ns3::DistributedSimulatorImpl Class Reference

distributed simulator implementation using lookahead More...

#include <distributed-simulator-impl.h>

Inheritance diagram for ns3::DistributedSimulatorImpl:

Public Member Functions
virtual void	Cancel (const EventId &ev)
virtual void	Destroy ()
virtual uint32_t	GetContext (void) const
virtual Time	GetDelayLeft (const EventId &id) const
virtual Time	GetMaximumSimulationTime (void) const
virtual uint32_t	GetSystemId (void) const
virtual bool	IsExpired (const EventId &ev) const
virtual bool	IsFinished (void) const
virtual Time	Now (void) const
virtual void	Remove (const EventId &ev)
virtual void	Run (void)
virtual EventId	Schedule (Time const &time, EventImpl *event)
virtual EventId	ScheduleDestroy (EventImpl *event)
virtual EventId	ScheduleNow (EventImpl *event)
virtual void	ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event)
virtual void	SetScheduler (ObjectFactory schedulerFactory)
virtual void	Stop (void)
virtual void	Stop (Time const &time)
Public Member Functions inherited from ns3::Object
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
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)
Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId (void)

Private Types
typedef std::list< EventId >	DestroyEvents

Private Member Functions
void	CalculateLookAhead (void)
virtual void	DoDispose (void)
Time	Next (void) const
uint64_t	NextTs (void) const
void	ProcessOneEvent (void)

Private Attributes
uint32_t	m_currentContext
uint64_t	m_currentTs
uint32_t	m_currentUid
DestroyEvents	m_destroyEvents
Ptr< Scheduler >	m_events
Time	m_grantedTime
uint32_t	m_myId
LbtsMessage *	m_pLBTS
bool	m_stop
uint32_t	m_systemCount
uint32_t	m_uid
int	m_unscheduledEvents

Static Private Attributes
static Time	m_lookAhead = Seconds (0)

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoInitialize (void)
virtual void	NotifyNewAggregate (void)
Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
virtual void	NotifyConstructionCompleted (void)

Detailed Description

distributed simulator implementation using lookahead

Doxygen introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 91 of file distributed-simulator-impl.h.

Member Function Documentation

void ns3::DistributedSimulatorImpl::Cancel ( const EventId &  ev )

virtual

Set the cancel bit on this event: the event's associated function will not be invoked when it expires. This method has the same visible effect as the ns3::Simulator::Remove method but its algorithmic complexity is much lower: it has O(1) complexity. This method has the exact same semantics as ns3::EventId::Cancel. Note that it is not possible to cancel events which were scheduled for the "destroy" time. Doing so will result in a program error (crash).

Parameters

ev	the event to cancel

Implements ns3::SimulatorImpl.

Definition at line 457 of file distributed-simulator-impl.cc.

References IsExpired().

void ns3::DistributedSimulatorImpl::Destroy ( )

virtual

This method is typically invoked at the end of a simulation to avoid false-positive reports by a leak checker. After this method has been invoked, it is actually possible to restart a new simulation with a set of calls to Simulator::Run, Simulator::Schedule and Simulator::ScheduleWithContext.

Implements ns3::SimulatorImpl.

Definition at line 128 of file distributed-simulator-impl.cc.

References ns3::MpiInterface::Destroy(), and NS_LOG_LOGIC.

void ns3::DistributedSimulatorImpl::DoDispose ( void  )

privatevirtual

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 115 of file distributed-simulator-impl.cc.

References ns3::Object::DoDispose(), and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

uint32_t ns3::DistributedSimulatorImpl::GetContext ( void  ) const

virtual

Returns

the current simulation context

Implements ns3::SimulatorImpl.

Definition at line 508 of file distributed-simulator-impl.cc.

Referenced by Schedule(), and ScheduleNow().

Time ns3::DistributedSimulatorImpl::GetDelayLeft ( const EventId &  id ) const

virtual

Parameters

id	the event id to analyse

Returns

the delay left until the input event id expires. if the event is not running, this method returns zero.

Implements ns3::SimulatorImpl.

Definition at line 411 of file distributed-simulator-impl.cc.

References IsExpired().

Time ns3::DistributedSimulatorImpl::GetMaximumSimulationTime ( void  ) const

virtual

Returns

the maximum simulation time at which an event can be scheduled.

The returned value will always be bigger than or equal to Simulator::Now.

Implements ns3::SimulatorImpl.

Definition at line 500 of file distributed-simulator-impl.cc.

uint32_t ns3::DistributedSimulatorImpl::GetSystemId ( void  ) const

virtual

Returns

the system id for this simulator; used for MPI or other distributed simulations

Implements ns3::SimulatorImpl.

Definition at line 328 of file distributed-simulator-impl.cc.

bool ns3::DistributedSimulatorImpl::IsExpired ( const EventId &  ev ) const

virtual

