• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

taosdata / TDengine / #3811

01 Apr 2025 03:25AM UTC coverage: 45.391% (-0.04%) from 45.433%
#3811

push

travis-ci

happyguoxy
test:alter gcda dir

222193 of 489511 relevant lines covered (45.39%)

736813.35 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

88.11
/source/util/src/ttimer.c
1
/*
2
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
3
 *
4
 * This program is free software: you can use, redistribute, and/or modify
5
 * it under the terms of the GNU Affero General Public License, version 3
6
 * or later ("AGPL"), as published by the Free Software Foundation.
7
 *
8
 * This program is distributed in the hope that it will be useful, but WITHOUT
9
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10
 * FITNESS FOR A PARTICULAR PURPOSE.
11
 *
12
 * You should have received a copy of the GNU Affero General Public License
13
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
14
 */
15

16
#define _DEFAULT_SOURCE
17
#include "ttimer.h"
18
#include "taoserror.h"
19
#include "tdef.h"
20
#include "tlog.h"
21
#include "tsched.h"
22

23
// clang-format off
24
#define tmrFatal(...) { if (tmrDebugFlag & DEBUG_FATAL) { taosPrintLog("TMR FATAL ", DEBUG_FATAL, tmrDebugFlag, __VA_ARGS__); }}
25
#define tmrError(...) { if (tmrDebugFlag & DEBUG_ERROR) { taosPrintLog("TMR ERROR ", DEBUG_ERROR, tmrDebugFlag, __VA_ARGS__); }}
26
#define tmrWarn(...)  { if (tmrDebugFlag & DEBUG_WARN)  { taosPrintLog("TMR WARN  ", DEBUG_WARN,  tmrDebugFlag, __VA_ARGS__); }}
27
#define tmrInfo(...)  { if (tmrDebugFlag & DEBUG_INFO)  { taosPrintLog("TMR INFO  ", DEBUG_INFO,  tmrDebugFlag, __VA_ARGS__); }}
28
#define tmrDebug(...) { if (tmrDebugFlag & DEBUG_DEBUG) { taosPrintLog("TMR DEBUG ", DEBUG_DEBUG, tmrDebugFlag, __VA_ARGS__); }}
29
#define tmrTrace(...) { if (tmrDebugFlag & DEBUG_TRACE) { taosPrintLog("TMR TRACE ", DEBUG_TRACE, tmrDebugFlag, __VA_ARGS__); }}
30
// clang-format on
31

32
#define TIMER_STATE_WAITING  0
33
#define TIMER_STATE_EXPIRED  1
34
#define TIMER_STATE_STOPPED  2
35
#define TIMER_STATE_CANCELED 3
36

37
typedef union _tmr_ctrl_t {
38
  char label[16];
39
  struct {
40
    // pad to ensure 'next' is the end of this union
41
    char               padding[16 - sizeof(union _tmr_ctrl_t*)];
42
    union _tmr_ctrl_t* next;
43
  };
44
} tmr_ctrl_t;
45

46
typedef struct tmr_obj_t {
47
  uintptr_t         id;
48
  tmr_ctrl_t*       ctrl;
49
  struct tmr_obj_t* mnext;
50
  struct tmr_obj_t* prev;
51
  struct tmr_obj_t* next;
52
  uint16_t          slot;
53
  uint8_t           wheel;
54
  uint8_t           state;
55
  uint8_t           refCount;
56
  uint8_t           reserved1;
57
  uint16_t          reserved2;
58
  union {
59
    int64_t expireAt;
60
    int64_t executedBy;
61
  };
62
  TAOS_TMR_CALLBACK fp;
63
  void*             param;
64
  uint8_t           priority;
65
} tmr_obj_t;
66

67
typedef struct timer_list_t {
68
  int64_t    lockedBy;
69
  tmr_obj_t* timers;
70
} timer_list_t;
71

72
typedef struct timer_map_t {
73
  uint32_t      size;
74
  uint32_t      count;
75
  timer_list_t* slots;
76
} timer_map_t;
77

78
typedef struct time_wheel_t {
79
  TdThreadMutex mutex;
80
  int64_t       nextScanAt;
81
  uint32_t      resolution;
82
  uint16_t      size;
83
  uint16_t      index;
84
  tmr_obj_t**   slots;
85
} time_wheel_t;
86

