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

taosdata / TDengine / #3594

24 Jan 2025 08:57AM UTC coverage: 63.086% (-0.2%) from 63.239%
#3594

push

travis-ci

web-flow
Merge pull request #29638 from taosdata/docs/TS-5846-3.0

enh: TDengine modify taosBenchmark new query rule cases and add doc

140232 of 285630 branches covered (49.1%)

Branch coverage included in aggregate %.

218398 of 282844 relevant lines covered (77.22%)

18911829.37 hits per line

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

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

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

70
  return TSDB_CODE_SUCCESS;
8,892✔
71
}
72

73
static char* doCompressData(void* data, int32_t srcSize, int32_t* dst, SDiskbasedBuf* pBuf) {  // do nothing
7,143,559✔
74
  if (!pBuf->comp) {
7,143,559!
75
    *dst = srcSize;
7,143,576✔
76
    return data;
7,143,576✔
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
6,507,974✔
86
  int32_t code = 0;
6,507,974✔
87
  if (!pBuf->comp) {
6,507,974!
88
    *dst = srcSize;
6,507,996✔
89
    return code;
6,507,996✔
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) {
6,219,532✔
103
  if (pBuf->pFree == NULL) {
6,219,532!
104
    return pBuf->nextPos;
×
105
  } else {
106
    int32_t offset = -1;
6,219,532✔
107

108
    size_t num = taosArrayGetSize(pBuf->pFree);
6,219,532✔
109
    for (int32_t i = 0; i < num; ++i) {
6,219,418!
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;
6,219,418✔
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); }
34,283,799✔
135

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

142
  ret = (int32_t)taosWriteFile(pBuf->pFile, pData, size);
7,144,024✔
143
  if (ret != size) {
7,144,043!
144
    return terrno;
×
145
  }
146

147
  // extend the file
148
  if (pBuf->fileSize < offset + size) {
7,144,054✔
149
    pBuf->fileSize = offset + size;
6,220,002✔
150
  }
151

152
  pBuf->statis.flushBytes += size;
7,144,054✔
153
  pBuf->statis.flushPages += 1;
7,144,054✔
154

155
  return TSDB_CODE_SUCCESS;
7,144,054✔
156
}
157

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

168
  char* t = NULL;
10,964,056✔
169
  if ((!HAS_DATA_IN_DISK(pg)) || pg->dirty) {
10,964,056✔
170
    void* payload = GET_PAYLOAD_DATA(pg);
7,143,138✔
171
    t = doCompressData(payload, pBuf->pageSize + sizeof(SFilePage), &size, pBuf);
7,143,138✔
172
    if (size < 0) {
7,143,567!
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) {
10,964,485✔
181
    if (!HAS_DATA_IN_DISK(pg)) {
7,143,553✔
182
      offset = allocateNewPositionInFile(pBuf, size);
6,219,550✔
183
      pBuf->nextPos += size;
6,219,417✔
184

185
      int32_t code = doFlushBufPageImpl(pBuf, offset, t, size);
6,219,417✔
186
      if (code != TSDB_CODE_SUCCESS) {
6,219,850!
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) {
924,003!
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);
924,003✔
204
      if (code != TSDB_CODE_SUCCESS) {
924,053!
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;
3,820,932✔
210
  }
211

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

224
static char* flushBufPage(SDiskbasedBuf* pBuf, SPageInfo* pg) {
10,963,943✔
225
  int32_t ret = TSDB_CODE_SUCCESS;
10,963,943✔
226

227
  if (pBuf->pFile == NULL) {
10,963,943✔
228
    if ((ret = createDiskFile(pBuf)) != TSDB_CODE_SUCCESS) {
8,892!
229
      terrno = ret;
×
230
      return NULL;
×
231
    }
232
  }
233

234
  char* p = doFlushBufPage(pBuf, pg);
10,963,943✔
235
  CLEAR_BUF_PAGE_IN_MEM_FLAG(pg);
10,964,586✔
236

237
  pg->dirty = false;
10,964,586✔
238
  return p;
10,964,586✔
239
}
240

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

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

261
  pBuf->statis.loadBytes += pg->length;
6,508,037✔
262
  pBuf->statis.loadPages += 1;
6,508,037✔
263

264
  int32_t fullSize = 0;
6,508,037✔
265
  return doDecompressData(pPage, pg->length, &fullSize, pBuf);
6,508,037✔
266
}
267

268
static SPageInfo* registerNewPageInfo(SDiskbasedBuf* pBuf, int32_t pageId) {
27,798,958✔
269
  pBuf->numOfPages += 1;
27,798,958✔
270

271
  SPageInfo* ppi = taosMemoryMalloc(sizeof(SPageInfo));
27,798,958!
272
  if (ppi == NULL) {
27,805,260!
273
    terrno = TSDB_CODE_OUT_OF_MEMORY;
×
274
    return NULL;
×
275
  }
276

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

285
  SPageInfo** pRet = taosArrayPush(pBuf->pIdList, &ppi);
27,805,260✔
286
  if (NULL == pRet) {
27,798,830!
287
    taosMemoryFree(ppi);
×
288
    return NULL;
×
289
  }
290
  return *pRet;
27,798,830✔
291
}
292

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

297
  SListNode* pn = NULL;
10,964,346✔
298
  while ((pn = tdListNext(&iter)) != NULL) {
13,321,122✔
299
    SPageInfo* pageInfo = *(SPageInfo**)pn->data;
13,321,250✔
300

301
    SPageInfo* p = *(SPageInfo**)(pageInfo->pData);
13,321,250✔
302

303
    if (!pageInfo->used) {
13,321,250✔
304
      break;
10,964,474✔
305
    }
306
  }
307

308
  return pn;
10,964,477✔
309
}
310

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

317
  terrno = 0;
10,964,431✔
318
  pn = tdListPopNode(pBuf->lruList, pn);
10,964,385✔
319

320
  SPageInfo* d = *(SPageInfo**)pn->data;
10,963,271✔
321

322
  d->pn = NULL;
10,963,271✔
323
  taosMemoryFreeClear(pn);
10,963,271!
324

325
  return flushBufPage(pBuf, d);
10,963,921✔
326
}
327

328
static int32_t lruListPushFront(SList* pList, SPageInfo* pi) {
34,308,898✔
329
  int32_t code = tdListPrepend(pList, &pi);
34,308,898✔
330
  if (TSDB_CODE_SUCCESS != code) {
34,308,516!
331
    return code;
×
332
  }
333
  SListNode* front = tdListGetHead(pList);
34,308,516✔
334
  pi->pn = front;
34,303,404✔
335
  return TSDB_CODE_SUCCESS;
34,303,404✔
336
}
337

338
static void lruListMoveToFront(SList* pList, SPageInfo* pi) {
1,121,198,865✔
339
  pi->pn = tdListPopNode(pList, pi->pn);
1,121,198,865✔
340
  tdListPrependNode(pList, pi->pn);
1,119,289,934✔
341
}
1,118,250,323✔
342

343
static SPageInfo* getPageInfoFromPayload(void* page) {
1,608,994,355✔
344
  char* p = (char*)page - POINTER_BYTES;
1,608,994,355✔
345

346
  SPageInfo* ppi = ((SPageInfo**)p)[0];
1,608,994,355✔
347
  return ppi;
1,608,994,355✔
348
}
349

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

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

378
  // at least more than 2 pages must be in memory
379
  if (inMemBufSize < pagesize * 2) {
10,203,820✔
380
    inMemBufSize = pagesize * 2;
4,313✔
381
  }
382

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

390
  // init id hash table
391
  _hash_fn_t fn = taosGetDefaultHashFunction(TSDB_DATA_TYPE_INT);
10,201,065✔
392
  pPBuf->pIdList = taosArrayInit(4, POINTER_BYTES);
10,203,172✔
393
  if (pPBuf->pIdList == NULL) {
10,208,380!
394
    code = terrno;
×
395
    goto _error;
×
396
  }
397

398
  pPBuf->all = tSimpleHashInit(64, fn);
10,208,380✔
399
  if (pPBuf->all == NULL) {
10,199,153!
400
    code = terrno;
×
401
    goto _error;
×
402
  }
403

404
  pPBuf->prefix = (char*)dir;
10,199,153✔
405
  pPBuf->emptyDummyIdList = taosArrayInit(1, sizeof(int32_t));
10,199,153✔
406
  if (pPBuf->emptyDummyIdList == NULL) {
10,208,193!
407
    code = terrno;
×
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;
10,208,631✔
415
  return TSDB_CODE_SUCCESS;
10,208,631✔
416

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

423
static char* doExtractPage(SDiskbasedBuf* pBuf) {
34,283,354✔
424
  char* availablePage = NULL;
34,283,354✔
425
  if (NO_IN_MEM_AVAILABLE_PAGES(pBuf)) {
34,283,354✔
426
    availablePage = evictBufPage(pBuf);
10,964,390✔
427
    if (availablePage == NULL) {
10,964,528!
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 =
46,659,430✔
433
        taosMemoryCalloc(1, getAllocPageSize(pBuf->pageSize));  // add extract bytes in case of zipped buffer increased.
46,637,928!
434
    if (availablePage == NULL) {
23,340,466!
435
      terrno = TSDB_CODE_OUT_OF_MEMORY;
×
436
    }
437
  }
438

439
  return availablePage;
34,304,994✔
440
}
441

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

445
  char* availablePage = doExtractPage(pBuf);
27,775,516✔
446
  if (availablePage == NULL) {
27,798,424!
447
    return NULL;
×
448
  }
449

450
  SPageInfo* pi = NULL;
27,798,424✔
451
  int32_t    code = 0;
27,798,424✔
452
  if (listNEles(pBuf->freePgList) != 0) {
27,798,424!
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);
987!
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);
27,798,424✔
468

469
    // register page id info
470
    pi = registerNewPageInfo(pBuf, *pageId);
27,798,424✔
471
    if (pi == NULL) {
27,797,127!
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);
27,797,127✔
478

479
    if (TSDB_CODE_SUCCESS == code) {
27,805,387!
480
      // add to LRU list
481
      code = lruListPushFront(pBuf->lruList, pi);
27,805,588✔
482
    }
483
    if (TSDB_CODE_SUCCESS == code) {
27,796,587!
484
      pBuf->totalBufSize += pBuf->pageSize;
27,796,587✔
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;
27,795,600✔
499

500
  ((void**)pi->pData)[0] = pi;
27,795,600✔
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));
27,795,600✔
506
}
507

508
void* getBufPage(SDiskbasedBuf* pBuf, int32_t id) {
1,266,830,822✔
509
  if (id < 0) {
1,266,830,822!
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;
1,266,830,822✔
516

517
  SPageInfo** pi = tSimpleHashGet(pBuf->all, &id, sizeof(int32_t));
1,266,830,822✔
518
  if (pi == NULL || *pi == NULL) {
1,268,457,717!
519
    uError("failed to locate the buffer page:%d, %s", id, pBuf->id);
×
520
    terrno = TSDB_CODE_INVALID_PARA;
×
521
    return NULL;
×
522
  }
523

524
  if (BUF_PAGE_IN_MEM(*pi)) {  // it is in memory
1,268,978,259✔
525
    // no need to update the LRU list if only one page exists
526
    if (pBuf->numOfPages == 1) {
1,262,431,216✔
527
      (*pi)->used = true;
141,949,098✔
528
      return (void*)(GET_PAYLOAD_DATA(*pi));
141,949,098✔
529
    }
530

531
    SPageInfo** pInfo = (SPageInfo**)((*pi)->pn->data);
1,120,482,118✔
532
    if (*pInfo != *pi) {
1,120,482,118!
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));
1,120,482,118✔
539
    (*pi)->used = true;
1,118,303,953✔
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));
1,118,303,953✔
545
  } else {  // not in memory
546

547
    (*pi)->pData = doExtractPage(pBuf);
6,547,043✔
548

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

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

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

566
    // some data has been flushed to disk, and needs to be loaded into buffer again.
567
    if (HAS_DATA_IN_DISK(*pi)) {
6,507,481!
568
      int32_t code = loadPageFromDisk(pBuf, *pi);
6,507,500✔
569
      if (code != 0) {
6,507,968!
570
        taosMemoryFree((*pi)->pData);
×
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));
6,507,964✔
580
  }
