Nix-vector routing protocol. More...

#include "ipv4-nix-vector-routing.h"

Inheritance diagram for ns3::Ipv4NixVectorRouting:

Public Member Functions
	Ipv4NixVectorRouting ()

	~Ipv4NixVectorRouting ()

void	FlushGlobalNixRoutingCache (void) const
	Called when run-time link topology change occurs which iterates through the node list and flushes any nix vector caches. More...

void	SetNode (Ptr< Node > node)
	Set the Node pointer of the node for which this routing protocol is to be placed. More...

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together. More...

void	Dispose (void)
	Dispose of this Object. More...

AggregateIterator	GetAggregateIterator (void) const
	Get an iterator to the Objects aggregated to this one. More...

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

template<typename T >
Ptr< T >	GetObject (void) const
	Get a pointer to the requested aggregated Object. More...

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

bool	IsInitialized (void) const
	Check if the object has been initialized. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor. More...

void	GetAttribute (std::string name, AttributeValue &value) const
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising erros. More...

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful. More...

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors. More...

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context. More...

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context. More...

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context. More...

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context. More...

Static Public Member Functions
static TypeId	GetTypeId (void)
	The Interface ID of the Global Router interface. More...

Static Public Member Functions inherited from ns3::Ipv4RoutingProtocol
static TypeId	GetTypeId (void)
	Get the type ID. More...

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)
	Get the type ID. More...

Private Member Functions
bool	BFS (uint32_t numberOfNodes, Ptr< Node > source, Ptr< Node > dest, std::vector< Ptr< Node > > &parentVector, Ptr< NetDevice > oif)
	Breadth first search algorithm. More...

bool	BuildNixVector (const std::vector< Ptr< Node > > &parentVector, uint32_t source, uint32_t dest, Ptr< NixVector > nixVector)
	Recurses the parent vector, created by BFS and actually builds the nixvector. More...

bool	BuildNixVectorLocal (Ptr< NixVector > nixVector)
	Special variation of BuildNixVector for when a node is sending to itself. More...

void	CheckCacheStateAndFlush (void) const
	Flushes routing caches if required. More...

void	DoDispose (void)
	Destructor implementation. More...

uint32_t	FindNetDeviceForNixIndex (uint32_t nodeIndex, Ipv4Address &gatewayIp)
	Nix index is with respect to the neighbors. More...

uint32_t	FindTotalNeighbors (void)
	Simple iterates through the nodes net-devices and determines how many neighbors it has. More...

void	FlushIpv4RouteCache (void) const
	Flushes the cache which stores the Ipv4 route based on the destination IP. More...

void	FlushNixCache (void) const
	Flushes the cache which stores nix-vector based on destination IP. More...

void	GetAdjacentNetDevices (Ptr< NetDevice > netDevice, Ptr< Channel > channel, NetDeviceContainer &netDeviceContainer)
	Given a net-device returns all the adjacent net-devices, essentially getting the neighbors on that channel. More...

Ptr< Ipv4Route >	GetIpv4RouteInCache (Ipv4Address address)
	Checks the cache based on dest IP for the Ipv4Route. More...

Ptr< NixVector >	GetNixVector (Ptr< Node > source, Ipv4Address dest, Ptr< NetDevice > oif)
	Takes in the source node and dest IP and calls GetNodeByIp, BFS, accounting for any output interface specified, and finally BuildNixVector to return the built nix-vector. More...

Ptr< NixVector >	GetNixVectorInCache (Ipv4Address address)
	Checks the cache based on dest IP for the nix-vector. More...

Ptr< Node >	GetNodeByIp (Ipv4Address dest)
	Iterates through the node list and finds the one corresponding to the given Ipv4Address. More...

Ptr< BridgeNetDevice >	NetDeviceIsBridged (Ptr< NetDevice > nd) const
	Determine if the NetDevice is bridged. More...

virtual void	NotifyAddAddress (uint32_t interface, Ipv4InterfaceAddress address)

virtual void	NotifyInterfaceDown (uint32_t interface)

virtual void	NotifyInterfaceUp (uint32_t interface)

virtual void	NotifyRemoveAddress (uint32_t interface, Ipv4InterfaceAddress address)

virtual void	PrintRoutingTable (Ptr< OutputStreamWrapper > stream, Time::Unit unit=Time::S) const
	Print the Routing Table entries. More...

void	ResetTotalNeighbors (void)
	Upon a run-time topology change caches are flushed and the total number of neighbors is reset to zero. More...

virtual bool	RouteInput (Ptr< const Packet > p, const Ipv4Header &header, Ptr< const NetDevice > idev, UnicastForwardCallback ucb, MulticastForwardCallback mcb, LocalDeliverCallback lcb, ErrorCallback ecb)
	Route an input packet (to be forwarded or locally delivered) More...

virtual Ptr< Ipv4Route >	RouteOutput (Ptr< Packet > p, const Ipv4Header &header, Ptr< NetDevice > oif, Socket::SocketErrno &sockerr)
	Query routing cache for an existing route, for an outbound packet. More...

virtual void	SetIpv4 (Ptr< Ipv4 > ipv4)

Private Attributes
Ptr< Ipv4 >	m_ipv4
	IPv4 object. More...

Ipv4RouteMap_t	m_ipv4RouteCache
	Cache stores Ipv4Routes based on destination ip. More...

NixMap_t	m_nixCache
	Cache stores nix-vectors based on destination ip. More...

Ptr< Node >	m_node
	Node object. More...

uint32_t	m_totalNeighbors
	Total neighbors used for nix-vector to determine number of bits. More...

Static Private Attributes
static bool	g_isCacheDirty
	Flag to mark when caches are dirty and need to be flushed. More...

Additional Inherited Members
Public Types inherited from ns3::Ipv4RoutingProtocol
typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, Socket::SocketErrno >	ErrorCallback
	Callback for routing errors (e.g., no route found) More...

typedef Callback< void, Ptr< const Packet >, const Ipv4Header &, uint32_t >	LocalDeliverCallback
	Callback for packets to be locally delivered. More...

typedef Callback< void, Ptr< Ipv4MulticastRoute >, Ptr< const Packet >, const Ipv4Header & >	MulticastForwardCallback
	Callback for multicast packets to be forwarded. More...

typedef Callback< void, Ptr< Ipv4Route >, Ptr< const Packet >, const Ipv4Header & >	UnicastForwardCallback
	Callback for unicast packets to be forwarded. More...

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

virtual void	NotifyNewAggregate (void)
	Notify all Objects aggregated to this one of a new Object being aggregated. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes. More...

virtual void	NotifyConstructionCompleted (void)
	Notifier called once the ObjectBase is fully constructed. More...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

Nix-vector routing protocol.

Config Paths

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

"/NodeList/[i]/$ns3::Ipv4NixVectorRouting"

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 104 bytes (on a 64-bit architecture).

Definition at line 60 of file ipv4-nix-vector-routing.h.

Constructor & Destructor Documentation

◆ Ipv4NixVectorRouting()

ns3::Ipv4NixVectorRouting::Ipv4NixVectorRouting ( )

◆ ~Ipv4NixVectorRouting()

ns3::Ipv4NixVectorRouting::~Ipv4NixVectorRouting ( )

Member Function Documentation

◆ BFS()

bool ns3::Ipv4NixVectorRouting::BFS	(	uint32_t	numberOfNodes,
		Ptr< Node >	source,
		Ptr< Node >	dest,
		std::vector< Ptr< Node > > &	parentVector,
		Ptr< NetDevice >	oif
	)

private

Breadth first search algorithm.

Parameters

[in]	numberOfNodes	total number of nodes
[in]	source	Source Node
[in]	dest	Destination Node
[out]	parentVector	Parent vector for retracing routes
[in]	oif	specific output interface to use from source node, if not null

Returns: false if dest not found, true o.w.

◆ BuildNixVector()

bool ns3::Ipv4NixVectorRouting::BuildNixVector	(	const std::vector< Ptr< Node > > &	parentVector,
		uint32_t	source,
		uint32_t	dest,
		Ptr< NixVector >	nixVector
	)

private

Recurses the parent vector, created by BFS and actually builds the nixvector.

Parameters

[in]	parentVector	Parent vector for retracing routes
[in]	source	Source Node index
[in]	dest	Destination Node index
[out]	nixVector	the NixVector to be used for routing

Returns: true on success, false otherwise.