87
static int32_t tsMaxTmrCtrl = TSDB_MAX_VNODES_PER_DB + 100;
88

89
static int32_t       tmrModuleInit = 0;
90
static TdThreadMutex tmrCtrlMutex;
91
static tmr_ctrl_t*   tmrCtrls;
92
static tmr_ctrl_t*   unusedTmrCtrl = NULL;
93
static void*         tmrQhandle;
94
static void*         tmrQhandleHigh;
95
static int32_t       numOfTmrCtrl = 0;
96

97
int32_t          taosTmrThreads = 1;
98
static uintptr_t nextTimerId = 0;
99

100
static time_wheel_t wheels[] = {
101
    {.resolution = MSECONDS_PER_TICK, .size = 4096},
102
    {.resolution = 1000, .size = 1024},
103
    {.resolution = 60000, .size = 1024},
104
};
105
static timer_map_t timerMap;
106

107
static uintptr_t getNextTimerId() {
136,693✔
108
  uintptr_t id;
109
  do {
110
    id = (uintptr_t)atomic_add_fetch_ptr((void**)&nextTimerId, 1);
136,693✔
111
  } while (id == 0);
136,695✔
112
  return id;
136,695✔
113
}
114

115
static void timerAddRef(tmr_obj_t* timer) {
407,926✔
116
  (void)atomic_add_fetch_8(&timer->refCount, 1);
407,926✔
117
}
407,928✔
118

119
static void timerDecRef(tmr_obj_t* timer) {
407,407✔
120
  if (atomic_sub_fetch_8(&timer->refCount, 1) == 0) {
407,407✔
121
    taosMemoryFree(timer);
136,364✔
122
  }
123
}
407,409✔
124

125
static void lockTimerList(timer_list_t* list) {
410,053✔
126
  int64_t tid = taosGetSelfPthreadId();
410,053✔
127
  int32_t i = 0;
410,053✔
128
  while (atomic_val_compare_exchange_64(&(list->lockedBy), 0, tid) != 0) {
410,053✔
129
    if (++i % 1000 == 0) {
×
130
      (void)sched_yield();
×
131
    }
132
  }
133
}
410,053✔
134

135
static void unlockTimerList(timer_list_t* list) {
410,054✔
136
  int64_t tid = taosGetSelfPthreadId();
410,054✔
137
  if (atomic_val_compare_exchange_64(&(list->lockedBy), tid, 0) != tid) {
410,053✔
138
    uError("%" PRId64 " trying to unlock a timer list not locked by current thread.", tid);
×
139
  }
140
}
410,054✔
141

142
static void addTimer(tmr_obj_t* timer) {
136,695✔
143
  timerAddRef(timer);
136,695✔
144
  timer->wheel = tListLen(wheels);
136,695✔
145

146
  uint32_t      idx = (uint32_t)(timer->id % timerMap.size);
136,695✔
147
  timer_list_t* list = timerMap.slots + idx;
136,695✔
148

149
  lockTimerList(list);
136,695✔
150
  timer->mnext = list->timers;
136,695✔
151
  list->timers = timer;
136,695✔
152
  unlockTimerList(list);
136,695✔
153
}
136,695✔
154

155
static tmr_obj_t* findTimer(uintptr_t id) {
209,408✔
156
  tmr_obj_t* timer = NULL;
209,408✔
157
  if (id > 0) {
209,408✔
158
    uint32_t      idx = (uint32_t)(id % timerMap.size);
136,852✔
159
    timer_list_t* list = timerMap.slots + idx;
136,852✔
160
    lockTimerList(list);
136,852✔
161
    for (timer = list->timers; timer != NULL; timer = timer->mnext) {
136,852✔
162
      if (timer->id == id) {
134,539✔
163
        timerAddRef(timer);
134,539✔
164
        break;
134,539✔
165
      }
166
    }
167
    unlockTimerList(list);
136,852✔
168
  }
169
  return timer;
209,408✔
170
}
171

