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

taosdata / TDengine / #4780

06 Oct 2025 08:05AM UTC coverage: 57.808% (-0.7%) from 58.554%
#4780

push

travis-ci

web-flow
Merge pull request #33175 from taosdata/docs/fix-download-url

fix: remove unnecessary jsonPath attribute and add  tdgpt download url

137100 of 302743 branches covered (45.29%)

Branch coverage included in aggregate %.

208096 of 294403 relevant lines covered (70.68%)

5550964.99 hits per line

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

58.82
/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) {
376✔
55
  if (pBuf->path == NULL) {  // prepare the file name when needed it
376!
56
    char path[PATH_MAX] = {0};
376✔
57
    taosGetTmpfilePath(pBuf->prefix, "paged-buf", path);
376✔
58
    pBuf->path = taosStrdup(path);
376!
59
    if (pBuf->path == NULL) {
376!
60
      return terrno;
×
61
    }
62
  }
63

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

70
  return TSDB_CODE_SUCCESS;
376✔
71
}
72

73
static char* doCompressData(void* data, int32_t srcSize, int32_t* dst, SDiskbasedBuf* pBuf) {  // do nothing
1,500,638✔
74
  if (!pBuf->comp) {
1,500,638!
75
    *dst = srcSize;
1,500,638✔
76
    return data;
1,500,638✔
77
  }
78

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

81
  memcpy(data, pBuf->assistBuf, *dst);
×
82
  return data;
×
83
}
84

85
static int32_t doDecompressData(void* data, int32_t srcSize, int32_t* dst, SDiskbasedBuf* pBuf) {  // do nothing
1,314,434✔
86
  int32_t code = 0;
1,314,434✔
87
  if (!pBuf->comp) {
1,314,434!
88
    *dst = srcSize;
1,314,434✔
89
    return code;
1,314,434✔
90
  }
91

92
  *dst = tsDecompressString(data, srcSize, 1, pBuf->assistBuf, pBuf->pageSize, ONE_STAGE_COMP, NULL, 0);
×
93
  if (*dst > 0) {
×
94
    memcpy(data, pBuf->assistBuf, *dst);
×
95
  } else if (*dst < 0) {
×
96
    return terrno;
×
97
  }
98
  return code;
×
99
  ;
100
}
101

102
static uint64_t allocateNewPositionInFile(SDiskbasedBuf* pBuf, size_t size) {
1,475,457✔
103
  if (pBuf->pFree == NULL) {
1,475,457!
104
    return pBuf->nextPos;
×
105
  } else {
106
    int32_t offset = -1;
1,475,457✔
107

108
    size_t num = taosArrayGetSize(pBuf->pFree);
1,475,457✔
109
    for (int32_t i = 0; i < num; ++i) {
1,475,448!
110
      SFreeListItem* pi = taosArrayGet(pBuf->pFree, i);
×
111
      if (pi->length >= size) {
×
112
        offset = pi->offset;
×
113
        pi->offset += (int32_t)size;
×
114
        pi->length -= (int32_t)size;
×
115

116
        return offset;
×
117
      }
118
    }
119

120
    // no available recycle space, allocate new area in file
121
    return pBuf->nextPos;
1,475,448✔
122
  }
123
}
124

125
/**
126
 *   +--------------------------+-------------------+--------------+
127
 *   | PTR to SPageInfo (8bytes)| Payload (PageSize)| 2 Extra Bytes|
128
 *   +--------------------------+-------------------+--------------+
129
 * @param pBuf
130
 * @param pg
131
 * @return
132
 */
133

134
static FORCE_INLINE size_t getAllocPageSize(int32_t pageSize) { return pageSize + POINTER_BYTES + sizeof(SFilePage); }
8,783,894✔
135

136
static int32_t doFlushBufPageImpl(SDiskbasedBuf* pBuf, int64_t offset, const char* pData, int32_t size) {
1,500,592✔
137
  int64_t ret = taosLSeekFile(pBuf->pFile, offset, SEEK_SET);
1,500,592✔
138
  if (ret < 0) {
1,500,738!
139
    return terrno;
×
140
  }
141

142
  ret = (int32_t)taosWriteFile(pBuf->pFile, pData, size);
1,500,738✔
143
  if (ret != size) {
1,500,744✔
144
    return terrno;
1✔
145
  }
146

147
  // extend the file
148
  if (pBuf->fileSize < offset + size) {
1,500,743✔
149
    pBuf->fileSize = offset + size;
1,475,595✔
150
  }
151

152
  pBuf->statis.flushBytes += size;
1,500,743✔
153
  pBuf->statis.flushPages += 1;
1,500,743✔
154

155
  return TSDB_CODE_SUCCESS;
1,500,743✔
156
}
157

