A Discrete-Event Network Simulator
API
arp-header.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2005 INRIA
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: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #include "ns3/assert.h"
22 #include "ns3/address-utils.h"
23 #include "arp-header.h"
24 #include "ns3/log.h"
25 
26 namespace ns3 {
27 
28 NS_LOG_COMPONENT_DEFINE ("ArpHeader");
29 
30 NS_OBJECT_ENSURE_REGISTERED (ArpHeader);
31 
32 void
33 ArpHeader::SetRequest (Address sourceHardwareAddress,
34  Ipv4Address sourceProtocolAddress,
35  Address destinationHardwareAddress,
36  Ipv4Address destinationProtocolAddress)
37 {
38  NS_LOG_FUNCTION (this << sourceHardwareAddress << sourceProtocolAddress << destinationHardwareAddress << destinationProtocolAddress);
40  m_macSource = sourceHardwareAddress;
41  m_macDest = destinationHardwareAddress;
42  m_ipv4Source = sourceProtocolAddress;
43  m_ipv4Dest = destinationProtocolAddress;
44 }
45 void
46 ArpHeader::SetReply (Address sourceHardwareAddress,
47  Ipv4Address sourceProtocolAddress,
48  Address destinationHardwareAddress,
49  Ipv4Address destinationProtocolAddress)
50 {
51  NS_LOG_FUNCTION (this << sourceHardwareAddress << sourceProtocolAddress << destinationHardwareAddress << destinationProtocolAddress);
53  m_macSource = sourceHardwareAddress;
54  m_macDest = destinationHardwareAddress;
55  m_ipv4Source = sourceProtocolAddress;
56  m_ipv4Dest = destinationProtocolAddress;
57 }
58 bool
60 {
61  NS_LOG_FUNCTION (this);
62  return (m_type == ARP_TYPE_REQUEST) ? true : false;
63 }
64 bool
65 ArpHeader::IsReply (void) const
66 {
67  NS_LOG_FUNCTION (this);
68  return (m_type == ARP_TYPE_REPLY) ? true : false;
69 }
70 Address
72 {
73  NS_LOG_FUNCTION (this);
74  return m_macSource;
75 }
76 Address
78 {
79  NS_LOG_FUNCTION (this);
80  return m_macDest;
81 }
84 {
85  NS_LOG_FUNCTION (this);
86  return m_ipv4Source;
87 }
90 {
91  NS_LOG_FUNCTION (this);
92  return m_ipv4Dest;
93 }
94 
95 
96 TypeId
98 {
99  static TypeId tid = TypeId ("ns3::ArpHeader")
100  .SetParent<Header> ()
101  .SetGroupName ("Internet")
102  .AddConstructor<ArpHeader> ()
103  ;
104  return tid;
105 }
106 TypeId
108 {
109  NS_LOG_FUNCTION (this);
110  return GetTypeId ();
111 }
112 void
113 ArpHeader::Print (std::ostream &os) const
114 {
115  NS_LOG_FUNCTION (this << &os);
116  if (IsRequest ())
117  {
118  os << "request "
119  << "source mac: " << m_macSource << " "
120  << "source ipv4: " << m_ipv4Source << " "
121  << "dest ipv4: " << m_ipv4Dest
122  ;
123  }
124  else
125  {
126  NS_ASSERT (IsReply ());
127  os << "reply "
128  << "source mac: " << m_macSource << " "
129  << "source ipv4: " << m_ipv4Source << " "
130  << "dest mac: " << m_macDest << " "
131  << "dest ipv4: " <<m_ipv4Dest
132  ;
133  }
134 }
135 uint32_t
137 {
138  NS_LOG_FUNCTION (this);
139  NS_ASSERT ((m_macSource.GetLength () == 6) || (m_macSource.GetLength () == 8) || (m_macSource.GetLength () == 1));
141 
142  uint32_t length = 16; // Length minus two hardware addresses
143  length += m_macSource.GetLength () * 2;
144 
145  return length;
146 }
147 
148 void
150 {
151  NS_LOG_FUNCTION (this << &start);
154 
155  /* ethernet */
156  i.WriteHtonU16 (0x0001);
157  /* ipv4 */
158  i.WriteHtonU16 (0x0800);
160  i.WriteU8 (4);
161  i.WriteHtonU16 (m_type);
162  WriteTo (i, m_macSource);
163  WriteTo (i, m_ipv4Source);
164  WriteTo (i, m_macDest);
165  WriteTo (i, m_ipv4Dest);
166 }
167 
168 uint32_t
170 {
171  NS_LOG_FUNCTION (this << &start);
173  i.Next (2); // Skip HRD
174  uint32_t protocolType = i.ReadNtohU16 (); // Read PRO
175  uint32_t hardwareAddressLen = i.ReadU8 (); // Read HLN
176  uint32_t protocolAddressLen = i.ReadU8 (); // Read PLN
177 
178  //
179  // It is implicit here that we have a protocol type of 0x800 (IP).
180  // It is also implicit here that we are using Ipv4 (PLN == 4).
181  // If this isn't the case, we need to return an error since we don't want to
182  // be too fragile if we get connected to real networks.
183  //
184  if (protocolType != 0x800 || protocolAddressLen != 4)
185  {
186  return 0;
187  }
188 
189  m_type = i.ReadNtohU16 (); // Read OP
190  ReadFrom (i, m_macSource, hardwareAddressLen); // Read SHA (size HLN)
191  ReadFrom (i, m_ipv4Source); // Read SPA (size PLN == 4)
192  ReadFrom (i, m_macDest, hardwareAddressLen); // Read THA (size HLN)
193  ReadFrom (i, m_ipv4Dest); // Read TPA (size PLN == 4)
194  return GetSerializedSize ();
195 }
196 
197 } // namespace ns3
Protocol header serialization and deserialization.
Definition: header.h:42
void SetReply(Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
Set the ARP reply parameters.
Definition: arp-header.cc:46
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
static TypeId GetTypeId(void)
Get the type ID.
Definition: arp-header.cc:97
Address m_macSource
hardware source address
Definition: arp-header.h:115
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
uint8_t GetLength(void) const
Get the length of the underlying address.
Definition: address.cc:75
virtual uint32_t GetSerializedSize(void) const
Definition: arp-header.cc:136
Ipv4Address GetDestinationIpv4Address(void) const
Returns the destination IP address.
Definition: arp-header.cc:89
void ReadFrom(Buffer::Iterator &i, Ipv4Address &ad)
Read an Ipv4Address from a Buffer.
def start()
Definition: core.py:1855
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:67
void WriteTo(Buffer::Iterator &i, Ipv4Address ad)
Write an Ipv4Address to a Buffer.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:204
void SetRequest(Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
Set the ARP request parameters.
Definition: arp-header.cc:33
The packet header for an ARP packet.
Definition: arp-header.h:34
Address GetDestinationHardwareAddress(void) const
Returns the destination hardware address.
Definition: arp-header.cc:77
iterator in a Buffer instance
Definition: buffer.h:98
a polymophic address class
Definition: address.h:90
Address GetSourceHardwareAddress(void) const
Returns the source hardware address.
Definition: arp-header.cc:71
Ipv4Address GetSourceIpv4Address(void) const
Returns the source IP address.
Definition: arp-header.cc:83
Ipv4Address m_ipv4Source
IP source address.
Definition: arp-header.h:117
virtual uint32_t Deserialize(Buffer::Iterator start)
Definition: arp-header.cc:169
void WriteHtonU16(uint16_t data)
Definition: buffer.h:905
void Next(void)
go forward by one byte
Definition: buffer.h:845
bool IsRequest(void) const
Check if the ARP is a request.
Definition: arp-header.cc:59
virtual TypeId GetInstanceTypeId(void) const
Get the most derived TypeId for this Object.
Definition: arp-header.cc:107
virtual void Print(std::ostream &os) const
Definition: arp-header.cc:113
Address m_macDest
hardware destination address
Definition: arp-header.h:116
Ipv4Address m_ipv4Dest
IP destination address.
Definition: arp-header.h:118
bool IsReply(void) const
Check if the ARP is a reply.
Definition: arp-header.cc:65
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void Serialize(Buffer::Iterator start) const
Definition: arp-header.cc:149
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:40
void WriteU8(uint8_t data)
Definition: buffer.h:869
uint16_t m_type
type of the ICMP (ARP_TYPE_REQUEST)
Definition: arp-header.h:114
uint8_t ReadU8(void)
Definition: buffer.h:1021
uint16_t ReadNtohU16(void)
Definition: buffer.h:946
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915