172
static void removeTimer(uintptr_t id) {
136,507✔
173
  tmr_obj_t*    prev = NULL;
136,507✔
174
  uint32_t      idx = (uint32_t)(id % timerMap.size);
136,507✔
175
  timer_list_t* list = timerMap.slots + idx;
136,507✔
176
  lockTimerList(list);
136,507✔
177
  for (tmr_obj_t* p = list->timers; p != NULL; p = p->mnext) {
136,506✔
178
    if (p->id == id) {
136,506✔
179
      if (prev == NULL) {
136,506✔
180
        list->timers = p->mnext;
136,506✔
181
      } else {
182
        prev->mnext = p->mnext;
×
183
      }
184
      timerDecRef(p);
136,506✔
185
      break;
136,507✔
186
    }
187
    prev = p;
×
188
  }
189
  unlockTimerList(list);
136,507✔
190
}
136,507✔
191

192
static void addToWheel(tmr_obj_t* timer, uint32_t delay) {
136,694✔
193
  timerAddRef(timer);
136,694✔
194
  // select a wheel for the timer, we are not an accurate timer,
195
  // but the inaccuracy should not be too large.
196
  timer->wheel = tListLen(wheels) - 1;
136,695✔
197
  for (uint8_t i = 0; i < tListLen(wheels); i++) {
138,005✔
198
    time_wheel_t* wheel = wheels + i;
138,005✔
199
    if (delay < wheel->resolution * wheel->size) {
138,005✔
200
      timer->wheel = i;
136,695✔
201
      break;
136,695✔
202
    }
203
  }
204

205
  time_wheel_t* wheel = wheels + timer->wheel;
136,695✔
206
  timer->prev = NULL;
136,695✔
207
  timer->expireAt = taosGetMonotonicMs() + delay;
136,695✔
208

209
  (void)taosThreadMutexLock(&wheel->mutex);
136,694✔
210

211
  uint32_t idx = 0;
136,695✔
212
  if (timer->expireAt > wheel->nextScanAt) {
136,695✔
213
    // adjust delay according to next scan time of this wheel
214
    // so that the timer is not fired earlier than desired.
215
    delay = (uint32_t)(timer->expireAt - wheel->nextScanAt);
136,695✔
216
    idx = (delay + wheel->resolution - 1) / wheel->resolution;
136,695✔
217
  }
218

219
  timer->slot = (uint16_t)((wheel->index + idx + 1) % wheel->size);
136,695✔
220
  tmr_obj_t* p = wheel->slots[timer->slot];
136,695✔
221
  wheel->slots[timer->slot] = timer;
136,695✔
222
  timer->next = p;
136,695✔
223
  if (p != NULL) {
136,695✔
224
    p->prev = timer;
18,810✔
225
  }
226

227
  (void)taosThreadMutexUnlock(&wheel->mutex);
136,695✔
228
}
136,695✔
229

230
static bool removeFromWheel(tmr_obj_t* timer) {
72,524✔
231
  uint8_t wheelIdx = timer->wheel;
72,524✔
232
  if (wheelIdx >= tListLen(wheels)) {
72,524✔
233
    return false;
×
234
  }
235
  time_wheel_t* wheel = wheels + wheelIdx;
72,524✔
236

237
  bool removed = false;
72,524✔
238
  (void)taosThreadMutexLock(&wheel->mutex);
72,524✔
239
  // other thread may modify timer->wheel, check again.
240
  if (timer->wheel < tListLen(wheels)) {
72,524✔
241
    if (timer->prev != NULL) {
72,524✔
242
      timer->prev->next = timer->next;
275✔
243
    }
244
    if (timer->next != NULL) {
72,524✔
245
      timer->next->prev = timer->prev;
577✔
246
    }
247
    if (timer == wheel->slots[timer->slot]) {
72,524✔
248
      wheel->slots[timer->slot] = timer->next;
72,249✔
249
    }
250
    timer->wheel = tListLen(wheels);
72,524✔
251
    timer->next = NULL;
72,524✔
252
    timer->prev = NULL;
72,524✔
253
    timerDecRef(timer);
72,524✔
254
    removed = true;
72,524✔
255
  }
256
  (void)taosThreadMutexUnlock(&wheel->mutex);
72,524✔
257

258
  return removed;
72,524✔
259
}
260

