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

taosdata / TDengine / #4066

12 May 2025 05:35AM UTC coverage: 62.547% (+0.04%) from 62.508%
#4066

push

travis-ci

web-flow
Merge pull request #31053 from taosdata/merge/mainto3.0

merge: from main to 3.0 branch

155777 of 317858 branches covered (49.01%)

Branch coverage included in aggregate %.

382 of 573 new or added lines in 31 files covered. (66.67%)

648 existing lines in 129 files now uncovered.

241270 of 316936 relevant lines covered (76.13%)

6462449.7 hits per line

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

59.2
/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 "tsdb.h"
17
#include "vnd.h"
18

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

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

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

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

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

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

75
static TFileSetRangeArray **vnodeSnapReaderGetTsdbRanges(SVSnapReader *pReader, int32_t tsdbTyp) {
220✔
76
  if (!(sizeof(pReader->pRsmaRanges) / sizeof(pReader->pRsmaRanges[0]) == 2)) {
77
    terrno = TSDB_CODE_INVALID_PARA;
78
    return NULL;
79
  }
80
  switch (tsdbTyp) {
220!
81
    case SNAP_DATA_TSDB:
110✔
82
      return &pReader->pRanges;
110✔
83
    case SNAP_DATA_RSMA1:
55✔
84
      return &pReader->pRsmaRanges[0];
55✔
85
    case SNAP_DATA_RSMA2:
55✔
86
      return &pReader->pRsmaRanges[1];
55✔
87
    default:
×
88
      return NULL;
×
89
  }
90
}
91

