A Discrete-Event Network Simulator
API
ns3::DefaultSimulatorImpl Class Reference

The default single process simulator implementation. More...

#include "default-simulator-impl.h"

+ Inheritance diagram for ns3::DefaultSimulatorImpl:
+ Collaboration diagram for ns3::DefaultSimulatorImpl:

Classes

struct  EventWithContext
 Wrap an event with its execution context. More...
 

Public Member Functions

 DefaultSimulatorImpl ()
 Constructor. More...
 
 ~DefaultSimulatorImpl () override
 Destructor. More...
 
void Cancel (const EventId &id) override
 Set the cancel bit on this event: the event's associated function will not be invoked when it expires. More...
 
void Destroy () override
 Execute the events scheduled with ScheduleDestroy().
More...
 
uint32_t GetContext () const override
 Get the current simulation context. More...
 
Time GetDelayLeft (const EventId &id) const override
 Get the remaining time until this event will execute. More...
 
uint64_t GetEventCount () const override
 Get the number of events executed. More...
 
Time GetMaximumSimulationTime () const override
 Get the maximum representable simulation time. More...
 
uint32_t GetSystemId () const override
 Get the system id of this simulator. More...
 
bool IsExpired (const EventId &id) const override
 Check if an event has already run or been cancelled. More...
 
bool IsFinished () const override
 Check if the simulation should finish. More...
 
Time Now () const override
 Return the current simulation virtual time. More...
 
void Remove (const EventId &id) override
 Remove an event from the event list. More...
 
void Run () override
 Run the simulation. More...
 
EventId Schedule (const Time &delay, EventImpl *event) override
 Schedule a future event execution (in the same context). More...
 
EventId ScheduleDestroy (EventImpl *event) override
 Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached. More...
 
EventId ScheduleNow (EventImpl *event) override
 Schedule an event to run at the current virtual time. More...
 
void ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event) override
 Schedule a future event execution (in a different context). More...
 
void SetScheduler (ObjectFactory schedulerFactory) override
 Set the Scheduler to be used to manage the event list. More...
 
void Stop () override
 Tell the Simulator the calling event should be the last one executed. More...
 
EventId Stop (const Time &delay) override
 Schedule the time delay until the Simulator should stop. More...
 
- Public Member Functions inherited from ns3::SimulatorImpl
virtual void PreEventHook (const EventId &id)
 Hook called before processing each event. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () 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
 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 errors. 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 ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimulatorImpl
static TypeId GetTypeId ()
 Get the registered TypeId for this class. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Private Types

typedef std::list< EventIdDestroyEvents
 Container type for the events to run at Simulator::Destroy() More...
 
typedef std::list< EventWithContextEventsWithContext
 Container type for the events from a different context. More...
 

Private Member Functions

void DoDispose () override
 Destructor implementation. More...
 
void ProcessEventsWithContext ()
 Move events from a different context into the main event queue. More...
 
void ProcessOneEvent ()
 Process the next event. More...
 

Private Attributes

uint32_t m_currentContext
 Execution context of the current event. More...
 
uint64_t m_currentTs
 Timestamp of the current event. More...
 
uint32_t m_currentUid
 Unique id of the current event. More...
 
DestroyEvents m_destroyEvents
 The container of events to run at Destroy. More...
 
uint64_t m_eventCount
 The event count. More...
 
Ptr< Schedulerm_events
 The event priority queue. More...
 
EventsWithContext m_eventsWithContext
 The container of events from a different context. More...
 
bool m_eventsWithContextEmpty
 Flag true if all events with context have been moved to the primary event queue. More...
 
std::mutex m_eventsWithContextMutex
 Mutex to control access to the list of events with context. More...
 
std::thread::id m_mainThreadId
 Main execution thread. More...
 
bool m_stop
 Flag calling for the end of the simulation. More...
 
uint32_t m_uid
 Next event unique id. More...
 
int m_unscheduledEvents
 Number of events that have been inserted but not yet scheduled, not counting the Destroy events; this is used for validation. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize ()
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

The default single process simulator implementation.

Definition at line 46 of file default-simulator-impl.h.

Member Typedef Documentation

◆ DestroyEvents

Container type for the events to run at Simulator::Destroy()

Definition at line 113 of file default-simulator-impl.h.

◆ EventsWithContext

Container type for the events from a different context.

Definition at line 101 of file default-simulator-impl.h.

Constructor & Destructor Documentation

◆ DefaultSimulatorImpl()

◆ ~DefaultSimulatorImpl()

ns3::DefaultSimulatorImpl::~DefaultSimulatorImpl ( )
override

Destructor.

Definition at line 69 of file default-simulator-impl.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ Cancel()

void ns3::DefaultSimulatorImpl::Cancel ( const EventId id)
overridevirtual

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
[in]idthe event to cancel

Implements ns3::SimulatorImpl.

Definition at line 350 of file default-simulator-impl.cc.

References IsExpired().

+ Here is the call graph for this function:

◆ Destroy()

void ns3::DefaultSimulatorImpl::Destroy ( )
overridevirtual

Execute the events scheduled with ScheduleDestroy().

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 90 of file default-simulator-impl.cc.

References m_destroyEvents, NS_LOG_FUNCTION, and NS_LOG_LOGIC.

◆ DoDispose()

void ns3::DefaultSimulatorImpl::DoDispose ( void  )
overrideprivatevirtual

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 75 of file default-simulator-impl.cc.

References ns3::Object::DoDispose(), ns3::Scheduler::Event::impl, m_events, NS_LOG_FUNCTION, ProcessEventsWithContext(), and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().

+ Here is the call graph for this function:

◆ GetContext()

uint32_t ns3::DefaultSimulatorImpl::GetContext ( ) const
overridevirtual

Get the current simulation context.

The simulation context is the ns-3 notion of a Logical Process. Events in a single context should only modify state associated with that context. Events for objects in other contexts should be scheduled with ScheduleWithContext() to track the context switches. In other words, events in different contexts should be mutually thread safe, by not modify overlapping model state.

In circumstances where the context can't be determined, such as during object initialization, the enum value NO_CONTEXT should be used.

Returns
The current simulation context

Implements ns3::SimulatorImpl.

Definition at line 389 of file default-simulator-impl.cc.

References m_currentContext.

Referenced by Schedule().

+ Here is the caller graph for this function:

◆ GetDelayLeft()

Time ns3::DefaultSimulatorImpl::GetDelayLeft ( const EventId id) const
overridevirtual

Get the remaining time until this event will execute.

Parameters
[in]idThe 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 304 of file default-simulator-impl.cc.

References IsExpired(), and m_currentTs.

+ Here is the call graph for this function:

◆ GetEventCount()

uint64_t ns3::DefaultSimulatorImpl::GetEventCount ( ) const
overridevirtual

Get the number of events executed.

Returns
The total number of events executed.

Implements ns3::SimulatorImpl.

Definition at line 395 of file default-simulator-impl.cc.

References m_eventCount.

◆ GetMaximumSimulationTime()

Time ns3::DefaultSimulatorImpl::GetMaximumSimulationTime ( ) const
overridevirtual

Get the maximum representable simulation time.

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 383 of file default-simulator-impl.cc.

◆ GetSystemId()

uint32_t ns3::DefaultSimulatorImpl::GetSystemId ( ) const
overridevirtual

Get the system id of this simulator.

The system id is the identifier for this simulator instance in a distributed simulation. For MPI this is the MPI rank.

Returns
The system id for this simulator.

Implements ns3::SimulatorImpl.

Definition at line 124 of file default-simulator-impl.cc.

◆ GetTypeId()

TypeId ns3::DefaultSimulatorImpl::GetTypeId ( void  )
static

Register this type.

Returns
The object TypeId.

Definition at line 46 of file default-simulator-impl.cc.

References ns3::TypeId::SetParent().

Referenced by ns3::anonymous_namespace{visual-simulator-impl.cc}::GetDefaultSimulatorImplFactory().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsExpired()

bool ns3::DefaultSimulatorImpl::IsExpired ( const EventId id) const
overridevirtual

Check if an event has already run or been cancelled.

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
[in]idThe event to test for expiration.
Returns
true if the event has expired, false otherwise.

Implements ns3::SimulatorImpl.

Definition at line 359 of file default-simulator-impl.cc.

References m_currentTs, m_currentUid, and m_destroyEvents.

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

+ Here is the caller graph for this function:

◆ IsFinished()

bool ns3::DefaultSimulatorImpl::IsFinished ( ) const
overridevirtual

Check if the simulation should finish.

Reasons to finish are because there are no more events lefts to be scheduled, or if simulation time has already reached the "stop time" (see Simulator::Stop()).

Returns
true if no more events or stop time reached.

Implements ns3::SimulatorImpl.

Definition at line 151 of file default-simulator-impl.cc.

References m_events, and m_stop.

◆ Now()

Time ns3::DefaultSimulatorImpl::Now ( ) const
overridevirtual

Return the current simulation virtual time.

Returns
The current virtual time.

Implements ns3::SimulatorImpl.

Definition at line 297 of file default-simulator-impl.cc.

References m_currentTs.

◆ ProcessEventsWithContext()

void ns3::DefaultSimulatorImpl::ProcessEventsWithContext ( )
private

◆ ProcessOneEvent()

◆ Remove()

void ns3::DefaultSimulatorImpl::Remove ( const EventId id)
overridevirtual

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
[in]idThe event to remove from the list of scheduled events.

Implements ns3::SimulatorImpl.

Definition at line 317 of file default-simulator-impl.cc.

References ns3::Scheduler::Event::impl, IsExpired(), m_destroyEvents, m_events, and m_unscheduledEvents.

+ Here is the call graph for this function:

◆ Run()

void ns3::DefaultSimulatorImpl::Run ( )
overridevirtual

Run the simulation.

The simulation will run until one of:

  • No events are present anymore
  • The user called Simulator::Stop
  • The user called Simulator::Stop with a 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 187 of file default-simulator-impl.cc.

References m_events, m_mainThreadId, m_stop, m_unscheduledEvents, NS_ASSERT, NS_LOG_FUNCTION, ProcessEventsWithContext(), and ProcessOneEvent().

+ Here is the call graph for this function:

◆ Schedule()

EventId ns3::DefaultSimulatorImpl::Schedule ( const Time delay,
EventImpl event 
)
overridevirtual

Schedule a future event execution (in the same context).

Parameters
[in]delayDelay until the event expires.
[in]eventThe event to schedule.
Returns
A unique identifier for the newly-scheduled event.

Implements ns3::SimulatorImpl.

Definition at line 223 of file default-simulator-impl.cc.