158
static char* doFlushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
2,187,947✔
159
  if (pg->pData == NULL || pg->used) {
2,187,947!
160
    uError("invalid params in paged buffer process when flushing buf to disk, %s", pBuf->id);
×
161
    terrno = TSDB_CODE_INVALID_PARA;
×
162
    return NULL;
×
163
  }
164

165
  int32_t size = pBuf->pageSize;
2,187,947✔
166
  int64_t offset = pg->offset;
2,187,947✔
167

168
  char* t = NULL;
2,187,947✔
169
  if ((!HAS_DATA_IN_DISK(pg)) || pg->dirty) {
2,187,947✔
170
    void* payload = GET_PAYLOAD_DATA(pg);
1,500,634✔
171
    t = doCompressData(payload, pBuf->pageSize + sizeof(SFilePage), &size, pBuf);
1,500,634✔
172
    if (size < 0) {
1,500,638!
173
      uError("failed to compress data when flushing data to disk, %s", pBuf->id);
×
174
      terrno = TSDB_CODE_INVALID_PARA;
×
175
      return NULL;
×
176
    }
177
  }
178

179
  // this page is flushed to disk for the first time
180
  if (pg->dirty) {
2,187,951✔
181
    if (!HAS_DATA_IN_DISK(pg)) {
1,500,617✔
182
      offset = allocateNewPositionInFile(pBuf, size);
1,475,468✔
183
      pBuf->nextPos += size;
1,475,444✔
184

185
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
1,475,444✔
186
      if (code != TSDB_CODE_SUCCESS) {
1,475,591!
187
        return NULL;
×
188
      }
189
    } else {
190
      // length becomes greater, current space is not enough, allocate new place, otherwise, do nothing
191
      if (pg->length < size) {
25,149!
192
        // 1. add current space to free list
193
        SPageDiskInfo dinfo = {.length = pg->length, .offset = offset};
×
194
        if (NULL == taosArrayPush(pBuf->pFree, &dinfo)) {
×
195
          return NULL;
×
196
        }
197

198
        // 2. allocate new position, and update the info
199
        offset = allocateNewPositionInFile(pBuf, size);
×
200
        pBuf->nextPos += size;
×
201
      }
202

203
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
25,149✔
204
      if (code != TSDB_CODE_SUCCESS) {
25,149!
205
        return NULL;
×
206
      }
207
    }
208
  } else {  // NOTE: the size may be -1, the this recycle page has not been flushed to disk yet.
209
    size = pg->length;
687,334✔
210
  }
211

212
  char* pDataBuf = pg->pData;
2,188,074✔
213
  memset(pDataBuf, 0, getAllocPageSize(pBuf->pageSize));
2,188,074✔
214

215
#ifdef BUF_PAGE_DEBUG
216
  uDebug("page_flush %p, pageId:%d, offset:%d", pDataBuf, pg->pageId, offset);
217
#endif
218

219
  pg->offset = offset;
2,188,074✔
220
  pg->length = size;  // on disk size
2,188,074✔
221
  return pDataBuf;
2,188,074✔
222
}
223

224
static char* flushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
2,187,948✔
225
  int32_t ret = TSDB_CODE_SUCCESS;
2,187,948✔
226

227
  if (pBuf->pFile == NULL) {
2,187,948✔
228
    if ((ret = createDiskFile(pBuf)) != TSDB_CODE_SUCCESS) {
376!
229
      terrno = ret;
×
230
      return NULL;
×
231
    }
232
  }
233

234
  char* p = doFlushBufPage(pBuf, pg);
2,187,948✔
235
  CLEAR_BUF_PAGE_IN_MEM_FLAG(pg);
2,188,079✔
236

237
  pg->dirty = false;
2,188,079✔
238
  return p;
2,188,079✔
239
}
240