92
static int32_t vnodeSnapReaderDealWithSnapInfo(SVSnapReader *pReader, SSnapshotParam *pParam) {
55✔
93
  int32_t code = 0;
55✔
94
  SVnode *pVnode = pReader->pVnode;
55✔
95

96
  if (pParam->data) {
55!
97
    // decode
98
    SSyncTLV *datHead = (void *)pParam->data;
55✔
99
    if (datHead->typ != TDMT_SYNC_PREP_SNAPSHOT_REPLY) {
55!
100
      code = TSDB_CODE_INVALID_DATA_FMT;
×
101
      terrno = code;
×
102
      goto _out;
×
103
    }
104

105
    STsdbRepOpts         tsdbOpts = {0};
55✔
106
    TFileSetRangeArray **ppRanges = NULL;
55✔
107
    int32_t              offset = 0;
55✔
108

109
    while (offset + sizeof(SSyncTLV) < datHead->len) {
165✔
110
      SSyncTLV *subField = (void *)(datHead->val + offset);
110✔
111
      offset += sizeof(SSyncTLV) + subField->len;
110✔
112
      void   *buf = subField->val;
110✔
113
      int32_t bufLen = subField->len;
110✔
114

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

145
    // toggle snap replication mode
146
    vInfo("vgId:%d, vnode snap reader supported tsdb rep of format:%d", TD_VID(pVnode), tsdbOpts.format);
55!
147
    if (pReader->sver == 0 && tsdbOpts.format == TSDB_SNAP_REP_FMT_RAW) {
55!
148
      pReader->tsdbDone = true;
55✔
149
    } else {
150
      pReader->tsdbRAWDone = true;
×
151
    }
152

153
    vInfo("vgId:%d, vnode snap writer enabled replication mode: %s", TD_VID(pVnode),
55!
154
          (pReader->tsdbDone ? "raw" : "normal"));
155
  }
156

157
_out:
×
158
  return code;
55✔
159
}
160

161
int32_t vnodeSnapReaderOpen(SVnode *pVnode, SSnapshotParam *pParam, SVSnapReader **ppReader) {
55✔
162
  int32_t       code = 0;
55✔
163
  int64_t       sver = pParam->start;
55✔
164
  int64_t       ever = pParam->end;
55✔
165
  SVSnapReader *pReader = NULL;
55✔
166

167
  pReader = (SVSnapReader *)taosMemoryCalloc(1, sizeof(*pReader));
55!
168
  if (pReader == NULL) {
55!
169
    code = terrno;
×
170
    goto _exit;
×
171
  }
172
  pReader->pVnode = pVnode;
55✔
173
  pReader->sver = sver;
55✔
174
  pReader->ever = ever;
55✔
175

176
  // snapshot info
177
  code = vnodeSnapReaderDealWithSnapInfo(pReader, pParam);
55✔
178
  if (code) goto _exit;
55!
179

180
  // open tsdb snapshot raw reader
181
  if (!pReader->tsdbRAWDone) {
55!
182
    code = tsdbSnapRAWReaderOpen(pVnode->pTsdb, ever, SNAP_DATA_RAW, &pReader->pTsdbRAWReader);
55✔
183
    if (code) goto _exit;
55!
184
  }
185

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

197
_exit:
55✔
198
  if (code) {
55!
199
    vError("vgId:%d, vnode snapshot reader open failed since %s", TD_VID(pVnode), tstrerror(code));
×
200
    *ppReader = NULL;
×
201
  } else {
202
    vInfo("vgId:%d, vnode snapshot reader opened, sver:%" PRId64 " ever:%" PRId64, TD_VID(pVnode), sver, ever);
55!
203
    *ppReader = pReader;
55✔
204
  }
205
  return code;
55✔
206
}
207

208
static void vnodeSnapReaderDestroyTsdbRanges(SVSnapReader *pReader) {
55✔
209
  int32_t tsdbTyps[TSDB_RETENTION_MAX] = {SNAP_DATA_TSDB, SNAP_DATA_RSMA1, SNAP_DATA_RSMA2};
55✔
210
  for (int32_t j = 0; j < TSDB_RETENTION_MAX; ++j) {
220✔
211
    TFileSetRangeArray **ppRanges = vnodeSnapReaderGetTsdbRanges(pReader, tsdbTyps[j]);
165✔
212
    if (ppRanges == NULL) continue;
165!
213
    tsdbTFileSetRangeArrayDestroy(ppRanges);
165✔
214
  }
215
}
55✔
216

217
void vnodeSnapReaderClose(SVSnapReader *pReader) {
55✔
218
  vInfo("vgId:%d, close vnode snapshot reader", TD_VID(pReader->pVnode));
55!
219
  vnodeSnapReaderDestroyTsdbRanges(pReader);
55✔
220
#ifdef USE_RSMA
221
  if (pReader->pRsmaReader) {
55!
222
    rsmaSnapReaderClose(&pReader->pRsmaReader);
×
223
  }
224
#endif
225

226
  if (pReader->pTsdbReader) {
55!
227
    tsdbSnapReaderClose(&pReader->pTsdbReader);
×
228
  }
229

230
  if (pReader->pTsdbRAWReader) {
55!
231
    tsdbSnapRAWReaderClose(&pReader->pTsdbRAWReader);
×
232
  }
233

234
  if (pReader->pMetaReader) {
55!
235
    metaSnapReaderClose(&pReader->pMetaReader);
×
236
  }
237
#ifdef USE_TQ
238
  if (pReader->pTqSnapReader) {
55!
239
    tqSnapReaderClose(&pReader->pTqSnapReader);
×
240
  }
241

242
  if (pReader->pTqOffsetReader) {
55!
243
    tqSnapReaderClose(&pReader->pTqOffsetReader);
×
244
  }
245

246
  if (pReader->pTqCheckInfoReader) {
55!
247
    tqSnapReaderClose(&pReader->pTqCheckInfoReader);
×
248
  }
249
#endif
250
  taosMemoryFree(pReader);
55!
251
}
55✔
252

253
int32_t vnodeSnapRead(SVSnapReader *pReader, uint8_t **ppData, uint32_t *nData) {
940✔
254
  int32_t code = 0;
940✔
255
  int32_t lino;
256
  SVnode *pVnode = pReader->pVnode;
940✔
257
  int32_t vgId = TD_VID(pReader->pVnode);
940✔
258

259
  // CONFIG ==============
260
  // FIXME: if commit multiple times and the config changed?
261
  if (!pReader->cfgDone) {
940✔
262
    char    fName[TSDB_FILENAME_LEN];
263
    int32_t offset = 0;
55✔
264

265
    vnodeGetPrimaryDir(pVnode->path, pVnode->diskPrimary, pVnode->pTfs, fName, TSDB_FILENAME_LEN);
55✔
266
    offset = strlen(fName);
55✔
267
    snprintf(fName + offset, TSDB_FILENAME_LEN - offset - 1, "%s%s", TD_DIRSEP, VND_INFO_FNAME);
55✔
268

269
    TdFilePtr pFile = taosOpenFile(fName, TD_FILE_READ);
55✔
270
    if (NULL == pFile) {
55!
271
      code = terrno;
×
272
      TSDB_CHECK_CODE(code, lino, _exit);
×
273
    }
274

275
    int64_t size;
276
    code = taosFStatFile(pFile, &size, NULL);
55✔
277
    if (code != 0) {
55!
278
      if (taosCloseFile(&pFile) != 0) {
×
279
        vError("vgId:%d, failed to close file", vgId);
×
280
      }
281
      TSDB_CHECK_CODE(code, lino, _exit);
×
282
    }
283

284
    *ppData = taosMemoryMalloc(sizeof(SSnapDataHdr) + size + 1);
55!
285
    if (*ppData == NULL) {
55!
286
      if (taosCloseFile(&pFile) != 0) {
×
287
        vError("vgId:%d, failed to close file", vgId);
×
288
      }
289
      TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
290
    }
291
    ((SSnapDataHdr *)(*ppData))->type = SNAP_DATA_CFG;
55✔
292
    ((SSnapDataHdr *)(*ppData))->size = size + 1;
55✔
293
    ((SSnapDataHdr *)(*ppData))->data[size] = '\0';
55✔
294

295
    if (taosReadFile(pFile, ((SSnapDataHdr *)(*ppData))->data, size) < 0) {
55!
296
      taosMemoryFree(*ppData);
×
297
      if (taosCloseFile(&pFile) != 0) {
×
298
        vError("vgId:%d, failed to close file", vgId);
×
299
      }
300
      TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
301
    }
302

303
    if (taosCloseFile(&pFile) != 0) {
55!
304
      vError("vgId:%d, failed to close file", vgId);
×
305
    }
306

307
    pReader->cfgDone = 1;
55✔
308
    goto _exit;
55✔
309
  }
310

311
  // META ==============
312
  if (!pReader->metaDone) {
885✔
313
    // open reader if not
314
    if (pReader->pMetaReader == NULL) {
580✔
315
      code = metaSnapReaderOpen(pReader->pVnode->pMeta, pReader->sver, pReader->ever, &pReader->pMetaReader);
55✔
316
      TSDB_CHECK_CODE(code, lino, _exit);
55!
317
    }
318

319
    code = metaSnapRead(pReader->pMetaReader, ppData);
580✔
320
    TSDB_CHECK_CODE(code, lino, _exit);
580!
321

322
    if (*ppData) {
580✔
323
      goto _exit;
525✔
324
    } else {
325
      pReader->metaDone = 1;
55✔
326
      metaSnapReaderClose(&pReader->pMetaReader);
55✔
327
    }
328
  }
329

330
  // TSDB ==============
331
  if (!pReader->tsdbDone) {
360!
332
    // open if not
333
    if (pReader->pTsdbReader == NULL) {
×
334
      code = tsdbSnapReaderOpen(pReader->pVnode->pTsdb, pReader->sver, pReader->ever, SNAP_DATA_TSDB, pReader->pRanges,
×
335
                                &pReader->pTsdbReader);
336
      TSDB_CHECK_CODE(code, lino, _exit);
×
337
    }
338

339
    code = tsdbSnapRead(pReader->pTsdbReader, ppData);
×
340
    TSDB_CHECK_CODE(code, lino, _exit);
×
341
    if (*ppData) {
×
342
      goto _exit;
×
343
    } else {
344
      pReader->tsdbDone = 1;
×
345
      tsdbSnapReaderClose(&pReader->pTsdbReader);
×
346
    }
347
  }
348

349
  if (!pReader->tsdbRAWDone) {
360✔
350
    // open if not
351
    if (pReader->pTsdbRAWReader == NULL) {
264!
352
      code = tsdbSnapRAWReaderOpen(pReader->pVnode->pTsdb, pReader->ever, SNAP_DATA_RAW, &pReader->pTsdbRAWReader);
×
353
      TSDB_CHECK_CODE(code, lino, _exit);
×
354
    }
355

356
    code = tsdbSnapRAWRead(pReader->pTsdbRAWReader, ppData);
264✔
357
    TSDB_CHECK_CODE(code, lino, _exit);
264!
358
    if (*ppData) {
264✔
359
      goto _exit;
209✔
360
    } else {
361
      pReader->tsdbRAWDone = 1;
55✔
362
      tsdbSnapRAWReaderClose(&pReader->pTsdbRAWReader);
55✔
363
    }
364
  }
365

366
  // TQ ================
367
#ifdef USE_TQ
368
  vInfo("vgId:%d tq transform start", vgId);
151!
369
  if (!pReader->tqHandleDone) {
151✔
370
    if (pReader->pTqSnapReader == NULL) {
101✔
371
      code = tqSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->ever, SNAP_DATA_TQ_HANDLE,
55✔
372
                              &pReader->pTqSnapReader);
373
      TSDB_CHECK_CODE(code, lino, _exit);
55!
374
    }
375

376
    code = tqSnapRead(pReader->pTqSnapReader, ppData);
101✔
377
    TSDB_CHECK_CODE(code, lino, _exit);
101!
378
    if (*ppData) {
101✔
379
      goto _exit;
46✔
380
    } else {
381
      pReader->tqHandleDone = 1;
55✔
382
      tqSnapReaderClose(&pReader->pTqSnapReader);
55✔
383
    }
384
  }
385
  if (!pReader->tqCheckInfoDone) {
105✔
386
    if (pReader->pTqCheckInfoReader == NULL) {
59✔
387
      code = tqSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->ever, SNAP_DATA_TQ_CHECKINFO,
55✔
388
                              &pReader->pTqCheckInfoReader);
389
      TSDB_CHECK_CODE(code, lino, _exit);
55!
390
    }
391

392
    code = tqSnapRead(pReader->pTqCheckInfoReader, ppData);
59✔
393
    TSDB_CHECK_CODE(code, lino, _exit);
59!
394
    if (*ppData) {
59✔
395
      goto _exit;
4✔
396
    } else {
397
      pReader->tqCheckInfoDone = 1;
55✔
398
      tqSnapReaderClose(&pReader->pTqCheckInfoReader);
55✔
399
    }
400
  }
