A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 NS_LOG_COMPONENT_DEFINE ("ArpHeader");
27 
28 namespace ns3 {
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  .AddConstructor<ArpHeader> ()
102  ;
103  return tid;
104 }
105 TypeId
107 {
108  NS_LOG_FUNCTION (this);
109  return GetTypeId ();
110 }
111 void
112 ArpHeader::Print (std::ostream &os) const
113 {
114  NS_LOG_FUNCTION (this << &os);
115  if (IsRequest ())
116  {
117  os << "request "
118  << "source mac: " << m_macSource << " "
119  << "source ipv4: " << m_ipv4Source << " "
120  << "dest ipv4: " << m_ipv4Dest
121  ;
122  }
123  else
124  {
125  NS_ASSERT (IsReply ());
126  os << "reply "
127  << "source mac: " << m_macSource << " "
128  << "source ipv4: " << m_ipv4Source << " "
129  << "dest mac: " << m_macDest << " "
130  << "dest ipv4: " <<m_ipv4Dest
131  ;
132  }
133 }
134 uint32_t
136 {
137  NS_LOG_FUNCTION (this);
138  NS_ASSERT((m_macSource.GetLength () == 6) || (m_macSource.GetLength () == 8));
140 
141  uint32_t length = 16; // Length minus two hardware addresses
142  length += m_macSource.GetLength () * 2;
143 
144  return length;
145 }
146 
147 void
149 {
150  NS_LOG_FUNCTION (this << &start);
153 
154  /* ethernet */
155  i.WriteHtonU16 (0x0001);
156  /* ipv4 */
157  i.WriteHtonU16 (0x0800);
159  i.WriteU8 (4);
160  i.WriteHtonU16 (m_type);
161  WriteTo (i, m_macSource);
162  WriteTo (i, m_ipv4Source);
163  WriteTo (i, m_macDest);
164  WriteTo (i, m_ipv4Dest);
165 }
166 
167 uint32_t
169 {
170  NS_LOG_FUNCTION (this << &start);
172  i.Next (2); // Skip HRD
173  uint32_t protocolType = i.ReadNtohU16 (); // Read PRO
174  uint32_t hardwareAddressLen = i.ReadU8 (); // Read HLN
175  uint32_t protocolAddressLen = i.ReadU8 (); // Read PLN
176 
177  //
178  // It is implicit here that we have a protocol type of 0x800 (IP).
179  // It is also implicit here that we are using Ipv4 (PLN == 4).
180  // If this isn't the case, we need to return an error since we don't want to
181  // be too fragile if we get connected to real networks.
182  //
183  if (protocolType != 0x800 || protocolAddressLen != 4)
184  {
185  return 0;
186  }
187 
188  m_type = i.ReadNtohU16 (); // Read OP
189  ReadFrom (i, m_macSource, hardwareAddressLen); // Read SHA (size HLN)
190  ReadFrom (i, m_ipv4Source); // Read SPA (size PLN == 4)
191  ReadFrom (i, m_macDest, hardwareAddressLen); // Read THA (size HLN)
192  ReadFrom (i, m_ipv4Dest); // Read TPA (size PLN == 4)
193  return GetSerializedSize ();
194 }
195 
196 } // 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 the class in the ns-3 factory.
Definition: object-base.h:38
void ReadFrom(Buffer::Iterator &i, Ipv4Address &ad)
Read an Ipv4Address from a Buffer.
virtual void Serialize(Buffer::Iterator start) const
Definition: arp-header.cc:148
#define NS_ASSERT(condition)
At runtime, in debugging builds, if this condition is not true, the program prints the source file...
Definition: assert.h:61
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:170
Ipv4Address GetSourceIpv4Address(void)
Returns the source IP address.
Definition: arp-header.cc:83
void SetRequest(Address sourceHardwareAddress, Ipv4Address sourceProtocolAddress, Address destinationHardwareAddress, Ipv4Address destinationProtocolAddress)
Set the ARP request parameters.
Definition: arp-header.cc:33
iterator in a Buffer instance
Definition: buffer.h:98
a polymophic address class
Definition: address.h:86
Ipv4Address m_ipv4Source
IP source address.
Definition: arp-header.h:117
virtual uint32_t Deserialize(Buffer::Iterator start)
Definition: arp-header.cc:168
void WriteHtonU16(uint16_t data)
Definition: buffer.h:912
uint8_t GetLength(void) const
Get the length of the underlying address.
Definition: address.cc:75
void Next(void)
go forward by one byte
Definition: buffer.h:852
Address m_macDest
hardware destination address
Definition: arp-header.h:116
Ipv4Address m_ipv4Dest
IP destination address.
Definition: arp-header.h:118
Address GetDestinationHardwareAddress(void)
Returns the destination hardware address.
Definition: arp-header.cc:77
Ipv4Address GetDestinationIpv4Address(void)
Returns the destination IP address.
Definition: arp-header.cc:89
Ipv4 addresses are stored in host order in this class.
Definition: ipv4-address.h:38
void WriteU8(uint8_t data)
Definition: buffer.h:876
uint16_t m_type
type of the ICMP (ARP_TYPE_REQUEST)
Definition: arp-header.h:114
Address GetSourceHardwareAddress(void)
Returns the source hardware address.
Definition: arp-header.cc:71
uint8_t ReadU8(void)
Definition: buffer.h:1028
bool IsReply(void) const
Check if the ARP is a reply.
Definition: arp-header.cc:65
virtual TypeId GetInstanceTypeId(void) const
Definition: arp-header.cc:106
virtual void Print(std::ostream &os) const
Definition: arp-header.cc:112
uint16_t ReadNtohU16(void)
Definition: buffer.h:953
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:610
virtual uint32_t GetSerializedSize(void) const
Definition: arp-header.cc:135
bool IsRequest(void) const
Check if the ARP is a request.
Definition: arp-header.cc:59