241
// load file block data in disk
242
static int32_t loadPageFromDisk(SDiskbasedBuf* pBuf, SPageInfo* pg) {
1,314,434✔
243
  if (pg->offset < 0 || pg->length <= 0) {
1,314,434!
244
    uError("failed to load buf page from disk, offset:%" PRId64 ", length:%d, %s", pg->offset, pg->length, pBuf->id);
×
245
    return TSDB_CODE_INVALID_PARA;
×
246
  }
247

248
  int64_t ret = taosLSeekFile(pBuf->pFile, pg->offset, SEEK_SET);
1,314,434✔
249
  if (ret < 0) {
1,314,434!
250
    ret = terrno;
×
251
    return ret;
×
252
  }
253

254
  void* pPage = (void*)GET_PAYLOAD_DATA(pg);
1,314,434✔
255
  ret = taosReadFile(pBuf->pFile, pPage, pg->length);
1,314,434✔
256
  if (ret != pg->length) {
1,314,434!
257
    ret = terrno;
×
258
    return ret;
×
259
  }
260

261
  pBuf->statis.loadBytes += pg->length;
1,314,434✔
262
  pBuf->statis.loadPages += 1;
1,314,434✔
263

264
  int32_t fullSize = 0;
1,314,434✔
265
  return doDecompressData(pPage, pg->length, &fullSize, pBuf);
1,314,434✔
266
}
267

268
static SPageInfo* registerNewPageInfo(SDiskbasedBuf* pBuf, int32_t pageId) {
7,478,560✔
269
  pBuf->numOfPages += 1;
7,478,560✔
270

271
  SPageInfo* ppi = taosMemoryMalloc(sizeof(SPageInfo));
7,478,560!
272
  if (ppi == NULL) {
7,488,185!
273
    return NULL;
×
274
  }
275

276
  ppi->pageId = pageId;
7,488,185✔
277
  ppi->pData = NULL;
7,488,185✔
278
  ppi->offset = -1;
7,488,185✔
279
  ppi->length = -1;
7,488,185✔
280
  ppi->used = true;
7,488,185✔
281
  ppi->pn = NULL;
7,488,185✔
282
  ppi->dirty = false;
7,488,185✔
283

284
  SPageInfo** pRet = taosArrayPush(pBuf->pIdList, &ppi);
7,488,185✔
285
  if (NULL == pRet) {
7,487,077!
286
    taosMemoryFree(ppi);
×
287
    return NULL;
×
288
  }
289
  return *pRet;
7,487,077✔
290
}
291

292
static SListNode* getEldestUnrefedPage(SDiskbasedBuf* pBuf) {
2,187,947✔
293
  SListIter iter = {0};
2,187,947✔
294
  tdListInitIter(pBuf->lruList, &iter, TD_LIST_BACKWARD);
2,187,947✔
295

296
  SListNode* pn = NULL;
2,187,930✔
297
  while ((pn = tdListNext(&iter)) != NULL) {
2,394,834!
298
    SPageInfo* pageInfo = *(SPageInfo**)pn->data;
2,394,844✔
299

300
    SPageInfo* p = *(SPageInfo**)(pageInfo->pData);
2,394,844✔
301

302
    if (!pageInfo->used) {
2,394,844✔
303
      break;
2,187,940✔
304
    }
305
  }
306

307
  return pn;
2,187,936✔
308
}
309

310
static char* evictBufPage(SDiskbasedBuf* pBuf) {
2,187,966✔
311
  SListNode* pn = getEldestUnrefedPage(pBuf);
2,187,966✔
312
  if (pn == NULL) {  // no available buffer pages now, return.
2,187,935!
313
    return NULL;
×
314
  }
315

316
  terrno = 0;
2,187,935✔
317
  pn = tdListPopNode(pBuf->lruList, pn);
2,187,931✔
318

319
  SPageInfo* d = *(SPageInfo**)pn->data;
2,187,836✔
320

321
  d->pn = NULL;
2,187,836✔
322
  taosMemoryFreeClear(pn);
2,187,836!
323

324
  return flushBufPage(pBuf, d);
2,187,953✔
325
}
326

327
static int32_t lruListPushFront(SList* pList, SPageInfo* pi) {
8,798,851✔
328
  int32_t code = tdListPrepend(pList, &pi);
8,798,851✔
329
  if (TSDB_CODE_SUCCESS != code) {
8,793,386!
330
    return code;
×
331
  }
332
  SListNode* front = tdListGetHead(pList);
8,793,386✔
333
  pi->pn = front;
8,791,722✔
334
  return TSDB_CODE_SUCCESS;
8,791,722✔
335
}
336

