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

taosdata / TDengine / #3523

06 Nov 2024 02:29AM UTC coverage: 55.861% (-2.4%) from 58.216%
#3523

push

travis-ci

web-flow
Merge pull request #28551 from taosdata/feat/TS-5215-2

test(blob): testing & fixes for blob

106075 of 245834 branches covered (43.15%)

Branch coverage included in aggregate %.

0 of 15 new or added lines in 2 files covered. (0.0%)

17003 existing lines in 254 files now uncovered.

181910 of 269703 relevant lines covered (67.45%)

1527639.59 hits per line

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

53.45
/source/libs/stream/src/streamTaskSm.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
#include "streamInt.h"
17
#include "streamsm.h"
18
#include "tmisce.h"
19
#include "tstream.h"
20
#include "ttimer.h"
21
#include "wal.h"
22

23
static int32_t initRes = 0;
24

25
#define GET_EVT_NAME(_ev)  (StreamTaskEventList[(_ev)].name)
26
#define CHECK_RET_VAL(_exec)             \
27
  do {                                   \
28
    void* p = (_exec);                   \
29
    if (p == NULL) {                     \
30
      initRes = TSDB_CODE_OUT_OF_MEMORY; \
31
      return;                            \
32
    }                                    \
33
  } while (0);
34

35
SStreamTaskState StreamTaskStatusList[9] = {
36
    {.state = TASK_STATUS__READY, .name = "ready"},
37
    {.state = TASK_STATUS__DROPPING, .name = "dropped"},
38
    {.state = TASK_STATUS__UNINIT, .name = "uninit"},
39
    {.state = TASK_STATUS__STOP, .name = "stop"},
40
    {.state = TASK_STATUS__SCAN_HISTORY, .name = "scan-history"},
41
    {.state = TASK_STATUS__HALT, .name = "halt"},
42
    {.state = TASK_STATUS__PAUSE, .name = "paused"},
43
    {.state = TASK_STATUS__CK, .name = "checkpoint"},
44
};
45

46
typedef struct SStreamEventInfo {
47
  EStreamTaskEvent event;
48
  const char*      name;
49
} SStreamEventInfo;
50

51
SStreamEventInfo StreamTaskEventList[12] = {
52
    {.event = 0, .name = ""},  // dummy event, place holder
53
    {.event = TASK_EVENT_INIT, .name = "initialize"},
54
    {.event = TASK_EVENT_INIT_SCANHIST, .name = "scan-history-init"},
55
    {.event = TASK_EVENT_SCANHIST_DONE, .name = "scan-history-completed"},
56
    {.event = TASK_EVENT_STOP, .name = "stopping"},
57
    {.event = TASK_EVENT_GEN_CHECKPOINT, .name = "checkpoint"},
58
    {.event = TASK_EVENT_CHECKPOINT_DONE, .name = "checkpoint-done"},
59
    {.event = TASK_EVENT_PAUSE, .name = "pausing"},
60
    {.event = TASK_EVENT_RESUME, .name = "resuming"},
61
    {.event = TASK_EVENT_HALT, .name = "halting"},
62
    {.event = TASK_EVENT_DROPPING, .name = "dropping"},
63
};
64

65
static TdThreadOnce streamTaskStateMachineInit = PTHREAD_ONCE_INIT;
66
static SArray*      streamTaskSMTrans = NULL;
67

68
static int32_t streamTaskInitStatus(SStreamTask* pTask);
69
static int32_t streamTaskKeepCurrentVerInWal(SStreamTask* pTask);
70
static int32_t initStateTransferTable();
71
static void    doInitStateTransferTable(void);
72

73
static STaskStateTrans createStateTransform(ETaskStatus current, ETaskStatus next, EStreamTaskEvent event,
74
                                            __state_trans_fn fn, __state_trans_succ_fn succFn,
75
                                            SFutureHandleEventInfo* pEventInfo);
76

77
static int32_t dummyFn(SStreamTask* UNUSED_PARAM(p)) { return TSDB_CODE_SUCCESS; }
22,771✔
78

UNCOV
79
static int32_t attachWaitedEvent(SStreamTask* pTask, SFutureHandleEventInfo* pEvtInfo) {
×
UNCOV
80
  char* p = streamTaskGetStatus(pTask).name;
×
81

UNCOV
82
  stDebug("s-task:%s status:%s attach event:%s required status:%s, since not allowed to handle it", pTask->id.idStr, p,
×
83
          GET_EVT_NAME(pEvtInfo->event), StreamTaskStatusList[pEvtInfo->status].name);
84

UNCOV
85
  SArray* pList = pTask->status.pSM->pWaitingEventList;
×
86

UNCOV
87
  void* px = taosArrayPush(pList, pEvtInfo);
×
UNCOV
88
  if (px == NULL) {
×
89
    stError("s-task:%s failed to add into waiting list, total waiting events:%d, code: out of memory", pTask->id.idStr,
×
90
            (int32_t)taosArrayGetSize(pList));
91
    return terrno;
×
92
  } else {
UNCOV
93
    stDebug("s-task:%s add into waiting list, total waiting events:%d", pTask->id.idStr,
×
94
            (int32_t)taosArrayGetSize(pList));
UNCOV
95
    return TSDB_CODE_SUCCESS;
×
96
  }
97
}
98