401
  if (!pReader->tqOffsetDone) {
101!
402
    if (pReader->pTqOffsetReader == NULL) {
101✔
403
      code = tqSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->ever, SNAP_DATA_TQ_OFFSET,
55✔
404
                              &pReader->pTqOffsetReader);
405
      TSDB_CHECK_CODE(code, lino, _exit);
55!
406
    }
407

408
    code = tqSnapRead(pReader->pTqOffsetReader, ppData);
101✔
409
    TSDB_CHECK_CODE(code, lino, _exit);
101!
410
    if (*ppData) {
101✔
411
      goto _exit;
46✔
412
    } else {
413
      pReader->tqOffsetDone = 1;
55✔
414
      tqSnapReaderClose(&pReader->pTqOffsetReader);
55✔
415
    }
416
  }
417
#endif
418
  // STREAM ============
419
#ifdef USE_STREAM
420
  vInfo("vgId:%d stream task start to take snapshot", vgId);
55!
421
  if (!pReader->streamTaskDone) {
55!
422
    if (pReader->pStreamTaskReader == NULL) {
55!
423
      code = streamTaskSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->sver, &pReader->pStreamTaskReader);
55✔
424
      TSDB_CHECK_CODE(code, lino, _exit);
55!
425
    }
426

427
    code = streamTaskSnapRead(pReader->pStreamTaskReader, ppData);
55✔
428
    TSDB_CHECK_CODE(code, lino, _exit);
