sixlowpan-header.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Universita' di Firenze, Italy
 *
 * 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: Tommaso Pecorella <tommaso.pecorella@unifi.it>
 *         Michele Muccio <michelemuccio@virgilio.it>
 */

#ifndef SIXLOWPANHEADER_H_
#define SIXLOWPANHEADER_H_

#include "ns3/header.h"
#include "ns3/ipv6-address.h"

namespace ns3 {

class SixLowPanDispatch
{
public:
  enum Dispatch_e
  {
    LOWPAN_NALP = 0x0,
    LOWPAN_NALP_N = 0x3F,
    LOWPAN_IPv6 = 0x41,
    LOWPAN_HC1 = 0x42,
    LOWPAN_BC0 = 0x50,
    LOWPAN_IPHC = 0x60,
    LOWPAN_IPHC_N = 0x7F,
    LOWPAN_MESH = 0x80,
    LOWPAN_MESH_N = 0xBF,
    LOWPAN_FRAG1 = 0xC0,
    LOWPAN_FRAG1_N = 0xC7,
    LOWPAN_FRAGN = 0xE0,
    LOWPAN_FRAGN_N = 0xE7,
    LOWPAN_UNSUPPORTED = 0xFF
  };

  enum NhcDispatch_e
  {
    LOWPAN_NHC = 0xE0,
    LOWPAN_NHC_N = 0xEF,
    LOWPAN_UDPNHC = 0xF0,
    LOWPAN_UDPNHC_N = 0xF7,
    LOWPAN_NHCUNSUPPORTED = 0xFF
  };

  SixLowPanDispatch (void);

  static Dispatch_e GetDispatchType (uint8_t dispatch);

  static NhcDispatch_e GetNhcDispatchType (uint8_t dispatch);

};

class SixLowPanHc1 : public Header
{
public:
  enum LowPanHc1Addr_e
  {
    HC1_PIII = 0x00,
    HC1_PIIC = 0x01,
    HC1_PCII = 0x02,
    HC1_PCIC = 0x03
  };

  enum LowPanHc1NextHeader_e
  {
    HC1_NC = 0x00,
    HC1_UDP = 0x01,
    HC1_ICMP = 0x02,
    HC1_TCP = 0x03
  };

  SixLowPanHc1 (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  void SetHopLimit (uint8_t limit);

  uint8_t GetHopLimit (void) const;

  LowPanHc1Addr_e GetDstCompression () const;

  const uint8_t* GetDstInterface () const;

  const uint8_t* GetDstPrefix () const;

  uint32_t GetFlowLabel () const;

  uint8_t GetNextHeader () const;

  LowPanHc1Addr_e GetSrcCompression () const;

  const uint8_t* GetSrcInterface () const;

  const uint8_t* GetSrcPrefix () const;

  uint8_t GetTrafficClass () const;

  bool IsTcflCompression () const;

  bool IsHc2HeaderPresent () const;

  void SetDstCompression (LowPanHc1Addr_e dstCompression);

  void SetDstInterface (const uint8_t* dstInterface);

  void SetDstPrefix (const uint8_t* dstPrefix);

  void SetFlowLabel (uint32_t flowLabel);

  void SetNextHeader (uint8_t nextHeader);

  void SetSrcCompression (LowPanHc1Addr_e srcCompression);

  void SetSrcInterface (const uint8_t* srcInterface);

  void SetSrcPrefix (const uint8_t* srcPrefix);

  void SetTcflCompression (bool tcflCompression);

  void SetHc2HeaderPresent (bool hc2HeaderPresent);

  void SetTrafficClass (uint8_t trafficClass);

private:
  uint8_t m_hopLimit;           
  uint8_t m_srcPrefix[8];       
  uint8_t m_srcInterface[8];    
  uint8_t m_dstPrefix[8];       
  uint8_t m_dstInterface[8];    
  uint8_t m_trafficClass;       
  uint32_t m_flowLabel;         
  uint8_t m_nextHeader;         
  LowPanHc1Addr_e m_srcCompression; 
  LowPanHc1Addr_e m_dstCompression; 
  bool m_tcflCompression;       
  LowPanHc1NextHeader_e m_nextHeaderCompression; 
  bool m_hc2HeaderPresent;      
};

std::ostream & operator<< (std::ostream & os, SixLowPanHc1 const &header);

class SixLowPanFrag1 : public Header
{
public:
  SixLowPanFrag1 (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  void SetDatagramSize (uint16_t datagramSize);

  uint16_t GetDatagramSize (void) const;

  void SetDatagramTag (uint16_t datagramTag);

  uint16_t GetDatagramTag (void) const;

private:
  uint16_t m_datagramSize; 
  uint16_t m_datagramTag;  

};

std::ostream & operator<< (std::ostream & os, SixLowPanFrag1 const & header);

class SixLowPanFragN : public Header
{
public:
  SixLowPanFragN (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  void SetDatagramSize (uint16_t datagramSize);

  uint16_t GetDatagramSize (void) const;

  void SetDatagramTag (uint16_t datagramTag);

  uint16_t GetDatagramTag (void) const;

  void SetDatagramOffset (uint8_t datagramOffset);

  uint8_t GetDatagramOffset (void) const;

private:
  uint16_t m_datagramSize;  
  uint16_t m_datagramTag;   
  uint8_t m_datagramOffset; 

};

std::ostream & operator<< (std::ostream & os, SixLowPanFragN const &header);

class SixLowPanIpv6 : public Header
{
public:
  SixLowPanIpv6 (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

};

std::ostream & operator<< (std::ostream & os, SixLowPanIpv6 const & header);

class SixLowPanIphc : public Header
{
public:
  enum TrafficClassFlowLabel_e
  {
    TF_FULL = 0,
    TF_DSCP_ELIDED,
    TF_FL_ELIDED,
    TF_ELIDED
  };

