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

taosdata / TDengine / #4729

12 Sep 2025 02:34AM UTC coverage: 58.085% (-1.0%) from 59.125%
#4729

push

travis-ci

web-flow
docs: optimize taosd config parameters doc better (#32964)

133518 of 292959 branches covered (45.58%)

Branch coverage included in aggregate %.

201933 of 284559 relevant lines covered (70.96%)

5466318.3 hits per line

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

65.21
/source/dnode/vnode/src/vnd/vnodeSnapshot.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 "bse.h"
17
#include "tsdb.h"
18
#include "vnd.h"
19

20
static int32_t vnodeExtractSnapInfoDiff(void *buf, int32_t bufLen, TFileSetRangeArray **ppRanges) {
180✔
21
  int32_t            code = 0;
180✔
22
  STsdbFSetPartList *pList = tsdbFSetPartListCreate();
180✔
23
  if (pList == NULL) {
180!
24
    code = terrno;
×
25
    goto _out;
×
26
  }
27

28
  code = tDeserializeTsdbFSetPartList(buf, bufLen, pList);
180✔
29
  if (code) goto _out;
180!
30

31
  code = tsdbFSetPartListToRangeDiff(pList, ppRanges);
180✔
32
  if (code) goto _out;
180!
33

34
_out:
180✔
35
  tsdbFSetPartListDestroy(&pList);
180✔
36
  return code;
180✔
37
}
38

39
// SVSnapReader ========================================================
40
struct SVSnapReader {
41
  SVnode *pVnode;
42
  int64_t sver;
43
  int64_t ever;
44
  int64_t index;
45
  // config
46
  int8_t cfgDone;
47
  // meta
48
  int8_t           metaDone;
49
  SMetaSnapReader *pMetaReader;
50
  // tsdb
51
  int8_t              tsdbDone;
52
  TFileSetRangeArray *pRanges;
53
  STsdbSnapReader    *pTsdbReader;
54
  // tsdb raw
55
  int8_t              tsdbRAWDone;
56
  STsdbSnapRAWReader *pTsdbRAWReader;
57

58
  // tq
59
  int8_t         tqHandleDone;
60
  STqSnapReader *pTqSnapReader;
61
  int8_t         tqOffsetDone;
62
  STqSnapReader *pTqOffsetReader;
63
  int8_t         tqCheckInfoDone;
64
  STqSnapReader *pTqCheckInfoReader;
65
  // stream
66
  int8_t              streamTaskDone;
67
  SStreamTaskReader  *pStreamTaskReader;
68
  int8_t              streamStateDone;
69
  SStreamStateReader *pStreamStateReader;
70
  // rsma
71
  int8_t              rsmaDone;
72
  TFileSetRangeArray *pRsmaRanges[TSDB_RETENTION_L2];
73
  SRSmaSnapReader    *pRsmaReader;
74

75
  // bse
76
  int8_t          bseDone;
77
  SBseSnapReader *pBseReader;
78
};
79

80
static TFileSetRangeArray **vnodeSnapReaderGetTsdbRanges(SVSnapReader *pReader, int32_t tsdbTyp) {
356✔
81
  if (!(sizeof(pReader->pRsmaRanges) / sizeof(pReader->pRsmaRanges[0]) == 2)) {
82
    terrno = TSDB_CODE_INVALID_PARA;
83
    return NULL;
84
  }
85
  switch (tsdbTyp) {
356!
86
    case SNAP_DATA_TSDB:
178✔
87
      return &pReader->pRanges;
178✔
88
    case SNAP_DATA_RSMA1:
89✔
89
      return &pReader->pRsmaRanges[0];
89✔
90
    case SNAP_DATA_RSMA2:
89✔
91
      return &pReader->pRsmaRanges[1];
89✔
92
    default:
×
93
      return NULL;
×
94
  }
95
}
96

97
static int32_t vnodeSnapReaderDealWithSnapInfo(SVSnapReader *pReader, SSnapshotParam *pParam) {
89✔
98
  int32_t code = 0;
89✔
99
  SVnode *pVnode = pReader->pVnode;
89✔
100

101
  if (pParam->data) {
89!
102
    // decode
103
    SSyncTLV *datHead = (void *)pParam->data;
89✔
104
    if (datHead->typ != TDMT_SYNC_PREP_SNAPSHOT_REPLY) {
89!
105
      code = TSDB_CODE_INVALID_DATA_FMT;
×
106
      terrno = code;
×
107
      goto _out;
×
108
    }
109

110
    STsdbRepOpts         tsdbOpts = {0};
89✔
111
    TFileSetRangeArray **ppRanges = NULL;
89✔
112
    int32_t              offset = 0;
89✔
113

114
    while (offset + sizeof(SSyncTLV) < datHead->len) {
267✔
115
      SSyncTLV *subField = (void *)(datHead->val + offset);
178✔
116
      offset += sizeof(SSyncTLV) + subField->len;
178✔
117
      void   *buf = subField->val;
178✔
118
      int32_t bufLen = subField->len;
178✔
119

120
      switch (subField->typ) {
178!
121
        case SNAP_DATA_TSDB:
89✔
122
        case SNAP_DATA_RSMA1:
123
        case SNAP_DATA_RSMA2: {
124
          ppRanges = vnodeSnapReaderGetTsdbRanges(pReader, subField->typ);
89✔
125
          if (ppRanges == NULL) {
89!
126
            vError("vgId:%d, unexpected subfield type in snapshot param. subtyp:%d", TD_VID(pVnode), subField->typ);
×
127
            code = TSDB_CODE_INVALID_DATA_FMT;
×
128
            goto _out;
×
129
          }
130
          code = vnodeExtractSnapInfoDiff(buf, bufLen, ppRanges);
89✔
131
          if (code) {
89!
132
            vError("vgId:%d, failed to get range diff since %s", TD_VID(pVnode), terrstr());
×
133
            goto _out;
×
134
          }
135
        } break;
89✔
136
        case SNAP_DATA_RAW: {
89✔
137
          code = tDeserializeTsdbRepOpts(buf, bufLen, &tsdbOpts);
89✔
138
          if (code) {
89!
139
            vError("vgId:%d, failed to deserialize tsdb rep opts since %s", TD_VID(pVnode), terrstr());
×
140
            goto _out;
×
141
          }
142
        } break;
89✔
143
        default:
×
144
          vError("vgId:%d, unexpected subfield type of snap info. typ:%d", TD_VID(pVnode), subField->typ);
×
145
          code = TSDB_CODE_INVALID_DATA_FMT;
×
146
          goto _out;
×
147
      }
148
    }
149

150
    // toggle snap replication mode
151
    vInfo("vgId:%d, vnode snap reader supported tsdb rep of format:%d", TD_VID(pVnode), tsdbOpts.format);
89!
152
    if (pReader->sver == 0 && tsdbOpts.format == TSDB_SNAP_REP_FMT_RAW) {
89!
153
      pReader->tsdbDone = true;
85✔
154
    } else {
155
      pReader->tsdbRAWDone = true;
4✔
156
    }
157

158
    vInfo("vgId:%d, vnode snap writer enabled replication mode: %s", TD_VID(pVnode),
89!
159
          (pReader->tsdbDone ? "raw" : "normal"));
160
  }
161

162
_out:
×
163
  return code;
89✔
164
}
165

166
int32_t vnodeSnapReaderOpen(SVnode *pVnode, SSnapshotParam *pParam, SVSnapReader **ppReader) {
89✔
167
  int32_t       code = 0;
89✔
168
  int64_t       sver = pParam->start;
89✔
169
  int64_t       ever = pParam->end;
89✔
170
  SVSnapReader *pReader = NULL;
89✔
171

172
  pReader = (SVSnapReader *)taosMemoryCalloc(1, sizeof(*pReader));
89!
173
  if (pReader == NULL) {
89!
174
    code = terrno;
×
175
    goto _exit;
×
176
  }
177
  pReader->pVnode = pVnode;
89✔
178
  pReader->sver = sver;
89✔
179
  pReader->ever = ever;
89✔
180

181
  // snapshot info
182
  code = vnodeSnapReaderDealWithSnapInfo(pReader, pParam);
89✔
183
  if (code) goto _exit;
89!
184

185
  // open tsdb snapshot raw reader
186
  if (!pReader->tsdbRAWDone) {
89✔
187
    code = tsdbSnapRAWReaderOpen(pVnode->pTsdb, ever, SNAP_DATA_RAW, &pReader->pTsdbRAWReader);
85✔
188
    if (code) goto _exit;
85!
189
  }
190

191
  // check snapshot ever
192
  SSnapshot snapshot = {0};
89✔
193
  code = vnodeGetSnapshot(pVnode, &snapshot);
89✔
194
  if (code) goto _exit;
89!
195
  if (ever != snapshot.lastApplyIndex) {
89!
196
    vError("vgId:%d, abort reader open due to vnode snapshot changed. ever:%" PRId64 ", commit ver:%" PRId64,
×
197
           TD_VID(pVnode), ever, snapshot.lastApplyIndex);
198
    code = TSDB_CODE_SYN_INTERNAL_ERROR;
×
199
    goto _exit;
×
200
  }
201

202
_exit:
89✔
203
  if (code) {
89!
204
    vError("vgId:%d, vnode snapshot reader open failed since %s", TD_VID(pVnode), tstrerror(code));
×
205
    *ppReader = NULL;
×
206
  } else {
207
    vInfo("vgId:%d, vnode snapshot reader opened, sver:%" PRId64 " ever:%" PRId64, TD_VID(pVnode), sver, ever);
89!
208
    *ppReader = pReader;
89✔
209
  }
210
  return code;
89✔
211
}
212

213
static void vnodeSnapReaderDestroyTsdbRanges(SVSnapReader *pReader) {
89✔
214
  int32_t tsdbTyps[TSDB_RETENTION_MAX] = {SNAP_DATA_TSDB, SNAP_DATA_RSMA1, SNAP_DATA_RSMA2};
89✔
215
  for (int32_t j = 0; j < TSDB_RETENTION_MAX; ++j) {
356✔
216
    TFileSetRangeArray **ppRanges = vnodeSnapReaderGetTsdbRanges(pReader, tsdbTyps[j]);
267✔
217
    if (ppRanges == NULL) continue;
267!
218
    tsdbTFileSetRangeArrayDestroy(ppRanges);
267✔
219
  }
220
}
89✔
221

222
void vnodeSnapReaderClose(SVSnapReader *pReader) {
89✔
223
  vInfo("vgId:%d, close vnode snapshot reader", TD_VID(pReader->pVnode));
89!
224
  vnodeSnapReaderDestroyTsdbRanges(pReader);
89✔
225
#ifdef USE_RSMA
226
  if (pReader->pRsmaReader) {
89!
227
    rsmaSnapReaderClose(&pReader->pRsmaReader);
×
228
  }
229
#endif
230

231
  if (pReader->pTsdbReader) {
89!
232
    tsdbSnapReaderClose(&pReader->pTsdbReader);
×
233
  }
234

235
  if (pReader->pTsdbRAWReader) {
89!
236
    tsdbSnapRAWReaderClose(&pReader->pTsdbRAWReader);
×
237
  }
238

239
  if (pReader->pMetaReader) {
89!
240
    metaSnapReaderClose(&pReader->pMetaReader);
×
241
  }
242
#ifdef USE_TQ
243
  if (pReader->pTqSnapReader) {
89!
244
    tqSnapReaderClose(&pReader->pTqSnapReader);
×
245
  }
246

247
  if (pReader->pTqOffsetReader) {
89!
248
    tqSnapReaderClose(&pReader->pTqOffsetReader);
×
249
  }
250

251
  if (pReader->pTqCheckInfoReader) {
89!
252
    tqSnapReaderClose(&pReader->pTqCheckInfoReader);
×
253
  }
254

255
#endif
256

257
  if (pReader->pBseReader) {
89!
258
    bseSnapReaderClose(&pReader->pBseReader);
×
259
  }
260
  taosMemoryFree(pReader);
89!
261
}
89✔
262

263
int32_t vnodeSnapRead(SVSnapReader *pReader, uint8_t **ppData, uint32_t *nData) {
1,360✔
264
  int32_t code = 0;
1,360✔
265
  int32_t lino;
266
  SVnode *pVnode = pReader->pVnode;
1,360✔
267
  int32_t vgId = TD_VID(pReader->pVnode);
1,360✔
268

269
  // CONFIG ==============
270
  // FIXME: if commit multiple times and the config changed?
271
  if (!pReader->cfgDone) {
1,360✔
272
    char    fName[TSDB_FILENAME_LEN];
273
    int32_t offset = 0;
89✔
274

275
    vnodeGetPrimaryPath(pVnode, false, fName, TSDB_FILENAME_LEN);
89✔
276
    offset = strlen(fName);
89✔
277
    snprintf(fName + offset, TSDB_FILENAME_LEN - offset - 1, "%s%s", TD_DIRSEP, VND_INFO_FNAME);
89✔
278

279
    TdFilePtr pFile = taosOpenFile(fName, TD_FILE_READ);
89✔
280
    if (NULL == pFile) {
89!
281
      code = terrno;
×
282
      TSDB_CHECK_CODE(code, lino, _exit);
×
283
    }
284

285
    int64_t size;
286
    code = taosFStatFile(pFile, &size, NULL);
89✔
287
    if (code != 0) {
89!
288
      if (taosCloseFile(&pFile) != 0) {
×
289
        vError("vgId:%d, failed to close file", vgId);
×
290
      }
291
      TSDB_CHECK_CODE(code, lino, _exit);
×
292
    }
293

294
    *ppData = taosMemoryMalloc(sizeof(SSnapDataHdr) + size + 1);
89!
295
    if (*ppData == NULL) {
89!
296
      if (taosCloseFile(&pFile) != 0) {
×
297
        vError("vgId:%d, failed to close file", vgId);
×
298
      }
299
      TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
300
    }
301
    ((SSnapDataHdr *)(*ppData))->type = SNAP_DATA_CFG;
89✔
302
    ((SSnapDataHdr *)(*ppData))->size = size + 1;
89✔
303
    ((SSnapDataHdr *)(*ppData))->data[size] = '\0';
89✔
304

305
    if (taosReadFile(pFile, ((SSnapDataHdr *)(*ppData))->data, size) < 0) {
89!
306
      taosMemoryFree(*ppData);
×
307
      if (taosCloseFile(&pFile) != 0) {
×
308
        vError("vgId:%d, failed to close file", vgId);
×
309
      }
310
      TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
311
    }
312

313
    if (taosCloseFile(&pFile) != 0) {
89!
314
      vError("vgId:%d, failed to close file", vgId);
×
315
    }
316

317
    pReader->cfgDone = 1;
89✔
318
    goto _exit;
89✔
319
  }
320

321
  // META ==============
322
  if (!pReader->metaDone) {
1,271✔
323
    // open reader if not
324
    if (pReader->pMetaReader == NULL) {
676✔
325
      code = metaSnapReaderOpen(pReader->pVnode->pMeta, pReader->sver, pReader->ever, &pReader->pMetaReader);
89✔
326
      TSDB_CHECK_CODE(code, lino, _exit);
89!
327
    }
328

329
    code = metaSnapRead(pReader->pMetaReader, ppData);
676✔
330
    TSDB_CHECK_CODE(code, lino, _exit);
676!
331

332
    if (*ppData) {
676✔
333
      goto _exit;
587✔
334
    } else {
335
      pReader->metaDone = 1;
89✔
336
      metaSnapReaderClose(&pReader->pMetaReader);
89✔
337
    }
338
  }
339

340
  // TSDB ==============
341
  if (!pReader->tsdbDone) {
684✔
342
    // open if not
343
    if (pReader->pTsdbReader == NULL) {
23✔
344
      code = tsdbSnapReaderOpen(pReader->pVnode->pTsdb, pReader->sver, pReader->ever, SNAP_DATA_TSDB, pReader->pRanges,
4✔
345
                                &pReader->pTsdbReader);
346
      TSDB_CHECK_CODE(code, lino, _exit);
4!
347
    }
348

349
    code = tsdbSnapRead(pReader->pTsdbReader, ppData);
23✔
350
    TSDB_CHECK_CODE(code, lino, _exit);
23!
351
    if (*ppData) {
23✔
352
      goto _exit;
19✔
353
    } else {
354
      pReader->tsdbDone = 1;
4✔
355
      tsdbSnapReaderClose(&pReader->pTsdbReader);
4✔
356
    }
357
  }
358

359
  if (!pReader->tsdbRAWDone) {
665✔
360
    // open if not
361
    if (pReader->pTsdbRAWReader == NULL) {
565!
362
      code = tsdbSnapRAWReaderOpen(pReader->pVnode->pTsdb, pReader->ever, SNAP_DATA_RAW, &pReader->pTsdbRAWReader);
×
363
      TSDB_CHECK_CODE(code, lino, _exit);
×
364
    }
365

366
    code = tsdbSnapRAWRead(pReader->pTsdbRAWReader, ppData);
565✔
367
    TSDB_CHECK_CODE(code, lino, _exit);
565!
368
    if (*ppData) {
565✔
369
      goto _exit;
480✔
370
    } else {
371
      pReader->tsdbRAWDone = 1;
85✔
372
      tsdbSnapRAWReaderClose(&pReader->pTsdbRAWReader);
85✔
373
    }
374
  }
375

376
  // TQ ================
377
#ifdef USE_TQ
378
  vInfo("vgId:%d tq transform start", vgId);
185!
379
  if (!pReader->tqHandleDone) {
185✔
380
    if (pReader->pTqSnapReader == NULL) {
136✔
381
      code = tqSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->ever, SNAP_DATA_TQ_HANDLE,
89✔
382
                              &pReader->pTqSnapReader);
383
      TSDB_CHECK_CODE(code, lino, _exit);
89!
384
    }
385

386
    code = tqSnapRead(pReader->pTqSnapReader, ppData);
136✔
387
    TSDB_CHECK_CODE(code, lino, _exit);
136!
388
    if (*ppData) {
136✔
389
      goto _exit;
47✔
390
    } else {
391
      pReader->tqHandleDone = 1;
89✔
392
      tqSnapReaderClose(&pReader->pTqSnapReader);
89✔
393
    }
394
  }
395
  if (!pReader->tqCheckInfoDone) {
138✔
396
    if (pReader->pTqCheckInfoReader == NULL) {
93✔
397
      code = tqSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->ever, SNAP_DATA_TQ_CHECKINFO,
89✔
398
                              &pReader->pTqCheckInfoReader);
399
      TSDB_CHECK_CODE(code, lino, _exit);
89!
400
    }
401

402
    code = tqSnapRead(pReader->pTqCheckInfoReader, ppData);
93✔
403
    TSDB_CHECK_CODE(code, lino, _exit);
93!
404
    if (*ppData) {
93✔
405
      goto _exit;
4✔
406
    } else {
407
      pReader->tqCheckInfoDone = 1;
89✔
408
      tqSnapReaderClose(&pReader->pTqCheckInfoReader);
89✔
409
    }
410
  }