55!
429
    if (*ppData) {
55!
UNCOV
430
      vInfo("vgId:%d no streamTask snapshot", vgId);
×
UNCOV
431
      goto _exit;
×
432
    } else {
433
      pReader->streamTaskDone = 1;
55✔
434
      code = streamTaskSnapReaderClose(pReader->pStreamTaskReader);
55✔
435
      TSDB_CHECK_CODE(code, lino, _exit);
55!
436
      pReader->pStreamTaskReader = NULL;
55✔
437
    }
438
  }
439
  if (!pReader->streamStateDone) {
55!
440
    if (pReader->pStreamStateReader == NULL) {
55!
441
      code =
442
          streamStateSnapReaderOpen(pReader->pVnode->pTq, pReader->sver, pReader->sver, &pReader->pStreamStateReader);
55✔
443
      if (code) {
55!
444
        pReader->streamStateDone = 1;
×
445
        pReader->pStreamStateReader = NULL;
×
446
        TSDB_CHECK_CODE(code, lino, _exit);
×
447
      }
448
    }
449
    code = streamStateSnapRead(pReader->pStreamStateReader, ppData);
55✔
450
    TSDB_CHECK_CODE(code, lino, _exit);
55!
451
    if (*ppData) {
55!
452
      goto _exit;
×
453
    } else {
454
      pReader->streamStateDone = 1;
55✔
455
      code = streamStateSnapReaderClose(pReader->pStreamStateReader);
55✔
456
      TSDB_CHECK_CODE(code, lino, _exit);
55!
457
      pReader->pStreamStateReader = NULL;
55✔
458
    }
459
  }
460
#endif
461
  // RSMA ==============
462
#ifdef USE_RSMA
463
  if (VND_IS_RSMA(pReader->pVnode) && !pReader->rsmaDone) {
55!
464
    // open if not
465
    if (pReader->pRsmaReader == NULL) {
×
466
      code = rsmaSnapReaderOpen(pReader->pVnode->pSma, pReader->sver, pReader->ever, &pReader->pRsmaReader);
×
467
      TSDB_CHECK_CODE(code, lino, _exit);
×
468
    }
469

470
    code = rsmaSnapRead(pReader->pRsmaReader, ppData);
×
471
    TSDB_CHECK_CODE(code, lino, _exit);
×
472
    if (*ppData) {
×
473
      goto _exit;
×
474
    } else {
475
      pReader->rsmaDone = 1;
×
476
      rsmaSnapReaderClose(&pReader->pRsmaReader);
×
477
    }
478
  }
479
#endif
480
  *ppData = NULL;
55✔
481
  *nData = 0;
55✔
482

483
_exit:
940✔
484
  if (code) {
940!
485
    vError("vgId:%d, vnode snapshot read failed at %s:%d since %s", vgId, __FILE__, lino, tstrerror(code));
×
486
  } else {
487
    if (*ppData) {
940✔
488
      SSnapDataHdr *pHdr = (SSnapDataHdr *)(*ppData);
885✔
489

490
      pReader->index++;
885✔
491
      *nData = sizeof(SSnapDataHdr) + pHdr->size;
885✔
492
      pHdr->index = pReader->index;
885✔
493
      vDebug("vgId:%d, vnode snapshot read data, index:%" PRId64 " type:%d blockLen:%d ", vgId, pReader->index,
885!
494
             pHdr->type, *nData);
495
    } else {
496
      vInfo("vgId:%d, vnode snapshot read data end, index:%" PRId64, vgId, pReader->index);
55!
497
    }
498
  }
499
  return code;
940✔
500
}
501

502
// SVSnapWriter ========================================================
503
struct SVSnapWriter {
504
  SVnode *pVnode;
505
  int64_t sver;
506
  int64_t ever;
507
  int64_t commitID;
508
  int64_t index;
509
  // config
510
  SVnodeInfo info;
511
  // meta
512
  SMetaSnapWriter *pMetaSnapWriter;
513
  // tsdb
514
  TFileSetRangeArray *pRanges;
515
  STsdbSnapWriter    *pTsdbSnapWriter;
516
  // tsdb raw
517
  STsdbSnapRAWWriter *pTsdbSnapRAWWriter;
518
  // tq
519
  STqSnapWriter *pTqSnapHandleWriter;
520
  STqSnapWriter *pTqSnapOffsetWriter;
521
  STqSnapWriter *pTqSnapCheckInfoWriter;
522
  // stream
523
  SStreamTaskWriter  *pStreamTaskWriter;
524
  SStreamStateWriter *pStreamStateWriter;
525
  // rsma
526
  TFileSetRangeArray *pRsmaRanges[TSDB_RETENTION_L2];
527
  SRSmaSnapWriter    *pRsmaSnapWriter;
528
};
529

530
TFileSetRangeArray **vnodeSnapWriterGetTsdbRanges(SVSnapWriter *pWriter, int32_t tsdbTyp) {
212✔
531
  switch (tsdbTyp) {
212!
532
    case SNAP_DATA_TSDB:
106✔
533
      return &pWriter->pRanges;
106✔
534
    case SNAP_DATA_RSMA1:
53✔
535
      return &pWriter->pRsmaRanges[0];
53✔
536
    case SNAP_DATA_RSMA2:
53✔
537
      return &pWriter->pRsmaRanges[1];
53✔
538
    default:
×
539
      return NULL;
×
540
  }
541
}
542

