Implement the Ipv4 layer. More...

#include <ipv4-l3-protocol.h>

Inheritance diagram for ns3::Ipv4L3Protocol:

Classes
class	Fragments
	A Set of Fragment belonging to the same packet (src, dst, identification and proto) More...

Public Types
enum	DropReason { DROP_TTL_EXPIRED = 1, DROP_NO_ROUTE, DROP_BAD_CHECKSUM, DROP_INTERFACE_DOWN, DROP_ROUTE_ERROR, DROP_FRAGMENT_TIMEOUT }
	Reason why a packet has been dropped. More...

Public Member Functions
bool	AddAddress (uint32_t i, Ipv4InterfaceAddress address)

uint32_t	AddInterface (Ptr< NetDevice > device)

Ptr< Socket >	CreateRawSocket (void)
	Creates a raw socket. More...

void	DeleteRawSocket (Ptr< Socket > socket)
	Deletes a particular raw socket. More...

Ipv4InterfaceAddress	GetAddress (uint32_t interfaceIndex, uint32_t addressIndex) const

Ptr< Ipv4Interface >	GetInterface (uint32_t i) const

int32_t	GetInterfaceForAddress (Ipv4Address addr) const
	Return the interface number of the interface that has been assigned the specified IP address. More...

int32_t	GetInterfaceForDevice (Ptr< const NetDevice > device) const

int32_t	GetInterfaceForPrefix (Ipv4Address addr, Ipv4Mask mask) const
	Return the interface number of first interface found that has an Ipv4 address within the prefix specified by the input address and mask parameters. More...

uint16_t	GetMetric (uint32_t i) const

uint16_t	GetMtu (uint32_t i) const

uint32_t	GetNAddresses (uint32_t interface) const

Ptr< NetDevice >	GetNetDevice (uint32_t i)

uint32_t	GetNInterfaces (void) const

Ptr< IpL4Protocol >	GetProtocol (int protocolNumber) const

Ptr< Ipv4RoutingProtocol >	GetRoutingProtocol (void) const
	Get the routing protocol to be used by this Ipv4 stack. More...

void	Insert (Ptr< IpL4Protocol > protocol)

bool	IsDestinationAddress (Ipv4Address address, uint32_t iif) const
	Determine whether address and interface corresponding to received packet can be accepted for local delivery. More...

bool	IsForwarding (uint32_t i) const

bool	IsUp (uint32_t i) const

void	Receive (Ptr< NetDevice > device, Ptr< const Packet > p, uint16_t protocol, const Address &from, const Address &to, NetDevice::PacketType packetType)

void	Remove (Ptr< IpL4Protocol > protocol)

bool	RemoveAddress (uint32_t interfaceIndex, uint32_t addressIndex)

Ipv4Address	SelectSourceAddress (Ptr< const NetDevice > device, Ipv4Address dst, Ipv4InterfaceAddress::InterfaceAddressScope_e scope)
	Return the first primary source address with scope less than or equal to the requested scope, to use in sending a packet to destination dst out of the specified device. More...

void	Send (Ptr< Packet > packet, Ipv4Address source, Ipv4Address destination, uint8_t protocol, Ptr< Ipv4Route > route)

void	SendWithHeader (Ptr< Packet > packet, Ipv4Header ipHeader, Ptr< Ipv4Route > route)

void	SetDefaultTtl (uint8_t ttl)

void	SetDown (uint32_t i)

void	SetForwarding (uint32_t i, bool val)

void	SetMetric (uint32_t i, uint16_t metric)

void	SetNode (Ptr< Node > node)

void	SetRoutingProtocol (Ptr< Ipv4RoutingProtocol > routingProtocol)
	Register a new routing protocol to be used by this Ipv4 stack. More...

void	SetUp (uint32_t i)

Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)

void	Dispose (void)

AggregateIterator	GetAggregateIterator (void) const

virtual TypeId	GetInstanceTypeId (void) const

template<typename T >
Ptr< T >	GetObject (void) const

template<typename T >
Ptr< T >	GetObject (TypeId tid) const

