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

taosdata / TDengine / #5013

03 Apr 2026 03:59PM UTC coverage: 72.317% (+0.01%) from 72.305%
#5013

push

travis-ci

web-flow
merge: from main to 3.0 branch #35067

4053 of 5985 new or added lines in 68 files covered. (67.72%)

13131 existing lines in 160 files now uncovered.

257489 of 356056 relevant lines covered (72.32%)

129893134.08 hits per line

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

69.02
/source/util/src/tpagedbuf.c
1
#define _DEFAULT_SOURCE
2
#include "tpagedbuf.h"
3
#include "taoserror.h"
4
#include "tcompression.h"
5
#include "tlog.h"
6
#include "tsimplehash.h"
7

8
#define GET_PAYLOAD_DATA(_p)           ((char*)(_p)->pData + POINTER_BYTES)
9
#define BUF_PAGE_IN_MEM(_p)            ((_p)->pData != NULL)
10
#define CLEAR_BUF_PAGE_IN_MEM_FLAG(_p) ((_p)->pData = NULL)
11
#define HAS_DATA_IN_DISK(_p)           ((_p)->offset >= 0)
12
#define NO_IN_MEM_AVAILABLE_PAGES(_b)  (listNEles((_b)->lruList) >= (_b)->inMemPages)
13

14
typedef struct SPageDiskInfo {
15
  int64_t offset;
16
  int32_t length;
17
} SPageDiskInfo, SFreeListItem;
18

19
struct SPageInfo {
20
  SListNode* pn;  // point to list node struct. it is NULL when the page is evicted from the in-memory buffer
21
  void*      pData;
22
  int64_t    offset;
23
  int32_t    pageId;
24
  int32_t    length : 29;
25
  bool       used : 1;   // set current page is in used
26
  bool       dirty : 1;  // set current buffer page is dirty or not
27
};
28

29
struct SDiskbasedBuf {
30
  int32_t    numOfPages;
31
  int64_t    totalBufSize;
32
  uint64_t   fileSize;  // disk file size
33
  TdFilePtr  pFile;
34
  int32_t    allocateId;  // allocated page id
35
  char*      path;        // file path
36
  char*      prefix;      // file name prefix
37
  int32_t    pageSize;    // current used page size
38
  int32_t    inMemPages;  // numOfPages that are allocated in memory
39
  SList*     freePgList;  // free page list
40
  SArray*    pIdList;     // page id list
41
  SSHashObj* all;
42
  SList*     lruList;
43
  void*      emptyDummyIdList;  // dummy id list
44
  void*      assistBuf;         // assistant buffer for compress/decompress data
45
  SArray*    pFree;             // free area in file
46
  bool       comp;              // compressed before flushed to disk
47
  uint64_t   nextPos;           // next page flush position
48

49
  char*               id;           // for debug purpose
50
  bool                printStatis;  // Print statistics info when closing this buffer.
51
  SDiskbasedBufStatis statis;
52
};
53

54
static int32_t createDiskFile(SDiskbasedBuf* pBuf) {
91,865✔
55
  if (pBuf->path == NULL) {  // prepare the file name when needed it
91,865✔
56
    char path[PATH_MAX] = {0};
91,865✔
57
    taosGetTmpfilePath(pBuf->prefix, "paged-buf", path);
91,865✔
58
    pBuf->path = taosStrdup(path);
91,865✔
59
    if (pBuf->path == NULL) {
91,865✔
60
      return terrno;
×
61
    }
62
  }
63

64
  pBuf->pFile =
91,865✔
65
      taosOpenFile(pBuf->path, TD_FILE_CREATE | TD_FILE_WRITE | TD_FILE_READ | TD_FILE_TRUNC | TD_FILE_AUTO_DEL);
91,865✔
66
  if (pBuf->pFile == NULL) {
91,865✔
67
    return terrno;
×
68
  }
69

70
  int64_t realSize = -1;
91,865✔
71
  if (taosFStatFile(pBuf->pFile, &realSize, NULL) != TSDB_CODE_SUCCESS) {
91,865✔
72
    realSize = -1;
×
73
  }
74
  uDebug("paged buffer file opened, path:%s, realSize:%" PRId64 ", nextPos:%" PRIu64 ", fileSize:%" PRIu64 ", %s",
91,865✔
75
         pBuf->path, realSize, pBuf->nextPos, pBuf->fileSize, pBuf->id);
76

77
  return TSDB_CODE_SUCCESS;
91,865✔
78
}
79

80
static char* doCompressData(void* data, int32_t srcSize, int32_t* dst, SDiskbasedBuf* pBuf) {  // do nothing
365,791,890✔
81
  if (!pBuf->comp) {
365,791,890✔
82
    *dst = srcSize;
365,791,890✔
83
    return data;
365,791,890✔
84
  }
85

86
  *dst = tsCompressString(data, srcSize, 1, pBuf->assistBuf, srcSize, ONE_STAGE_COMP, NULL, 0);
×
87

88
  memcpy(data, pBuf->assistBuf, *dst);
×
89
  return data;
×
90
}
91

