A Discrete-Event Network Simulator
API
ipv6-header.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2007-2008 Louis Pasteur University
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Sebastien Vincent <vincent@clarinet.u-strasbg.fr>
19 */
20
21#include "ns3/assert.h"
22#include "ns3/log.h"
23#include "ns3/header.h"
24
25#include "ns3/address-utils.h"
26#include "ipv6-header.h"
27
28namespace ns3 {
29
30NS_LOG_COMPONENT_DEFINE ("Ipv6Header");
31
33
35 : m_trafficClass (0),
36 m_flowLabel (1),
37 m_payloadLength (0),
38 m_nextHeader (0),
39 m_hopLimit (0)
40{
41 SetSource (Ipv6Address ("::"));
43}
44
45void Ipv6Header::SetTrafficClass (uint8_t traffic)
46{
47 m_trafficClass = traffic;
48}
49
51{
52 return m_trafficClass;
53}
54
56{
57 m_flowLabel = flow;
58}
59
61{
62 return m_flowLabel;
63}
64
66{
67 m_payloadLength = len;
68}
69
71{
72 return m_payloadLength;
73}
74
75void Ipv6Header::SetNextHeader (uint8_t next)
76{
77 m_nextHeader = next;
78}
79
81{
82 return m_nextHeader;
83}
84
85void Ipv6Header::SetHopLimit (uint8_t limit)
86{
87 m_hopLimit = limit;
88}
89
91{
92 return m_hopLimit;
93}
94
96{
97 m_sourceAddress = src;
98}
99
101{
102 SetSource (src);
103}
104
106{
107 return m_sourceAddress;
108}
109
111{
112 return GetSource ();
113}
114
116{
118}
119
121{
122 SetDestination (dst);
123}
124
126{
128}
129
131{
132 return GetDestination ();
133}
134
136{
137 static TypeId tid = TypeId ("ns3::Ipv6Header")
138 .SetParent<Header> ()
139 .SetGroupName ("Internet")
140 .AddConstructor<Ipv6Header> ()
141 ;
142 return tid;
143}
144
146{
147 return GetTypeId ();
148}
149
150void Ipv6Header::Print (std::ostream& os) const
151{
152 os << "(Version 6 "
153 << "Traffic class 0x" << std::hex << m_trafficClass << std::dec << " "
154 << "DSCP " << DscpTypeToString (GetDscp ()) << " "
155 << "Flow Label 0x" << std::hex << m_flowLabel << std::dec << " "
156 << "Payload Length " << m_payloadLength << " "
157 << "Next Header " << std::dec << (uint32_t) m_nextHeader << " "
158 << "Hop Limit " << std::dec << (uint32_t)m_hopLimit << " )"
160 ;
161}
162
164{
165 return 10 * 4;
166}
167
169{
171 uint32_t vTcFl = 0; /* version, Traffic Class and Flow Label fields */
172
173 vTcFl = (6 << 28) | (m_trafficClass << 20) | (m_flowLabel);
174
175 i.WriteHtonU32 (vTcFl);
179
182}
183
185{
187 uint32_t vTcFl = 0;
188
189 vTcFl = i.ReadNtohU32 ();
190 if ((vTcFl >> 28) != 6)
191 {
192 NS_LOG_WARN ("Trying to decode a non-IPv6 header, refusing to do it.");
193 return 0;
194 }
195
196 m_trafficClass = (uint8_t)((vTcFl >> 20) & 0x000000ff);
197 m_flowLabel = vTcFl & 0xfffff;
199 m_nextHeader = i.ReadU8 ();
200 m_hopLimit = i.ReadU8 ();
201
204
205 return GetSerializedSize ();
206}
207
209{
210 NS_LOG_FUNCTION (this << dscp);
211 m_trafficClass &= 0x3; // Clear out the DSCP part, retain 2 bits of ECN
212 m_trafficClass |= (dscp << 2);
213}
214
216{
217 NS_LOG_FUNCTION (this << ecn);
218 m_trafficClass &= 0xFC; // Clear out the ECN part, retain 6 bits of DSCP
219 m_trafficClass |= ecn;
220}
221
223{
224 NS_LOG_FUNCTION (this);
225 // Extract only first 6 bits of TOS byte, i.e 0xFC
226 return DscpType ((m_trafficClass & 0xFC) >> 2);
227}
228
230{
231 NS_LOG_FUNCTION (this << dscp);
232 switch (dscp)
233 {
234 case DscpDefault:
235 return "Default";
236 case DSCP_CS1:
237 return "CS1";
238 case DSCP_AF11:
239 return "AF11";
240 case DSCP_AF12:
241 return "AF12";
242 case DSCP_AF13:
243 return "AF13";
244 case DSCP_CS2:
245 return "CS2";
246 case DSCP_AF21:
247 return "AF21";
248 case DSCP_AF22:
249 return "AF22";
250 case DSCP_AF23:
251 return "AF23";
252 case DSCP_CS3:
253 return "CS3";
254 case DSCP_AF31:
255 return "AF31";
256 case DSCP_AF32:
257 return "AF32";
258 case DSCP_AF33:
259 return "AF33";
260 case DSCP_CS4:
261 return "CS4";
262 case DSCP_AF41:
263 return "AF41";
264 case DSCP_AF42:
265 return "AF42";
266 case DSCP_AF43:
267 return "AF43";
268 case DSCP_CS5:
269 return "CS5";
270 case DSCP_EF:
271 return "EF";
272 case DSCP_CS6:
273 return "CS6";
274 case DSCP_CS7:
275 return "CS7";
276 default:
277 return "Unrecognized DSCP";
278 };
279}
280
283{
284 NS_LOG_FUNCTION (this);
285 // Extract only last 2 bits of Traffic Class byte, i.e 0x3
286 return EcnType (m_trafficClass & 0x3);
287}
288
290{
291 NS_LOG_FUNCTION (this << ecn);
292 switch (ecn)
293 {
294 case ECN_NotECT:
295 return "Not-ECT";
296 case ECN_ECT1:
297 return "ECT (1)";
298 case ECN_ECT0:
299 return "ECT (0)";
300 case ECN_CE:
301 return "CE";
302 default:
303 return "Unknown ECN codepoint";
304 };
305}
306
307} /* namespace ns3 */
308
iterator in a Buffer instance
Definition: buffer.h:99
uint16_t ReadNtohU16(void)
Definition: buffer.h:946
void WriteU8(uint8_t data)
Definition: buffer.h:869
uint8_t ReadU8(void)
Definition: buffer.h:1021
void WriteHtonU16(uint16_t data)
Definition: buffer.h:905
void WriteHtonU32(uint32_t data)
Definition: buffer.h:924
uint32_t ReadNtohU32(void)
Definition: buffer.h:970
Protocol header serialization and deserialization.
Definition: header.h:43
Describes an IPv6 address.
Definition: ipv6-address.h:50
Packet header for IPv6.
Definition: ipv6-header.h:36
void SetDestination(Ipv6Address dst)
Set the "Destination address" field.
Definition: ipv6-header.cc:115
NS_DEPRECATED_3_35 Ipv6Address GetSourceAddress(void) const
Get the "Source address" field.
Definition: ipv6-header.cc:110
uint8_t GetHopLimit(void) const
Get the "Hop limit" field (TTL).
Definition: ipv6-header.cc:90
virtual TypeId GetInstanceTypeId(void) const
Return the instance type identifier.
Definition: ipv6-header.cc:145
virtual void Print(std::ostream &os) const
Print some information about the packet.
Definition: ipv6-header.cc:150
void SetEcn(EcnType ecn)
Set ECN field bits.
Definition: ipv6-header.cc:215
Ipv6Address GetSource(void) const
Get the "Source address" field.
Definition: ipv6-header.cc:105
virtual uint32_t GetSerializedSize(void) const
Get the serialized size of the packet.
Definition: ipv6-header.cc:163
DscpType GetDscp(void) const
Definition: ipv6-header.cc:222
static TypeId GetTypeId(void)
Get the type identifier.
Definition: ipv6-header.cc:135
Ipv6Address m_destinationAddress
The destination address.
Definition: ipv6-header.h:342
void SetSource(Ipv6Address src)
Set the "Source address" field.
Definition: ipv6-header.cc:95
uint8_t GetNextHeader(void) const
Get the next header.
Definition: ipv6-header.cc:80
void SetHopLimit(uint8_t limit)
Set the "Hop limit" field (TTL).
Definition: ipv6-header.cc:85
uint32_t m_flowLabel
The flow label.
Definition: ipv6-header.h:317
void SetPayloadLength(uint16_t len)
Set the "Payload length" field.
Definition: ipv6-header.cc:65
NS_DEPRECATED_3_35 Ipv6Address GetDestinationAddress(void) const
Get the "Destination address" field.
Definition: ipv6-header.cc:130
Ipv6Header(void)
Constructor.
Definition: ipv6-header.cc:34
uint8_t GetTrafficClass(void) const
Get the "Traffic class" field.
Definition: ipv6-header.cc:50
uint16_t GetPayloadLength(void) const
Get the "Payload length" field.
Definition: ipv6-header.cc:70
void SetFlowLabel(uint32_t flow)
Set the "Flow label" field.
Definition: ipv6-header.cc:55
Ipv6Address m_sourceAddress
The source address.
Definition: ipv6-header.h:337
EcnType
ECN field bits.
Definition: ipv6-header.h:153
uint16_t m_payloadLength
The payload length.
Definition: ipv6-header.h:322
uint8_t m_nextHeader
The Next header number.
Definition: ipv6-header.h:327
NS_DEPRECATED_3_35 void SetSourceAddress(Ipv6Address src)
Set the "Source address" field.
Definition: ipv6-header.cc:100
std::string DscpTypeToString(DscpType dscp) const
Definition: ipv6-header.cc:229
std::string EcnTypeToString(EcnType ecn) const
Definition: ipv6-header.cc:289
virtual void Serialize(Buffer::Iterator start) const
Serialize the packet.
Definition: ipv6-header.cc:168
void SetTrafficClass(uint8_t traffic)
Set the "Traffic class" field.
Definition: ipv6-header.cc:45
void SetDscp(DscpType dscp)
Set DSCP Field.
Definition: ipv6-header.cc:208
uint32_t GetFlowLabel(void) const
Get the "Flow label" field.
Definition: ipv6-header.cc:60
virtual uint32_t Deserialize(Buffer::Iterator start)
Deserialize the packet.
Definition: ipv6-header.cc:184
Ipv6Address GetDestination(void) const
Get the "Destination address" field.
Definition: ipv6-header.cc:125
void SetNextHeader(uint8_t next)
Set the "Next header" field.
Definition: ipv6-header.cc:75
uint32_t m_trafficClass
The traffic class.
Definition: ipv6-header.h:311
EcnType GetEcn(void) const
Definition: ipv6-header.cc:282
NS_DEPRECATED_3_35 void SetDestinationAddress(Ipv6Address dst)
Set the "Destination address" field.
Definition: ipv6-header.cc:120
uint8_t m_hopLimit
The Hop limit value.
Definition: ipv6-header.h:332
DscpType
DiffServ Code Points Code Points defined in Assured Forwarding (AF) RFC 2597 Expedited Forwarding (EF...
Definition: ipv6-header.h:47
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_LOG_WARN(msg)
Use NS_LOG to output a message of level LOG_WARN.
Definition: log.h:265
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Every class exported by the ns3 library is enclosed in the ns3 namespace.
void WriteTo(Buffer::Iterator &i, Ipv4Address ad)
Write an Ipv4Address to a Buffer.
void ReadFrom(Buffer::Iterator &i, Ipv4Address &ad)
Read an Ipv4Address from a Buffer.
def start()
Definition: core.py:1852