void	Initialize (void)

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::ObjectBase
void	GetAttribute (std::string name, AttributeValue &value) const

bool	GetAttributeFailSafe (std::string name, AttributeValue &attribute) const

void	SetAttribute (std::string name, const AttributeValue &value)

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Ipv4
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Static Public Attributes
static const uint16_t	PROT_NUMBER = 0x0800

Static Public Attributes inherited from ns3::Ipv4
static const uint32_t	IF_ANY = 0xffffffff

Protected Member Functions
virtual void	DoDispose (void)

virtual void	NotifyNewAggregate ()

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

virtual void	DoInitialize (void)

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)

Private Types
typedef std::vector< Ptr < Ipv4Interface > >	Ipv4InterfaceList

typedef std::list< Ptr < IpL4Protocol > >	L4List_t

typedef std::map< std::pair < uint64_t, uint32_t >, Ptr < Fragments > >	MapFragments_t

typedef std::map< std::pair < uint64_t, uint32_t > , EventId >	MapFragmentsTimers_t

typedef std::list< Ptr < Ipv4RawSocketImpl > >	SocketList

Private Member Functions
	Ipv4L3Protocol (const Ipv4L3Protocol &)

uint32_t	AddIpv4Interface (Ptr< Ipv4Interface > interface)

Ipv4Header	BuildHeader (Ipv4Address source, Ipv4Address destination, uint8_t protocol, uint16_t payloadSize, uint8_t ttl, uint8_t tos, bool mayFragment)

void	DoFragmentation (Ptr< Packet > packet, uint32_t outIfaceMtu, std::list< Ptr< Packet > > &listFragments)
	Fragment a packet. More...

Ptr< Icmpv4L4Protocol >	GetIcmp (void) const
	Get ICMPv4 protocol. More...

virtual bool	GetIpForward (void) const

virtual bool	GetWeakEsModel (void) const

void	HandleFragmentsTimeout (std::pair< uint64_t, uint32_t > key, Ipv4Header &ipHeader, uint32_t iif)
	Process the timeout for packet fragments. More...

void	IpForward (Ptr< Ipv4Route > rtentry, Ptr< const Packet > p, const Ipv4Header &header)

void	IpMulticastForward (Ptr< Ipv4MulticastRoute > mrtentry, Ptr< const Packet > p, const Ipv4Header &header)

bool	IsUnicast (Ipv4Address ad, Ipv4Mask interfaceMask) const

void	LocalDeliver (Ptr< const Packet > p, Ipv4Header const &ip, uint32_t iif)

Ipv4L3Protocol &	operator= (const Ipv4L3Protocol &)

bool	ProcessFragment (Ptr< Packet > &packet, Ipv4Header &ipHeader, uint32_t iif)
	Process a packet fragment. More...

void	RouteInputError (Ptr< const Packet > p, const Ipv4Header &ipHeader, Socket::SocketErrno sockErrno)

void	SendRealOut (Ptr< Ipv4Route > route, Ptr< Packet > packet, Ipv4Header const &ipHeader)

virtual void	SetIpForward (bool forward)

void	SetupLoopback (void)

virtual void	SetWeakEsModel (bool model)

Private Attributes
uint8_t	m_defaultTos

uint8_t	m_defaultTtl

TracedCallback< const Ipv4Header &, Ptr< const Packet >, DropReason, Ptr < Ipv4 >, uint32_t >	m_dropTrace

Time	m_fragmentExpirationTimeout

MapFragments_t	m_fragments
	The hash of fragmented packets.

MapFragmentsTimers_t	m_fragmentsTimers

uint16_t	m_identification

Ipv4InterfaceList	m_interfaces

bool	m_ipForward

TracedCallback< const Ipv4Header &, Ptr< const Packet >, uint32_t >	m_localDeliverTrace

Ptr< Node >	m_node

L4List_t	m_protocols

Ptr< Ipv4RoutingProtocol >	m_routingProtocol

TracedCallback< Ptr< const Packet >, Ptr< Ipv4 > , uint32_t >	m_rxTrace

TracedCallback< const Ipv4Header &, Ptr< const Packet >, uint32_t >	m_sendOutgoingTrace