411
  if (!pReader->tqOffsetDone) {
134!
412
    if (pReader->pTqOffsetReader == NULL) {
134✔
413
      code = tqSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->ever, SNAP_DATA_TQ_OFFSET,
89✔
414
                              &pReader->pTqOffsetReader);
415
      TSDB_CHECK_CODE(code, lino, _exit);
89!
416
    }
417

418
    code = tqSnapRead(pReader->pTqOffsetReader, ppData);
134✔
419
    TSDB_CHECK_CODE(code, lino, _exit);
134!
420
    if (*ppData) {
134✔
421
      goto _exit;
45✔
422
    } else {
423
      pReader->tqOffsetDone = 1;
89✔
424
      tqSnapReaderClose(&pReader->pTqOffsetReader);
89✔
425
    }
426
  }
427
#endif
428
  // RSMA ==============
429
#ifdef USE_RSMA
430
  if (VND_IS_RSMA(pReader->pVnode) && !pReader->rsmaDone) {
89!
431
    // open if not
432
    if (pReader->pRsmaReader == NULL) {
×
433
      code = rsmaSnapReaderOpen(pReader->pVnode->pSma, pReader->sver, pReader->ever, &pReader->pRsmaReader);
×
434
      TSDB_CHECK_CODE(code, lino, _exit);
×
435
    }
436

437
    code = rsmaSnapRead(pReader->pRsmaReader, ppData);
×
438
    TSDB_CHECK_CODE(code, lino, _exit);
×
439
    if (*ppData) {
×
440
      goto _exit;
×
441
    } else {
442
      pReader->rsmaDone = 1;
×
443
      rsmaSnapReaderClose(&pReader->pRsmaReader);
×
444
    }
445
  }
