/usr/include/ns3.26/ns3/qos-utils.h is in libns3-dev 3.26+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 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2009 MIRKO BANCHI
*
* 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
*
* Author: Mirko Banchi <mk.banchi@gmail.com>
*/
#ifndef QOS_UTILS_H
#define QOS_UTILS_H
#include "ns3/uinteger.h"
#include "ns3/ptr.h"
#include "ns3/packet.h"
namespace ns3 {
/**
* \ingroup wifi
* This enumeration defines the Access Categories as an enumeration
* with values corresponding to the AC index (ACI) values specified
* (Table 8-104 "ACI-to-AC coding"; IEEE 802.11-2012).
*/
enum AcIndex
{
/** Best Effort */
AC_BE = 0,
/** Background */
AC_BK = 1,
/** Video */
AC_VI = 2,
/** Voice */
AC_VO = 3,
/** Total number of ACs */
AC_BE_NQOS = 4,
AC_UNDEF
};
/**
* \ingroup wifi
* Maps TID (Traffic ID) to Access classes.
* For more details see (Table 9-1 "UP-to-AC mapping"; IEEE 802.11-2012).
*
* \param tid the Traffic ID to be mapped to Access class
* \return the access class for the given TID
*/
AcIndex QosUtilsMapTidToAc (uint8_t tid);
/**
* \ingroup wifi
* If a qos tag is attached to the packet, returns a value < 8.
* A value >= 8 is returned otherwise.
*
* \param packet the packet to checked for a QoS tag
*
* \return a value less than 8 if QoS tag was present, a value >= 8
* is returned if no QoS tag was present
*/
uint8_t QosUtilsGetTidForPacket (Ptr<const Packet> packet);
/**
* \ingroup wifi
* Next function is useful to correctly sort buffered packets under block ack.
* When an BAR is received from originator station, completed "old"
* (see section 9.10.3 in IEEE 802.11e) packets must be forwarded up before "new" packets.
*
* \param seqControl the sequence control field
* \param endSequence
*
* \return a unique integer for the given sequence control and end sequence
*/
uint32_t QosUtilsMapSeqControlToUniqueInteger (uint16_t seqControl, uint16_t endSequence);
/**
* \ingroup wifi
* This function checks if packet with sequence number <i>seqNumber</i> is an "old" packet.
* The sequence number space is considered divided into two parts, one of which is "old" and
* one of which is "new" by means of a boundary created by adding half the sequence number
* range to the starting sequence number <i>startingSeq</i>. So this function works fine also
* when <i>seqNumber</i> is smaller than <i>startingSeq</i> and <i>startingSeq</i> + 2048 is greater
* than 4096 because all comparison are circular modulo 2^12. The following are possible scenarios:
*
* ----- = old packets
* +++++ = new packets
*
* CASE A:
*
* 0 4095
* |++++++|----------------|++++++|
* ^ ^
* | endSeq | startingSeq
*
*
* CASE B:
*
* 0 4095
* |------|++++++++++++++++|-----|
* ^ ^
* | startingSeq | endSeq
*
* Here in the examples endSeq is the sequenceNumber of the "last" new packet.
* So this function, when specified a starting sequence and a sequence number, returns true
* if that packet (with sequence number <i>numberSeq</i>)) belongs to the section of the
* sequence number space marked with '-' characters. The function returns false otherwise.
*
* \param startingSeq the starting sequence number
* \param seqNumber the sequence number to be checked
*
* \return true if the packet is old, false otherwise
*/
bool QosUtilsIsOldPacket (uint16_t startingSeq, uint16_t seqNumber);
} //namespace ns3
#endif /* QOS_UTILS_H */
|