337
static void lruListMoveToFront(SList* pList, SPageInfo* pi) {
237,159,162✔
338
  pi->pn = tdListPopNode(pList, pi->pn);
237,159,162✔
339
  tdListPrependNode(pList, pi->pn);
236,967,153✔
340
}
236,827,496✔
341

342
static SPageInfo* getPageInfoFromPayload(void* page) {
314,308,638✔
343
  char* p = (char*)page - POINTER_BYTES;
314,308,638✔
344

345
  SPageInfo* ppi = ((SPageInfo**)p)[0];
314,308,638✔
346
  return ppi;
314,308,638✔
347
}
348

349
int32_t createDiskbasedBuf(SDiskbasedBuf** pBuf, int32_t pagesize, int64_t inMemBufSize, const char* id,
1,404,770✔
350
                           const char* dir) {
351
  int32_t code = 0;
1,404,770✔
352
  *pBuf = NULL;
1,404,770✔
353
  SDiskbasedBuf* pPBuf = taosMemoryCalloc(1, sizeof(SDiskbasedBuf));
1,404,770!
354
  if (pPBuf == NULL) {
1,405,504!
355
    code = terrno;
×
356
    goto _error;
×
357
  }
358

359
  pPBuf->pageSize = pagesize;
1,405,504✔
360
  pPBuf->numOfPages = 0;  // all pages are in buffer in the first place
1,405,504✔
361
  pPBuf->totalBufSize = 0;
1,405,504✔
362
  pPBuf->allocateId = -1;
1,405,504✔
363
  pPBuf->pFile = NULL;
1,405,504✔
364
  pPBuf->id = taosStrdup(id);
1,405,504!
365
  if (id != NULL && pPBuf->id == NULL) {
1,405,323!
366
    code = terrno;
×
367
    goto _error;
×
368
  }
369
  pPBuf->fileSize = 0;
1,405,323✔
370
  pPBuf->pFree = taosArrayInit(4, sizeof(SFreeListItem));
1,405,323✔
371
  pPBuf->freePgList = tdListNew(POINTER_BYTES);
1,405,759✔
372
  if (pPBuf->pFree == NULL || pPBuf->freePgList == NULL) {
1,405,606!
373
    code = terrno;
×
374
    goto _error;
×
375
  }
376

377
  // at least more than 2 pages must be in memory
378
  if (inMemBufSize < pagesize * 2) {
1,405,652✔
379
    inMemBufSize = pagesize * 2;
3,120✔
380
  }
381

382
  pPBuf->inMemPages = inMemBufSize / pagesize;  // maximum allowed pages, it is a soft limit.
1,405,652✔
383
  pPBuf->lruList = tdListNew(POINTER_BYTES);
1,405,652✔
384
  if (pPBuf->lruList == NULL) {
1,405,554!
385
    code = terrno;
×
386
    goto _error;
×
387
  }
388

389
  // init id hash table
390
  _hash_fn_t fn = taosGetDefaultHashFunction(TSDB_DATA_TYPE_INT);
1,405,554✔
391
  pPBuf->pIdList = taosArrayInit(4, POINTER_BYTES);
1,405,465✔
392
  if (pPBuf->pIdList == NULL) {
1,405,796!
393
    code = terrno;
×
394
    goto _error;
×
395
  }
396

397
  pPBuf->all = tSimpleHashInit(64, fn);
1,405,796✔
398
  if (pPBuf->all == NULL) {
1,405,374!
399
    code = terrno;
×
400
    goto _error;
×
401
  }
402

403
  pPBuf->prefix = (char*)dir;
1,405,374✔
404
  pPBuf->emptyDummyIdList = taosArrayInit(1, sizeof(int32_t));
1,405,374✔
405
  if (pPBuf->emptyDummyIdList == NULL) {
1,405,808✔
406
    code = terrno;
9✔
407
    goto _error;
×
408
  }
409

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

413
  *pBuf = pPBuf;
1,405,799✔
414
  return TSDB_CODE_SUCCESS;
1,405,799✔
415

416
_error:
×
417
  destroyDiskbasedBuf(pPBuf);
×
418
  *pBuf = NULL;
×
419
  return code;
×
420
}
421