446

447
  if (!pReader->bseDone) {
89!
448
    if (pReader->pBseReader == NULL) {
89!
449
      code = bseSnapReaderOpen(pReader->pVnode->pBse, pReader->sver, pReader->ever, &pReader->pBseReader);
89✔
450
      TSDB_CHECK_CODE(code, lino, _exit);
89!
451
    }
452
    int32_t len = 0;
89✔
453
    code = bseSnapReaderRead(pReader->pBseReader, ppData);
89✔
454
    TSDB_CHECK_CODE(code, lino, _exit);
89!
455
    if (*ppData) {
89!
456
      goto _exit;
×
457
    } else {
458
      pReader->bseDone = 1;
89✔
459
      bseSnapReaderClose(&pReader->pBseReader);
89✔
460
    }
461
  }
462

463
#endif
464
  *ppData = NULL;
89✔
465
  *nData = 0;
89✔
466

467
_exit:
1,360✔
468
  if (code) {
1,360!
469
    vError("vgId:%d, vnode snapshot read failed at %s:%d since %s", vgId, __FILE__, lino, tstrerror(code));
×
470
  } else {
471
    if (*ppData) {
1,360✔
472
      SSnapDataHdr *pHdr = (SSnapDataHdr *)(*ppData);
1,271✔
473

474
      pReader->index++;
1,271✔
475
      *nData = sizeof(SSnapDataHdr) + pHdr->size;
1,271✔
476
      pHdr->index = pReader->index;
1,271✔
477
      vDebug("vgId:%d, vnode snapshot read data, index:%" PRId64 " type:%d blockLen:%d ", vgId, pReader->index,
1,271!
478
             pHdr->type, *nData);
479
    } else {
480
      vInfo("vgId:%d, vnode snapshot read data end, index:%" PRId64, vgId, pReader->index);
89!
481
    }
482
  }
