blob: 0638fa939eba29c89c7059fe3351527085830e5f [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
21#ifndef _CCNX_PIT_H_
22#define _CCNX_PIT_H_
23
Alexander Afanasyevcf133f02011-09-06 12:13:48 -070024#include "ns3/object.h"
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070025#include "ns3/nstime.h"
26#include "ns3/event-id.h"
27
Alexander Afanasyev161a5c42012-04-17 15:14:04 -070028#include "ccnx-name-components-hash-helper.h"
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070029#include "ccnx-pit-entry.h"
30
31#include <boost/multi_index_container.hpp>
32#include <boost/multi_index/tag.hpp>
33#include <boost/multi_index/ordered_index.hpp>
34#include <boost/multi_index/composite_key.hpp>
35#include <boost/multi_index/hashed_index.hpp>
36#include <boost/multi_index/member.hpp>
37#include <boost/multi_index/mem_fun.hpp>
Ilya Moiseenko1c73cb52011-10-28 13:13:11 -070038#include <map>
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070039#include <iostream>
Ilya Moiseenko1c73cb52011-10-28 13:13:11 -070040#include <algorithm>
Alexander Afanasyeva46844b2011-11-21 19:13:26 -080041#include <boost/tuple/tuple.hpp>
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070042
43namespace ns3 {
44
45class Ccnx;
46class CcnxFace;
47class CcnxContentObjectHeader;
48class CcnxInterestHeader;
49
50/**
51 * \ingroup ccnx
52 * \private
53 * \brief Private namespace for CCNx PIT implementation
54 */
55namespace __ccnx_private
56{
Alexander Afanasyev78cf0c92011-09-01 19:57:14 -070057// class i_prefix{}; ///< tag for prefix hash
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070058class i_timestamp {}; ///< tag for timestamp-ordered records (for cleanup optimization)
59};
60
61/**
62 * \ingroup ccnx
63 * \brief Typedef for RIT container implemented as a Boost.MultiIndex container
64 *
65 * - First index (tag<i_prefix>) is a unique hash index based on
66 * prefixes
67 * - Second index (tag<i_timestamp>) is a sequenced index based on
68 * arrival order (for clean-up optimizations)
69 *
70 * \see http://www.boost.org/doc/libs/1_46_1/libs/multi_index/doc/ for more information on Boost.MultiIndex library
71 */
72struct CcnxPitEntryContainer
73{
74 typedef
75 boost::multi_index::multi_index_container<
76 CcnxPitEntry,
77 boost::multi_index::indexed_by<
78 // indexed by hash
79 boost::multi_index::hashed_unique<
80 boost::multi_index::tag<__ccnx_private::i_prefix>,
81 boost::multi_index::const_mem_fun<CcnxPitEntry, const CcnxNameComponents&, &CcnxPitEntry::GetPrefix>,
82 CcnxPrefixHash
83 >,
84 // sequenced to implement MRU
Alexander Afanasyevd76f4aa2011-12-15 21:30:16 -080085 boost::multi_index::ordered_non_unique<
86 boost::multi_index::tag<__ccnx_private::i_timestamp>,
87 boost::multi_index::member<CcnxPitEntry, Time, &CcnxPitEntry::m_expireTime>
88 >
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070089 >
90 > type;
91};
92
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -070093////////////////////////////////////////////////////////////////////////
94////////////////////////////////////////////////////////////////////////
95
96/**
97 * \ingroup ccnx
98 * \brief Class implementing Pending Interests Table
99 */
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700100class CcnxPit : public CcnxPitEntryContainer::type, public Object
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700101{
102public:
103 /**
Alexander Afanasyevcf133f02011-09-06 12:13:48 -0700104 * \brief Interface ID
105 *
106 * \return interface ID
107 */
108 static TypeId GetTypeId ();
109
110 /**
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700111 * \brief PIT constructor
112 */
113 CcnxPit ();
114
Alexander Afanasyevd02a5d62011-11-21 11:01:51 -0800115 /**
116 * \brief Destructor
117 */
118 virtual ~CcnxPit ();
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800119
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700120 /**
121 * \brief Find corresponding PIT entry for the given content name
122 * \param prefix Prefix for which to lookup the entry
123 * \returns const reference to Pit entry. If record not found,
124 * CcnxPitEntryNotFound exception will be thrown
125 */
Alexander Afanasyevff8c5d62012-04-25 15:14:51 -0700126 CcnxPitEntryContainer::type::iterator
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700127 Lookup (const CcnxContentObjectHeader &header) const;
128
129 /**
130 * \brief Find corresponding PIT entry for the given content name
131 * \param prefix Prefix for which to lookup the entry
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800132 * \returns a tuple:
133 * get<0>: `const CcnxPitEntry&`: a valid PIT entry (if record does not exist, it will be created)
134 * get<1>: `bool`: true if a new entry was created
135 * get<2>: `bool`: true if a PIT entry exists and Nonce that present in header has been already seen
136 *
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700137 */
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800138 boost::tuple<const CcnxPitEntry&, bool, bool>
139 Lookup (const CcnxInterestHeader &header);
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700140
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800141 Time GetPitEntryPruningTimeout () const
142 {
143 return m_PitEntryPruningTimout;
144 }
145
146 /**
147 * \brief Set FIB table
148 */
149 void SetFib (Ptr<CcnxFib> fib);
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700150
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800151protected:
152 // inherited from Object class
153 virtual void NotifyNewAggregate ();
154 virtual void DoDispose ();
155
156private:
157 /** \brief Remove expired records from PIT */
158 void CleanExpired ();
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700159
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700160 /**
161 * \brief Set cleanup timeout
162 *
163 * Side effect: current clean up even (if any) will be cancelled and a new event started
164 *
165 * \param timeout cleanup timeout
166 */
167 void SetCleanupTimeout (const Time &timeout);
168
169 /**
170 * \brief Get cleanup timeout
171 *
172 * \returns cleanup timeout
173 */
174 Time GetCleanupTimeout () const;
175
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700176 friend std::ostream& operator<< (std::ostream& os, const CcnxPit &fib);
177
178private:
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700179 Time m_cleanupTimeout; ///< \brief Configurable timeout of how often cleanup events are working
180 EventId m_cleanupEvent; ///< \brief Cleanup event
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800181
182 // configuration variables. Check implementation of GetTypeId for more details
Alexander Afanasyeva46844b2011-11-21 19:13:26 -0800183 Time m_PitEntryPruningTimout;
Alexander Afanasyev09c7deb2011-11-23 14:50:10 -0800184 Time m_PitEntryDefaultLifetime;
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700185
Alexander Afanasyevc5a23e22011-09-07 00:37:36 -0700186 Ptr<CcnxFib> m_fib; ///< \brief Link to FIB table
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700187};
188
189///////////////////////////////////////////////////////////////////////////////
190///////////////////////////////////////////////////////////////////////////////
191
Alexander Afanasyeva95b7392012-03-09 10:54:10 -0800192std::ostream& operator<< (std::ostream& os, const CcnxPit &pit);
Alexander Afanasyeva98cdd22011-08-29 17:32:37 -0700193
194class CcnxPitEntryNotFound {};
195
196} // namespace ns3
197
198#endif /* CCNX_PIT_H */