99
int32_t streamTaskInitStatus(SStreamTask* pTask) {
5,403✔
100
  pTask->execInfo.checkTs = taosGetTimestampMs();
5,403✔
101
  stDebug("s-task:%s start init, and check downstream tasks, set the init ts:%" PRId64, pTask->id.idStr,
5,403✔
102
          pTask->execInfo.checkTs);
103

104
  streamTaskSendCheckMsg(pTask);
5,403✔
105
  return 0;
5,403✔
106
}
107

108
int32_t streamTaskKeepCurrentVerInWal(SStreamTask* pTask) {
1,391✔
109
  if (!HAS_RELATED_FILLHISTORY_TASK(pTask)) {
1,391!
110
    stError("s-task:%s no related fill-history task, since it may have been dropped already", pTask->id.idStr);
×
111
  }
112

113
  if (pTask->info.taskLevel == TASK_LEVEL__SOURCE) {
1,389✔
114
    pTask->hTaskInfo.haltVer = walReaderGetCurrentVer(pTask->exec.pWalReader);
713✔
115
    if (pTask->hTaskInfo.haltVer == -1) {
713✔
116
      pTask->hTaskInfo.haltVer = pTask->dataRange.range.minVer;
201✔
117
    }
118
  }
119

120
  return TSDB_CODE_SUCCESS;
1,389✔
121
}
122

123
// todo check rsp code for handle Event:TASK_EVENT_SCANHIST_DONE
124
static bool isInvalidStateTransfer(ETaskStatus state, const EStreamTaskEvent event) {
×
125
  if (event == TASK_EVENT_INIT || event == TASK_EVENT_INIT_SCANHIST) {
×
126
    return (state != TASK_STATUS__UNINIT);
×
127
  }
128

129
  if (event == TASK_EVENT_SCANHIST_DONE) {
×
130
    return (state != TASK_STATUS__SCAN_HISTORY);
×
131
  }
132

133
  if (event == TASK_EVENT_GEN_CHECKPOINT) {
×
134
    return (state != TASK_STATUS__READY);
×
135
  }
136

137
  if (event == TASK_EVENT_CHECKPOINT_DONE) {
×
138
    return (state != TASK_STATUS__CK);
×
139
  }
140

141
  // todo refactor later
142
  if (event == TASK_EVENT_RESUME) {
×
143
    return true;
×
144
  }
145

146
  if (event == TASK_EVENT_HALT) {
×
147
    if (state == TASK_STATUS__DROPPING || state == TASK_STATUS__UNINIT || state == TASK_STATUS__STOP ||
×
148
        state == TASK_STATUS__SCAN_HISTORY) {
149
      return true;
×
150
    }
151
  }
152

153
  return false;
×
154
}
155

156
// todo optimize the perf of find the trans objs by using hash table
157
static STaskStateTrans* streamTaskFindTransform(ETaskStatus state, const EStreamTaskEvent event) {
17,518✔
158
  int32_t numOfTrans = taosArrayGetSize(streamTaskSMTrans);
17,518✔
159
  for (int32_t i = 0; i < numOfTrans; ++i) {
204,173✔
160
    STaskStateTrans* pTrans = taosArrayGet(streamTaskSMTrans, i);
204,049✔
161
    if (pTrans == NULL) {
204,131!
162
      continue;
×
163
    }
164

165
    if (pTrans->state.state == state && pTrans->event == event) {
204,131✔
166
      return pTrans;
17,473✔
167
    }
168
  }
169

170
  if (isInvalidStateTransfer(state, event)) {
124!
171
    stError("invalid state transfer %d, handle event:%s", state, GET_EVT_NAME(event));
×
172
  }
173

174
  return NULL;
×
175
}
176