581
}
582

583
void releaseBufPage(SDiskbasedBuf* pBuf, void* page) {
1,021,496,000✔
584
  if (page == NULL) {
1,021,496,000!
585
    return;
×
586
  }
587

588
  SPageInfo* ppi = getPageInfoFromPayload(page);
1,021,496,000✔
589
  releaseBufPageInfo(pBuf, ppi);
1,020,109,984✔
590
}
591

592
void releaseBufPageInfo(SDiskbasedBuf* pBuf, SPageInfo* pi) {
1,020,340,737✔
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) {
1,020,340,737!
598
    return;
×
599
  }
600

601
  if (pi->pData == NULL) {
1,020,340,737!
602
    uError("pi->pData (page data) is null");
×
603
    return;
×
604
  }
605

606
  pi->used = false;
1,020,340,737✔
607
  pBuf->statis.releasePages += 1;
1,020,340,737✔
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) {
12,718,051✔
615
  if (pBuf == NULL) {
12,718,051✔
616
    return;
2,508,902✔
617
  }
618

619
  dBufPrintStatis(pBuf);
10,209,149✔
620

621
  bool needRemoveFile = false;
10,209,731✔
622
  if (pBuf->pFile != NULL) {
10,209,731✔
623
    needRemoveFile = true;
8,892✔
624
    uDebug(
8,892✔
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);
8,892✔
631
    if (TSDB_CODE_SUCCESS != code) {
8,892!
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);
10,200,839✔
636
  }
637

638
  // print the statistics information
639
  {
640
    SDiskbasedBufStatis* ps = &pBuf->statis;
10,209,012✔
641
    if (ps->loadPages == 0) {
10,209,012✔
642
      uDebug("Get/Release pages:%d/%d, flushToDisk:%.2f Kb (%d Pages), loadFromDisk:%.2f Kb (%d Pages)", ps->getPages,
10,200,132✔
643
             ps->releasePages, ps->flushBytes / 1024.0f, ps->flushPages, ps->loadBytes / 1024.0f, ps->loadPages);
644
    } else {
645
      uDebug(
8,880✔
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) {
10,209,012✔
653
    int32_t ret = taosRemoveFile(pBuf->path);
8,892✔
654
    if (ret != 0) {  // print the error and discard this error info
8,892!
655
      uDebug("WARNING tPage remove file failed. path=%s, code:%s", pBuf->path, strerror(errno));
8,892✔
656
    }
657
  }
658

659
  taosMemoryFreeClear(pBuf->path);
10,208,362!
660

661
  size_t n = taosArrayGetSize(pBuf->pIdList);
10,208,362✔
662
  for (int32_t i = 0; i < n; ++i) {
36,965,709✔
663
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
26,754,971✔
664
    taosMemoryFreeClear(pi->pData);
26,746,822!
665
    taosMemoryFreeClear(pi);
26,759,449!
666
  }
667

668
  taosArrayDestroy(pBuf->pIdList);
10,210,738✔
669

670
  pBuf->lruList = tdListFree(pBuf->lruList);
10,210,176✔
671
  pBuf->freePgList = tdListFree(pBuf->freePgList);
10,210,861✔
672

673
  taosArrayDestroy(pBuf->emptyDummyIdList);
10,210,928✔
674
  taosArrayDestroy(pBuf->pFree);
10,210,834✔
675

676
  tSimpleHashCleanup(pBuf->all);
10,210,921✔
677

678
  taosMemoryFreeClear(pBuf->id);
10,211,065!
679
  taosMemoryFreeClear(pBuf->assistBuf);
10,211,031!
680
  taosMemoryFreeClear(pBuf);
10,211,031!
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; }
586,870,347✔
692

693
int32_t getNumOfInMemBufPages(const SDiskbasedBuf* pBuf) { return pBuf->inMemPages; }
2,154,291✔
694

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

697
void setBufPageDirty(void* pPage, bool dirty) {
601,076,195✔
698
  SPageInfo* ppi = getPageInfoFromPayload(pPage);
601,076,195✔
699
  ppi->dirty = dirty;
600,874,071✔
700
}
600,874,071✔
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; }
3,533,370✔
733

734
SDiskbasedBufStatis getDBufStatis(const SDiskbasedBuf* pBuf) { return pBuf->statis; }
2,285,521✔
735

736
void dBufPrintStatis(const SDiskbasedBuf* pBuf) {
10,208,802✔
737
  if (!pBuf->printStatis) {
10,208,802✔
738
    return;
6,675,621✔
739
  }
740

741
  const SDiskbasedBufStatis* ps = &pBuf->statis;
3,533,181✔
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) {
3,533,181✔
752
    (void)printf(
544✔
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,
544✔
756
        ps->loadPages, ps->loadBytes / (1024.0 * ps->loadPages));
544✔
757
  } else {
758
    // printf("no page loaded\n");
759
  }
760
}
761

762
void clearDiskbasedBuf(SDiskbasedBuf* pBuf) {
26,415✔
763
  size_t n = taosArrayGetSize(pBuf->pIdList);
26,415✔
764
  for (int32_t i = 0; i < n; ++i) {
1,073,853✔
765
    SPageInfo* pi = taosArrayGetP(pBuf->pIdList, i);
1,047,438✔
766
    taosMemoryFreeClear(pi->pData);
1,047,404✔
767
    taosMemoryFreeClear(pi);
1,047,440!
768
  }
769

770
  taosArrayClear(pBuf->pIdList);
26,415✔
771

772
  tdListEmpty(pBuf->lruList);
26,414✔
773
  tdListEmpty(pBuf->freePgList);
26,413✔
774

775
  taosArrayClear(pBuf->emptyDummyIdList);
26,414✔
776
  taosArrayClear(pBuf->pFree);
26,414✔
777

778
  tSimpleHashClear(pBuf->all);
26,414✔
779

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