cs-policy-priority-fifo.hpp
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2014-2024, 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 #ifndef NFD_DAEMON_TABLE_CS_POLICY_PRIORITY_FIFO_HPP
27 #define NFD_DAEMON_TABLE_CS_POLICY_PRIORITY_FIFO_HPP
28 
29 #include "cs-policy.hpp"
30 
31 #include <ndn-cxx/util/scheduler.hpp>
32 
33 #include <list>
34 
35 namespace nfd::cs {
36 namespace priority_fifo {
37 
38 using Queue = std::list<Policy::EntryRef>;
39 
40 enum QueueType {
41  QUEUE_UNSOLICITED,
42  QUEUE_STALE,
43  QUEUE_FIFO,
44  QUEUE_MAX
45 };
46 
47 struct EntryInfo
48 {
49  QueueType queueType;
50  Queue::iterator queueIt;
51  ndn::scheduler::EventId moveStaleEventId;
52 };
53 
66 class PriorityFifoPolicy final : public Policy
67 {
68 public:
69  PriorityFifoPolicy();
70 
71  ~PriorityFifoPolicy() final;
72 
73 private:
74  void
75  doAfterInsert(EntryRef i) final;
76 
77  void
78  doAfterRefresh(EntryRef i) final;
79 
80  void
81  doBeforeErase(EntryRef i) final;
82 
83  void
84  doBeforeUse(EntryRef i) final;
85 
86  void
87  evictEntries() final;
88 
89 private:
93  void
94  evictOne();
95 
99  void
100  attachQueue(EntryRef i);
101 
105  void
106  detachQueue(EntryRef i);
107 
110  void
111  moveToStaleQueue(EntryRef i);
112 
113 public:
114  static constexpr std::string_view POLICY_NAME{"priority_fifo"};
115 
116 private:
117  Queue m_queues[QUEUE_MAX];
118  std::map<EntryRef, EntryInfo*> m_entryInfoMap;
119 };
120 
121 } // namespace priority_fifo
122 
123 using priority_fifo::PriorityFifoPolicy;
124 
125 } // namespace nfd::cs
126 
127 #endif // NFD_DAEMON_TABLE_CS_POLICY_PRIORITY_FIFO_HPP
nfd::cs::Policy
Represents a CS replacement policy.
Definition: cs-policy.hpp:43
nfd::cs::Policy::EntryRef
Table::const_iterator EntryRef
A reference to a CS entry.
Definition: cs-policy.hpp:117
nfd::cs::priority_fifo::PriorityFifoPolicy
Priority First-In-First-Out (FIFO) replacement policy.
Definition: cs-policy-priority-fifo.hpp:67
nfd::cs::priority_fifo::PriorityFifoPolicy::~PriorityFifoPolicy
~PriorityFifoPolicy() final
Definition: cs-policy-priority-fifo.cpp:39
nfd::cs::priority_fifo::PriorityFifoPolicy::PriorityFifoPolicy
PriorityFifoPolicy()
Definition: cs-policy-priority-fifo.cpp:34
nfd::cs::priority_fifo::PriorityFifoPolicy::POLICY_NAME
static constexpr std::string_view POLICY_NAME
Definition: cs-policy-priority-fifo.hpp:114
nfd::cs::priority_fifo::QueueType
QueueType
Definition: cs-policy-priority-fifo.hpp:40
nfd::cs::priority_fifo::QUEUE_FIFO
@ QUEUE_FIFO
Definition: cs-policy-priority-fifo.hpp:43
nfd::cs::priority_fifo::QUEUE_STALE
@ QUEUE_STALE
Definition: cs-policy-priority-fifo.hpp:42
nfd::cs::priority_fifo::QUEUE_MAX
@ QUEUE_MAX
Definition: cs-policy-priority-fifo.hpp:44
nfd::cs::priority_fifo::QUEUE_UNSOLICITED
@ QUEUE_UNSOLICITED
Definition: cs-policy-priority-fifo.hpp:41
nfd::cs::priority_fifo::Queue
std::list< Policy::EntryRef > Queue
Definition: cs-policy-priority-fifo.hpp:38
nfd::cs::priority_fifo::EntryInfo
Definition: cs-policy-priority-fifo.hpp:48
nfd::cs::priority_fifo::EntryInfo::queueIt
Queue::iterator queueIt
Definition: cs-policy-priority-fifo.hpp:50
nfd::cs::priority_fifo::EntryInfo::moveStaleEventId
ndn::scheduler::EventId moveStaleEventId
Definition: cs-policy-priority-fifo.hpp:51
nfd::cs::priority_fifo::EntryInfo::queueType
QueueType queueType
Definition: cs-policy-priority-fifo.hpp:49