177
static int32_t doHandleWaitingEvent(SStreamTaskSM* pSM, const char* pEventName, SStreamTask* pTask) {
×
178
  int32_t code = TSDB_CODE_SUCCESS;
×
179
  int64_t el = (taosGetTimestampMs() - pSM->startTs);
×
180
  stDebug("s-task:%s handle event:%s completed, elapsed time:%" PRId64 "ms state:%s -> %s", pTask->id.idStr,
×
181
          pEventName, el, pSM->prev.state.name, pSM->current.name);
182

183
  SFutureHandleEventInfo* pEvtInfo = taosArrayGet(pSM->pWaitingEventList, 0);
×
184
  if (pEvtInfo == NULL) {
×
185
    return terrno;
×
186
  }
187

188
  // OK, let's handle the waiting event, since the task has reached the required status now
189
  if (pSM->current.state == pEvtInfo->status) {
×
190
    stDebug("s-task:%s handle the event:%s in waiting list, state:%s", pTask->id.idStr,
×
191
            GET_EVT_NAME(pEvtInfo->event), pSM->current.name);
192

193
    // remove it
194
    void* px = taosArrayPop(pSM->pWaitingEventList);
×
195

196
    STaskStateTrans* pNextTrans = streamTaskFindTransform(pSM->current.state, pEvtInfo->event);
×
197

198
    pSM->pActiveTrans = pNextTrans;
×
199
    pSM->startTs = taosGetTimestampMs();
×
200
    streamMutexUnlock(&pTask->lock);
×
201

202
    code = pNextTrans->pAction(pSM->pTask);
×
203
    if (pNextTrans->autoInvokeEndFn) {
×
204
      return streamTaskOnHandleEventSuccess(pSM, pNextTrans->event, pEvtInfo->callBackFn, pEvtInfo->pParam);
×
205
    } else {
206
      return code;
×
207
    }
208
  } else {
209
    streamMutexUnlock(&pTask->lock);
×
210
    stDebug("s-task:%s state:%s event:%s in waiting list, req state:%s not fulfilled, put it back", pTask->id.idStr,
×
211
            pSM->current.name, GET_EVT_NAME(pEvtInfo->event),
212
            StreamTaskStatusList[pEvtInfo->status].name);
213
  }
214

215
  return code;
×
216
}
217

UNCOV
218
static int32_t removeEventInWaitingList(SStreamTask* pTask, EStreamTaskEvent event) {
×
UNCOV
219
  SStreamTaskSM* pSM = pTask->status.pSM;
×
UNCOV
220
  bool           removed = false;
×
UNCOV
221
  int32_t        num = taosArrayGetSize(pSM->pWaitingEventList);
×
222

UNCOV
223
  for (int32_t i = 0; i < num; ++i) {
×
UNCOV
224
    SFutureHandleEventInfo* pInfo = taosArrayGet(pSM->pWaitingEventList, i);
×
UNCOV
225
    if (pInfo == NULL) {
×
226
      continue;
×
227
    }
228

UNCOV
229
    if (pInfo->event == event) {
×
UNCOV
230
      taosArrayRemove(pSM->pWaitingEventList, i);
×
UNCOV
231
      stDebug("s-task:%s %s event in waiting list not be handled yet, remove it from waiting list, remaining events:%d",
×
232
              pTask->id.idStr, GET_EVT_NAME(pInfo->event), num - 1);
UNCOV
233
      removed = true;
×
UNCOV
234
      break;
×
235
    }
236
  }
237

UNCOV
238
  if (!removed) {
×
239
    stDebug("s-task:%s failed to remove event:%s in waiting list", pTask->id.idStr, GET_EVT_NAME(event));
×
240
  }
241

UNCOV
242
  return TSDB_CODE_SUCCESS;
×
243
}
244

245
int32_t streamTaskRestoreStatus(SStreamTask* pTask) {
116✔
246
  SStreamTaskSM* pSM = pTask->status.pSM;
116✔
247
  int32_t        code = 0;
116✔
248

249
  streamMutexLock(&pTask->lock);
116✔
250

251
  if (pSM->current.state == TASK_STATUS__PAUSE && pSM->pActiveTrans == NULL) {
238!
252
    SStreamTaskState state = pSM->current;
120✔
253
    pSM->current = pSM->prev.state;
120✔
254

255
    pSM->prev.state = state;
120✔
256
    pSM->prev.evt = 0;
120✔
257

258
    pSM->startTs = taosGetTimestampMs();
119✔
259

260
    if (taosArrayGetSize(pSM->pWaitingEventList) > 0) {
119!
261
      stDebug("s-task:%s restore status, %s -> %s, and then handle waiting event", pTask->id.idStr,
×
262
              pSM->prev.state.name, pSM->current.name);
263
      code = doHandleWaitingEvent(pSM, "restore-pause/halt", pTask);
×
264
    } else {
265
      stDebug("s-task:%s restore status, %s -> %s", pTask->id.idStr, pSM->prev.state.name, pSM->current.name);
116✔
266
    }
267
  } else {
UNCOV
268
    code = removeEventInWaitingList(pTask, TASK_EVENT_PAUSE);  // ignore the return value,
×
UNCOV
269
    if (code) {
×
270
      stError("s-task:%s failed to remove event in waiting list, code:%s", pTask->id.idStr, tstrerror(code));
×
271
    }
272

UNCOV
273
    code = TSDB_CODE_FAILED;  // failed to restore the status, since it is not in pause status
×
274
  }
275

276
  streamMutexUnlock(&pTask->lock);
118✔
277
  return code;
119✔
278
}
279

