catchunks: refactor in preparation for CUBIC pipeline.
Rename AIMD pipeline to "Adaptive Pipeline".
Remove "aimd-" from command line options.
Change-Id: Ie5689cf3c0b90bedb322fd42dbf289f8a04e56d2
refs: #4861
diff --git a/tools/chunks/catchunks/pipeline-interests-fixed.cpp b/tools/chunks/catchunks/pipeline-interests-fixed.cpp
new file mode 100644
index 0000000..6df6d27
--- /dev/null
+++ b/tools/chunks/catchunks/pipeline-interests-fixed.cpp
@@ -0,0 +1,187 @@
+/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
+/*
+ * Copyright (c) 2016-2019, Regents of the University of California,
+ * Colorado State University,
+ * University Pierre & Marie Curie, Sorbonne University.
+ *
+ * This file is part of ndn-tools (Named Data Networking Essential Tools).
+ * See AUTHORS.md for complete list of ndn-tools authors and contributors.
+ *
+ * ndn-tools 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.
+ *
+ * ndn-tools 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
+ * ndn-tools, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
+ *
+ * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
+ *
+ * @author Wentao Shang
+ * @author Steve DiBenedetto
+ * @author Andrea Tosatto
+ * @author Davide Pesavento
+ * @author Chavoosh Ghasemi
+ */
+
+#include "pipeline-interests-fixed.hpp"
+#include "data-fetcher.hpp"
+
+namespace ndn {
+namespace chunks {
+
+PipelineInterestsFixed::PipelineInterestsFixed(Face& face, const Options& options)
+ : PipelineInterests(face)
+ , m_options(options)
+ , m_hasFailure(false)
+{
+ m_segmentFetchers.resize(m_options.maxPipelineSize);
+}
+
+PipelineInterestsFixed::~PipelineInterestsFixed()
+{
+ cancel();
+}
+
+void
+PipelineInterestsFixed::doRun()
+{
+ // if the FinalBlockId is unknown, this could potentially request non-existent segments
+ for (size_t nRequestedSegments = 0;
+ nRequestedSegments < m_options.maxPipelineSize;
+ ++nRequestedSegments) {
+ if (!fetchNextSegment(nRequestedSegments))
+ // all segments have been requested
+ break;
+ }
+}
+
+bool
+PipelineInterestsFixed::fetchNextSegment(std::size_t pipeNo)
+{
+ if (isStopping())
+ return false;
+
+ if (m_hasFailure) {
+ onFailure("Fetching terminated but no final segment number has been found");
+ return false;
+ }
+
+ uint64_t nextSegmentNo = getNextSegmentNo();
+ if (m_hasFinalBlockId && nextSegmentNo > m_lastSegmentNo)
+ return false;
+
+ // send interest for next segment
+ if (m_options.isVerbose)
+ std::cerr << "Requesting segment #" << nextSegmentNo << std::endl;
+
+ Interest interest(Name(m_prefix).appendSegment(nextSegmentNo));
+ interest.setInterestLifetime(m_options.interestLifetime);
+ interest.setMustBeFresh(m_options.mustBeFresh);
+ interest.setMaxSuffixComponents(1);
+
+ auto fetcher = DataFetcher::fetch(m_face, interest,
+ m_options.maxRetriesOnTimeoutOrNack,
+ m_options.maxRetriesOnTimeoutOrNack,
+ bind(&PipelineInterestsFixed::handleData, this, _1, _2, pipeNo),
+ bind(&PipelineInterestsFixed::handleFail, this, _2, pipeNo),
+ bind(&PipelineInterestsFixed::handleFail, this, _2, pipeNo),
+ m_options.isVerbose);
+
+ BOOST_ASSERT(!m_segmentFetchers[pipeNo].first || !m_segmentFetchers[pipeNo].first->isRunning());
+ m_segmentFetchers[pipeNo] = make_pair(fetcher, nextSegmentNo);
+
+ return true;
+}
+
+void
+PipelineInterestsFixed::doCancel()
+{
+ for (auto& fetcher : m_segmentFetchers) {
+ if (fetcher.first)
+ fetcher.first->cancel();
+ }
+
+ m_segmentFetchers.clear();
+}
+
+void
+PipelineInterestsFixed::handleData(const Interest& interest, const Data& data, size_t pipeNo)
+{
+ if (isStopping())
+ return;
+
+ BOOST_ASSERT(data.getName().equals(interest.getName()));
+
+ if (m_options.isVerbose)
+ std::cerr << "Received segment #" << getSegmentFromPacket(data) << std::endl;
+
+ onData(data);
+
+ if (!m_hasFinalBlockId && data.getFinalBlock()) {
+ m_lastSegmentNo = data.getFinalBlock()->toSegment();
+ m_hasFinalBlockId = true;
+
+ for (auto& fetcher : m_segmentFetchers) {
+ if (fetcher.first == nullptr)
+ continue;
+
+ if (fetcher.second > m_lastSegmentNo) {
+ // stop trying to fetch segments that are beyond m_lastSegmentNo
+ fetcher.first->cancel();
+ }
+ else if (fetcher.first->hasError()) { // fetcher.second <= m_lastSegmentNo
+ // there was an error while fetching a segment that is part of the content
+ return onFailure("Failure retrieving segment #" + to_string(fetcher.second));
+ }
+ }
+ }
+
+ if (allSegmentsReceived()) {
+ if (!m_options.isQuiet) {
+ printSummary();
+ }
+ }
+ else {
+ fetchNextSegment(pipeNo);
+ }
+}
+
+void PipelineInterestsFixed::handleFail(const std::string& reason, std::size_t pipeNo)
+{
+ if (isStopping())
+ return;
+
+ // if the failed segment is definitely part of the content, raise a fatal error
+ if (m_hasFinalBlockId && m_segmentFetchers[pipeNo].second <= m_lastSegmentNo)
+ return onFailure(reason);
+
+ if (!m_hasFinalBlockId) {
+ bool areAllFetchersStopped = true;
+ for (auto& fetcher : m_segmentFetchers) {
+ if (fetcher.first == nullptr)
+ continue;
+
+ // cancel fetching all segments that follow
+ if (fetcher.second > m_segmentFetchers[pipeNo].second) {
+ fetcher.first->cancel();
+ }
+ else if (fetcher.first->isRunning()) { // fetcher.second <= m_segmentFetchers[pipeNo].second
+ areAllFetchersStopped = false;
+ }
+ }
+
+ if (areAllFetchersStopped) {
+ onFailure("Fetching terminated but no final segment number has been found");
+ }
+ else {
+ m_hasFailure = true;
+ }
+ }
+}
+
+} // namespace chunks
+} // namespace ndn