cs-manager.cpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2019, 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 "cs-manager.hpp"
28 #include "table/cs.hpp"
29 
30 #include <ndn-cxx/mgmt/nfd/cs-info.hpp>
31 
32 namespace nfd {
33 
34 constexpr size_t CsManager::ERASE_LIMIT;
35 
36 CsManager::CsManager(Cs& cs, const ForwarderCounters& fwCounters,
37  Dispatcher& dispatcher, CommandAuthenticator& authenticator)
38  : ManagerBase("cs", dispatcher, authenticator)
39  , m_cs(cs)
40  , m_fwCounters(fwCounters)
41 {
42  registerCommandHandler<ndn::nfd::CsConfigCommand>("config",
43  bind(&CsManager::changeConfig, this, _4, _5));
44  registerCommandHandler<ndn::nfd::CsEraseCommand>("erase",
45  bind(&CsManager::erase, this, _4, _5));
46 
47  registerStatusDatasetHandler("info", bind(&CsManager::serveInfo, this, _1, _2, _3));
48 }
49 
50 void
51 CsManager::changeConfig(const ControlParameters& parameters,
52  const ndn::mgmt::CommandContinuation& done)
53 {
54  using ndn::nfd::CsFlagBit;
55 
56  if (parameters.hasCapacity()) {
57  m_cs.setLimit(parameters.getCapacity());
58  }
59 
60  if (parameters.hasFlagBit(CsFlagBit::BIT_CS_ENABLE_ADMIT)) {
61  m_cs.enableAdmit(parameters.getFlagBit(CsFlagBit::BIT_CS_ENABLE_ADMIT));
62  }
63 
64  if (parameters.hasFlagBit(CsFlagBit::BIT_CS_ENABLE_SERVE)) {
65  m_cs.enableServe(parameters.getFlagBit(CsFlagBit::BIT_CS_ENABLE_SERVE));
66  }
67 
68  ControlParameters body;
69  body.setCapacity(m_cs.getLimit());
70  body.setFlagBit(CsFlagBit::BIT_CS_ENABLE_ADMIT, m_cs.shouldAdmit(), false);
71  body.setFlagBit(CsFlagBit::BIT_CS_ENABLE_SERVE, m_cs.shouldServe(), false);
72  done(ControlResponse(200, "OK").setBody(body.wireEncode()));
73 }
74 
75 void
76 CsManager::erase(const ControlParameters& parameters,
77  const ndn::mgmt::CommandContinuation& done)
78 {
79  size_t count = parameters.hasCount() ?
80  parameters.getCount() :
81  std::numeric_limits<size_t>::max();
82  m_cs.erase(parameters.getName(), std::min(count, ERASE_LIMIT),
83  [=] (size_t nErased) {
84  ControlParameters body;
85  body.setName(parameters.getName());
86  body.setCount(nErased);
87  if (nErased == ERASE_LIMIT && count > ERASE_LIMIT) {
88  m_cs.find(Interest(parameters.getName()).setCanBePrefix(true),
89  [=] (const Interest&, const Data&) mutable {
90  body.setCapacity(ERASE_LIMIT);
91  done(ControlResponse(200, "OK").setBody(body.wireEncode()));
92  },
93  [=] (const Interest&) {
94  done(ControlResponse(200, "OK").setBody(body.wireEncode()));
95  });
96  }
97  else {
98  done(ControlResponse(200, "OK").setBody(body.wireEncode()));
99  }
100  });
101 }
102 
103 void
104 CsManager::serveInfo(const Name& topPrefix, const Interest& interest,
105  ndn::mgmt::StatusDatasetContext& context) const
106 {
107  ndn::nfd::CsInfo info;
108  info.setCapacity(m_cs.getLimit());
109  info.setEnableAdmit(m_cs.shouldAdmit());
110  info.setEnableServe(m_cs.shouldServe());
111  info.setNEntries(m_cs.size());
112  info.setNHits(m_fwCounters.nCsHits);
113  info.setNMisses(m_fwCounters.nCsMisses);
114 
115  context.append(info.wireEncode());
116  context.end();
117 }
118 
119 } // namespace nfd
size_t getLimit() const
get capacity (in number of packets)
Definition: cs.hpp:103
void registerStatusDatasetHandler(const std::string &verb, const ndn::mgmt::StatusDatasetHandler &handler)
bool shouldServe() const
get CS_ENABLE_SERVE flag
Definition: cs.hpp:149
void enableAdmit(bool shouldAdmit)
set CS_ENABLE_ADMIT flag
Definition: cs.cpp:165
static constexpr size_t ERASE_LIMIT
Definition: cs-manager.hpp:69
CsManager(cs::Cs &cs, const ForwarderCounters &fwCounters, Dispatcher &dispatcher, CommandAuthenticator &authenticator)
Definition: cs-manager.cpp:36
Provides ControlCommand authorization according to NFD configuration file.
A collection of common functions shared by all NFD managers, such as communicating with the dispatche...
Copyright (c) 2014-2015, Regents of the University of California, Arizona Board of Regents...
Definition: algorithm.hpp:32
void erase(const Name &prefix, size_t limit, AfterEraseCallback &&cb)
asynchronously erases entries under prefix
Definition: cs.hpp:64
void enableServe(bool shouldServe)
set CS_ENABLE_SERVE flag
Definition: cs.cpp:175
void setLimit(size_t nMaxPackets)
change capacity (in number of packets)
Definition: cs.hpp:111
size_t size() const
get number of stored packets
Definition: cs.hpp:94
counters provided by Forwarder
void find(const Interest &interest, HitCallback &&hit, MissCallback &&miss) const
finds the best matching Data packet
Definition: cs.hpp:81
bool shouldAdmit() const
get CS_ENABLE_ADMIT flag
Definition: cs.hpp:134