280
int32_t streamCreateStateMachine(SStreamTask* pTask) {
10,839✔
281
  int32_t code = initStateTransferTable();
10,839✔
282
  if (code != TSDB_CODE_SUCCESS) {
10,832!
283
    return code;
×
284
  }
285

286
  const char* id = pTask->id.idStr;
10,832✔
287

288
  SStreamTaskSM* pSM = taosMemoryCalloc(1, sizeof(SStreamTaskSM));
10,832✔
289
  if (pSM == NULL) {
10,850!
290
    stError("s-task:%s failed to create task stateMachine, size:%d, code:%s", id, (int32_t)sizeof(SStreamTaskSM),
×
291
            tstrerror(terrno));
292
    return terrno;
×
293
  }
294

295
  pSM->pTask = pTask;
10,850✔
296
  pSM->pWaitingEventList = taosArrayInit(4, sizeof(SFutureHandleEventInfo));
10,850✔
297
  if (pSM->pWaitingEventList == NULL) {
10,848!
298
    taosMemoryFree(pSM);
×
299
    stError("s-task:%s failed to create task stateMachine, size:%d, code:%s", id, (int32_t)sizeof(SStreamTaskSM),
×
300
            tstrerror(terrno));
301
    return terrno;
×
302
  }
303

304
  // set the initial state for the state-machine of stream task
305
  pSM->current = StreamTaskStatusList[TASK_STATUS__UNINIT];
10,848✔
306
  pSM->startTs = taosGetTimestampMs();
10,843✔
307

308
  pTask->status.pSM = pSM;
10,843✔
309
  return TSDB_CODE_SUCCESS;
10,843✔
310
}
311

312
void streamDestroyStateMachine(SStreamTaskSM* pSM) {
23,358✔
313
  if (pSM == NULL) {
23,358✔
314
    return;
12,578✔
315
  }
316

317
  taosArrayDestroy(pSM->pWaitingEventList);
10,780✔
318
  taosMemoryFree(pSM);
10,785✔
319
}
320

321
static int32_t doHandleEvent(SStreamTaskSM* pSM, EStreamTaskEvent event, STaskStateTrans* pTrans) {
11,624✔
322
  SStreamTask* pTask = pSM->pTask;
11,624✔
323
  const char*  id = pTask->id.idStr;
11,624✔
324
  int32_t      code = 0;
11,624✔
325

326
  if (pTrans->attachEvent.event != 0) {
11,624!
327
    code = attachWaitedEvent(pTask, &pTrans->attachEvent);
×
328
    streamMutexUnlock(&pTask->lock);
×
329
    if (code) {
×
330
      return code;
×
331
    }
332

333
    while (1) {
×
334
      // wait for the task to be here
335
      streamMutexLock(&pTask->lock);
×
336
      ETaskStatus s = streamTaskGetStatus(pTask).state;
×
337
      streamMutexUnlock(&pTask->lock);
×
338

339
      if ((s == pTrans->next.state) && (pSM->prev.evt == pTrans->event)) {// this event has been handled already
×
340
        stDebug("s-task:%s attached event:%s handled", id, GET_EVT_NAME(pTrans->event));
×
341
        return TSDB_CODE_SUCCESS;
×
342
      } else if (s != TASK_STATUS__DROPPING && s != TASK_STATUS__STOP && s != TASK_STATUS__UNINIT) {
×
343
        stDebug("s-task:%s not handle event:%s yet, wait for 100ms and recheck", id, GET_EVT_NAME(event));
×
344
        taosMsleep(100);
×
345
      } else {
346
        stDebug("s-task:%s is dropped or stopped already, not wait.", id);
×
347
        return TSDB_CODE_STREAM_INVALID_STATETRANS;
×
348
      }
349
    }
350

351
  } else {  // override current active trans
352
    pSM->pActiveTrans = pTrans;
11,624✔
353
    pSM->startTs = taosGetTimestampMs();
11,637✔
354
    streamMutexUnlock(&pTask->lock);
11,637✔
355

356
    code = pTrans->pAction(pTask);
11,650✔
357

358
    if (pTrans->autoInvokeEndFn) {
11,651✔
359
      int32_t c = streamTaskOnHandleEventSuccess(pSM, event, NULL, NULL);
6,248✔
360
      if (code == TSDB_CODE_SUCCESS) {
6,264!
361
        code = c;
6,265✔
362
      }
363
    }
364
  }
365

366
  return code;
11,667✔
367
}
368

369
static int32_t doHandleEventAsync(SStreamTaskSM* pSM, EStreamTaskEvent event, STaskStateTrans* pTrans, __state_trans_user_fn callbackFn, void* param) {
5,822✔
370
  SStreamTask* pTask = pSM->pTask;
5,822✔
371
  int32_t code = 0;
5,822✔
372

373
  if (pTrans->attachEvent.event != 0) {
5,822!
UNCOV
374
    SFutureHandleEventInfo info = pTrans->attachEvent;
×
UNCOV
375
    info.pParam = param;
×
UNCOV
376
    info.callBackFn = callbackFn;
×
377

UNCOV
378
    code = attachWaitedEvent(pTask, &info);
×
UNCOV
379
    streamMutexUnlock(&pTask->lock);
×
380
  } else {  // override current active trans
381
    pSM->pActiveTrans = pTrans;
5,822✔
382
    pSM->startTs = taosGetTimestampMs();
5,838✔
383
    streamMutexUnlock(&pTask->lock);
5,838✔
384

385
    code = pTrans->pAction(pTask);
5,861✔
386
    // todo handle error code;
387

388
    if (pTrans->autoInvokeEndFn) {
5,860!
389
      int32_t c = streamTaskOnHandleEventSuccess(pSM, event, callbackFn, param);
5,860✔
390
      if (code == TSDB_CODE_SUCCESS) {
5,859✔
391
        code = c;
5,856✔
392
      }
393
    }
394
  }
395

396
  return code;
5,859✔
397
}
398

