author | Tom Henderson <tomh@tomh.org> |
Sun, 18 Mar 2007 14:06:51 -0700 | |
changeset 345 | 47b41507a45a |
parent 337 | 42102ed8ee3c |
child 375 | de64c081a2e0 |
permissions | -rw-r--r-- |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
1 |
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */ |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
2 |
/* |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
3 |
* Copyright (c) 2007 University of Washington |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
4 |
* All rights reserved. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
5 |
* |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
6 |
* This program is free software; you can redistribute it and/or modify |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
7 |
* it under the terms of the GNU General Public License version 2 as |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
8 |
* published by the Free Software Foundation; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
9 |
* |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
10 |
* This program is distributed in the hope that it will be useful, |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
11 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
12 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
13 |
* GNU General Public License for more details. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
14 |
* |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
15 |
* You should have received a copy of the GNU General Public License |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
16 |
* along with this program; if not, write to the Free Software |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
17 |
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
18 |
*/ |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
19 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
20 |
// The queue base class does not have any limit based on the number |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
21 |
// of packets or number of bytes. It is, conceptually, infinite |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
22 |
// by default. Only subclasses define limitations. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
23 |
// The base class implements tracing and basic statistics calculations. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
24 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
25 |
#ifndef QUEUE_H |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
26 |
#define QUEUE_H |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
27 |
|
317
b5959aa4a02f
fix queue tracing
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
308
diff
changeset
|
28 |
#include <string> |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
29 |
#include "ns3/packet.h" |
345
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
30 |
#include "ns3/callback-trace-source.h" |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
31 |
#include "ns3/trace-resolver.h" |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
32 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
33 |
namespace ns3 { |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
34 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
35 |
class Queue |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
36 |
{ |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
37 |
public: |
345
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
38 |
enum TraceType { |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
39 |
ENQUEUE, |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
40 |
DEQUEUE, |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
41 |
DROP, |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
42 |
}; |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
43 |
Queue (); |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
44 |
virtual ~Queue (); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
45 |
|
345
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
46 |
TraceResolver *CreateTraceResolver (TraceContext const &context); |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
47 |
|
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
48 |
bool IsEmpty (void); |
337
42102ed8ee3c
Fix bug 8: Enque/Deque misspelled
Tom Henderson <tomh@tomh.org>
parents:
317
diff
changeset
|
49 |
bool Enqueue (const Packet& p); |
42102ed8ee3c
Fix bug 8: Enque/Deque misspelled
Tom Henderson <tomh@tomh.org>
parents:
317
diff
changeset
|
50 |
bool Dequeue (Packet &p); |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
51 |
|
337
42102ed8ee3c
Fix bug 8: Enque/Deque misspelled
Tom Henderson <tomh@tomh.org>
parents:
317
diff
changeset
|
52 |
void DequeueAll (void); |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
53 |
uint32_t GetNPackets (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
54 |
uint32_t GetNBytes (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
55 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
56 |
uint32_t GetTotalReceivedBytes (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
57 |
uint32_t GetTotalReceivedPackets (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
58 |
uint32_t GetTotalDroppedBytes (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
59 |
uint32_t GetTotalDroppedPackets (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
60 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
61 |
void ResetStatistics (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
62 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
63 |
#if 0 |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
64 |
// average calculation requires keeping around |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
65 |
// a buffer with the date of arrival of past received packets |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
66 |
// which are within the average window |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
67 |
// so, it is quite costly to do it all the time. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
68 |
// Hence, it is disabled by default and must be explicitely |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
69 |
// enabled with this method which specifies the size |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
70 |
// of the average window in time units. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
71 |
void EnableRunningAverage (Time averageWindow); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
72 |
void DisableRunningAverage (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
73 |
// average |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
74 |
double GetQueueSizeAverage (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
75 |
double GetReceivedBytesPerSecondAverage (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
76 |
double GetReceivedPacketsPerSecondAverage (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
77 |
double GetDroppedBytesPerSecondAverage (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
78 |
double GetDroppedPacketsPerSecondAverage (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
79 |
// variance |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
80 |
double GetQueueSizeVariance (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
81 |
double GetReceivedBytesPerSecondVariance (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
82 |
double GetReceivedPacketsPerSecondVariance (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
83 |
double GetDroppedBytesPerSecondVariance (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
84 |
double GetDroppedPacketsPerSecondVariance (void); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
85 |
#endif |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
86 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
87 |
private: |
337
42102ed8ee3c
Fix bug 8: Enque/Deque misspelled
Tom Henderson <tomh@tomh.org>
parents:
317
diff
changeset
|
88 |
virtual bool DoEnqueue (const Packet& p) = 0; |
42102ed8ee3c
Fix bug 8: Enque/Deque misspelled
Tom Henderson <tomh@tomh.org>
parents:
317
diff
changeset
|
89 |
virtual bool DoDequeue (Packet &p) = 0; |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
90 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
91 |
protected: |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
92 |
// called by subclasses to notify parent of packet drops. |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
93 |
void Drop (const Packet& p); |
317
b5959aa4a02f
fix queue tracing
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
308
diff
changeset
|
94 |
|
b5959aa4a02f
fix queue tracing
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
308
diff
changeset
|
95 |
private: |
345
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
96 |
CallbackTraceSource<const Packet &> m_traceEnqueue; |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
97 |
CallbackTraceSource<const Packet &> m_traceDequeue; |
47b41507a45a
move channel.cc channel.h to node directory; merge ns-3-tracing from mathieu
Tom Henderson <tomh@tomh.org>
parents:
337
diff
changeset
|
98 |
CallbackTraceSource<const Packet &> m_traceDrop; |
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
99 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
100 |
uint32_t m_nBytes; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
101 |
uint32_t m_nTotalReceivedBytes; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
102 |
uint32_t m_nPackets; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
103 |
uint32_t m_nTotalReceivedPackets; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
104 |
uint32_t m_nTotalDroppedBytes; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
105 |
uint32_t m_nTotalDroppedPackets; |
317
b5959aa4a02f
fix queue tracing
Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
parents:
308
diff
changeset
|
106 |
|
264
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
107 |
#if 0 |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
108 |
// Static methods to manage queue default |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
109 |
// Set desired queue default |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
110 |
static void Default(const Queue& q); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
111 |
// Return reference to the current default queue type |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
112 |
static Queue& Default(); |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
113 |
// Static variable pointing to current default queue |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
114 |
static Queue* defaultQueue; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
115 |
#endif |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
116 |
}; |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
117 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
118 |
}; // namespace ns3 |
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
119 |
|
128d8d1bfb51
queues, trace-writer, debug
craigdo@m354-pc01.ee.washington.edu
parents:
diff
changeset
|
120 |
#endif /* QUEUE_H */ |