NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
measurements.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2018, Regents of the University of California,
4  * Arizona Board of Regents,
5  * Colorado State University,
6  * University Pierre & Marie Curie, Sorbonne University,
7  * Washington University in St. Louis,
8  * Beijing Institute of Technology,
9  * The University of Memphis.
10  *
11  * This file is part of NFD (Named Data Networking Forwarding Daemon).
12  * See AUTHORS.md for complete list of NFD authors and contributors.
13  *
14  * NFD is free software: you can redistribute it and/or modify it under the terms
15  * of the GNU General Public License as published by the Free Software Foundation,
16  * either version 3 of the License, or (at your option) any later version.
17  *
18  * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
19  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
20  * PURPOSE. See the GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License along with
23  * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
24  */
25 
26 #include "measurements.hpp"
27 #include "name-tree.hpp"
28 #include "pit-entry.hpp"
29 #include "fib-entry.hpp"
30 
31 namespace nfd {
32 namespace measurements {
33 
35  : m_nameTree(nameTree)
36  , m_nItems(0)
37 {
38 }
39 
40 Entry&
42 {
43  Entry* entry = nte.getMeasurementsEntry();
44  if (entry != nullptr) {
45  return *entry;
46  }
47 
48  nte.setMeasurementsEntry(make_unique<Entry>(nte.getName()));
49  ++m_nItems;
50  entry = nte.getMeasurementsEntry();
51 
52  entry->m_expiry = time::steady_clock::now() + getInitialLifetime();
53  entry->m_cleanup = scheduler::schedule(getInitialLifetime(),
54  bind(&Measurements::cleanup, this, ref(*entry)));
55 
56  return *entry;
57 }
58 
59 Entry&
61 {
62  name_tree::Entry& nte = m_nameTree.lookup(name, std::min(name.size(), getMaxDepth()));
63  return this->get(nte);
64 }
65 
66 Entry&
67 Measurements::get(const fib::Entry& fibEntry)
68 {
69  name_tree::Entry& nte = m_nameTree.lookup(fibEntry);
70  return this->get(nte);
71 }
72 
73 Entry&
74 Measurements::get(const pit::Entry& pitEntry)
75 {
76  name_tree::Entry& nte = m_nameTree.lookup(pitEntry);
77  return this->get(nte);
78 }
79 
80 Entry*
82 {
83  if (child.getName().empty()) { // the root entry
84  return nullptr;
85  }
86 
87  name_tree::Entry* nteChild = m_nameTree.getEntry(child);
88  name_tree::Entry* nte = nteChild->getParent();
89  BOOST_ASSERT(nte != nullptr);
90  return &this->get(*nte);
91 }
92 
93 template<typename K>
94 Entry*
95 Measurements::findLongestPrefixMatchImpl(const K& key, const EntryPredicate& pred) const
96 {
97  name_tree::Entry* match = m_nameTree.findLongestPrefixMatch(key,
98  [&pred] (const name_tree::Entry& nte) {
99  const Entry* entry = nte.getMeasurementsEntry();
100  return entry != nullptr && pred(*entry);
101  });
102  if (match != nullptr) {
103  return match->getMeasurementsEntry();
104  }
105  return nullptr;
106 }
107 
108 Entry*
110 {
111  return this->findLongestPrefixMatchImpl(name.getPrefix(NameTree::getMaxDepth()), pred);
112 }
113 
114 Entry*
116 {
117  return this->findLongestPrefixMatch(pitEntry.getName(), pred);
118 }
119 
120 Entry*
122 {
123  const name_tree::Entry* nte = m_nameTree.findExactMatch(name);
124  return nte == nullptr ? nullptr : nte->getMeasurementsEntry();
125 }
126 
127 void
128 Measurements::extendLifetime(Entry& entry, const time::nanoseconds& lifetime)
129 {
130  BOOST_ASSERT(m_nameTree.getEntry(entry) != nullptr);
131 
133  if (entry.m_expiry >= expiry) {
134  // has longer lifetime, not extending
135  return;
136  }
137 
138  scheduler::cancel(entry.m_cleanup);
139  entry.m_expiry = expiry;
140  entry.m_cleanup = scheduler::schedule(lifetime, bind(&Measurements::cleanup, this, ref(entry)));
141 }
142 
143 void
144 Measurements::cleanup(Entry& entry)
145 {
146  name_tree::Entry* nte = m_nameTree.getEntry(entry);
147  BOOST_ASSERT(nte != nullptr);
148 
149  nte->setMeasurementsEntry(nullptr);
150  m_nameTree.eraseIfEmpty(nte);
151  --m_nItems;
152 }
153 
154 } // namespace measurements
155 } // namespace nfd
const Name & getName() const
Entry * findExactMatch(const Name &name) const
perform an exact match
time_point TimePoint
Definition: time.hpp:226
Measurements(NameTree &nameTree)
void cancel(const EventId &eventId)
Cancel a scheduled event.
Definition: scheduler.cpp:54
represents a FIB entry
Definition: fib-entry.hpp:51
static time_point now() noexcept
Definition: time.cpp:80
std::function< bool(const Entry &)> EntryPredicate
a predicate that accepts or rejects an entry
Entry * findLongestPrefixMatch(const Name &name, const EntryPredicate &pred=AnyEntry()) const
perform a longest prefix match for name
Entry & lookup(const Name &name, size_t prefixLen)
find or insert an entry by name
Definition: name-tree.cpp:44
Entry * findLongestPrefixMatch(const Name &name, const EntrySelector &entrySelector=AnyEntry()) const
longest prefix matching
Definition: name-tree.cpp:162
void setMeasurementsEntry(unique_ptr< measurements::Entry > measurementsEntry)
represents a Measurements entry
measurements::Entry * getMeasurementsEntry() const
Entry * getParent(const Entry &child)
find or insert a parent entry
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
an Interest table entry
Definition: pit-entry.hpp:57
void extendLifetime(Entry &entry, const time::nanoseconds &lifetime)
extend lifetime of an entry
static constexpr size_t getMaxDepth()
maximum depth of a Measurements entry
Entry * getEntry(const EntryT &tableEntry) const
Definition: name-tree.hpp:79
Represents an absolute name.
Definition: name.hpp:42
size_t eraseIfEmpty(Entry *entry, bool canEraseAncestors=true)
delete the entry if it is empty
Definition: name-tree.cpp:123
a common index structure for FIB, PIT, StrategyChoice, and Measurements
Definition: name-tree.hpp:38
const Name & getName() const
Definition: pit-entry.hpp:77
EventId schedule(time::nanoseconds after, const EventCallback &event)
Schedule an event.
Definition: scheduler.cpp:48
bool empty() const
Check if name is empty.
Definition: name.hpp:146
Entry * findExactMatch(const Name &name, size_t prefixLen=std::numeric_limits< size_t >::max()) const
exact match lookup
Definition: name-tree.cpp:150
Entry * getParent() const
Entry & get(const Name &name)
find or insert an entry by name
const Name & getName() const
static time::nanoseconds getInitialLifetime()
an entry in the name tree
static constexpr size_t getMaxDepth()
maximum depth of the name tree
Definition: name-tree.hpp:53