NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
asf-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 "asf-measurements.hpp"
27 
28 namespace nfd {
29 namespace fw {
30 namespace asf {
31 
32 NFD_LOG_INIT("AsfMeasurements");
33 
36 const double RttStats::ALPHA = 0.125;
37 
39  : m_srtt(RTT_NO_MEASUREMENT)
40  , m_rtt(RTT_NO_MEASUREMENT)
41 {
42 }
43 
44 void
46 {
47  m_rtt = static_cast<RttStats::Rtt>(durationRtt.count());
48 
49  m_rttEstimator.addMeasurement(durationRtt);
50 
51  m_srtt = computeSrtt(m_srtt, m_rtt);
52 }
53 
55 RttStats::computeSrtt(Rtt previousSrtt, Rtt currentRtt)
56 {
57  if (previousSrtt == RTT_NO_MEASUREMENT) {
58  return currentRtt;
59  }
60 
61  return Rtt(ALPHA * currentRtt + (1 - ALPHA) * previousSrtt);
62 }
63 
66 
68  : m_isTimeoutScheduled(false)
69  , m_nSilentTimeouts(0)
70 {
71 }
72 
74 {
76  scheduler::cancel(m_measurementExpirationId);
77 }
78 
79 void
80 FaceInfo::setTimeoutEvent(const scheduler::EventId& id, const Name& interestName)
81 {
82  if (!m_isTimeoutScheduled) {
83  m_timeoutEventId = id;
84  m_isTimeoutScheduled = true;
85  m_lastInterestName = interestName;
86  }
87  else {
88  BOOST_THROW_EXCEPTION(FaceInfo::Error("Tried to schedule a timeout for a face that already has a timeout scheduled."));
89  }
90 }
91 
92 void
93 FaceInfo::cancelTimeoutEvent()
94 {
95  scheduler::cancel(m_timeoutEventId);
96  m_isTimeoutScheduled = false;
97 }
98 
99 void
100 FaceInfo::cancelTimeoutEvent(const Name& prefix)
101 {
102  if (isTimeoutScheduled() && doesNameMatchLastInterest(prefix)) {
104  }
105 }
106 
107 bool
108 FaceInfo::doesNameMatchLastInterest(const Name& name)
109 {
110  return m_lastInterestName.isPrefixOf(name);
111 }
112 
113 void
114 FaceInfo::recordRtt(const shared_ptr<pit::Entry>& pitEntry, const Face& inFace)
115 {
116  // Calculate RTT
117  pit::OutRecordCollection::const_iterator outRecord = pitEntry->getOutRecord(inFace);
118 
119  if (outRecord == pitEntry->out_end()) { // no out-record
120  NFD_LOG_TRACE(pitEntry->getInterest() << " dataFrom inFace=" << inFace.getId() << " no-out-record");
121  return;
122  }
123 
124  time::steady_clock::Duration steadyRtt = time::steady_clock::now() - outRecord->getLastRenewed();
125  RttEstimator::Duration durationRtt = time::duration_cast<RttEstimator::Duration>(steadyRtt);
126 
127  m_rttStats.addRttMeasurement(durationRtt);
128 
129  NFD_LOG_TRACE("Recording RTT for FaceId: " << inFace.getId()
130  << " RTT: " << m_rttStats.getRtt()
131  << " SRTT: " << m_rttStats.getSrtt());
132 }
133 
134 void
135 FaceInfo::recordTimeout(const Name& interestName)
136 {
137  m_rttStats.recordTimeout();
138  cancelTimeoutEvent(interestName);
139 }
140 
143 
145  : m_isProbingDue(false)
146  , m_hasFirstProbeBeenScheduled(false)
147 {
148 }
149 
150 FaceInfo*
152 {
153  FaceInfoTable::iterator it = m_fit.find(faceId);
154 
155  if (it != m_fit.end()) {
156  return &it->second;
157  }
158  else {
159  return nullptr;
160  }
161 }
162 
163 FaceInfo&
165 {
166  FaceInfoTable::iterator it = m_fit.find(faceId);
167 
168  FaceInfo* info = nullptr;
169 
170  if (it == m_fit.end()) {
171  const auto& pair = m_fit.insert(std::make_pair(faceId, FaceInfo()));
172  info = &pair.first->second;
173 
174  extendFaceInfoLifetime(*info, faceId);
175  }
176  else {
177  info = &it->second;
178  }
179 
180  return *info;
181 }
182 
183 void
185 {
186  m_fit.erase(faceId);
187 }
188 
189 void
191 {
192  // Cancel previous expiration
194 
195  // Refresh measurement
197  bind(&NamespaceInfo::expireFaceInfo, this, faceId));
198 
200 }
201 
204 
205 constexpr time::microseconds AsfMeasurements::MEASUREMENTS_LIFETIME;
206 
208  : m_measurements(measurements)
209 {
210 }
211 
212 FaceInfo*
213 AsfMeasurements::getFaceInfo(const fib::Entry& fibEntry, const Interest& interest, FaceId faceId)
214 {
215  NamespaceInfo& info = getOrCreateNamespaceInfo(fibEntry, interest);
216  return info.getFaceInfo(fibEntry, faceId);
217 }
218 
219 FaceInfo&
221  FaceId faceId)
222 {
223  NamespaceInfo& info = getOrCreateNamespaceInfo(fibEntry, interest);
224  return info.getOrCreateFaceInfo(fibEntry, faceId);
225 }
226 
229 {
230  measurements::Entry* me = m_measurements.findLongestPrefixMatch(prefix);
231  if (me == nullptr) {
232  return nullptr;
233  }
234 
235  // Set or update entry lifetime
236  extendLifetime(*me);
237 
238  NamespaceInfo* info = me->insertStrategyInfo<NamespaceInfo>().first;
239  BOOST_ASSERT(info != nullptr);
240  return info;
241 }
242 
245 {
246  measurements::Entry* me = m_measurements.get(fibEntry);
247 
248  // If the FIB entry is not under the strategy's namespace, find a part of the prefix
249  // that falls under the strategy's namespace
250  for (size_t prefixLen = fibEntry.getPrefix().size() + 1;
251  me == nullptr && prefixLen <= interest.getName().size(); ++prefixLen) {
252  me = m_measurements.get(interest.getName().getPrefix(prefixLen));
253  }
254 
255  // Either the FIB entry or the Interest's name must be under this strategy's namespace
256  BOOST_ASSERT(me != nullptr);
257 
258  // Set or update entry lifetime
259  extendLifetime(*me);
260 
261  NamespaceInfo* info = me->insertStrategyInfo<NamespaceInfo>().first;
262  BOOST_ASSERT(info != nullptr);
263  return *info;
264 }
265 
266 void
267 AsfMeasurements::extendLifetime(measurements::Entry& me)
268 {
269  m_measurements.extendLifetime(me, MEASUREMENTS_LIFETIME);
270 }
271 
272 } // namespace asf
273 } // namespace fw
274 } // namespace nfd
time::microseconds Duration
PartialName getPrefix(ssize_t nComponents) const
Extract a prefix of the name.
Definition: name.hpp:210
const Name & getPrefix() const
Definition: fib-entry.hpp:58
FaceInfo & getOrCreateFaceInfo(const fib::Entry &fibEntry, FaceId faceId)
void recordRtt(const shared_ptr< pit::Entry > &pitEntry, const Face &inFace)
void setMeasurementExpirationEventId(const scheduler::EventId &id)
generalization of a network interface
Definition: face.hpp:67
void cancel(const EventId &eventId)
cancel a scheduled event
Definition: scheduler.cpp:53
represents a FIB entry
Definition: fib-entry.hpp:51
void addRttMeasurement(RttEstimator::Duration &durationRtt)
static time_point now() noexcept
Definition: time.cpp:80
bool isPrefixOf(const Name &other) const
Check if this name is a prefix of another name.
Definition: name.cpp:260
void extendFaceInfoLifetime(FaceInfo &info, FaceId faceId)
FaceInfo & getOrCreateFaceInfo(const fib::Entry &fibEntry, const Interest &interest, FaceId faceId)
const scheduler::EventId & getMeasurementExpirationEventId()
AsfMeasurements(MeasurementsAccessor &measurements)
represents an Interest packet
Definition: interest.hpp:42
stores stategy information about each face in this namespace
void extendLifetime(Entry &entry, const time::nanoseconds &lifetime)
extend lifetime of an entry
Entry * findLongestPrefixMatch(const Name &name, const EntryPredicate &pred=AnyEntry()) const
perform a longest prefix match for name
static const Rtt RTT_TIMEOUT
void cancelTimeoutEvent(const Name &prefix)
represents a Measurements entry
Table::const_iterator iterator
Definition: cs-internal.hpp:41
std::shared_ptr< ns3::EventId > EventId
Definition: scheduler.hpp:51
#define NFD_LOG_TRACE(expression)
Definition: logger.hpp:54
void expireFaceInfo(FaceId faceId)
void addMeasurement(Duration measure)
Copyright (c) 2011-2015 Regents of the University of California.
Definition: ndn-common.hpp:40
FaceId getId() const
Definition: face.hpp:233
NamespaceInfo & getOrCreateNamespaceInfo(const fib::Entry &fibEntry, const Interest &interest)
static const Rtt RTT_NO_MEASUREMENT
static constexpr time::microseconds MEASUREMENTS_LIFETIME
Represents an absolute name.
Definition: name.hpp:42
void setTimeoutEvent(const scheduler::EventId &id, const Name &interestName)
std::pair< T *, bool > insertStrategyInfo(A &&... args)
insert a StrategyInfo item
Strategy information for each face in a namespace.
size_t size() const
Get number of components.
Definition: name.hpp:154
allows Strategy to access portion of Measurements table under its namespace
NamespaceInfo * getNamespaceInfo(const Name &prefix)
EventId schedule(time::nanoseconds after, const EventCallback &event)
schedule an event
Definition: scheduler.cpp:47
Entry * get(const Name &name)
find or insert a Measurements entry for name
FaceInfo * getFaceInfo(const fib::Entry &fibEntry, FaceId faceId)
void recordTimeout(const Name &interestName)
FaceInfo * getFaceInfo(const fib::Entry &fibEntry, const Interest &interest, FaceId faceId)
uint64_t FaceId
identifies a face
Definition: face.hpp:39
#define NFD_LOG_INIT(name)
Definition: logger.hpp:34
time::duration< double, boost::micro > Rtt
const Name & getName() const
Definition: interest.hpp:139