92
static int32_t doDecompressData(void* data, int32_t srcSize, int32_t* dst, SDiskbasedBuf* pBuf) {  // do nothing
300,139,157✔
93
  int32_t code = 0;
300,139,157✔
94
  if (!pBuf->comp) {
300,139,157✔
95
    *dst = srcSize;
300,139,157✔
96
    return code;
300,139,157✔
97
  }
98

99
  *dst = tsDecompressString(data, srcSize, 1, pBuf->assistBuf, pBuf->pageSize, ONE_STAGE_COMP, NULL, 0);
×
100
  if (*dst > 0) {
×
101
    memcpy(data, pBuf->assistBuf, *dst);
×
102
  } else if (*dst < 0) {
×
103
    return terrno;
×
104
  }
105
  return code;
×
106
  ;
107
}
108

109
static uint64_t allocateNewPositionInFile(SDiskbasedBuf* pBuf, size_t size) {
365,252,240✔
110
  if (pBuf->pFree == NULL) {
365,252,240✔
111
    return pBuf->nextPos;
×
112
  } else {
113
    int32_t offset = -1;
365,252,240✔
114

115
    size_t num = taosArrayGetSize(pBuf->pFree);
365,252,240✔
116
    for (int32_t i = 0; i < num; ++i) {
365,252,240✔
117
      SFreeListItem* pi = taosArrayGet(pBuf->pFree, i);
×
118
      if (pi->length >= size) {
×
119
        offset = pi->offset;
×
120
        pi->offset += (int32_t)size;
×
121
        pi->length -= (int32_t)size;
×
122

123
        return offset;
×
124
      }
125
    }
126

127
    // no available recycle space, allocate new area in file
128
    return pBuf->nextPos;
365,252,240✔
129
  }
130
}
131

132
/**
133
 *   +--------------------------+-------------------+--------------+
134
 *   | PTR to SPageInfo (8bytes)| Payload (PageSize)| 2 Extra Bytes|
135
 *   +--------------------------+-------------------+--------------+
136
 * @param pBuf
137
 * @param pg
138
 * @return
139
 */
140

141
static FORCE_INLINE size_t getAllocPageSize(int32_t pageSize) { return pageSize + POINTER_BYTES + sizeof(SFilePage); }
1,800,996,280✔
142

143
static int32_t doFlushBufPageImpl(SDiskbasedBuf* pBuf, int64_t offset, const char* pData, int32_t size) {
365,789,713✔
144
  int64_t ret = taosLSeekFile(pBuf->pFile, offset, SEEK_SET);
365,789,713✔
145
  if (ret < 0) {
365,791,162✔
146
    return terrno;
×
147
  }
148

149
  ret = (int32_t)taosWriteFile(pBuf->pFile, pData, size);
365,791,162✔
150
  if (ret != size) {
365,791,162✔
151
    return terrno;
×
152
  }
153

154
  // extend the file
155
  if (pBuf->fileSize < offset + size) {
365,791,162✔
156
    pBuf->fileSize = offset + size;
365,252,240✔
157
  }
158

159
  pBuf->statis.flushBytes += size;
365,791,162✔
160
  pBuf->statis.flushPages += 1;
365,790,657✔
161

162
  return TSDB_CODE_SUCCESS;
365,791,162✔
163
}
164

165
static char* doFlushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
541,809,102✔
166
  if (pg->pData == NULL || pg->used) {
541,809,102✔
UNCOV
167
    uError("invalid params in paged buffer process when flushing buf to disk, %s", pBuf->id);
×
UNCOV
168
    terrno = TSDB_CODE_INVALID_PARA;
×
169
    return NULL;
×
170
  }
171

172
  int32_t size = pBuf->pageSize;
541,809,102✔
173
  int64_t offset = pg->offset;
541,809,102✔
174

175
  char* t = NULL;
541,809,102✔
176
  if ((!HAS_DATA_IN_DISK(pg)) || pg->dirty) {
541,809,102✔
177
    void* payload = GET_PAYLOAD_DATA(pg);
365,791,890✔
178
    t = doCompressData(payload, pBuf->pageSize + sizeof(SFilePage), &size, pBuf);
365,791,890✔
179
    if (size < 0) {
365,791,890✔
180
      uError("failed to compress data when flushing data to disk, %s", pBuf->id);
×
181
      terrno = TSDB_CODE_INVALID_PARA;
×
182
      return NULL;
×
183
    }
184
  }
185

186
  // this page is flushed to disk for the first time
187
  if (pg->dirty) {
541,809,102✔
188
    if (!HAS_DATA_IN_DISK(pg)) {
365,791,162✔
189
      offset = allocateNewPositionInFile(pBuf, size);
365,252,745✔
190
      pBuf->nextPos += size;
365,251,296✔
191

192
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
365,251,296✔
193
      if (code != TSDB_CODE_SUCCESS) {
365,252,745✔
194
        return NULL;
×
195
      }
196
    } else {
197
      // length becomes greater, current space is not enough, allocate new place, otherwise, do nothing
198
      if (pg->length < size) {
538,417✔
199
        // 1. add current space to free list
200
        SPageDiskInfo dinfo = {.length = pg->length, .offset = offset};
×
201
        if (NULL == taosArrayPush(pBuf->pFree, &dinfo)) {
×
202
          return NULL;
×
203
        }
204

205
        // 2. allocate new position, and update the info
206
        offset = allocateNewPositionInFile(pBuf, size);
×
207
        pBuf->nextPos += size;
×
208
      }
209

210
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
538,417✔
211
      if (code != TSDB_CODE_SUCCESS) {
538,417✔
212
        return NULL;
×
213
      }
214
    }
215
  } else {  // NOTE: the size may be -1, the this recycle page has not been flushed to disk yet.
216
    size = pg->length;
176,017,940✔
217
  }
