Simulator implementation using MPI and a Null Message algorithm. More...
#include <null-message-simulator-impl.h>
Public Member Functions | |
NullMessageSimulatorImpl () | |
~NullMessageSimulatorImpl () | |
virtual void | Cancel (const EventId &ev) |
Set the cancel bit on this event: the event's associated function will not be invoked when it expires. More... | |
virtual void | Destroy () |
This method is typically invoked at the end of a simulation to avoid false-positive reports by a leak checker. More... | |
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 |
This method has O(1) complexity. More... | |
virtual bool | IsFinished (void) const |
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. More... | |
virtual Time | Now (void) const |
Return the "current simulation time". More... | |
virtual void | Remove (const EventId &ev) |
Remove an event from the event list. More... | |
virtual void | Run (void) |
Run the simulation until one of: More... | |
virtual void | RunOneEvent (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) |
If an event invokes this method, it will be the last event scheduled by the Simulator::Run method before returning to the caller. More... | |
virtual void | Stop (Time const &time) |
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. 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 NullMessageSimulatorImpl * | GetInstance (void) |
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) |
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... | |
Private Types | |
typedef std::list< EventId > | DestroyEvents |
Private Member Functions | |
Time | CalculateGuaranteeTime (uint32_t systemId) |
void | CalculateLookAhead (void) |
Calculate the look ahead allowable for this MPI task. More... | |
void | CalculateSafeTime (void) |
Calculate the SafeTime. More... | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
Time | GetSafeTime (void) |
Get the current SafeTime; the maximum time that events can be processed based on information received from neighboring MPI tasks. More... | |
void | HandleArrivingMessagesBlocking (void) |
Blocking receive of arriving messages. More... | |
void | HandleArrivingMessagesNonBlocking (void) |
Non blocking receive of pending messages. More... | |
Time | Next (void) const |
void | NullMessageEventHandler (RemoteChannelBundle *bundle) |
void | ProcessOneEvent (void) |
Process the next event on the queue. More... | |
void | RescheduleNullMessageEvent (Ptr< RemoteChannelBundle > bundle) |
void | RescheduleNullMessageEvent (uint32_t nodeSysId) |
void | ScheduleNullMessageEvent (Ptr< RemoteChannelBundle > bundle) |
Private Attributes | |
uint32_t | m_currentContext |
uint64_t | m_currentTs |
uint32_t | m_currentUid |
DestroyEvents | m_destroyEvents |
Ptr< Scheduler > | m_events |
uint32_t | m_myId |
Time | m_safeTime |
double | m_schedulerTune |
bool | m_stop |
uint32_t | m_systemCount |
uint32_t | m_uid |
int | m_unscheduledEvents |
Static Private Attributes | |
static NullMessageSimulatorImpl * | g_instance = 0 |
Friends | |
class | NullMessageEvent |
class | NullMessageMpiInterface |
class | RemoteChannelBundleManager |
Additional Inherited Members | |
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... | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. 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... | |
Simulator implementation using MPI and a Null Message algorithm.
Doxygen introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Definition at line 45 of file null-message-simulator-impl.h.
|
private |
Definition at line 170 of file null-message-simulator-impl.h.
ns3::NullMessageSimulatorImpl::NullMessageSimulatorImpl | ( | ) |
Definition at line 67 of file null-message-simulator-impl.cc.
References g_instance, ns3::MpiInterface::GetSize(), ns3::MpiInterface::GetSystemId(), m_currentContext, m_currentTs, m_currentUid, m_events, m_myId, m_safeTime, m_stop, m_systemCount, m_uid, m_unscheduledEvents, NS_ASSERT, NS_FATAL_ERROR, and NS_LOG_FUNCTION.
ns3::NullMessageSimulatorImpl::~NullMessageSimulatorImpl | ( | ) |
Definition at line 98 of file null-message-simulator-impl.cc.
References NS_LOG_FUNCTION.
|
private |
systemId | SystemID to compute guarentee time for |
Calculate the guarantee time for incoming RemoteChannelBundel from task nodeSysId. No message should arrive from task nodeSysId with a receive time less than the guarantee time.
Definition at line 577 of file null-message-simulator-impl.cc.
References ns3::RemoteChannelBundleManager::Find(), GetInstance(), GetSafeTime(), ns3::Min(), Next(), and NS_ASSERT.
Referenced by ns3::NullMessageMpiInterface::SendPacket().
|
private |
Calculate the look ahead allowable for this MPI task.
Basically the minimum latency on links to neighbor MPI tasks.
Add this channel to the remote channel bundle from this task to MPI task on other side of the channel.
Definition at line 138 of file null-message-simulator-impl.cc.
References ns3::RemoteChannelBundleManager::Add(), ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::RemoteChannelBundleManager::Find(), ns3::TimeValue::Get(), ns3::NodeContainer::GetGlobal(), ns3::MpiInterface::GetSize(), ns3::MpiInterface::GetSystemId(), ns3::Node::GetSystemId(), ns3::NullMessageMpiInterface::InitializeSendReceiveBuffers(), m_safeTime, and NS_LOG_FUNCTION.
Referenced by Run().
|
private |
Calculate the SafeTime.
Should be called after message receives.
Definition at line 353 of file null-message-simulator-impl.cc.
References ns3::RemoteChannelBundleManager::GetSafeTime(), m_currentTs, m_safeTime, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by HandleArrivingMessagesBlocking(), and HandleArrivingMessagesNonBlocking().
|
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).
ev | the event to cancel |
Implements ns3::SimulatorImpl.
Definition at line 521 of file null-message-simulator-impl.cc.
References IsExpired().
|
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 118 of file null-message-simulator-impl.cc.
References ns3::MpiInterface::Destroy(), ns3::RemoteChannelBundleManager::Destroy(), m_destroyEvents, NS_LOG_FUNCTION, and NS_LOG_LOGIC.
|
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 104 of file null-message-simulator-impl.cc.
References ns3::Object::DoDispose(), ns3::Scheduler::Event::impl, m_events, NS_LOG_FUNCTION, and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().
|
virtual |
Implements ns3::SimulatorImpl.
Definition at line 572 of file null-message-simulator-impl.cc.
References m_currentContext.
Referenced by Schedule(), and ScheduleNow().
id | the event id to analyse |
Implements ns3::SimulatorImpl.
Definition at line 475 of file null-message-simulator-impl.cc.
References IsExpired(), m_currentTs, and ns3::TimeStep().
|
static |
Singleton accessor.
Definition at line 597 of file null-message-simulator-impl.cc.
References g_instance, and NS_ASSERT.
Referenced by CalculateGuaranteeTime(), ns3::RemoteChannelBundleManager::InitializeNullMessageEvents(), and ns3::NullMessageMpiInterface::SendPacket().
|
virtual |
The returned value will always be bigger than or equal to Simulator::Now.
Implements ns3::SimulatorImpl.
Definition at line 564 of file null-message-simulator-impl.cc.
References ns3::TimeStep().
|
private |
Get the current SafeTime; the maximum time that events can be processed based on information received from neighboring MPI tasks.
Definition at line 362 of file null-message-simulator-impl.cc.
References m_safeTime.
Referenced by CalculateGuaranteeTime(), NullMessageEventHandler(), and Run().
|
virtual |
Implements ns3::SimulatorImpl.
Definition at line 369 of file null-message-simulator-impl.cc.
References m_myId.
|
static |
Definition at line 54 of file null-message-simulator-impl.cc.
References m_schedulerTune, and ns3::TypeId::SetParent().
|
private |
Blocking receive of arriving messages.
Definition at line 340 of file null-message-simulator-impl.cc.
References CalculateSafeTime(), NS_LOG_FUNCTION, ns3::NullMessageMpiInterface::ReceiveMessagesBlocking(), and ns3::NullMessageMpiInterface::TestSendComplete().
Referenced by Run().
|
private |
Non blocking receive of pending messages.
Definition at line 327 of file null-message-simulator-impl.cc.
References CalculateSafeTime(), NS_LOG_FUNCTION, ns3::NullMessageMpiInterface::ReceiveMessagesNonBlocking(), and ns3::NullMessageMpiInterface::TestSendComplete().
Referenced by Run().
|
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.
ev | the event to test for expiration |
Implements ns3::SimulatorImpl.
Definition at line 530 of file null-message-simulator-impl.cc.
References ns3::EventId::GetTs(), ns3::EventId::GetUid(), ns3::EventImpl::IsCancelled(), m_currentTs, m_currentUid, m_destroyEvents, and ns3::EventId::PeekEventImpl().
Referenced by Cancel(), GetDelayLeft(), and Remove().
|
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 247 of file null-message-simulator-impl.cc.
References m_events, and m_stop.
Referenced by Run().
|
private |
Definition at line 253 of file null-message-simulator-impl.cc.
References m_events, NS_ASSERT, NS_LOG_FUNCTION, and ns3::TimeStep().
Referenced by CalculateGuaranteeTime(), NullMessageEventHandler(), and Run().
|
virtual |
Return the "current simulation time".
Implements ns3::SimulatorImpl.
Definition at line 469 of file null-message-simulator-impl.cc.
References m_currentTs, and ns3::TimeStep().
|
private |
bundle | remote channel bundle to schedule an event for. |
Null message event handler. Scheduled to send a null message for the specified bundle at regular intervals. Will canceled and rescheduled when packets are sent.
Definition at line 585 of file null-message-simulator-impl.cc.
References ns3::RemoteChannelBundle::GetDelay(), GetSafeTime(), ns3::Min(), Next(), NS_LOG_FUNCTION, ScheduleNullMessageEvent(), and ns3::NullMessageMpiInterface::SendNullMessage().
Referenced by RescheduleNullMessageEvent(), and ScheduleNullMessageEvent().
|
private |
Process the next event on the queue.
Definition at line 229 of file null-message-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_events, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_unscheduledEvents, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_LOGIC, and ns3::SimpleRefCount< T, PARENT, DELETER >::Unref().
Referenced by Run(), and RunOneEvent().
|
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).
ev | the event to remove from the list of scheduled events. |
Implements ns3::SimulatorImpl.
Definition at line 488 of file null-message-simulator-impl.cc.
References ns3::Scheduler::Event::impl, IsExpired(), m_destroyEvents, m_events, and m_unscheduledEvents.
|
private |
bundle | Bundle to reschedule Null Message event for |
Reschedule Null Message event for the specified RemoteChannelBundel. Existing event will be canceled.
Definition at line 275 of file null-message-simulator-impl.cc.
References ns3::Simulator::Cancel(), m_schedulerTune, NS_LOG_FUNCTION, NullMessageEventHandler(), ns3::PeekPointer(), and ns3::Simulator::Schedule().
Referenced by RescheduleNullMessageEvent(), and ns3::NullMessageMpiInterface::SendPacket().
|
private |
nodeSysId | SystemID to reschedule null event for |
Reschedule Null Message event for the RemoteChannelBundel to the task nodeSysId. Existing event will be canceled.
Definition at line 288 of file null-message-simulator-impl.cc.
References ns3::RemoteChannelBundleManager::Find(), NS_ASSERT, NS_LOG_FUNCTION, and RescheduleNullMessageEvent().
|
virtual |
Run the simulation until one of:
Implements ns3::SimulatorImpl.
Definition at line 299 of file null-message-simulator-impl.cc.
References CalculateLookAhead(), GetSafeTime(), HandleArrivingMessagesBlocking(), HandleArrivingMessagesNonBlocking(), ns3::RemoteChannelBundleManager::InitializeNullMessageEvents(), IsFinished(), m_stop, Next(), NS_LOG_FUNCTION, and ProcessOneEvent().
|
virtual |
Definition at line 375 of file null-message-simulator-impl.cc.
References NS_LOG_FUNCTION, and ProcessOneEvent().
time | delay until the event expires |
event | the event to schedule |
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 402 of file null-message-simulator-impl.cc.
References GetContext(), 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, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_ASSERT, NS_LOG_FUNCTION, and ns3::TimeStep().
event | the event to schedule |
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 458 of file null-message-simulator-impl.cc.
References m_currentTs, m_destroyEvents, m_uid, and NS_LOG_FUNCTION.
event | the event to schedule |
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 442 of file null-message-simulator-impl.cc.
References GetContext(), ns3::Scheduler::Event::impl, ns3::Scheduler::Event::key, ns3::Scheduler::EventKey::m_context, m_currentTs, m_events, ns3::Scheduler::EventKey::m_ts, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, and NS_LOG_FUNCTION.
|
private |
bundle | Bundle to schedule Null Message event for |
Schedule Null Message event for the specified RemoteChannelBundle.
Definition at line 264 of file null-message-simulator-impl.cc.
References m_schedulerTune, NS_LOG_FUNCTION, NullMessageEventHandler(), ns3::PeekPointer(), and ns3::Simulator::Schedule().
Referenced by ns3::RemoteChannelBundleManager::InitializeNullMessageEvents(), and NullMessageEventHandler().
|
virtual |
time | delay until the event expires |
context | event context |
event | the event to schedule |
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 422 of file null-message-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, ns3::Scheduler::EventKey::m_uid, m_uid, m_unscheduledEvents, NS_ASSERT, NS_LOG_FUNCTION, and ns3::TimeStep().
|
virtual |
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 211 of file null-message-simulator-impl.cc.
References ns3::ObjectFactory::Create(), m_events, and NS_LOG_FUNCTION.
|
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 383 of file null-message-simulator-impl.cc.
References m_stop, and NS_LOG_FUNCTION.
|
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.
time | the stop time, relative to the current time. |
Implements ns3::SimulatorImpl.
Definition at line 391 of file null-message-simulator-impl.cc.
References ns3::Time::GetTimeStep(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::Simulator::Stop().
|
friend |
Definition at line 83 of file null-message-simulator-impl.h.
|
friend |
Definition at line 84 of file null-message-simulator-impl.h.
|
friend |
Definition at line 85 of file null-message-simulator-impl.h.
|
staticprivate |
Definition at line 207 of file null-message-simulator-impl.h.
Referenced by GetInstance(), and NullMessageSimulatorImpl().
|
private |
Definition at line 178 of file null-message-simulator-impl.h.
Referenced by GetContext(), NullMessageSimulatorImpl(), and ProcessOneEvent().
|
private |
Definition at line 177 of file null-message-simulator-impl.h.
Referenced by CalculateSafeTime(), GetDelayLeft(), IsExpired(), Now(), NullMessageSimulatorImpl(), ProcessOneEvent(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().
|
private |
Definition at line 176 of file null-message-simulator-impl.h.
Referenced by IsExpired(), NullMessageSimulatorImpl(), and ProcessOneEvent().
|
private |
Definition at line 172 of file null-message-simulator-impl.h.
Referenced by Destroy(), IsExpired(), Remove(), and ScheduleDestroy().
Definition at line 174 of file null-message-simulator-impl.h.
Referenced by DoDispose(), IsFinished(), Next(), NullMessageSimulatorImpl(), ProcessOneEvent(), Remove(), Schedule(), ScheduleNow(), ScheduleWithContext(), and SetScheduler().
|
private |
Definition at line 183 of file null-message-simulator-impl.h.
Referenced by GetSystemId(), and NullMessageSimulatorImpl().
|
private |
Definition at line 190 of file null-message-simulator-impl.h.
Referenced by CalculateLookAhead(), CalculateSafeTime(), GetSafeTime(), and NullMessageSimulatorImpl().
|
private |
Definition at line 202 of file null-message-simulator-impl.h.
Referenced by GetTypeId(), RescheduleNullMessageEvent(), and ScheduleNullMessageEvent().
|
private |
Definition at line 173 of file null-message-simulator-impl.h.
Referenced by IsFinished(), NullMessageSimulatorImpl(), Run(), and Stop().
|
private |
Definition at line 184 of file null-message-simulator-impl.h.
Referenced by NullMessageSimulatorImpl().
|
private |
Definition at line 175 of file null-message-simulator-impl.h.
Referenced by NullMessageSimulatorImpl(), Schedule(), ScheduleDestroy(), ScheduleNow(), and ScheduleWithContext().
|
private |
Definition at line 181 of file null-message-simulator-impl.h.
Referenced by NullMessageSimulatorImpl(), ProcessOneEvent(), Remove(), Schedule(), ScheduleNow(), and ScheduleWithContext().