Nsc wrapper glue, to interface with the Ipv4 protocol underneath. More...
#include "nsc-tcp-l4-protocol.h"
Public Member Functions | |
NscTcpL4Protocol () | |
virtual | ~NscTcpL4Protocol () |
Ipv4EndPoint * | Allocate (void) |
Allocate an IPv4 Endpoint. More... | |
Ipv4EndPoint * | Allocate (Ipv4Address address) |
Allocate an IPv4 Endpoint. More... | |
Ipv4EndPoint * | Allocate (Ptr< NetDevice > boundNetDevice, uint16_t port) |
Allocate an IPv4 Endpoint. More... | |
Ipv4EndPoint * | Allocate (Ptr< NetDevice > boundNetDevice, Ipv4Address address, uint16_t port) |
Allocate an IPv4 Endpoint. More... | |
Ipv4EndPoint * | Allocate (Ptr< NetDevice > boundNetDevice, Ipv4Address localAddress, uint16_t localPort, Ipv4Address peerAddress, uint16_t peerPort) |
Allocate an IPv4 Endpoint. More... | |
Ptr< Socket > | CreateSocket (void) |
void | DeAllocate (Ipv4EndPoint *endPoint) |
Remove an IPv4 Endpoint. More... | |
virtual IpL4Protocol::DownTargetCallback | GetDownTarget (void) const |
This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 case) More... | |
virtual IpL4Protocol::DownTargetCallback6 | GetDownTarget6 (void) const |
This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 case) More... | |
std::string | GetNscLibrary (void) const |
Get the NSC library being used. More... | |
virtual int | GetProtocolNumber (void) const |
Returns the protocol number of this protocol. More... | |
virtual int | GetVersion (void) const |
Get the NSC version. More... | |
virtual IpL4Protocol::RxStatus | Receive (Ptr< Packet > p, Ipv4Header const &header, Ptr< Ipv4Interface > incomingInterface) |
Called from lower-level layers to send the packet up in the stack. More... | |
virtual IpL4Protocol::RxStatus | Receive (Ptr< Packet > p, Ipv6Header const &header, Ptr< Ipv6Interface > interface) |
Called from lower-level layers to send the packet up in the stack. More... | |
virtual void | SetDownTarget (IpL4Protocol::DownTargetCallback cb) |
This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 case) More... | |
virtual void | SetDownTarget6 (IpL4Protocol::DownTargetCallback6 cb) |
This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 case) More... | |
void | SetNode (Ptr< Node > node) |
Set node associated with this stack. More... | |
void | SetNscLibrary (const std::string &lib) |
Set the NSC library to be used. More... | |
![]() | |
virtual | ~IpL4Protocol () |
virtual void | ReceiveIcmp (Ipv4Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv4Address payloadSource, Ipv4Address payloadDestination, const uint8_t payload[8]) |
Called from lower-level layers to send the ICMP packet up in the stack. More... | |
virtual void | ReceiveIcmp (Ipv6Address icmpSource, uint8_t icmpTtl, uint8_t icmpType, uint8_t icmpCode, uint32_t icmpInfo, Ipv6Address payloadSource, Ipv6Address payloadDestination, const uint8_t payload[8]) |
Called from lower-level layers to send the ICMPv6 packet up in the stack. More... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Static Public Attributes | |
static const uint8_t | PROT_NUMBER = 6 |
protocol number (0x6) More... | |
Protected Member Functions | |
virtual void | DoDispose (void) |
Destructor implementation. More... | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
![]() | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
![]() | |
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... | |
Private Member Functions | |
NscTcpL4Protocol (NscTcpL4Protocol const &) | |
Copy constructor. More... | |
void | AddInterface (void) |
Add an interface. More... | |
void | gettime (unsigned int *sec, unsigned int *usec) |
Called by the Linux stack RNG initialization. More... | |
NscTcpL4Protocol & | operator= (NscTcpL4Protocol const &) |
Copy constructor. More... | |
void | send_callback (const void *data, int datalen) |
Invoked by NSCs 'ethernet driver' to re-inject a packet into ns-3. More... | |
void | SoftInterrupt (void) |
Provide a "soft" interrupt to NSC. More... | |
void | wakeup () |
Called by the NSC stack whenever something of interest has happened. More... | |
Private Attributes | |
void * | m_dlopenHandle |
dynamic library handle. More... | |
IpL4Protocol::DownTargetCallback | m_downTarget |
Callback to send packets over IPv4. More... | |
Ipv4EndPointDemux * | m_endPoints |
A list of IPv4 end points. More... | |
Ptr< Node > | m_node |
the node this stack is associated with More... | |
NscInterfaceImpl * | m_nscInterface |
the NSC Interface. More... | |
std::string | m_nscLibrary |
path to the NSC library. More... | |
INetStack * | m_nscStack |
the NSC stack. More... | |
std::vector< Ptr< NscTcpSocketImpl > > | m_sockets |
list of sockets More... | |
Timer | m_softTimer |
Soft interrupt timer. More... | |
Related Functions | |
(Note that these are not member functions.) | |
class | NscInterfaceImpl |
NscInterfaceImpl friend class. More... | |
class | NscTcpSocketImpl |
NscTcpSocketImpl friend class. More... | |
Additional Inherited Members | |
![]() | |
typedef Callback< void, Ptr< Packet >, Ipv4Address, Ipv4Address, uint8_t, Ptr< Ipv4Route > > | DownTargetCallback |
callback to send packets over IPv4 More... | |
typedef Callback< void, Ptr< Packet >, Ipv6Address, Ipv6Address, uint8_t, Ptr< Ipv6Route > > | DownTargetCallback6 |
callback to send packets over IPv6 More... | |
enum | RxStatus { RX_OK, RX_CSUM_FAILED, RX_ENDPOINT_CLOSED, RX_ENDPOINT_UNREACH } |
Rx status codes. More... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Nsc wrapper glue, to interface with the Ipv4 protocol underneath.
Definition at line 47 of file nsc-tcp-l4-protocol.h.
ns3::NscTcpL4Protocol::NscTcpL4Protocol | ( | ) |
Definition at line 157 of file nsc-tcp-l4-protocol.cc.
References m_dlopenHandle, and NS_LOG_LOGIC().
|
virtual |
Definition at line 167 of file nsc-tcp-l4-protocol.cc.
References m_dlopenHandle, and NS_LOG_FUNCTION.
|
private |
Copy constructor.
Defined and not implemented to avoid misuse
|
private |
Add an interface.
Actually NSC only supports one interface per node (Bug 1398)
Definition at line 450 of file nsc-tcp-l4-protocol.cc.
References INetStack::add_default_gateway(), ns3::Ipv4InterfaceAddress::GetLocal(), ns3::Ipv4InterfaceAddress::GetMask(), ns3::Object::GetObject(), INetStack::if_attach(), m_node, m_nscStack, NS_ASSERT_MSG(), NS_LOG_LOGIC(), ns3::Ipv4Address::Print(), and ns3::Ipv4Mask::Print().
Referenced by SetNode().
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | void | ) |
Allocate an IPv4 Endpoint.
Definition at line 298 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | Ipv4Address | address | ) |
Allocate an IPv4 Endpoint.
address | address to use |
Definition at line 305 of file nsc-tcp-l4-protocol.cc.
References first::address, ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | Ptr< NetDevice > | boundNetDevice, |
uint16_t | port | ||
) |
Allocate an IPv4 Endpoint.
boundNetDevice | Bound NetDevice (if any) |
port | port to use |
Definition at line 312 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, NS_LOG_FUNCTION, and port.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | Ptr< NetDevice > | boundNetDevice, |
Ipv4Address | address, | ||
uint16_t | port | ||
) |
Allocate an IPv4 Endpoint.
boundNetDevice | Bound NetDevice (if any) |
address | address to use |
port | port to use |
Definition at line 319 of file nsc-tcp-l4-protocol.cc.
References first::address, ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, NS_LOG_FUNCTION, and port.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | Ptr< NetDevice > | boundNetDevice, |
Ipv4Address | localAddress, | ||
uint16_t | localPort, | ||
Ipv4Address | peerAddress, | ||
uint16_t | peerPort | ||
) |
Allocate an IPv4 Endpoint.
boundNetDevice | Bound NetDevice (if any) |
localAddress | local address to use |
localPort | local port to use |
peerAddress | remote address to use |
peerPort | remote port to use |
Definition at line 326 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.
Definition at line 286 of file nsc-tcp-l4-protocol.cc.
References m_node, m_sockets, and NS_LOG_FUNCTION.
void ns3::NscTcpL4Protocol::DeAllocate | ( | Ipv4EndPoint * | endPoint | ) |
Remove an IPv4 Endpoint.
endPoint | the end point to remove |
Definition at line 337 of file nsc-tcp-l4-protocol.cc.
References NS_LOG_FUNCTION.
|
protectedvirtual |
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.
Definition at line 262 of file nsc-tcp-l4-protocol.cc.
References ns3::Object::DoDispose(), m_downTarget, m_endPoints, m_node, m_nscInterface, m_sockets, NS_LOG_FUNCTION, and ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::Nullify().
|
virtual |
This method allows a caller to get the current down target callback set for this L4 protocol (IPv4 case)
Implements ns3::IpL4Protocol.
Definition at line 510 of file nsc-tcp-l4-protocol.cc.
References m_downTarget.
|
virtual |
This method allows a caller to get the current down target callback set for this L4 protocol (IPv6 case)
Implements ns3::IpL4Protocol.
Definition at line 516 of file nsc-tcp-l4-protocol.cc.
std::string ns3::NscTcpL4Protocol::GetNscLibrary | ( | void | ) | const |
Get the NSC library being used.
Definition at line 187 of file nsc-tcp-l4-protocol.cc.
References m_nscLibrary.
Referenced by GetTypeId().
|
virtual |
Returns the protocol number of this protocol.
Implements ns3::IpL4Protocol.
Definition at line 251 of file nsc-tcp-l4-protocol.cc.
References PROT_NUMBER.
|
private |
Called by the Linux stack RNG initialization.
Its also used by the cradle code to add a timestamp to printk/printf/debug output.
sec | seconds |
usec | microseconds |
Definition at line 438 of file nsc-tcp-l4-protocol.cc.
References ns3::Time::GetMicroSeconds(), and ns3::Simulator::Now().
|
static |
Get the type ID.
Definition at line 125 of file nsc-tcp-l4-protocol.cc.
References ns3::TypeId::ATTR_CONSTRUCT, ns3::TypeId::ATTR_GET, GetNscLibrary(), m_sockets, ns3::MakeObjectVectorAccessor(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), SetNscLibrary(), and ns3::TypeId::SetParent().
|
virtual |
|
protectedvirtual |
Notify all Objects aggregated to this one of a new Object being aggregated.
This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.
This method is invoked whenever two sets of Objects are aggregated together. It is invoked exactly once for each Object in both sets. This method can be overridden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate() method.
It is safe to call GetObject() and AggregateObject() from within this method.
Reimplemented from ns3::Object.
Definition at line 228 of file nsc-tcp-l4-protocol.cc.
References ns3::Object::AggregateObject(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), m_downTarget, m_node, ns3::MakeCallback(), ns3::Object::NotifyNewAggregate(), ns3::Ipv4L3Protocol::Send(), SetDownTarget(), and SetNode().
|
private |
Copy constructor.
Defined and not implemented to avoid misuse
|
virtual |
Called from lower-level layers to send the packet up in the stack.
p | packet to forward up |
header | IPv4 Header information |
incomingInterface | the Ipv4Interface on which the packet arrived |
Implements ns3::IpL4Protocol.
Definition at line 344 of file nsc-tcp-l4-protocol.cc.
References ns3::Packet::AddHeader(), ns3::Packet::CopyData(), data, ns3::Ipv4Header::EnableChecksum(), ns3::Ipv4Header::GetDestination(), ns3::Packet::GetSize(), ns3::Ipv4Header::GetSource(), INetStack::if_receive_packet(), m_nscStack, NS_LOG_FUNCTION, packetSize, PROT_NUMBER, ns3::IpL4Protocol::RX_OK, ns3::Ipv4Header::SetDestination(), ns3::Ipv4Header::SetPayloadSize(), ns3::Ipv4Header::SetProtocol(), ns3::Ipv4Header::SetSource(), ns3::Ipv4Header::SetTtl(), and wakeup().
|
virtual |
Called from lower-level layers to send the packet up in the stack.
p | packet to forward up |
header | IPv6 Header information |
incomingInterface | the Ipv6Interface on which the packet arrived |
Implements ns3::IpL4Protocol.
Definition at line 381 of file nsc-tcp-l4-protocol.cc.
References ns3::IpL4Protocol::RX_ENDPOINT_UNREACH.
|
private |
Invoked by NSCs 'ethernet driver' to re-inject a packet into ns-3.
A packet is an octet soup consisting of an IP Header, TCP Header and user payload, if any
data | the data |
datalen | the data length |
Definition at line 393 of file nsc-tcp-l4-protocol.cc.
References data, ns3::Object::GetObject(), INetStack::if_send_finish(), m_downTarget, m_node, m_nscStack, NS_ASSERT, NS_ASSERT_MSG(), and PROT_NUMBER.
|
virtual |
This method allows a caller to set the current down target callback set for this L4 protocol (IPv4 case)
cb | current Callback for the L4 protocol |
Implements ns3::IpL4Protocol.
Definition at line 499 of file nsc-tcp-l4-protocol.cc.
References m_downTarget.
Referenced by NotifyNewAggregate().
|
virtual |
This method allows a caller to set the current down target callback set for this L4 protocol (IPv6 case)
cb | current Callback for the L4 protocol |
Implements ns3::IpL4Protocol.
Definition at line 505 of file nsc-tcp-l4-protocol.cc.
Set node associated with this stack.
node | the node |
Definition at line 192 of file nsc-tcp-l4-protocol.cc.
References AddInterface(), ns3::Object::AggregateObject(), ns3::external_rand(), INetStack::get_hz(), INetStack::init(), m_dlopenHandle, m_node, m_nscInterface, m_nscStack, m_softTimer, ns3::MilliSeconds(), NS_ASSERT, ns3::Timer::Schedule(), ns3::Simulator::ScheduleNow(), ns3::Timer::SetDelay(), ns3::Timer::SetFunction(), and SoftInterrupt().
Referenced by NotifyNewAggregate().
void ns3::NscTcpL4Protocol::SetNscLibrary | ( | const std::string & | lib | ) |
Set the NSC library to be used.
lib | the library path |
Definition at line 174 of file nsc-tcp-l4-protocol.cc.
References m_dlopenHandle, m_nscLibrary, NS_ASSERT, and NS_FATAL_ERROR.
Referenced by GetTypeId().
|
private |
Provide a "soft" interrupt to NSC.
Definition at line 386 of file nsc-tcp-l4-protocol.cc.
References INetStack::increment_ticks(), m_nscStack, m_softTimer, ns3::Timer::Schedule(), and INetStack::timer_interrupt().
Referenced by SetNode().
|
private |
Called by the NSC stack whenever something of interest has happened.
Examples: when data arrives on a socket, a listen socket has a new connection pending, etc.
Definition at line 424 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::GetAllEndPoints(), and m_endPoints.
Referenced by Receive().
|
friend |
NscInterfaceImpl friend class.
Definition at line 212 of file nsc-tcp-l4-protocol.h.
|
friend |
NscTcpSocketImpl friend class.
Definition at line 217 of file nsc-tcp-l4-protocol.h.
|
private |
dynamic library handle.
Definition at line 223 of file nsc-tcp-l4-protocol.h.
Referenced by NscTcpL4Protocol(), SetNode(), SetNscLibrary(), and ~NscTcpL4Protocol().
|
private |
Callback to send packets over IPv4.
Definition at line 227 of file nsc-tcp-l4-protocol.h.
Referenced by DoDispose(), GetDownTarget(), NotifyNewAggregate(), send_callback(), and SetDownTarget().
|
private |
A list of IPv4 end points.
Definition at line 220 of file nsc-tcp-l4-protocol.h.
Referenced by Allocate(), DoDispose(), and wakeup().
the node this stack is associated with
Definition at line 219 of file nsc-tcp-l4-protocol.h.
Referenced by AddInterface(), CreateSocket(), DoDispose(), NotifyNewAggregate(), send_callback(), and SetNode().
|
private |
the NSC Interface.
Definition at line 222 of file nsc-tcp-l4-protocol.h.
Referenced by DoDispose(), and SetNode().
|
private |
path to the NSC library.
Definition at line 224 of file nsc-tcp-l4-protocol.h.
Referenced by GetNscLibrary(), and SetNscLibrary().
|
private |
the NSC stack.
Definition at line 221 of file nsc-tcp-l4-protocol.h.
Referenced by AddInterface(), Receive(), send_callback(), SetNode(), and SoftInterrupt().
|
private |
list of sockets
Definition at line 226 of file nsc-tcp-l4-protocol.h.
Referenced by CreateSocket(), DoDispose(), and GetTypeId().
|
private |
Soft interrupt timer.
Definition at line 225 of file nsc-tcp-l4-protocol.h.
Referenced by SetNode(), and SoftInterrupt().
|
static |
protocol number (0x6)
Definition at line 49 of file nsc-tcp-l4-protocol.h.
Referenced by GetProtocolNumber(), Receive(), and send_callback().