Neighbor-index data structure for nix-vector routing. More...

#include <nix-vector.h>

Inheritance diagram for ns3::NixVector:

Collaboration diagram for ns3::NixVector:

Public Member Functions
	NixVector ()
	NixVector (const NixVector &o)
	~NixVector ()
void	AddNeighborIndex (uint32_t newBits, uint32_t numberOfBits)
uint32_t	BitCount (uint32_t numberOfNeighbors) const
Ptr< NixVector >	Copy (void) const
uint32_t	Deserialize (const uint32_t *buffer, uint32_t size)
uint32_t	ExtractNeighborIndex (uint32_t numberOfBits)
uint32_t	GetRemainingBits (void)
uint32_t	GetSerializedSize (void) const
NixVector &	operator= (const NixVector &o)
uint32_t	Serialize (uint32_t *buffer, uint32_t maxSize) const
Public Member Functions inherited from ns3::SimpleRefCount< NixVector >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const

Private Types
typedef std::vector< uint32_t >	NixBits_t

Private Member Functions
void	DumpNixVector (std::ostream &os) const
void	PrintDec2BinNix (uint32_t, uint32_t, std::ostream &os) const
void	PrintDec2BinNixFill (uint32_t, uint32_t, std::ostream &os) const

Private Attributes
uint32_t	m_currentVectorBitSize
NixBits_t	m_nixVector
uint32_t	m_totalBitSize
uint32_t	m_used

Friends
std::ostream &	operator<< (std::ostream &outs, const NixVector &nix)

Additional Inherited Members
Static Public Member Functions inherited from ns3::SimpleRefCount< NixVector >
static void	Cleanup (void)

Detailed Description

Neighbor-index data structure for nix-vector routing.

This data structure holds a vector of "neighbor-indexes" for a simulation specific routing protocol, nix-vector routing. Theses neighbor-indexes correspond to the net-device which a node should use to route a packet. A nix-vector is built (or fetched from a cache) on-demand. The nix-vector is transmitted with the packet, and along each hop of the route, the current node extracts the appropriate neighbor-index and routes the packet.

The implementation of NixVector uses a vector to store the neighbor-indexes. Each entry in the vector is 32 bits long and can store multiple neighbor-indexes. A fair amount of bit manipulation is used to store these neighbor-indexes efficiently. A vector is used so that the nix-vector can grow arbitrarily if the topology and route requires a large number of neighbor-indexes.

As the nix-vector travels along the route, an internal private member variable keeps track of how many bits have been used. At a particular node, the nix-vector is used to return the next neighbor-index. This neighbor-index is used to determine which net-device to use. The number of bits used would then be incremented accordingly, and the packet would be routed.

Definition at line 63 of file nix-vector.h.

Member Typedef Documentation

typedef std::vector<uint32_t> ns3::NixVector::NixBits_t

private

Definition at line 153 of file nix-vector.h.

Constructor & Destructor Documentation

ns3::NixVector::NixVector ( )

Definition at line 32 of file nix-vector.cc.

References m_nixVector, and NS_LOG_FUNCTION_NOARGS.

Referenced by Copy().

Here is the caller graph for this function:

ns3::NixVector::~NixVector ( )

Definition at line 43 of file nix-vector.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::NixVector::NixVector ( const NixVector & o )

Parameters

o	the NixVector to copy to a new NixVector using a constructor

Definition at line 48 of file nix-vector.cc.

Member Function Documentation

void ns3::NixVector::AddNeighborIndex	(	uint32_t	newBits,
		uint32_t	numberOfBits
	)

Parameters

newBits	the neighbor-index to be added to the vector
numberOfBits	the number of bits that newBits contains

Adds the neighbor index to the vector using a fair amount of bit manipulation to pack everything in efficiently.

Note: This function assumes that the number of bits to be added is always less than or equal to 32, ie., you can only span one entry of a nix-vector at a time. This is reasonable, since 32 bits gives you 2^32 possible neighbors.

Definition at line 86 of file nix-vector.cc.

References m_currentVectorBitSize, m_nixVector, m_totalBitSize, NS_FATAL_ERROR, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv4NixVectorRouting::BuildNixVector(), and ns3::Ipv4NixVectorRouting::BuildNixVectorLocal().

Here is the caller graph for this function:

uint32_t ns3::NixVector::BitCount ( uint32_t numberOfNeighbors ) const

Returns: number of bits of numberOfNeighbors

Parameters

numberOfNeighbors the total number of neighbors

This function is used to determine the number of bits of numberOfNeighbors so that this value can be passed in to AddNeighborIndex or ExtractNeighborIndex.

Definition at line 362 of file nix-vector.cc.

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv4NixVectorRouting::BuildNixVector(), ns3::Ipv4NixVectorRouting::BuildNixVectorLocal(), DumpNixVector(), and ns3::Ipv4NixVectorRouting::RouteInput().

Here is the caller graph for this function:

Ptr< NixVector > ns3::NixVector::Copy ( void ) const

Returns: a copy of this nix-vector

Definition at line 71 of file nix-vector.cc.

References NixVector().

Referenced by ns3::Packet::operator=(), ns3::Packet::Packet(), and ns3::Ipv4NixVectorRouting::RouteOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::NixVector::Deserialize	(	const uint32_t *	buffer,
		uint32_t	size
	)

Returns: zero if a complete nix-vector is not deserialized

Parameters

buffer	points to buffer for deserialization
size	number of bytes to deserialize

The raw character buffer containing all the nix-vector information is deserialized into this nix-vector.

Definition at line 279 of file nix-vector.cc.

References m_currentVectorBitSize, m_nixVector, m_totalBitSize, m_used, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::Packet::Deserialize().

Here is the caller graph for this function:

void ns3::NixVector::DumpNixVector ( std::ostream & os ) const

private

Definition at line 316 of file nix-vector.cc.

References BitCount(), m_nixVector, m_totalBitSize, NS_LOG_FUNCTION_NOARGS, PrintDec2BinNix(), and PrintDec2BinNixFill().

Referenced by ns3::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

uint32_t ns3::NixVector::ExtractNeighborIndex ( uint32_t numberOfBits )

Returns: the neighbor index

Parameters

numberOfBits the number of bits to extract from the vector

Extracts the number of bits specified from the vector and returns the value extracted

Note: This function assumes that the number of bits to be extracted is always less than or equal to 32, ie., you can only span one entry of a nix-vector at a time. This is reasonable, since 32 bits gives you 2^32 possible neighbors.

Definition at line 158 of file nix-vector.cc.

References GetRemainingBits(), m_nixVector, m_used, NS_FATAL_ERROR, and NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::Ipv4NixVectorRouting::RouteInput().

Here is the call graph for this function: