The default single process simulator implementation. More...
#include "default-simulator-impl.h"
Classes | |
struct | EventWithContext |
Wrap an event with its execution context. More... | |
Public Member Functions | |
DefaultSimulatorImpl () | |
Constructor. | |
~DefaultSimulatorImpl () override | |
Destructor. | |
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. | |
void | Destroy () override |
Execute the events scheduled with ScheduleDestroy(). | |
uint32_t | GetContext () const override |
Get the current simulation context. | |
Time | GetDelayLeft (const EventId &id) const override |
Get the remaining time until this event will execute. | |
uint64_t | GetEventCount () const override |
Get the number of events executed. | |
Time | GetMaximumSimulationTime () const override |
Get the maximum representable simulation time. | |
uint32_t | GetSystemId () const override |
Get the system id of this simulator. | |
bool | IsExpired (const EventId &id) const override |
Check if an event has already run or been cancelled. | |
bool | IsFinished () const override |
Check if the simulation should finish. | |
Time | Now () const override |
Return the current simulation virtual time. | |
void | Remove (const EventId &id) override |
Remove an event from the event list. | |
void | Run () override |
Run the simulation. | |
EventId | Schedule (const Time &delay, EventImpl *event) override |
Schedule a future event execution (in the same context). | |
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. | |
EventId | ScheduleNow (EventImpl *event) override |
Schedule an event to run at the current virtual time. | |
void | ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event) override |
Schedule a future event execution (in a different context). | |
void | SetScheduler (ObjectFactory schedulerFactory) override |
Set the Scheduler to be used to manage the event list. | |
void | Stop () override |
Tell the Simulator the calling event should be the last one executed. | |
void | Stop (const Time &delay) override |
Schedule the time delay until the Simulator should stop. | |
Public Member Functions inherited from ns3::SimulatorImpl | |
virtual void | Cancel (const EventId &id)=0 |
Set the cancel bit on this event: the event's associated function will not be invoked when it expires. | |
virtual void | Destroy ()=0 |
Execute the events scheduled with ScheduleDestroy(). | |
virtual uint32_t | GetContext () const =0 |
Get the current simulation context. | |
virtual Time | GetDelayLeft (const EventId &id) const =0 |
Get the remaining time until this event will execute. | |
virtual uint64_t | GetEventCount () const =0 |
Get the number of events executed. | |
virtual Time | GetMaximumSimulationTime () const =0 |
Get the maximum representable simulation time. | |
virtual uint32_t | GetSystemId () const =0 |
Get the system id of this simulator. | |
virtual bool | IsExpired (const EventId &id) const =0 |
Check if an event has already run or been cancelled. | |
virtual bool | IsFinished () const =0 |
Check if the simulation should finish. | |
virtual Time | Now () const =0 |
Return the current simulation virtual time. | |
virtual void | PreEventHook (const EventId &id) |
Hook called before processing each event. | |
virtual void | Remove (const EventId &id)=0 |
Remove an event from the event list. | |
virtual void | Run ()=0 |
Run the simulation. | |
virtual EventId | Schedule (const Time &delay, EventImpl *event)=0 |
Schedule a future event execution (in the same context). | |
virtual EventId | ScheduleDestroy (EventImpl *event)=0 |
Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached. | |
virtual EventId | ScheduleNow (EventImpl *event)=0 |
Schedule an event to run at the current virtual time. | |
virtual void | ScheduleWithContext (uint32_t context, const Time &delay, EventImpl *event)=0 |
Schedule a future event execution (in a different context). | |
virtual void | SetScheduler (ObjectFactory schedulerFactory)=0 |
Set the Scheduler to be used to manage the event list. | |
virtual void | Stop ()=0 |
Tell the Simulator the calling event should be the last one executed. | |
virtual void | Stop (const Time &delay)=0 |
Schedule the time delay until the Simulator should stop. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::SimulatorImpl | |
static TypeId | GetTypeId () |
Get the registered TypeId for this class. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Types | |
typedef std::list< EventId > | DestroyEvents |
Container type for the events to run at Simulator::Destroy() | |
typedef std::list< EventWithContext > | EventsWithContext |
Container type for the events from a different context. | |
Private Member Functions | |
void | DoDispose () override |
Destructor implementation. | |
void | ProcessEventsWithContext () |
Move events from a different context into the main event queue. | |
void | ProcessOneEvent () |
Process the next event. | |
Private Attributes | |
uint32_t | m_currentContext |
Execution context of the current event. | |
uint64_t | m_currentTs |
Timestamp of the current event. | |
uint32_t | m_currentUid |
Unique id of the current event. | |
DestroyEvents | m_destroyEvents |
The container of events to run at Destroy. | |
uint64_t | m_eventCount |
The event count. | |
Ptr< Scheduler > | m_events |
The event priority queue. | |
EventsWithContext | m_eventsWithContext |
The container of events from a different context. | |
bool | m_eventsWithContextEmpty |
Flag true if all events with context have been moved to the primary event queue. | |
std::mutex | m_eventsWithContextMutex |
Mutex to control access to the list of events with context. | |
std::thread::id | m_mainThreadId |
Main execution thread. | |
bool | m_stop |
Flag calling for the end of the simulation. | |
uint32_t | m_uid |
Next event unique id. | |
int | m_unscheduledEvents |
Number of events that have been inserted but not yet scheduled, not counting the Destroy events; this is used for validation. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
The default single process simulator implementation.
Introspection did not find any typical Config paths.
No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 176 bytes (on a 64-bit architecture).
Definition at line 46 of file default-simulator-impl.h.
|
private |
Container type for the events to run at Simulator::Destroy()
Definition at line 113 of file default-simulator-impl.h.
|
private |
Container type for the events from a different context.
Definition at line 101 of file default-simulator-impl.h.
ns3::DefaultSimulatorImpl::DefaultSimulatorImpl | ( | ) |
Constructor.
Definition at line 55 of file default-simulator-impl.cc.
References ns3::EventId::INVALID, m_currentContext, m_currentTs, m_currentUid, m_eventCount, m_eventsWithContextEmpty, m_mainThreadId, m_stop, m_uid, m_unscheduledEvents, ns3::Simulator::NO_CONTEXT, NS_LOG_FUNCTION, and ns3::EventId::VALID.
|
override |
|
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).
[in] | id | the event to cancel |
Implements ns3::SimulatorImpl.
Definition at line 350 of file default-simulator-impl.cc.
References IsExpired().
|
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.
|
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().
|
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.
Implements ns3::SimulatorImpl.
Definition at line 390 of file default-simulator-impl.cc.
References m_currentContext.
Referenced by Schedule().
Get the remaining time until this event will execute.
[in] | id | The event id to analyse. |
Implements ns3::SimulatorImpl.
Definition at line 304 of file default-simulator-impl.cc.
References IsExpired(), and m_currentTs.
|
overridevirtual |
Get the number of events executed.
Implements ns3::SimulatorImpl.
Definition at line 396 of file default-simulator-impl.cc.
References m_eventCount.
|
overridevirtual |
Get the maximum representable simulation time.
The returned value will always be bigger than or equal to Simulator::Now.
Implements ns3::SimulatorImpl.
Definition at line 384 of file default-simulator-impl.cc.
|
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.
Implements ns3::SimulatorImpl.
Definition at line 124 of file default-simulator-impl.cc.
|
static |
Register this type.
Definition at line 46 of file default-simulator-impl.cc.
References ns3::TypeId::SetParent().
Referenced by ns3::anonymous_namespace{visual-simulator-impl.cc}::GetDefaultSimulatorImplFactory().
|
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.
[in] | id | The event to test for expiration. |
true
if the event has expired, false otherwise. Implements ns3::SimulatorImpl.
Definition at line 359 of file default-simulator-impl.cc.
References ns3::EventId::DESTROY, m_currentTs, m_currentUid, and m_destroyEvents.
Referenced by Cancel(), GetDelayLeft(), and Remove().
|
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()).
true
if no more events or stop time reached. Implements ns3::SimulatorImpl.
Definition at line 151 of file default-simulator-impl.cc.
|
overridevirtual |
Return the current simulation virtual time.
Implements ns3::SimulatorImpl.
Definition at line 297 of file default-simulator-impl.cc.
References m_currentTs.
|
private |
Move events from a different context into the main event queue.
Definition at line 157 of file default-simulator-impl.cc.
References ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, m_eventsWithContext, m_eventsWithContextEmpty, m_eventsWithContextMutex, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, and m_unscheduledEvents.
Referenced by DoDispose(), ProcessOneEvent(), and Run().
|
private |
Process the next event.
Definition at line 130 of file default-simulator-impl.cc.
References ns3::Scheduler::Event::impl, ns3::EventImpl::Invoke(), ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentContext, m_currentTs, m_currentUid, m_eventCount, m_events, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT, NS_LOG_LOGIC, ns3::SimulatorImpl::PreEventHook(), ProcessEventsWithContext(), and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().
Referenced by Run().
|
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).
[in] | id | The event to remove from the list of scheduled events. |
Implements ns3::SimulatorImpl.
Definition at line 317 of file default-simulator-impl.cc.
References ns3::EventId::DESTROY, ns3::Scheduler::Event::impl, IsExpired(), m_destroyEvents, m_events, and m_unscheduledEvents.
|
overridevirtual |
Run the simulation.
The simulation will run until one of:
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().
|
overridevirtual |
Schedule a future event execution (in the same context).
[in] | delay | Delay until the event expires. |
[in] | event | The event to schedule. |
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().
Schedule an event to run at the end of the simulation, after the Stop() time or condition has been reached.
[in] | event | The event to schedule. |
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.
Schedule an event to run at the current virtual time.
[in] | event | The event to schedule. |
Implements ns3::SimulatorImpl.
Definition at line 276 of file default-simulator-impl.cc.
References m_mainThreadId, NS_ASSERT_MSG, and Schedule().
|
overridevirtual |
Schedule a future event execution (in a different context).
This method is thread-safe: it can be called from any thread.
[in] | delay | Delay until the event expires. |
[in] | context | Event context. |
[in] | event | The 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.
|
overridevirtual |
Set the Scheduler to be used to manage the event list.
[in] | schedulerFactory | A 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.
|
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.
|
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.
[in] | delay | The stop time, relative to the current time. |
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().
|
private |
Execution context of the current event.
Definition at line 128 of file default-simulator-impl.h.
Referenced by DefaultSimulatorImpl(), GetContext(), and ProcessOneEvent().
|
private |
Timestamp of the current event.
Definition at line 126 of file default-simulator-impl.h.
Referenced by DefaultSimulatorImpl(), GetDelayLeft(), IsExpired(), Now(), ProcessEventsWithContext(), ProcessOneEvent(), Schedule(), ScheduleDestroy(), and ScheduleWithContext().
|
private |
Unique id of the current event.
Definition at line 124 of file default-simulator-impl.h.
Referenced by DefaultSimulatorImpl(), IsExpired(), and ProcessOneEvent().
|
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().
|
private |
The event count.
Definition at line 130 of file default-simulator-impl.h.
Referenced by DefaultSimulatorImpl(), GetEventCount(), and ProcessOneEvent().
The event priority queue.
Definition at line 119 of file default-simulator-impl.h.
Referenced by DoDispose(), IsFinished(), ProcessEventsWithContext(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleWithContext(), and SetScheduler().
|
private |
The container of events from a different context.
Definition at line 103 of file default-simulator-impl.h.
Referenced by ProcessEventsWithContext(), and ScheduleWithContext().
|
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().
|
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().
|
private |
Main execution thread.
Definition at line 138 of file default-simulator-impl.h.
Referenced by DefaultSimulatorImpl(), Run(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().
|
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().
|
private |
Next event unique id.
Definition at line 122 of file default-simulator-impl.h.
Referenced by DefaultSimulatorImpl(), ProcessEventsWithContext(), Schedule(), ScheduleDestroy(), and ScheduleWithContext().
|
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().