483
  return code;
1,360✔
484
}
485

486
// SVSnapWriter ========================================================
487
struct SVSnapWriter {
488
  SVnode *pVnode;
489
  int64_t sver;
490
  int64_t ever;
491
  int64_t commitID;
492
  int64_t index;
493
  // config
494
  SVnodeInfo info;
495
  // meta
496
  SMetaSnapWriter *pMetaSnapWriter;
497
  // tsdb
498
  TFileSetRangeArray *pRanges;
499
  STsdbSnapWriter    *pTsdbSnapWriter;
500
  // tsdb raw
501
  STsdbSnapRAWWriter *pTsdbSnapRAWWriter;
502
  // tq
503
  STqSnapWriter *pTqSnapHandleWriter;
504
  STqSnapWriter *pTqSnapOffsetWriter;
505
  STqSnapWriter *pTqSnapCheckInfoWriter;
506
  // rsma
507
  TFileSetRangeArray *pRsmaRanges[TSDB_RETENTION_L2];
508
  SRSmaSnapWriter    *pRsmaSnapWriter;
509

510
  // bse
511
  SBseSnapWriter *pBseSnapWriter;
512
};
513

514
TFileSetRangeArray **vnodeSnapWriterGetTsdbRanges(SVSnapWriter *pWriter, int32_t tsdbTyp) {
364✔
515
  switch (tsdbTyp) {
364!
516
    case SNAP_DATA_TSDB:
182✔
517
      return &pWriter->pRanges;
182✔
518
    case SNAP_DATA_RSMA1:
91✔
519
      return &pWriter->pRsmaRanges[0];
91✔
520
    case SNAP_DATA_RSMA2:
91✔
521
      return &pWriter->pRsmaRanges[1];
91✔
522
    default:
×
523
      return NULL;
×
524
  }
525
}
526