SocketList	m_sockets

TracedCallback< Ptr< const Packet >, Ptr< Ipv4 > , uint32_t >	m_txTrace

TracedCallback< const Ipv4Header &, Ptr< const Packet >, uint32_t >	m_unicastForwardTrace

bool	m_weakEsModel

Friends
class	Ipv4L3ProtocolTestCase

Detailed Description

Implement the Ipv4 layer.

This is the actual implementation of IP. It contains APIs to send and receive packets at the IP layer, as well as APIs for IP routing.

This class contains two distinct groups of trace sources. The trace sources 'Rx' and 'Tx' are called, respectively, immediately after receiving from the NetDevice and immediately before sending to a NetDevice for transmitting a packet. These are low level trace sources that include the Ipv4Header already serialized into the packet. In contrast, the Drop, SendOutgoing, UnicastForward, and LocalDeliver trace sources are slightly higher-level and pass around the Ipv4Header as an explicit parameter and not as part of the packet.

IP fragmentation and reassembly is handled at this level. At the moment the fragmentation does not handle IP option headers, and in particular the ones that shall not be fragmented. Moreover, the actual implementation does not mimic exactly the Linux kernel. Hence it is not possible, for instance, to test a fragmentation attack.

Config Paths

ns3::Ipv4L3Protocol is accessible through the following paths with Config::Set and Config::Connect:

/NodeList/[i]/$ns3::Ipv4L3Protocol

Attributes

DefaultTos: The TOS value set by default on all outgoing packets generated on this node.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: construct write read
DefaultTtl: The TTL value set by default on all outgoing packets generated on this node.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 64
- Flags: construct write read
FragmentExpirationTimeout: When this timeout expires, the fragments will be cleared from the buffer.
- Set with class: TimeValue
- Underlying type: Time
- Initial value: +30000000000.0ns
- Flags: construct write read
InterfaceList: The set of Ipv4 interfaces associated to this Ipv4 stack.
- Set with class: ns3::ObjectPtrContainerValue
- Underlying type: ns3::Ptr< ns3::Ipv4Interface >
- Flags: read

Attributes defined in parent class ns3::Ipv4

IpForward: Globally enable or disable IP forwarding for all current and future Ipv4 devices.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read
WeakEsModel: RFC1122 term for whether host accepts datagram with a dest. address on another interface
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: construct write read

TraceSources

Tx: Send ipv4 packet to outgoing interface.
Rx: Receive ipv4 packet from incoming interface.
Drop: Drop ipv4 packet
SendOutgoing: A newly-generated packet by this node is about to be queued for transmission
UnicastForward: A unicast IPv4 packet was received by this node and is being forwarded to another node
LocalDeliver: An IPv4 packet was received by/for this node, and it is being forward up the stack

Definition at line 77 of file ipv4-l3-protocol.h.

Member Enumeration Documentation

enum ns3::Ipv4L3Protocol::DropReason

Reason why a packet has been dropped.

Enumerator
DROP_TTL_EXPIRED	Packet TTL has expired
DROP_NO_ROUTE	No route to host
DROP_BAD_CHECKSUM	Bad checksum
DROP_INTERFACE_DOWN	Interface is down so can not send packet
DROP_ROUTE_ERROR	Route error
DROP_FRAGMENT_TIMEOUT	Fragment timeout exceeded

Definition at line 90 of file ipv4-l3-protocol.h.

Member Function Documentation

bool ns3::Ipv4L3Protocol::AddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

virtual

Parameters

interface	Interface number of an Ipv4 interface
address	Ipv4InterfaceAddress address to associate with the underlying Ipv4 interface

Returns: true if the operation succeeded

Implements ns3::Ipv4.

Definition at line 940 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::AddAddress(), and NS_LOG_FUNCTION.

uint32_t ns3::Ipv4L3Protocol::AddInterface ( Ptr< NetDevice > device )

virtual

Parameters

device device to add to the list of Ipv4 interfaces which can be used as output interfaces during packet forwarding.

Returns: the index of the Ipv4 interface added.

