blob: d438f1069adc8d7a288d11f76de01d25e7a03fd3 [file] [log] [blame]
Alexander Afanasyev33b72772014-01-26 23:22:58 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
3 * Copyright (C) 2014 Named Data Networking Project
4 * See COPYING for copyright and distribution information.
5 */
6
7#include "forwarder.hpp"
Junxiao Shi8c8d2182014-01-30 22:33:00 -07008#include "core/logger.hpp"
9#include "best-route-strategy.hpp"
Alexander Afanasyev33b72772014-01-26 23:22:58 -080010
Alexander Afanasyev18bbf812014-01-29 01:40:23 -080011namespace nfd {
Alexander Afanasyev33b72772014-01-26 23:22:58 -080012
Junxiao Shi8c8d2182014-01-30 22:33:00 -070013NFD_LOG_INIT("Forwarder");
14
Junxiao Shi88884492014-02-15 15:57:43 -070015const Name Forwarder::s_localhostName("ndn:/localhost");
16
Junxiao Shic041ca32014-02-25 20:01:15 -070017Forwarder::Forwarder()
18 : m_lastFaceId(0)
Alexander Afanasyev33b72772014-01-26 23:22:58 -080019{
Junxiao Shi8c8d2182014-01-30 22:33:00 -070020 m_strategy = make_shared<fw::BestRouteStrategy>(boost::ref(*this));
Alexander Afanasyev33b72772014-01-26 23:22:58 -080021}
22
23void
Junxiao Shi8c8d2182014-01-30 22:33:00 -070024Forwarder::addFace(shared_ptr<Face> face)
Alexander Afanasyev33b72772014-01-26 23:22:58 -080025{
Junxiao Shi8c8d2182014-01-30 22:33:00 -070026 FaceId faceId = ++m_lastFaceId;
27 face->setId(faceId);
28 m_faces[faceId] = face;
29 NFD_LOG_INFO("addFace id=" << faceId);
30
31 face->onReceiveInterest += bind(&Forwarder::onInterest,
32 this, boost::ref(*face), _1);
33 face->onReceiveData += bind(&Forwarder::onData,
34 this, boost::ref(*face), _1);
Alexander Afanasyev33b72772014-01-26 23:22:58 -080035}
36
37void
Junxiao Shi8c8d2182014-01-30 22:33:00 -070038Forwarder::removeFace(shared_ptr<Face> face)
Alexander Afanasyev33b72772014-01-26 23:22:58 -080039{
Junxiao Shi8c8d2182014-01-30 22:33:00 -070040 FaceId faceId = face->getId();
41 m_faces.erase(faceId);
42 face->setId(INVALID_FACEID);
43 NFD_LOG_INFO("removeFace id=" << faceId);
Junxiao Shic041ca32014-02-25 20:01:15 -070044
Junxiao Shi8c8d2182014-01-30 22:33:00 -070045 // XXX This clears all subscriptions, because EventEmitter
46 // does not support only removing Forwarder's subscription
47 face->onReceiveInterest.clear();
48 face->onReceiveData .clear();
Junxiao Shic041ca32014-02-25 20:01:15 -070049
Junxiao Shi8c8d2182014-01-30 22:33:00 -070050 m_fib.removeNextHopFromAllEntries(face);
Alexander Afanasyev33b72772014-01-26 23:22:58 -080051}
52
Steve DiBenedetto26b730f2014-02-02 18:36:16 -070053shared_ptr<Face>
54Forwarder::getFace(FaceId id)
55{
56 std::map<FaceId, shared_ptr<Face> >::iterator i = m_faces.find(id);
57 return (i == m_faces.end()) ? (shared_ptr<Face>()) : (i->second);
58}
59
Alexander Afanasyev33b72772014-01-26 23:22:58 -080060void
Junxiao Shi8c8d2182014-01-30 22:33:00 -070061Forwarder::onInterest(Face& face, const Interest& interest)
Alexander Afanasyev33b72772014-01-26 23:22:58 -080062{
Junxiao Shi8c8d2182014-01-30 22:33:00 -070063 this->onIncomingInterest(face, interest);
64}
65
66void
67Forwarder::onData(Face& face, const Data& data)
68{
69 this->onIncomingData(face, data);
Alexander Afanasyev33b72772014-01-26 23:22:58 -080070}
71
Junxiao Shid3c792f2014-01-30 00:46:13 -070072void
73Forwarder::onIncomingInterest(Face& inFace, const Interest& interest)
74{
75 // receive Interest
Junxiao Shi8c8d2182014-01-30 22:33:00 -070076 NFD_LOG_DEBUG("onIncomingInterest face=" << inFace.getId() << " interest=" << interest.getName());
Junxiao Shi06887ac2014-02-13 20:15:42 -070077 const_cast<Interest&>(interest).setIncomingFaceId(inFace.getId());
Junxiao Shic041ca32014-02-25 20:01:15 -070078
Junxiao Shi88884492014-02-15 15:57:43 -070079 // /localhost scope control
80 bool violatesLocalhost = !inFace.isLocal() &&
81 s_localhostName.isPrefixOf(interest.getName());
82 if (violatesLocalhost) {
83 NFD_LOG_DEBUG("onIncomingInterest face=" << inFace.getId()
84 << " interest=" << interest.getName() << " violates /localhost");
85 return;
86 }
Junxiao Shic041ca32014-02-25 20:01:15 -070087
Junxiao Shid3c792f2014-01-30 00:46:13 -070088 // PIT insert
89 std::pair<shared_ptr<pit::Entry>, bool>
90 pitInsertResult = m_pit.insert(interest);
91 shared_ptr<pit::Entry> pitEntry = pitInsertResult.first;
Junxiao Shic041ca32014-02-25 20:01:15 -070092
Junxiao Shid3c792f2014-01-30 00:46:13 -070093 // detect loop and record Nonce
94 bool isLoop = ! pitEntry->addNonce(interest.getNonce());
95 if (isLoop) {
96 // goto Interest loop pipeline
97 this->onInterestLoop(inFace, interest, pitEntry);
98 return;
99 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700100
Junxiao Shid3c792f2014-01-30 00:46:13 -0700101 // cancel unsatisfy & straggler timer
102 this->cancelUnsatisfyAndStragglerTimer(pitEntry);
Junxiao Shic041ca32014-02-25 20:01:15 -0700103
Junxiao Shid3c792f2014-01-30 00:46:13 -0700104 const pit::InRecordCollection& inRecords = pitEntry->getInRecords();
105 bool isPending = inRecords.begin() == inRecords.end();
Junxiao Shic041ca32014-02-25 20:01:15 -0700106
Junxiao Shid3c792f2014-01-30 00:46:13 -0700107 if (!isPending) {
108 // CS lookup
109 const Data* csMatch = m_cs.find(interest);
110 if (csMatch != 0) {
111 // XXX should we lookup PIT for other Interests that also match csMatch?
112
113 // goto outgoing Data pipeline
114 this->onOutgoingData(*csMatch, inFace);
115 return;
116 }
117 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700118
Junxiao Shid3c792f2014-01-30 00:46:13 -0700119 // insert InRecord
120 pit::InRecordCollection::iterator inRecordIt =
121 pitEntry->insertOrUpdateInRecord(inFace.shared_from_this(), interest);
Junxiao Shic041ca32014-02-25 20:01:15 -0700122
Junxiao Shid3c792f2014-01-30 00:46:13 -0700123 // app chosen nexthops
124 bool isAppChosenNexthops = false; // TODO get from local control header
125 if (isAppChosenNexthops) {
126 // TODO foreach chosen nexthop: goto outgoing Interest pipeline
127 return;
128 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700129
Junxiao Shid3c792f2014-01-30 00:46:13 -0700130 // FIB lookup
131 shared_ptr<fib::Entry> fibEntry
132 = m_fib.findLongestPrefixMatch(interest.getName());
133 // TODO use Fib::findParent(pitEntry)
Junxiao Shic041ca32014-02-25 20:01:15 -0700134
Junxiao Shid3c792f2014-01-30 00:46:13 -0700135 // dispatch to strategy
Junxiao Shi88884492014-02-15 15:57:43 -0700136 this->dispatchToStrategy(inFace, interest, fibEntry, pitEntry);
Junxiao Shid3c792f2014-01-30 00:46:13 -0700137}
138
139void
140Forwarder::onInterestLoop(Face& inFace, const Interest& interest,
141 shared_ptr<pit::Entry> pitEntry)
142{
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700143 NFD_LOG_DEBUG("onInterestLoop face=" << inFace.getId() << " interest=" << interest.getName());
144
Junxiao Shid3c792f2014-01-30 00:46:13 -0700145 // do nothing, which means Interest is dropped
146}
147
148void
149Forwarder::onOutgoingInterest(shared_ptr<pit::Entry> pitEntry, Face& outFace)
150{
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700151 NFD_LOG_DEBUG("onOutgoingInterest face=" << outFace.getId() << " interest=" << pitEntry->getName());
152
Junxiao Shid3c792f2014-01-30 00:46:13 -0700153 // pick Interest
154 const Interest& interest = pitEntry->getInterest();
155 // TODO pick the last incoming Interest
Junxiao Shic041ca32014-02-25 20:01:15 -0700156
Junxiao Shid3c792f2014-01-30 00:46:13 -0700157 // insert OutRecord
158 pit::OutRecordCollection::iterator outRecordIt =
159 pitEntry->insertOrUpdateOutRecord(outFace.shared_from_this(), interest);
Junxiao Shic041ca32014-02-25 20:01:15 -0700160
Junxiao Shid3c792f2014-01-30 00:46:13 -0700161 // set PIT unsatisfy timer
162 this->setUnsatisfyTimer(pitEntry);
Junxiao Shic041ca32014-02-25 20:01:15 -0700163
Junxiao Shid3c792f2014-01-30 00:46:13 -0700164 // send Interest
165 outFace.sendInterest(interest);
166}
167
168void
Junxiao Shi09498f02014-02-26 19:41:08 -0700169Forwarder::onInterestReject(shared_ptr<pit::Entry> pitEntry)
Junxiao Shid3c792f2014-01-30 00:46:13 -0700170{
Junxiao Shi09498f02014-02-26 19:41:08 -0700171 NFD_LOG_DEBUG("onInterestReject interest=" << pitEntry->getName());
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700172
Junxiao Shid3c792f2014-01-30 00:46:13 -0700173 // set PIT straggler timer
174 this->setStragglerTimer(pitEntry);
175}
176
177void
178Forwarder::onInterestUnsatisfied(shared_ptr<pit::Entry> pitEntry)
179{
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700180 NFD_LOG_DEBUG("onInterestUnsatisfied interest=" << pitEntry->getName());
181
Junxiao Shid3c792f2014-01-30 00:46:13 -0700182 // invoke PIT unsatisfied callback
183 // TODO
Junxiao Shic041ca32014-02-25 20:01:15 -0700184
Junxiao Shid3c792f2014-01-30 00:46:13 -0700185 // PIT delete
186 m_pit.remove(pitEntry);
187}
188
189void
190Forwarder::onIncomingData(Face& inFace, const Data& data)
191{
192 // receive Data
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700193 NFD_LOG_DEBUG("onIncomingData face=" << inFace.getId() << " data=" << data.getName());
Junxiao Shi06887ac2014-02-13 20:15:42 -0700194 const_cast<Data&>(data).setIncomingFaceId(inFace.getId());
Junxiao Shic041ca32014-02-25 20:01:15 -0700195
Junxiao Shi88884492014-02-15 15:57:43 -0700196 // /localhost scope control
197 bool violatesLocalhost = !inFace.isLocal() &&
198 s_localhostName.isPrefixOf(data.getName());
199 if (violatesLocalhost) {
200 NFD_LOG_DEBUG("onIncomingData face=" << inFace.getId()
201 << " interest=" << data.getName() << " violates /localhost");
202 return;
203 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700204
Junxiao Shid3c792f2014-01-30 00:46:13 -0700205 // PIT match
206 shared_ptr<pit::DataMatchResult> pitMatches = m_pit.findAllDataMatches(data);
207 if (pitMatches->begin() == pitMatches->end()) {
208 // goto Data unsolicited pipeline
209 this->onDataUnsolicited(inFace, data);
210 return;
211 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700212
Junxiao Shid3c792f2014-01-30 00:46:13 -0700213 // CS insert
214 m_cs.insert(data);
Junxiao Shic041ca32014-02-25 20:01:15 -0700215
Junxiao Shid3c792f2014-01-30 00:46:13 -0700216 std::set<shared_ptr<Face> > pendingDownstreams;
217 // foreach PitEntry
218 for (pit::DataMatchResult::iterator it = pitMatches->begin();
219 it != pitMatches->end(); ++it) {
220 shared_ptr<pit::Entry> pitEntry = *it;
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700221 NFD_LOG_DEBUG("onIncomingData matching=" << pitEntry->getName());
Junxiao Shic041ca32014-02-25 20:01:15 -0700222
Junxiao Shid3c792f2014-01-30 00:46:13 -0700223 // cancel unsatisfy & straggler timer
224 this->cancelUnsatisfyAndStragglerTimer(pitEntry);
Junxiao Shic041ca32014-02-25 20:01:15 -0700225
Junxiao Shid3c792f2014-01-30 00:46:13 -0700226 // remember pending downstreams
227 const pit::InRecordCollection& inRecords = pitEntry->getInRecords();
228 for (pit::InRecordCollection::const_iterator it = inRecords.begin();
229 it != inRecords.end(); ++it) {
230 if (it->getExpiry() > time::now()) {
231 pendingDownstreams.insert(it->getFace());
232 }
233 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700234
Junxiao Shid3c792f2014-01-30 00:46:13 -0700235 // mark PIT satisfied
236 pitEntry->deleteInRecords();
237 pitEntry->deleteOutRecord(inFace.shared_from_this());
Junxiao Shic041ca32014-02-25 20:01:15 -0700238
Junxiao Shid3c792f2014-01-30 00:46:13 -0700239 // set PIT straggler timer
240 this->setStragglerTimer(pitEntry);
Junxiao Shic041ca32014-02-25 20:01:15 -0700241
Junxiao Shid3c792f2014-01-30 00:46:13 -0700242 // invoke PIT satisfy callback
243 // TODO
244 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700245
Junxiao Shid3c792f2014-01-30 00:46:13 -0700246 // foreach pending downstream
247 for (std::set<shared_ptr<Face> >::iterator it = pendingDownstreams.begin();
248 it != pendingDownstreams.end(); ++it) {
249 // goto outgoing Data pipeline
250 this->onOutgoingData(data, **it);
251 }
252}
253
254void
255Forwarder::onDataUnsolicited(Face& inFace, const Data& data)
256{
257 // accept to cache?
258 bool acceptToCache = false;// TODO decision
259 if (acceptToCache) {
260 // CS insert
261 m_cs.insert(data);
262 }
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700263
264 NFD_LOG_DEBUG("onDataUnsolicited face=" << inFace.getId() << " data=" << data.getName() << " acceptToCache=" << acceptToCache);
Junxiao Shid3c792f2014-01-30 00:46:13 -0700265}
266
267void
268Forwarder::onOutgoingData(const Data& data, Face& outFace)
269{
Junxiao Shi8c8d2182014-01-30 22:33:00 -0700270 NFD_LOG_DEBUG("onOutgoingData face=" << outFace.getId() << " data=" << data.getName());
271
Junxiao Shid3c792f2014-01-30 00:46:13 -0700272 // traffic manager
273 // pass through
Junxiao Shic041ca32014-02-25 20:01:15 -0700274
Junxiao Shid3c792f2014-01-30 00:46:13 -0700275 // send Data
276 outFace.sendData(data);
277}
278
279static inline bool
280compare_InRecord_expiry(const pit::InRecord& a, const pit::InRecord& b)
281{
282 return a.getExpiry() < b.getExpiry();
283}
284
285void
286Forwarder::setUnsatisfyTimer(shared_ptr<pit::Entry> pitEntry)
287{
288 const pit::InRecordCollection& inRecords = pitEntry->getInRecords();
289 pit::InRecordCollection::const_iterator lastExpiring =
290 std::max_element(inRecords.begin(), inRecords.end(),
291 &compare_InRecord_expiry);
292
293 time::Point lastExpiry = lastExpiring->getExpiry();
294 time::Duration lastExpiryFromNow = lastExpiry - time::now();
295 if (lastExpiryFromNow <= time::seconds(0)) {
296 // TODO all InRecords are already expired; will this happen?
297 }
Junxiao Shic041ca32014-02-25 20:01:15 -0700298
299 pitEntry->m_unsatisfyTimer = scheduler::schedule(lastExpiryFromNow,
Junxiao Shid3c792f2014-01-30 00:46:13 -0700300 bind(&Forwarder::onInterestUnsatisfied, this, pitEntry));
301}
302
303void
304Forwarder::setStragglerTimer(shared_ptr<pit::Entry> pitEntry)
305{
306 time::Duration stragglerTime = time::milliseconds(100);
Junxiao Shic041ca32014-02-25 20:01:15 -0700307
308 pitEntry->m_stragglerTimer = scheduler::schedule(stragglerTime,
Junxiao Shid3c792f2014-01-30 00:46:13 -0700309 bind(&Pit::remove, &m_pit, pitEntry));
310}
311
312void
313Forwarder::cancelUnsatisfyAndStragglerTimer(shared_ptr<pit::Entry> pitEntry)
314{
Junxiao Shic041ca32014-02-25 20:01:15 -0700315 scheduler::cancel(pitEntry->m_unsatisfyTimer);
316 scheduler::cancel(pitEntry->m_stragglerTimer);
Junxiao Shid3c792f2014-01-30 00:46:13 -0700317}
318
Junxiao Shi88884492014-02-15 15:57:43 -0700319void
320Forwarder::dispatchToStrategy(const Face& inFace,
321 const Interest& interest,
322 shared_ptr<fib::Entry> fibEntry,
323 shared_ptr<pit::Entry> pitEntry)
324{
325 m_strategy->afterReceiveInterest(inFace, interest, fibEntry, pitEntry);
326 // TODO dispatch according to fibEntry
327}
Junxiao Shid3c792f2014-01-30 00:46:13 -0700328
Alexander Afanasyev18bbf812014-01-29 01:40:23 -0800329} // namespace nfd