This generator assigns addresses sequentially from a provided network address; used in topology code. More...
#include "ipv6-address-generator.h"
Static Public Member Functions | |
static bool | AddAllocated (const Ipv6Address addr) |
Add the Ipv6Address to the list of IPv6 entries. | |
static Ipv6Address | GetAddress (const Ipv6Prefix prefix) |
Get the Ipv6Address that will be allocated upon NextAddress () | |
static Ipv6Address | GetNetwork (const Ipv6Prefix prefix) |
Get the current network of the given Ipv6Prefix. | |
static void | Init (const Ipv6Address net, const Ipv6Prefix prefix, const Ipv6Address interfaceId="::1") |
Initialise the base network and interfaceId for the generator. | |
static void | InitAddress (const Ipv6Address interfaceId, const Ipv6Prefix prefix) |
Set the interfaceId for the given Ipv6Prefix. | |
static bool | IsAddressAllocated (const Ipv6Address addr) |
Check the Ipv6Address allocation in the list of IPv6 entries. | |
static bool | IsNetworkAllocated (const Ipv6Address addr, const Ipv6Prefix prefix) |
Check if a network has already allocated addresses. | |
static Ipv6Address | NextAddress (const Ipv6Prefix prefix) |
Allocate the next Ipv6Address for the configured network and prefix. | |
static Ipv6Address | NextNetwork (const Ipv6Prefix prefix) |
Get the next network according to the given Ipv6Prefix. | |
static void | Reset () |
Reset the networks and Ipv6Address to zero. | |
static void | TestMode () |
Used to turn off fatal errors and assertions, for testing. | |
This generator assigns addresses sequentially from a provided network address; used in topology code.
It also keeps track of all addresses assigned to perform duplicate detection.
Global unicast IPv6 addresses based on RFC 4291 definition:
| n bits | m bits | 128-n-m bits | +-------------------------+-----------+----------------------------+ | global routing prefix | subnet ID | interface ID | +-------------------------+-----------+----------------------------+
In this class, the first two quantities (n + m) are what is called the 'net', and the 'prefix' defines the length in bits of (n + m).
The way this is expected to be used is that, after initializing the network and interfaceId to a number, a user can call NextAddress () repeatedly to obtain new interface IDs with the current network (for multiple addresses on the link) and can call NextNetwork () to increment the subnet ID.
The interface ID is often an EUI-64 address derived from the MAC address, but can also be a pseudo-random value (RFC 3041). This implementation does not generate EUI-64-based interface IDs.
Definition at line 61 of file ipv6-address-generator.h.
|
static |
Add the Ipv6Address to the list of IPv6 entries.
Typically, this is used by external address allocators that want to make use of this class's ability to track duplicates. AddAllocated is always called internally for any address generated by NextAddress ()
addr | The Ipv6Address to be added to the list of Ipv6 entries |
Definition at line 734 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by AddressCollision6TestCase::DoRun(), and ns3::Ipv6AddressHelper::NewAddress().
|
static |
Get the Ipv6Address that will be allocated upon NextAddress ()
Does not change the internal state; just is used to peek the next address that will be allocated upon NextAddress ()
prefix | The Ipv6Prefix for the current network |
Definition at line 710 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by AddressAllocator6TestCase::DoRun().
|
static |
Get the current network of the given Ipv6Prefix.
Does not change the internal state; this just peeks at the current network
prefix | The Ipv6Prefix for the current network |
Definition at line 694 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by ns3::CsmaStarHelper::AssignIpv6Addresses(), ns3::PointToPointDumbbellHelper::AssignIpv6Addresses(), ns3::PointToPointGridHelper::AssignIpv6Addresses(), ns3::PointToPointStarHelper::AssignIpv6Addresses(), NetworkNumber6AllocatorTestCase::DoRun(), and AddressAllocator6TestCase::DoRun().
|
static |
Initialise the base network and interfaceId for the generator.
The first call to NextAddress() or GetAddress() will return the value passed in.
net | The network for the base Ipv6Address |
prefix | The prefix of the base Ipv6Address |
interfaceId | The base interface ID used for initialization |
Definition at line 676 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by ns3::CsmaStarHelper::AssignIpv6Addresses(), ns3::PointToPointDumbbellHelper::AssignIpv6Addresses(), ns3::PointToPointGridHelper::AssignIpv6Addresses(), ns3::PointToPointStarHelper::AssignIpv6Addresses(), NetworkNumber6AllocatorTestCase::DoRun(), AddressAllocator6TestCase::DoRun(), NetworkAndAddress6TestCase::DoRun(), and ExampleAddress6GeneratorTestCase::DoRun().
|
static |
Set the interfaceId for the given Ipv6Prefix.
interfaceId | The interfaceId to set for the current Ipv6Prefix |
prefix | The Ipv6Prefix whose address is to be set |
Definition at line 702 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by ExampleAddress6GeneratorTestCase::DoRun().
|
static |
Check the Ipv6Address allocation in the list of IPv6 entries.
addr | The Ipv6Address to be checked in the list of Ipv4 entries |
Definition at line 742 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
|
static |
Check if a network has already allocated addresses.
Definition at line 750 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
|
static |
Allocate the next Ipv6Address for the configured network and prefix.
This operation is a post-increment, meaning that the first address allocated will be the one that was initially configured.
prefix | The Ipv6Prefix for the current network |
Definition at line 718 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by AddressAllocator6TestCase::DoRun(), NetworkAndAddress6TestCase::DoRun(), and ExampleAddress6GeneratorTestCase::DoRun().
|
static |
Get the next network according to the given Ipv6Prefix.
This operation is a pre-increment, meaning that the internal state is changed before returning the new network address.
This also resets the interface ID to the base interface ID that was used for initialization.
prefix | The Ipv6Prefix used to set the next network |
Definition at line 686 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION.
Referenced by ns3::CsmaStarHelper::AssignIpv6Addresses(), ns3::PointToPointDumbbellHelper::AssignIpv6Addresses(), ns3::PointToPointGridHelper::AssignIpv6Addresses(), ns3::PointToPointStarHelper::AssignIpv6Addresses(), NetworkNumber6AllocatorTestCase::DoRun(), AddressAllocator6TestCase::DoRun(), NetworkAndAddress6TestCase::DoRun(), and ExampleAddress6GeneratorTestCase::DoRun().
|
static |
Reset the networks and Ipv6Address to zero.
Definition at line 726 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION_NOARGS.
Referenced by NetworkNumber6AllocatorTestCase::DoTeardown(), AddressAllocator6TestCase::DoTeardown(), NetworkAndAddress6TestCase::DoTeardown(), ExampleAddress6GeneratorTestCase::DoTeardown(), AddressCollision6TestCase::DoTeardown(), and IpAddressHelperTestCasev6::DoTeardown().
|
static |
Used to turn off fatal errors and assertions, for testing.
Definition at line 758 of file ipv6-address-generator.cc.
References ns3::SimulationSingleton< T >::Get(), and NS_LOG_FUNCTION_NOARGS.
Referenced by AddressCollision6TestCase::DoRun().