Once a device has been added, it can never be removed: if you want to disable it, you can invoke Ipv4::SetDown which will make sure that it is never used during packet forwarding.

Implements ns3::Ipv4.

Definition at line 280 of file ipv4-l3-protocol.cc.

References ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::ArpL3Protocol::Receive(), Receive(), and ns3::Node::RegisterProtocolHandler().

Ptr< Socket > ns3::Ipv4L3Protocol::CreateRawSocket ( void )

virtual

Creates a raw socket.

Returns: a smart pointer to the instantiated raw socket

Implements ns3::Ipv4.

Definition at line 140 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::DeleteRawSocket ( Ptr< Socket > socket )

virtual

Deletes a particular raw socket.

Parameters

socket Smart pointer to the raw socket to be deleted

Implements ns3::Ipv4.

Definition at line 149 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::DoDispose ( void )

protectedvirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 200 of file ipv4-l3-protocol.cc.

References ns3::Object::DoDispose(), m_fragments, and NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::DoFragmentation	(	Ptr< Packet >	packet,
		uint32_t	outIfaceMtu,
		std::list< Ptr< Packet > > &	listFragments
	)

private

Fragment a packet.

Parameters

packet	the packet
outIfaceMtu	the MTU of the interface
listFragments	the list of fragments

Definition at line 1161 of file ipv4-l3-protocol.cc.

