wimax-tlv.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2009 INRIA, UDcast
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 *         Mohamed Amine Ismail <amine.ismail@sophia.inria.fr>
 *
 */
 
#ifndef WIMAX_TLV_H
#define WIMAX_TLV_H
 
#define WIMAX_TLV_EXTENDED_LENGTH_MASK 0x80
 
#include "ns3/assert.h"
#include "ns3/header.h"
#include "ns3/ipv4-address.h"
#include "ns3/log.h"
#include "ns3/uinteger.h"
 
#include <cstdlib>
#include <vector>
 
namespace ns3
{
 
/**
 * @ingroup wimax
 * The value field of a tlv can take different values (uint8_t, uint16,
 * vector, ...). This class is a virtual interface
 * from which all the types of tlv values should derive
 */
class TlvValue
{
  public:
    virtual ~TlvValue()
    {
    }
 
    /**
     * Get serialized size in bytes
     * @returns the serialized size
     */
    virtual uint32_t GetSerializedSize() const = 0;
    /**
     * Serialize to a buffer
     * @param start the iterator
     */
    virtual void Serialize(Buffer::Iterator start) const = 0;
    /**
     * Deserialize from a buffer
     * @param start the iterator
     * @param valueLen the maximum length of the value
     * @returns the
     */
    virtual uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLen) = 0;
    /**
     * Copy function
     * @returns the TLV value
     */
    virtual TlvValue* Copy() const = 0;
 
  private:
};
 
// =============================================================================
/**
 * @ingroup wimax
 * @brief This class implements the Type-Len-Value structure channel encodings as described by "IEEE
 * Standard for Local and metropolitan area networks Part 16: Air Interface for Fixed Broadband
 * Wireless Access Systems"
 * 11. TLV encodings, page 645
 *
 */
class Tlv : public Header
{
  public:
    /// CommonTypes enumeration
    enum CommonTypes
    {
        HMAC_TUPLE = 149,
        MAC_VERSION_ENCODING = 148,
        CURRENT_TRANSMIT_POWER = 147,
        DOWNLINK_SERVICE_FLOW = 146,
        UPLINK_SERVICE_FLOW = 145,
        VENDOR_ID_EMCODING = 144,
        VENDOR_SPECIFIC_INFORMATION = 143
    };
 
    /**
     * Constructor
     *
     * @param type type
     * @param length the length
     * @param value TLV value
     */
    Tlv(uint8_t type, uint64_t length, const TlvValue& value);
    Tlv();
    ~Tlv() override;
    /**
     * Register this type.
     * @return the TypeId.
     */
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    void Print(std::ostream& os) const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    /**
     * Get size of length field
     * @returns the size of length field
     */
    uint8_t GetSizeOfLen() const;
    /**
     * Get type value
     * @returns the type
     */
    uint8_t GetType() const;
    /**
     * Get length value
     * @returns the length
     */
    uint64_t GetLength() const;
    /**
     * Peek value
     * @returns the TLV value
     */
    TlvValue* PeekValue();
    /**
     * Copy TLV
     * @returns a pointer to a TLV copy
     */
    Tlv* Copy() const;
    /**
     * Copy TlvValue
     * @returns the TLV value
     */
    TlvValue* CopyValue() const;
    /**
     * assignment operator
     * @param o the TLV to assign
     * @returns the TLV
     */
    Tlv& operator=(const Tlv& o);
    /**
     * type conversion operator
     * @param tlv the TLV
     */
    Tlv(const Tlv& tlv);
 
  private:
    uint8_t m_type;    ///< type
    uint64_t m_length; ///< length
    TlvValue* m_value; ///< value
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief U8TlvValue class
 */
class U8TlvValue : public TlvValue
{
  public:
    /**
     * Constructor
     *
     * @param value value to encode
     */
    U8TlvValue(uint8_t value);
    U8TlvValue();
    ~U8TlvValue() override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLen) override;
    /**
     * Deserialize from a buffer
     * @param start the iterator
     * @returns the size of the item
     */
    uint32_t Deserialize(Buffer::Iterator start);
    /**
     * Get value
     * @returns the value
     */
    uint8_t GetValue() const;
    /**
     * Copy
     * @returns a U8 TLV value
     */
    U8TlvValue* Copy() const override;
 
  private:
    uint8_t m_value; ///< value
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief U16TlvValue class
 */
class U16TlvValue : public TlvValue
{
  public:
    /**
     * Constructor
     *
     * @param value value to encode
     */
    U16TlvValue(uint16_t value);
    U16TlvValue();
    ~U16TlvValue() override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLen) override;
    /**
     * Deserialize from a buffer
     * @param start the iterator
     * @returns the size
     */
    uint32_t Deserialize(Buffer::Iterator start);
    /**
     * Get value
     * @returns the value
     */
    uint16_t GetValue() const;
    /**
     * Copy
     * @returns the U16 TLV value
     */
    U16TlvValue* Copy() const override;
 
  private:
    uint16_t m_value; ///< value
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief U32TlvValue class
 */
class U32TlvValue : public TlvValue
{
  public:
    /**
     * Constructor
     *
     * @param value to encode
     */
    U32TlvValue(uint32_t value);
    U32TlvValue();
    ~U32TlvValue() override;
 
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLen) override;
    /**
     * Deserialize from a buffer
     * @param start the iterator
     * @returns the size
     */
    uint32_t Deserialize(Buffer::Iterator start);
    /**
     * Get value
     * @returns the value
     */
    uint32_t GetValue() const;
    /**
     * Copy
     * @returns the U32 TLV Value
     */
    U32TlvValue* Copy() const override;
 
  private:
    uint32_t m_value; ///< value
};
 
// ==============================================================================
 
/**
 * @ingroup wimax
 * @brief this class is used to implement a vector of values in one tlv value field
 */
class VectorTlvValue : public TlvValue
{
  public:
    /// TLV vector iterator typedef
    typedef std::vector<Tlv*>::const_iterator Iterator;
    VectorTlvValue();
    ~VectorTlvValue() override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override = 0;
    /**
     * Begin iterator
     * @returns the beginning element
     */
    Iterator Begin() const;
    /**
     * End iterator
     * @returns the ending element
     */
    Iterator End() const;
    /**
     * Add a TLV
     * @param val the TLV value
     */
    void Add(const Tlv& val);
    /**
     * Copy
     * @returns the vector TLV value
     */
    VectorTlvValue* Copy() const override = 0;
 
  private:
    std::vector<Tlv*>* m_tlvList; ///< tlv list
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief SfVectorTlvValue class
 */
class SfVectorTlvValue : public VectorTlvValue
{
  public:
    /// Type enumeration
    enum Type
    {
        SFID = 1,
        CID = 2,
        Service_Class_Name = 3,
        reserved1 = 4,
        QoS_Parameter_Set_Type = 5,
        Traffic_Priority = 6,
        Maximum_Sustained_Traffic_Rate = 7,
        Maximum_Traffic_Burst = 8,
        Minimum_Reserved_Traffic_Rate = 9,
        Minimum_Tolerable_Traffic_Rate = 10,
        Service_Flow_Scheduling_Type = 11,
        Request_Transmission_Policy = 12,
        Tolerated_Jitter = 13,
        Maximum_Latency = 14,
        Fixed_length_versus_Variable_length_SDU_Indicator = 15,
        SDU_Size = 16,
        Target_SAID = 17,
        ARQ_Enable = 18,
        ARQ_WINDOW_SIZE = 19,
        ARQ_RETRY_TIMEOUT_Transmitter_Delay = 20,
        ARQ_RETRY_TIMEOUT_Receiver_Delay = 21,
        ARQ_BLOCK_LIFETIME = 22,
        ARQ_SYNC_LOSS = 23,
        ARQ_DELIVER_IN_ORDER = 24,
        ARQ_PURGE_TIMEOUT = 25,
        ARQ_BLOCK_SIZE = 26,
        reserved2 = 27,
        CS_Specification = 28,
        IPV4_CS_Parameters = 100
    };
 
    SfVectorTlvValue();
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    SfVectorTlvValue* Copy() const override;
};
 
// ==============================================================================
 
/**
 * @ingroup wimax
 * @brief this class implements the convergence sub-layer descriptor as a tlv vector
 */
class CsParamVectorTlvValue : public VectorTlvValue
{
  public:
    /// Type enumeration
    enum Type
    {
        Classifier_DSC_Action = 1,
        Packet_Classification_Rule = 3,
    };
 
    CsParamVectorTlvValue();
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    CsParamVectorTlvValue* Copy() const override;
 