◆ BuildNixVectorLocal()

bool ns3::Ipv4NixVectorRouting::BuildNixVectorLocal ( Ptr< NixVector > nixVector )

private

Special variation of BuildNixVector for when a node is sending to itself.

Parameters

[out] nixVector the NixVector to be used for routing

Returns: true on success, false otherwise.

◆ CheckCacheStateAndFlush()

void ns3::Ipv4NixVectorRouting::CheckCacheStateAndFlush ( void ) const

private

Flushes routing caches if required.

◆ DoDispose()

void ns3::Ipv4NixVectorRouting::DoDispose ( void )

privatevirtual

Destructor implementation.

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

Subclasses are expected to implement their real destruction code in an overridden 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.

◆ FindNetDeviceForNixIndex()

uint32_t ns3::Ipv4NixVectorRouting::FindNetDeviceForNixIndex	(	uint32_t	nodeIndex,
		Ipv4Address &	gatewayIp
	)

private

Nix index is with respect to the neighbors.

The net-device index must be derived from this

Parameters

[in]	nodeIndex	Nix Node index
[out]	gatewayIp	IP address of the gateway

Returns: the index of the NetDevice in the node.

◆ FindTotalNeighbors()

uint32_t ns3::Ipv4NixVectorRouting::FindTotalNeighbors ( void )

private

Simple iterates through the nodes net-devices and determines how many neighbors it has.

Returns: the number of neighbors.

◆ FlushGlobalNixRoutingCache()

void ns3::Ipv4NixVectorRouting::FlushGlobalNixRoutingCache ( void ) const

Called when run-time link topology change occurs which iterates through the node list and flushes any nix vector caches.

Internal:: const is used here due to need to potentially flush the cache in const methods such as PrintRoutingTable. Caches are stored in mutable variables and flushed in const methods.

◆ FlushIpv4RouteCache()

void ns3::Ipv4NixVectorRouting::FlushIpv4RouteCache ( void ) const

private

Flushes the cache which stores the Ipv4 route based on the destination IP.

◆ FlushNixCache()

void ns3::Ipv4NixVectorRouting::FlushNixCache ( void ) const

private

Flushes the cache which stores nix-vector based on destination IP.

◆ GetAdjacentNetDevices()

void ns3::Ipv4NixVectorRouting::GetAdjacentNetDevices	(	Ptr< NetDevice >	netDevice,
		Ptr< Channel >	channel,
		NetDeviceContainer &	netDeviceContainer
	)

private

Given a net-device returns all the adjacent net-devices, essentially getting the neighbors on that channel.

Parameters

[in]	netDevice	the NetDevice attached to the channel.
[in]	channel	the channel to check
[out]	netDeviceContainer	the NetDeviceContainer of the NetDevices in the channel.

◆ GetIpv4RouteInCache()

Ptr<Ipv4Route> ns3::Ipv4NixVectorRouting::GetIpv4RouteInCache ( Ipv4Address address )

private

Checks the cache based on dest IP for the Ipv4Route.

Parameters

address Address to check

Returns: The cached route.

◆ GetNixVector()

Ptr<NixVector> ns3::Ipv4NixVectorRouting::GetNixVector	(	Ptr< Node >	source,
		Ipv4Address	dest,
		Ptr< NetDevice >	oif
	)

private

Takes in the source node and dest IP and calls GetNodeByIp, BFS, accounting for any output interface specified, and finally BuildNixVector to return the built nix-vector.

Parameters

source	Source node
dest	Destination node address
oif	Preferred output interface

Returns: The NixVector to be used in routing.

◆ GetNixVectorInCache()

Ptr<NixVector> ns3::Ipv4NixVectorRouting::GetNixVectorInCache ( Ipv4Address address )

private

Checks the cache based on dest IP for the nix-vector.

Parameters

address Address to check

Returns: The NixVector to be used in routing.

◆ GetNodeByIp()

Ptr<Node> ns3::Ipv4NixVectorRouting::GetNodeByIp ( Ipv4Address dest )

private

Iterates through the node list and finds the one corresponding to the given Ipv4Address.

Parameters

dest	destination node IP

Returns: The node with the specified IP.

◆ GetTypeId()

static TypeId ns3::Ipv4NixVectorRouting::GetTypeId ( void )