527
static int32_t vnodeSnapWriterDealWithSnapInfo(SVSnapWriter *pWriter, SSnapshotParam *pParam) {
91✔
528
  SVnode *pVnode = pWriter->pVnode;
91✔
529
  int32_t code = 0;
91✔
530
  int32_t lino;
531

532
  if (pParam->data) {
91!
533
    SSyncTLV *datHead = (void *)pParam->data;
91✔
534
    if (datHead->typ != TDMT_SYNC_PREP_SNAPSHOT_REPLY) {
91!
535
      TSDB_CHECK_CODE(code = TSDB_CODE_INVALID_DATA_FMT, lino, _exit);
×
536
    }
537

538
    STsdbRepOpts         tsdbOpts = {0};
91✔
539
    TFileSetRangeArray **ppRanges = NULL;
91✔
540
    int32_t              offset = 0;
91✔
541

542
    while (offset + sizeof(SSyncTLV) < datHead->len) {
273✔
543
      SSyncTLV *subField = (void *)(datHead->val + offset);
182✔
544
      offset += sizeof(SSyncTLV) + subField->len;
182✔
545
      void   *buf = subField->val;
182✔
546
      int32_t bufLen = subField->len;
182✔
547

548
      switch (subField->typ) {
182!
549
        case SNAP_DATA_TSDB:
91✔
550
        case SNAP_DATA_RSMA1:
551
        case SNAP_DATA_RSMA2: {
552
          ppRanges = vnodeSnapWriterGetTsdbRanges(pWriter, subField->typ);
91✔
553
          if (ppRanges == NULL) {
91!
554
            vError("vgId:%d, unexpected subfield type in snapshot param. subtyp:%d", TD_VID(pVnode), subField->typ);
×
555
            TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
556
          }
557

558
          code = vnodeExtractSnapInfoDiff(buf, bufLen, ppRanges);
91✔
559
          TSDB_CHECK_CODE(code, lino, _exit);
91!
560
        } break;
91✔
561
        case SNAP_DATA_RAW: {
91✔
562
          code = tDeserializeTsdbRepOpts(buf, bufLen, &tsdbOpts);
91✔
563
          TSDB_CHECK_CODE(code, lino, _exit);
91!
564
        } break;
91✔
565
        default:
×
566
          vError("vgId:%d, unexpected subfield type of snap info. typ:%d", TD_VID(pVnode), subField->typ);
×
567
          TSDB_CHECK_CODE(code = TSDB_CODE_INVALID_DATA_FMT, lino, _exit);
×
568
          goto _exit;
569
      }
570
    }
571

572
    vInfo("vgId:%d, vnode snap writer supported tsdb rep of format:%d", TD_VID(pVnode), tsdbOpts.format);
91!
573
  }
574

575
_exit:
×
576
  if (code) {
91!
577
    vError("vgId:%d %s failed at %s:%d since %s", TD_VID(pVnode), __func__, __FILE__, __LINE__, tstrerror(code));
×
578
  }
579
  return code;
91✔
580
}
581

582
extern int32_t tsdbDisableAndCancelAllBgTask(STsdb *pTsdb);
583
extern void    tsdbEnableBgTask(STsdb *pTsdb);
584

585
static int32_t vnodeCancelAndDisableAllBgTask(SVnode *pVnode) {
91✔
586
  TAOS_CHECK_RETURN(tsdbDisableAndCancelAllBgTask(pVnode->pTsdb));
91!
587
  TAOS_CHECK_RETURN(vnodeSyncCommit(pVnode));
91!
588
  return 0;
91✔
589
}
590