218

219
  char* pDataBuf = pg->pData;
541,809,102✔
220
  memset(pDataBuf, 0, getAllocPageSize(pBuf->pageSize));
1,083,617,268✔
221

222
#ifdef BUF_PAGE_DEBUG
223
  uDebug("page_flush %p, pageId:%d, offset:%d", pDataBuf, pg->pageId, offset);
224
#endif
225

226
  pg->offset = offset;
541,809,102✔
227
  pg->length = size;  // on disk size
541,808,630✔
228
  return pDataBuf;
541,809,102✔
229
}
230

231
static char* flushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
541,808,597✔
232
  int32_t ret = TSDB_CODE_SUCCESS;
541,808,597✔
233

234
  if (pBuf->pFile == NULL) {
541,808,597✔
235
    if ((ret = createDiskFile(pBuf)) != TSDB_CODE_SUCCESS) {
91,865✔
236
      terrno = ret;
×
237
      return NULL;
×
238
    }
239
  }
240

241
  char* p = doFlushBufPage(pBuf, pg);
541,808,597✔
242
  CLEAR_BUF_PAGE_IN_MEM_FLAG(pg);
541,808,630✔
243

244
  pg->dirty = false;
541,808,630✔
245
  return p;
541,808,630✔
246
}
247

248
// load file block data in disk
249
static int32_t loadPageFromDisk(SDiskbasedBuf* pBuf, SPageInfo* pg) {
300,139,157✔
250
  if (pg->offset < 0 || pg->length <= 0) {
300,139,157✔
251
    uError("failed to load buf page from disk, offset:%" PRId64 ", length:%d, %s", pg->offset, pg->length, pBuf->id);
×
252
    return TSDB_CODE_INVALID_PARA;
×
253
  }
254

255
  int64_t ret = taosLSeekFile(pBuf->pFile, pg->offset, SEEK_SET);
300,139,157✔
256
  if (ret < 0) {
300,139,157✔
257
    ret = terrno;
×
258
    return ret;
×
259
  }
260

261
  void* pPage = (void*)GET_PAYLOAD_DATA(pg);
300,139,157✔
262
  ret = taosReadFile(pBuf->pFile, pPage, pg->length);
300,139,157✔
263
  if (ret != pg->length) {
300,139,157✔
264
    ret = terrno;
×
265
    return ret;
×
266
  }
267

268
  pBuf->statis.loadBytes += pg->length;
300,139,157✔
269
  pBuf->statis.loadPages += 1;
300,139,157✔
270

271
  int32_t fullSize = 0;
300,139,157✔
272
  return doDecompressData(pPage, pg->length, &fullSize, pBuf);
300,139,157✔
273
}
274

275
static SPageInfo* registerNewPageInfo(SDiskbasedBuf* pBuf, int32_t pageId) {
1,500,827,712✔
276
  pBuf->numOfPages += 1;
1,500,827,712✔
277

278
  SPageInfo* ppi = taosMemoryMalloc(sizeof(SPageInfo));
1,500,913,015✔
279
  if (ppi == NULL) {
1,500,810,795✔
280
    return NULL;
×
281
  }
282

283
  ppi->pageId = pageId;
1,500,810,795✔
284
  ppi->pData = NULL;
1,500,810,399✔
285
  ppi->offset = -1;
1,500,892,576✔
286
  ppi->length = -1;
1,500,908,437✔
287
  ppi->used = true;
1,500,921,786✔
288
  ppi->pn = NULL;
1,500,897,485✔
289
  ppi->dirty = false;
1,500,830,611✔
290

291
  SPageInfo** pRet = taosArrayPush(pBuf->pIdList, &ppi);
1,500,986,018✔
292
  if (NULL == pRet) {
1,500,925,886✔
293
    taosMemoryFree(ppi);
×
294
    return NULL;
×
295
  }
296
  return *pRet;
1,500,925,886✔
297
}
298

299
static SListNode* getEldestUnrefedPage(SDiskbasedBuf* pBuf) {
541,803,580✔
300
  SListIter iter = {0};
541,803,580✔
301
  tdListInitIter(pBuf->lruList, &iter, TD_LIST_BACKWARD);
541,808,630✔
302

303
  SListNode* pn = NULL;
541,809,102✔
304
  while ((pn = tdListNext(&iter)) != NULL) {
593,747,936✔
305
    SPageInfo* pageInfo = *(SPageInfo**)pn->data;
593,747,936✔
306

307
    SPageInfo* p = *(SPageInfo**)(pageInfo->pData);
593,747,936✔
308

309
    if (!pageInfo->used) {
593,746,992✔
310
      break;
541,808,630✔
311
    }
312
  }
313

314
  return pn;
541,808,630✔
315
}
316

