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 (uint16_t port) |
Allocate an IPv4 Endpoint. More... | |
Ipv4EndPoint * | Allocate (Ipv4Address address, uint16_t port) |
Allocate an IPv4 Endpoint. More... | |
Ipv4EndPoint * | Allocate (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 |
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... | |
Public Member Functions inherited from ns3::IpL4Protocol | |
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... | |
Public Member Functions inherited from ns3::Object | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
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) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
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. 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 |
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) |
Get the type ID. More... | |
Static Public Member Functions inherited from ns3::IpL4Protocol | |
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::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Noop. More... | |
Static Public Member Functions inherited from ns3::ObjectBase | |
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) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
virtual void | NotifyNewAggregate () |
This method is invoked whenever two sets of objects are aggregated together. More... | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. 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... | |
Friends | |
class | NscInterfaceImpl |
class | NscTcpSocketImpl |
Additional Inherited Members | |
Public Types inherited from ns3::IpL4Protocol | |
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... | |
Nsc wrapper glue, to interface with the Ipv4 protocol underneath.
Definition at line 46 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 448 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 ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | uint16_t | port | ) |
Allocate an IPv4 Endpoint.
port | port to use |
Definition at line 312 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | Ipv4Address | address, |
uint16_t | port | ||
) |
Allocate an IPv4 Endpoint.
address | address to use |
port | port to use |
Definition at line 319 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::Allocate(), m_endPoints, and NS_LOG_FUNCTION.
Ipv4EndPoint * ns3::NscTcpL4Protocol::Allocate | ( | Ipv4Address | localAddress, |
uint16_t | localPort, | ||
Ipv4Address | peerAddress, | ||
uint16_t | peerPort | ||
) |
Allocate an IPv4 Endpoint.
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 335 of file nsc-tcp-l4-protocol.cc.
References NS_LOG_FUNCTION.
|
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 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 508 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 514 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 |
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 436 of file nsc-tcp-l4-protocol.cc.
References ns3::Time::GetMicroSeconds(), and ns3::Simulator::Now().
|
static |
Get the type ID.
Definition at line 126 of file nsc-tcp-l4-protocol.cc.
References ns3::TypeId::ATTR_CONSTRUCT, ns3::TypeId::ATTR_GET, GetNscLibrary(), m_sockets, ns3::MakeObjectVectorAccessor(), SetNscLibrary(), and ns3::TypeId::SetParent().
|
virtual |
|
protectedvirtual |
This method is invoked whenever two sets of objects are aggregated together.
This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.
It is invoked exactly once for each object in both sets. This method can be overriden 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 342 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, 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 379 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 391 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 497 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 503 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, 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 384 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 422 of file nsc-tcp-l4-protocol.cc.
References ns3::Ipv4EndPointDemux::GetAllEndPoints(), and m_endPoints.
Referenced by Receive().
|
friend |
Definition at line 203 of file nsc-tcp-l4-protocol.h.
|
friend |
Definition at line 204 of file nsc-tcp-l4-protocol.h.
|
private |
dynamic library handle.
Definition at line 210 of file nsc-tcp-l4-protocol.h.
Referenced by NscTcpL4Protocol(), SetNode(), SetNscLibrary(), and ~NscTcpL4Protocol().
|
private |
Callback to send packets over IPv4.
Definition at line 214 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 207 of file nsc-tcp-l4-protocol.h.
Referenced by Allocate(), DoDispose(), and wakeup().
the node this stack is associated with
Definition at line 206 of file nsc-tcp-l4-protocol.h.
Referenced by AddInterface(), CreateSocket(), DoDispose(), NotifyNewAggregate(), send_callback(), and SetNode().
|
private |
the NSC Interface.
Definition at line 209 of file nsc-tcp-l4-protocol.h.
Referenced by DoDispose(), and SetNode().
|
private |
path to the NSC library.
Definition at line 211 of file nsc-tcp-l4-protocol.h.
Referenced by GetNscLibrary(), and SetNscLibrary().
|
private |
the NSC stack.
Definition at line 208 of file nsc-tcp-l4-protocol.h.
Referenced by AddInterface(), Receive(), send_callback(), SetNode(), and SoftInterrupt().
|
private |
list of sockets
Definition at line 213 of file nsc-tcp-l4-protocol.h.
Referenced by CreateSocket(), DoDispose(), and GetTypeId().
|
private |
Soft interrupt timer.
Definition at line 212 of file nsc-tcp-l4-protocol.h.
Referenced by SetNode(), and SoftInterrupt().
|
static |
protocol number (0x6)
Definition at line 48 of file nsc-tcp-l4-protocol.h.
Referenced by GetProtocolNumber(), Receive(), and send_callback().