  enum Hlim_e
  {
    HLIM_INLINE = 0,
    HLIM_COMPR_1,
    HLIM_COMPR_64,
    HLIM_COMPR_255
  };

  enum HeaderCompression_e
  {
    HC_INLINE = 0,
    HC_COMPR_64,
    HC_COMPR_16,
    HC_COMPR_0
  };

  SixLowPanIphc (void);
  SixLowPanIphc (uint8_t dispatch);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  void SetTf (TrafficClassFlowLabel_e tfField);

  TrafficClassFlowLabel_e GetTf (void) const;

  void SetNh (bool nhField);

  bool GetNh (void) const;

  void SetHlim (Hlim_e hlimField);

  Hlim_e GetHlim (void) const;

  void SetCid (bool cidField);

  bool GetCid (void) const;

  void SetSac (bool sacField);

  bool GetSac (void) const;

  void SetSam (HeaderCompression_e samField);

  HeaderCompression_e GetSam (void) const;

  void SetM (bool mField);

  bool GetM (void) const;

  void SetDac (bool dacField);

  bool GetDac (void) const;

  void SetDam (HeaderCompression_e damField);

  HeaderCompression_e GetDam (void) const;

  void SetSrcContextId (uint8_t srcContextId);

  uint8_t GetSrcContextId (void) const;

  void SetDstContextId (uint8_t dstContextId);

  uint8_t GetDstContextId (void) const;

  void SetEcn (uint8_t ecn);

  uint8_t GetEcn (void) const;

  void SetDscp (uint8_t dscp);

  uint8_t GetDscp (void) const;

  void SetFlowLabel (uint32_t flowLabel);

  uint32_t GetFlowLabel (void) const;

  void SetNextHeader (uint8_t nextHeader);

  uint8_t GetNextHeader (void) const;

  void SetHopLimit (uint8_t hopLimit);

  uint8_t GetHopLimit (void) const;

  void SetSrcAddress (Ipv6Address srcAddress);

  Ipv6Address GetSrcAddress () const;

  void SetDstAddress (Ipv6Address dstAddress);

  Ipv6Address GetDstAddress () const;

private:
  uint16_t m_baseFormat;      
  uint8_t m_srcdstContextId;  
  uint8_t m_ecn : 2;          
  uint8_t m_dscp : 6;         
  uint32_t m_flowLabel : 20;  
  uint8_t m_nextHeader;       
  uint8_t m_hopLimit;         
  Ipv6Address m_srcAddress;   
  Ipv6Address m_dstAddress;   

  void PostProcessSac ();
  void PostProcessDac ();

};

std::ostream & operator<< (std::ostream & os, SixLowPanIphc const &header);

class SixLowPanNhcExtension : public Header
{
public:
  enum Eid_e
  {
    EID_HOPBYHOP_OPTIONS_H = 0,
    EID_ROUTING_H,
    EID_FRAGMENTATION_H,
    EID_DESTINATION_OPTIONS_H,
    EID_MOBILITY_H,
    EID_IPv6_H = 7
  };

  SixLowPanNhcExtension (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  virtual SixLowPanDispatch::NhcDispatch_e GetNhcDispatchType (void) const;

  void SetEid (Eid_e extensionHeaderType);

  Eid_e GetEid (void) const;

  void SetNextHeader (uint8_t nextHeader);

  uint8_t GetNextHeader (void) const;

  void SetNh (bool nhField);

  bool GetNh (void) const;

  void SetBlob (const uint8_t* blob, uint32_t size);

  uint32_t CopyBlob (uint8_t* blob, uint32_t size) const;

private:
  uint8_t m_nhcExtensionHeader; 
  uint8_t m_nhcNextHeader;      
  uint8_t m_nhcBlobLength;      
  uint8_t m_nhcBlob[256];       
};

std::ostream & operator<< (std::ostream & os, SixLowPanNhcExtension const &header);


class SixLowPanUdpNhcExtension : public Header
{
public:
  enum Ports_e
  {
    PORTS_INLINE = 0,
    PORTS_ALL_SRC_LAST_DST,
    PORTS_LAST_SRC_ALL_DST,
    PORTS_LAST_SRC_LAST_DST
  };

  SixLowPanUdpNhcExtension (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  virtual SixLowPanDispatch::NhcDispatch_e GetNhcDispatchType (void) const;

  void SetPorts (Ports_e port);

  Ports_e GetPorts (void) const;

  void SetSrcPort (uint16_t port);

  uint16_t GetSrcPort () const;

  void SetDstPort (uint16_t port);

  uint16_t GetDstPort () const;

  void SetC (bool cField);

  bool GetC (void) const;

  void SetChecksum (uint16_t checksum);

  uint16_t GetChecksum (void) const;

private:
  uint8_t m_baseFormat; 
  uint16_t m_checksum;  
  uint16_t m_srcPort;   
  uint16_t m_dstPort;   
};

std::ostream & operator<< (std::ostream & os, SixLowPanUdpNhcExtension const &header);

class SixLowPanBc0 : public Header
{
public:
  SixLowPanBc0 (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  void SetSequenceNumber (uint8_t seqNumber);

  uint8_t GetSequenceNumber (void) const;

private:
  uint8_t m_seqNumber;          
};

std::ostream & operator<< (std::ostream & os, SixLowPanBc0 const &header);

class SixLowPanMesh : public Header
{
public:
  SixLowPanMesh (void);

  static TypeId GetTypeId (void);

  virtual TypeId GetInstanceTypeId (void) const;

  virtual void Print (std::ostream& os) const;

  virtual uint32_t GetSerializedSize (void) const;

  virtual void Serialize (Buffer::Iterator start) const;

  virtual uint32_t Deserialize (Buffer::Iterator start);

  void SetHopsLeft (uint8_t hopsLeft);

  uint8_t GetHopsLeft (void) const;

  void SetOriginator (Address originator);

  Address GetOriginator (void) const;

  void SetFinalDst (Address finalDst);

  Address GetFinalDst (void) const;

private:
  uint8_t m_hopsLeft; 
  bool m_v;           
  bool m_f;           
  Address m_src;      
  Address m_dst;      
};

std::ostream & operator<< (std::ostream & os, SixLowPanMesh const &header);

}

#endif /* SIXLOWPANHEADER_H_ */