399
int32_t streamTaskHandleEvent(SStreamTaskSM* pSM, EStreamTaskEvent event) {
11,666✔
400
  int32_t          code = TSDB_CODE_SUCCESS;
11,666✔
401
  SStreamTask*     pTask = pSM->pTask;
11,666✔
402
  STaskStateTrans* pTrans = NULL;
11,666✔
403

404
  while (1) {
405
    streamMutexLock(&pTask->lock);
11,666✔
406

407
    if (pSM->pActiveTrans != NULL && pSM->pActiveTrans->autoInvokeEndFn) {
11,680!
408
      EStreamTaskEvent evt = pSM->pActiveTrans->event;
×
409
      streamMutexUnlock(&pTask->lock);
×
410

411
      stDebug("s-task:%s status:%s handling event:%s by another thread, wait for 100ms and check if completed",
×
412
              pTask->id.idStr, pSM->current.name, GET_EVT_NAME(evt));
413
      taosMsleep(100);
×
414
    } else {
415
      // no active event trans exists, handle this event directly
416
      pTrans = streamTaskFindTransform(pSM->current.state, event);
11,680✔
417
      if (pTrans == NULL) {
11,634!
418
        stDebug("s-task:%s failed to handle event:%s, status:%s", pTask->id.idStr, GET_EVT_NAME(event),
×
419
                pSM->current.name);
420
        streamMutexUnlock(&pTask->lock);
×
421
        return TSDB_CODE_STREAM_INVALID_STATETRANS;
×
422
      }
423

424
      if (pSM->pActiveTrans != NULL) {
11,634✔
425
        // not allowed concurrently initialization
426
        if (event == TASK_EVENT_INIT && pSM->pActiveTrans->event == TASK_EVENT_INIT) {
6!
427
          streamMutexUnlock(&pTask->lock);
×
428
          stError("s-task:%s already in handling init procedure, handle this init event failed", pTask->id.idStr);
×
429
          return TSDB_CODE_STREAM_CONFLICT_EVENT;
×
430
        }
431

432
        // currently in some state transfer procedure, not auto invoke transfer, abort it
433
        stDebug("s-task:%s event:%s handle procedure quit, status %s -> %s failed, handle event %s now",
6!
434
                pTask->id.idStr, GET_EVT_NAME(pSM->pActiveTrans->event), pSM->current.name,
435
                pSM->pActiveTrans->next.name, GET_EVT_NAME(event));
436
      }
437

438
      code = doHandleEvent(pSM, event, pTrans);
11,634✔
439
      break;
11,668✔
440
    }
441
  }
442

443
  return code;
11,668✔
444
}
445

446
int32_t streamTaskHandleEventAsync(SStreamTaskSM* pSM, EStreamTaskEvent event, __state_trans_user_fn callbackFn, void* param) {
5,859✔
447
  int32_t          code = TSDB_CODE_SUCCESS;
5,859✔
448
  SStreamTask*     pTask = pSM->pTask;
5,859✔
449
  STaskStateTrans* pTrans = NULL;
5,859✔
450

451
  while (1) {
452
    streamMutexLock(&pTask->lock);
5,859✔
453

454
    if (pSM->pActiveTrans != NULL && pSM->pActiveTrans->autoInvokeEndFn) {
5,870!
455
      EStreamTaskEvent evt = pSM->pActiveTrans->event;
×
456
      streamMutexUnlock(&pTask->lock);
×
457

458
      stDebug("s-task:%s status:%s handling event:%s by some other thread, wait for 100ms and check if completed",
×
459
              pTask->id.idStr, pSM->current.name, GET_EVT_NAME(evt));
460
      taosMsleep(100);
×
461
    } else {
462
      // no active event trans exists, handle this event directly
463
      pTrans = streamTaskFindTransform(pSM->current.state, event);
5,870✔
464
      if (pTrans == NULL) {
5,839!
465
        stDebug("s-task:%s failed to handle event:%s, status:%s", pTask->id.idStr, GET_EVT_NAME(event), pSM->current.name);
×
466
        streamMutexUnlock(&pTask->lock);
×
467
        return TSDB_CODE_STREAM_INVALID_STATETRANS;
×
468
      }
469

470
      if (pSM->pActiveTrans != NULL) {
5,839✔
471
        // currently in some state transfer procedure, not auto invoke transfer, quit from this procedure
472
        stDebug("s-task:%s event:%s handle procedure quit, status %s -> %s failed, handle event %s now",
14✔
473
                pTask->id.idStr, GET_EVT_NAME(pSM->pActiveTrans->event), pSM->current.name,
474
                pSM->pActiveTrans->next.name, GET_EVT_NAME(event));
475
      }
476

477
      code = doHandleEventAsync(pSM, event, pTrans, callbackFn, param);
5,839✔
478
      break;
5,859✔
479
    }
480
  }
481

482
  return code;
5,859✔
483
}
484