422
static char* doExtractPage(SDiskbasedBuf* pBuf) {
8,783,797✔
423
  char* availablePage = NULL;
8,783,797✔
424
  if (NO_IN_MEM_AVAILABLE_PAGES(pBuf)) {
8,783,797✔
425
    availablePage = evictBufPage(pBuf);
2,187,977✔
426
    if (availablePage == NULL) {
2,188,077!
427
      uWarn("no available buf pages, current:%d, max:%d, reason: %s, %s", listNEles(pBuf->lruList), pBuf->inMemPages,
×
428
            terrstr(), pBuf->id)
429
    }
430
  } else {
431
    availablePage =
6,605,591✔
432
        taosMemoryCalloc(1, getAllocPageSize(pBuf->pageSize));  // add extract bytes in case of zipped buffer increased.
13,191,640!
433
  }
434

435
  return availablePage;
8,793,390✔
436
}
437

438
void* getNewBufPage(SDiskbasedBuf* pBuf, int32_t* pageId) {
7,469,439✔
439
  pBuf->statis.getPages += 1;
7,469,439✔
440

441
  char* availablePage = doExtractPage(pBuf);
7,469,439✔
442
  if (availablePage == NULL) {
7,478,823!
443
    return NULL;
×
444
  }
445

446
  SPageInfo* pi = NULL;
7,478,823✔
447
  int32_t    code = 0;
7,478,823✔
448
  if (listNEles(pBuf->freePgList) != 0) {
7,478,823!
449
    SListNode* pItem = tdListPopHead(pBuf->freePgList);
×
450
    pi = *(SPageInfo**)pItem->data;
×
451
    pi->used = true;
×
452
    *pageId = pi->pageId;
×
453
    taosMemoryFreeClear(pItem);
×
454
    code = lruListPushFront(pBuf->lruList, pi);
×
455
    if (TSDB_CODE_SUCCESS != code) {
×
456
      taosMemoryFree(pi);
469!
457
      taosMemoryFree(availablePage);
×
458
      terrno = code;
×
459
      return NULL;
×
460
    }
461
  } else {  // create a new pageinfo
462
    // register new id in this group
463
    *pageId = (++pBuf->allocateId);
7,478,823✔
464

465
    // register page id info
466
    pi = registerNewPageInfo(pBuf, *pageId);
7,478,823✔
467
    if (pi == NULL) {
7,485,950!
468
      taosMemoryFree(availablePage);
×
469
      return NULL;
×
470
    }
471

472
    // add to hash map
473
    int32_t code = tSimpleHashPut(pBuf->all, pageId, sizeof(int32_t), &pi, POINTER_BYTES);
7,485,950✔
474

475
    if (TSDB_CODE_SUCCESS == code) {
7,485,004!
476
      // add to LRU list
477
      code = lruListPushFront(pBuf->lruList, pi);
7,485,076✔
478
    }
479
    if (TSDB_CODE_SUCCESS == code) {
7,477,286!
480
      pBuf->totalBufSize += pBuf->pageSize;
7,477,286✔
481
    } else {
482
      taosMemoryFree(availablePage);
×
483
      SPageInfo **pLast = taosArrayPop(pBuf->pIdList);
×
484
      int32_t ret = tSimpleHashRemove(pBuf->all, pageId, sizeof(int32_t));
×
485
      if (ret != TSDB_CODE_SUCCESS) {
×
486
        uError("%s failed to clear pageId %d from buf hash-set since %s", __func__, *pageId, tstrerror(ret));
×
487
      }
488
      taosMemoryFree(pi);
×
489
      terrno = code;
×
490
      return NULL;
×
491
    }
492
  }
493

494
  pi->pData = availablePage;
7,476,817✔
495

496
  ((void**)pi->pData)[0] = pi;
7,476,817✔
497
#ifdef BUF_PAGE_DEBUG
498
  uDebug("page_getNewBufPage , pi->pData:%p, pageId:%d, offset:%" PRId64, pi->pData, pi->pageId, pi->offset);
499
#endif
500

501
  return (void*)(GET_PAYLOAD_DATA(pi));
7,476,817✔
502
}
503