543
static int32_t vnodeSnapWriterDealWithSnapInfo(SVSnapWriter *pWriter, SSnapshotParam *pParam) {
53✔
544
  SVnode *pVnode = pWriter->pVnode;
53✔
545
  int32_t code = 0;
53✔
546
  int32_t lino;
547

548
  if (pParam->data) {
53!
549
    SSyncTLV *datHead = (void *)pParam->data;
53✔
550
    if (datHead->typ != TDMT_SYNC_PREP_SNAPSHOT_REPLY) {
53!
551
      TSDB_CHECK_CODE(code = TSDB_CODE_INVALID_DATA_FMT, lino, _exit);
×
552
    }
553

554
    STsdbRepOpts         tsdbOpts = {0};
53✔
555
    TFileSetRangeArray **ppRanges = NULL;
53✔
556
    int32_t              offset = 0;
53✔
557

558
    while (offset + sizeof(SSyncTLV) < datHead->len) {
159✔
559
      SSyncTLV *subField = (void *)(datHead->val + offset);
106✔
560
      offset += sizeof(SSyncTLV) + subField->len;
106✔
561
      void   *buf = subField->val;
106✔
562
      int32_t bufLen = subField->len;
106✔
563

564
      switch (subField->typ) {
106!
565
        case SNAP_DATA_TSDB:
53✔
566
        case SNAP_DATA_RSMA1:
567
        case SNAP_DATA_RSMA2: {
568
          ppRanges = vnodeSnapWriterGetTsdbRanges(pWriter, subField->typ);
53✔
569
          if (ppRanges == NULL) {
53!
570
            vError("vgId:%d, unexpected subfield type in snapshot param. subtyp:%d", TD_VID(pVnode), subField->typ);
×
571
            TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
572
          }
573

574
          code = vnodeExtractSnapInfoDiff(buf, bufLen, ppRanges);
53✔
575
          TSDB_CHECK_CODE(code, lino, _exit);
53!
576
        } break;
53✔
577
        case SNAP_DATA_RAW: {
53✔
578
          code = tDeserializeTsdbRepOpts(buf, bufLen, &tsdbOpts);
53✔
579
          TSDB_CHECK_CODE(code, lino, _exit);
53!
580
        } break;
53✔
581
        default:
×
582
          vError("vgId:%d, unexpected subfield type of snap info. typ:%d", TD_VID(pVnode), subField->typ);
×
583
          TSDB_CHECK_CODE(code = TSDB_CODE_INVALID_DATA_FMT, lino, _exit);
×
584
          goto _exit;
585
      }
586
    }
587

588
    vInfo("vgId:%d, vnode snap writer supported tsdb rep of format:%d", TD_VID(pVnode), tsdbOpts.format);
53!
589
  }
590

591
_exit:
×
592
  if (code) {
53!
593
    vError("vgId:%d %s failed at %s:%d since %s", TD_VID(pVnode), __func__, __FILE__, __LINE__, tstrerror(code));
×
594
  }
595
  return code;
53✔
596
}
597

598
extern int32_t tsdbDisableAndCancelAllBgTask(STsdb *pTsdb);
599
extern void    tsdbEnableBgTask(STsdb *pTsdb);
600

601
static int32_t vnodeCancelAndDisableAllBgTask(SVnode *pVnode) {
53✔
602
  TAOS_CHECK_RETURN(tsdbDisableAndCancelAllBgTask(pVnode->pTsdb));
53!
603
  TAOS_CHECK_RETURN(vnodeSyncCommit(pVnode));
53!
604
  return 0;
53✔
605
}
606

607
static int32_t vnodeEnableBgTask(SVnode *pVnode) {
53✔
608
  tsdbEnableBgTask(pVnode->pTsdb);
53✔
609
  return 0;
53✔
610
}
611

612
int32_t vnodeSnapWriterOpen(SVnode *pVnode, SSnapshotParam *pParam, SVSnapWriter **ppWriter) {
53✔
613
  int32_t       code = 0;
53✔
614
  int32_t       lino;
615
  SVSnapWriter *pWriter = NULL;
53✔
616
  int64_t       sver = pParam->start;
53✔
617
  int64_t       ever = pParam->end;
53✔
618

619
  // disable write, cancel and disable all bg tasks
620
  (void)taosThreadMutexLock(&pVnode->mutex);
53✔
621
  pVnode->disableWrite = true;
53✔
622
  (void)taosThreadMutexUnlock(&pVnode->mutex);
53✔
623

624
  code = vnodeCancelAndDisableAllBgTask(pVnode);
53✔
625
  TSDB_CHECK_CODE(code, lino, _exit);
53!
626

627
  // alloc
628
  pWriter = (SVSnapWriter *)taosMemoryCalloc(1, sizeof(*pWriter));
53!
629
  if (pWriter == NULL) {
53!
630
    TSDB_CHECK_CODE(code = terrno, lino, _exit);
×
631
  }
632
  pWriter->pVnode = pVnode;
53✔
633
  pWriter->sver = sver;
53✔
634
  pWriter->ever = ever;
53✔
635

636
  // inc commit ID
637
  pWriter->commitID = ++pVnode->state.commitID;
53✔
638

639
  // snapshot info
640
  code = vnodeSnapWriterDealWithSnapInfo(pWriter, pParam);
53✔
641
  TSDB_CHECK_CODE(code, lino, _exit);
53!
642

643
_exit:
53✔
644
  if (code) {
53!
645
    vError("vgId:%d, vnode snapshot writer open failed since %s", TD_VID(pVnode), tstrerror(code));
×
646
    if (pWriter) taosMemoryFreeClear(pWriter);
×
647
    *ppWriter = NULL;
×
648
  } else {
649
    vInfo("vgId:%d, vnode snapshot writer opened, sver:%" PRId64 " ever:%" PRId64 " commit id:%" PRId64, TD_VID(pVnode),
53!
650
          sver, ever, pWriter->commitID);
651
    *ppWriter = pWriter;
53✔
652
  }
653
  return code;
53✔
654
}
655