317
static char* evictBufPage(SDiskbasedBuf* pBuf) {
541,808,630✔
318
  SListNode* pn = getEldestUnrefedPage(pBuf);
541,808,630✔
319
  if (pn == NULL) {  // no available buffer pages now, return.
541,808,630✔
320
    return NULL;
×
321
  }
322

323
  terrno = 0;
541,808,630✔
324
  pn = tdListPopNode(pBuf->lruList, pn);
541,808,125✔
325

326
  SPageInfo* d = *(SPageInfo**)pn->data;
541,808,125✔
327

328
  d->pn = NULL;
541,808,125✔
329
  taosMemoryFreeClear(pn);
541,808,125✔
330

331
  return flushBufPage(pBuf, d);
541,808,597✔
332
}
333

334
static int32_t lruListPushFront(SList* pList, SPageInfo* pi) {
1,800,972,152✔
335
  int32_t code = tdListPrepend(pList, &pi);
1,800,972,152✔
336
  if (TSDB_CODE_SUCCESS != code) {
1,801,027,802✔
337
    return code;
×
338
  }
339
  SListNode* front = tdListGetHead(pList);
1,801,027,802✔
340
  pi->pn = front;
1,800,992,025✔
341
  return TSDB_CODE_SUCCESS;
1,801,011,680✔
342
}
343

344
static void lruListMoveToFront(SList* pList, SPageInfo* pi) {
2,147,483,647✔
345
  pi->pn = tdListPopNode(pList, pi->pn);
2,147,483,647✔
346
  tdListPrependNode(pList, pi->pn);
2,147,483,647✔
347
}
2,147,483,647✔
348

349
static SPageInfo* getPageInfoFromPayload(void* page) {
2,147,483,647✔
350
  char* p = (char*)page - POINTER_BYTES;
2,147,483,647✔
351

352
  SPageInfo* ppi = ((SPageInfo**)p)[0];
2,147,483,647✔
353
  return ppi;
2,147,483,647✔
354
}
355

356
int32_t createDiskbasedBuf(SDiskbasedBuf** pBuf, int32_t pagesize, int64_t inMemBufSize, const char* id,
331,099,522✔
357
                           const char* dir) {
358
  int32_t code = 0;
331,099,522✔
359
  *pBuf = NULL;
331,099,522✔
360
  SDiskbasedBuf* pPBuf = taosMemoryCalloc(1, sizeof(SDiskbasedBuf));
331,157,316✔
361
  if (pPBuf == NULL) {
330,716,111✔
362
    code = terrno;
×
363
    goto _error;
×
364
  }
365

366
  pPBuf->pageSize = pagesize;
330,716,111✔
367
  pPBuf->numOfPages = 0;  // all pages are in buffer in the first place
330,725,126✔
368
  pPBuf->totalBufSize = 0;
330,820,635✔
369
  pPBuf->allocateId = -1;
330,858,554✔
370
  pPBuf->pFile = NULL;
330,827,822✔
371
  pPBuf->id = taosStrdup(id);
330,998,123✔
372
  if (id != NULL && pPBuf->id == NULL) {
331,040,855✔
373
    code = terrno;
×
374
    goto _error;
×
375
  }
376
  pPBuf->fileSize = 0;
331,092,485✔
377
  pPBuf->pFree = taosArrayInit(4, sizeof(SFreeListItem));
331,106,880✔
378
  pPBuf->freePgList = tdListNew(POINTER_BYTES);
330,957,886✔
379
  if (pPBuf->pFree == NULL || pPBuf->freePgList == NULL) {
330,886,534✔
380
    code = terrno;
44✔
381
    goto _error;
×
382
  }
383

384
  // at least more than 2 pages must be in memory
385
  if (inMemBufSize < pagesize * 2) {
331,098,707✔
386
    inMemBufSize = pagesize * 2;
1,184,655✔
387
  }
388

389
  pPBuf->inMemPages = inMemBufSize / pagesize;  // maximum allowed pages, it is a soft limit.
331,098,707✔
390
  pPBuf->lruList = tdListNew(POINTER_BYTES);
331,004,541✔
391
  if (pPBuf->lruList == NULL) {
331,085,762✔
392
    code = terrno;
×
393
    goto _error;
×
394
  }
395

396
  // init id hash table
397
  _hash_fn_t fn = taosGetDefaultHashFunction(TSDB_DATA_TYPE_INT);
331,079,580✔
398
  pPBuf->pIdList = taosArrayInit(4, POINTER_BYTES);
331,092,508✔
399
  if (pPBuf->pIdList == NULL) {
331,075,215✔
400
    code = terrno;
×
401
    goto _error;
×
402
  }
403

404
  pPBuf->all = tSimpleHashInit(64, fn);
330,997,825✔
405
  if (pPBuf->all == NULL) {
331,009,015✔
406
    code = terrno;
×
407
    goto _error;
×
408
  }
409

410
  pPBuf->prefix = (char*)dir;
331,020,857✔
411
  pPBuf->emptyDummyIdList = taosArrayInit(1, sizeof(int32_t));
331,052,991✔
412
  if (pPBuf->emptyDummyIdList == NULL) {
331,153,767✔
413
    code = terrno;
×
414
    goto _error;
×
415
  }
416

417
  //  qDebug("QInfo:0x%"PRIx64 ", create resBuf for output, page size:%d, inmem buf pages:%d, file:%s", qId,
418
  //  pPBuf->pageSize, pPBuf->inMemPages, pPBuf->path);
419

420
  *pBuf = pPBuf;
331,101,609✔
421
  return TSDB_CODE_SUCCESS;
331,132,733✔
422

423
_error:
×
424
  destroyDiskbasedBuf(pPBuf);
×
425
  *pBuf = NULL;
×
426
  return code;
×
427
}
428