References ns3::Packet::AddHeader(), ns3::Node::ChecksumEnabled(), ns3::Packet::Copy(), ns3::Packet::CreateFragment(), ns3::Ipv4Header::EnableChecksum(), ns3::Ipv4Header::GetFragmentOffset(), ns3::Ipv4Header::GetSerializedSize(), ns3::Packet::GetSize(), ns3::Ipv4Header::IsLastFragment(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::Packet::Print(), ns3::Packet::RemoveHeader(), ns3::Ipv4Header::SetFragmentOffset(), ns3::Ipv4Header::SetLastFragment(), ns3::Ipv4Header::SetMoreFragments(), and ns3::Ipv4Header::SetPayloadSize().

Ipv4InterfaceAddress ns3::Ipv4L3Protocol::GetAddress	(	uint32_t	interface,
		uint32_t	addressIndex
	)		const

virtual

Because addresses can be removed, the addressIndex is not guaranteed to be static across calls to this method.

Parameters

interface	Interface number of an Ipv4 interface
addressIndex	index of Ipv4InterfaceAddress

Returns: the Ipv4InterfaceAddress associated to the interface and addressIndex

Implements ns3::Ipv4.

Definition at line 953 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::GetAddress(), and NS_LOG_FUNCTION.

Referenced by IsDestinationAddress(), SelectSourceAddress(), and Send().

Ptr< Icmpv4L4Protocol > ns3::Ipv4L3Protocol::GetIcmp ( void ) const

private

Get ICMPv4 protocol.

Returns: Icmpv4L4Protocol pointer

Definition at line 528 of file ipv4-l3-protocol.cc.

References ns3::Object::GetObject(), GetProtocol(), and NS_LOG_FUNCTION.

Referenced by HandleFragmentsTimeout().

int32_t ns3::Ipv4L3Protocol::GetInterfaceForAddress ( Ipv4Address address ) const

virtual

Return the interface number of the interface that has been assigned the specified IP address.

Parameters

address The IP address being searched for

Returns: The interface number of the Ipv4 interface with the given address or -1 if not found.

Each IP interface has one or more IP addresses associated with it. This method searches the list of interfaces for one that holds a particular address. This call takes an IP address as a parameter and returns the interface number of the first interface that has been assigned that address, or -1 if not found. There must be an exact match; this method will not match broadcast or multicast addresses.

Implements ns3::Ipv4.

Definition at line 325 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

int32_t ns3::Ipv4L3Protocol::GetInterfaceForDevice ( Ptr< const NetDevice > device ) const

virtual

Parameters

device The NetDevice for an Ipv4Interface

Returns: The interface number of an Ipv4 interface or -1 if not found.

Implements ns3::Ipv4.

Definition at line 370 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by SelectSourceAddress(), and Send().

int32_t ns3::Ipv4L3Protocol::GetInterfaceForPrefix	(	Ipv4Address	address,
		Ipv4Mask	mask
	)		const

virtual

Return the interface number of first interface found that has an Ipv4 address within the prefix specified by the input address and mask parameters.

Parameters

address	The IP address assigned to the interface of interest.
mask	The IP prefix to use in the mask

Returns: The interface number of the Ipv4 interface with the given address or -1 if not found.

Each IP interface has one or more IP addresses associated with it. This method searches the list of interfaces for the first one found that holds an address that is included within the prefix formed by the input address and mask parameters. The value -1 is returned if no match is found.

Implements ns3::Ipv4.

Definition at line 347 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Address::CombineMask(), and NS_LOG_FUNCTION.

uint16_t ns3::Ipv4L3Protocol::GetMetric ( uint32_t interface ) const

virtual

Parameters

interface The interface number of an Ipv4 interface

Returns: routing metric (cost) associated to the underlying Ipv4 interface

Implements ns3::Ipv4.

Definition at line 1047 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::GetMetric(), and NS_LOG_FUNCTION.

uint16_t ns3::Ipv4L3Protocol::GetMtu ( uint32_t interface ) const

virtual

Parameters

interface Interface number of Ipv4 interface

Returns: the Maximum Transmission Unit (in bytes) associated to the underlying Ipv4 interface

Implements ns3::Ipv4.

Definition at line 1055 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::GetDevice(), and NS_LOG_FUNCTION.

uint32_t ns3::Ipv4L3Protocol::GetNAddresses ( uint32_t interface ) const

virtual

Parameters

interface Interface number of an Ipv4 interface

Returns: the number of Ipv4InterfaceAddress entries for the interface.

Implements ns3::Ipv4.

Definition at line 961 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::GetNAddresses(), and NS_LOG_FUNCTION.

Referenced by IsDestinationAddress(), SelectSourceAddress(), and Send().

Ptr< NetDevice > ns3::Ipv4L3Protocol::GetNetDevice ( uint32_t interface )

virtual

Parameters

interface The interface number of an Ipv4 interface.

Returns: The NetDevice associated with the Ipv4 interface number.

Implements ns3::Ipv4.

Definition at line 1114 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::GetDevice(), and NS_LOG_FUNCTION.

uint32_t ns3::Ipv4L3Protocol::GetNInterfaces ( void ) const

virtual

Returns: the number of interfaces added by the user.

Implements ns3::Ipv4.

Definition at line 318 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by IsDestinationAddress(), and SelectSourceAddress().

Ptr< IpL4Protocol > ns3::Ipv4L3Protocol::GetProtocol ( int protocolNumber ) const

virtual

Parameters

protocolNumber number of protocol to lookup in this L4 Demux

Returns: a matching L4 Protocol

This method is typically called by lower layers to forward packets up the stack to the right protocol.

Implements ns3::Ipv4.

Definition at line 111 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

Referenced by GetIcmp().

Ptr< Ipv4RoutingProtocol > ns3::Ipv4L3Protocol::GetRoutingProtocol ( void ) const

virtual

Get the routing protocol to be used by this Ipv4 stack.

Returns: smart pointer to Ipv4RoutingProtocol object, or null pointer if none

Implements ns3::Ipv4.

Definition at line 193 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::HandleFragmentsTimeout	(	std::pair< uint64_t, uint32_t >	key,
		Ipv4Header &	ipHeader,
		uint32_t	iif
	)

private

Process the timeout for packet fragments.

Parameters

key	representing the packet fragments
ipHeader	the IP header of the original packet
iif	Input Interface

Definition at line 1441 of file ipv4-l3-protocol.cc.

References DROP_FRAGMENT_TIMEOUT, GetIcmp(), ns3::Object::GetObject(), ns3::Packet::GetSize(), m_fragments, and NS_LOG_FUNCTION.

Referenced by ProcessFragment().

void ns3::Ipv4L3Protocol::Insert ( Ptr< IpL4Protocol > protocol )

virtual

Parameters

protocol a template for the protocol to add to this L4 Demux.

Returns: the L4Protocol effectively added.

Invoke Copy on the input template to get a copy of the input protocol which can be used on the Node on which this L4 Demux is running. The new L4Protocol is registered internally as a working L4 Protocol and returned from this method. The caller does not get ownership of the returned pointer.

Implements ns3::Ipv4.

Definition at line 105 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

bool ns3::Ipv4L3Protocol::IsDestinationAddress	(	Ipv4Address	address,
		uint32_t	iif
	)		const

virtual

Determine whether address and interface corresponding to received packet can be accepted for local delivery.

Parameters

address	The IP address being considered
iif	The incoming Ipv4 interface index

This method can be used to determine whether a received packet has an acceptable address for local delivery on the host. The address may be a unicast, multicast, or broadcast address. This method will return true if address is an exact match of a unicast address on one of the host's interfaces (see below), if address corresponds to a multicast group that the host has joined (and the incoming device is acceptable), or if address corresponds to a broadcast address.

If the Ipv4 attribute WeakEsModel is true, the unicast address may match any of the Ipv4 addresses on any interface. If the attribute is false, the address must match one assigned to the incoming device.

Implements ns3::Ipv4.

Definition at line 389 of file ipv4-l3-protocol.cc.

References GetAddress(), GetNAddresses(), GetNInterfaces(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsMulticast(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

bool ns3::Ipv4L3Protocol::IsForwarding ( uint32_t interface ) const

virtual

Parameters

interface Interface number of Ipv4 interface

Returns: true if IP forwarding enabled for input datagrams on this device

Implements ns3::Ipv4.

Definition at line 1097 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::IsForwarding(), NS_LOG_FUNCTION, and NS_LOG_LOGIC.

bool ns3::Ipv4L3Protocol::IsUp ( uint32_t interface ) const

virtual

Parameters

interface Interface number of Ipv4 interface

Returns: true if the underlying interface is in the "up" state, false otherwise.

Implements ns3::Ipv4.

Definition at line 1063 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Interface::IsUp(), and NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::NotifyNewAggregate ( void )

protectedvirtual

This function will notify other components connected to the node that a new stack member is now connected This will be used to notify Layer 3 protocol of layer 4 protocol stack to connect them together.

Reimplemented from ns3::Object.

Definition at line 167 of file ipv4-l3-protocol.cc.

References ns3::Object::NotifyNewAggregate(), and NS_LOG_FUNCTION.

bool ns3::Ipv4L3Protocol::ProcessFragment	(	Ptr< Packet > &	packet,
		Ipv4Header &	ipHeader,
		uint32_t	iif
	)

private

Process a packet fragment.

Parameters

packet	the packet
fragmentSize	the size of the fragment
iif	Input Interface

Returns: true is the fragment completed the packet

Definition at line 1254 of file ipv4-l3-protocol.cc.

References ns3::Ipv4L3Protocol::Fragments::AddFragment(), ns3::Packet::Copy(), ns3::Ipv4Address::Get(), ns3::Ipv4Header::GetDestination(), ns3::Ipv4Header::GetFragmentOffset(), ns3::Ipv4Header::GetIdentification(), ns3::Ipv4L3Protocol::Fragments::GetPacket(), ns3::Ipv4Header::GetProtocol(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), HandleFragmentsTimeout(), ns3::Ipv4L3Protocol::Fragments::IsEntire(), ns3::Ipv4Header::IsLastFragment(), m_fragments, ns3::Simulator::Now(), NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::Simulator::Schedule().

void ns3::Ipv4L3Protocol::Receive	(	Ptr< NetDevice >	device,
		Ptr< const Packet >	p,
		uint16_t	protocol,
		const Address &	from,
		const Address &	to,
		NetDevice::PacketType	packetType
	)

Lower layer calls this method after calling L3Demux::Lookup The ARP subclass needs to know from which NetDevice this packet is coming to:

implement a per-NetDevice ARP cache
send back arp replies on the right device
Parameters

device network device

p the packet

protocol protocol value

from address of the correspondant

to address of the destination

packetType type of the packet

Definition at line 452 of file ipv4-l3-protocol.cc.

References ns3::Node::ChecksumEnabled(), ns3::Packet::Copy(), DROP_BAD_CHECKSUM, DROP_INTERFACE_DOWN, DROP_NO_ROUTE, ns3::Ipv4Header::EnableChecksum(), ns3::Ipv4Interface::GetDevice(), ns3::Node::GetId(), ns3::Object::GetObject(), ns3::Ipv4Header::GetPayloadSize(), ns3::Ipv4Header::IsChecksumOk(), ns3::Ipv4Interface::IsUp(), ns3::MakeCallback(), NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, and NS_LOG_WARN.

Referenced by AddInterface().

void ns3::Ipv4L3Protocol::Remove ( Ptr< IpL4Protocol > protocol )

Parameters

protocol protocol to remove from this demux.

The input value to this method should be the value returned from the Ipv4L4Protocol::Insert method.

Definition at line 124 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

bool ns3::Ipv4L3Protocol::RemoveAddress	(	uint32_t	interface,
		uint32_t	addressIndex
	)

virtual

Remove the address at addressIndex on named interface. The addressIndex for all higher indices will decrement by one after this method is called; so, for example, to remove 5 addresses from an interface i, one could call RemoveAddress (i, 0); 5 times.

Parameters

interface	Interface number of an Ipv4 interface
addressIndex	index of Ipv4InterfaceAddress to remove

Returns: true if the operation succeeded

Implements ns3::Ipv4.

Definition at line 969 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION, and ns3::Ipv4Interface::RemoveAddress().

Ipv4Address ns3::Ipv4L3Protocol::SelectSourceAddress	(	Ptr< const NetDevice >	device,
		Ipv4Address	dst,
		Ipv4InterfaceAddress::InterfaceAddressScope_e	scope
	)

virtual

Return the first primary source address with scope less than or equal to the requested scope, to use in sending a packet to destination dst out of the specified device.

This method mirrors the behavior of Linux inet_select_addr() and is provided because interfaces may have multiple IP addresses configured on them with different scopes, and with a primary and secondary status. Secondary addresses are never returned.

See Also: Ipv4InterfaceAddress

If a non-zero device pointer is provided, the method first tries to return a primary address that is configured on that device, and whose subnet matches that of dst and whose scope is less than or equal to the requested scope. If a primary address does not match the subnet of dst but otherwise matches the scope, it is returned. If no such address on the device is found, the other devices are searched in order of their interface index, but not considering dst as a factor in the search. Because a loopback interface is typically the first one configured on a node, it will be the first alternate device to be tried. Addresses scoped at LINK scope are not returned in this phase.

If no device pointer is provided, the same logic as above applies, only that there is no preferred device that is consulted first. This means that if the device pointer is null, input parameter dst will be ignored.

If there are no possible addresses to return, a warning log message is issued and the all-zeroes address is returned.

Parameters

device	output NetDevice (optionally provided, only to constrain the search)
dst	Destination address to match, if device is provided
scope	Scope of returned address must be less than or equal to this

Returns: the first primary Ipv4Address that meets the search criteria

Implements ns3::Ipv4.

Definition at line 986 of file ipv4-l3-protocol.cc.

References ns3::Ipv4Address::CombineMask(), GetAddress(), GetInterfaceForDevice(), GetNAddresses(), GetNInterfaces(), NS_ASSERT_MSG, NS_LOG_FUNCTION, and NS_LOG_WARN.

void ns3::Ipv4L3Protocol::Send	(	Ptr< Packet >	packet,
		Ipv4Address	source,
		Ipv4Address	destination,
		uint8_t	protocol,
		Ptr< Ipv4Route >	route
	)

virtual

Parameters

packet	packet to send
source	source address of packet
destination	address of packet
protocol	number of packet
route	route entry

Higher-level layers call this method to send a packet down the stack to the MAC and PHY layers.

Implements ns3::Ipv4.

Definition at line 563 of file ipv4-l3-protocol.cc.

References ns3::Packet::AddHeader(), ns3::Ipv4Address::CombineMask(), ns3::Packet::Copy(), DROP_NO_ROUTE, GetAddress(), ns3::Ipv4Interface::GetDevice(), ns3::Ipv4Route::GetGateway(), ns3::Node::GetId(), GetInterfaceForDevice(), GetNAddresses(), ns3::Object::GetObject(), ns3::Packet::GetSize(), ns3::Ipv4Address::IsBroadcast(), ns3::Ipv4Address::IsLocalMulticast(), ns3::Ipv4Address::IsSubnetDirectedBroadcast(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_ERROR, NS_LOG_FUNCTION, NS_LOG_LOGIC, NS_LOG_WARN, ns3::Packet::PeekPacketTag(), ns3::Packet::RemovePacketTag(), and ns3::Ipv4Interface::Send().

Referenced by ns3::NscTcpL4Protocol::NotifyNewAggregate(), and ns3::dsr::DsrRouting::NotifyNewAggregate().

void ns3::Ipv4L3Protocol::SendWithHeader	(	Ptr< Packet >	packet,
		Ipv4Header	ipHeader,
		Ptr< Ipv4Route >	route
	)

virtual

Parameters

packet	packet to send
ipHeader	IP Header
route	route entry

Higher-level layers call this method to send a packet with IPv4 Header (Intend to be used with IpHeaderInclude attribute.)

Implements ns3::Ipv4.

Definition at line 550 of file ipv4-l3-protocol.cc.

References ns3::Node::ChecksumEnabled(), ns3::Ipv4Header::EnableChecksum(), and NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::SetDefaultTtl ( uint8_t ttl )

Parameters

ttl	default ttl to use

When we need to send an ipv4 packet, we use this default ttl value.

Definition at line 273 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::SetDown ( uint32_t interface )

virtual

Parameters

interface Interface number of Ipv4 interface

Set the interface into the "down" state. In this state, it is ignored during Ipv4 forwarding.

Implements ns3::Ipv4.

Definition at line 1084 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION, and ns3::Ipv4Interface::SetDown().

void ns3::Ipv4L3Protocol::SetForwarding	(	uint32_t	interface,
		bool	val
	)

virtual

Parameters

interface	Interface number of Ipv4 interface
val	Value to set the forwarding flag

If set to true, IP forwarding is enabled for input datagrams on this device

Implements ns3::Ipv4.

Definition at line 1106 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION, and ns3::Ipv4Interface::SetForwarding().

void ns3::Ipv4L3Protocol::SetMetric	(	uint32_t	interface,
		uint16_t	metric
	)

virtual

Parameters

interface	The interface number of an Ipv4 interface
metric	routing metric (cost) associated to the underlying Ipv4 interface

Implements ns3::Ipv4.

Definition at line 1039 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION, and ns3::Ipv4Interface::SetMetric().

void ns3::Ipv4L3Protocol::SetRoutingProtocol ( Ptr< Ipv4RoutingProtocol > routingProtocol )

virtual

Register a new routing protocol to be used by this Ipv4 stack.

This call will replace any routing protocol that has been previously registered. If you want to add multiple routing protocols, you must add them to a Ipv4ListRoutingProtocol directly.

Parameters

routingProtocol smart pointer to Ipv4RoutingProtocol object

Implements ns3::Ipv4.

Definition at line 184 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION.

void ns3::Ipv4L3Protocol::SetUp ( uint32_t interface )

virtual

Parameters

interface Interface number of Ipv4 interface

Set the interface into the "up" state. In this state, it is considered valid during Ipv4 forwarding.

Implements ns3::Ipv4.

Definition at line 1071 of file ipv4-l3-protocol.cc.

References NS_LOG_FUNCTION, and ns3::Ipv4Interface::SetUp().

The documentation for this class was generated from the following files:

src/internet/model/ipv4-l3-protocol.h
src/internet/model/ipv4-l3-protocol.cc

device	network device
p	the packet
protocol	protocol value
from	address of the correspondant
to	address of the destination
packetType	type of the packet

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::Ipv4

TraceSources

Member Enumeration Documentation

Member Function Documentation