/usr/include/ns3/realtime-simulator-impl.h is in libns3-dev 3.13+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2008 University of Washington
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
#ifndef REALTIME_SIMULATOR_IMPL_H
#define REALTIME_SIMULATOR_IMPL_H
#include "simulator-impl.h"
#include "scheduler.h"
#include "synchronizer.h"
#include "event-impl.h"
#include "ptr.h"
#include "assert.h"
#include "log.h"
#include "system-mutex.h"
#include <list>
namespace ns3 {
class RealtimeSimulatorImpl : public SimulatorImpl
{
public:
static TypeId GetTypeId (void);
/**
* Enumeration of the types of packets supported in the class.
*
*/
enum SynchronizationMode {
SYNC_BEST_EFFORT, /** Make a best effort to keep synced to real-time */
SYNC_HARD_LIMIT, /** Keep to real-time within a tolerance or die trying */
};
RealtimeSimulatorImpl ();
~RealtimeSimulatorImpl ();
virtual void Destroy ();
virtual bool IsFinished (void) const;
virtual Time Next (void) const;
virtual void Stop (void);
virtual void Stop (Time const &time);
virtual EventId Schedule (Time const &time, EventImpl *event);
virtual void ScheduleWithContext (uint32_t context, Time const &time, EventImpl *event);
virtual EventId ScheduleNow (EventImpl *event);
virtual EventId ScheduleDestroy (EventImpl *event);
virtual void Remove (const EventId &ev);
virtual void Cancel (const EventId &ev);
virtual bool IsExpired (const EventId &ev) const;
virtual void Run (void);
virtual void RunOneEvent (void);
virtual Time Now (void) const;
virtual Time GetDelayLeft (const EventId &id) const;
virtual Time GetMaximumSimulationTime (void) const;
virtual void SetScheduler (ObjectFactory schedulerFactory);
virtual uint32_t GetSystemId (void) const;
virtual uint32_t GetContext (void) const;
void ScheduleRealtimeWithContext (uint32_t context, Time const &time, EventImpl *event);
void ScheduleRealtime (Time const &time, EventImpl *event);
void ScheduleRealtimeNowWithContext (uint32_t context, EventImpl *event);
void ScheduleRealtimeNow (EventImpl *event);
Time RealtimeNow (void) const;
void SetSynchronizationMode (RealtimeSimulatorImpl::SynchronizationMode mode);
RealtimeSimulatorImpl::SynchronizationMode GetSynchronizationMode (void) const;
void SetHardLimit (Time limit);
Time GetHardLimit (void) const;
private:
bool Running (void) const;
bool Realtime (void) const;
void ProcessOneEvent (void);
uint64_t NextTs (void) const;
virtual void DoDispose (void);
typedef std::list<EventId> DestroyEvents;
DestroyEvents m_destroyEvents;
bool m_stop;
bool m_running;
// The following variables are protected using the m_mutex
Ptr<Scheduler> m_events;
int m_unscheduledEvents;
uint32_t m_uid;
uint32_t m_currentUid;
uint64_t m_currentTs;
uint32_t m_currentContext;
mutable SystemMutex m_mutex;
Ptr<Synchronizer> m_synchronizer;
/**
* The policy to use if the simulation cannot keep synchronized to real-time.
*/
SynchronizationMode m_synchronizationMode;
/**
* The maximum allowable drift from real-time in SYNC_HARD_LIMIT mode.
*/
Time m_hardLimit;
};
} // namespace ns3
#endif /* REALTIME_SIMULATOR_IMPL_H */
|