| /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
| /* |
| * Copyright (c) 2014-2024, Regents of the University of California, |
| * Arizona Board of Regents, |
| * Colorado State University, |
| * University Pierre & Marie Curie, Sorbonne University, |
| * Washington University in St. Louis, |
| * Beijing Institute of Technology, |
| * The University of Memphis. |
| * |
| * This file is part of NFD (Named Data Networking Forwarding Daemon). |
| * See AUTHORS.md for complete list of NFD authors and contributors. |
| * |
| * NFD is free software: you can redistribute it and/or modify it under the terms |
| * of the GNU General Public License as published by the Free Software Foundation, |
| * either version 3 of the License, or (at your option) any later version. |
| * |
| * NFD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; |
| * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR |
| * PURPOSE. See the GNU General Public License for more details. |
| * |
| * You should have received a copy of the GNU General Public License along with |
| * NFD, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>. |
| */ |
| |
| #include "asf-strategy.hpp" |
| #include "algorithm.hpp" |
| #include "common/logger.hpp" |
| |
| namespace nfd::fw::asf { |
| |
| NFD_LOG_INIT(AsfStrategy); |
| NFD_REGISTER_STRATEGY(AsfStrategy); |
| |
| AsfStrategy::AsfStrategy(Forwarder& forwarder, const Name& name) |
| : Strategy(forwarder) |
| , ProcessNackTraits(this) |
| , m_measurements(getMeasurements()) |
| , m_probing(m_measurements) |
| { |
| ParsedInstanceName parsed = parseInstanceName(name); |
| if (parsed.version && *parsed.version != getStrategyName()[-1].toVersion()) { |
| NDN_THROW(std::invalid_argument("AsfStrategy does not support version " + |
| std::to_string(*parsed.version))); |
| } |
| |
| StrategyParameters params = parseParameters(parsed.parameters); |
| m_retxSuppression = RetxSuppressionExponential::construct(params); |
| auto probingInterval = params.getOrDefault<time::milliseconds::rep>("probing-interval", |
| m_probing.getProbingInterval().count()); |
| m_probing.setProbingInterval(time::milliseconds(probingInterval)); |
| m_nMaxTimeouts = params.getOrDefault<size_t>("max-timeouts", m_nMaxTimeouts); |
| |
| this->setInstanceName(makeInstanceName(name, getStrategyName())); |
| |
| NDN_LOG_DEBUG(*m_retxSuppression); |
| NFD_LOG_DEBUG("probing-interval=" << m_probing.getProbingInterval() |
| << " max-timeouts=" << m_nMaxTimeouts); |
| } |
| |
| const Name& |
| AsfStrategy::getStrategyName() |
| { |
| static const auto strategyName = Name("/localhost/nfd/strategy/asf").appendVersion(4); |
| return strategyName; |
| } |
| |
| void |
| AsfStrategy::afterReceiveInterest(const Interest& interest, const FaceEndpoint& ingress, |
| const shared_ptr<pit::Entry>& pitEntry) |
| { |
| const auto& fibEntry = this->lookupFib(*pitEntry); |
| |
| // Check if the interest is new and, if so, skip the retx suppression check |
| if (!hasPendingOutRecords(*pitEntry)) { |
| auto* faceToUse = getBestFaceForForwarding(interest, ingress.face, fibEntry, pitEntry); |
| if (faceToUse == nullptr) { |
| NFD_LOG_INTEREST_FROM(interest, ingress, "new no-nexthop"); |
| sendNoRouteNack(ingress.face, pitEntry); |
| } |
| else { |
| NFD_LOG_INTEREST_FROM(interest, ingress, "new forward-to=" << faceToUse->getId()); |
| forwardInterest(interest, *faceToUse, fibEntry, pitEntry); |
| sendProbe(interest, ingress, *faceToUse, fibEntry, pitEntry); |
| } |
| return; |
| } |
| |
| auto* faceToUse = getBestFaceForForwarding(interest, ingress.face, fibEntry, pitEntry, false); |
| if (faceToUse != nullptr) { |
| auto suppressResult = m_retxSuppression->decidePerUpstream(*pitEntry, *faceToUse); |
| if (suppressResult == RetxSuppressionResult::SUPPRESS) { |
| // Cannot be sent on this face, interest was received within the suppression window |
| NFD_LOG_INTEREST_FROM(interest, ingress, "retx forward-to=" << faceToUse->getId() << " suppressed"); |
| } |
| else { |
| // The retx arrived after the suppression period: forward it but don't probe, because |
| // probing was done earlier for this interest when it was newly received |
| NFD_LOG_INTEREST_FROM(interest, ingress, "retx forward-to=" << faceToUse->getId()); |
| auto* outRecord = forwardInterest(interest, *faceToUse, fibEntry, pitEntry); |
| if (outRecord && suppressResult == RetxSuppressionResult::FORWARD) { |
| m_retxSuppression->incrementIntervalForOutRecord(*outRecord); |
| } |
| } |
| return; |
| } |
| |
| // If all eligible faces have been used (i.e., they all have a pending out-record), |
| // choose the nexthop with the earliest out-record |
| const auto& nexthops = fibEntry.getNextHops(); |
| auto it = findEligibleNextHopWithEarliestOutRecord(ingress.face, interest, nexthops, pitEntry); |
| if (it == nexthops.end()) { |
| NFD_LOG_INTEREST_FROM(interest, ingress, "retx no-nexthop"); |
| return; |
| } |
| auto& outFace = it->getFace(); |
| auto suppressResult = m_retxSuppression->decidePerUpstream(*pitEntry, outFace); |
| if (suppressResult == RetxSuppressionResult::SUPPRESS) { |
| NFD_LOG_INTEREST_FROM(interest, ingress, "retx retry-to=" << outFace.getId() << " suppressed"); |
| } |
| else { |
| NFD_LOG_INTEREST_FROM(interest, ingress, "retx retry-to=" << outFace.getId()); |
| // sendInterest() is used here instead of forwardInterest() because the measurements info |
| // were already attached to this face in the previous forwarding |
| auto* outRecord = sendInterest(interest, outFace, pitEntry); |
| if (outRecord && suppressResult == RetxSuppressionResult::FORWARD) { |
| m_retxSuppression->incrementIntervalForOutRecord(*outRecord); |
| } |
| } |
| } |
| |
| void |
| AsfStrategy::beforeSatisfyInterest(const Data& data, const FaceEndpoint& ingress, |
| const shared_ptr<pit::Entry>& pitEntry) |
| { |
| NamespaceInfo* namespaceInfo = m_measurements.getNamespaceInfo(pitEntry->getName()); |
| if (namespaceInfo == nullptr) { |
| NFD_LOG_DATA_FROM(data, ingress, "no-measurements"); |
| return; |
| } |
| |
| // Record the RTT between the Interest out to Data in |
| FaceInfo* faceInfo = namespaceInfo->getFaceInfo(ingress.face.getId()); |
| if (faceInfo == nullptr) { |
| NFD_LOG_DATA_FROM(data, ingress, "no-face-info"); |
| return; |
| } |
| |
| auto outRecord = pitEntry->getOutRecord(ingress.face); |
| if (outRecord == pitEntry->out_end()) { |
| NFD_LOG_DATA_FROM(data, ingress, "no-out-record"); |
| } |
| else { |
| faceInfo->recordRtt(time::steady_clock::now() - outRecord->getLastRenewed()); |
| NFD_LOG_DATA_FROM(data, ingress, "rtt=" << faceInfo->getLastRtt() << " srtt=" << faceInfo->getSrtt()); |
| } |
| |
| // Extend lifetime for measurements associated with Face |
| namespaceInfo->extendFaceInfoLifetime(*faceInfo, ingress.face.getId()); |
| // Extend PIT entry timer to allow slower probes to arrive |
| this->setExpiryTimer(pitEntry, 50_ms); |
| faceInfo->cancelTimeout(data.getName()); |
| } |
| |
| void |
| AsfStrategy::afterReceiveNack(const lp::Nack& nack, const FaceEndpoint& ingress, |
| const shared_ptr<pit::Entry>& pitEntry) |
| { |
| NFD_LOG_NACK_FROM(nack, ingress, ""); |
| onTimeoutOrNack(pitEntry->getName(), ingress.face.getId(), true); |
| this->processNack(nack, ingress.face, pitEntry); |
| } |
| |
| pit::OutRecord* |
| AsfStrategy::forwardInterest(const Interest& interest, Face& outFace, const fib::Entry& fibEntry, |
| const shared_ptr<pit::Entry>& pitEntry) |
| { |
| const auto& interestName = interest.getName(); |
| auto faceId = outFace.getId(); |
| |
| auto* outRecord = sendInterest(interest, outFace, pitEntry); |
| |
| FaceInfo& faceInfo = m_measurements.getOrCreateFaceInfo(fibEntry, interestName, faceId); |
| |
| // Refresh measurements since Face is being used for forwarding |
| NamespaceInfo& namespaceInfo = m_measurements.getOrCreateNamespaceInfo(fibEntry, interestName); |
| namespaceInfo.extendFaceInfoLifetime(faceInfo, faceId); |
| |
| if (!faceInfo.isTimeoutScheduled()) { |
| auto timeout = faceInfo.scheduleTimeout(interestName, |
| [this, name = interestName, faceId] { |
| onTimeoutOrNack(name, faceId, false); |
| }); |
| NFD_LOG_TRACE("Scheduled timeout for " << fibEntry.getPrefix() << " to=" << faceId |
| << " in " << time::duration_cast<time::milliseconds>(timeout)); |
| } |
| |
| return outRecord; |
| } |
| |
| void |
| AsfStrategy::sendProbe(const Interest& interest, const FaceEndpoint& ingress, const Face& faceToUse, |
| const fib::Entry& fibEntry, const shared_ptr<pit::Entry>& pitEntry) |
| { |
| if (!m_probing.isProbingNeeded(fibEntry, interest.getName())) |
| return; |
| |
| Face* faceToProbe = m_probing.getFaceToProbe(ingress.face, interest, fibEntry, faceToUse); |
| if (faceToProbe == nullptr) |
| return; |
| |
| Interest probeInterest(interest); |
| probeInterest.refreshNonce(); |
| NFD_LOG_DEBUG("Sending probe " << probeInterest.getName() << " nonce=" << probeInterest.getNonce() |
| << " to=" << faceToProbe->getId() << " trigger-nonce=" << interest.getNonce()); |
| forwardInterest(probeInterest, *faceToProbe, fibEntry, pitEntry); |
| |
| m_probing.afterForwardingProbe(fibEntry, interest.getName()); |
| } |
| |
| struct FaceStats |
| { |
| Face* face; |
| time::nanoseconds rtt; |
| time::nanoseconds srtt; |
| uint64_t cost; |
| }; |
| |
| struct FaceStatsCompare |
| { |
| bool |
| operator()(const FaceStats& lhs, const FaceStats& rhs) const |
| { |
| time::nanoseconds lhsValue = getValueForSorting(lhs); |
| time::nanoseconds rhsValue = getValueForSorting(rhs); |
| |
| // Sort by RTT and then by cost |
| return std::tie(lhsValue, lhs.cost) < std::tie(rhsValue, rhs.cost); |
| } |
| |
| private: |
| static time::nanoseconds |
| getValueForSorting(const FaceStats& stats) |
| { |
| // These values allow faces with no measurements to be ranked better than timeouts |
| // srtt < RTT_NO_MEASUREMENT < RTT_TIMEOUT |
| if (stats.rtt == FaceInfo::RTT_TIMEOUT) { |
| return time::nanoseconds::max(); |
| } |
| else if (stats.rtt == FaceInfo::RTT_NO_MEASUREMENT) { |
| return time::nanoseconds::max() / 2; |
| } |
| else { |
| return stats.srtt; |
| } |
| } |
| }; |
| |
| Face* |
| AsfStrategy::getBestFaceForForwarding(const Interest& interest, const Face& inFace, |
| const fib::Entry& fibEntry, const shared_ptr<pit::Entry>& pitEntry, |
| bool isInterestNew) |
| { |
| std::set<FaceStats, FaceStatsCompare> rankedFaces; |
| |
| auto now = time::steady_clock::now(); |
| for (const auto& nh : fibEntry.getNextHops()) { |
| if (!isNextHopEligible(inFace, interest, nh, pitEntry, !isInterestNew, now)) { |
| continue; |
| } |
| |
| const FaceInfo* info = m_measurements.getFaceInfo(fibEntry, interest.getName(), nh.getFace().getId()); |
| if (info == nullptr) { |
| rankedFaces.insert({&nh.getFace(), FaceInfo::RTT_NO_MEASUREMENT, |
| FaceInfo::RTT_NO_MEASUREMENT, nh.getCost()}); |
| } |
| else { |
| rankedFaces.insert({&nh.getFace(), info->getLastRtt(), info->getSrtt(), nh.getCost()}); |
| } |
| } |
| |
| auto it = rankedFaces.begin(); |
| return it != rankedFaces.end() ? it->face : nullptr; |
| } |
| |
| void |
| AsfStrategy::onTimeoutOrNack(const Name& interestName, FaceId faceId, bool isNack) |
| { |
| NamespaceInfo* namespaceInfo = m_measurements.getNamespaceInfo(interestName); |
| if (namespaceInfo == nullptr) { |
| NFD_LOG_TRACE(interestName << " FibEntry has been removed since timeout scheduling"); |
| return; |
| } |
| |
| FaceInfo* fiPtr = namespaceInfo->getFaceInfo(faceId); |
| if (fiPtr == nullptr) { |
| NFD_LOG_TRACE(interestName << " FaceInfo id=" << faceId << " has been removed since timeout scheduling"); |
| return; |
| } |
| |
| auto& faceInfo = *fiPtr; |
| size_t nTimeouts = faceInfo.getNTimeouts() + 1; |
| faceInfo.setNTimeouts(nTimeouts); |
| |
| if (nTimeouts < m_nMaxTimeouts && !isNack) { |
| NFD_LOG_TRACE(interestName << " face=" << faceId << " timeout-count=" << nTimeouts << " ignoring"); |
| // Extend lifetime for measurements associated with Face |
| namespaceInfo->extendFaceInfoLifetime(faceInfo, faceId); |
| faceInfo.cancelTimeout(interestName); |
| } |
| else { |
| NFD_LOG_TRACE(interestName << " face=" << faceId << " timeout-count=" << nTimeouts); |
| faceInfo.recordTimeout(interestName); |
| } |
| } |
| |
| void |
| AsfStrategy::sendNoRouteNack(Face& face, const shared_ptr<pit::Entry>& pitEntry) |
| { |
| lp::NackHeader nackHeader; |
| nackHeader.setReason(lp::NackReason::NO_ROUTE); |
| this->sendNack(nackHeader, face, pitEntry); |
| this->rejectPendingInterest(pitEntry); |
| } |
| |
| } // namespace nfd::fw::asf |