261
static void processExpiredTimer(void* handle, void* arg) {
63,982✔
262
  tmr_obj_t* timer = (tmr_obj_t*)handle;
63,982✔
263
  timer->executedBy = taosGetSelfPthreadId();
63,982✔
264
  uint8_t state = atomic_val_compare_exchange_8(&timer->state, TIMER_STATE_WAITING, TIMER_STATE_EXPIRED);
63,982✔
265
  if (state == TIMER_STATE_WAITING) {
63,982✔
266
    const char* fmt = "%s timer[id=%" PRIuPTR ", fp=%p, param=%p] execution start.";
63,982✔
267
    tmrDebug(fmt, timer->ctrl->label, timer->id, timer->fp, timer->param);
63,982✔
268

269
    (*timer->fp)(timer->param, (tmr_h)timer->id);
63,982✔
270
    atomic_store_8(&timer->state, TIMER_STATE_STOPPED);
63,983✔
271

272
    fmt = "%s timer[id=%" PRIuPTR ", fp=%p, param=%p] execution end.";
63,983✔
273
    tmrDebug(fmt, timer->ctrl->label, timer->id, timer->fp, timer->param);
63,983✔
274
  }
275
  removeTimer(timer->id);
63,983✔
276
  timerDecRef(timer);
63,983✔
277
}
63,983✔
278

279
static void addToExpired(tmr_obj_t* head) {
6,206,763✔
280
  const char* fmt = "%s adding expired timer[id=%" PRIuPTR ", fp=%p, param=%p] to queue.";
6,206,763✔
281

282
  while (head != NULL) {
6,270,746✔
283
    uintptr_t  id = head->id;
63,983✔
284
    tmr_obj_t* next = head->next;
63,983✔
285
    tmrDebug(fmt, head->ctrl->label, id, head->fp, head->param);
63,983✔
286

287
    SSchedMsg schedMsg;
288
    schedMsg.fp = NULL;
63,983✔
289
    schedMsg.tfp = processExpiredTimer;
63,983✔
290
    schedMsg.msg = NULL;
63,983✔
291
    schedMsg.ahandle = head;
63,983✔
292
    schedMsg.thandle = NULL;
63,983✔
293
    uint8_t priority = head->priority;
63,983✔
294

295
    if (priority == 1) {
63,983✔
296
      if (taosScheduleTask(tmrQhandle, &schedMsg) != 0) {
59,517✔
297
        tmrError("%s failed to add expired timer[id=%" PRIuPTR "] to queue.", head->ctrl->label, id);
×
298
      }
299
    } else if (priority == 2) {
4,466✔
300
      if (taosScheduleTask(tmrQhandleHigh, &schedMsg) != 0) {
4,466✔
301
        tmrError("%s failed to add expired timer[id=%" PRIuPTR "] to high level queue.", head->ctrl->label, id);
×
302
      }
303
    }
304
    else{
305
      tmrError("%s invalid priority level %d for timer[id=%" PRIuPTR "].", head->ctrl->label, priority, id);
×
306
    }
307

308
    tmrDebug("timer[id=%" PRIuPTR "] has been added to queue priority:%d.", id, priority);
63,983✔
309
    head = next;
63,983✔
310
  }
311
}
6,206,763✔
312

313
static uintptr_t doStartTimer(tmr_obj_t* timer, TAOS_TMR_CALLBACK fp, int32_t mseconds, void* param, tmr_ctrl_t* ctrl,
136,692✔
314
                              uint8_t priority) {
315
  uintptr_t id = getNextTimerId();
136,692✔
316
  timer->id = id;
136,695✔
317
  timer->state = TIMER_STATE_WAITING;
136,695✔
318
  timer->fp = fp;
136,695✔
319
  timer->param = param;
136,695✔
320
  timer->ctrl = ctrl;
136,695✔
321
  timer->priority = priority;
136,695✔
322
  addTimer(timer);
136,695✔
323

324
  const char* fmt = "%s timer[id=%" PRIuPTR ", fp=%p, param=%p] started";
136,694✔
325
  tmrDebug(fmt, ctrl->label, timer->id, timer->fp, timer->param);
136,694✔
326

327
  if (mseconds == 0) {
136,694✔
328
    timer->wheel = tListLen(wheels);
×
329
    timerAddRef(timer);
×
330
    addToExpired(timer);
×
331
  } else {
332
    addToWheel(timer, mseconds);
136,694✔
333
  }
334

335
  // note: use `timer->id` here is unsafe as `timer` may already be freed
336
  return id;
136,695✔
337
}
338