This method has O(1) complexity. Note that it is not possible to test for the expiration of events which were scheduled for the "destroy" time. Doing so will result in a program error (crash). An event is said to "expire" when it starts being scheduled which means that if the code executed by the event calls this function, it will get true.

Parameters

ev	the event to test for expiration

Returns

true if the event has expired, false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 466 of file distributed-simulator-impl.cc.

References ns3::EventImpl::IsCancelled().

Referenced by Cancel(), GetDelayLeft(), and Remove().

bool ns3::DistributedSimulatorImpl::IsFinished ( void  ) const

virtual

If there are no more events lefts to be scheduled, or if simulation time has already reached the "stop time" (see Simulator::Stop()), return true. Return false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 251 of file distributed-simulator-impl.cc.

Time ns3::DistributedSimulatorImpl::Now ( void  ) const

virtual

Return the "current simulation time".

Implements ns3::SimulatorImpl.

Definition at line 405 of file distributed-simulator-impl.cc.

void ns3::DistributedSimulatorImpl::Remove ( const EventId &  ev )

virtual

Remove an event from the event list. This method has the same visible effect as the ns3::EventId::Cancel method but its algorithmic complexity is much higher: it has often O(log(n)) complexity, sometimes O(n), sometimes worse. Note that it is not possible to remove events which were scheduled for the "destroy" time. Doing so will result in a program error (crash).

Parameters

ev	the event to remove from the list of scheduled events.

Implements ns3::SimulatorImpl.

Definition at line 424 of file distributed-simulator-impl.cc.

References IsExpired().

void ns3::DistributedSimulatorImpl::Run ( void  )

virtual

Run the simulation until one of:

• no events are present anymore
• the user called Simulator::Stop
• the user called Simulator::Stop with stop time and the expiration time of the next event to be processed is greater than or equal to the stop time.

Implements ns3::SimulatorImpl.

Definition at line 271 of file distributed-simulator-impl.cc.

References ns3::LbtsMessage::GetRxCount(), ns3::MpiInterface::GetRxCount(), ns3::LbtsMessage::GetSmallestTime(), ns3::LbtsMessage::GetTxCount(), ns3::MpiInterface::GetTxCount(), NS_ASSERT, NS_FATAL_ERROR, ns3::MpiInterface::ReceiveMessages(), and ns3::MpiInterface::TestSendComplete().

EventId ns3::DistributedSimulatorImpl::Schedule ( Time const &  time, EventImpl *  event  )

virtual

Parameters

time	delay until the event expires
event	the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 349 of file distributed-simulator-impl.cc.

References GetContext(), ns3::Time::GetTimeStep(), ns3::Time::IsPositive(), and NS_ASSERT.

EventId ns3::DistributedSimulatorImpl::ScheduleDestroy ( EventImpl *  event )

virtual

Parameters

event

the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 396 of file distributed-simulator-impl.cc.

EventId ns3::DistributedSimulatorImpl::ScheduleNow ( EventImpl *  event )

virtual

Parameters

event

the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 382 of file distributed-simulator-impl.cc.

References GetContext().

void ns3::DistributedSimulatorImpl::ScheduleWithContext ( uint32_t  context, Time const &  time, EventImpl *  event  )

virtual

Parameters

time	delay until the event expires
context	event context
event	the event to schedule

Returns

a unique identifier for the newly-scheduled event.

This method will be typically used by language bindings to delegate events to their own subclass of the EventImpl base class.

Implements ns3::SimulatorImpl.

Definition at line 367 of file distributed-simulator-impl.cc.

References ns3::Time::GetTimeStep(), and NS_LOG_FUNCTION.

void ns3::DistributedSimulatorImpl::SetScheduler ( ObjectFactory  schedulerFactory )

virtual

Parameters

schedulerFactory

a new event scheduler factory

The event scheduler can be set at any time: the events scheduled in the previous scheduler will be transfered to the new scheduler before we start to use it.

Implements ns3::SimulatorImpl.

Definition at line 219 of file distributed-simulator-impl.cc.

References ns3::ObjectFactory::Create().

void ns3::DistributedSimulatorImpl::Stop ( void  )

virtual

If an event invokes this method, it will be the last event scheduled by the Simulator::Run method before returning to the caller.

Implements ns3::SimulatorImpl.

Definition at line 334 of file distributed-simulator-impl.cc.

void ns3::DistributedSimulatorImpl::Stop ( Time const &  time )

virtual

Force the Simulator::Run method to return to the caller when the expiration time of the next event to be processed is greater than or equal to the stop time. The stop time is relative to the current simulation time.

Parameters

time	the stop time, relative to the current time.

Implements ns3::SimulatorImpl.

Definition at line 340 of file distributed-simulator-impl.cc.

References ns3::Simulator::Schedule(), and ns3::Simulator::Stop().

---

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

• src/mpi/model/distributed-simulator-impl.h
• src/mpi/model/distributed-simulator-impl.cc