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

taosdata / TDengine / #4970

28 Feb 2026 08:05AM UTC coverage: 67.707% (+0.02%) from 67.69%
#4970

push

travis-ci

web-flow
fix(planner): disable project block merge in non-top-level subplans (#34617)

208390 of 307783 relevant lines covered (67.71%)

125793239.88 hits per line

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

74.84
/source/util/src/tlrucache.c
1
/*
2
 * Copyright (c) 2019 TAOS Data, Inc. <jhtao@taosdata.com>
3
 *
4
 * This program is free software: you can use, redistribute, and/or modify
5
 * it under the terms of the GNU Affero General Public License, version 3
6
 * or later ("AGPL"), as published by the Free Software Foundation.
7
 *
8
 * This program is distributed in the hope that it will be useful, but WITHOUT
9
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10
 * FITNESS FOR A PARTICULAR PURPOSE.
11
 *
12
 * You should have received a copy of the GNU Affero General Public License
13
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
14
 */
15

16
#define _DEFAULT_SOURCE
17
#include "tlrucache.h"
18
#include "os.h"
19
#include "taoserror.h"
20
#include "tarray.h"
21
#include "tdef.h"
22
#include "tlog.h"
23
#include "tutil.h"
24

25
typedef struct SLRUEntry      SLRUEntry;
26
typedef struct SLRUEntryTable SLRUEntryTable;
27
typedef struct SLRUCacheShard SLRUCacheShard;
28
typedef struct SShardedCache  SShardedCache;
29

30
enum {
31
  TAOS_LRU_IN_CACHE = (1 << 0),  // Whether this entry is referenced by the hash table.
32

33
  TAOS_LRU_IS_HIGH_PRI = (1 << 1),  // Whether this entry is high priority entry.
34

35
  TAOS_LRU_IN_HIGH_PRI_POOL = (1 << 2),  // Whether this entry is in high-pri pool.
36

37
  TAOS_LRU_HAS_HIT = (1 << 3),  // Whether this entry has had any lookups (hits).
38
};
39

40
struct SLRUEntry {
41
  void                  *value;
42
  _taos_lru_deleter_t    deleter;
43
  _taos_lru_overwriter_t overwriter;
44
  void                  *ud;
45
  SLRUEntry             *nextHash;
46
  SLRUEntry             *next;
47
  SLRUEntry             *prev;
48
  size_t                 totalCharge;
49
  size_t                 keyLength;
50
  uint32_t               hash;
51
  uint32_t               refs;
52
  uint8_t                flags;
53
  char                   keyData[1];
54
};
55

56
#define TAOS_LRU_ENTRY_IN_CACHE(h)     ((h)->flags & TAOS_LRU_IN_CACHE)
57
#define TAOS_LRU_ENTRY_IN_HIGH_POOL(h) ((h)->flags & TAOS_LRU_IN_HIGH_PRI_POOL)
58
#define TAOS_LRU_ENTRY_IS_HIGH_PRI(h)  ((h)->flags & TAOS_LRU_IS_HIGH_PRI)
59
#define TAOS_LRU_ENTRY_HAS_HIT(h)      ((h)->flags & TAOS_LRU_HAS_HIT)
60

61
#define TAOS_LRU_ENTRY_SET_IN_CACHE(h, inCache) \
62
  do {                                          \
63
    if (inCache) {                              \
64
      (h)->flags |= TAOS_LRU_IN_CACHE;          \
65
    } else {                                    \
66
      (h)->flags &= ~TAOS_LRU_IN_CACHE;         \
67
    }                                           \
68
  } while (0)
69
#define TAOS_LRU_ENTRY_SET_IN_HIGH_POOL(h, inHigh) \
70
  do {                                             \
71
    if (inHigh) {                                  \
72
      (h)->flags |= TAOS_LRU_IN_HIGH_PRI_POOL;     \
73
    } else {                                       \
74
      (h)->flags &= ~TAOS_LRU_IN_HIGH_PRI_POOL;    \
75
    }                                              \
76
  } while (0)
77
#define TAOS_LRU_ENTRY_SET_PRIORITY(h, priority) \
78
  do {                                           \
79
    if (priority == TAOS_LRU_PRIORITY_HIGH) {    \
80
      (h)->flags |= TAOS_LRU_IS_HIGH_PRI;        \
81
    } else {                                     \
82
      (h)->flags &= ~TAOS_LRU_IS_HIGH_PRI;       \
83
    }                                            \
84
  } while (0)
85
#define TAOS_LRU_ENTRY_SET_HIT(h) ((h)->flags |= TAOS_LRU_HAS_HIT)
86

87
#define TAOS_LRU_ENTRY_HAS_REFS(h) ((h)->refs > 0)
88
#define TAOS_LRU_ENTRY_REF(h)      (++(h)->refs)
89

90
static bool taosLRUEntryUnref(SLRUEntry *entry) {
49,472,248✔
91
  --entry->refs;
49,472,248✔
92
  return entry->refs == 0;
49,472,248✔
93
}
94

95
static void taosLRUEntryFree(SLRUEntry *entry) {
97,224,386✔
96
  if (entry->deleter) {
97,224,386✔
97
    (*entry->deleter)(entry->keyData, entry->keyLength, entry->value, entry->ud);
97,225,996✔
98
  }
99

100
  taosMemoryFree(entry);
97,225,352✔
101
}
97,222,132✔
102

103
typedef void (*_taos_lru_table_func_t)(SLRUEntry *entry);
104

105
struct SLRUEntryTable {
106
  int         lengthBits;
107
  SLRUEntry **list;
108
  uint32_t    elems;
109
  int         maxLengthBits;
110
};
111

112
static int taosLRUEntryTableInit(SLRUEntryTable *table, int maxUpperHashBits) {
215,036,351✔
113
  table->lengthBits = 16;
215,036,351✔
114
  table->list = taosMemoryCalloc(1 << table->lengthBits, sizeof(SLRUEntry *));
215,039,064✔
115
  if (!table->list) {
215,047,797✔
116
    TAOS_RETURN(terrno);
×
117
  }
118

119
  table->elems = 0;
215,047,206✔
120
  table->maxLengthBits = maxUpperHashBits;
215,047,384✔
121

122
  TAOS_RETURN(TSDB_CODE_SUCCESS);
215,047,384✔
123
}
124

125
static void taosLRUEntryTableApply(SLRUEntryTable *table, _taos_lru_table_func_t func, uint32_t begin, uint32_t end) {
215,016,949✔
126
  for (uint32_t i = begin; i < end; ++i) {
2,147,483,647✔
127
    SLRUEntry *h = table->list[i];
2,147,483,647✔
128
    while (h) {
2,147,483,647✔
129
      SLRUEntry *n = h->nextHash;
6,361✔
130
      func(h);
6,361✔
131
      h = n;
124✔
132
    }
133
  }
134
}
23,590✔
135

136
static void taosLRUEntryTableFree(SLRUEntry *entry) {
6,361✔
137
  if (!TAOS_LRU_ENTRY_HAS_REFS(entry)) {
6,361✔
138
    taosLRUEntryFree(entry);
6,361✔
139
  }
140
}
6,361✔
141

142
static void taosLRUEntryTableCleanup(SLRUEntryTable *table) {
215,018,655✔
143
  taosLRUEntryTableApply(table, taosLRUEntryTableFree, 0, 1 << table->lengthBits);
215,018,655✔
144

145
  taosMemoryFree(table->list);
215,019,250✔
146
}
215,022,049✔
147

148
static int taosLRUEntryTableApplyF(SLRUEntryTable *table, _taos_lru_functor_t functor, void *ud) {
1,009,009✔
149
  int      ret = 0;
1,009,009✔
150
  uint32_t end = 1 << table->lengthBits;
1,009,009✔
151
  for (uint32_t i = 0; i < end; ++i) {
2,147,483,647✔
152
    SLRUEntry *h = table->list[i];
2,147,483,647✔
153
    while (h) {
2,147,483,647✔
154
      SLRUEntry *n = h->nextHash;
57,023,585✔
155
      ret = functor(h->keyData, h->keyLength, h->value, ud);
57,025,779✔
156
      if (ret) {
57,028,029✔
157
        return ret;
×
158
      }
159
      h = n;
57,028,029✔
160
    }
161
  }
162

163
  return ret;
×
164
}
165

166
static SLRUEntry **taosLRUEntryTableFindPtr(SLRUEntryTable *table, const void *key, size_t keyLen, uint32_t hash) {
226,326,055✔
167
  SLRUEntry **entry = &table->list[hash >> (32 - table->lengthBits)];
226,326,055✔
168
  while (*entry && ((*entry)->hash != hash || memcmp(key, (*entry)->keyData, keyLen) != 0)) {
233,168,660✔
169
    entry = &(*entry)->nextHash;
6,828,389✔
170
  }
171

172
  return entry;
226,339,308✔
173
}
174

175
static void taosLRUEntryTableResize(SLRUEntryTable *table) {
×
176
  int lengthBits = table->lengthBits;
×
177
  if (lengthBits >= table->maxLengthBits) {
×
178
    return;
×
179
  }
180

181
  if (lengthBits >= 31) {
×
182
    return;
×
183
  }
184

185
  uint32_t    oldLength = 1 << lengthBits;
×
186
  int         newLengthBits = lengthBits + 1;
×
187
  SLRUEntry **newList = taosMemoryCalloc(1 << newLengthBits, sizeof(SLRUEntry *));
×
188
  if (!newList) {
×
189
    return;
×
190
  }
191
  uint32_t count = 0;
×
192
  for (uint32_t i = 0; i < oldLength; ++i) {
×
193
    SLRUEntry *entry = table->list[i];
×
194
    while (entry) {
×
195
      SLRUEntry  *next = entry->nextHash;
×
196
      uint32_t    hash = entry->hash;
×
197
      SLRUEntry **ptr = &newList[hash >> (32 - newLengthBits)];
×
198
      entry->nextHash = *ptr;
×
199
      *ptr = entry;
×
200
      entry = next;
×
201
      ++count;
×
202
    }
203
  }
204

205
  taosMemoryFree(table->list);
×
206
  table->list = newList;
×
207
  table->lengthBits = newLengthBits;
×
208
}
209

210
static SLRUEntry *taosLRUEntryTableLookup(SLRUEntryTable *table, const void *key, size_t keyLen, uint32_t hash) {
78,988,581✔
211
  return *taosLRUEntryTableFindPtr(table, key, keyLen, hash);
78,988,581✔
212
}
213

214
static SLRUEntry *taosLRUEntryTableInsert(SLRUEntryTable *table, SLRUEntry *entry) {
97,226,082✔
215
  SLRUEntry **ptr = taosLRUEntryTableFindPtr(table, entry->keyData, entry->keyLength, entry->hash);
97,226,082✔
216
  SLRUEntry  *old = *ptr;
97,225,125✔
217
  entry->nextHash = (old == NULL) ? NULL : old->nextHash;
97,225,251✔
218
  *ptr = entry;
97,225,531✔
219
  if (old == NULL) {
97,225,468✔
220
    ++table->elems;
49,992,278✔
221
    if ((table->elems >> table->lengthBits) > 0) {
49,992,189✔
222
      taosLRUEntryTableResize(table);
×
223
    }
224
  }
225

226
  return old;
97,223,998✔
227
}
228

229
static SLRUEntry *taosLRUEntryTableRemove(SLRUEntryTable *table, const void *key, size_t keyLen, uint32_t hash) {
50,128,489✔
230
  SLRUEntry **entry = taosLRUEntryTableFindPtr(table, key, keyLen, hash);
50,128,489✔
231
  SLRUEntry  *result = *entry;
50,128,489✔
232
  if (result) {
50,128,489✔
233
    *entry = result->nextHash;
49,991,289✔
234
    --table->elems;
49,991,289✔
235
  }
236

237
  return result;
50,128,489✔
238
}
239

240
struct SLRUCacheShard {
241
  size_t         capacity;
242
  size_t         highPriPoolUsage;
243
  bool           strictCapacity;
244
  double         highPriPoolRatio;
245
  double         highPriPoolCapacity;
246
  SLRUEntry      lru;
247
  SLRUEntry     *lruLowPri;
248
  SLRUEntryTable table;
249
  size_t         usage;     // Memory size for entries residing in the cache.
250
  size_t         lruUsage;  // Memory size for entries residing only in the LRU list.
251
  TdThreadMutex  mutex;
252
};
253

254
#define TAOS_LRU_CACHE_SHARD_HASH32(key, len) (MurmurHash3_32((key), (len)))
255

256
static void taosLRUCacheShardMaintainPoolSize(SLRUCacheShard *shard) {
2,101,149✔
257
  while (shard->highPriPoolUsage > shard->highPriPoolCapacity) {
2,101,149✔
258
    shard->lruLowPri = shard->lruLowPri->next;
×
259
    TAOS_LRU_ENTRY_SET_IN_HIGH_POOL(shard->lruLowPri, false);
×
260

261
    shard->highPriPoolUsage -= shard->lruLowPri->totalCharge;
×
262
  }
263
}
2,101,979✔
264

265
static void taosLRUCacheShardLRUInsert(SLRUCacheShard *shard, SLRUEntry *e) {
99,326,609✔
266
  if (shard->highPriPoolRatio > 0 && (TAOS_LRU_ENTRY_IS_HIGH_PRI(e) || TAOS_LRU_ENTRY_HAS_HIT(e))) {
99,326,609✔
267
    e->next = &shard->lru;
2,100,728✔
268
    e->prev = shard->lru.prev;
2,101,979✔
269

270
    e->prev->next = e;
2,101,979✔
271
    e->next->prev = e;
2,101,979✔
272

273
    TAOS_LRU_ENTRY_SET_IN_HIGH_POOL(e, true);
2,101,149✔
274
    shard->highPriPoolUsage += e->totalCharge;
2,101,564✔
275
    taosLRUCacheShardMaintainPoolSize(shard);
2,101,149✔
276
  } else {
277
    e->next = shard->lruLowPri->next;
97,223,622✔
278
    e->prev = shard->lruLowPri;
97,224,369✔
279

280
    e->prev->next = e;
97,225,715✔
281
    e->next->prev = e;
97,225,325✔
282

283
    TAOS_LRU_ENTRY_SET_IN_HIGH_POOL(e, false);
97,219,634✔
284
    shard->lruLowPri = e;
97,222,357✔
285
  }
286

287
  shard->lruUsage += e->totalCharge;
99,324,035✔
288
}
99,327,251✔
289

290
static void taosLRUCacheShardLRURemove(SLRUCacheShard *shard, SLRUEntry *e) {
99,325,050✔
291
  if (shard->lruLowPri == e) {
99,325,050✔
292
    shard->lruLowPri = e->prev;
100,126✔
293
  }
294
  e->next->prev = e->prev;
99,325,050✔
295
  e->prev->next = e->next;
99,324,728✔
296
  e->prev = e->next = NULL;
99,318,733✔
297

298
  shard->lruUsage -= e->totalCharge;
99,319,055✔
299
  if (TAOS_LRU_ENTRY_IN_HIGH_POOL(e)) {
99,319,161✔
300
    shard->highPriPoolUsage -= e->totalCharge;
2,097,407✔
301
  }
302
}
99,321,093✔
303

304
static void taosLRUCacheShardEvictLRU(SLRUCacheShard *shard, size_t charge, SArray *deleted) {
215,047,710✔
305
  while (shard->usage + charge > shard->capacity && shard->lru.next != &shard->lru) {
215,047,710✔
306
    SLRUEntry *old = shard->lru.next;
×
307

308
    taosLRUCacheShardLRURemove(shard, old);
×
309
    SLRUEntry *tentry = taosLRUEntryTableRemove(&shard->table, old->keyData, old->keyLength, old->hash);
×
310
    TAOS_LRU_ENTRY_SET_IN_CACHE(old, false);
×
311
    shard->usage -= old->totalCharge;
×
312

313
    if (!taosArrayPush(deleted, &old)) {
×
314
      // ignore this round's eviting
315
    }
316
  }
317
}
215,049,411✔
318

319
static void taosLRUCacheShardSetCapacity(SLRUCacheShard *shard, size_t capacity) {
215,045,502✔
320
  SArray *lastReferenceList = taosArrayInit(16, POINTER_BYTES);
215,045,502✔
321
  if (!lastReferenceList) {
215,037,004✔
322
    return;
×
323
  }
324

325
  (void)taosThreadMutexLock(&shard->mutex);
215,037,004✔
326

327
  shard->capacity = capacity;
215,053,016✔
328
  shard->highPriPoolCapacity = capacity * shard->highPriPoolRatio;
215,052,007✔
329
  taosLRUCacheShardEvictLRU(shard, 0, lastReferenceList);
215,051,164✔
330

331
  (void)taosThreadMutexUnlock(&shard->mutex);
215,046,838✔
332

333
  for (int i = 0; i < taosArrayGetSize(lastReferenceList); ++i) {
215,052,314✔
334
    SLRUEntry *entry = taosArrayGetP(lastReferenceList, i);
×
335
    taosLRUEntryFree(entry);
×
336
  }
337
  taosArrayDestroy(lastReferenceList);
215,046,183✔
338
}
339

340
static int taosLRUCacheShardInit(SLRUCacheShard *shard, size_t capacity, bool strict, double highPriPoolRatio,
215,036,339✔
341
                                 int maxUpperHashBits) {
342
  TAOS_CHECK_RETURN(taosLRUEntryTableInit(&shard->table, maxUpperHashBits));
215,036,339✔
343

344
  (void)taosThreadMutexInit(&shard->mutex, NULL);
215,046,577✔
345

346
  (void)taosThreadMutexLock(&shard->mutex);
215,047,193✔
347
  shard->capacity = 0;
215,047,238✔
348
  shard->highPriPoolUsage = 0;
215,046,847✔
349
  shard->strictCapacity = strict;
215,047,238✔
350
  shard->highPriPoolRatio = highPriPoolRatio;
215,047,060✔
351
  shard->highPriPoolCapacity = 0;
215,047,060✔
352

353
  shard->usage = 0;
215,046,800✔
354
  shard->lruUsage = 0;
215,046,548✔
355

356
  shard->lru.next = &shard->lru;
215,046,307✔
357
  shard->lru.prev = &shard->lru;
215,046,054✔
358
  shard->lruLowPri = &shard->lru;
215,045,861✔
359
  (void)taosThreadMutexUnlock(&shard->mutex);
215,045,973✔
360

361
  taosLRUCacheShardSetCapacity(shard, capacity);
215,045,653✔
362

363
  TAOS_RETURN(TSDB_CODE_SUCCESS);
215,035,168✔
364
}
365

366
static void taosLRUCacheShardCleanup(SLRUCacheShard *shard) {
215,021,129✔
367
  (void)taosThreadMutexDestroy(&shard->mutex);
215,021,129✔
368

369
  taosLRUEntryTableCleanup(&shard->table);
215,019,386✔
370
}
215,021,214✔
371

372
static LRUStatus taosLRUCacheShardInsertEntry(SLRUCacheShard *shard, SLRUEntry *e, LRUHandle **handle,
97,225,662✔
373
                                              bool freeOnFail) {
374
  LRUStatus  status = TAOS_LRU_STATUS_OK;
97,225,662✔
375
  SLRUEntry *toFree = NULL;
97,225,662✔
376
  SArray    *lastReferenceList = NULL;
97,225,662✔
377
  if (shard->usage + e->totalCharge > shard->capacity) {
97,225,662✔
378
    lastReferenceList = taosArrayInit(16, POINTER_BYTES);
×
379
    if (!lastReferenceList) {
×
380
      taosLRUEntryFree(e);
×
381
      return TAOS_LRU_STATUS_FAIL;
×
382
    }
383
  }
384

385
  (void)taosThreadMutexLock(&shard->mutex);
97,227,475✔
386

387
  if (shard->usage + e->totalCharge > shard->capacity && shard->lru.next != &shard->lru) {
97,227,948✔
388
    if (!lastReferenceList) {
×
389
      lastReferenceList = taosArrayInit(16, POINTER_BYTES);
×
390
      if (!lastReferenceList) {
×
391
        taosLRUEntryFree(e);
×
392
        (void)taosThreadMutexUnlock(&shard->mutex);
×
393
        return TAOS_LRU_STATUS_FAIL;
×
394
      }
395
    }
396
    taosLRUCacheShardEvictLRU(shard, e->totalCharge, lastReferenceList);
×
397
  }
398

399
  if (shard->usage + e->totalCharge > shard->capacity && (shard->strictCapacity || handle == NULL)) {
97,228,063✔
400
    TAOS_LRU_ENTRY_SET_IN_CACHE(e, false);
×
401
    if (handle == NULL) {
×
402
      toFree = e;
×
403
    } else {
404
      if (freeOnFail) {
×
405
        taosLRUEntryFree(e);
×
406

407
        *handle = NULL;
×
408
      }
409

410
      status = TAOS_LRU_STATUS_INCOMPLETE;
×
411
    }
412
  } else {
413
    SLRUEntry *old = taosLRUEntryTableInsert(&shard->table, e);
97,224,038✔
414
    shard->usage += e->totalCharge;
97,222,864✔
415
    if (old != NULL) {
97,223,335✔
416
      status = TAOS_LRU_STATUS_OK_OVERWRITTEN;
47,231,566✔
417

418
      if (old->overwriter) {
47,231,566✔
419
        (*old->overwriter)(old->keyData, old->keyLength, old->value, old->ud);
47,231,566✔
420
      }
421

422
      TAOS_LRU_ENTRY_SET_IN_CACHE(old, false);
47,232,210✔
423
      if (!TAOS_LRU_ENTRY_HAS_REFS(old)) {
47,232,210✔
424
        taosLRUCacheShardLRURemove(shard, old);
538✔
425
        shard->usage -= old->totalCharge;
538✔
426

427
        toFree = old;
×
428
      }
429
    }
430
    if (handle == NULL) {
97,222,354✔
431
      taosLRUCacheShardLRUInsert(shard, e);
97,222,354✔
432
    } else {
433
      if (!TAOS_LRU_ENTRY_HAS_REFS(e)) {
×
434
        TAOS_LRU_ENTRY_REF(e);
×
435
      }
436

437
      *handle = (LRUHandle *)e;
×
438
    }
439
  }
440

441
_exit:
97,222,980✔
442
  (void)taosThreadMutexUnlock(&shard->mutex);
97,222,980✔
443

444
  if (toFree) {
97,225,751✔
445
    taosLRUEntryFree(toFree);
538✔
446
  }
447

448
  for (int i = 0; i < taosArrayGetSize(lastReferenceList); ++i) {
97,225,709✔
449
    SLRUEntry *entry = taosArrayGetP(lastReferenceList, i);
×
450

451
    taosLRUEntryFree(entry);
×
452
  }
453
  taosArrayDestroy(lastReferenceList);
97,225,746✔
454

455
  return status;
97,224,929✔
456
}
457

458
static LRUStatus taosLRUCacheShardInsert(SLRUCacheShard *shard, const void *key, size_t keyLen, uint32_t hash,
97,227,119✔
459
                                         void *value, size_t charge, _taos_lru_deleter_t deleter,
460
                                         _taos_lru_overwriter_t overwriter, LRUHandle **handle, LRUPriority priority,
461
                                         void *ud) {
462
  SLRUEntry *e = taosMemoryCalloc(1, sizeof(SLRUEntry) - 1 + keyLen);
97,227,119✔
463
  if (!e) {
97,209,789✔
464
    if (deleter) {
×
465
      (*deleter)(key, keyLen, value, ud);
×
466
    }
467
    return TAOS_LRU_STATUS_FAIL;
×
468
  }
469

470
  e->value = value;
97,209,789✔
471
  e->flags = 0;
97,209,789✔
472
  e->deleter = deleter;
97,210,032✔
473
  e->overwriter = overwriter;
97,209,773✔
474
  e->ud = ud;
97,214,550✔
475
  e->keyLength = keyLen;
97,213,579✔
476
  e->hash = hash;
97,215,589✔
477
  e->refs = 0;
97,220,315✔
478
  e->next = e->prev = NULL;
97,222,452✔
479
  TAOS_LRU_ENTRY_SET_IN_CACHE(e, true);
97,223,920✔
480

481
  TAOS_LRU_ENTRY_SET_PRIORITY(e, priority);
97,220,939✔
482
  memcpy(e->keyData, key, keyLen);
97,223,077✔
483
  // TODO: e->CalcTotalCharge(charge, metadataChargePolicy);
484
  e->totalCharge = charge;
97,222,106✔
485

486
  return taosLRUCacheShardInsertEntry(shard, e, handle, true);
97,225,541✔
487
}
488

489
static LRUHandle *taosLRUCacheShardLookup(SLRUCacheShard *shard, const void *key, size_t keyLen, uint32_t hash) {
78,984,633✔
490
  SLRUEntry *e = NULL;
78,984,633✔
491

492
  (void)taosThreadMutexLock(&shard->mutex);
78,984,633✔
493
  e = taosLRUEntryTableLookup(&shard->table, key, keyLen, hash);
78,989,961✔
494
  if (e != NULL) {
78,987,000✔
495
    if (!TAOS_LRU_ENTRY_HAS_REFS(e)) {
49,471,604✔
496
      taosLRUCacheShardLRURemove(shard, e);
49,470,851✔
497
    }
498
    TAOS_LRU_ENTRY_REF(e);
49,466,575✔
499
    TAOS_LRU_ENTRY_SET_HIT(e);
49,467,956✔
500
  }
501

502
  (void)taosThreadMutexUnlock(&shard->mutex);
78,983,996✔
503

504
  return (LRUHandle *)e;
78,985,741✔
505
}
506

507
static void taosLRUCacheShardErase(SLRUCacheShard *shard, const void *key, size_t keyLen, uint32_t hash) {
139,308✔
508
  bool lastReference = false;
139,308✔
509
  (void)taosThreadMutexLock(&shard->mutex);
139,308✔
510

511
  SLRUEntry *e = taosLRUEntryTableRemove(&shard->table, key, keyLen, hash);
139,308✔
512
  if (e != NULL) {
139,308✔
513
    TAOS_LRU_ENTRY_SET_IN_CACHE(e, false);
2,108✔
514
    if (!TAOS_LRU_ENTRY_HAS_REFS(e)) {
2,108✔
515
      taosLRUCacheShardLRURemove(shard, e);
2,108✔
516

517
      shard->usage -= e->totalCharge;
2,108✔
518
      lastReference = true;
2,108✔
519
    }
520
  }
521

522
  (void)taosThreadMutexUnlock(&shard->mutex);
139,308✔
523

524
  if (lastReference) {
139,308✔
525
    taosLRUEntryFree(e);
2,108✔
526
  }
527
}
139,308✔
528

529
static int taosLRUCacheShardApply(SLRUCacheShard *shard, _taos_lru_functor_t functor, void *ud) {
1,011,006✔
530
  int ret;
531

532
  (void)taosThreadMutexLock(&shard->mutex);
1,011,006✔
533

534
  ret = taosLRUEntryTableApplyF(&shard->table, functor, ud);
1,008,807✔
535

536
  (void)taosThreadMutexUnlock(&shard->mutex);
1,012,351✔
537

538
  return ret;
1,012,351✔
539
}
540

541
static void taosLRUCacheShardEraseUnrefEntries(SLRUCacheShard *shard) {
77,447,766✔
542
  SArray *lastReferenceList = taosArrayInit(16, POINTER_BYTES);
77,447,766✔
543

544
  (void)taosThreadMutexLock(&shard->mutex);
77,447,371✔
545

546
  while (shard->lru.next != &shard->lru) {
127,300,105✔
547
    SLRUEntry *old = shard->lru.next;
49,851,981✔
548
    taosLRUCacheShardLRURemove(shard, old);
49,851,981✔
549
    SLRUEntry *tentry = taosLRUEntryTableRemove(&shard->table, old->keyData, old->keyLength, old->hash);
49,851,981✔
550
    TAOS_LRU_ENTRY_SET_IN_CACHE(old, false);
49,851,981✔
551
    shard->usage -= old->totalCharge;
49,851,981✔
552

553
    if (!taosArrayPush(lastReferenceList, &old)) {
49,851,981✔
554
      taosLRUEntryFree(old);
×
555
      return;
×
556
    }
557
  }
558

559
  (void)taosThreadMutexUnlock(&shard->mutex);
77,448,003✔
560

561
  for (int i = 0; i < taosArrayGetSize(lastReferenceList); ++i) {
127,300,316✔
562
    SLRUEntry *entry = taosArrayGetP(lastReferenceList, i);
49,851,981✔
563

564
    taosLRUEntryFree(entry);
49,851,981✔
565
  }
566

567
  taosArrayDestroy(lastReferenceList);
77,448,225✔
568
}
569

570
static bool taosLRUCacheShardRef(SLRUCacheShard *shard, LRUHandle *handle) {
×
571
  SLRUEntry *e = (SLRUEntry *)handle;
×
572
  (void)taosThreadMutexLock(&shard->mutex);
×
573

574
  TAOS_LRU_ENTRY_REF(e);
×
575

576
  (void)taosThreadMutexUnlock(&shard->mutex);
×
577

578
  return true;
×
579
}
580

581
static bool taosLRUCacheShardRelease(SLRUCacheShard *shard, LRUHandle *handle, bool eraseIfLastRef) {
49,471,926✔
582
  if (handle == NULL) {
49,471,926✔
583
    return false;
×
584
  }
585

586
  SLRUEntry *e = (SLRUEntry *)handle;
49,471,926✔
587
  bool       lastReference = false;
49,471,926✔
588

589
  (void)taosThreadMutexLock(&shard->mutex);
49,471,926✔
590

591
  lastReference = taosLRUEntryUnref(e);
49,472,248✔
592
  if (lastReference && TAOS_LRU_ENTRY_IN_CACHE(e)) {
49,472,248✔
593
    if (shard->usage > shard->capacity || eraseIfLastRef) {
2,239,179✔
594
      SLRUEntry *tentry = taosLRUEntryTableRemove(&shard->table, e->keyData, e->keyLength, e->hash);
137,200✔
595
      TAOS_LRU_ENTRY_SET_IN_CACHE(e, false);
137,200✔
596
    } else {
597
      taosLRUCacheShardLRUInsert(shard, e);
2,101,564✔
598

599
      lastReference = false;
2,101,979✔
600
    }
601
  }
602

603
  if (lastReference && e->value) {
49,472,248✔
604
    shard->usage -= e->totalCharge;
47,369,516✔
605
  }
606

607
  (void)taosThreadMutexUnlock(&shard->mutex);
49,472,248✔
608

609
  if (lastReference) {
49,472,248✔
610
    taosLRUEntryFree(e);
47,369,516✔
611
  }
612

613
  return lastReference;
49,470,638✔
614
}
615

616
static size_t taosLRUCacheShardGetUsage(SLRUCacheShard *shard) {
124,953,198✔
617
  size_t usage = 0;
124,953,198✔
618

619
  (void)taosThreadMutexLock(&shard->mutex);
124,953,198✔
620
  usage = shard->usage;
124,953,198✔
621
  (void)taosThreadMutexUnlock(&shard->mutex);
124,953,198✔
622

623
  return usage;
124,953,198✔
624
}
625

626
static int32_t taosLRUCacheShardGetElems(SLRUCacheShard *shard) {
133,459,198✔
627
  int32_t elems = 0;
133,459,198✔
628

629
  (void)taosThreadMutexLock(&shard->mutex);
133,459,198✔
630
  elems = shard->table.elems;
133,459,198✔
631
  (void)taosThreadMutexUnlock(&shard->mutex);
133,459,198✔
632

633
  return elems;
133,459,198✔
634
}
635

636
static size_t taosLRUCacheShardGetPinnedUsage(SLRUCacheShard *shard) {
×
637
  size_t usage = 0;
×
638

639
  (void)taosThreadMutexLock(&shard->mutex);
×
640

641
  usage = shard->usage - shard->lruUsage;
×
642

643
  (void)taosThreadMutexUnlock(&shard->mutex);
×
644

645
  return usage;
×
646
}
647

648
static void taosLRUCacheShardSetStrictCapacity(SLRUCacheShard *shard, bool strict) {
77,468,416✔
649
  (void)taosThreadMutexLock(&shard->mutex);
77,468,416✔
650

651
  shard->strictCapacity = strict;
77,472,332✔
652

653
  (void)taosThreadMutexUnlock(&shard->mutex);
77,471,787✔
654
}
77,470,287✔
655

656
struct SShardedCache {
657
  uint32_t      shardMask;
658
  TdThreadMutex capacityMutex;
659
  size_t        capacity;
660
  bool          strictCapacity;
661
  uint64_t      lastId;  // atomic var for last id
662
};
663

664
struct SLRUCache {
665
  SShardedCache   shardedCache;
666
  SLRUCacheShard *shards;
667
  int             numShards;
668
};
669

670
static int getDefaultCacheShardBits(size_t capacity) {
20,290,144✔
671
  int    numShardBits = 0;
20,290,144✔
672
  size_t minShardSize = 512 * 1024;
20,290,144✔
673
  size_t numShards = capacity / minShardSize;
20,290,144✔
674
  while (numShards >>= 1) {
85,459,980✔
675
    if (++numShardBits >= 6) {
65,303,460✔
676
      return numShardBits;
133,624✔
677
    }
678
  }
679

680
  return numShardBits;
20,156,520✔
681
}
682

683
SLRUCache *taosLRUCacheInit(size_t capacity, int numShardBits, double highPriPoolRatio) {
28,772,190✔
684
  if (numShardBits >= 20) {
28,772,190✔
685
    return NULL;
×
686
  }
687
  if (highPriPoolRatio < 0.0 || highPriPoolRatio > 1.0) {
28,772,190✔
688
    return NULL;
×
689
  }
690
  SLRUCache *cache = taosMemoryCalloc(1, sizeof(SLRUCache));
28,775,900✔
691
  if (!cache) {
28,775,683✔
692
    return NULL;
×
693
  }
694

695
  if (numShardBits < 0) {
28,775,683✔
696
    numShardBits = getDefaultCacheShardBits(capacity);
20,289,446✔
697
  }
698

699
  int numShards = 1 << numShardBits;
28,779,460✔
700
  cache->shards = taosMemoryCalloc(numShards, sizeof(SLRUCacheShard));
28,779,460✔
701
  if (!cache->shards) {
28,777,262✔
702
    taosMemoryFree(cache);
×
703
    return NULL;
×
704
  }
705

706
  bool   strictCapacity = 1;
28,778,797✔
707
  size_t perShard = (capacity + (numShards - 1)) / numShards;
28,778,797✔
708
  for (int i = 0; i < numShards; ++i) {
243,811,191✔
709
    if (TSDB_CODE_SUCCESS !=
215,032,394✔
710
        taosLRUCacheShardInit(&cache->shards[i], perShard, strictCapacity, highPriPoolRatio, 32 - numShardBits)) {
215,030,328✔
711
      taosMemoryFree(cache->shards);
×
712
      taosMemoryFree(cache);
×
713
      return NULL;
×
714
    }
715
  }
716

717
  cache->numShards = numShards;
28,780,863✔
718

719
  cache->shardedCache.shardMask = (1 << numShardBits) - 1;
28,781,918✔
720
  cache->shardedCache.strictCapacity = strictCapacity;
28,782,387✔
721
  cache->shardedCache.capacity = capacity;
28,782,387✔
722
  cache->shardedCache.lastId = 1;
28,782,387✔
723

724
  (void)taosThreadMutexInit(&cache->shardedCache.capacityMutex, NULL);
28,782,387✔
725

726
  return cache;
28,782,566✔
727
}
728

729
void taosLRUCacheCleanup(SLRUCache *cache) {
218,451,366✔
730
  if (cache) {
218,451,366✔
731
    if (cache->shards) {
28,769,382✔
732
      int numShards = cache->numShards;
28,769,212✔
733
      for (int i = 0; i < numShards; ++i) {
243,788,481✔
734
        taosLRUCacheShardCleanup(&cache->shards[i]);
215,018,714✔
735
      }
736
      taosMemoryFree(cache->shards);
28,769,767✔
737
      cache->shards = 0;
28,769,767✔
738
    }
739

740
    (void)taosThreadMutexDestroy(&cache->shardedCache.capacityMutex);
28,769,681✔
741

742
    taosMemoryFree(cache);
28,769,767✔
743
  }
744
}
218,451,751✔
745

746
LRUStatus taosLRUCacheInsert(SLRUCache *cache, const void *key, size_t keyLen, void *value, size_t charge,
97,225,943✔
747
                             _taos_lru_deleter_t deleter, _taos_lru_overwriter_t overwriter, LRUHandle **handle,
748
                             LRUPriority priority, void *ud) {
749
  uint32_t hash = TAOS_LRU_CACHE_SHARD_HASH32(key, keyLen);
97,225,943✔
750
  uint32_t shardIndex = hash & cache->shardedCache.shardMask;
97,228,616✔
751

752
  return taosLRUCacheShardInsert(&cache->shards[shardIndex], key, keyLen, hash, value, charge, deleter, overwriter,
97,228,616✔
753
                                 handle, priority, ud);
754
}
755

756
LRUHandle *taosLRUCacheLookup(SLRUCache *cache, const void *key, size_t keyLen) {
78,973,187✔
757
  uint32_t hash = TAOS_LRU_CACHE_SHARD_HASH32(key, keyLen);
78,973,187✔
758
  uint32_t shardIndex = hash & cache->shardedCache.shardMask;
78,988,458✔
759

760
  return taosLRUCacheShardLookup(&cache->shards[shardIndex], key, keyLen, hash);
78,988,458✔
761
}
762

763
void taosLRUCacheErase(SLRUCache *cache, const void *key, size_t keyLen) {
139,308✔
764
  uint32_t hash = TAOS_LRU_CACHE_SHARD_HASH32(key, keyLen);
139,308✔
765
  uint32_t shardIndex = hash & cache->shardedCache.shardMask;
139,308✔
766

767
  return taosLRUCacheShardErase(&cache->shards[shardIndex], key, keyLen, hash);
139,308✔
768
}
769

770
void taosLRUCacheApply(SLRUCache *cache, _taos_lru_functor_t functor, void *ud) {
1,011,679✔
771
  int numShards = cache->numShards;
1,011,679✔
772
  for (int i = 0; i < numShards; ++i) {
2,022,848✔
773
    if (taosLRUCacheShardApply(&cache->shards[i], functor, ud)) {
1,010,517✔
774
      break;
×
775
    }
776
  }
777
}
1,012,331✔
778

779
void taosLRUCacheEraseUnrefEntries(SLRUCache *cache) {
12,507,647✔
780
  int numShards = cache->numShards;
12,507,647✔
781
  for (int i = 0; i < numShards; ++i) {
89,955,887✔
782
    taosLRUCacheShardEraseUnrefEntries(&cache->shards[i]);
77,447,748✔
783
  }
784
}
12,508,139✔
785

786
bool taosLRUCacheRef(SLRUCache *cache, LRUHandle *handle) {
×
787
  if (handle == NULL) {
×
788
    return false;
×
789
  }
790

791
  uint32_t hash = ((SLRUEntry *)handle)->hash;
×
792
  uint32_t shardIndex = hash & cache->shardedCache.shardMask;
×
793

794
  return taosLRUCacheShardRef(&cache->shards[shardIndex], handle);
×
795
}
796

797
bool taosLRUCacheRelease(SLRUCache *cache, LRUHandle *handle, bool eraseIfLastRef) {
49,471,498✔
798
  if (handle == NULL) {
49,471,498✔
799
    return false;
×
800
  }
801

802
  uint32_t hash = ((SLRUEntry *)handle)->hash;
49,471,498✔
803
  uint32_t shardIndex = hash & cache->shardedCache.shardMask;
49,471,498✔
804

805
  return taosLRUCacheShardRelease(&cache->shards[shardIndex], handle, eraseIfLastRef);
49,471,498✔
806
}
807

808
void *taosLRUCacheValue(SLRUCache *cache, LRUHandle *handle) { return ((SLRUEntry *)handle)->value; }
49,334,082✔
809

810
void taosLRUCacheUpdate(SLRUCache *cache, LRUHandle *handle, void *value) { ((SLRUEntry *)handle)->value = value; }
×
811

812
size_t taosLRUCacheGetUsage(SLRUCache *cache) {
124,896,036✔
813
  size_t usage = 0;
124,896,036✔
814

815
  for (int i = 0; i < cache->numShards; ++i) {
249,849,234✔
816
    usage += taosLRUCacheShardGetUsage(&cache->shards[i]);
124,953,198✔
817
  }
818

819
  return usage;
124,896,036✔
820
}
821

822
int32_t taosLRUCacheGetElems(SLRUCache *cache) {
125,021,797✔
823
  int32_t elems = 0;
125,021,797✔
824

825
  for (int i = 0; i < cache->numShards; ++i) {
258,480,995✔
826
    elems += taosLRUCacheShardGetElems(&cache->shards[i]);
133,459,198✔
827
  }
828

829
  return elems;
125,021,797✔
830
}
831

832
size_t taosLRUCacheGetPinnedUsage(SLRUCache *cache) {
×
833
  size_t usage = 0;
×
834

835
  for (int i = 0; i < cache->numShards; ++i) {
×
836
    usage += taosLRUCacheShardGetPinnedUsage(&cache->shards[i]);
×
837
  }
838

839
  return usage;
×
840
}
841

842
void taosLRUCacheSetCapacity(SLRUCache *cache, size_t capacity) {
6,642✔
843
  uint32_t numShards = cache->numShards;
6,642✔
844
  size_t   perShard = (capacity + (numShards - 1)) / numShards;
6,642✔
845

846
  (void)taosThreadMutexLock(&cache->shardedCache.capacityMutex);
6,642✔
847

848
  for (int i = 0; i < numShards; ++i) {
13,284✔
849
    taosLRUCacheShardSetCapacity(&cache->shards[i], perShard);
6,642✔
850
  }
851

852
  cache->shardedCache.capacity = capacity;
6,642✔
853

854
  (void)taosThreadMutexUnlock(&cache->shardedCache.capacityMutex);
6,642✔
855
}
6,642✔
856

857
size_t taosLRUCacheGetCapacity(SLRUCache *cache) {
×
858
  size_t capacity = 0;
×
859

860
  (void)taosThreadMutexLock(&cache->shardedCache.capacityMutex);
×
861

862
  capacity = cache->shardedCache.capacity;
×
863

864
  (void)taosThreadMutexUnlock(&cache->shardedCache.capacityMutex);
×
865

866
  return capacity;
×
867
}
868

869
void taosLRUCacheSetStrictCapacity(SLRUCache *cache, bool strict) {
12,519,659✔
870
  uint32_t numShards = cache->numShards;
12,519,659✔
871

872
  (void)taosThreadMutexLock(&cache->shardedCache.capacityMutex);
12,520,575✔
873

874
  for (int i = 0; i < numShards; ++i) {
89,990,380✔
875
    taosLRUCacheShardSetStrictCapacity(&cache->shards[i], strict);
77,469,166✔
876
  }
877

878
  cache->shardedCache.strictCapacity = strict;
12,521,214✔
879

880
  (void)taosThreadMutexUnlock(&cache->shardedCache.capacityMutex);
12,521,214✔
881
}
12,520,522✔
882

883
bool taosLRUCacheIsStrictCapacity(SLRUCache *cache) {
×
884
  bool strict = false;
×
885

886
  (void)taosThreadMutexLock(&cache->shardedCache.capacityMutex);
×
887

888
  strict = cache->shardedCache.strictCapacity;
×
889

890
  (void)taosThreadMutexUnlock(&cache->shardedCache.capacityMutex);
×
891

892
  return strict;
×
893
}
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