504
void* getBufPage(SDiskbasedBuf* pBuf, int32_t id) {
253,603,331✔
505
  if (id < 0) {
253,603,331!
506
    terrno = TSDB_CODE_INVALID_PARA;
×
507
    uError("invalid page id:%d, %s", id, pBuf->id);
×
508
    return NULL;
×
509
  }
510

511
  pBuf->statis.getPages += 1;
253,603,331✔
512

513
  SPageInfo** pi = tSimpleHashGet(pBuf->all, &id, sizeof(int32_t));
253,603,331✔
514
  if (pi == NULL || *pi == NULL) {
252,939,511!
515
    uError("failed to locate the buffer page:%d, %s", id, pBuf->id);
70,357!
516
    terrno = TSDB_CODE_INVALID_PARA;
70,357✔
517
    return NULL;
×
518
  }
519

520
  if (BUF_PAGE_IN_MEM(*pi)) {  // it is in memory
252,869,154✔
521
    // no need to update the LRU list if only one page exists
522
    if (pBuf->numOfPages == 1) {
251,612,717✔
523
      (*pi)->used = true;
14,474,715✔
524
      return (void*)(GET_PAYLOAD_DATA(*pi));
14,474,715✔
525
    }
526

527
    SPageInfo** pInfo = (SPageInfo**)((*pi)->pn->data);
237,138,002✔
528
    if (*pInfo != *pi) {
237,138,002!
529
      terrno = TSDB_CODE_APP_ERROR;
×
530
      uError("inconsistently data in paged buffer, pInfo:%p, pi:%p, %s", *pInfo, *pi, pBuf->id);
×
531
      return NULL;
×
532
    }
533

534
    lruListMoveToFront(pBuf->lruList, (*pi));
237,138,002✔
535
    (*pi)->used = true;
236,879,298✔
536

537
#ifdef BUF_PAGE_DEBUG
538
    uDebug("page_getBufPage1 pageId:%d, offset:%" PRId64, (*pi)->pageId, (*pi)->offset);
539
#endif
540
    return (void*)(GET_PAYLOAD_DATA(*pi));
236,879,298✔
541
  } else {  // not in memory
542

543
    (*pi)->pData = doExtractPage(pBuf);
1,256,437✔
544

545
    // failed to evict buffer page, return with error code.
546
    if ((*pi)->pData == NULL) {
1,314,437!
547
      return NULL;
×
548
    }
549

550
    // set the ptr to the new SPageInfo
551
    ((void**)((*pi)->pData))[0] = (*pi);
1,314,437✔
552

553
    int32_t code = lruListPushFront(pBuf->lruList, *pi);
1,314,437✔
554
    if (TSDB_CODE_SUCCESS != code) {
1,314,437!
555
      taosMemoryFree((*pi)->pData);
×
556
      (*pi)->pData = NULL;
×
557
      terrno = code;
×
558
      return NULL;
×
559
    }
560
    (*pi)->used = true;
1,314,437✔
561

562
    // some data has been flushed to disk, and needs to be loaded into buffer again.
563
    if (HAS_DATA_IN_DISK(*pi)) {
1,314,437✔
564
      int32_t code = loadPageFromDisk(pBuf, *pi);
1,314,434✔
565
      if (code != 0) {
1,314,434!
566
        taosMemoryFree((*pi)->pData);
×
567
        (*pi)->pData = NULL;
×
568
        terrno = code;
×
569
        return NULL;
×
570
      }
571
    }
572
#ifdef BUF_PAGE_DEBUG
573
    uDebug("page_getBufPage2 pageId:%d, offset:%" PRId64, (*pi)->pageId, (*pi)->offset);
574
#endif
575
    return (void*)(GET_PAYLOAD_DATA(*pi));
1,314,437✔
576
  }
577
}
578

579
void releaseBufPage(SDiskbasedBuf* pBuf, void* page) {
187,566,123✔
580
  if (page == NULL) {
187,566,123!
581
    return;
×
582
  }
583

584
  SPageInfo* ppi = getPageInfoFromPayload(page);
187,566,123✔
585
  releaseBufPageInfo(pBuf, ppi);
186,979,880✔
586
}
587

588
void releaseBufPageInfo(SDiskbasedBuf* pBuf, SPageInfo* pi) {
186,975,891✔
589
#ifdef BUF_PAGE_DEBUG
590
  uDebug("page_releaseBufPageInfo pageId:%d, used:%d, offset:%" PRId64, pi->pageId, pi->used, pi->offset);
591
#endif
592

593
  if (pi == NULL) {
186,975,891!
594
    return;
×
595
  }
596

597
  if (pi->pData == NULL) {
186,975,891!
598
    uError("pi->pData (page data) is null");
×
599
    return;
×
600
  }
601

602
  pi->used = false;
186,975,891✔
603
  pBuf->statis.releasePages += 1;
186,975,891✔
604
}
605