339
tmr_h taosTmrStartPriority(TAOS_TMR_CALLBACK fp, int32_t mseconds, void* param, void* handle, uint8_t priority) {
136,561✔
340
  tmr_ctrl_t* ctrl = (tmr_ctrl_t*)handle;
136,561✔
341
  if (ctrl == NULL || ctrl->label[0] == 0) {
136,561✔
342
    return NULL;
9✔
343
  }
344

345
  tmr_obj_t* timer = (tmr_obj_t*)taosMemoryCalloc(1, sizeof(tmr_obj_t));
136,552✔
346
  if (timer == NULL) {
136,550✔
347
    tmrError("%s failed to allocated memory for new timer object.", ctrl->label);
×
348
    return NULL;
×
349
  }
350

351
  return (tmr_h)doStartTimer(timer, fp, mseconds, param, ctrl, priority);
136,550✔
352
}
353

354
tmr_h taosTmrStart(TAOS_TMR_CALLBACK fp, int32_t mseconds, void* param, void* handle) {
2,439✔
355
  return taosTmrStartPriority(fp, mseconds, param, handle, 1);
2,439✔
356
}
357

358
static void taosTimerLoopFunc(int32_t signo) {
2,068,927✔
359
  int64_t now = taosGetMonotonicMs();
2,068,927✔
360

361
  for (int32_t i = 0; i < tListLen(wheels); i++) {
8,275,690✔
362
    // `expried` is a temporary expire list.
363
    // expired timers are first add to this list, then move
364
    // to expired queue as a batch to improve performance.
365
    // note this list is used as a stack in this function.
366
    tmr_obj_t* expired = NULL;
6,206,769✔
367

368
    time_wheel_t* wheel = wheels + i;
6,206,769✔
369
    while (now >= wheel->nextScanAt) {
8,438,094✔
370
      (void)taosThreadMutexLock(&wheel->mutex);
2,231,331✔
371
      wheel->index = (wheel->index + 1) % wheel->size;
2,231,325✔
372
      tmr_obj_t* timer = wheel->slots[wheel->index];
2,231,325✔
373
      while (timer != NULL) {
2,295,308✔
374
        tmr_obj_t* next = timer->next;
63,983✔
375
        if (now < timer->expireAt) {
63,983✔
376
          timer = next;
×
377
          continue;
×
378
        }
379

380
        // remove from the wheel
381
        if (timer->prev == NULL) {
63,983✔
382
          wheel->slots[wheel->index] = next;
63,983✔
383
          if (next != NULL) {
63,983✔
384
            next->prev = NULL;
17,950✔
385
          }
386
        } else {
387
          timer->prev->next = next;
×
388
          if (next != NULL) {
×
389
            next->prev = timer->prev;
×
390
          }
391
        }
392
        timer->wheel = tListLen(wheels);
63,983✔
393

394
        // add to temporary expire list
395
        timer->next = expired;
63,983✔
396
        timer->prev = NULL;
63,983✔
397
        if (expired != NULL) {
63,983✔
398
          expired->prev = timer;
18,431✔
399
        }
400
        expired = timer;
63,983✔
401

402
        timer = next;
63,983✔
403
      }
404
      wheel->nextScanAt += wheel->resolution;
2,231,325✔
405
      (void)taosThreadMutexUnlock(&wheel->mutex);
2,231,325✔
406
    }
407

408
    addToExpired(expired);
6,206,763✔
409
  }
410
}
2,068,921✔
411

412
static bool doStopTimer(tmr_obj_t* timer, uint8_t state) {
134,538✔
413
  if (state == TIMER_STATE_WAITING) {
134,538✔
414
    bool reusable = false;
72,524✔
415
    if (removeFromWheel(timer)) {
72,524✔
416
      removeTimer(timer->id);
72,524✔
417
      // only safe to reuse the timer when timer is removed from the wheel.
418
      // we cannot guarantee the thread safety of the timr in all other cases.
419
      reusable = true;
72,524✔
420
    }
421
    const char* fmt = "%s timer[id=%" PRIuPTR ", fp=%p, param=%p] is cancelled.";
72,524✔
422
    tmrDebug(fmt, timer->ctrl->label, timer->id, timer->fp, timer->param);
72,524✔
423
    return reusable;
72,524✔
424
  }
425

426
  if (state != TIMER_STATE_EXPIRED) {
62,014✔
427
    // timer already stopped or cancelled, has nothing to do in this case
428
    return false;
×
429
  }
430

431
  if (timer->executedBy == taosGetSelfPthreadId()) {
62,014✔
432
    // taosTmrReset is called in the timer callback, should do nothing in this
433
    // case to avoid dead lock. note taosTmrReset must be the last statement
434
    // of the callback funtion, will be a bug otherwise.
435
    return false;
62,014✔
436
  }
437

438
  // timer callback is executing in another thread, we SHOULD wait it to stop,
439
  // BUT this may result in dead lock if current thread are holding a lock which
440
  // the timer callback need to acquire. so, we HAVE TO return directly.
441
  const char* fmt = "%s timer[id=%" PRIuPTR ", fp=%p, param=%p] is executing and cannot be stopped.";
1✔
442
  tmrDebug(fmt, timer->ctrl->label, timer->id, timer->fp, timer->param);
1✔
443
  return false;
1✔
444
}
445