656
static void vnodeSnapWriterDestroyTsdbRanges(SVSnapWriter *pWriter) {
53✔
657
  int32_t tsdbTyps[TSDB_RETENTION_MAX] = {SNAP_DATA_TSDB, SNAP_DATA_RSMA1, SNAP_DATA_RSMA2};
53✔
658
  for (int32_t j = 0; j < TSDB_RETENTION_MAX; ++j) {
212✔
659
    TFileSetRangeArray **ppRanges = vnodeSnapWriterGetTsdbRanges(pWriter, tsdbTyps[j]);
159✔
660
    if (ppRanges == NULL) continue;
159!
661
    tsdbTFileSetRangeArrayDestroy(ppRanges);
159✔
662
  }
663
}
53✔
664

665
int32_t vnodeSnapWriterClose(SVSnapWriter *pWriter, int8_t rollback, SSnapshot *pSnapshot) {
53✔
666
  int32_t code = 0;
53✔
667
  SVnode *pVnode = pWriter->pVnode;
53✔
668

669
  vnodeSnapWriterDestroyTsdbRanges(pWriter);
53✔
670

671
  // prepare
672
  if (pWriter->pTsdbSnapWriter) {
53!
673
    code = tsdbSnapWriterPrepareClose(pWriter->pTsdbSnapWriter, rollback);
×
674
    if (code) goto _exit;
×
675
  }
676

677
  if (pWriter->pTsdbSnapRAWWriter) {
53✔
678
    code = tsdbSnapRAWWriterPrepareClose(pWriter->pTsdbSnapRAWWriter);
50✔
679
    if (code) goto _exit;
50!
680
  }
681
#ifdef USE_RSMA
682
  if (pWriter->pRsmaSnapWriter) {
53!
683
    code = rsmaSnapWriterPrepareClose(pWriter->pRsmaSnapWriter, rollback);
×
684
    if (code) goto _exit;
×
685
  }
686
#endif
687
  // commit json
688
  if (!rollback) {
53!
689
    pWriter->info.state.committed = pWriter->ever;
53✔
690
    pVnode->config = pWriter->info.config;
53✔
691
    pVnode->state = (SVState){.committed = pWriter->info.state.committed,
53✔
692
                              .applied = pWriter->info.state.committed,
53✔
693
                              .commitID = pWriter->commitID,
53✔
694
                              .commitTerm = pWriter->info.state.commitTerm,
53✔
695
                              .applyTerm = pWriter->info.state.commitTerm};
53✔
696
    pVnode->statis = pWriter->info.statis;
53✔
697
    char dir[TSDB_FILENAME_LEN] = {0};
53✔
698
    vnodeGetPrimaryDir(pVnode->path, pVnode->diskPrimary, pVnode->pTfs, dir, TSDB_FILENAME_LEN);
53✔
699

700
    code = vnodeCommitInfo(dir);
53✔
701
    if (code) goto _exit;
53!
702

703
  } else {
704
    vnodeRollback(pWriter->pVnode);
×
705
  }
706

707
  // commit/rollback sub-system
708
  if (pWriter->pMetaSnapWriter) {
53✔
709
    code = metaSnapWriterClose(&pWriter->pMetaSnapWriter, rollback);
48✔
710
    if (code) goto _exit;
48!
711
  }
712

713
  if (pWriter->pTsdbSnapWriter) {
53!
714
    code = tsdbSnapWriterClose(&pWriter->pTsdbSnapWriter, rollback);
×
715
    if (code) goto _exit;
×
716
  }
717

718
  if (pWriter->pTsdbSnapRAWWriter) {
53✔
719
    code = tsdbSnapRAWWriterClose(&pWriter->pTsdbSnapRAWWriter, rollback);
50✔
720
    if (code) goto _exit;
50!
721
  }
722
#ifdef USE_TQ
723
  if (pWriter->pTqSnapHandleWriter) {
53✔
724
    code = tqSnapWriterClose(&pWriter->pTqSnapHandleWriter, rollback);
46✔
725
    if (code) goto _exit;
46!
726
  }
727

728
  if (pWriter->pTqSnapCheckInfoWriter) {
53✔
729
    code = tqSnapWriterClose(&pWriter->pTqSnapCheckInfoWriter, rollback);
4✔
730
    if (code) goto _exit;
4!
731
  }
732

733
  if (pWriter->pTqSnapOffsetWriter) {
53✔
734
    code = tqSnapWriterClose(&pWriter->pTqSnapOffsetWriter, rollback);
46✔
735
    if (code) goto _exit;
46!
736
  }
737
#endif
738
#ifdef USE_STREAM
739
  if (pWriter->pStreamTaskWriter) {
53!
UNCOV
740
    code = streamTaskSnapWriterClose(pWriter->pStreamTaskWriter, rollback, pWriter->pStreamStateWriter == NULL ? 1 : 0);
×
741

UNCOV
742
    if (code) goto _exit;
×
743
  }
744

745
  if (pWriter->pStreamStateWriter) {
53!
746
    code = streamStateSnapWriterClose(pWriter->pStreamStateWriter, rollback);
×
747
    if (code) goto _exit;
×
748

749
    code = streamStateRebuildFromSnap(pWriter->pStreamStateWriter, 0);
×
750
    pWriter->pStreamStateWriter = NULL;
×
751
    if (code) goto _exit;
×
752
  }
753
#endif
754
#ifdef USE_RSMA
755
  if (pWriter->pRsmaSnapWriter) {
53!
756
    code = rsmaSnapWriterClose(&pWriter->pRsmaSnapWriter, rollback);
×
757
    if (code) goto _exit;
×
758
  }
759
#endif
760
  code = vnodeBegin(pVnode);
53✔
761
  if (code) goto _exit;
53!
762

763
  (void)taosThreadMutexLock(&pVnode->mutex);
53✔
764
  pVnode->disableWrite = false;
53✔
765
  (void)taosThreadMutexUnlock(&pVnode->mutex);
53✔
766

767
_exit:
53✔
768
  if (code) {
53!
769
    vError("vgId:%d, vnode snapshot writer close failed since %s", TD_VID(pWriter->pVnode), tstrerror(code));
×
770
  } else {
771
    vInfo("vgId:%d, vnode snapshot writer closed, rollback:%d", TD_VID(pVnode), rollback);
53!
772
    taosMemoryFree(pWriter);
53!
773
  }
774
  if (vnodeEnableBgTask(pVnode) != 0) {
53!
775
    tsdbError("vgId:%d, failed to enable bg task", TD_VID(pVnode));
×
776
  }
777
  return code;
53✔
778
}
779

