Distributed simulator implementation using lookahead. More...
#include "distributed-simulator-impl.h"
Public Member Functions | |
DistributedSimulatorImpl () | |
Default constructor. | |
~DistributedSimulatorImpl () override | |
Destructor. | |
virtual void | BoundLookAhead (const Time lookAhead) |
Add additional bound to lookahead constraints. | |
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. | |
EventId | Stop (const Time &delay) override |
Schedule the time delay until the Simulator should stop. | |
Public Member Functions inherited from ns3::SimulatorImpl | |
virtual void | PreEventHook (const EventId &id) |
Hook called before processing each event. | |
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. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
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, bool permissive=false) 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. | |
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(). | |
Private Member Functions | |
void | CalculateLookAhead () |
Calculate lookahead constraint based on network latency. | |
void | DoDispose () override |
Destructor implementation. | |
bool | IsLocalFinished () const |
Check if this rank is finished. | |
Time | Next () const |
Get the time of the next event, as returned by NextTs(). | |
uint64_t | NextTs () const |
Get the timestep of the next event. | |
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. | |
bool | m_globalFinished |
Are all parallel instances completed. | |
Time | m_grantedTime |
End of current window. | |
uint32_t | m_myId |
MPI rank. | |
LbtsMessage * | m_pLBTS |
Container for Lbts messages, one per rank. | |
bool | m_stop |
Flag calling for the end of the simulation. | |
uint32_t | m_systemCount |
MPI communicator size. | |
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. | |
Static Private Attributes | |
static Time | m_lookAhead = Time::Max() |
Current window size. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
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 Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Distributed simulator implementation using lookahead.
Definition at line 96 of file distributed-simulator-impl.h.
|
private |
Container type for the events to run at Simulator::Destroy().
Definition at line 185 of file distributed-simulator-impl.h.
ns3::DistributedSimulatorImpl::DistributedSimulatorImpl | ( | ) |
Default constructor.
Definition at line 90 of file distributed-simulator-impl.cc.
References ns3::MpiInterface::GetSize(), ns3::MpiInterface::GetSystemId(), ns3::EventId::INVALID, m_currentContext, m_currentTs, m_currentUid, m_eventCount, m_events, m_globalFinished, m_grantedTime, m_myId, m_pLBTS, m_stop, m_systemCount, m_uid, m_unscheduledEvents, ns3::Simulator::NO_CONTEXT, NS_LOG_FUNCTION, ns3::Seconds(), and ns3::EventId::VALID.
|
override |
Destructor.
Definition at line 112 of file distributed-simulator-impl.cc.
References NS_LOG_FUNCTION.
|
virtual |
Add additional bound to lookahead constraints.
This may be used if there are additional constraints on lookahead in addition to the minimum inter rank latency time. For example when running ns-3 in a co-simulation setting the other simulators may have tighter lookahead constraints.
The method may be invoked more than once, the minimum time will be used to constrain lookahead.
[in] | lookAhead | The maximum lookahead; must be > 0. |
Definition at line 263 of file distributed-simulator-impl.cc.
References m_lookAhead, Min, NS_LOG_FUNCTION, and NS_LOG_WARN.
|
private |
Calculate lookahead constraint based on network latency.
The smallest cross-rank PointToPoint channel delay imposes a constraint on the conservative PDES time window. The user may impose additional constraints on lookahead using the ConstrainLookAhead() method.
Definition at line 152 of file distributed-simulator-impl.cc.
References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::TimeValue::Get(), ns3::MpiInterface::GetCommunicator(), ns3::NodeContainer::GetGlobal(), ns3::Time::GetInteger(), GetMaximumSimulationTime(), ns3::MpiInterface::GetSize(), ns3::MpiInterface::GetSystemId(), m_grantedTime, m_lookAhead, NS_LOG_FUNCTION, and ns3::Seconds().
Referenced by Run().
|
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 573 of file distributed-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 133 of file distributed-simulator-impl.cc.
References ns3::MpiInterface::Destroy(), 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 118 of file distributed-simulator-impl.cc.
References ns3::Object::DoDispose(), ns3::Scheduler::Event::impl, m_events, m_pLBTS, NS_LOG_FUNCTION, 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 614 of file distributed-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 527 of file distributed-simulator-impl.cc.
References IsExpired(), and m_currentTs.
|
overridevirtual |
Get the number of events executed.
Implements ns3::SimulatorImpl.
Definition at line 620 of file distributed-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 606 of file distributed-simulator-impl.cc.
Referenced by CalculateLookAhead(), NextTs(), and Run().
|
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 443 of file distributed-simulator-impl.cc.
References m_myId.
|
static |
Register this type.
Definition at line 81 of file distributed-simulator-impl.cc.
References ns3::TypeId::SetParent().
|
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 executed, 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 582 of file distributed-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 316 of file distributed-simulator-impl.cc.
References m_globalFinished.
|
private |
Check if this rank is finished.
It's finished when there are no more events or stop has been requested.
true
when this rank is finished. Definition at line 322 of file distributed-simulator-impl.cc.
References m_events, and m_stop.
Referenced by NextTs(), and Run().
|
private |
Get the time of the next event, as returned by NextTs().
Definition at line 344 of file distributed-simulator-impl.cc.
References NextTs().
Referenced by Run().
|
private |
Get the timestep of the next event.
If there are no more events the timestep is infinity.
Definition at line 328 of file distributed-simulator-impl.cc.
References GetMaximumSimulationTime(), ns3::Time::GetTimeStep(), IsLocalFinished(), ns3::Scheduler::Event::key, m_events, and ns3::Scheduler::EventKey::m_ts.
Referenced by Next().
|
overridevirtual |
Return the current simulation virtual time.
Implements ns3::SimulatorImpl.
Definition at line 521 of file distributed-simulator-impl.cc.
References m_currentTs.
|
private |
Process the next event.
Definition at line 295 of file distributed-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_FUNCTION, NS_LOG_LOGIC, ns3::SimulatorImpl::PreEventHook(), 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 540 of file distributed-simulator-impl.cc.
References ns3::EventImpl::Cancel(), 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 350 of file distributed-simulator-impl.cc.
References CalculateLookAhead(), ns3::MpiInterface::GetCommunicator(), GetMaximumSimulationTime(), ns3::GrantedTimeWindowMpiInterface::GetRxCount(), ns3::LbtsMessage::GetRxCount(), ns3::LbtsMessage::GetSmallestTime(), ns3::GrantedTimeWindowMpiInterface::GetTxCount(), ns3::LbtsMessage::GetTxCount(), ns3::LbtsMessage::IsFinished(), IsLocalFinished(), m_events, m_globalFinished, m_grantedTime, m_lookAhead, m_myId, m_pLBTS, m_stop, m_systemCount, m_unscheduledEvents, Next(), NS_ASSERT, NS_LOG_FUNCTION, ProcessOneEvent(), ns3::GrantedTimeWindowMpiInterface::ReceiveMessages(), and ns3::GrantedTimeWindowMpiInterface::TestSendComplete().
|
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 468 of file distributed-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, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT, 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 510 of file distributed-simulator-impl.cc.
References m_currentTs, m_destroyEvents, m_uid, and NS_LOG_FUNCTION.
Schedule an event to run at the current virtual time.
[in] | event | The event to schedule. |
Implements ns3::SimulatorImpl.
Definition at line 503 of file distributed-simulator-impl.cc.
References NS_LOG_FUNCTION, 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 488 of file distributed-simulator-impl.cc.
References ns3::Time::GetTimeStep(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, ns3::Scheduler::EventKey::m_ts, m_uid, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, and NS_LOG_FUNCTION.
|
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 277 of file distributed-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 449 of file distributed-simulator-impl.cc.
References m_stop, and NS_LOG_FUNCTION.
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 457 of file distributed-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 203 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), GetContext(), and ProcessOneEvent().
|
private |
Timestamp of the current event.
Definition at line 201 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), GetDelayLeft(), IsExpired(), Now(), ProcessOneEvent(), Schedule(), ScheduleDestroy(), and ScheduleWithContext().
|
private |
Unique id of the current event.
Definition at line 199 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), IsExpired(), and ProcessOneEvent().
|
private |
The container of events to run at Destroy()
Definition at line 188 of file distributed-simulator-impl.h.
Referenced by Destroy(), IsExpired(), Remove(), and ScheduleDestroy().
|
private |
The event count.
Definition at line 205 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), GetEventCount(), and ProcessOneEvent().
The event priority queue.
Definition at line 194 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), DoDispose(), IsLocalFinished(), NextTs(), ProcessOneEvent(), Remove(), Run(), Schedule(), ScheduleWithContext(), and SetScheduler().
|
private |
Are all parallel instances completed.
Definition at line 192 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), IsFinished(), and Run().
|
private |
End of current window.
Definition at line 219 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), CalculateLookAhead(), and Run().
Current window size.
Initialize m_lookAhead to maximum, it will be constrained by user supplied time via BoundLookAhead and the minimum latency network between ranks.
Definition at line 220 of file distributed-simulator-impl.h.
Referenced by BoundLookAhead(), CalculateLookAhead(), and Run().
|
private |
MPI rank.
Definition at line 217 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), GetSystemId(), and Run().
|
private |
Container for Lbts messages, one per rank.
Allocated once we know how many systems there are.
Definition at line 216 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), DoDispose(), and Run().
|
private |
Flag calling for the end of the simulation.
Definition at line 190 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), IsLocalFinished(), Run(), and Stop().
|
private |
MPI communicator size.
Definition at line 218 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), and Run().
|
private |
Next event unique id.
Definition at line 197 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), 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 210 of file distributed-simulator-impl.h.
Referenced by DistributedSimulatorImpl(), ProcessOneEvent(), Remove(), Run(), Schedule(), and ScheduleWithContext().