static

The Interface ID of the Global Router interface.

Returns: The Interface ID

See also: Object::GetObject ()

◆ NetDeviceIsBridged()

Ptr<BridgeNetDevice> ns3::Ipv4NixVectorRouting::NetDeviceIsBridged ( Ptr< NetDevice > nd ) const

private

Determine if the NetDevice is bridged.

Parameters

nd	the NetDevice to check

Returns: the bridging NetDevice (or null if the NetDevice is not bridged)

◆ NotifyAddAddress()

virtual void ns3::Ipv4NixVectorRouting::NotifyAddAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

privatevirtual

Parameters

interface	the index of the interface we are being notified about
address	a new address being added to an interface

Protocols are expected to implement this method to be notified whenever a new address is added to an interface. Typically used to add a 'network route' on an interface. Can be invoked on an up or down interface.

Implements ns3::Ipv4RoutingProtocol.

◆ NotifyInterfaceDown()

virtual void ns3::Ipv4NixVectorRouting::NotifyInterfaceDown ( uint32_t interface )

privatevirtual

Parameters

interface the index of the interface we are being notified about

Protocols are expected to implement this method to be notified of the state change of an interface in a node.

Implements ns3::Ipv4RoutingProtocol.

◆ NotifyInterfaceUp()

virtual void ns3::Ipv4NixVectorRouting::NotifyInterfaceUp ( uint32_t interface )

privatevirtual

Parameters

interface the index of the interface we are being notified about

Protocols are expected to implement this method to be notified of the state change of an interface in a node.

Implements ns3::Ipv4RoutingProtocol.

◆ NotifyRemoveAddress()

virtual void ns3::Ipv4NixVectorRouting::NotifyRemoveAddress	(	uint32_t	interface,
		Ipv4InterfaceAddress	address
	)

privatevirtual

Parameters

interface	the index of the interface we are being notified about
address	a new address being added to an interface

Protocols are expected to implement this method to be notified whenever a new address is removed from an interface. Typically used to remove the 'network route' of an interface. Can be invoked on an up or down interface.

Implements ns3::Ipv4RoutingProtocol.

◆ PrintRoutingTable()

virtual void ns3::Ipv4NixVectorRouting::PrintRoutingTable	(	Ptr< OutputStreamWrapper >	stream,
		Time::Unit	unit = `Time::S`
	)		const

privatevirtual

Print the Routing Table entries.

Parameters

stream	The ostream the Routing table is printed to
unit	The time unit to be used in the report

Implements ns3::Ipv4RoutingProtocol.

◆ ResetTotalNeighbors()

void ns3::Ipv4NixVectorRouting::ResetTotalNeighbors ( void )

private

Upon a run-time topology change caches are flushed and the total number of neighbors is reset to zero.

◆ RouteInput()

virtual bool ns3::Ipv4NixVectorRouting::RouteInput	(	Ptr< const Packet >	p,
		const Ipv4Header &	header,
		Ptr< const NetDevice >	idev,
		UnicastForwardCallback	ucb,
		MulticastForwardCallback	mcb,
		LocalDeliverCallback	lcb,
		ErrorCallback	ecb
	)

privatevirtual

Route an input packet (to be forwarded or locally delivered)

This lookup is used in the forwarding process. The packet is handed over to the Ipv4RoutingProtocol, and will get forwarded onward by one of the callbacks. The Linux equivalent is ip_route_input(). There are four valid outcomes, and a matching callbacks to handle each.

Parameters

p	received packet
header	input parameter used to form a search key for a route
idev	Pointer to ingress network device
ucb	Callback for the case in which the packet is to be forwarded as unicast
mcb	Callback for the case in which the packet is to be forwarded as multicast
lcb	Callback for the case in which the packet is to be locally delivered
ecb	Callback to call if there is an error in forwarding

Returns: true if the Ipv4RoutingProtocol takes responsibility for forwarding or delivering the packet, false otherwise

Implements ns3::Ipv4RoutingProtocol.

◆ RouteOutput()

virtual Ptr<Ipv4Route> ns3::Ipv4NixVectorRouting::RouteOutput	(	Ptr< Packet >	p,
		const Ipv4Header &	header,
		Ptr< NetDevice >	oif,
		Socket::SocketErrno &	sockerr
	)