446
bool taosTmrStop(tmr_h timerId) {
75,122✔
447
  uintptr_t id = (uintptr_t)timerId;
75,122✔
448

449
  tmr_obj_t* timer = findTimer(id);
75,122✔
450
  if (timer == NULL) {
75,122✔
451
    tmrDebug("timer[id=%" PRIuPTR "] does not exist", id);
2,741✔
452
    return false;
2,741✔
453
  }
454

455
  uint8_t state = atomic_val_compare_exchange_8(&timer->state, TIMER_STATE_WAITING, TIMER_STATE_CANCELED);
72,381✔
456
  (void)doStopTimer(timer, state);
72,381✔
457
  timerDecRef(timer);
72,381✔
458

459
  return state == TIMER_STATE_WAITING;
72,381✔
460
}
461

462
bool taosTmrStopA(tmr_h* timerId) {
1,030✔
463
  bool ret = taosTmrStop(*timerId);
1,030✔
464
  *timerId = NULL;
1,030✔
465
  return ret;
1,030✔
466
}
467

468
bool taosTmrIsStopped(tmr_h* timerId) {
21✔
469
  uintptr_t id = (uintptr_t)*timerId;
21✔
470

471
  tmr_obj_t* timer = findTimer(id);
21✔
472
  if (timer == NULL) {
21✔
473
    tmrDebug("timer[id=%" PRIuPTR "] does not exist", id);
21✔
474
    return true;
21✔
475
  }
476

477
  uint8_t state = atomic_load_8(&timer->state);
×
478

479
  return (state == TIMER_STATE_CANCELED) || (state == TIMER_STATE_STOPPED);
×
480
}
481

482
bool taosTmrResetPriority(TAOS_TMR_CALLBACK fp, int32_t mseconds, void* param, void* handle, tmr_h* pTmrId,
134,266✔
483
                          uint8_t priority) {
484
  tmr_ctrl_t* ctrl = (tmr_ctrl_t*)handle;
134,266✔
485
  if (ctrl == NULL || ctrl->label[0] == 0) {
134,266✔
486
    return false;
×
487
  }
488

489
  uintptr_t  id = (uintptr_t)*pTmrId;
134,266✔
490
  bool       stopped = false;
134,266✔
491
  tmr_obj_t* timer = findTimer(id);
134,266✔
492
  if (timer == NULL) {
134,266✔
493
    tmrDebug("%s timer[id=%" PRIuPTR "] does not exist", ctrl->label, id);
72,108✔
494
  } else {
495
    uint8_t state = atomic_val_compare_exchange_8(&timer->state, TIMER_STATE_WAITING, TIMER_STATE_CANCELED);
62,158✔
496
    if (!doStopTimer(timer, state)) {
62,158✔
497
      timerDecRef(timer);
62,015✔
498
      timer = NULL;
62,015✔
499
    }
500
    stopped = state == TIMER_STATE_WAITING;
62,158✔
501
  }
502

503
  if (timer == NULL) {
134,266✔
504
    *pTmrId = taosTmrStartPriority(fp, mseconds, param, handle, priority);
134,123✔
505
    if (NULL == *pTmrId) {
134,123✔
506
      stopped = true;
×
507
    }
508
    return stopped;
134,123✔
509
  }
510

511
  tmrDebug("%s timer[id=%" PRIuPTR "] is reused", ctrl->label, timer->id);
143✔
512

513
  // wait until there's no other reference to this timer,
514
  // so that we can reuse this timer safely.
515
  for (int32_t i = 1; atomic_load_8(&timer->refCount) > 1; ++i) {
143✔
516
    if (i % 1000 == 0) {
×
517
      (void)sched_yield();
×
518
    }
519
  }
520

521
  if (timer->refCount != 1) {
143✔
522
    uError("timer refCount=%d not expected 1", timer->refCount);
×
523
  }
524
  memset(timer, 0, sizeof(*timer));
143✔
525
  *pTmrId = (tmr_h)doStartTimer(timer, fp, mseconds, param, ctrl, priority);
143✔
526

527
  return stopped;
143✔
528
}
529