References GetContext(), ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Time::IsPositive(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_mainThreadId, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by ScheduleNow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ ScheduleDestroy()

EventId ns3::DefaultSimulatorImpl::ScheduleDestroy ( EventImpl event)
overridevirtual

Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.

Parameters
[in]eventThe event to schedule.
Returns
A unique identifier for the newly-scheduled event.

Implements ns3::SimulatorImpl.

Definition at line 285 of file default-simulator-impl.cc.

References m_currentTs, m_destroyEvents, m_mainThreadId, m_uid, and NS_ASSERT_MSG.

◆ ScheduleNow()

EventId ns3::DefaultSimulatorImpl::ScheduleNow ( EventImpl event)
overridevirtual

Schedule an event to run at the current virtual time.

Parameters
[in]eventThe event to schedule.
Returns
A unique identifier for the newly-scheduled event.

Implements ns3::SimulatorImpl.

Definition at line 276 of file default-simulator-impl.cc.

References m_mainThreadId, NS_ASSERT_MSG, and Schedule().

+ Here is the call graph for this function:

◆ ScheduleWithContext()

void ns3::DefaultSimulatorImpl::ScheduleWithContext ( uint32_t  context,
const Time delay,
EventImpl event 
)
overridevirtual

Schedule a future event execution (in a different context).

This method is thread-safe: it can be called from any thread.

Parameters
[in]delayDelay until the event expires.
[in]contextEvent context.
[in]eventThe event to schedule.

Implements ns3::SimulatorImpl.

Definition at line 244 of file default-simulator-impl.cc.

References ns3::DefaultSimulatorImpl::EventWithContext::context, ns3::DefaultSimulatorImpl::EventWithContext::event, ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_eventsWithContext, m_eventsWithContextEmpty, m_eventsWithContextMutex, m_mainThreadId, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_LOG_FUNCTION, and ns3::DefaultSimulatorImpl::EventWithContext::timestamp.

+ Here is the call graph for this function:

◆ SetScheduler()

void ns3::DefaultSimulatorImpl::SetScheduler ( ObjectFactory  schedulerFactory)
overridevirtual

Set the Scheduler to be used to manage the event list.

Parameters
[in]schedulerFactoryA new event scheduler factory.

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

Implements ns3::SimulatorImpl.

Definition at line 106 of file default-simulator-impl.cc.

References ns3::ObjectFactory::Create(), m_events, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Stop() [1/2]

void ns3::DefaultSimulatorImpl::Stop ( )
overridevirtual

Tell the Simulator the calling event should be the last one executed.

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

Implements ns3::SimulatorImpl.

Definition at line 206 of file default-simulator-impl.cc.

References m_stop, and NS_LOG_FUNCTION.

◆ Stop() [2/2]

EventId ns3::DefaultSimulatorImpl::Stop ( const Time delay)
overridevirtual

Schedule the time delay until the Simulator should stop.

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
[in]delayThe stop time, relative to the current time.
Returns
The stop EventId.

Implements ns3::SimulatorImpl.

Definition at line 213 of file default-simulator-impl.cc.

References ns3::Time::GetTimeStep(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Simulator::Stop().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_currentContext

uint32_t ns3::DefaultSimulatorImpl::m_currentContext
private

Execution context of the current event.

Definition at line 128 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), GetContext(), and ProcessOneEvent().

◆ m_currentTs

uint64_t ns3::DefaultSimulatorImpl::m_currentTs
private

◆ m_currentUid

uint32_t ns3::DefaultSimulatorImpl::m_currentUid
private

Unique id of the current event.

Definition at line 124 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), IsExpired(), and ProcessOneEvent().

◆ m_destroyEvents

DestroyEvents ns3::DefaultSimulatorImpl::m_destroyEvents
private

The container of events to run at Destroy.

Definition at line 115 of file default-simulator-impl.h.

Referenced by Destroy(), IsExpired(), Remove(), and ScheduleDestroy().

◆ m_eventCount

uint64_t ns3::DefaultSimulatorImpl::m_eventCount
private

The event count.

Definition at line 130 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), GetEventCount(), and ProcessOneEvent().

◆ m_events

Ptr<Scheduler> ns3::DefaultSimulatorImpl::m_events
private

◆ m_eventsWithContext

EventsWithContext ns3::DefaultSimulatorImpl::m_eventsWithContext
private

The container of events from a different context.

Definition at line 103 of file default-simulator-impl.h.

Referenced by ProcessEventsWithContext(), and ScheduleWithContext().

◆ m_eventsWithContextEmpty

bool ns3::DefaultSimulatorImpl::m_eventsWithContextEmpty
private

Flag true if all events with context have been moved to the primary event queue.

Definition at line 108 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), ProcessEventsWithContext(), and ScheduleWithContext().

◆ m_eventsWithContextMutex

std::mutex ns3::DefaultSimulatorImpl::m_eventsWithContextMutex
private

Mutex to control access to the list of events with context.

Definition at line 110 of file default-simulator-impl.h.

Referenced by ProcessEventsWithContext(), and ScheduleWithContext().

◆ m_mainThreadId

std::thread::id ns3::DefaultSimulatorImpl::m_mainThreadId
private

Main execution thread.

Definition at line 138 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), Run(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().

◆ m_stop

bool ns3::DefaultSimulatorImpl::m_stop
private

Flag calling for the end of the simulation.

Definition at line 117 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), IsFinished(), Run(), and Stop().

◆ m_uid

uint32_t ns3::DefaultSimulatorImpl::m_uid
private

◆ m_unscheduledEvents

int ns3::DefaultSimulatorImpl::m_unscheduledEvents
private

Number of events that have been inserted but not yet scheduled, not counting the Destroy events; this is used for validation.

Definition at line 135 of file default-simulator-impl.h.

Referenced by DefaultSimulatorImpl(), ProcessEventsWithContext(), ProcessOneEvent(), Remove(), Run(), Schedule(), and ScheduleWithContext().


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