A Discrete-Event Network Simulator
API
calendar-scheduler.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2009 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  * Author: Alexander Krotov <krotov@iitp.ru>
20  */
21 
22 #ifndef CALENDAR_SCHEDULER_H
23 #define CALENDAR_SCHEDULER_H
24 
25 #include "scheduler.h"
26 #include <stdint.h>
27 #include <list>
28 
35 namespace ns3 {
36 
37 class EventImpl;
38 
92 class CalendarScheduler : public Scheduler
93 {
94 public:
99  static TypeId GetTypeId (void);
100 
102  CalendarScheduler ();
104  virtual ~CalendarScheduler ();
105 
106  // Inherited
107  virtual void Insert (const Scheduler::Event &ev);
108  virtual bool IsEmpty (void) const;
109  virtual Scheduler::Event PeekNext (void) const;
110  virtual Scheduler::Event RemoveNext (void);
111  virtual void Remove (const Scheduler::Event &ev);
112 
113 private:
115  void ResizeUp (void);
117  void ResizeDown (void);
123  void Resize (uint32_t newSize);
129  uint64_t CalculateNewWidth (void);
137  void Init (uint32_t nBuckets,
138  uint64_t width,
139  uint64_t startPrio);
146  inline uint32_t Hash (uint64_t key) const;
148  void PrintInfo (void);
155  void DoResize (uint32_t newSize, uint64_t newWidth);
161  Scheduler::Event DoRemoveNext (void);
167  void DoInsert (const Scheduler::Event &ev);
168 
170  typedef std::list<Scheduler::Event> Bucket;
171 
173  Bucket *m_buckets;
175  uint32_t m_nBuckets;
177  uint64_t m_width;
179  uint32_t m_lastBucket;
181  uint64_t m_bucketTop;
183  uint64_t m_lastPrio;
185  uint32_t m_qSize;
186 
196  void SetReverse (bool reverse);
202  Scheduler::Event & (*NextEvent) (Bucket & bucket);
209  bool (*Order) (const EventKey & newEvent, const EventKey & it);
214  void (*Pop) (Bucket &);
220  bool m_reverse = false;
221 };
222 
223 } // namespace ns3
224 
225 #endif /* CALENDAR_SCHEDULER_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::CalendarScheduler::m_reverse
bool m_reverse
Bucket ordering.
Definition: calendar-scheduler.h:220
ns3::CalendarScheduler::RemoveNext
virtual Scheduler::Event RemoveNext(void)
Remove the earliest event from the event list.
Definition: calendar-scheduler.cc:263
ns3::CalendarScheduler::DoRemoveNext
Scheduler::Event DoRemoveNext(void)
Remove the earliest event.
Definition: calendar-scheduler.cc:216
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::CalendarScheduler::GetTypeId
static TypeId GetTypeId(void)
Register this type.
Definition: calendar-scheduler.cc:45
ns3::CalendarScheduler::Bucket
std::list< Scheduler::Event > Bucket
Calendar bucket type: a list of Events.
Definition: calendar-scheduler.h:170
ns3::CalendarScheduler::Pop
void(* Pop)(Bucket &)
Pop the next event from the bucket, according to m_reverse.
Definition: calendar-scheduler.h:214
ns3::CalendarScheduler::PeekNext
virtual Scheduler::Event PeekNext(void) const
Get a pointer to the next event.
Definition: calendar-scheduler.cc:181
ns3::CalendarScheduler::CalendarScheduler
CalendarScheduler()
Constructor.
Definition: calendar-scheduler.cc:61
ns3::CalendarScheduler::DoResize
void DoResize(uint32_t newSize, uint64_t newWidth)
Resize the number of buckets and width.
Definition: calendar-scheduler.cc:403
scheduler.h
ns3::Scheduler abstract base class, ns3::Scheduler::Event and ns3::Scheduler::EventKey declarations.
ns3::CalendarScheduler::ResizeDown
void ResizeDown(void)
Halve the number of buckets if necessary.
Definition: calendar-scheduler.cc:313
ns3::CalendarScheduler::m_lastPrio
uint64_t m_lastPrio
The priority of the last event removed.
Definition: calendar-scheduler.h:183
ns3::CalendarScheduler::m_bucketTop
uint64_t m_bucketTop
Priority at the top of the bucket from which last event was dequeued.
Definition: calendar-scheduler.h:181
ns3::CalendarScheduler::Resize
void Resize(uint32_t newSize)
Resize to a new number of buckets, with automatically computed width.
Definition: calendar-scheduler.cc:422
ns3::Scheduler::Event
Scheduler event.
Definition: scheduler.h:182
ns3::CalendarScheduler::m_nBuckets
uint32_t m_nBuckets
Number of buckets in the array.
Definition: calendar-scheduler.h:175
ns3::Scheduler::EventKey
Structure for sorting and comparing Events.
Definition: scheduler.h:169
ns3::CalendarScheduler::Remove
virtual void Remove(const Scheduler::Event &ev)
Remove a specific event from the event list.
Definition: calendar-scheduler.cc:278
ns3::CalendarScheduler::DoInsert
void DoInsert(const Scheduler::Event &ev)
Insert a new event in to the correct bucket.
Definition: calendar-scheduler.cc:146
ns3::CalendarScheduler::Order
bool(* Order)(const EventKey &newEvent, const EventKey &it)
Ordering function to identify the insertion point, according to m_reverse.
Definition: calendar-scheduler.h:209
ns3::CalendarScheduler::Init
void Init(uint32_t nBuckets, uint64_t width, uint64_t startPrio)
Initialize the calendar queue.
Definition: calendar-scheduler.cc:111
ns3::CalendarScheduler::Insert
virtual void Insert(const Scheduler::Event &ev)
Insert a new Event in the schedule.
Definition: calendar-scheduler.cc:167
ns3::CalendarScheduler::m_buckets
Bucket * m_buckets
Array of buckets.
Definition: calendar-scheduler.h:173
ns3::CalendarScheduler::Hash
uint32_t Hash(uint64_t key) const
Hash the dimensionless time to a bucket.
Definition: calendar-scheduler.cc:137
ns3::Scheduler
Maintain the event list.
Definition: scheduler.h:156
ns3::CalendarScheduler::m_lastBucket
uint32_t m_lastBucket
Bucket index from which the last event was dequeued.
Definition: calendar-scheduler.h:179
ns3::CalendarScheduler::m_width
uint64_t m_width
Duration of a bucket, in dimensionless time units.
Definition: calendar-scheduler.h:177
ns3::CalendarScheduler::IsEmpty
virtual bool IsEmpty(void) const
Test if the schedule is empty.
Definition: calendar-scheduler.cc:175
ns3::CalendarScheduler::~CalendarScheduler
virtual ~CalendarScheduler()
Destructor.
Definition: calendar-scheduler.cc:67
ns3::CalendarScheduler::PrintInfo
void PrintInfo(void)
Print the configuration and bucket size distribution.
Definition: calendar-scheduler.cc:124
ns3::CalendarScheduler::CalculateNewWidth
uint64_t CalculateNewWidth(void)
Compute the new bucket size, based on up to the first 25 entries.
Definition: calendar-scheduler.cc:324
ns3::CalendarScheduler::SetReverse
void SetReverse(bool reverse)
Set the insertion order.
Definition: calendar-scheduler.cc:74
ns3::CalendarScheduler::ResizeUp
void ResizeUp(void)
Double the number of buckets if necessary.
Definition: calendar-scheduler.cc:302
ns3::CalendarScheduler::m_qSize
uint32_t m_qSize
Number of events in queue.
Definition: calendar-scheduler.h:185
ns3::CalendarScheduler
a calendar queue event scheduler
Definition: calendar-scheduler.h:93