A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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 
22 NS_LOG_COMPONENT_DEFINE ("Synchronizer");
23 
24 namespace ns3 {
25 
26 NS_OBJECT_ENSURE_REGISTERED (Synchronizer)
27  ;
28 
29 TypeId
31 {
32  static TypeId tid = TypeId ("ns3::Synchronizer")
33  .SetParent<Object> ()
34  ;
35  return tid;
36 }
37 
39  : m_realtimeOriginNano (0), m_simOriginNano (0)
40 {
41  NS_LOG_FUNCTION (this);
42 }
43 
45 {
46  NS_LOG_FUNCTION (this);
47 }
48 
49 bool
51 {
52  NS_LOG_FUNCTION (this);
53  return DoRealtime ();
54 }
55 
56 uint64_t
58 {
59  NS_LOG_FUNCTION (this);
61 }
62 
63 void
65 {
66  NS_LOG_FUNCTION (this << ts);
69 }
70 
71 uint64_t
73 {
74  NS_LOG_FUNCTION (this);
76 }
77 
78 int64_t
80 {
81  NS_LOG_FUNCTION (this << ts);
82  int64_t tDrift = DoGetDrift (TimeStepToNanosecond (ts));
83 
84  if (tDrift < 0)
85  {
86  return -NanosecondToTimeStep (-tDrift);
87  } else {
88  return NanosecondToTimeStep (tDrift);
89  }
90 }
91 
92 bool
93 Synchronizer::Synchronize (uint64_t tsCurrent, uint64_t tsDelay)
94 {
95  NS_LOG_FUNCTION (this << tsCurrent << tsDelay);
96  return DoSynchronize (TimeStepToNanosecond (tsCurrent),
97  TimeStepToNanosecond (tsDelay));
98 }
99 
100 void
102 {
103  NS_LOG_FUNCTION (this);
104  DoSignal ();
105 }
106 
107 void
109 {
110  NS_LOG_FUNCTION (this << cond);
111  DoSetCondition (cond);
112 }
113 
114 void
116 {
117  NS_LOG_FUNCTION (this);
118  DoEventStart ();
119 }
120 
121 uint64_t
123 {
124  NS_LOG_FUNCTION (this);
125  return NanosecondToTimeStep (DoEventEnd ());
126 }
127 
128 uint64_t
130 {
131  NS_LOG_FUNCTION (this << ts);
132  return TimeStep (ts).GetNanoSeconds ();
133 }
134 
135 uint64_t
137 {
138  NS_LOG_FUNCTION (this << ns);
139  return NanoSeconds (ns).GetTimeStep ();
140 }
141 
142 } // namespace ns3
143 
144 
virtual int64_t DoGetDrift(uint64_t ns)=0
Declaration of method used to retrieve drift between the real time clock used to synchronize the simu...
virtual void DoSetCondition(bool)=0
Declaration of the method used to set the condition variable that tells a possible simulator thread w...
#define NS_LOG_FUNCTION(parameters)
Definition: log.h:345
Time TimeStep(uint64_t ts)
Definition: nstime.h:950
uint64_t NanosecondToTimeStep(uint64_t ns)
Convert a normalized nanosecond count into a simulator time step (which can be steps of time in a use...
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
uint64_t GetCurrentRealtime(void)
Retrieve the value of the origin of the underlying normalized wall clock time in simulator timestep u...
Definition: synchronizer.cc:57
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...
NS_LOG_COMPONENT_DEFINE("Synchronizer")
virtual void DoSetOrigin(uint64_t ns)=0
Establish a correspondence between a simulation time and a wall-clock (real) time.
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:93
bool Realtime(void)
Return true if this synchronizer is actually synchronizing to a realtime clock.
Definition: synchronizer.cc:50
uint64_t GetOrigin(void)
Retrieve the value of the origin of the simulation time in simulator timestep units.
Definition: synchronizer.cc:72
virtual uint64_t DoGetCurrentRealtime(void)=0
Retrieve the value of the origin of the underlying normalized wall clock time in simulator timestep u...
virtual void DoEventStart(void)=0
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:79
int64_t GetNanoSeconds(void) const
Definition: nstime.h:299
virtual void DoSignal(void)=0
Declaration of the method used to tell a possible simulator thread waiting in the DoSynchronize metho...
uint64_t m_simOriginNano
Definition: synchronizer.h:304
static TypeId GetTypeId(void)
Definition: synchronizer.cc:30
void SetOrigin(uint64_t ts)
Establish a correspondence between a simulation time and the synchronizer real time.
Definition: synchronizer.cc:64
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 (which can be steps of time in a user-specified unit) to a normalized t...
a base class which provides memory management and object aggregation
Definition: object.h:63
virtual uint64_t DoEventEnd(void)=0
a unique identifier for an interface.
Definition: type-id.h:49
TypeId SetParent(TypeId tid)
Definition: type-id.cc:611
virtual ~Synchronizer()
Definition: synchronizer.cc:44
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.