780
static int32_t vnodeSnapWriteInfo(SVSnapWriter *pWriter, uint8_t *pData, uint32_t nData) {
53✔
781
  int32_t       code = 0;
53✔
782
  int32_t       lino;
783
  SVnode       *pVnode = pWriter->pVnode;
53✔
784
  SSnapDataHdr *pHdr = (SSnapDataHdr *)pData;
53✔
785

786
  // decode info
787
  code = vnodeDecodeInfo(pHdr->data, &pWriter->info);
53✔
788
  TSDB_CHECK_CODE(code, lino, _exit);
53!
789

790
  // change some value
791
  pWriter->info.state.commitID = pWriter->commitID;
53✔
792

793
  // modify info as needed
794
  char dir[TSDB_FILENAME_LEN] = {0};
53✔
795
  vnodeGetPrimaryDir(pVnode->path, pVnode->diskPrimary, pVnode->pTfs, dir, TSDB_FILENAME_LEN);
53✔
796

797
  SVnodeStats vndStats = pWriter->info.config.vndStats;
53✔
798
  pWriter->info.config = pVnode->config;
53✔
799
  pWriter->info.config.vndStats = vndStats;
53✔
800
  vDebug("vgId:%d, save config while write snapshot", pWriter->pVnode->config.vgId);
53!
801
  code = vnodeSaveInfo(dir, &pWriter->info);
53✔
802
  TSDB_CHECK_CODE(code, lino, _exit);
53!
803

804
_exit:
53✔
805
  return code;
53✔
806
}
807

808
int32_t vnodeSnapWrite(SVSnapWriter *pWriter, uint8_t *pData, uint32_t nData) {
829✔
809
  int32_t       code = 0;
829✔
810
  int32_t       lino;
811
  SSnapDataHdr *pHdr = (SSnapDataHdr *)pData;
829✔
812
  SVnode       *pVnode = pWriter->pVnode;
829✔
813

814
  if (!(pHdr->size + sizeof(SSnapDataHdr) == nData)) {
829!
815
    return TSDB_CODE_INVALID_PARA;
×
816
  }
817

818
  if (pHdr->index != pWriter->index + 1) {
829!
819
    vError("vgId:%d, unexpected vnode snapshot msg. index:%" PRId64 ", expected index:%" PRId64, TD_VID(pVnode),
×
820
           pHdr->index, pWriter->index + 1);
821
    TSDB_CHECK_CODE(code = TSDB_CODE_INVALID_MSG, lino, _exit);
×
822
  }
823

824
  pWriter->index = pHdr->index;
829✔
825

826
  vDebug("vgId:%d, vnode snapshot write data, index:%" PRId64 " type:%d blockLen:%d", TD_VID(pVnode), pHdr->index,
829!
827
         pHdr->type, nData);
828

829
  switch (pHdr->type) {
829!
830
    case SNAP_DATA_CFG: {
53✔
831
      code = vnodeSnapWriteInfo(pWriter, pData, nData);
53✔
832
      TSDB_CHECK_CODE(code, lino, _exit);
53!
833
    } break;
53✔
834
    case SNAP_DATA_META: {
517✔
835
      // meta
836
      if (pWriter->pMetaSnapWriter == NULL) {
517✔
837
        code = metaSnapWriterOpen(pVnode->pMeta, pWriter->sver, pWriter->ever, &pWriter->pMetaSnapWriter);
48✔
838
        TSDB_CHECK_CODE(code, lino, _exit);
48!
839
      }
840

841
      code = metaSnapWrite(pWriter->pMetaSnapWriter, pData, nData);
517✔
842
      TSDB_CHECK_CODE(code, lino, _exit);
517!
843
    } break;
517✔
844
    case SNAP_DATA_TSDB:
×
845
    case SNAP_DATA_DEL: {
846
      // tsdb
847
      if (pWriter->pTsdbSnapWriter == NULL) {
×
848
        code = tsdbSnapWriterOpen(pVnode->pTsdb, pWriter->sver, pWriter->ever, pWriter->pRanges,
×
849
                                  &pWriter->pTsdbSnapWriter);
850
        TSDB_CHECK_CODE(code, lino, _exit);
×
851
      }
852

853
      code = tsdbSnapWrite(pWriter->pTsdbSnapWriter, pHdr);
×
854
      TSDB_CHECK_CODE(code, lino, _exit);
×
855
    } break;
×
856
    case SNAP_DATA_RAW: {
163✔
857
      // tsdb
858
      if (pWriter->pTsdbSnapRAWWriter == NULL) {
163✔
859
        code = tsdbSnapRAWWriterOpen(pVnode->pTsdb, pWriter->ever, &pWriter->pTsdbSnapRAWWriter);
50✔
860
        TSDB_CHECK_CODE(code, lino, _exit);
50!
861
      }
862

863
      code = tsdbSnapRAWWrite(pWriter->pTsdbSnapRAWWriter, pHdr);
163✔
864
      TSDB_CHECK_CODE(code, lino, _exit);
163!
865
    } break;
163✔
866
#ifdef USE_TQ
867
    case SNAP_DATA_TQ_HANDLE: {
46✔
868
      // tq handle
869
      if (pWriter->pTqSnapHandleWriter == NULL) {
46!
870
        code = tqSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pTqSnapHandleWriter);
46✔
871
        TSDB_CHECK_CODE(code, lino, _exit);
46!
872
      }
873

874
      code = tqSnapHandleWrite(pWriter->pTqSnapHandleWriter, pData, nData);
46✔
875
      TSDB_CHECK_CODE(code, lino, _exit);
46!
876
    } break;
46✔
877
    case SNAP_DATA_TQ_CHECKINFO: {
4✔
878
      // tq checkinfo
879
      if (pWriter->pTqSnapCheckInfoWriter == NULL) {
4!
880
        code = tqSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pTqSnapCheckInfoWriter);
4✔
881
        TSDB_CHECK_CODE(code, lino, _exit);
4!
882
      }
883

884
      code = tqSnapCheckInfoWrite(pWriter->pTqSnapCheckInfoWriter, pData, nData);
4✔
885
      TSDB_CHECK_CODE(code, lino, _exit);
4!
886
    } break;