429
static char* doExtractPage(SDiskbasedBuf* pBuf) {
1,800,830,601✔
430
  char* availablePage = NULL;
1,800,830,601✔
431
  if (NO_IN_MEM_AVAILABLE_PAGES(pBuf)) {
1,800,830,601✔
432
    availablePage = evictBufPage(pBuf);
541,808,630✔
433
    if (availablePage == NULL) {
541,808,630✔
434
      uWarn("no available buf pages, current:%d, max:%d, reason: %s, %s", listNEles(pBuf->lruList), pBuf->inMemPages,
×
435
            terrstr(), pBuf->id)
436
    }
437
  } else {
438
    availablePage =
1,258,792,148✔
439
        taosMemoryCalloc(1, getAllocPageSize(pBuf->pageSize));  // add extract bytes in case of zipped buffer increased.
2,147,483,647✔
440
  }
441

442
  return availablePage;
1,800,598,498✔
443
}
444

445
void* getNewBufPage(SDiskbasedBuf* pBuf, int32_t* pageId) {
1,500,721,660✔
446
  pBuf->statis.getPages += 1;
1,500,721,660✔
447

448
  char* availablePage = doExtractPage(pBuf);
1,500,746,933✔
449
  if (availablePage == NULL) {
1,500,453,251✔
450
    return NULL;
×
451
  }
452

453
  SPageInfo* pi = NULL;
1,500,453,251✔
454
  int32_t    code = 0;
1,500,458,950✔
455
  if (listNEles(pBuf->freePgList) != 0) {
1,500,458,950✔
456
    SListNode* pItem = tdListPopHead(pBuf->freePgList);
×
457
    pi = *(SPageInfo**)pItem->data;
×
458
    pi->used = true;
×
459
    *pageId = pi->pageId;
×
460
    taosMemoryFreeClear(pItem);
×
461
    code = lruListPushFront(pBuf->lruList, pi);
×
462
    if (TSDB_CODE_SUCCESS != code) {
×
463
      taosMemoryFree(pi);
96✔
464
      taosMemoryFree(availablePage);
×
465
      terrno = code;
×
466
      return NULL;
×
467
    }
468
  } else {  // create a new pageinfo
469
    // register new id in this group
470
    *pageId = (++pBuf->allocateId);
1,500,626,318✔
471

472
    // register page id info
473
    pi = registerNewPageInfo(pBuf, *pageId);
1,500,790,743✔
474
    if (pi == NULL) {
1,500,805,953✔
475
      taosMemoryFree(availablePage);
×
476
      return NULL;
×
477
    }
478

479
    // add to hash map
480
    int32_t code = tSimpleHashPut(pBuf->all, pageId, sizeof(int32_t), &pi, POINTER_BYTES);
1,500,805,953✔
481

482
    if (TSDB_CODE_SUCCESS == code) {
1,500,874,719✔
483
      // add to LRU list
484
      code = lruListPushFront(pBuf->lruList, pi);
1,500,907,508✔
485
    }
486
    if (TSDB_CODE_SUCCESS == code) {
1,500,860,317✔
487
      pBuf->totalBufSize += pBuf->pageSize;
1,500,860,317✔
488
    } else {
489
      taosMemoryFree(availablePage);
×
490
      SPageInfo **pLast = taosArrayPop(pBuf->pIdList);
×
491
      int32_t ret = tSimpleHashRemove(pBuf->all, pageId, sizeof(int32_t));
×
492
      if (ret != TSDB_CODE_SUCCESS) {
×
493
        uError("%s failed to clear pageId %d from buf hash-set since %s", __func__, *pageId, tstrerror(ret));
×
494
      }
495
      taosMemoryFree(pi);
×
496
      terrno = code;
×
497
      return NULL;
×
498
    }
499
  }
500

501
  pi->pData = availablePage;
1,500,844,742✔
502

503
  ((void**)pi->pData)[0] = pi;
1,500,873,352✔
504
#ifdef BUF_PAGE_DEBUG
505
  uDebug("page_getNewBufPage , pi->pData:%p, pageId:%d, offset:%" PRId64, pi->pData, pi->pageId, pi->offset);
506
#endif
507

508
  return (void*)(GET_PAYLOAD_DATA(pi));
1,500,913,303✔
509
}
510

