Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 1 | /* -*- 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 | |
| 21 | #ifndef _CCNX_PIT_ENTRY_H_ |
| 22 | #define _CCNX_PIT_ENTRY_H_ |
| 23 | |
| 24 | #include "ns3/ptr.h" |
| 25 | |
| 26 | #include "ccnx-pit-entry-incoming-face.h" |
| 27 | #include "ccnx-pit-entry-outgoing-face.h" |
| 28 | #include "ccnx-fib.h" |
| 29 | |
| 30 | #include <boost/multi_index_container.hpp> |
| 31 | #include <boost/multi_index/tag.hpp> |
| 32 | #include <boost/multi_index/ordered_index.hpp> |
| 33 | #include <boost/multi_index/composite_key.hpp> |
| 34 | #include <boost/multi_index/hashed_index.hpp> |
| 35 | #include <boost/multi_index/member.hpp> |
| 36 | #include <boost/multi_index/mem_fun.hpp> |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 37 | #include <set> |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 38 | |
| 39 | #include <iostream> |
| 40 | |
| 41 | namespace ns3 { |
| 42 | |
| 43 | class CcnxFace; |
| 44 | class CcnxNameComponents; |
| 45 | |
Alexander Afanasyev | 6315ef7 | 2012-06-01 20:56:31 -0700 | [diff] [blame] | 46 | /// @cond include_hidden |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 47 | namespace __ccnx_private |
| 48 | { |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 49 | class i_retx {}; |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 50 | } |
Alexander Afanasyev | 6315ef7 | 2012-06-01 20:56:31 -0700 | [diff] [blame] | 51 | /// @endcond |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 52 | |
| 53 | /** |
| 54 | * \ingroup ccnx |
| 55 | * \brief Typedef for indexed face container of CcnxPitEntryIncomingFace |
| 56 | * |
| 57 | * Indexes: |
| 58 | * - by face (may be it will be possible to replace with just the std::map) |
| 59 | */ |
| 60 | struct CcnxPitEntryIncomingFaceContainer |
| 61 | { |
| 62 | typedef boost::multi_index::multi_index_container< |
| 63 | CcnxPitEntryIncomingFace, |
| 64 | boost::multi_index::indexed_by< |
| 65 | // For fast access to elements using CcnxFace |
| 66 | boost::multi_index::ordered_unique< |
| 67 | boost::multi_index::tag<__ccnx_private::i_face>, |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 68 | boost::multi_index::member<CcnxPitEntryIncomingFace, Ptr<CcnxFace>, &CcnxPitEntryIncomingFace::m_face> |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 69 | > |
| 70 | > |
| 71 | > type; |
| 72 | }; |
| 73 | |
| 74 | /** |
| 75 | * \ingroup ccnx |
| 76 | * \brief Typedef for indexed face container of CcnxPitEntryOutgoingFace |
| 77 | * |
| 78 | * Indexes: |
| 79 | * - by face (may be it will be possible to replace with just the std::map) |
| 80 | */ |
| 81 | struct CcnxPitEntryOutgoingFaceContainer |
| 82 | { |
| 83 | typedef boost::multi_index::multi_index_container< |
| 84 | CcnxPitEntryOutgoingFace, |
| 85 | boost::multi_index::indexed_by< |
| 86 | // For fast access to elements using CcnxFace |
| 87 | boost::multi_index::ordered_unique< |
| 88 | boost::multi_index::tag<__ccnx_private::i_face>, |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 89 | boost::multi_index::member<CcnxPitEntryOutgoingFace, Ptr<CcnxFace>, &CcnxPitEntryOutgoingFace::m_face> |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 90 | >, |
| 91 | boost::multi_index::ordered_non_unique< |
| 92 | boost::multi_index::tag<__ccnx_private::i_retx>, |
| 93 | boost::multi_index::member<CcnxPitEntryOutgoingFace, uint32_t, &CcnxPitEntryOutgoingFace::m_retxCount> |
| 94 | > |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 95 | > |
| 96 | > type; |
| 97 | }; |
| 98 | |
| 99 | |
| 100 | /** |
| 101 | * \ingroup ccnx |
| 102 | * \brief structure for PIT entry |
| 103 | */ |
| 104 | struct CcnxPitEntry |
| 105 | { |
| 106 | public: |
| 107 | /** |
| 108 | * \brief PIT entry constructor |
| 109 | * \param prefix Prefix of the PIT entry |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 110 | * \param offsetTime Relative time to the current moment, representing PIT entry lifetime |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 111 | * \param fibEntry A FIB entry associated with the PIT entry |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 112 | */ |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 113 | CcnxPitEntry (Ptr<CcnxNameComponents> prefix, const Time &offsetTime, const CcnxFibEntry &fibEntry); |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 114 | |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 115 | /** |
| 116 | * @brief Update lifetime of PIT entry |
| 117 | * |
| 118 | * This function will update PIT entry lifetime to the maximum of the current lifetime and |
| 119 | * the lifetime Simulator::Now () + offsetTime |
| 120 | * |
| 121 | * @param offsetTime Relative time to the current moment, representing PIT entry lifetime |
| 122 | */ |
| 123 | void |
| 124 | UpdateLifetime (const Time &offsetTime); |
| 125 | |
Alexander Afanasyev | 19426ef | 2011-11-23 20:55:28 -0800 | [diff] [blame] | 126 | const CcnxNameComponents & |
| 127 | GetPrefix () const |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 128 | { return *m_prefix; } |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 129 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 130 | /** |
| 131 | * @brief Get current expiration time of the record |
| 132 | * |
| 133 | * @returns current expiration time of the record |
| 134 | */ |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 135 | const Time & |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 136 | GetExpireTime () const |
| 137 | { return m_expireTime; } |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 138 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 139 | /** |
| 140 | * @brief Set expiration time on record as `expireTime` (absolute time) |
| 141 | * |
| 142 | * @param expireTime absolute simulation time of when the record should expire |
| 143 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 144 | void |
Alexander Afanasyev | 1aeaf92 | 2012-04-23 13:48:09 -0700 | [diff] [blame] | 145 | SetExpireTime (const Time &expireTime); |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 146 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 147 | /** |
| 148 | * @brief Check if nonce `nonce` for the same prefix has already been seen |
| 149 | * |
| 150 | * @param nonce Nonce to check |
| 151 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 152 | bool |
| 153 | IsNonceSeen (uint32_t nonce) const |
| 154 | { return m_seenNonces.find (nonce) != m_seenNonces.end (); } |
| 155 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 156 | /** |
| 157 | * @brief Add `nonce` to the list of seen nonces |
| 158 | * |
| 159 | * @param nonce nonce to add to the list of seen nonces |
| 160 | * |
| 161 | * All nonces are stored for the lifetime of the PIT entry |
| 162 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 163 | void |
| 164 | AddSeenNonce (uint32_t nonce) |
| 165 | { m_seenNonces.insert (nonce); } |
| 166 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 167 | /** |
| 168 | * @brief Add `face` to the list of incoming faces |
| 169 | * |
| 170 | * @param face Face to add to the list of incoming faces |
| 171 | * @returns iterator to the added entry |
| 172 | */ |
Alexander Afanasyev | a5bbe0e | 2011-11-22 17:28:39 -0800 | [diff] [blame] | 173 | CcnxPitEntryIncomingFaceContainer::type::iterator |
| 174 | AddIncoming (Ptr<CcnxFace> face); |
| 175 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 176 | /** |
Alexander Afanasyev | 9d313d4 | 2011-11-25 13:36:15 -0800 | [diff] [blame] | 177 | * @brief Remove incoming entry for face `face` |
| 178 | */ |
| 179 | void |
| 180 | RemoveIncoming (Ptr<CcnxFace> face); |
| 181 | |
| 182 | /** |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 183 | * @brief Clear all incoming faces either after all of them were satisfied or NACKed |
| 184 | */ |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 185 | void |
Alexander Afanasyev | a5bbe0e | 2011-11-22 17:28:39 -0800 | [diff] [blame] | 186 | ClearIncoming () |
| 187 | { m_incoming.clear (); } |
| 188 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 189 | /** |
| 190 | * @brief Add `face` to the list of outgoing faces |
| 191 | * |
| 192 | * @param face Face to add to the list of outgoing faces |
| 193 | * @returns iterator to the added entry |
| 194 | */ |
Alexander Afanasyev | a5bbe0e | 2011-11-22 17:28:39 -0800 | [diff] [blame] | 195 | CcnxPitEntryOutgoingFaceContainer::type::iterator |
| 196 | AddOutgoing (Ptr<CcnxFace> face); |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 197 | |
| 198 | /** |
Alexander Afanasyev | 120bf31 | 2011-12-19 01:24:47 -0800 | [diff] [blame] | 199 | * @brief Clear all incoming faces either after all of them were satisfied or NACKed |
| 200 | */ |
| 201 | void |
| 202 | ClearOutgoing () |
| 203 | { m_outgoing.clear (); } |
| 204 | |
| 205 | /** |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 206 | * @brief Remove all references to face. |
| 207 | * |
| 208 | * 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 | */ |
| 211 | void |
| 212 | RemoveAllReferencesToFace (Ptr<CcnxFace> face); |
| 213 | |
Alexander Afanasyev | 5a59507 | 2011-11-25 14:49:07 -0800 | [diff] [blame] | 214 | /** |
| 215 | * @brief Flag outgoing face as hopeless |
| 216 | */ |
| 217 | void |
| 218 | SetWaitingInVain (CcnxPitEntryOutgoingFaceContainer::type::iterator face); |
| 219 | |
| 220 | /** |
| 221 | * @brief Check if all outgoing faces are NACKed |
| 222 | */ |
| 223 | bool |
| 224 | AreAllOutgoingInVain () const; |
Alexander Afanasyev | a7a2b8b | 2011-11-28 18:19:09 -0800 | [diff] [blame] | 225 | |
| 226 | /* |
| 227 | * @brief Similar to AreAllOutgoingInVain, but ignores `face` |
| 228 | * \see AreAllOutgoingInVain |
| 229 | **/ |
| 230 | bool |
| 231 | AreTherePromisingOutgoingFacesExcept (Ptr<CcnxFace> face) const; |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 232 | |
| 233 | /** |
| 234 | * @brief Increase maximum limit of allowed retransmission per outgoing face |
| 235 | */ |
| 236 | void |
| 237 | IncreaseAllowedRetxCount (); |
Alexander Afanasyev | 5a59507 | 2011-11-25 14:49:07 -0800 | [diff] [blame] | 238 | |
Alexander Afanasyev | 09c7deb | 2011-11-23 14:50:10 -0800 | [diff] [blame] | 239 | protected: |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 240 | |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 241 | private: |
| 242 | friend std::ostream& operator<< (std::ostream& os, const CcnxPitEntry &entry); |
Alexander Afanasyev | 0782718 | 2011-12-13 01:07:32 -0800 | [diff] [blame] | 243 | /** |
| 244 | * \brief Default constructor |
| 245 | */ |
| 246 | CcnxPitEntry () : m_fibEntry(*((CcnxFibEntry*)0)) {}; |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 247 | |
Alexander Afanasyev | 78cf0c9 | 2011-09-01 19:57:14 -0700 | [diff] [blame] | 248 | public: |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 249 | Ptr<CcnxNameComponents> m_prefix; ///< \brief Prefix of the PIT entry |
Alexander Afanasyev | c5a23e2 | 2011-09-07 00:37:36 -0700 | [diff] [blame] | 250 | const CcnxFibEntry &m_fibEntry; ///< \brief FIB entry related to this prefix |
Alexander Afanasyev | a46844b | 2011-11-21 19:13:26 -0800 | [diff] [blame] | 251 | std::set<uint32_t> m_seenNonces; ///< \brief map of nonces that were seen for this prefix |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 252 | |
| 253 | CcnxPitEntryIncomingFaceContainer::type m_incoming; ///< \brief container for incoming interests |
| 254 | CcnxPitEntryOutgoingFaceContainer::type m_outgoing; ///< \brief container for outgoing interests |
| 255 | |
| 256 | Time m_expireTime; ///< \brief Time when PIT entry will be removed |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 257 | |
Alexander Afanasyev | 7f3e49e | 2012-04-30 00:17:07 -0700 | [diff] [blame] | 258 | Time m_lastRetransmission; ///< @brief Last time when number of retransmissions were increased |
Alexander Afanasyev | 0a61c34 | 2011-12-06 12:48:55 -0800 | [diff] [blame] | 259 | uint32_t m_maxRetxCount; ///< @brief Maximum allowed number of retransmissions via outgoing faces |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 260 | }; |
| 261 | |
Alexander Afanasyev | a95b739 | 2012-03-09 10:54:10 -0800 | [diff] [blame] | 262 | std::ostream& operator<< (std::ostream& os, const CcnxPitEntry &entry); |
| 263 | |
Alexander Afanasyev | a98cdd2 | 2011-08-29 17:32:37 -0700 | [diff] [blame] | 264 | } // namespace ns3 |
| 265 | |
| 266 | #endif // _CCNX_PIT_ENTRY_H_ |