  private:
};
 
// ==============================================================================
 
/**
 * @ingroup wimax
 * @brief this class implements the classifier descriptor as a tlv vector
 */
class ClassificationRuleVectorTlvValue : public VectorTlvValue
{
  public:
    /// ClassificationRuleTlvType enumeration
    enum ClassificationRuleTlvType
    {
        Priority = 1,
        ToS = 2,
        Protocol = 3,
        IP_src = 4,
        IP_dst = 5,
        Port_src = 6,
        Port_dst = 7,
        Index = 14,
    };
 
    ClassificationRuleVectorTlvValue();
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    ClassificationRuleVectorTlvValue* Copy() const override;
 
  private:
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief TosTlvValue class
 */
class TosTlvValue : public TlvValue
{
  public:
    TosTlvValue();
    /**
     * Constructor
     *
     * @param low low value
     * @param high high value
     * @param mask the mask
     */
    TosTlvValue(uint8_t low, uint8_t high, uint8_t mask);
    ~TosTlvValue() override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    /**
     * Get low part
     * @returns the low part
     */
    uint8_t GetLow() const;
    /**
     * Get high part
     * @returns the high part
     */
    uint8_t GetHigh() const;
    /**
     * Get the mask
     * @returns the mask
     */
    uint8_t GetMask() const;
    /**
     * Copy
     * @returns the TOS TLV value
     */
    TosTlvValue* Copy() const override;
 
  private:
    uint8_t m_low;  ///< low
    uint8_t m_high; ///< high
    uint8_t m_mask; ///< mask
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief PortRangeTlvValue class
 */
class PortRangeTlvValue : public TlvValue
{
  public:
    /// PortRange structure
    struct PortRange
    {
        uint16_t PortLow;  ///< low
        uint16_t PortHigh; ///< high
    };
 
    /// PortRange vector iterator typedef
    typedef std::vector<PortRange>::const_iterator Iterator;
    PortRangeTlvValue();
    ~PortRangeTlvValue() override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    /**
     * Add a range
     * @param portLow the low port of the range
     * @param portHigh the high port of the range
     */
    void Add(uint16_t portLow, uint16_t portHigh);
    /**
     * Begin iterator
     * @returns the beginning element
     */
    Iterator Begin() const;
    /**
     * End iterator
     * @returns the ending element
     */
    Iterator End() const;
    /**
     * Copy
     * @returns the port range tlv value
     */
    PortRangeTlvValue* Copy() const override;
 
  private:
    std::vector<PortRange>* m_portRange; ///< port range
};
 
// ==============================================================================
/**
 * @ingroup wimax
 * @brief ProtocolTlvValue class
 */
class ProtocolTlvValue : public TlvValue
{
  public:
    ProtocolTlvValue();
    ~ProtocolTlvValue() override;
    /// Iterator typedef
    typedef std::vector<uint8_t>::const_iterator Iterator;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    /**
     * Add protocol number
     * @param protocol the protocol number
     */
    void Add(uint8_t protocol);
    /**
     * Begin iterator
     * @returns the beginning element
     */
    Iterator Begin() const;
    /**
     * End iterator
     * @return the ending element
     */
    Iterator End() const;
    /**
     * Copy
     * @returns the protocol tlv value
     */
    ProtocolTlvValue* Copy() const override;
 
  private:
    std::vector<uint8_t>* m_protocol; ///< protocol
};
 
// ==============================================================================
 
/**
 * @ingroup wimax
 * @brief Ipv4AddressTlvValue class
 */
class Ipv4AddressTlvValue : public TlvValue
{
  public:
    /// Ipv4Addr structure
    struct Ipv4Addr
    {
        Ipv4Address Address; ///< address
        Ipv4Mask Mask;       ///< mask
    };
 
    /// IPv4 address vector iterator typedef
    typedef std::vector<Ipv4Addr>::const_iterator Iterator;
    Ipv4AddressTlvValue();
    ~Ipv4AddressTlvValue() override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start, uint64_t valueLength) override;
    /**
     * Add IPv4 address and mask
     * @param address the IPv4 address
     * @param mask the IPv4 mask
     */
    void Add(Ipv4Address address, Ipv4Mask mask);
    /**
     * Begin iterator
     * @returns the beginning element
     */
    Iterator Begin() const;
    /**
     * End iterator
     * @returns the ending element
     */
    Iterator End() const;
    Ipv4AddressTlvValue* Copy() const override;
 
  private:
    std::vector<Ipv4Addr>* m_ipv4Addr; ///< ipv4 addr
};
 
} // namespace ns3
 
#endif /* WIMAX_TLV_H */