485
static void keepPrevInfo(SStreamTaskSM* pSM) {
17,471✔
486
  STaskStateTrans* pTrans = pSM->pActiveTrans;
17,471✔
487

488
  pSM->prev.state = pSM->current;
17,471✔
489
  pSM->prev.evt = pTrans->event;
17,471✔
490
}
17,471✔
491

492
int32_t streamTaskOnHandleEventSuccess(SStreamTaskSM* pSM, EStreamTaskEvent event, __state_trans_user_fn callbackFn, void* param) {
17,492✔
493
  SStreamTask* pTask = pSM->pTask;
17,492✔
494
  const char*  id = pTask->id.idStr;
17,492✔
495
  int32_t      code = 0;
17,492✔
496

497
  // do update the task status
498
  streamMutexLock(&pTask->lock);
17,492✔
499

500
  STaskStateTrans* pTrans = pSM->pActiveTrans;
17,504✔
501
  if (pTrans == NULL) {
17,504✔
502
    ETaskStatus s = pSM->current.state;
36✔
503

504
    if (s != TASK_STATUS__DROPPING && s != TASK_STATUS__PAUSE && s != TASK_STATUS__STOP && s != TASK_STATUS__UNINIT &&
36!
505
        s != TASK_STATUS__READY) {
UNCOV
506
      stError("s-task:%s invalid task status:%s on handling event:%s success", id, pSM->current.name,
×
507
              GET_EVT_NAME(pSM->prev.evt));
508
    }
509

510
    // the pSM->prev.evt may be 0, so print string is not appropriate.
511
    stDebug("s-task:%s event:%s handled failed, current status:%s, trigger event:%s", id, GET_EVT_NAME(event),
36✔
512
            pSM->current.name, GET_EVT_NAME(pSM->prev.evt));
513

514
    streamMutexUnlock(&pTask->lock);
36✔
515
    return TSDB_CODE_STREAM_INVALID_STATETRANS;
1✔
516
  }
517

518
  if (pTrans->event != event) {
17,468!
UNCOV
519
    stWarn("s-task:%s handle event:%s failed, current status:%s, active trans evt:%s", id, GET_EVT_NAME(event),
×
520
           pSM->current.name, GET_EVT_NAME(pTrans->event));
521
    streamMutexUnlock(&pTask->lock);
×
UNCOV
522
    return TSDB_CODE_STREAM_INVALID_STATETRANS;
×
523
  }
524

525
  // repeat pause will not overwrite the previous pause state
526
  if (pSM->current.state != TASK_STATUS__PAUSE || pTrans->next.state != TASK_STATUS__PAUSE) {
17,468!
527
    keepPrevInfo(pSM);
17,468✔
528
    pSM->current = pTrans->next;
17,454✔
529
  } else {
UNCOV
530
    stDebug("s-task:%s repeat pause evt recv, not update prev status", id);
×
531
  }
532

533
  pSM->pActiveTrans = NULL;
17,454✔
534
  // todo remove it
535
  // todo: handle the error code
536
  // on success callback, add into lock if necessary, or maybe we should add an option for this?
537
  code = pTrans->pSuccAction(pTask);
17,454✔
538

539
  streamMutexUnlock(&pTask->lock);
17,462✔
540

541
  // todo: add parameter to control lock
542
  // after handling the callback function assigned by invoker, go on handling the waiting tasks
543
  if (callbackFn != NULL) {
17,495✔
544
    stDebug("s-task:%s start to handle user-specified callback fn for event:%s", id, GET_EVT_NAME(pTrans->event));
5,866✔
545
    int32_t ret = callbackFn(pSM->pTask, param);
5,866✔
546
    if (ret != TSDB_CODE_SUCCESS) {
547
      // todo  handle error
548
    }
549

550
    stDebug("s-task:%s handle user-specified callback fn for event:%s completed", id, GET_EVT_NAME(pTrans->event));
5,847✔
551
  }
552

553
  streamMutexLock(&pTask->lock);
17,476✔
554

555
  // tasks in waiting list
556
  if (taosArrayGetSize(pSM->pWaitingEventList) > 0) {
17,500!
UNCOV
557
    code = doHandleWaitingEvent(pSM, GET_EVT_NAME(pTrans->event), pTask);
×
558
  } else {
559
    streamMutexUnlock(&pTask->lock);
17,496✔
560

561
    int64_t el = (taosGetTimestampMs() - pSM->startTs);
17,515✔
562
    stDebug("s-task:%s handle event:%s completed, elapsed time:%" PRId64 "ms state:%s -> %s", id,
17,515✔
563
            GET_EVT_NAME(pTrans->event), el, pSM->prev.state.name, pSM->current.name);
564
  }
565

566
  return code;
17,511✔
567
}
568