591
static int32_t vnodeEnableBgTask(SVnode *pVnode) {
91✔
592
  tsdbEnableBgTask(pVnode->pTsdb);
91✔
593
  return 0;
91✔
594
}
595

596
int32_t vnodeSnapWriterOpen(SVnode *pVnode, SSnapshotParam *pParam, SVSnapWriter **ppWriter) {
91✔
597
  int32_t       code = 0;
91✔
598
  int32_t       lino;
599
  SVSnapWriter *pWriter = NULL;
91✔
600
  int64_t       sver = pParam->start;
91✔
601
  int64_t       ever = pParam->end;
91✔
602

603
  // disable write, cancel and disable all bg tasks
604
  (void)taosThreadMutexLock(&pVnode->mutex);
91✔
605
  pVnode->disableWrite = true;
91✔
606
  (void)taosThreadMutexUnlock(&pVnode->mutex);
91✔
607

608
  code = vnodeCancelAndDisableAllBgTask(pVnode);
91✔
609
  TSDB_CHECK_CODE(code, lino, _exit);
91!
610

611
  // alloc
612
  pWriter = (SVSnapWriter *)taosMemoryCalloc(1, sizeof(*pWriter));
91!
613
  if (pWriter == NULL) {
91!
614
    TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
615
  }
616
  pWriter->pVnode = pVnode;
91✔
617
  pWriter->sver = sver;
91✔
618
  pWriter->ever = ever;
91✔
619

620
  // inc commit ID
621
  pWriter->commitID = ++pVnode->state.commitID;
91✔
622

623
  // snapshot info
624
  code = vnodeSnapWriterDealWithSnapInfo(pWriter, pParam);
91✔
625
  TSDB_CHECK_CODE(code, lino, _exit);
91!
626

627
_exit:
91✔
628
  if (code) {
91!
629
    vError("vgId:%d, vnode snapshot writer open failed since %s", TD_VID(pVnode), tstrerror(code));
×
630
    if (pWriter) taosMemoryFreeClear(pWriter);
×
631
    *ppWriter = NULL;
×
632
  } else {
633
    vInfo("vgId:%d, vnode snapshot writer opened, sver:%" PRId64 " ever:%" PRId64 " commit id:%" PRId64, TD_VID(pVnode),
91!
634
          sver, ever, pWriter->commitID);
635
    *ppWriter = pWriter;
91✔
636
  }
637
  return code;
91✔
638
}
639

640
static void vnodeSnapWriterDestroyTsdbRanges(SVSnapWriter *pWriter) {
91✔
641
  int32_t tsdbTyps[TSDB_RETENTION_MAX] = {SNAP_DATA_TSDB, SNAP_DATA_RSMA1, SNAP_DATA_RSMA2};
91✔
642
  for (int32_t j = 0; j < TSDB_RETENTION_MAX; ++j) {
364✔
643
    TFileSetRangeArray **ppRanges = vnodeSnapWriterGetTsdbRanges(pWriter, tsdbTyps[j]);
273✔
644
    if (ppRanges == NULL) continue;
273!
645
    tsdbTFileSetRangeArrayDestroy(ppRanges);
273✔
646
  }
647
}
91✔
648