4✔
887
    case SNAP_DATA_TQ_OFFSET: {
46✔
888
      // tq offset
889
      if (pWriter->pTqSnapOffsetWriter == NULL) {
46!
890
        code = tqSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pTqSnapOffsetWriter);
46✔
891
        TSDB_CHECK_CODE(code, lino, _exit);
46!
892
      }
893

894
      code = tqSnapOffsetWrite(pWriter->pTqSnapOffsetWriter, pData, nData);
46✔
895
      TSDB_CHECK_CODE(code, lino, _exit);
46!
896
    } break;
46✔
897
#endif
898
#ifdef USE_STREAM
UNCOV
899
    case SNAP_DATA_STREAM_TASK:
×
900
    case SNAP_DATA_STREAM_TASK_CHECKPOINT: {
UNCOV
901
      if (pWriter->pStreamTaskWriter == NULL) {
×
UNCOV
902
        code = streamTaskSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pStreamTaskWriter);
×
UNCOV
903
        TSDB_CHECK_CODE(code, lino, _exit);
×
904
      }
UNCOV
905
      code = streamTaskSnapWrite(pWriter->pStreamTaskWriter, pData, nData);
×
UNCOV
906
      TSDB_CHECK_CODE(code, lino, _exit);
×
UNCOV
907
    } break;
×
908
    case SNAP_DATA_STREAM_STATE_BACKEND: {
×
909
      if (pWriter->pStreamStateWriter == NULL) {
×
910
        code = streamStateSnapWriterOpen(pVnode->pTq, pWriter->sver, pWriter->ever, &pWriter->pStreamStateWriter);
×
911
        TSDB_CHECK_CODE(code, lino, _exit);
×
912
      }
913
      code = streamStateSnapWrite(pWriter->pStreamStateWriter, pData, nData);
×
914
      TSDB_CHECK_CODE(code, lino, _exit);
×
915

916
    } break;
×
917
#endif
918
#ifdef USE_RSMA
919
    case SNAP_DATA_RSMA1:
×
920
    case SNAP_DATA_RSMA2:
921
    case SNAP_DATA_QTASK: {
922
      // rsma1/rsma2/qtask for rsma
923
      if (pWriter->pRsmaSnapWriter == NULL) {
×
924
        code = rsmaSnapWriterOpen(pVnode->pSma, pWriter->sver, pWriter->ever, (void **)pWriter->pRsmaRanges,
×
925
                                  &pWriter->pRsmaSnapWriter);
926
        TSDB_CHECK_CODE(code, lino, _exit);
×
927
      }
928

929
      code = rsmaSnapWrite(pWriter->pRsmaSnapWriter, pData, nData);
×
930
      TSDB_CHECK_CODE(code, lino, _exit);
×
931
    } break;
×
932
#endif
933
    default:
×
934
      break;
×
935
  }
936
_exit:
829✔
937
  if (code) {
829!
938
    vError("vgId:%d, vnode snapshot write failed since %s, index:%" PRId64 " type:%d nData:%d", TD_VID(pVnode),
×
939
           tstrerror(code), pHdr->index, pHdr->type, nData);
940
  }
941
  return code;
829✔
942
}
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