569
SStreamTaskState streamTaskGetStatus(const SStreamTask* pTask) {
1,118,885✔
570
  return pTask->status.pSM->current;  // copy one obj in case of multi-thread environment
1,118,885✔
571
}
572

573
ETaskStatus streamTaskGetPrevStatus(const SStreamTask* pTask) {
4,854✔
574
  return pTask->status.pSM->prev.state.state;
4,854✔
575
}
576

577
const char* streamTaskGetStatusStr(ETaskStatus status) {
28,589✔
578
  int32_t index = status;
28,589✔
579
  if (index < 0 || index > tListLen(StreamTaskStatusList)) {
28,589!
UNCOV
580
    return "";
×
581
  }
582

583
  return StreamTaskStatusList[status].name;
28,593✔
584
}
585

586
void streamTaskResetStatus(SStreamTask* pTask) {
96✔
587
  SStreamTaskSM* pSM = pTask->status.pSM;
96✔
588

589
  streamMutexLock(&pTask->lock);
96✔
590
  stDebug("s-task:%s level:%d fill-history:%d vgId:%d set uninit, prev status:%s", pTask->id.idStr,
96✔
591
          pTask->info.taskLevel, pTask->info.fillHistory, pTask->pMeta->vgId, pSM->current.name);
592

593
  pSM->current = StreamTaskStatusList[TASK_STATUS__UNINIT];
96✔
594
  pSM->pActiveTrans = NULL;
96✔
595
  taosArrayClear(pSM->pWaitingEventList);
96✔
596
  streamMutexUnlock(&pTask->lock);
96✔
597

598
  // clear the downstream ready status
599
  pTask->status.downstreamReady = 0;
96✔
600
}
96✔
601

UNCOV
602
void streamTaskSetStatusReady(SStreamTask* pTask) {
×
UNCOV
603
  SStreamTaskSM* pSM = pTask->status.pSM;
×
604
  if (pSM->current.state == TASK_STATUS__DROPPING) {
×
605
    stError("s-task:%s task in dropping state, cannot be set ready", pTask->id.idStr);
×
606
    return;
×
607
  }
608

UNCOV
609
  pSM->prev.state = pSM->current;
×
UNCOV
610
  pSM->prev.evt = 0;
×
611

612
  pSM->current = StreamTaskStatusList[TASK_STATUS__READY];
×
UNCOV
613
  pSM->startTs = taosGetTimestampMs();
×
614
  pSM->pActiveTrans = NULL;
×
615
  taosArrayClear(pSM->pWaitingEventList);
×
616
}
617

618
STaskStateTrans createStateTransform(ETaskStatus current, ETaskStatus next, EStreamTaskEvent event, __state_trans_fn fn,
3,366✔
619
                                     __state_trans_succ_fn succFn, SFutureHandleEventInfo* pEventInfo) {
620
  STaskStateTrans trans = {0};
3,366✔
621
  trans.state = StreamTaskStatusList[current];
3,366✔
622
  trans.next = StreamTaskStatusList[next];
3,366✔
623
  trans.event = event;
3,366✔
624

625
  if (pEventInfo != NULL) {
3,366✔
626
    trans.attachEvent = *pEventInfo;
396✔
627
  } else {
628
    trans.attachEvent.event = 0;
2,970✔
629
    trans.attachEvent.status = 0;
2,970✔
630
  }
631

632
  trans.pAction = (fn != NULL) ? fn : dummyFn;
3,366✔
633
  trans.pSuccAction = (succFn != NULL) ? succFn : dummyFn;
3,366✔
634
  trans.autoInvokeEndFn = (fn == NULL);
3,366✔
635
  return trans;
3,366✔
636
}
637

638
int32_t initStateTransferTable() {
10,833✔
639
  return taosThreadOnce(&streamTaskStateMachineInit, doInitStateTransferTable);
10,833✔
640
}
641