649
int32_t vnodeSnapWriterClose(SVSnapWriter *pWriter, int8_t rollback, SSnapshot *pSnapshot) {
91✔
650
  int32_t code = 0;
91✔
651
  SVnode *pVnode = pWriter->pVnode;
91✔
652

653
  vnodeSnapWriterDestroyTsdbRanges(pWriter);
91✔
654

655
  // prepare
656
  if (pWriter->pTsdbSnapWriter) {
91✔
657
    code = tsdbSnapWriterPrepareClose(pWriter->pTsdbSnapWriter, rollback);
3✔
658
    if (code) goto _exit;
3!
659
  }
660

661
  if (pWriter->pTsdbSnapRAWWriter) {
91✔
662
    code = tsdbSnapRAWWriterPrepareClose(pWriter->pTsdbSnapRAWWriter);
81✔
663
    if (code) goto _exit;
81!
664
  }
665
#ifdef USE_RSMA
666
  if (pWriter->pRsmaSnapWriter) {
91!
667
    code = rsmaSnapWriterPrepareClose(pWriter->pRsmaSnapWriter, rollback);
×
668
    if (code) goto _exit;
×
669
  }
670
#endif
671
  // commit json
672
  if (!rollback) {
91!
673
    pWriter->info.state.committed = pWriter->ever;
91✔
674
    pVnode->config = pWriter->info.config;
91✔
675
    pVnode->state = (SVState){.committed = pWriter->info.state.committed,
91✔
676
                              .applied = pWriter->info.state.committed,
91✔
677
                              .commitID = pWriter->commitID,
91✔
678
                              .commitTerm = pWriter->info.state.commitTerm,
91✔
679
                              .applyTerm = pWriter->info.state.commitTerm};
91✔
680
    pVnode->statis = pWriter->info.statis;
91✔
681
    char dir[TSDB_FILENAME_LEN] = {0};
91✔
682
    vnodeGetPrimaryPath(pVnode, false, dir, TSDB_FILENAME_LEN);
91✔
683

684
    code = vnodeCommitInfo(dir);
91✔
685
    if (code) goto _exit;
91!
686

687
  } else {
688
    vnodeRollback(pWriter->pVnode);
×
689
  }
690

691
  // commit/rollback sub-system
692
  if (pWriter->pMetaSnapWriter) {
91✔
693
    code = metaSnapWriterClose(&pWriter->pMetaSnapWriter, rollback);
79✔
694
    if (code) goto _exit;
79!
695
  }
696

697
  if (pWriter->pTsdbSnapWriter) {
91✔
698
    code = tsdbSnapWriterClose(&pWriter->pTsdbSnapWriter, rollback);
3✔
699
    if (code) goto _exit;
3!
700
  }
701

702
  if (pWriter->pTsdbSnapRAWWriter) {
91✔
703
    code = tsdbSnapRAWWriterClose(&pWriter->pTsdbSnapRAWWriter, rollback);
81✔
704
    if (code) goto _exit;
81!
705
  }
706
#ifdef USE_TQ
707
  if (pWriter->pTqSnapHandleWriter) {
91✔
708
    code = tqSnapWriterClose(&pWriter->pTqSnapHandleWriter, rollback);
47✔
709
    if (code) goto _exit;
47!
710
  }
711

712
  if (pWriter->pTqSnapCheckInfoWriter) {
91✔
713
    code = tqSnapWriterClose(&pWriter->pTqSnapCheckInfoWriter, rollback);
4✔
714
    if (code) goto _exit;
4!
715
  }
716

717
  if (pWriter->pTqSnapOffsetWriter) {
91✔
718
    code = tqSnapWriterClose(&pWriter->pTqSnapOffsetWriter, rollback);
45✔
719
    if (code) goto _exit;
45!
720
  }
721
#endif
722
#ifdef USE_RSMA
723
  if (pWriter->pRsmaSnapWriter) {
91!
724
    code = rsmaSnapWriterClose(&pWriter->pRsmaSnapWriter, rollback);
×
725
    if (code) goto _exit;
×
726
  }
727

728
  if (pWriter->pBseSnapWriter) {
91!
729
    bseSnapWriterClose(&pWriter->pBseSnapWriter, rollback);
×
730
  }
731

732
#endif
733
  code = vnodeBegin(pVnode);
91✔
734
  if (code) goto _exit;
91!
735

736
  (void)taosThreadMutexLock(&pVnode->mutex);
91✔
737
  pVnode->disableWrite = false;
91✔
738
  (void)taosThreadMutexUnlock(&pVnode->mutex);
91✔
739

740
_exit:
91✔
741
  if (code) {
91!
742
    vError("vgId:%d, vnode snapshot writer close failed since %s", TD_VID(pWriter->pVnode), tstrerror(code));
×
743
  } else {
744
    vInfo("vgId:%d, vnode snapshot writer closed, rollback:%d", TD_VID(pVnode), rollback);
91!
745
    taosMemoryFree(pWriter);
91!
746
  }
747
  if (vnodeEnableBgTask(pVnode) != 0) {
91!
748
    tsdbError("vgId:%d, failed to enable bg task", TD_VID(pVnode));
×
749
  }
750
  return code;
91✔
751
}
752

753
static int32_t vnodeSnapWriteInfo(SVSnapWriter *pWriter, uint8_t *pData, uint32_t nData) {
91✔
754
  int32_t       code = 0;
91✔
755
  int32_t       lino;
756
  SVnode       *pVnode = pWriter->pVnode;
91✔
757
  SSnapDataHdr *pHdr = (SSnapDataHdr *)pData;
91✔
758

759
  // decode info
760
  code = vnodeDecodeInfo(pHdr->data, &pWriter->info);
91✔
761
  TSDB_CHECK_CODE(code, lino, _exit);
91!
762

763
  // change some value
764
  pWriter->info.state.commitID = pWriter->commitID;
91✔
765

766
  // modify info as needed
767
  char dir[TSDB_FILENAME_LEN] = {0};
91✔
768
  vnodeGetPrimaryPath(pVnode, false, dir, TSDB_FILENAME_LEN);
91✔
769

770
  SVnodeStats vndStats = pWriter->info.config.vndStats;
91✔
771
  pWriter->info.config = pVnode->config;
91✔
772
  pWriter->info.config.vndStats = vndStats;
91✔
773
  vDebug("vgId:%d, save config while write snapshot", pWriter->pVnode->config.vgId);
91!
774
  code = vnodeSaveInfo(dir, &pWriter->info);
91✔
775
  TSDB_CHECK_CODE(code, lino, _exit);
91!
776

777
_exit:
91✔
778
  return code;
91✔
779
}
780