511
void* getBufPage(SDiskbasedBuf* pBuf, int32_t id) {
2,147,483,647✔
512
  if (id < 0) {
2,147,483,647✔
513
    terrno = TSDB_CODE_INVALID_PARA;
×
514
    uError("invalid page id:%d, %s", id, pBuf->id);
×
515
    return NULL;
×
516
  }
517

518
  pBuf->statis.getPages += 1;
2,147,483,647✔
519

520
  SPageInfo** pi = tSimpleHashGet(pBuf->all, &id, sizeof(int32_t));
2,147,483,647✔
521
  if (pi == NULL || *pi == NULL) {
2,147,483,647✔
522
    uError("failed to locate the buffer page:%d, %s", id, pBuf->id);
36✔
523
    terrno = TSDB_CODE_INVALID_PARA;
36✔
524
    return NULL;
×
525
  }
526

527
  if (BUF_PAGE_IN_MEM(*pi)) {  // it is in memory
2,147,483,647✔
528
    // no need to update the LRU list if only one page exists
529
    if (pBuf->numOfPages == 1) {
2,147,483,647✔
530
      (*pi)->used = true;
2,147,483,647✔
531
      return (void*)(GET_PAYLOAD_DATA(*pi));
2,147,483,647✔
532
    }
533

534
    SPageInfo** pInfo = (SPageInfo**)((*pi)->pn->data);
2,147,483,647✔
535
    if (*pInfo != *pi) {
2,147,483,647✔
536
      terrno = TSDB_CODE_APP_ERROR;
×
537
      uError("inconsistently data in paged buffer, pInfo:%p, pi:%p, %s", *pInfo, *pi, pBuf->id);
×
538
      return NULL;
×
539
    }
540

541
    lruListMoveToFront(pBuf->lruList, (*pi));
2,147,483,647✔
542
    (*pi)->used = true;
2,147,483,647✔
543

544
#ifdef BUF_PAGE_DEBUG
545
    uDebug("page_getBufPage1 pageId:%d, offset:%" PRId64, (*pi)->pageId, (*pi)->offset);
546
#endif
547
    return (void*)(GET_PAYLOAD_DATA(*pi));
2,147,483,647✔
548
  } else {  // not in memory
549

550
    (*pi)->pData = doExtractPage(pBuf);
300,139,261✔
551

552
    // failed to evict buffer page, return with error code.
553
    if ((*pi)->pData == NULL) {
300,139,261✔
554
      return NULL;
×
555
    }
556

557
    // set the ptr to the new SPageInfo
558
    ((void**)((*pi)->pData))[0] = (*pi);
300,139,261✔
559

560
    int32_t code = lruListPushFront(pBuf->lruList, *pi);
300,139,261✔
561
    if (TSDB_CODE_SUCCESS != code) {
300,139,261✔
562
      taosMemoryFree((*pi)->pData);
×
563
      (*pi)->pData = NULL;
×
564
      terrno = code;
×
565
      return NULL;
×
566
    }
567
    (*pi)->used = true;
300,139,261✔
568

569
    // some data has been flushed to disk, and needs to be loaded into buffer again.
570
    if (HAS_DATA_IN_DISK(*pi)) {
300,139,261✔
571
      int32_t code = loadPageFromDisk(pBuf, *pi);
300,139,157✔
572
      if (code != 0) {
300,139,157✔
573
        taosMemoryFree((*pi)->pData);
×
574
        (*pi)->pData = NULL;
×
575
        terrno = code;
×
576
        return NULL;
×
577
      }
578
    }
579
#ifdef BUF_PAGE_DEBUG
580
    uDebug("page_getBufPage2 pageId:%d, offset:%" PRId64, (*pi)->pageId, (*pi)->offset);
581
#endif
582
    return (void*)(GET_PAYLOAD_DATA(*pi));
300,139,261✔
583
  }
584
}
585

586
void releaseBufPage(SDiskbasedBuf* pBuf, void* page) {
2,147,483,647✔
587
  if (page == NULL) {
2,147,483,647✔
588
    return;
×
589
  }
590

591
  SPageInfo* ppi = getPageInfoFromPayload(page);
2,147,483,647✔
592
  releaseBufPageInfo(pBuf, ppi);
2,147,483,647✔
593
}
594

595
void releaseBufPageInfo(SDiskbasedBuf* pBuf, SPageInfo* pi) {
2,147,483,647✔
596
#ifdef BUF_PAGE_DEBUG
597
  uDebug("page_releaseBufPageInfo pageId:%d, used:%d, offset:%" PRId64, pi->pageId, pi->used, pi->offset);
598
#endif
599

600
  if (pi == NULL) {
2,147,483,647✔
601
    return;
×
602
  }
603

604
  if (pi->pData == NULL) {
2,147,483,647✔
605
    uError("pi->pData (page data) is null");
×
606
    return;
×
607
  }
608

609
  pi->used = false;
2,147,483,647✔
610
  pBuf->statis.releasePages += 1;
2,147,483,647✔
611
}
612

613
size_t getTotalBufSize(const SDiskbasedBuf* pBuf) { return (size_t)pBuf->totalBufSize; }
104✔
614

615
SArray* getDataBufPagesIdList(SDiskbasedBuf* pBuf) { return pBuf->pIdList; }
312✔
616