privatevirtual

Query routing cache for an existing route, for an outbound packet.

This lookup is used by transport protocols. It does not cause any packet to be forwarded, and is synchronous. Can be used for multicast or unicast. The Linux equivalent is ip_route_output()

The header input parameter may have an uninitialized value for the source address, but the destination address should always be properly set by the caller.

Parameters

p	packet to be routed. Note that this method may modify the packet. Callers may also pass in a null pointer.
header	input parameter (used to form key to search for the route)
oif	Output interface Netdevice. May be zero, or may be bound via socket options to a particular output interface.
sockerr	Output parameter; socket errno

Returns: a code that indicates what happened in the lookup

Implements ns3::Ipv4RoutingProtocol.

◆ SetIpv4()

virtual void ns3::Ipv4NixVectorRouting::SetIpv4 ( Ptr< Ipv4 > ipv4 )

privatevirtual

Parameters

ipv4	the ipv4 object this routing protocol is being associated with

Typically, invoked directly or indirectly from ns3::Ipv4::SetRoutingProtocol

Implements ns3::Ipv4RoutingProtocol.

◆ SetNode()

void ns3::Ipv4NixVectorRouting::SetNode ( Ptr< Node > node )

Set the Node pointer of the node for which this routing protocol is to be placed.

Parameters

node	Node pointer

Member Data Documentation

◆ g_isCacheDirty

bool ns3::Ipv4NixVectorRouting::g_isCacheDirty

staticprivate

Flag to mark when caches are dirty and need to be flushed.

Used for lazy cleanup of caches when there are many topology changes.

Definition at line 234 of file ipv4-nix-vector-routing.h.

◆ m_ipv4

Ptr<Ipv4> ns3::Ipv4NixVectorRouting::m_ipv4

private

IPv4 object.

Definition at line 242 of file ipv4-nix-vector-routing.h.

◆ m_ipv4RouteCache

Ipv4RouteMap_t ns3::Ipv4NixVectorRouting::m_ipv4RouteCache

mutableprivate

Cache stores Ipv4Routes based on destination ip.

Definition at line 240 of file ipv4-nix-vector-routing.h.

◆ m_nixCache

NixMap_t ns3::Ipv4NixVectorRouting::m_nixCache

mutableprivate

Cache stores nix-vectors based on destination ip.

Definition at line 237 of file ipv4-nix-vector-routing.h.

◆ m_node

Ptr<Node> ns3::Ipv4NixVectorRouting::m_node

private

Node object.

Definition at line 243 of file ipv4-nix-vector-routing.h.

◆ m_totalNeighbors

uint32_t ns3::Ipv4NixVectorRouting::m_totalNeighbors

private

Total neighbors used for nix-vector to determine number of bits.

Definition at line 246 of file ipv4-nix-vector-routing.h.

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

src/nix-vector-routing/model/ipv4-nix-vector-routing.h

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Constructor & Destructor Documentation

◆ Ipv4NixVectorRouting()

◆ ~Ipv4NixVectorRouting()

Member Function Documentation

◆ BFS()

◆ BuildNixVector()

◆ BuildNixVectorLocal()

◆ CheckCacheStateAndFlush()

◆ DoDispose()

◆ FindNetDeviceForNixIndex()

◆ FindTotalNeighbors()

◆ FlushGlobalNixRoutingCache()

◆ FlushIpv4RouteCache()

◆ FlushNixCache()

◆ GetAdjacentNetDevices()

◆ GetIpv4RouteInCache()

◆ GetNixVector()

◆ GetNixVectorInCache()

◆ GetNodeByIp()

◆ GetTypeId()

◆ NetDeviceIsBridged()

◆ NotifyAddAddress()

◆ NotifyInterfaceDown()

◆ NotifyInterfaceUp()

◆ NotifyRemoveAddress()

◆ PrintRoutingTable()

◆ ResetTotalNeighbors()

◆ RouteInput()

◆ RouteOutput()

◆ SetIpv4()

◆ SetNode()

Member Data Documentation

◆ g_isCacheDirty

◆ m_ipv4

◆ m_ipv4RouteCache

◆ m_nixCache

◆ m_node

◆ m_totalNeighbors