642
//clang-format off
643
void doInitStateTransferTable(void) {
99✔
644
  streamTaskSMTrans = taosArrayInit(8, sizeof(STaskStateTrans));
99✔
645

646
  // initialization event handle
647
  STaskStateTrans trans = createStateTransform(TASK_STATUS__UNINIT, TASK_STATUS__READY, TASK_EVENT_INIT, streamTaskInitStatus, streamTaskOnNormalTaskReady, NULL);
99✔
648
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
649

650
  trans = createStateTransform(TASK_STATUS__UNINIT, TASK_STATUS__SCAN_HISTORY, TASK_EVENT_INIT_SCANHIST, streamTaskInitStatus, streamTaskOnScanHistoryTaskReady, NULL);
99✔
651
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
652

653
  // scan-history related event
654
  trans = createStateTransform(TASK_STATUS__SCAN_HISTORY, TASK_STATUS__READY, TASK_EVENT_SCANHIST_DONE, NULL, NULL, NULL);
99✔
655
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
656

657
  // halt stream task, from other task status
658
  trans = createStateTransform(TASK_STATUS__READY, TASK_STATUS__HALT, TASK_EVENT_HALT, NULL, streamTaskKeepCurrentVerInWal, NULL);
99✔
659
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
660
  trans = createStateTransform(TASK_STATUS__HALT, TASK_STATUS__HALT, TASK_EVENT_HALT, NULL, streamTaskKeepCurrentVerInWal, NULL);
99✔
661
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
662

663
  SFutureHandleEventInfo info = {.status = TASK_STATUS__READY, .event = TASK_EVENT_HALT};
99✔
664

665
  trans = createStateTransform(TASK_STATUS__CK, TASK_STATUS__HALT, TASK_EVENT_HALT, NULL, streamTaskKeepCurrentVerInWal, &info);
99✔
666
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
667
  trans = createStateTransform(TASK_STATUS__PAUSE, TASK_STATUS__HALT, TASK_EVENT_HALT, NULL, streamTaskKeepCurrentVerInWal, NULL);
99✔
668
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
669

670
  // checkpoint related event
671
  trans = createStateTransform(TASK_STATUS__READY, TASK_STATUS__CK, TASK_EVENT_GEN_CHECKPOINT, NULL, NULL, NULL);
99✔
672
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
673
  trans = createStateTransform(TASK_STATUS__HALT, TASK_STATUS__CK, TASK_EVENT_GEN_CHECKPOINT, NULL, NULL, NULL);
99✔
674
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
675
  trans = createStateTransform(TASK_STATUS__CK, TASK_STATUS__READY, TASK_EVENT_CHECKPOINT_DONE, NULL, NULL, NULL);
99✔
676
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
677

678
  // pause & resume related event handle
679
  trans = createStateTransform(TASK_STATUS__READY, TASK_STATUS__PAUSE, TASK_EVENT_PAUSE, NULL, NULL, NULL);
99✔
680
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
681
  trans = createStateTransform(TASK_STATUS__SCAN_HISTORY, TASK_STATUS__PAUSE, TASK_EVENT_PAUSE, NULL, NULL, NULL);
99✔
682
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
683

684
  info = (SFutureHandleEventInfo){.status = TASK_STATUS__READY, .event = TASK_EVENT_PAUSE};
99✔
685
  trans = createStateTransform(TASK_STATUS__CK, TASK_STATUS__PAUSE, TASK_EVENT_PAUSE, NULL, NULL, &info);
99✔
686
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
687
  trans = createStateTransform(TASK_STATUS__HALT, TASK_STATUS__PAUSE, TASK_EVENT_PAUSE, NULL, NULL, &info);
99✔
688
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
689
  trans = createStateTransform(TASK_STATUS__UNINIT, TASK_STATUS__PAUSE, TASK_EVENT_PAUSE, NULL, NULL, &info);
99✔
690
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
691

692
  trans = createStateTransform(TASK_STATUS__PAUSE, TASK_STATUS__PAUSE, TASK_EVENT_PAUSE, NULL, NULL, NULL);
99✔
693
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
694
  trans = createStateTransform(TASK_STATUS__STOP, TASK_STATUS__STOP, TASK_EVENT_PAUSE, NULL, NULL, NULL);
99✔
695
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
696
  trans = createStateTransform(TASK_STATUS__DROPPING, TASK_STATUS__DROPPING, TASK_EVENT_PAUSE, NULL, NULL, NULL);
99✔
697
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
698

699
  // resume is completed by restore status of state-machine
700

701
  // stop related event
702
  trans = createStateTransform(TASK_STATUS__READY, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
703
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
704
  trans = createStateTransform(TASK_STATUS__DROPPING, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
705
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
706
  trans = createStateTransform(TASK_STATUS__UNINIT, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
707
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
708
  trans = createStateTransform(TASK_STATUS__STOP, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
709
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
710
  trans = createStateTransform(TASK_STATUS__SCAN_HISTORY, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
711
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
712
  trans = createStateTransform(TASK_STATUS__HALT, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
713
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
714
  trans = createStateTransform(TASK_STATUS__PAUSE, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
715
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
716
  trans = createStateTransform(TASK_STATUS__CK, TASK_STATUS__STOP, TASK_EVENT_STOP, NULL, NULL, NULL);
99✔
717
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
718

719
  // dropping related event
720
  trans = createStateTransform(TASK_STATUS__READY, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
721
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
722
  trans = createStateTransform(TASK_STATUS__DROPPING, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
723
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
724
  trans = createStateTransform(TASK_STATUS__UNINIT, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
725
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
726
  trans = createStateTransform(TASK_STATUS__STOP, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
727
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
728
  trans = createStateTransform(TASK_STATUS__SCAN_HISTORY, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
729
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
730
  trans = createStateTransform(TASK_STATUS__HALT, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
731
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
732
  trans = createStateTransform(TASK_STATUS__PAUSE, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
733
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
734
  trans = createStateTransform(TASK_STATUS__CK, TASK_STATUS__DROPPING, TASK_EVENT_DROPPING, NULL, NULL, NULL);
99✔
735
  CHECK_RET_VAL(taosArrayPush(streamTaskSMTrans, &trans));
198!
736
}
737
//clang-format on
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