Outline ![]()
Files ![]()
loading...
SourceVu![]()
ESP-IDF Framework and Examples![]()
ESP-IDF![]()
components/openthread/openthread/src/core/common/timer.cpp
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
/*
* Copyright (c) 2016, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file implements a multiplexed timer service on top of the alarm abstraction.
*/
#include "timer.hpp"
#include "instance/instance.hpp"
namespace ot {
//---------------------------------------------------------------------------------------------------------------------
// `NextFireTime`
NextFireTime::NextFireTime(void)
: NextFireTime(TimerMilli::GetNow())
{
}
NextFireTime::NextFireTime(Time aNow)
: mNow(aNow)
, mNextTime(aNow.GetDistantFuture())
{
}
void NextFireTime::UpdateIfEarlier(Time aTime) { mNextTime = Min(mNextTime, Max(mNow, aTime)); }
//---------------------------------------------------------------------------------------------------------------------
// `Timer`
const Timer::Scheduler::AlarmApi TimerMilli::Scheduler::sAlarmMilliApi = {
&otPlatAlarmMilliStartAt,
&otPlatAlarmMilliStop,
&otPlatAlarmMilliGetNow,
};
bool Timer::DoesFireBefore(const Timer &aSecondTimer, Time aNow) const
{
// Indicates whether the fire time of this timer is strictly
// before the fire time of a second given timer.
bool retval;
bool isBeforeNow = (GetFireTime() < aNow);
// Check if one timer is before `now` and the other one is not.
if ((aSecondTimer.GetFireTime() < aNow) != isBeforeNow)
{
// One timer is before `now` and the other one is not, so if
// this timer's fire time is before `now` then the second fire
// time would be after `now` and this timer would fire before
// the second timer.
retval = isBeforeNow;
}
else
{
// Both timers are before `now` or both are after `now`. Either
// way the difference is guaranteed to be less than `kMaxDt` so
// we can safely compare the fire times directly.
retval = GetFireTime() < aSecondTimer.GetFireTime();
}
return retval;
}
//---------------------------------------------------------------------------------------------------------------------
// `TimerMilli`
void TimerMilli::Start(uint32_t aDelay) { StartAt(GetNow(), aDelay); }
void TimerMilli::StartAt(TimeMilli aStartTime, uint32_t aDelay)
{
OT_ASSERT(aDelay <= kMaxDelay);
FireAt(aStartTime + aDelay);
}
void TimerMilli::FireAt(TimeMilli aFireTime)
{
mFireTime = aFireTime;
Get<Scheduler>().Add(*this);
}
void TimerMilli::FireAt(const NextFireTime &aNextFireTime)
{
if (aNextFireTime.IsSet())
{
FireAt(aNextFireTime.GetNextTime());
}
else
{
Stop();
}
}
void TimerMilli::FireAtIfEarlier(TimeMilli aFireTime)
{
if (!IsRunning() || (mFireTime > aFireTime))
{
FireAt(aFireTime);
}
}
void TimerMilli::FireAtIfEarlier(const NextFireTime &aNextFireTime)
{
if (aNextFireTime.IsSet())
{
FireAtIfEarlier(aNextFireTime.GetNextTime());
}
}
void TimerMilli::Stop(void) { Get<Scheduler>().Remove(*this); }
void TimerMilli::RemoveAll(Instance &aInstance) { aInstance.Get<Scheduler>().RemoveAll(); }
//---------------------------------------------------------------------------------------------------------------------
// `Timer::Scheduler`
void Timer::Scheduler::Add(Timer &aTimer, const AlarmApi &aAlarmApi)
{
Timer *prev = nullptr;
Time now(aAlarmApi.AlarmGetNow());
Remove(aTimer, aAlarmApi);
for (Timer &cur : mTimerList)
{
if (aTimer.DoesFireBefore(cur, now))
{
break;
}
prev = &cur;
}
if (prev == nullptr)
{
mTimerList.Push(aTimer);
SetAlarm(aAlarmApi);
}
else
{
mTimerList.PushAfter(aTimer, *prev);
}
}
void Timer::Scheduler::Remove(Timer &aTimer, const AlarmApi &aAlarmApi)
{
VerifyOrExit(aTimer.IsRunning());
if (mTimerList.GetHead() == &aTimer)
{
mTimerList.Pop();
SetAlarm(aAlarmApi);
}
else
{
IgnoreError(mTimerList.Remove(aTimer));
}
aTimer.SetNext(&aTimer);
exit:
return;
}
void Timer::Scheduler::SetAlarm(const AlarmApi &aAlarmApi)
{
if (mTimerList.IsEmpty())
{
aAlarmApi.AlarmStop(&GetInstance());
}
else
{
Timer *timer = mTimerList.GetHead();
Time now(aAlarmApi.AlarmGetNow());
uint32_t remaining;
remaining = (now < timer->mFireTime) ? (timer->mFireTime - now) : 0;
aAlarmApi.AlarmStartAt(&GetInstance(), now.GetValue(), remaining);
}
}
void Timer::Scheduler::ProcessTimers(const AlarmApi &aAlarmApi)
{
Timer *timer = mTimerList.GetHead();
if (timer)
{
Time now(aAlarmApi.AlarmGetNow());
if (now >= timer->mFireTime)
{
Remove(*timer, aAlarmApi); // `Remove()` will `SetAlarm` for next timer if there is any.
timer->Fired();
ExitNow();
}
}
SetAlarm(aAlarmApi);
exit:
return;
}
void Timer::Scheduler::RemoveAll(const AlarmApi &aAlarmApi)
{
Timer *timer;
while ((timer = mTimerList.Pop()) != nullptr)
{
timer->SetNext(timer);
}
SetAlarm(aAlarmApi);
}
extern "C" void otPlatAlarmMilliFired(otInstance *aInstance)
{
VerifyOrExit(otInstanceIsInitialized(aInstance));
AsCoreType(aInstance).Get<TimerMilli::Scheduler>().ProcessTimers();
exit:
return;
}
//---------------------------------------------------------------------------------------------------------------------
// `TimerMicro`
#if OPENTHREAD_CONFIG_PLATFORM_USEC_TIMER_ENABLE
const Timer::Scheduler::AlarmApi TimerMicro::Scheduler::sAlarmMicroApi = {
&otPlatAlarmMicroStartAt,
&otPlatAlarmMicroStop,
&otPlatAlarmMicroGetNow,
};
void TimerMicro::Start(uint32_t aDelay) { StartAt(GetNow(), aDelay); }
void TimerMicro::StartAt(TimeMicro aStartTime, uint32_t aDelay)
{
OT_ASSERT(aDelay <= kMaxDelay);
FireAt(aStartTime + aDelay);
}
void TimerMicro::FireAt(TimeMicro aFireTime)
{
mFireTime = aFireTime;
Get<Scheduler>().Add(*this);
}
void TimerMicro::Stop(void) { Get<Scheduler>().Remove(*this); }
void TimerMicro::RemoveAll(Instance &aInstance) { aInstance.Get<Scheduler>().RemoveAll(); }
extern "C" void otPlatAlarmMicroFired(otInstance *aInstance)
{
VerifyOrExit(otInstanceIsInitialized(aInstance));
AsCoreType(aInstance).Get<TimerMicro::Scheduler>().ProcessTimers();
exit:
return;
}
#endif // OPENTHREAD_CONFIG_PLATFORM_USEC_TIMER_ENABLE
} // namespace ot
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.