blob: 3cb53715be6da135ed7e298d6a28d435d28fc41e [file] [log] [blame]
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -07001/* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil -*- */
2/*
3 * Copyright (c) 2011 University of California, Los Angeles
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu>
19 */
20
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070021#ifndef _NDN_PIT_ENTRY_H_
22#define _NDN_PIT_ENTRY_H_
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070023
24#include "ns3/ptr.h"
Alexander Afanasyev11f7bb42012-07-09 17:06:30 -070025#include "ns3/simple-ref-count.h"
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070026
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070027#include "ns3/ndn-fib.h"
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070028
29#include "ns3/ndn-pit-entry-incoming-face.h"
30#include "ns3/ndn-pit-entry-outgoing-face.h"
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070031
32#include <boost/multi_index_container.hpp>
33#include <boost/multi_index/tag.hpp>
34#include <boost/multi_index/ordered_index.hpp>
Alexander Afanasyev9a989702012-06-29 17:44:00 -070035// #include <boost/multi_index/composite_key.hpp>
36// #include <boost/multi_index/hashed_index.hpp>
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070037#include <boost/multi_index/member.hpp>
Alexander Afanasyev9a989702012-06-29 17:44:00 -070038// #include <boost/multi_index/mem_fun.hpp>
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080039#include <set>
Alexander Afanasyeved449cc2012-08-21 11:10:33 -070040#include <boost/shared_ptr.hpp>
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070041
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070042namespace ns3 {
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070043namespace ndn {
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070044
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070045class Pit;
46
Alexander Afanasyeved449cc2012-08-21 11:10:33 -070047namespace fw { class Tag; }
48
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070049namespace pit {
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070050
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070051/// @cond include_hidden
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070052class i_face {};
Alexander Afanasyev0a61c342011-12-06 12:48:55 -080053class i_retx {};
Alexander Afanasyev6315ef72012-06-01 20:56:31 -070054/// @endcond
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070055
56/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070057 * \ingroup ndn
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070058 * \brief Typedef for indexed face container of PitEntryOutgoingFace
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070059 *
60 * Indexes:
61 * - by face (may be it will be possible to replace with just the std::map)
62 */
Alexander Afanasyevc202fd92012-09-03 21:46:00 -070063// struct OutgoingFaceContainer
64// {
65// /// @cond include_hidden
66// typedef boost::multi_index::multi_index_container<
67// OutgoingFace,
68// boost::multi_index::indexed_by<
69// // For fast access to elements using NdnFace
70// boost::multi_index::ordered_unique<
71// boost::multi_index::tag<i_face>,
72// boost::multi_index::member<OutgoingFace, Ptr<Face>, &OutgoingFace::m_face>
73// >
74// // ,
75// // boost::multi_index::ordered_non_unique<
76// // boost::multi_index::tag<i_retx>,
77// // boost::multi_index::member<OutgoingFace, uint32_t, &OutgoingFace::m_retxCount>
Alexander Afanasyeveec66292013-02-06 16:23:21 -080078// // >
Alexander Afanasyevc202fd92012-09-03 21:46:00 -070079// >
80// > type;
81// /// @endcond
82// };
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070083
84
85/**
Alexander Afanasyev4aac5572012-08-09 10:49:55 -070086 * \ingroup ndn
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070087 * \brief structure for PIT entry
Alexander Afanasyev36b45772012-07-10 16:57:42 -070088 *
89 * All set-methods are virtual, in case index rearrangement is necessary in the derived classes
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070090 */
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070091class Entry : public SimpleRefCount<Entry>
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070092{
93public:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -070094 typedef std::set< IncomingFace > in_container; ///< @brief incoming faces container type
Alexander Afanasyevf034cbd2012-06-29 14:28:31 -070095 typedef in_container::iterator in_iterator; ///< @brief iterator to incoming faces
96
Alexander Afanasyevc202fd92012-09-03 21:46:00 -070097 // typedef OutgoingFaceContainer::type out_container; ///< @brief outgoing faces container type
98 typedef std::set< OutgoingFace > out_container; ///< @brief outgoing faces container type
Alexander Afanasyevf034cbd2012-06-29 14:28:31 -070099 typedef out_container::iterator out_iterator; ///< @brief iterator to outgoing faces
100
101 typedef std::set< uint32_t > nonce_container; ///< @brief nonce container type
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800102
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700103 /**
104 * \brief PIT entry constructor
105 * \param prefix Prefix of the PIT entry
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800106 * \param offsetTime Relative time to the current moment, representing PIT entry lifetime
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700107 * \param fibEntry A FIB entry associated with the PIT entry
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700108 */
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700109 Entry (Pit &container, Ptr<const Interest> header, Ptr<fib::Entry> fibEntry);
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700110
111 /**
112 * @brief Virtual destructor
113 */
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700114 virtual ~Entry ();
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800115
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800116 /**
117 * @brief Update lifetime of PIT entry
118 *
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800119 * @param lifetime desired lifetime of the pit entry (relative to the Simulator::Now ())
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800120 *
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800121 * This function will update PIT entry lifetime to the maximum of the current lifetime and
122 * the lifetime Simulator::Now () + lifetime
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800123 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700124 virtual void
Alexander Afanasyev08b7d9e2012-08-23 10:53:46 -0700125 UpdateLifetime (const Time &lifetime);
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700126
127 /**
Alexander Afanasyev08b7d9e2012-08-23 10:53:46 -0700128 * @brief Offset the currently set PIT lifetime (allowed both negative and positive offsets)
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800129 *
Alexander Afanasyev08b7d9e2012-08-23 10:53:46 -0700130 * @param offsetTime positive or negative offset for the PIT lifetime.
131 *
132 * If PIT expire time becomes less than Simulator::Now, then it is adjusted to Simulator::Now.
133 */
134 virtual void
135 OffsetLifetime (const Time &offsetTime);
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800136
Alexander Afanasyev08b7d9e2012-08-23 10:53:46 -0700137 /**
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700138 * @brief Get prefix of the PIT entry
139 */
Alexander Afanasyevcfdc14f2013-03-15 14:38:44 -0700140 const Name &
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700141 GetPrefix () const;
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800142
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800143 /**
144 * @brief Get current expiration time of the record
145 *
146 * @returns current expiration time of the record
147 */
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700148 const Time &
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700149 GetExpireTime () const;
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800150
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800151 /**
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800152 * @brief Check if nonce `nonce` for the same prefix has already been seen
153 *
154 * @param nonce Nonce to check
155 */
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800156 bool
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700157 IsNonceSeen (uint32_t nonce) const;
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800158
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800159 /**
160 * @brief Add `nonce` to the list of seen nonces
161 *
162 * @param nonce nonce to add to the list of seen nonces
163 *
164 * All nonces are stored for the lifetime of the PIT entry
165 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700166 virtual void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700167 AddSeenNonce (uint32_t nonce);
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800168
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800169 /**
170 * @brief Add `face` to the list of incoming faces
171 *
172 * @param face Face to add to the list of incoming faces
173 * @returns iterator to the added entry
174 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700175 virtual in_iterator
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700176 AddIncoming (Ptr<Face> face);
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800177
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800178 /**
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800179 * @brief Remove incoming entry for face `face`
180 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700181 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700182 RemoveIncoming (Ptr<Face> face);
Alexander Afanasyev9d313d42011-11-25 13:36:15 -0800183
184 /**
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800185 * @brief Clear all incoming faces either after all of them were satisfied or NACKed
186 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700187 virtual void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700188 ClearIncoming ();
Alexander Afanasyeva5bbe0e2011-11-22 17:28:39 -0800189
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800190 /**
191 * @brief Add `face` to the list of outgoing faces
192 *
193 * @param face Face to add to the list of outgoing faces
194 * @returns iterator to the added entry
195 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700196 virtual out_iterator
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700197 AddOutgoing (Ptr<Face> face);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800198
199 /**
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800200 * @brief Clear all incoming faces either after all of them were satisfied or NACKed
201 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700202 virtual void
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700203 ClearOutgoing ();
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800204
Alexander Afanasyev120bf312011-12-19 01:24:47 -0800205 /**
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800206 * @brief Remove all references to face.
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800207 *
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800208 * This method should be called before face is completely removed from the stack.
209 * Face is removed from the lists of incoming and outgoing faces
210 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700211 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700212 RemoveAllReferencesToFace (Ptr<Face> face);
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800213
Alexander Afanasyev5a595072011-11-25 14:49:07 -0800214 /**
215 * @brief Flag outgoing face as hopeless
216 */
Alexander Afanasyev786936a2012-07-17 19:48:15 -0700217 // virtual void
218 // SetWaitingInVain (out_iterator face);
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700219 virtual void
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700220 SetWaitingInVain (Ptr<Face> face);
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800221
Alexander Afanasyev5a595072011-11-25 14:49:07 -0800222 /**
223 * @brief Check if all outgoing faces are NACKed
224 */
225 bool
226 AreAllOutgoingInVain () const;
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800227
Alexander Afanasyevb4fee8b2012-06-06 12:54:26 -0700228 /**
Alexander Afanasyeva7a2b8b2011-11-28 18:19:09 -0800229 * @brief Similar to AreAllOutgoingInVain, but ignores `face`
230 * \see AreAllOutgoingInVain
231 **/
232 bool
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700233 AreTherePromisingOutgoingFacesExcept (Ptr<Face> face) const;
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800234
235 /**
236 * @brief Increase maximum limit of allowed retransmission per outgoing face
237 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700238 virtual void
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800239 IncreaseAllowedRetxCount ();
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700240
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700241 /**
242 * @brief Get maximum allowed number of retransmissions via outgoing faces
243 */
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700244 uint32_t
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700245 GetMaxRetxCount () const;
246
247 /**
248 * @brief Get associated FIB entry
249 */
250 Ptr<fib::Entry>
251 GetFibEntry ();
252
253 /**
254 * @brief Get associated list (const reference) of incoming faces
255 */
256 const in_container &
257 GetIncoming () const;
258
259 /**
260 * @brief Get associated list (const reference) of outgoing faces
261 */
262 const out_container &
263 GetOutgoing () const;
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700264
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700265 /**
Alexander Afanasyevff033952012-08-23 15:45:52 -0700266 * @brief Get number of outgoing faces (needed for python bindings)
267 */
268 uint32_t
269 GetOutgoingCount () const;
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800270
Alexander Afanasyevff033952012-08-23 15:45:52 -0700271 /**
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700272 * @brief Add new forwarding strategy tag
273 */
274 inline void
275 AddFwTag (boost::shared_ptr< fw::Tag > tag);
276
277 /**
278 * @brief Get forwarding strategy tag (tag is not removed)
279 */
280 template<class T>
281 inline boost::shared_ptr< T >
282 GetFwTag ();
283
284 /**
285 * @brief Remove the forwarding strategy tag
286 */
287 template<class T>
288 inline void
289 RemoveFwTag ();
290
Alexander Afanasyev91e11282012-08-21 17:23:11 -0700291 /**
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700292 * @brief Get Interest (if several interests are received, then nonce is from the first Interest)
Alexander Afanasyev91e11282012-08-21 17:23:11 -0700293 */
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700294 Ptr<const Interest>
Alexander Afanasyev91e11282012-08-21 17:23:11 -0700295 GetInterest () const;
296
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700297private:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700298 friend std::ostream& operator<< (std::ostream& os, const Entry &entry);
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800299
Alexander Afanasyev36b45772012-07-10 16:57:42 -0700300protected:
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700301 Pit &m_container; ///< @brief Reference to the container (to rearrange indexes, if necessary)
Alexander Afanasyev31cb4692012-08-17 13:08:20 -0700302
Alexander Afanasyeveae83ee2013-03-15 15:01:10 -0700303 Ptr<const Interest> m_interest; ///< \brief Interest of the PIT entry (if several interests are received, then nonce is from the first Interest)
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700304 Ptr<fib::Entry> m_fibEntry; ///< \brief FIB entry related to this prefix
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800305
306 nonce_container m_seenNonces; ///< \brief map of nonces that were seen for this prefix
Alexander Afanasyevf034cbd2012-06-29 14:28:31 -0700307 in_container m_incoming; ///< \brief container for incoming interests
308 out_container m_outgoing; ///< \brief container for outgoing interests
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700309
310 Time m_expireTime; ///< \brief Time when PIT entry will be removed
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800311
Alexander Afanasyev7f3e49e2012-04-30 00:17:07 -0700312 Time m_lastRetransmission; ///< @brief Last time when number of retransmissions were increased
Alexander Afanasyev0a61c342011-12-06 12:48:55 -0800313 uint32_t m_maxRetxCount; ///< @brief Maximum allowed number of retransmissions via outgoing faces
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700314
315 std::list< boost::shared_ptr<fw::Tag> > m_fwTags; ///< @brief Forwarding strategy tags
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700316};
317
Alexander Afanasyeveec66292013-02-06 16:23:21 -0800318struct EntryIsNotEmpty
319{
320 bool
321 operator () (Ptr<Entry> entry)
322 {
323 return !entry->GetIncoming ().empty ();
324 }
325};
326
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700327std::ostream& operator<< (std::ostream& os, const Entry &entry);
Alexander Afanasyeva95b7392012-03-09 10:54:10 -0800328
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700329inline void
330Entry::AddFwTag (boost::shared_ptr< fw::Tag > tag)
331{
332 m_fwTags.push_back (tag);
333}
334
335/**
336 * @brief Get and remove forwarding strategy tag
337 */
338template<class T>
339inline boost::shared_ptr< T >
340Entry::GetFwTag ()
341{
342 for (std::list< boost::shared_ptr<fw::Tag> >::iterator item = m_fwTags.begin ();
343 item != m_fwTags.end ();
344 item ++)
345 {
346 boost::shared_ptr< T > retPtr = boost::dynamic_pointer_cast<T> (*item);
Alexander Afanasyev38ba9b22012-08-21 13:32:43 -0700347 if (retPtr != boost::shared_ptr< T > ())
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700348 {
349 return retPtr;
350 }
351 }
352
Alexander Afanasyev38ba9b22012-08-21 13:32:43 -0700353 return boost::shared_ptr< T > ();
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700354}
355
356// /**
357// * @brief Peek the forwarding strategy tag
358// */
359// template<class T>
360// inline boost::shared_ptr< const T >
361// Entry::PeekFwTag () const
362// {
363// for (std::list< boost::shared_ptr<fw::Tag> >::const_iterator item = m_fwTags.begin ();
364// item != m_fwTags.end ();
365// item ++)
366// {
367// boost::shared_ptr< const T > retPtr = boost::dynamic_pointer_cast<const T> (*item);
368// if (retPtr != 0)
369// {
370// return retPtr;
371// }
372// }
373
374// return 0;
375// }
376
377template<class T>
378inline void
379Entry::RemoveFwTag ()
380{
381 for (std::list< boost::shared_ptr<fw::Tag> >::iterator item = m_fwTags.begin ();
382 item != m_fwTags.end ();
383 item ++)
384 {
385 boost::shared_ptr< T > retPtr = boost::dynamic_pointer_cast< T > (*item);
Alexander Afanasyev38ba9b22012-08-21 13:32:43 -0700386 if (retPtr != boost::shared_ptr< T > ())
Alexander Afanasyeved449cc2012-08-21 11:10:33 -0700387 {
388 m_fwTags.erase (item);
389 return;
390 }
391 }
392}
393
394
Alexander Afanasyev2b4c9472012-08-09 15:00:38 -0700395} // namespace pit
396} // namespace ndn
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700397} // namespace ns3
398
Alexander Afanasyev4aac5572012-08-09 10:49:55 -0700399#endif // _NDN_PIT_ENTRY_H_