qos-utils.h

Go to the documentation of this file.

/*
 * 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/fatal-error.h"
#include "ns3/ptr.h"
 
#include <map>
 
namespace ns3
{
 
class Packet;
class WifiMacHeader;
class QueueItem;
class Mac48Address;
 
typedef std::pair<Mac48Address, uint8_t> WifiAddressTidPair; 
 
struct WifiAddressTidHash
{
    std::size_t operator()(const WifiAddressTidPair& addressTidPair) const;
};
 
struct WifiAddressHash
{
    std::size_t operator()(const Mac48Address& address) const;
};
 
enum AcIndex : uint8_t
{
    AC_BE = 0,
    AC_BK = 1,
    AC_VI = 2,
    AC_VO = 3,
    AC_BE_NQOS = 4,
    AC_BEACON = 5,
    AC_UNDEF
};
 
inline std::ostream&
operator<<(std::ostream& os, const AcIndex& acIndex)
{
    switch (acIndex)
    {
    case AC_BE:
        return (os << "AC BE");
    case AC_BK:
        return (os << "AC BK");
    case AC_VI:
        return (os << "AC VI");
    case AC_VO:
        return (os << "AC VO");
    case AC_BE_NQOS:
        return (os << "AC BE NQOS");
    case AC_BEACON:
        return (os << "AC BEACON");
    case AC_UNDEF:
        return (os << "AC Undefined");
    default:
        NS_FATAL_ERROR("Unknown AC index");
        return (os << "Unknown");
    }
}
 
class WifiAc
{
  public:
    WifiAc(uint8_t lowTid, uint8_t highTid);
    uint8_t GetLowTid() const;
    uint8_t GetHighTid() const;
    uint8_t GetOtherTid(uint8_t tid) const;
 
  private:
    uint8_t m_lowTid;  
    uint8_t m_highTid; 
};
 
bool operator>(AcIndex left, AcIndex right);
 
bool operator>=(AcIndex left, AcIndex right);
 
bool operator<(AcIndex left, AcIndex right);
 
bool operator<=(AcIndex left, AcIndex right);
 
extern const std::map<AcIndex, WifiAc> wifiAcList;
 
AcIndex QosUtilsMapTidToAc(uint8_t tid);
 
uint8_t QosUtilsGetTidForPacket(Ptr<const Packet> packet);
 
uint32_t QosUtilsMapSeqControlToUniqueInteger(uint16_t seqControl, uint16_t endSequence);
 
bool QosUtilsIsOldPacket(uint16_t startingSeq, uint16_t seqNumber);
 
uint8_t GetTid(Ptr<const Packet> packet, const WifiMacHeader hdr);
 
uint8_t SelectQueueByDSField(Ptr<QueueItem> item);
 
} // namespace ns3
 
#endif /* QOS_UTILS_H */