/usr/include/ns3.27/ns3/queue.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2007 University of Washington
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
// The queue base class has a limit on its size, in terms of number of
// packets or number of bytes depending on the operating mode.
// The base class implements tracing and basic statistics calculations.
#ifndef QUEUE_H
#define QUEUE_H
#include "ns3/packet.h"
#include "ns3/object.h"
#include "ns3/traced-callback.h"
#include "ns3/traced-value.h"
#include "ns3/unused.h"
#include "ns3/log.h"
#include <string>
#include <sstream>
#include <list>
namespace ns3 {
/**
* \ingroup network
* \defgroup queue Queue
*/
/**
* \ingroup queue
* \brief Abstract base class for packet Queues
*
* This class defines the subset of the base APIs for packet queues in the ns-3 system
* that is independent of the type of enqueued objects
*/
class QueueBase : public Object
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
QueueBase ();
virtual ~QueueBase ();
/**
* \brief Append the item type to the provided type ID if the latter does not
* end with '>'
*
* \param typeId the type ID
* \param itemType the item type
*
* This method is meant to be invoked by helpers to save users from
* specifying the type of items stored in a queue. For instance,
* PointToPointHelper::SetQueue calls
*
* \code
* QueueBase::AppendItemTypeIfNotPresent (type, "Packet");
* \endcode
*
* where type specifies the queue type (e.g., "ns3::DropTailQueue").
* This allows users to call SetQueue ("ns3::DropTailQueue")
* instead of SetQueue ("ns3::DropTailQueue<Packet>")
*/
static void AppendItemTypeIfNotPresent (std::string& typeId, const std::string& itemType);
/**
* \return true if the queue is empty; false otherwise
*/
bool IsEmpty (void) const;
/**
* \return The number of packets currently stored in the Queue
*/
uint32_t GetNPackets (void) const;
/**
* \return The number of bytes currently occupied by the packets in the Queue
*/
uint32_t GetNBytes (void) const;
/**
* \return The total number of bytes received by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalReceivedBytes (void) const;
/**
* \return The total number of packets received by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalReceivedPackets (void) const;
/**
* \return The total number of bytes dropped by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalDroppedBytes (void) const;
/**
* \return The total number of bytes dropped before enqueue by this Queue
* since the simulation began, or since ResetStatistics was called, according
* to whichever happened more recently
*/
uint32_t GetTotalDroppedBytesBeforeEnqueue (void) const;
/**
* \return The total number of bytes dropped after dequeue by this Queue
* since the simulation began, or since ResetStatistics was called, according
* to whichever happened more recently
*/
uint32_t GetTotalDroppedBytesAfterDequeue (void) const;
/**
* \return The total number of packets dropped by this Queue since the
* simulation began, or since ResetStatistics was called, according to
* whichever happened more recently
*/
uint32_t GetTotalDroppedPackets (void) const;
/**
* \return The total number of packets dropped before enqueue by this Queue
* since the simulation began, or since ResetStatistics was called, according
* to whichever happened more recently
*/
uint32_t GetTotalDroppedPacketsBeforeEnqueue (void) const;
/**
* \return The total number of packets dropped after dequeue by this Queue
* since the simulation began, or since ResetStatistics was called, according
* to whichever happened more recently
*/
uint32_t GetTotalDroppedPacketsAfterDequeue (void) const;
/**
* Resets the counts for dropped packets, dropped bytes, received packets, and
* received bytes.
*/
void ResetStatistics (void);
/**
* \brief Enumeration of the modes supported in the class.
*
*/
enum QueueMode
{
QUEUE_MODE_PACKETS, /**< Use number of packets for maximum queue size */
QUEUE_MODE_BYTES, /**< Use number of bytes for maximum queue size */
};
/**
* Set the operating mode of this device.
*
* \param mode The operating mode of this device.
*/
void SetMode (QueueBase::QueueMode mode);
/**
* Get the operating mode of this device.
*
* \returns The operating mode of this device.
*/
QueueBase::QueueMode GetMode (void) const;
/**
* \brief Set the maximum amount of packets that can be stored in this queue
*
* \param maxPackets amount of packets
*/
void SetMaxPackets (uint32_t maxPackets);
/**
* \return the maximum amount of packets that can be stored in this queue
*/
uint32_t GetMaxPackets (void) const;
/**
* \brief Set the maximum amount of bytes that can be stored in this queue
*
* \param maxBytes amount of bytes
*/
void SetMaxBytes (uint32_t maxBytes);
/**
* \return the maximum amount of bytes that can be stored in this queue
*/
uint32_t GetMaxBytes (void) const;
#if 0
// average calculation requires keeping around
// a buffer with the date of arrival of past received packets
// which are within the average window
// so, it is quite costly to do it all the time.
// Hence, it is disabled by default and must be explicitly
// enabled with this method which specifies the size
// of the average window in time units.
void EnableRunningAverage (Time averageWindow);
void DisableRunningAverage (void);
// average
double GetQueueSizeAverage (void);
double GetReceivedBytesPerSecondAverage (void);
double GetReceivedPacketsPerSecondAverage (void);
double GetDroppedBytesPerSecondAverage (void);
double GetDroppedPacketsPerSecondAverage (void);
// variance
double GetQueueSizeVariance (void);
double GetReceivedBytesPerSecondVariance (void);
double GetReceivedPacketsPerSecondVariance (void);
double GetDroppedBytesPerSecondVariance (void);
double GetDroppedPacketsPerSecondVariance (void);
#endif
private:
TracedValue<uint32_t> m_nBytes; //!< Number of bytes in the queue
uint32_t m_nTotalReceivedBytes; //!< Total received bytes
TracedValue<uint32_t> m_nPackets; //!< Number of packets in the queue
uint32_t m_nTotalReceivedPackets; //!< Total received packets
uint32_t m_nTotalDroppedBytes; //!< Total dropped bytes
uint32_t m_nTotalDroppedBytesBeforeEnqueue; //!< Total dropped bytes before enqueue
uint32_t m_nTotalDroppedBytesAfterDequeue; //!< Total dropped bytes after dequeue
uint32_t m_nTotalDroppedPackets; //!< Total dropped packets
uint32_t m_nTotalDroppedPacketsBeforeEnqueue; //!< Total dropped packets before enqueue
uint32_t m_nTotalDroppedPacketsAfterDequeue; //!< Total dropped packets after dequeue
uint32_t m_maxPackets; //!< max packets in the queue
uint32_t m_maxBytes; //!< max bytes in the queue
QueueMode m_mode; //!< queue mode (packets or bytes)
/// Friend class
template <typename Item>
friend class Queue;
};
/**
* \ingroup queue
* \brief Template class for packet Queues
*
* This class defines the subset of the base APIs for packet queues in the ns-3 system
* that is dependent on the type of enqueued objects.
*
* Queue is a template class. The type of the objects stored within the queue
* is specified by the type parameter, which can be any class providing a
* GetSize () method (e.g., Packet, QueueDiscItem, etc.). Subclasses need to
* implement the DoEnqueue, DoDequeue, DoRemove and DoPeek methods.
*
* Users of the Queue template class usually hold a queue through a smart pointer,
* hence forward declaration is recommended to avoid pulling the implementation
* of the templates included in this file. Thus, do not include queue.h but add
* the following forward declaration in your .h file:
*
* \code
* template <typename Item> class Queue;
* \endcode
*
* Then, include queue.h in the corresponding .cc file.
*/
template <typename Item>
class Queue : public QueueBase
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
Queue ();
virtual ~Queue ();
/**
* Place an item into the Queue (each subclass defines the position)
* \param item item to enqueue
* \return True if the operation was successful; false otherwise
*/
virtual bool Enqueue (Ptr<Item> item) = 0;
/**
* Remove an item from the Queue (each subclass defines the position),
* counting it as dequeued
* \return 0 if the operation was not successful; the item otherwise.
*/
virtual Ptr<Item> Dequeue (void) = 0;
/**
* Remove an item from the Queue (each subclass defines the position),
* counting it as dropped
* \return 0 if the operation was not successful; the item otherwise.
*/
virtual Ptr<Item> Remove (void) = 0;
/**
* Get a copy of an item in the queue (each subclass defines the position)
* without removing it
* \return 0 if the operation was not successful; the item otherwise.
*/
virtual Ptr<const Item> Peek (void) const = 0;
/**
* Flush the queue.
*/
void Flush (void);
protected:
/// Const iterator.
typedef typename std::list<Ptr<Item> >::const_iterator ConstIterator;
/**
* \brief Get a const iterator which refers to the first item in the queue.
*
* Subclasses can browse the items in the queue by using an iterator
*
* \code
* for (auto i = Head (); i != Tail (); ++i)
* {
* (*i)->method (); // some method of the Item class
* }
* \endcode
*
* \returns a const iterator which refers to the first item in the queue.
*/
ConstIterator Head (void) const;
/**
* \brief Get a const iterator which indicates past-the-last item in the queue.
*
* Subclasses can browse the items in the queue by using an iterator
*
* \code
* for (auto i = Head (); i != Tail (); ++i)
* {
* (*i)->method (); // some method of the Item class
* }
* \endcode
*
* \returns a const iterator which indicates past-the-last item in the queue.
*/
ConstIterator Tail (void) const;
/**
* Push an item in the queue
* \param pos the position where the item is inserted
* \param item the item to enqueue
* \return true if success, false if the packet has been dropped.
*/
bool DoEnqueue (ConstIterator pos, Ptr<Item> item);
/**
* Pull the item to dequeue from the queue
* \param pos the position of the item to dequeue
* \return the item.
*/
Ptr<Item> DoDequeue (ConstIterator pos);
/**
* Pull the item to drop from the queue
* \param pos the position of the item to remove
* \return the item.
*/
Ptr<Item> DoRemove (ConstIterator pos);
/**
* Peek the front item in the queue
* \param pos the position of the item to peek
* \return the item.
*/
Ptr<const Item> DoPeek (ConstIterator pos) const;
/**
* \brief Drop a packet before enqueue
* \param item item that was dropped
*
* This method is called by the base class when a packet is dropped because
* the queue is full and by the subclasses to notify parent (this class) that
* a packet has been dropped for other reasons before being enqueued.
*/
void DropBeforeEnqueue (Ptr<Item> item);
/**
* \brief Drop a packet after dequeue
* \param item item that was dropped
*
* This method is called by the base class when a Remove operation is requested
* and by the subclasses to notify parent (this class) that a packet has been
* dropped for other reasons after being dequeued.
*/
void DropAfterDequeue (Ptr<Item> item);
private:
std::list<Ptr<Item> > m_packets; //!< the items in the queue
NS_LOG_TEMPLATE_DECLARE; //!< the log component
/// Traced callback: fired when a packet is enqueued
TracedCallback<Ptr<const Item> > m_traceEnqueue;
/// Traced callback: fired when a packet is dequeued
TracedCallback<Ptr<const Item> > m_traceDequeue;
/// Traced callback: fired when a packet is dropped
TracedCallback<Ptr<const Item> > m_traceDrop;
/// Traced callback: fired when a packet is dropped before enqueue
TracedCallback<Ptr<const Item> > m_traceDropBeforeEnqueue;
/// Traced callback: fired when a packet is dropped after dequeue
TracedCallback<Ptr<const Item> > m_traceDropAfterDequeue;
};
/**
* Implementation of the templates declared above.
*/
template <typename Item>
TypeId
Queue<Item>::GetTypeId (void)
{
std::string name = GetTypeParamName<Queue<Item> > ();
static TypeId tid = TypeId (("ns3::Queue<" + name + ">").c_str ())
.SetParent<QueueBase> ()
.SetGroupName ("Network")
.AddTraceSource ("Enqueue", "Enqueue a packet in the queue.",
MakeTraceSourceAccessor (&Queue<Item>::m_traceEnqueue),
"ns3::" + name + "::TracedCallback")
.AddTraceSource ("Dequeue", "Dequeue a packet from the queue.",
MakeTraceSourceAccessor (&Queue<Item>::m_traceDequeue),
"ns3::" + name + "::TracedCallback")
.AddTraceSource ("Drop", "Drop a packet (for whatever reason).",
MakeTraceSourceAccessor (&Queue<Item>::m_traceDrop),
"ns3::" + name + "::TracedCallback")
.AddTraceSource ("DropBeforeEnqueue", "Drop a packet before enqueue.",
MakeTraceSourceAccessor (&Queue<Item>::m_traceDropBeforeEnqueue),
"ns3::" + name + "::TracedCallback")
.AddTraceSource ("DropAfterDequeue", "Drop a packet after dequeue.",
MakeTraceSourceAccessor (&Queue<Item>::m_traceDropAfterDequeue),
"ns3::" + name + "::TracedCallback")
;
return tid;
}
template <typename Item>
Queue<Item>::Queue ()
: NS_LOG_TEMPLATE_DEFINE ("Queue")
{
}
template <typename Item>
Queue<Item>::~Queue ()
{
}
template <typename Item>
bool
Queue<Item>::DoEnqueue (ConstIterator pos, Ptr<Item> item)
{
NS_LOG_FUNCTION (this << item);
if (m_mode == QUEUE_MODE_PACKETS && (m_nPackets.Get () >= m_maxPackets))
{
NS_LOG_LOGIC ("Queue full (at max packets) -- dropping pkt");
DropBeforeEnqueue (item);
return false;
}
if (m_mode == QUEUE_MODE_BYTES && (m_nBytes.Get () + item->GetSize () > m_maxBytes))
{
NS_LOG_LOGIC ("Queue full (packet would exceed max bytes) -- dropping pkt");
DropBeforeEnqueue (item);
return false;
}
m_packets.insert (pos, item);
uint32_t size = item->GetSize ();
m_nBytes += size;
m_nTotalReceivedBytes += size;
m_nPackets++;
m_nTotalReceivedPackets++;
NS_LOG_LOGIC ("m_traceEnqueue (p)");
m_traceEnqueue (item);
return true;
}
template <typename Item>
Ptr<Item>
Queue<Item>::DoDequeue (ConstIterator pos)
{
NS_LOG_FUNCTION (this);
if (m_nPackets.Get () == 0)
{
NS_LOG_LOGIC ("Queue empty");
return 0;
}
Ptr<Item> item = *pos;
m_packets.erase (pos);
if (item != 0)
{
NS_ASSERT (m_nBytes.Get () >= item->GetSize ());
NS_ASSERT (m_nPackets.Get () > 0);
m_nBytes -= item->GetSize ();
m_nPackets--;
NS_LOG_LOGIC ("m_traceDequeue (p)");
m_traceDequeue (item);
}
return item;
}
template <typename Item>
Ptr<Item>
Queue<Item>::DoRemove (ConstIterator pos)
{
NS_LOG_FUNCTION (this);
if (m_nPackets.Get () == 0)
{
NS_LOG_LOGIC ("Queue empty");
return 0;
}
Ptr<Item> item = *pos;
m_packets.erase (pos);
if (item != 0)
{
NS_ASSERT (m_nBytes.Get () >= item->GetSize ());
NS_ASSERT (m_nPackets.Get () > 0);
m_nBytes -= item->GetSize ();
m_nPackets--;
// packets are first dequeued and then dropped
NS_LOG_LOGIC ("m_traceDequeue (p)");
m_traceDequeue (item);
DropAfterDequeue (item);
}
return item;
}
template <typename Item>
void
Queue<Item>::Flush (void)
{
NS_LOG_FUNCTION (this);
while (!IsEmpty ())
{
Remove ();
}
}
template <typename Item>
Ptr<const Item>
Queue<Item>::DoPeek (ConstIterator pos) const
{
NS_LOG_FUNCTION (this);
if (m_nPackets.Get () == 0)
{
NS_LOG_LOGIC ("Queue empty");
return 0;
}
return *pos;
}
template <typename Item>
typename Queue<Item>::ConstIterator Queue<Item>::Head (void) const
{
return m_packets.cbegin ();
}
template <typename Item>
typename Queue<Item>::ConstIterator Queue<Item>::Tail (void) const
{
return m_packets.cend ();
}
template <typename Item>
void
Queue<Item>::DropBeforeEnqueue (Ptr<Item> item)
{
NS_LOG_FUNCTION (this << item);
m_nTotalDroppedPackets++;
m_nTotalDroppedPacketsBeforeEnqueue++;
m_nTotalDroppedBytes += item->GetSize ();
m_nTotalDroppedBytesBeforeEnqueue += item->GetSize ();
NS_LOG_LOGIC ("m_traceDropBeforeEnqueue (p)");
m_traceDrop (item);
m_traceDropBeforeEnqueue (item);
}
template <typename Item>
void
Queue<Item>::DropAfterDequeue (Ptr<Item> item)
{
NS_LOG_FUNCTION (this << item);
m_nTotalDroppedPackets++;
m_nTotalDroppedPacketsAfterDequeue++;
m_nTotalDroppedBytes += item->GetSize ();
m_nTotalDroppedBytesAfterDequeue += item->GetSize ();
NS_LOG_LOGIC ("m_traceDropAfterDequeue (p)");
m_traceDrop (item);
m_traceDropAfterDequeue (item);
}
} // namespace ns3
#endif /* QUEUE_H */
|