530
bool taosTmrReset(TAOS_TMR_CALLBACK fp, int32_t mseconds, void* param, void* handle, tmr_h* pTmrId) {
129,673✔
531
  return taosTmrResetPriority(fp, mseconds, param, handle, pTmrId, 1);
129,673✔
532
}
533

534
static int32_t taosTmrModuleInit(void) {
571✔
535
  tmrCtrls = taosMemoryMalloc(sizeof(tmr_ctrl_t) * tsMaxTmrCtrl);
571✔
536
  if (tmrCtrls == NULL) {
571✔
537
    tmrError("failed to allocate memory for timer controllers.");
×
538
    return terrno;
×
539
  }
540

541
  memset(&timerMap, 0, sizeof(timerMap));
571✔
542

543
  for (uint32_t i = 0; i < tsMaxTmrCtrl - 1; ++i) {
641,804✔
544
    tmr_ctrl_t* ctrl = tmrCtrls + i;
641,233✔
545
    ctrl->next = ctrl + 1;
641,233✔
546
  }
547
  (tmrCtrls + tsMaxTmrCtrl - 1)->next = NULL;
571✔
548
  unusedTmrCtrl = tmrCtrls;
571✔
549

550
  (void)taosThreadMutexInit(&tmrCtrlMutex, NULL);
571✔
551

552
  int64_t now = taosGetMonotonicMs();
571✔
553
  for (int32_t i = 0; i < tListLen(wheels); i++) {
2,284✔
554
    time_wheel_t* wheel = wheels + i;
1,713✔
555
    if (taosThreadMutexInit(&wheel->mutex, NULL) != 0) {
1,713✔
556
      tmrError("failed to create the mutex for wheel, reason:%s", strerror(ERRNO));
×
557
      return terrno;
×
558
    }
559
    wheel->nextScanAt = now + wheel->resolution;
1,713✔
560
    wheel->index = 0;
1,713✔
561
    wheel->slots = (tmr_obj_t**)taosMemoryCalloc(wheel->size, sizeof(tmr_obj_t*));
1,713✔
562
    if (wheel->slots == NULL) {
1,713✔
563
      tmrError("failed to allocate wheel slots");
×
564
      return terrno;
×
565
    }
566
    timerMap.size += wheel->size;
1,713✔
567
  }
568

569
  timerMap.count = 0;
571✔
570
  timerMap.slots = (timer_list_t*)taosMemoryCalloc(timerMap.size, sizeof(timer_list_t));
571✔
571
  if (timerMap.slots == NULL) {
571✔
572
    tmrError("failed to allocate hash map");
×
573
    return terrno;
×
574
  }
575

576
  tmrQhandle = taosInitScheduler(10000, taosTmrThreads, "tmr", NULL);
571✔
577
  tmrQhandleHigh = taosInitScheduler(10000, taosTmrThreads, "high-tmr", NULL);
571✔
578
  if (taosInitTimer(taosTimerLoopFunc, MSECONDS_PER_TICK) != 0) {
571✔
579
    tmrError("failed to initialize timer");
×
580
  }
581

582
  tmrDebug("timer module is initialized, number of threads: %d", taosTmrThreads);
571✔
583

584
  return 2;
571✔
585
}
586

587
static int32_t taosTmrInitModule(void) {
2,401✔
588
  if (atomic_load_32(&tmrModuleInit) == 2) {
2,401✔
589
    return 0;
1,830✔
590
  }
591

592
  if (atomic_load_32(&tmrModuleInit) < 0) {
571✔
593
    return -1;
×
594
  }
595

596
  while (true) {
597
    if (0 == atomic_val_compare_exchange_32(&tmrModuleInit, 0, 1)) {
1,142✔
598
      atomic_store_32(&tmrModuleInit, taosTmrModuleInit());
571✔
599
    } else if (atomic_load_32(&tmrModuleInit) < 0) {
571✔
600
      return -1;
×
601
    } else if (atomic_load_32(&tmrModuleInit) == 2) {
571✔
602
      return 0;
571✔
603
    } else {
604
      taosMsleep(1);
×
605
    }
606
  }
607

608
  return -1;
609
}
610