617
void destroyDiskbasedBuf(SDiskbasedBuf* pBuf) {
390,983,388✔
618
  if (pBuf == NULL) {
390,983,388✔
619
    return;
59,793,012✔
620
  }
621

622
  dBufPrintStatis(pBuf);
331,190,376✔
623

624
  bool needRemoveFile = false;
331,173,188✔
625
  if (pBuf->pFile != NULL) {
331,173,188✔
626
    needRemoveFile = true;
91,865✔
627
    uDebug(
91,865✔
628
        "Paged buffer closed, total:%.2f Kb (%d Pages), inmem size:%.2f Kb (%d Pages), file size:%.2f Kb, page "
629
        "size:%.2f Kb, %s",
630
        pBuf->totalBufSize / 1024.0, pBuf->numOfPages, listNEles(pBuf->lruList) * pBuf->pageSize / 1024.0,
631
        listNEles(pBuf->lruList), pBuf->fileSize / 1024.0, pBuf->pageSize / 1024.0f, pBuf->id);
632

633
    int32_t code = taosCloseFile(&pBuf->pFile);
91,865✔
634
    if (TSDB_CODE_SUCCESS != code) {
91,865✔
635
      uError("failed to close paged buffer file when destroying, path:%s, closeCode:%d, err:%s, %s", pBuf->path, code,
×
636
             tstrerror(code), pBuf->id);
637
    }
638
  } else {
639
    uDebug("Paged buffer closed, total:%.2f Kb, no file created, %s", pBuf->totalBufSize / 1024.0, pBuf->id);
331,043,835✔
640
  }
641

642
  // print the statistics information
643
  {
644
    SDiskbasedBufStatis* ps = &pBuf->statis;
331,135,953✔
645
    if (ps->loadPages == 0) {
331,195,709✔
646
      uDebug("Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages)", ps->getPages,
331,110,374✔
647
             ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f, ps->loadPages);
648
    } else {
649
      uDebug(
91,657✔
650
          "Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages), avgPgSize:%.2f Kb",
651
          ps->getPages, ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f,
652
          ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
653
    }
654
  }
655

656
  if (needRemoveFile) {
331,186,581✔
657
    int32_t ret = taosRemoveFile(pBuf->path);
91,865✔
658
    if (ret != 0) {  // print the error and discard this error info
91,865✔
659
      uDebug("WARNING tPage remove file failed. path=%s, code:%s", pBuf->path, strerror(ERRNO));
91,865✔
660
    }
661
  }
662

663
  taosMemoryFreeClear(pBuf->path);
331,186,581✔
664

665
  size_t n = taosArrayGetSize(pBuf->pIdList);
331,203,069✔
666
  for (int32_t i = 0; i < n; ++i) {
1,566,651,004✔
667
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
1,235,483,463✔
668
    taosMemoryFreeClear(pi->pData);
1,235,457,913✔
669
    taosMemoryFreeClear(pi);
1,235,339,676✔
670
  }
671

672
  taosArrayDestroy(pBuf->pIdList);
331,167,541✔
673

674
  pBuf->lruList = tdListFree(pBuf->lruList);
331,133,718✔
675
  pBuf->freePgList = tdListFree(pBuf->freePgList);
331,125,405✔
676

677
  taosArrayDestroy(pBuf->emptyDummyIdList);
331,150,565✔
678
  taosArrayDestroy(pBuf->pFree);
331,144,926✔
679

680
  tSimpleHashCleanup(pBuf->all);
331,137,094✔
681

682
  taosMemoryFreeClear(pBuf->id);
331,167,762✔
683
  taosMemoryFreeClear(pBuf->assistBuf);
331,162,146✔
684
  taosMemoryFreeClear(pBuf);
331,176,835✔
685
}
686

687
SPageInfo* getLastPageInfo(SArray* pList) {
×
688
  size_t     size = taosArrayGetSize(pList);
×
689
  SPageInfo* pPgInfo = taosArrayGetP(pList, size - 1);
×
690
  return pPgInfo;
×
691
}
692

693
int32_t getPageId(const SPageInfo* pPgInfo) { return pPgInfo->pageId; }
×
694

695
int32_t getBufPageSize(const SDiskbasedBuf* pBuf) { return pBuf->pageSize; }
2,147,483,647✔
696

697
int32_t getNumOfInMemBufPages(const SDiskbasedBuf* pBuf) { return pBuf->inMemPages; }
9,401,248✔
698

699
bool isAllDataInMemBuf(const SDiskbasedBuf* pBuf) { return pBuf->fileSize == 0; }
×
700

701
void setBufPageDirty(void* pPage, bool dirty) {
2,147,483,647✔
702
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
2,147,483,647✔
703
  ppi->dirty = dirty;
2,147,483,647✔
704
}
2,147,483,647✔
705

706
int32_t setBufPageCompressOnDisk(SDiskbasedBuf* pBuf, bool comp) {
×
707
  pBuf->comp = comp;
×
708
  if (comp && (pBuf->assistBuf == NULL)) {
×
709
    pBuf->assistBuf = taosMemoryMalloc(pBuf->pageSize + 2);  // EXTRA BYTES
×
710
    if (pBuf->assistBuf) {
×
711
      return terrno;
×
712
    }
713
  }
714
  return TSDB_CODE_SUCCESS;
×
715
}
716

717
int32_t dBufSetBufPageRecycled(SDiskbasedBuf* pBuf, void* pPage) {
×
718
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
×
719

720
  int32_t code = tdListAppend(pBuf->freePgList, &ppi);
×
721
  if (TSDB_CODE_SUCCESS != code) {
×
722
    return code;
×
723
  }
724

725
  ppi->used = false;
×
726
  ppi->dirty = false;
×
727

728
  // add this pageinfo into the free page info list
729
  SListNode* pNode = tdListPopNode(pBuf->lruList, ppi->pn);
×
730
  taosMemoryFreeClear(ppi->pData);
×
731
  taosMemoryFreeClear(pNode);
×
732
  ppi->pn = NULL;
×
733
  return TSDB_CODE_SUCCESS;
×
734
}
735

736
void dBufSetPrintInfo(SDiskbasedBuf* pBuf) { pBuf->printStatis = true; }
28,699,898✔
737

738
SDiskbasedBufStatis getDBufStatis(const SDiskbasedBuf* pBuf) { return pBuf->statis; }
9,861,959✔
739

740
void dBufPrintStatis(const SDiskbasedBuf* pBuf) {
331,188,017✔
741
  if (!pBuf->printStatis) {
331,188,017✔
742
    return;
302,509,035✔
743
  }
744

745
  const SDiskbasedBufStatis* ps = &pBuf->statis;
28,690,994✔
746

747
#if 0
748
  printf(
749
      "Paged buffer closed, total:%.2f Kb (%d Pages), inmem size:%.2f Kb (%d Pages), file size:%.2f Kb, page size:%.2f "
750
      "Kb, %s\n",
751
      pBuf->totalBufSize / 1024.0, pBuf->numOfPages, listNEles(pBuf->lruList) * pBuf->pageSize / 1024.0,
752
      listNEles(pBuf->lruList), pBuf->fileSize / 1024.0, pBuf->pageSize / 1024.0f, pBuf->id);
753
#endif
754

755
  if (ps->loadPages > 0) {
28,701,188✔
756
    (void)printf(
18,634✔
757
        "Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages), avgPageSize:%.2f "
758
        "Kb\n",
759
        ps->getPages, ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f,
18,634✔
760
        ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
18,634✔
761
  } else {
762
    // printf("no page loaded\n");
763
  }
764
}
765

766
void clearDiskbasedBuf(SDiskbasedBuf* pBuf) {
2,849,030✔
767
  if (pBuf == NULL) {
2,849,030✔
768
    return;
×
769
  }
770

771
  int64_t realSizeBefore = -1;
2,849,030✔
772
  if (pBuf->pFile != NULL && taosFStatFile(pBuf->pFile, &realSizeBefore, NULL) != TSDB_CODE_SUCCESS) {
2,849,818✔
773
    realSizeBefore = -1;
×
774
  }
775

776
  const SDiskbasedBufStatis* ps = &pBuf->statis;
2,850,230✔
777
  uDebug(
2,849,433✔
778
      "clear paged buffer begin, pages:%d, inMemPages:%d, fileSize:%" PRIu64 ", nextPos:%" PRIu64
779
      ", realSize:%" PRId64 ", get/release:%d/%d, flush/load:%d/%d, %s",
780
      pBuf->numOfPages, listNEles(pBuf->lruList), pBuf->fileSize, pBuf->nextPos, realSizeBefore, ps->getPages,
781
      ps->releasePages, ps->flushPages, ps->loadPages, pBuf->id);
782

783
  size_t n = taosArrayGetSize(pBuf->pIdList);
2,849,433✔
784
  for (int32_t i = 0; i < n; ++i) {
268,344,375✔
785
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
265,497,754✔
786
    taosMemoryFreeClear(pi->pData);
265,498,542✔
787
    taosMemoryFreeClear(pi);
265,489,669✔
788
  }
789

790
  taosArrayClear(pBuf->pIdList);
2,846,621✔
791

792
  tdListEmpty(pBuf->lruList);
2,847,821✔
793
  tdListEmpty(pBuf->freePgList);
2,845,833✔
794

795
  taosArrayClear(pBuf->emptyDummyIdList);
2,846,236✔
796
  taosArrayClear(pBuf->pFree);
2,845,842✔
797

798
  tSimpleHashClear(pBuf->all);
2,846,639✔
799

800
  pBuf->numOfPages = 0;  // all pages are in buffer in the first place
2,849,415✔
801
  pBuf->totalBufSize = 0;
2,849,415✔
802
  pBuf->allocateId = -1;
2,849,818✔
803
  pBuf->fileSize = 0;
2,849,818✔
804
  pBuf->nextPos = 0;
2,849,827✔
805

806
  if (pBuf->pFile != NULL) {
2,849,809✔
807
    int32_t code = taosFtruncateFile(pBuf->pFile, 0);
26,408✔
808
    if (code != TSDB_CODE_SUCCESS) {
26,408✔
809
      uWarn("failed to truncate paged buffer file, path:%s, code:%s, %s", pBuf->path, tstrerror(code), pBuf->id);
×
810
    }
811
  }
812

813
  int64_t realSizeAfter = -1;
2,849,809✔
814
  if (pBuf->pFile != NULL && taosFStatFile(pBuf->pFile, &realSizeAfter, NULL) != TSDB_CODE_SUCCESS) {
2,850,221✔
815
    realSizeAfter = -1;
×
816
  }
817

818
  uDebug("clear paged buffer end, pages:%d, inMemPages:%d, fileSize:%" PRIu64 ", nextPos:%" PRIu64
2,850,615✔
819
         ", realSize:%" PRId64 ", %s",
820
         pBuf->numOfPages, listNEles(pBuf->lruList), pBuf->fileSize, pBuf->nextPos, realSizeAfter, pBuf->id);
821
}
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