781
int32_t vnodeSnapWrite(SVSnapWriter *pWriter, uint8_t *pData, uint32_t nData) {
1,289✔
782
  int32_t       code = 0;
1,289✔
783
  int32_t       lino;
784
  SSnapDataHdr *pHdr = (SSnapDataHdr *)pData;
1,289✔
785
  SVnode       *pVnode = pWriter->pVnode;
1,289✔
786

787
  if (!(pHdr->size + sizeof(SSnapDataHdr) == nData)) {
1,289!
788
    return TSDB_CODE_INVALID_PARA;
×
789
  }
790

791
  if (pHdr->index != pWriter->index + 1) {
1,289!
792
    vError("vgId:%d, unexpected vnode snapshot msg. index:%" PRId64 ", expected index:%" PRId64, TD_VID(pVnode),
×
793
           pHdr->index, pWriter->index + 1);
794
    TSDB_CHECK_CODE(code = TSDB_CODE_INVALID_MSG, lino, _exit);
×
795
  }
796

797
  pWriter->index = pHdr->index;
1,289✔
798

799
  vDebug("vgId:%d, vnode snapshot write data, index:%" PRId64 " type:%d blockLen:%d", TD_VID(pVnode), pHdr->index,
1,289!
800
         pHdr->type, nData);
801

802
  switch (pHdr->type) {
1,289!
803
    case SNAP_DATA_CFG: {
91✔
804
      code = vnodeSnapWriteInfo(pWriter, pData, nData);
91✔
805
      TSDB_CHECK_CODE(code, lino, _exit);
91!
806
    } break;
91✔
807
    case SNAP_DATA_META: {
593✔
808
      // meta
809
      if (pWriter->pMetaSnapWriter == NULL) {
593✔
810
        code = metaSnapWriterOpen(pVnode->pMeta, pWriter->sver, pWriter->ever, &pWriter->pMetaSnapWriter);
79✔
811
        TSDB_CHECK_CODE(code, lino, _exit);
79!
812
      }
813

814
      code = metaSnapWrite(pWriter->pMetaSnapWriter, pData, nData);
593✔
815
      TSDB_CHECK_CODE(code, lino, _exit);
593!
816
    } break;
593✔
817
    case SNAP_DATA_TSDB:
19✔
818
    case SNAP_DATA_DEL: {
819
      // tsdb
820
      if (pWriter->pTsdbSnapWriter == NULL) {
19✔
821
        code = tsdbSnapWriterOpen(pVnode->pTsdb, pWriter->sver, pWriter->ever, pWriter->pRanges,
3✔
822
                                  &pWriter->pTsdbSnapWriter);
823
        TSDB_CHECK_CODE(code, lino, _exit);
3!
824
      }
825

826
      code = tsdbSnapWrite(pWriter->pTsdbSnapWriter, pHdr);
19✔
827
      TSDB_CHECK_CODE(code, lino, _exit);
19!
828
    } break;
19✔
829
    case SNAP_DATA_RAW: {
490✔
830
      // tsdb
831
      if (pWriter->pTsdbSnapRAWWriter == NULL) {
490✔
832
        code = tsdbSnapRAWWriterOpen(pVnode->pTsdb, pWriter->ever, &pWriter->pTsdbSnapRAWWriter);
81✔
833
        TSDB_CHECK_CODE(code, lino, _exit);
81!
834
      }
835

836
      code = tsdbSnapRAWWrite(pWriter->pTsdbSnapRAWWriter, pHdr);
490✔
837
      TSDB_CHECK_CODE(code, lino, _exit);
490!
838
    } break;
490✔
839
#ifdef USE_TQ
840
    case SNAP_DATA_TQ_HANDLE: {
47✔
841
      // tq handle
842
      if (pWriter->pTqSnapHandleWriter == NULL) {
47!
843
        code = tqSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pTqSnapHandleWriter);
47✔
844
        TSDB_CHECK_CODE(code, lino, _exit);
47!
845
      }
846

847
      code = tqSnapHandleWrite(pWriter->pTqSnapHandleWriter, pData, nData);
47✔
848
      TSDB_CHECK_CODE(code, lino, _exit);
47!
849
    } break;
47✔
850
    case SNAP_DATA_TQ_CHECKINFO: {
4✔
851
      // tq checkinfo
852
      if (pWriter->pTqSnapCheckInfoWriter == NULL) {
4!
853
        code = tqSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pTqSnapCheckInfoWriter);
4✔
854
        TSDB_CHECK_CODE(code, lino, _exit);
4!
855
      }
856

857
      code = tqSnapCheckInfoWrite(pWriter->pTqSnapCheckInfoWriter, pData, nData);
4✔
858
      TSDB_CHECK_CODE(code, lino, _exit);
4!
859
    } break;
4✔
860
    case SNAP_DATA_TQ_OFFSET: {
45✔
861
      // tq offset
862
      if (pWriter->pTqSnapOffsetWriter == NULL) {
45!
863
        code = tqSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pTqSnapOffsetWriter);
45✔
864
        TSDB_CHECK_CODE(code, lino, _exit);
45!
865
      }
866

867
      code = tqSnapOffsetWrite(pWriter->pTqSnapOffsetWriter, pData, nData);
45✔
868
      TSDB_CHECK_CODE(code, lino, _exit);
45!
869
    } break;
45✔
870
#endif
871
#ifdef USE_RSMA
872
    case SNAP_DATA_RSMA1:
×
873
    case SNAP_DATA_RSMA2:
874
    case SNAP_DATA_QTASK: {
875
      // rsma1/rsma2/qtask for rsma
876
      if (pWriter->pRsmaSnapWriter == NULL) {
×
877
        code = rsmaSnapWriterOpen(pVnode->pSma, pWriter->sver, pWriter->ever, (void **)pWriter->pRsmaRanges,
×
878
                                  &pWriter->pRsmaSnapWriter);
879
        TSDB_CHECK_CODE(code, lino, _exit);
×
880
      }
881

882
      code = rsmaSnapWrite(pWriter->pRsmaSnapWriter, pData, nData);
×
883
      TSDB_CHECK_CODE(code, lino, _exit);
×
884
    } break;
×
885
    case SNAP_DATA_BSE: {
×
886
      if (pWriter->pBseSnapWriter == NULL) {
×
887
        code = bseSnapWriterOpen(pVnode->pBse, pWriter->sver, pWriter->ever, &pWriter->pBseSnapWriter);
×
888
        TSDB_CHECK_CODE(code, lino, _exit);
×
889
      }
890
      code = bseSnapWriterWrite(pWriter->pBseSnapWriter, pData, nData);
×
891
      TSDB_CHECK_CODE(code, lino, _exit);
×
892
    } break;
×
893
#endif
894
    default:
×
895
      break;
×
896
  }
897
_exit:
1,289✔
898
  if (code) {
1,289!
899
    vError("vgId:%d, vnode snapshot write failed since %s, index:%" PRId64 " type:%d nData:%d", TD_VID(pVnode),
×
900
           tstrerror(code), pHdr->index, pHdr->type, nData);
901
  }
902
  return code;
1,289✔
903
}
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