Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 1 | /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */ |
| 2 | /* |
| 3 | * Copyright (c) 2011 University of California, Los Angeles |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License version 2 as |
| 7 | * published by the Free Software Foundation; |
| 8 | * |
| 9 | * This program is distributed in the hope that it will be useful, |
| 10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 12 | * GNU General Public License for more details. |
| 13 | * |
| 14 | * You should have received a copy of the GNU General Public License |
| 15 | * along with this program; if not, write to the Free Software |
| 16 | * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
| 17 | * |
| 18 | * Author: Alexander Afanasyev <alexander.afanasyev@ucla.edu> |
| 19 | */ |
| 20 | |
| 21 | |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 22 | #ifndef NDNSIM_SIMPLE_LIMITS_H |
| 23 | #define NDNSIM_SIMPLE_LIMITS_H |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 24 | |
| 25 | #include "ns3/event-id.h" |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 26 | #include "ns3/ndn-pit.h" |
| 27 | #include "ns3/ndn-pit-entry.h" |
Alexander Afanasyev | 0484e77 | 2012-10-29 11:02:08 -0700 | [diff] [blame] | 28 | #include "ns3/simulator.h" |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 29 | #include "ns3/string.h" |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 30 | |
| 31 | #include "ns3/ndn-forwarding-strategy.h" |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 32 | |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 33 | #include "ns3/ndn-limits.h" |
Alexander Afanasyev | f5c0774 | 2012-10-31 13:13:05 -0700 | [diff] [blame] | 34 | |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 35 | namespace ns3 { |
| 36 | namespace ndn { |
| 37 | namespace fw { |
| 38 | |
| 39 | /** |
| 40 | * \ingroup ndn |
| 41 | * \brief Strategy implementing per-FIB entry limits |
| 42 | */ |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 43 | template<class Parent> |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 44 | class SimpleLimits : |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 45 | public Parent |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 46 | { |
| 47 | private: |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 48 | typedef Parent super; |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 49 | |
| 50 | public: |
| 51 | static TypeId |
| 52 | GetTypeId (); |
| 53 | |
| 54 | /** |
| 55 | * @brief Default constructor |
| 56 | */ |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 57 | SimpleLimits () |
Alexander Afanasyev | f5c0774 | 2012-10-31 13:13:05 -0700 | [diff] [blame] | 58 | { } |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 59 | |
| 60 | virtual void |
| 61 | WillEraseTimedOutPendingInterest (Ptr<pit::Entry> pitEntry); |
| 62 | |
Alexander Afanasyev | f5c0774 | 2012-10-31 13:13:05 -0700 | [diff] [blame] | 63 | virtual void |
| 64 | AddFace (Ptr<Face> face) |
| 65 | { |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 66 | ObjectFactory factory (m_limitType); |
| 67 | Ptr<Limits> limits = factory.template Create<Limits> (); |
Alexander Afanasyev | f5c0774 | 2012-10-31 13:13:05 -0700 | [diff] [blame] | 68 | face->AggregateObject (limits); |
| 69 | |
| 70 | super::AddFace (face); |
| 71 | } |
| 72 | |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 73 | protected: |
| 74 | virtual bool |
| 75 | TrySendOutInterest (Ptr<Face> inFace, |
| 76 | Ptr<Face> outFace, |
| 77 | Ptr<const InterestHeader> header, |
| 78 | Ptr<const Packet> origPacket, |
| 79 | Ptr<pit::Entry> pitEntry); |
| 80 | |
| 81 | virtual void |
| 82 | WillSatisfyPendingInterest (Ptr<Face> inFace, |
| 83 | Ptr<pit::Entry> pitEntry); |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 84 | |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 85 | private: |
| 86 | std::string m_limitType; |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 87 | }; |
| 88 | |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 89 | template<class Parent> |
| 90 | TypeId |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 91 | SimpleLimits<Parent>::GetTypeId (void) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 92 | { |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 93 | static TypeId tid = TypeId ((super::GetTypeId ().GetName ()+"::SimpleLimits").c_str ()) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 94 | .SetGroupName ("Ndn") |
| 95 | .template SetParent <super> () |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 96 | .template AddConstructor <SimpleLimits> () |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 97 | |
| 98 | .template AddAttribute ("Limit", "Limit type to be used (e.g., ns3::ndn::Limits::Window or ns3::ndn::Limits::Rate)", |
| 99 | StringValue ("ns3::ndn::Limits::Window"), |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 100 | MakeStringAccessor (&SimpleLimits<Parent>::m_limitType), |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 101 | MakeStringChecker ()) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 102 | ; |
| 103 | return tid; |
| 104 | } |
| 105 | |
| 106 | template<class Parent> |
| 107 | bool |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 108 | SimpleLimits<Parent>::TrySendOutInterest (Ptr<Face> inFace, |
Alexander Afanasyev | f5c0774 | 2012-10-31 13:13:05 -0700 | [diff] [blame] | 109 | Ptr<Face> outFace, |
| 110 | Ptr<const InterestHeader> header, |
| 111 | Ptr<const Packet> origPacket, |
| 112 | Ptr<pit::Entry> pitEntry) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 113 | { |
| 114 | // NS_LOG_FUNCTION (this << pitEntry->GetPrefix ()); |
| 115 | // totally override all (if any) parent processing |
| 116 | |
| 117 | pit::Entry::out_iterator outgoing = |
| 118 | pitEntry->GetOutgoing ().find (outFace); |
| 119 | |
| 120 | if (outgoing != pitEntry->GetOutgoing ().end ()) |
| 121 | { |
| 122 | // just suppress without any other action |
| 123 | return false; |
| 124 | } |
| 125 | |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 126 | Ptr<Limits> faceLimits = outFace->template GetObject<Limits> (); |
| 127 | if (faceLimits->IsBelowLimit ()) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 128 | { |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 129 | faceLimits->BorrowLimit (); |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 130 | pitEntry->AddOutgoing (outFace); |
| 131 | |
| 132 | //transmission |
| 133 | Ptr<Packet> packetToSend = origPacket->Copy (); |
| 134 | outFace->Send (packetToSend); |
| 135 | |
| 136 | this->DidSendOutInterest (outFace, header, origPacket, pitEntry); |
| 137 | return true; |
| 138 | } |
| 139 | else |
| 140 | { |
| 141 | // NS_LOG_DEBUG ("Face limit for " << header->GetName ()); |
| 142 | } |
| 143 | |
| 144 | return false; |
| 145 | } |
| 146 | |
| 147 | template<class Parent> |
| 148 | void |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 149 | SimpleLimits<Parent>::WillEraseTimedOutPendingInterest (Ptr<pit::Entry> pitEntry) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 150 | { |
| 151 | // NS_LOG_FUNCTION (this << pitEntry->GetPrefix ()); |
| 152 | |
| 153 | for (pit::Entry::out_container::iterator face = pitEntry->GetOutgoing ().begin (); |
| 154 | face != pitEntry->GetOutgoing ().end (); |
| 155 | face ++) |
| 156 | { |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 157 | Ptr<Limits> faceLimits = face->m_face->GetObject<Limits> (); |
| 158 | faceLimits->ReturnLimit (); |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 159 | } |
| 160 | |
| 161 | super::WillEraseTimedOutPendingInterest (pitEntry); |
| 162 | } |
| 163 | |
| 164 | |
| 165 | template<class Parent> |
| 166 | void |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 167 | SimpleLimits<Parent>::WillSatisfyPendingInterest (Ptr<Face> inFace, |
Alexander Afanasyev | f5c0774 | 2012-10-31 13:13:05 -0700 | [diff] [blame] | 168 | Ptr<pit::Entry> pitEntry) |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 169 | { |
| 170 | // NS_LOG_FUNCTION (this << pitEntry->GetPrefix ()); |
| 171 | |
| 172 | for (pit::Entry::out_container::iterator face = pitEntry->GetOutgoing ().begin (); |
| 173 | face != pitEntry->GetOutgoing ().end (); |
| 174 | face ++) |
| 175 | { |
Alexander Afanasyev | 6f95e70 | 2012-10-31 16:27:31 -0700 | [diff] [blame] | 176 | Ptr<Limits> faceLimits = face->m_face->GetObject<Limits> (); |
| 177 | faceLimits->ReturnLimit (); |
Alexander Afanasyev | 0fff1db | 2012-10-29 10:14:47 -0700 | [diff] [blame] | 178 | } |
| 179 | |
| 180 | super::WillSatisfyPendingInterest (inFace, pitEntry); |
| 181 | } |
Alexander Afanasyev | 1e7bcaf | 2012-09-05 10:17:53 -0700 | [diff] [blame] | 182 | |
| 183 | } // namespace fw |
| 184 | } // namespace ndn |
| 185 | } // namespace ns3 |
| 186 | |
Alexander Afanasyev | ccd5bb4 | 2012-10-31 17:27:49 -0700 | [diff] [blame] | 187 | #endif // NDNSIM_SIMPLE_LIMITS_H |