blob: 3d2ebc7fb885a4286916cc3ee25cb2c7020d6914 [file] [log] [blame]
Alexander Afanasyev6f95e702012-10-31 16:27:31 -07001/* -*- 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
Alexander Afanasyev0c395372014-12-20 15:54:02 -080021#include "ndn-limits-rate.hpp"
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070022
23#include "ns3/log.h"
24#include "ns3/simulator.h"
25#include "ns3/random-variable.h"
Alexander Afanasyev0c395372014-12-20 15:54:02 -080026#include "ns3/ndn-face.hpp"
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -070027#include "ns3/node.h"
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070028
29NS_LOG_COMPONENT_DEFINE ("ndn.Limits.Rate");
30
31namespace ns3 {
32namespace ndn {
33
34NS_OBJECT_ENSURE_REGISTERED (LimitsRate);
35
36TypeId
37LimitsRate::GetTypeId ()
38{
39 static TypeId tid = TypeId ("ns3::ndn::Limits::Rate")
40 .SetGroupName ("Ndn")
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -080041 .SetParent <Limits> ()
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070042 .AddConstructor <LimitsRate> ()
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -080043
44 .AddAttribute ("RandomizeLeak", "Randomize start time for token bucket leakage. May be helpful to prevent leak synchronizations",
45 TimeValue (Seconds (0.001)),
46 MakeTimeAccessor (&LimitsRate::m_leakRandomizationInteral),
47 MakeTimeChecker ())
48
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070049 ;
50 return tid;
51}
52
53void
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -070054LimitsRate::NotifyNewAggregate ()
55{
56 super::NotifyNewAggregate ();
57
58 if (!m_isLeakScheduled)
59 {
60 if (GetObject<Face> () != 0)
61 {
62 NS_ASSERT_MSG (GetObject<Face> ()->GetNode () != 0, "Node object should exist on the face");
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -080063
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -070064 m_isLeakScheduled = true;
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -080065
66 if (!m_leakRandomizationInteral.IsZero ())
67 {
68 UniformVariable r (0.0, m_leakRandomizationInteral.ToDouble (Time::S));
69 Simulator::ScheduleWithContext (GetObject<Face> ()->GetNode ()->GetId (),
70 Seconds (r.GetValue ()), &LimitsRate::LeakBucket, this, 0.0);
71 }
72 else
73 {
74 Simulator::ScheduleWithContext (GetObject<Face> ()->GetNode ()->GetId (),
75 Seconds (0), &LimitsRate::LeakBucket, this, 0.0);
76 }
77
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -070078 }
79 }
80}
81
Alexander Afanasyevccd5bb42012-10-31 17:27:49 -070082void
83LimitsRate::SetLimits (double rate, double delay)
84{
85 super::SetLimits (rate, delay);
86
87 // maximum allowed burst
88 m_bucketMax = GetMaxRate () * GetMaxDelay ();
89
90 // amount of packets allowed every second (leak rate)
91 m_bucketLeak = GetMaxRate ();
92}
93
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -070094
95void
Alexander Afanasyev6f95e702012-10-31 16:27:31 -070096LimitsRate::UpdateCurrentLimit (double limit)
97{
98 NS_ASSERT_MSG (limit >= 0.0, "Limit should be greater or equal to zero");
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -080099
Alexander Afanasyev6f95e702012-10-31 16:27:31 -0700100 m_bucketLeak = std::min (limit, GetMaxRate ());
101 m_bucketMax = m_bucketLeak * GetMaxDelay ();
102}
103
104bool
105LimitsRate::IsBelowLimit ()
106{
107 if (!IsEnabled ()) return true;
108
109 return (m_bucketMax - m_bucket >= 1.0);
110}
111
112void
113LimitsRate::BorrowLimit ()
114{
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -0800115 if (!IsEnabled ()) return;
Alexander Afanasyev6f95e702012-10-31 16:27:31 -0700116
117 NS_ASSERT_MSG (m_bucketMax - m_bucket >= 1.0, "Should not be possible, unless we IsBelowLimit was not checked correctly");
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -0800118 m_bucket += 1;
Alexander Afanasyev6f95e702012-10-31 16:27:31 -0700119}
120
121void
122LimitsRate::ReturnLimit ()
123{
124 // do nothing
125}
126
127void
128LimitsRate::LeakBucket (double interval)
129{
130 const double leak = m_bucketLeak * interval;
131
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -0800132#ifdef NS3_LOG_ENABLE
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -0700133 if (m_bucket>1)
134 {
135 NS_LOG_DEBUG ("Leak from " << m_bucket << " to " << std::max (0.0, m_bucket - leak));
136 }
137#endif
Alexander Afanasyev08ab5722012-11-06 17:22:25 -0800138
139 double bucketOld = m_bucket;
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -0800140
Alexander Afanasyev6f95e702012-10-31 16:27:31 -0700141 m_bucket = std::max (0.0, m_bucket - leak);
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -0700142
143 // calculate interval so next time we will leak by 1.001, unless such interval would be more than 1 second
144 double newInterval = 1.0;
145 if (m_bucketLeak > 1.0)
146 {
147 newInterval = 1.001 / m_bucketLeak;
148 }
Alexander Afanasyev08ab5722012-11-06 17:22:25 -0800149
150 if (m_bucketMax - bucketOld < 1.0 &&
151 m_bucketMax - m_bucket >= 1.0) // limit number of times this stuff is called
152 {
153 this->FireAvailableSlotCallback ();
154 }
Alexander Afanasyevdc115ef2013-02-13 12:06:55 -0800155
Alexander Afanasyev7e4235a2012-10-31 16:58:44 -0700156 Simulator::Schedule (Seconds (newInterval), &LimitsRate::LeakBucket, this, newInterval);
Alexander Afanasyev6f95e702012-10-31 16:27:31 -0700157}
158
159} // namespace ndn
160} // namespace ns3