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

taosdata / TDengine / #3608

12 Feb 2025 05:57AM UTC coverage: 63.066% (+1.4%) from 61.715%
#3608

push

travis-ci

web-flow
Merge pull request #29746 from taosdata/merge/mainto3.02

merge: from main to 3.0 branch

140199 of 286257 branches covered (48.98%)

Branch coverage included in aggregate %.

89 of 161 new or added lines in 18 files covered. (55.28%)

3211 existing lines in 190 files now uncovered.

218998 of 283298 relevant lines covered (77.3%)

5949310.66 hits per line

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

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

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

70
  return TSDB_CODE_SUCCESS;
298✔
71
}
72

73
static char* doCompressData(void* data, int32_t srcSize, int32_t* dst, SDiskbasedBuf* pBuf) {  // do nothing
1,193,389✔
74
  if (!pBuf->comp) {
1,193,389!
75
    *dst = srcSize;
1,193,397✔
76
    return data;
1,193,397✔
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,036,889✔
86
  int32_t code = 0;
1,036,889✔
87
  if (!pBuf->comp) {
1,036,889!
88
    *dst = srcSize;
1,036,890✔
89
    return code;
1,036,890✔
90
  }
91

UNCOV
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,193,381✔
103
  if (pBuf->pFree == NULL) {
1,193,381!
104
    return pBuf->nextPos;
×
105
  } else {
106
    int32_t offset = -1;
1,193,381✔
107

108
    size_t num = taosArrayGetSize(pBuf->pFree);
1,193,381✔
109
    for (int32_t i = 0; i < num; ++i) {
1,193,288!
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,193,288✔
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); }
9,347,058✔
135

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

142
  ret = (int32_t)taosWriteFile(pBuf->pFile, pData, size);
1,193,648✔
143
  if (ret != size) {
1,193,656!
144
    return terrno;
×
145
  }
146

147
  // extend the file
148
  if (pBuf->fileSize < offset + size) {
1,193,671✔
149
    pBuf->fileSize = offset + size;
1,193,670✔
150
  }
151

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

155
  return TSDB_CODE_SUCCESS;
1,193,671✔
156
}
157

158
static char* doFlushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
1,705,025✔
159
  if (pg->pData == NULL || pg->used) {
1,705,025!
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;
1,705,042✔
166
  int64_t offset = pg->offset;
1,705,042✔
167

168
  char* t = NULL;
1,705,042✔
169
  if ((!HAS_DATA_IN_DISK(pg)) || pg->dirty) {
1,705,042✔
170
    void* payload = GET_PAYLOAD_DATA(pg);
1,193,365✔
171
    t = doCompressData(payload, pBuf->pageSize + sizeof(SFilePage), &size, pBuf);
1,193,365✔
172
    if (size < 0) {
1,193,393!
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) {
1,705,070✔
181
    if (!HAS_DATA_IN_DISK(pg)) {
1,193,383!
182
      offset = allocateNewPositionInFile(pBuf, size);
1,193,388✔
183
      pBuf->nextPos += size;
1,193,287✔
184

185
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
1,193,287✔
186
      if (code != TSDB_CODE_SUCCESS) {
1,193,631!
187
        return NULL;
×
188
      }
189
    } else {
190
      // length becomes greater, current space is not enough, allocate new place, otherwise, do nothing
UNCOV
191
      if (pg->length < size) {
×
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

UNCOV
203
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
×
UNCOV
204
      if (code != TSDB_CODE_SUCCESS) {
×
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;
511,687✔
210
  }
211

212
  char* pDataBuf = pg->pData;
1,705,318✔
213
  memset(pDataBuf, 0, getAllocPageSize(pBuf->pageSize));
1,705,318✔
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;
1,705,318✔
220
  pg->length = size;  // on disk size
1,705,318✔
221
  return pDataBuf;
1,705,318✔
222
}
223

224
static char* flushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
1,705,038✔
225
  int32_t ret = TSDB_CODE_SUCCESS;
1,705,038✔
226

227
  if (pBuf->pFile == NULL) {
1,705,038✔
228
    if ((ret = createDiskFile(pBuf)) != TSDB_CODE_SUCCESS) {
298!
229
      terrno = ret;
×
230
      return NULL;
×
231
    }
232
  }
233

234
  char* p = doFlushBufPage(pBuf, pg);
1,705,038✔
235
  CLEAR_BUF_PAGE_IN_MEM_FLAG(pg);
1,705,205✔
236

237
  pg->dirty = false;
1,705,205✔
238
  return p;
1,705,205✔
239
}
240

241
// load file block data in disk
242
static int32_t loadPageFromDisk(SDiskbasedBuf* pBuf, SPageInfo* pg) {
1,036,608✔
243
  if (pg->offset < 0 || pg->length <= 0) {
1,036,608!
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,036,681✔
249
  if (ret < 0) {
1,036,890!
250
    ret = terrno;
×
251
    return ret;
×
252
  }
253

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

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

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

268
static SPageInfo* registerNewPageInfo(SDiskbasedBuf* pBuf, int32_t pageId) {
8,330,155✔
269
  pBuf->numOfPages += 1;
8,330,155✔
270

271
  SPageInfo* ppi = taosMemoryMalloc(sizeof(SPageInfo));
8,330,155!
272
  if (ppi == NULL) {
8,331,595!
273
    terrno = TSDB_CODE_OUT_OF_MEMORY;
×
274
    return NULL;
×
275
  }
276

277
  ppi->pageId = pageId;
8,331,595✔
278
  ppi->pData = NULL;
8,331,595✔
279
  ppi->offset = -1;
8,331,595✔
280
  ppi->length = -1;
8,331,595✔
281
  ppi->used = true;
8,331,595✔
282
  ppi->pn = NULL;
8,331,595✔
283
  ppi->dirty = false;
8,331,595✔
284

285
  SPageInfo** pRet = taosArrayPush(pBuf->pIdList, &ppi);
8,331,595✔
286
  if (NULL == pRet) {
8,328,931!
287
    taosMemoryFree(ppi);
×
288
    return NULL;
×
289
  }
290
  return *pRet;
8,328,931✔
291
}
292

293
static SListNode* getEldestUnrefedPage(SDiskbasedBuf* pBuf) {
1,705,170✔
294
  SListIter iter = {0};
1,705,170✔
295
  tdListInitIter(pBuf->lruList, &iter, TD_LIST_BACKWARD);
1,705,170✔
296

297
  SListNode* pn = NULL;
1,705,149✔
298
  while ((pn = tdListNext(&iter)) != NULL) {
1,940,156✔
299
    SPageInfo* pageInfo = *(SPageInfo**)pn->data;
1,940,193✔
300

301
    SPageInfo* p = *(SPageInfo**)(pageInfo->pData);
1,940,193✔
302

303
    if (!pageInfo->used) {
1,940,193✔
304
      break;
1,705,186✔
305
    }
306
  }
307

308
  return pn;
1,705,188✔
309
}
310

311
static char* evictBufPage(SDiskbasedBuf* pBuf) {
1,705,185✔
312
  SListNode* pn = getEldestUnrefedPage(pBuf);
1,705,185✔
313
  if (pn == NULL) {  // no available buffer pages now, return.
1,705,177!
314
    return NULL;
×
315
  }
316

317
  terrno = 0;
1,705,177✔
318
  pn = tdListPopNode(pBuf->lruList, pn);
1,705,172✔
319

320
  SPageInfo* d = *(SPageInfo**)pn->data;
1,704,797✔
321

322
  d->pn = NULL;
1,704,797✔
323
  taosMemoryFreeClear(pn);
1,704,797!
324

325
  return flushBufPage(pBuf, d);
1,705,030✔
326
}
327

328
static int32_t lruListPushFront(SList* pList, SPageInfo* pi) {
9,364,367✔
329
  int32_t code = tdListPrepend(pList, &pi);
9,364,367✔
330
  if (TSDB_CODE_SUCCESS != code) {
9,363,405!
331
    return code;
×
332
  }
333
  SListNode* front = tdListGetHead(pList);
9,363,405✔
334
  pi->pn = front;
9,360,558✔
335
  return TSDB_CODE_SUCCESS;
9,360,558✔
336
}
337

338
static void lruListMoveToFront(SList* pList, SPageInfo* pi) {
302,772,396✔
339
  pi->pn = tdListPopNode(pList, pi->pn);
302,772,396✔
340
  tdListPrependNode(pList, pi->pn);
301,963,203✔
341
}
301,952,436✔
342

343
static SPageInfo* getPageInfoFromPayload(void* page) {
388,407,629✔
344
  char* p = (char*)page - POINTER_BYTES;
388,407,629✔
345

346
  SPageInfo* ppi = ((SPageInfo**)p)[0];
388,407,629✔
347
  return ppi;
388,407,629✔
348
}
349

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

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

378
  // at least more than 2 pages must be in memory
379
  if (inMemBufSize < pagesize * 2) {
1,444,004✔
380
    inMemBufSize = pagesize * 2;
4,340✔
381
  }
382

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

390
  // init id hash table
391
  _hash_fn_t fn = taosGetDefaultHashFunction(TSDB_DATA_TYPE_INT);
1,443,833✔
392
  pPBuf->pIdList = taosArrayInit(4, POINTER_BYTES);
1,443,924✔
393
  if (pPBuf->pIdList == NULL) {
1,444,218!
394
    code = terrno;
×
395
    goto _error;
×
396
  }
397

398
  pPBuf->all = tSimpleHashInit(64, fn);
1,444,218✔
399
  if (pPBuf->all == NULL) {
1,443,472!
400
    code = terrno;
×
401
    goto _error;
×
402
  }
403

404
  pPBuf->prefix = (char*)dir;
1,443,472✔
405
  pPBuf->emptyDummyIdList = taosArrayInit(1, sizeof(int32_t));
1,443,472✔
406
  if (pPBuf->emptyDummyIdList == NULL) {
1,444,233✔
407
    code = terrno;
18✔
408
    goto _error;
×
409
  }
410

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

414
  *pBuf = pPBuf;
1,444,215✔
415
  return TSDB_CODE_SUCCESS;
1,444,215✔
416

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

423
static char* doExtractPage(SDiskbasedBuf* pBuf) {
9,346,929✔
424
  char* availablePage = NULL;
9,346,929✔
425
  if (NO_IN_MEM_AVAILABLE_PAGES(pBuf)) {
9,346,929✔
426
    availablePage = evictBufPage(pBuf);
1,705,189✔
427
    if (availablePage == NULL) {
1,705,037!
428
      uWarn("no available buf pages, current:%d, max:%d, reason: %s, %s", listNEles(pBuf->lruList), pBuf->inMemPages,
×
429
            terrstr(), pBuf->id)
430
    }
431
  } else {
432
    availablePage =
15,304,016✔
433
        taosMemoryCalloc(1, getAllocPageSize(pBuf->pageSize));  // add extract bytes in case of zipped buffer increased.
15,283,480!
434
    if (availablePage == NULL) {
7,662,276!
435
      terrno = TSDB_CODE_OUT_OF_MEMORY;
×
436
    }
437
  }
438

439
  return availablePage;
9,367,313✔
440
}
441

442
void* getNewBufPage(SDiskbasedBuf* pBuf, int32_t* pageId) {
8,310,224✔
443
  pBuf->statis.getPages += 1;
8,310,224✔
444

445
  char* availablePage = doExtractPage(pBuf);
8,310,224✔
446
  if (availablePage == NULL) {
8,330,419!
447
    return NULL;
×
448
  }
449

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

469
    // register page id info
470
    pi = registerNewPageInfo(pBuf, *pageId);
8,330,419✔
471
    if (pi == NULL) {
8,328,364!
472
      taosMemoryFree(availablePage);
×
473
      return NULL;
×
474
    }
475

476
    // add to hash map
477
    int32_t code = tSimpleHashPut(pBuf->all, pageId, sizeof(int32_t), &pi, POINTER_BYTES);
8,328,364✔
478

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

498
  pi->pData = availablePage;
8,323,425✔
499

500
  ((void**)pi->pData)[0] = pi;
8,323,425✔
501
#ifdef BUF_PAGE_DEBUG
502
  uDebug("page_getNewBufPage , pi->pData:%p, pageId:%d, offset:%" PRId64, pi->pData, pi->pageId, pi->offset);
503
#endif
504

505
  return (void*)(GET_PAYLOAD_DATA(pi));
8,323,425✔
506
}
507

508
void* getBufPage(SDiskbasedBuf* pBuf, int32_t id) {
327,516,621✔
509
  if (id < 0) {
327,516,621!
510
    terrno = TSDB_CODE_INVALID_PARA;
×
511
    uError("invalid page id:%d, %s", id, pBuf->id);
×
512
    return NULL;
×
513
  }
514

515
  pBuf->statis.getPages += 1;
327,516,621✔
516

517
  SPageInfo** pi = tSimpleHashGet(pBuf->all, &id, sizeof(int32_t));
327,516,621✔
518
  if (pi == NULL || *pi == NULL) {
325,630,658!
UNCOV
519
    uError("failed to locate the buffer page:%d, %s", id, pBuf->id);
×
UNCOV
520
    terrno = TSDB_CODE_INVALID_PARA;
×
521
    return NULL;
×
522
  }
523

524
  if (BUF_PAGE_IN_MEM(*pi)) {  // it is in memory
325,977,953✔
525
    // no need to update the LRU list if only one page exists
526
    if (pBuf->numOfPages == 1) {
324,731,777✔
527
      (*pi)->used = true;
23,359,677✔
528
      return (void*)(GET_PAYLOAD_DATA(*pi));
23,359,677✔
529
    }
530

531
    SPageInfo** pInfo = (SPageInfo**)((*pi)->pn->data);
301,372,100✔
532
    if (*pInfo != *pi) {
301,372,100!
533
      terrno = TSDB_CODE_APP_ERROR;
×
534
      uError("inconsistently data in paged buffer, pInfo:%p, pi:%p, %s", *pInfo, *pi, pBuf->id);
×
535
      return NULL;
×
536
    }
537

538
    lruListMoveToFront(pBuf->lruList, (*pi));
301,372,100✔
539
    (*pi)->used = true;
302,042,400✔
540

541
#ifdef BUF_PAGE_DEBUG
542
    uDebug("page_getBufPage1 pageId:%d, offset:%" PRId64, (*pi)->pageId, (*pi)->offset);
543
#endif
544
    return (void*)(GET_PAYLOAD_DATA(*pi));
302,042,400✔
545
  } else {  // not in memory
546

547
    (*pi)->pData = doExtractPage(pBuf);
1,246,176✔
548

549
    // failed to evict buffer page, return with error code.
550
    if ((*pi)->pData == NULL) {
1,036,537!
551
      return NULL;
×
552
    }
553

554
    // set the ptr to the new SPageInfo
555
    ((void**)((*pi)->pData))[0] = (*pi);
1,036,537✔
556

557
    int32_t code = lruListPushFront(pBuf->lruList, *pi);
1,036,537✔
558
    if (TSDB_CODE_SUCCESS != code) {
1,036,743!
559
      taosMemoryFree((*pi)->pData);
×
560
      (*pi)->pData = NULL;
×
561
      terrno = code;
×
562
      return NULL;
×
563
    }
564
    (*pi)->used = true;
1,036,743✔
565

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

583
void releaseBufPage(SDiskbasedBuf* pBuf, void* page) {
230,539,519✔
584
  if (page == NULL) {
230,539,519!
585
    return;
×
586
  }
587

588
  SPageInfo* ppi = getPageInfoFromPayload(page);
230,539,519✔
589
  releaseBufPageInfo(pBuf, ppi);
229,728,626✔
590
}
591

592
void releaseBufPageInfo(SDiskbasedBuf* pBuf, SPageInfo* pi) {
229,699,174✔
593
#ifdef BUF_PAGE_DEBUG
594
  uDebug("page_releaseBufPageInfo pageId:%d, used:%d, offset:%" PRId64, pi->pageId, pi->used, pi->offset);
595
#endif
596

597
  if (pi == NULL) {
229,699,174!
598
    return;
×
599
  }
600

601
  if (pi->pData == NULL) {
229,699,174!
602
    uError("pi->pData (page data) is null");
×
603
    return;
×
604
  }
605

606
  pi->used = false;
229,699,174✔
607
  pBuf->statis.releasePages += 1;
229,699,174✔
608
}
609

610
size_t getTotalBufSize(const SDiskbasedBuf* pBuf) { return (size_t)pBuf->totalBufSize; }
1✔
611

612
SArray* getDataBufPagesIdList(SDiskbasedBuf* pBuf) { return pBuf->pIdList; }
3✔
613

614
void destroyDiskbasedBuf(SDiskbasedBuf* pBuf) {
1,781,679✔
615
  if (pBuf == NULL) {
1,781,679✔
616
    return;
337,490✔
617
  }
618

619
  dBufPrintStatis(pBuf);
1,444,189✔
620

621
  bool needRemoveFile = false;
1,444,269✔
622
  if (pBuf->pFile != NULL) {
1,444,269✔
623
    needRemoveFile = true;
298✔
624
    uDebug(
298✔
625
        "Paged buffer closed, total:%.2f Kb (%d Pages), inmem size:%.2f Kb (%d Pages), file size:%.2f Kb, page "
626
        "size:%.2f Kb, %s",
627
        pBuf->totalBufSize / 1024.0, pBuf->numOfPages, listNEles(pBuf->lruList) * pBuf->pageSize / 1024.0,
628
        listNEles(pBuf->lruList), pBuf->fileSize / 1024.0, pBuf->pageSize / 1024.0f, pBuf->id);
629

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

638
  // print the statistics information
639
  {
640
    SDiskbasedBufStatis* ps = &pBuf->statis;
1,444,229✔
641
    if (ps->loadPages == 0) {
1,444,229✔
642
      uDebug("Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages)", ps->getPages,
1,443,933✔
643
             ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f, ps->loadPages);
644
    } else {
645
      uDebug(
296✔
646
          "Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages), avgPgSize:%.2f Kb",
647
          ps->getPages, ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f,
648
          ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
649
    }
650
  }
651

652
  if (needRemoveFile) {
1,444,229✔
653
    int32_t ret = taosRemoveFile(pBuf->path);
298✔
654
    if (ret != 0) {  // print the error and discard this error info
298!
655
      uDebug("WARNING tPage remove file failed. path=%s, code:%s", pBuf->path, strerror(errno));
298✔
656
    }
657
  }
658

659
  taosMemoryFreeClear(pBuf->path);
1,444,187!
660

661
  size_t n = taosArrayGetSize(pBuf->pIdList);
1,444,187✔
662
  for (int32_t i = 0; i < n; ++i) {
8,616,142✔
663
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
7,171,566✔
664
    taosMemoryFreeClear(pi->pData);
7,169,916!
665
    taosMemoryFreeClear(pi);
7,173,239!
666
  }
667

668
  taosArrayDestroy(pBuf->pIdList);
1,444,576✔
669

670
  pBuf->lruList = tdListFree(pBuf->lruList);
1,444,311✔
671
  pBuf->freePgList = tdListFree(pBuf->freePgList);
1,444,338✔
672

673
  taosArrayDestroy(pBuf->emptyDummyIdList);
1,444,333✔
674
  taosArrayDestroy(pBuf->pFree);
1,444,335✔
675

676
  tSimpleHashCleanup(pBuf->all);
1,444,336✔
677

678
  taosMemoryFreeClear(pBuf->id);
1,444,339!
679
  taosMemoryFreeClear(pBuf->assistBuf);
1,444,334!
680
  taosMemoryFreeClear(pBuf);
1,444,334!
681
}
682

683
SPageInfo* getLastPageInfo(SArray* pList) {
×
684
  size_t     size = taosArrayGetSize(pList);
×
685
  SPageInfo* pPgInfo = taosArrayGetP(pList, size - 1);
×
686
  return pPgInfo;
×
687
}
688

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

691
int32_t getBufPageSize(const SDiskbasedBuf* pBuf) { return pBuf->pageSize; }
223,207,687✔
692

693
int32_t getNumOfInMemBufPages(const SDiskbasedBuf* pBuf) { return pBuf->inMemPages; }
59,674✔
694

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

697
void setBufPageDirty(void* pPage, bool dirty) {
166,477,307✔
698
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
166,477,307✔
699
  ppi->dirty = dirty;
166,419,997✔
700
}
166,419,997✔
701

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

713
int32_t dBufSetBufPageRecycled(SDiskbasedBuf* pBuf, void* pPage) {
×
714
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
×
715

716
  int32_t code = tdListAppend(pBuf->freePgList, &ppi);
×
717
  if (TSDB_CODE_SUCCESS != code) {
×
718
    return code;
×
719
  }
720

721
  ppi->used = false;
×
722
  ppi->dirty = false;
×
723

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

732
void dBufSetPrintInfo(SDiskbasedBuf* pBuf) { pBuf->printStatis = true; }
145,256✔
733

734
SDiskbasedBufStatis getDBufStatis(const SDiskbasedBuf* pBuf) { return pBuf->statis; }
60,713✔
735

736
void dBufPrintStatis(const SDiskbasedBuf* pBuf) {
1,444,192✔
737
  if (!pBuf->printStatis) {
1,444,192✔
738
    return;
1,298,996✔
739
  }
740

741
  const SDiskbasedBufStatis* ps = &pBuf->statis;
145,196✔
742

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

751
  if (ps->loadPages > 0) {
145,196✔
752
    (void)printf(
68✔
753
        "Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages), avgPageSize:%.2f "
754
        "Kb\n",
755
        ps->getPages, ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f,
68✔
756
        ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
68✔
757
  } else {
758
    // printf("no page loaded\n");
759
  }
760
}
761

762
void clearDiskbasedBuf(SDiskbasedBuf* pBuf) {
16,857✔
763
  size_t n = taosArrayGetSize(pBuf->pIdList);
16,857✔
764
  for (int32_t i = 0; i < n; ++i) {
1,176,638✔
765
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
1,159,781✔
766
    taosMemoryFreeClear(pi->pData);
1,159,781!
767
    taosMemoryFreeClear(pi);
1,159,781!
768
  }
769

770
  taosArrayClear(pBuf->pIdList);
16,857✔
771

772
  tdListEmpty(pBuf->lruList);
16,857✔
773
  tdListEmpty(pBuf->freePgList);
16,857✔
774

775
  taosArrayClear(pBuf->emptyDummyIdList);
16,857✔
776
  taosArrayClear(pBuf->pFree);
16,857✔
777

778
  tSimpleHashClear(pBuf->all);
16,857✔
779

780
  pBuf->numOfPages = 0;  // all pages are in buffer in the first place
16,857✔
781
  pBuf->totalBufSize = 0;
16,857✔
782
  pBuf->allocateId = -1;
16,857✔
783
  pBuf->fileSize = 0;
16,857✔
784
}
16,857✔
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