606
size_t getTotalBufSize(const SDiskbasedBuf* pBuf) { return (size_t)pBuf->totalBufSize; }
3✔
607

608
SArray* getDataBufPagesIdList(SDiskbasedBuf* pBuf) { return pBuf->pIdList; }
9✔
609

610
void destroyDiskbasedBuf(SDiskbasedBuf* pBuf) {
1,707,017✔
611
  if (pBuf == NULL) {
1,707,017✔
612
    return;
301,236✔
613
  }
614

615
  dBufPrintStatis(pBuf);
1,405,781✔
616

617
  bool needRemoveFile = false;
1,405,825✔
618
  if (pBuf->pFile != NULL) {
1,405,825✔
619
    needRemoveFile = true;
376✔
620
    uDebug(
376!
621
        "Paged buffer closed, total:%.2f Kb (%d Pages), inmem size:%.2f Kb (%d Pages), file size:%.2f Kb, page "
622
        "size:%.2f Kb, %s",
623
        pBuf->totalBufSize / 1024.0, pBuf->numOfPages, listNEles(pBuf->lruList) * pBuf->pageSize / 1024.0,
624
        listNEles(pBuf->lruList), pBuf->fileSize / 1024.0, pBuf->pageSize / 1024.0f, pBuf->id);
625

626
    int32_t code = taosCloseFile(&pBuf->pFile);
376✔
627
    if (TSDB_CODE_SUCCESS != code) {
376!
628
      uDebug("WARNING tPage failed to close file when destroy disk basebuf: %s", pBuf->path);
×
629
    }
630
  } else {
631
    uDebug("Paged buffer closed, total:%.2f Kb, no file created, %s", pBuf->totalBufSize / 1024.0, pBuf->id);
1,405,449✔
632
  }
633

634
  // print the statistics information
635
  {
636
    SDiskbasedBufStatis* ps = &pBuf->statis;
1,405,804✔
637
    if (ps->loadPages == 0) {
1,405,804✔
638
      uDebug("Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages)", ps->getPages,
1,405,434✔
639
             ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f, ps->loadPages);
640
    } else {
641
      uDebug(
370!
642
          "Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages), avgPgSize:%.2f Kb",
643
          ps->getPages, ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f,
644
          ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
645
    }
646
  }
647

648
  if (needRemoveFile) {
1,405,804✔
649
    int32_t ret = taosRemoveFile(pBuf->path);
376✔
650
    if (ret != 0) {  // print the error and discard this error info
376!
651
      uDebug("WARNING tPage remove file failed. path=%s, code:%s", pBuf->path, strerror(ERRNO));
376!
652
    }
653
  }
654

655
  taosMemoryFreeClear(pBuf->path);
1,405,727!
656

657
  size_t n = taosArrayGetSize(pBuf->pIdList);
1,405,727✔
658
  for (int32_t i = 0; i < n; ++i) {
7,507,506✔
659
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
6,101,645✔
660
    taosMemoryFreeClear(pi->pData);
6,100,922!
661
    taosMemoryFreeClear(pi);
6,099,186!
662
  }
663

664
  taosArrayDestroy(pBuf->pIdList);
1,405,861✔
665

666
  pBuf->lruList = tdListFree(pBuf->lruList);
1,405,862✔
667
  pBuf->freePgList = tdListFree(pBuf->freePgList);
1,405,891✔
668

669
  taosArrayDestroy(pBuf->emptyDummyIdList);
1,405,896✔
670
  taosArrayDestroy(pBuf->pFree);
1,405,851✔
671

672
  tSimpleHashCleanup(pBuf->all);
1,405,888✔
673

674
  taosMemoryFreeClear(pBuf->id);
1,405,886!
675
  taosMemoryFreeClear(pBuf->assistBuf);
1,405,889!
676
  taosMemoryFreeClear(pBuf);
1,405,889!
677
}
678

679
SPageInfo* getLastPageInfo(SArray* pList) {
×
680
  size_t     size = taosArrayGetSize(pList);
×
681
  SPageInfo* pPgInfo = taosArrayGetP(pList, size - 1);
×
682
  return pPgInfo;
×
683
}
684

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

687
int32_t getBufPageSize(const SDiskbasedBuf* pBuf) { return pBuf->pageSize; }
212,739,267✔
688

689
int32_t getNumOfInMemBufPages(const SDiskbasedBuf* pBuf) { return pBuf->inMemPages; }
70,937✔
690

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

693
void setBufPageDirty(void* pPage, bool dirty) {
130,826,235✔
694
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
130,826,235✔
695
  ppi->dirty = dirty;
130,717,602✔
696
}
130,717,602✔
697

698
int32_t setBufPageCompressOnDisk(SDiskbasedBuf* pBuf, bool comp) {
×
699
  pBuf->comp = comp;
×
700
  if (comp && (pBuf->assistBuf == NULL)) {
×
701
    pBuf->assistBuf = taosMemoryMalloc(pBuf->pageSize + 2);  // EXTRA BYTES
×
702
    if (pBuf->assistBuf) {
×
703
      return terrno;
×
704
    }
705
  }
706
  return TSDB_CODE_SUCCESS;
×
707
}
708

709
int32_t dBufSetBufPageRecycled(SDiskbasedBuf* pBuf, void* pPage) {
×
710
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
×
711

712
  int32_t code = tdListAppend(pBuf->freePgList, &ppi);
×
713
  if (TSDB_CODE_SUCCESS != code) {
×
714
    return code;
×
715
  }
716

717
  ppi->used = false;
×
718
  ppi->dirty = false;
×
719

720
  // add this pageinfo into the free page info list
721
  SListNode* pNode = tdListPopNode(pBuf->lruList, ppi->pn);
×
722
  taosMemoryFreeClear(ppi->pData);
×
723
  taosMemoryFreeClear(pNode);
×
724
  ppi->pn = NULL;
×
725
  return TSDB_CODE_SUCCESS;
×
726
}
727

728
void dBufSetPrintInfo(SDiskbasedBuf* pBuf) { pBuf->printStatis = true; }
131,278✔
729

730
SDiskbasedBufStatis getDBufStatis(const SDiskbasedBuf* pBuf) { return pBuf->statis; }
71,782✔
731

732
void dBufPrintStatis(const SDiskbasedBuf* pBuf) {
1,405,771✔
733
  if (!pBuf->printStatis) {
1,405,771✔
734
    return;
1,274,539✔
735
  }
736

737
  const SDiskbasedBufStatis* ps = &pBuf->statis;
131,232✔
738

739
#if 0
740
  printf(
741
      "Paged buffer closed, total:%.2f Kb (%d Pages), inmem size:%.2f Kb (%d Pages), file size:%.2f Kb, page size:%.2f "
742
      "Kb, %s\n",
743
      pBuf->totalBufSize / 1024.0, pBuf->numOfPages, listNEles(pBuf->lruList) * pBuf->pageSize / 1024.0,
744
      listNEles(pBuf->lruList), pBuf->fileSize / 1024.0, pBuf->pageSize / 1024.0f, pBuf->id);
745
#endif
746

747
  if (ps->loadPages > 0) {
131,232✔
748
    (void)printf(
102✔
749
        "Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages), avgPageSize:%.2f "
750
        "Kb\n",
751
        ps->getPages, ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f,
102✔
752
        ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
102✔
753
  } else {
754
    // printf("no page loaded\n");
755
  }
756
}
757

758
void clearDiskbasedBuf(SDiskbasedBuf* pBuf) {
9,660✔
759
  size_t n = taosArrayGetSize(pBuf->pIdList);
9,660✔
760
  for (int32_t i = 0; i < n; ++i) {
1,399,185✔
761
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
1,389,523✔
762
    taosMemoryFreeClear(pi->pData);
1,389,366!
763
    taosMemoryFreeClear(pi);
1,389,526!
764
  }
765

766
  taosArrayClear(pBuf->pIdList);
9,662✔
767

768
  tdListEmpty(pBuf->lruList);
9,661✔
769
  tdListEmpty(pBuf->freePgList);
9,661✔
770

771
  taosArrayClear(pBuf->emptyDummyIdList);
9,660✔
772
  taosArrayClear(pBuf->pFree);
9,660✔
773

774
  tSimpleHashClear(pBuf->all);
9,660✔
775

776
  pBuf->numOfPages = 0;  // all pages are in buffer in the first place
9,661✔
777
  pBuf->totalBufSize = 0;
9,661✔
778
  pBuf->allocateId = -1;
9,661✔
779
  pBuf->fileSize = 0;
9,661✔
780
}
9,661✔
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