A Discrete-Event Network Simulator
API
synchronizer.cc
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 University of Washington
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  */
18 
19 #include "synchronizer.h"
20 #include "log.h"
21 
28 namespace ns3 {
29 
30 NS_LOG_COMPONENT_DEFINE ("Synchronizer");
31 
32 NS_OBJECT_ENSURE_REGISTERED (Synchronizer);
33 
34 TypeId
36 {
37  static TypeId tid = TypeId ("ns3::Synchronizer")
38  .SetParent<Object> ()
39  ;
40  return tid;
41 }
42 
44  : m_realtimeOriginNano (0),
45  m_simOriginNano (0)
46 {
47  NS_LOG_FUNCTION (this);
48 }
49 
51 {
52  NS_LOG_FUNCTION (this);
53 }
54 
55 bool
57 {
58  NS_LOG_FUNCTION (this);
59  return DoRealtime ();
60 }
61 
62 uint64_t
64 {
65  NS_LOG_FUNCTION (this);
67 }
68 
69 void
71 {
72  NS_LOG_FUNCTION (this << ts);
75 }
76 
77 uint64_t
79 {
80  NS_LOG_FUNCTION (this);
82 }
83 
84 int64_t
86 {
87  NS_LOG_FUNCTION (this << ts);
88  int64_t tDrift = DoGetDrift (TimeStepToNanosecond (ts));
89 
90  if (tDrift < 0)
91  {
92  return -NanosecondToTimeStep (-tDrift);
93  } else {
94  return NanosecondToTimeStep (tDrift);
95  }
96 }
97 
98 bool
99 Synchronizer::Synchronize (uint64_t tsCurrent, uint64_t tsDelay)
100 {
101  NS_LOG_FUNCTION (this << tsCurrent << tsDelay);
102  return DoSynchronize (TimeStepToNanosecond (tsCurrent),
103  TimeStepToNanosecond (tsDelay));
104 }
105 
106 void
108 {
109  NS_LOG_FUNCTION (this);
110  DoSignal ();
111 }
112 
113 void
115 {
116  NS_LOG_FUNCTION (this << cond);
117  DoSetCondition (cond);
118 }
119 
120 void
122 {
123  NS_LOG_FUNCTION (this);
124  DoEventStart ();
125 }
126 
127 uint64_t
129 {
130  NS_LOG_FUNCTION (this);
131  return NanosecondToTimeStep (DoEventEnd ());
132 }
133 
134 uint64_t
136 {
137  NS_LOG_FUNCTION (this << ts);
138  return TimeStep (ts).GetNanoSeconds ();
139 }
140 
141 uint64_t
143 {
144  NS_LOG_FUNCTION (this << ns);
145  return NanoSeconds (ns).GetTimeStep ();
146 }
147 
148 } // namespace ns3
149 
150 
virtual int64_t DoGetDrift(uint64_t ns)=0
Get the drift between the real time clock used to synchronize the simulation and the current simulati...
virtual void DoSetCondition(bool)=0
Set the condition variable to tell a possible simulator thread waiting in the Synchronize method that...
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:44
uint64_t NanosecondToTimeStep(uint64_t ns)
Convert a normalized nanosecond time step into a simulator time step (in Time resolution units)...
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
uint64_t GetCurrentRealtime(void)
Retrieve the value of the origin of the underlying normalized wall clock time in simulator timestep u...
Definition: synchronizer.cc:63
Time NanoSeconds(uint64_t value)
Construct a Time in the indicated unit.
Definition: nstime.h:883
void SetCondition(bool)
Set the condition variable that tells a possible simulator thread waiting in the Synchronize method t...
void EventStart(void)
Ask the synchronizer to remember what time it is.
uint64_t EventEnd(void)
Ask the synchronizer to return the time step between the instant remembered during EventStart and now...
virtual void DoSetOrigin(uint64_t ns)=0
Establish a correspondence between a simulation time and a wall-clock (real) time.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
bool Synchronize(uint64_t tsCurrent, uint64_t tsDelay)
Wait until the real time is in sync with the specified simulation time or until the synchronizer is S...
Definition: synchronizer.cc:99
bool Realtime(void)
Return true if this synchronizer is actually synchronizing to a realtime clock.
Definition: synchronizer.cc:56
uint64_t GetOrigin(void)
Retrieve the value of the origin of the simulation time in Time.resolution units. ...
Definition: synchronizer.cc:78
int64_t GetTimeStep(void) const
Definition: nstime.h:357
Time TimeStep(uint64_t ts)
Definition: nstime.h:916
virtual uint64_t DoGetCurrentRealtime(void)=0
Retrieve the value of the origin of the underlying normalized wall clock time in Time resolution unit...
Synchronizer()
Constructor.
Definition: synchronizer.cc:43
ns3::Synchronizer declaration.
virtual void DoEventStart(void)=0
Record the normalized real time at which the current event is starting execution. ...
int64_t GetDrift(uint64_t ts)
Retrieve the difference between the real time clock used to synchronize the simulation and the simula...
Definition: synchronizer.cc:85
int64_t GetNanoSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:339
virtual void DoSignal(void)=0
Tell a possible simulator thread waiting in the DoSynchronize method that an event has happened which...
uint64_t m_simOriginNano
The simulation time, in ns, when SetOrigin was called.
Definition: synchronizer.h:316
static TypeId GetTypeId(void)
Get the registered TypeId for this class.
Definition: synchronizer.cc:35
void SetOrigin(uint64_t ts)
Establish a correspondence between a simulation time and the synchronizer real time.
Definition: synchronizer.cc:70
void Signal(void)
Tell a possible simulator thread waiting in the Synchronize method that an event has happened which d...
uint64_t TimeStepToNanosecond(uint64_t ts)
Convert a simulator time step (in Time resolution units) to a normalized time step in nanosecond unit...
A base class which provides memory management and object aggregation.
Definition: object.h:87
virtual uint64_t DoEventEnd(void)=0
Return the amount of real time elapsed since the last call to EventStart.
Debug message logging.
a unique identifier for an interface.
Definition: type-id.h:51
TypeId SetParent(TypeId tid)
Definition: type-id.cc:631
virtual ~Synchronizer()
Destructor.
Definition: synchronizer.cc:50
virtual bool DoRealtime(void)=0
Return true if this synchronizer is actually synchronizing to a realtime clock.
virtual bool DoSynchronize(uint64_t nsCurrent, uint64_t nsDelay)=0
Wait until the real time is in sync with the specified simulation time.