611
void* taosTmrInit(int32_t maxNumOfTmrs, int32_t resolution, int32_t longest, const char* label) {
2,401✔
612
  const char* ret = taosMonotonicInit();
2,401✔
613
  tmrDebug("ttimer monotonic clock source:%s", ret);
2,401✔
614

615
  if (taosTmrInitModule() < 0) {
2,401✔
616
    return NULL;
×
617
  }
618

619
  (void)taosThreadMutexLock(&tmrCtrlMutex);
2,401✔
620
  tmr_ctrl_t* ctrl = unusedTmrCtrl;
2,401✔
621
  if (ctrl != NULL) {
2,401✔
622
    unusedTmrCtrl = ctrl->next;
2,401✔
623
    numOfTmrCtrl++;
2,401✔
624
  }
625
  (void)taosThreadMutexUnlock(&tmrCtrlMutex);
2,401✔
626

627
  if (ctrl == NULL) {
2,401✔
628
    tmrError("%s too many timer controllers, failed to create timer controller.", label);
×
629
    terrno = TSDB_CODE_OUT_OF_MEMORY;
×
630
    return NULL;
×
631
  }
632

633
  tstrncpy(ctrl->label, label, sizeof(ctrl->label));
2,401✔
634

635
  tmrDebug("%s timer controller is initialized, number of timer controllers: %d.", label, numOfTmrCtrl);
2,401✔
636
  return ctrl;
2,401✔
637
}
638

639
void taosTmrCleanUp(void* handle) {
1,807✔
640
  tmr_ctrl_t* ctrl = (tmr_ctrl_t*)handle;
1,807✔
641
  if (ctrl == NULL || ctrl->label[0] == 0) {
1,807✔
642
    return;
×
643
  }
644

645
  tmrDebug("%s timer controller is cleaned up.", ctrl->label);
1,807✔
646
  ctrl->label[0] = 0;
1,807✔
647

648
  (void)taosThreadMutexLock(&tmrCtrlMutex);
1,807✔
649
  ctrl->next = unusedTmrCtrl;
1,807✔
650
  numOfTmrCtrl--;
1,807✔
651
  unusedTmrCtrl = ctrl;
1,807✔
652
  (void)taosThreadMutexUnlock(&tmrCtrlMutex);
1,807✔
653

654
  tmrDebug("time controller's tmr ctrl size:  %d", numOfTmrCtrl);
1,807✔
655
  if (numOfTmrCtrl <= 0) {
1,807✔
656
    taosUninitTimer();
102✔
657

658
    taosCleanUpScheduler(tmrQhandle);
102✔
659
    taosMemoryFreeClear(tmrQhandle);
102✔
660

661
    taosCleanUpScheduler(tmrQhandleHigh);
102✔
662
    taosMemoryFreeClear(tmrQhandleHigh);
102✔
663

664
    for (int32_t i = 0; i < tListLen(wheels); i++) {
408✔
665
      time_wheel_t* wheel = wheels + i;
306✔
666
      (void)taosThreadMutexDestroy(&wheel->mutex);
306✔
667
      taosMemoryFree(wheel->slots);
306✔
668
    }
669

670
    (void)taosThreadMutexDestroy(&tmrCtrlMutex);
102✔
671

672
    for (size_t i = 0; i < timerMap.size; i++) {
626,790✔
673
      timer_list_t* list = timerMap.slots + i;
626,688✔
674
      tmr_obj_t*    t = list->timers;
626,688✔
675
      while (t != NULL) {
626,725✔
676
        tmr_obj_t* next = t->mnext;
37✔
677
        taosMemoryFree(t);
37✔
678
        t = next;
37✔
679
      }
680
    }
681
    taosMemoryFree(timerMap.slots);
102✔
682
    taosMemoryFree(tmrCtrls);
102✔
683

684
    tmrCtrls = NULL;
102✔
685
    unusedTmrCtrl = NULL;
102✔
686
    atomic_store_32(&tmrModuleInit, 0);
102✔
687
  }
688
}
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2026 Coveralls, Inc