-
Notifications
You must be signed in to change notification settings - Fork 46
Expand file tree
/
Copy pathmemory_pool.c
More file actions
707 lines (593 loc) · 23.4 KB
/
Copy pathmemory_pool.c
File metadata and controls
707 lines (593 loc) · 23.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
/*
*
* Copyright (C) 2023-2025 Intel Corporation
*
* Under the Apache License v2.0 with LLVM Exceptions. See LICENSE.TXT.
* SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
*
*/
#include <assert.h>
#include <stdarg.h>
#include <stdint.h>
#include <string.h>
#include <umf/base.h>
#include <umf/memory_pool.h>
#include <umf/memory_pool_ops.h>
#include "base_alloc_global.h"
#include "ctl/ctl_defaults.h"
#include "ctl/ctl_internal.h"
#include "libumf.h"
#include "memory_pool_internal.h"
#include "memory_provider_internal.h"
#include "provider_tracking.h"
#include "utils_assert.h"
#include "utils_concurrency.h"
#include "utils_log.h"
#include "utils_name.h"
#include "utlist.h"
// Handle UTHash memory allocation failures without aborting the process.
#define HASH_NONFATAL_OOM 1
static bool uthash_oom = false;
#define uthash_nonfatal_oom(obj) \
do { \
(void)(obj); \
uthash_oom = true; \
} while (0)
#include "uthash.h"
static ctl_default_entry_t *pool_default_list = NULL;
static utils_mutex_t pool_default_mtx;
static UTIL_ONCE_FLAG mem_pool_ctl_initialized = UTIL_ONCE_FLAG_INIT;
static struct ctl umf_pool_ctl_root;
static void pool_ctl_init(void);
typedef struct pool_name_list_entry_t {
umf_memory_pool_handle_t pool;
struct pool_name_list_entry_t *next;
} pool_name_list_entry_t;
typedef struct pool_name_dict_entry_t {
char *name; /* key */
pool_name_list_entry_t *pools;
UT_hash_handle hh;
} pool_name_dict_entry_t;
static pool_name_dict_entry_t *pools_by_name = NULL;
static utils_rwlock_t pools_by_name_lock;
static UTIL_ONCE_FLAG pools_by_name_init_once = UTIL_ONCE_FLAG_INIT;
static void pools_by_name_init(void) { utils_rwlock_init(&pools_by_name_lock); }
static umf_result_t pools_by_name_add(umf_memory_pool_handle_t pool) {
const char *name = NULL;
umf_result_t ret = pool->ops.get_name(pool->pool_priv, &name);
if (ret != UMF_RESULT_SUCCESS || !name) {
return ret;
}
if (!utils_name_is_valid(name)) {
LOG_ERR("Pool name: %s contains invalid character, ctl by_name is not "
"supported for this pool",
name);
return UMF_RESULT_SUCCESS;
}
utils_init_once(&pools_by_name_init_once, pools_by_name_init);
utils_write_lock(&pools_by_name_lock);
pool_name_dict_entry_t *entry = NULL;
HASH_FIND_STR(pools_by_name, name, entry);
if (!entry) {
entry = umf_ba_global_alloc(sizeof(*entry));
if (!entry) {
utils_write_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
}
entry->name = umf_ba_global_strdup(name);
if (!entry->name) {
umf_ba_global_free(entry);
utils_write_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
}
entry->pools = NULL;
uthash_oom = false;
HASH_ADD_KEYPTR(hh, pools_by_name, entry->name, strlen(entry->name),
entry);
if (uthash_oom) {
umf_ba_global_free(entry->name);
umf_ba_global_free(entry);
utils_write_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
}
}
pool_name_list_entry_t *node = umf_ba_global_alloc(sizeof(*node));
if (!node) {
utils_write_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
}
node->pool = pool;
node->next = NULL;
LL_APPEND(entry->pools, node);
utils_write_unlock(&pools_by_name_lock);
return UMF_RESULT_SUCCESS;
}
static void pools_by_name_remove(umf_memory_pool_handle_t pool) {
const char *name = NULL;
if (pool->ops.get_name(pool->pool_priv, &name) != UMF_RESULT_SUCCESS ||
!name) {
return;
}
utils_init_once(&pools_by_name_init_once, pools_by_name_init);
utils_write_lock(&pools_by_name_lock);
pool_name_dict_entry_t *entry = NULL;
HASH_FIND_STR(pools_by_name, name, entry);
if (entry) {
pool_name_list_entry_t *it = NULL, *tmp = NULL;
LL_FOREACH_SAFE(entry->pools, it, tmp) {
if (it->pool == pool) {
LL_DELETE(entry->pools, it);
umf_ba_global_free(it);
break;
}
}
if (entry->pools == NULL) {
HASH_DEL(pools_by_name, entry);
umf_ba_global_free(entry->name);
umf_ba_global_free(entry);
}
}
utils_write_unlock(&pools_by_name_lock);
}
static umf_result_t CTL_SUBTREE_HANDLER(CTL_NONAME, by_handle)(
void *ctx, umf_ctl_query_source_t source, void *arg, size_t size,
umf_ctl_index_utlist_t *indexes, const char *extra_name,
umf_ctl_query_type_t queryType, va_list args) {
(void)source, (void)ctx;
umf_memory_pool_handle_t hPool = *(umf_memory_pool_handle_t *)indexes->arg;
va_list args2;
va_copy(args2, args);
umf_result_t ret = ctl_query(&umf_pool_ctl_root, hPool, source, extra_name,
queryType, arg, size, args2);
va_end(args2);
if (ret == UMF_RESULT_ERROR_INVALID_CTL_PATH) {
// Node was not found in pool_ctl_root, try to query the specific pool
ret = hPool->ops.ext_ctl(hPool->pool_priv, source, extra_name, arg,
size, queryType, args);
}
return ret;
}
static umf_result_t CTL_SUBTREE_HANDLER(default)(
void *ctx, umf_ctl_query_source_t source, void *arg, size_t size,
umf_ctl_index_utlist_t *indexes, const char *extra_name,
umf_ctl_query_type_t queryType, va_list args) {
(void)indexes;
(void)ctx;
(void)args;
utils_init_once(&mem_pool_ctl_initialized, pool_ctl_init);
return ctl_default_subtree(&pool_default_list, &pool_default_mtx, source,
arg, size, extra_name, queryType);
}
static umf_result_t
CTL_READ_HANDLER(alloc_count)(void *ctx, umf_ctl_query_source_t source,
void *arg, size_t size,
umf_ctl_index_utlist_t *indexes) {
/* suppress unused-parameter errors */
(void)source, (void)size, (void)indexes;
size_t *arg_out = arg;
if (ctx == NULL || arg_out == NULL) {
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
assert(size == sizeof(size_t));
umf_memory_pool_handle_t pool = (umf_memory_pool_handle_t)ctx;
utils_atomic_load_acquire_size_t(&pool->stats.alloc_count, arg_out);
return UMF_RESULT_SUCCESS;
}
static const umf_ctl_node_t CTL_NODE(stats)[] = {CTL_LEAF_RO(alloc_count),
CTL_NODE_END};
static umf_ctl_node_t CTL_NODE(by_handle)[] = {
CTL_LEAF_SUBTREE(CTL_NONAME, by_handle),
CTL_NODE_END,
};
static const struct ctl_argument CTL_ARG(by_handle) = CTL_ARG_PTR;
typedef struct by_name_arg_t {
char name[255];
size_t index;
} by_name_arg_t;
// parses optional size_t argument. if arg is not integer then sets out to size_max
static int by_name_index_parser(const void *arg, void *dest, size_t dest_size) {
size_t *out = (size_t *)dest;
if (arg == NULL) {
*out = SIZE_MAX;
return 1; // node n
}
int ret = ctl_arg_unsigned(arg, dest, dest_size);
if (ret) {
*out = SIZE_MAX;
return 1;
}
return 0;
}
static const struct ctl_argument CTL_ARG(by_name) = {
sizeof(by_name_arg_t),
{CTL_ARG_PARSER_STRUCT(by_name_arg_t, name, CTL_ARG_TYPE_STRING,
ctl_arg_string),
CTL_ARG_PARSER_STRUCT(by_name_arg_t, index,
CTL_ARG_TYPE_UNSIGNED_LONG_LONG,
by_name_index_parser),
CTL_ARG_PARSER_END}};
static umf_result_t CTL_SUBTREE_HANDLER(CTL_NONAME, by_name)(
void *ctx, umf_ctl_query_source_t source, void *arg, size_t size,
umf_ctl_index_utlist_t *indexes, const char *extra_name,
umf_ctl_query_type_t queryType, va_list args) {
(void)ctx;
utils_init_once(&pools_by_name_init_once, pools_by_name_init);
by_name_arg_t *name_arg = (by_name_arg_t *)indexes->arg;
utils_read_lock(&pools_by_name_lock);
pool_name_dict_entry_t *entry = NULL;
// find pool name in the hashmap
HASH_FIND_STR(pools_by_name, name_arg->name, entry);
if (!entry) {
utils_read_unlock(&pools_by_name_lock);
LOG_ERR("Pool %s not found", name_arg->name);
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
size_t count = 0;
pool_name_list_entry_t *it = NULL;
LL_COUNT(entry->pools, it, count);
// Special case: if user asked for umf.pool.by_name.name.count, we just return
// number of pools sharing the same name.
if (strcmp(extra_name, "count") == 0) {
if (name_arg->index != SIZE_MAX) {
LOG_ERR("count field requires no index argument");
utils_read_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
if (queryType != CTL_QUERY_READ) {
LOG_ERR("count field is read only");
utils_read_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
size_t *output = (size_t *)arg;
*output = count;
utils_read_unlock(&pools_by_name_lock);
return UMF_RESULT_SUCCESS;
}
if (queryType == CTL_QUERY_READ && count > 1 &&
name_arg->index == SIZE_MAX) {
LOG_ERR("CTL 'by_name' read operation requires exactly one pool with "
"the specified name. "
"Actual number of pools with name '%s' is %zu. "
"You can add extra index parameter after the name to specify "
"exact pool e.g. umf.pool.by_name.pool_name,1.node_name",
name_arg->name, count);
utils_read_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
umf_result_t ret = UMF_RESULT_SUCCESS;
size_t nr = 0;
if (name_arg->index != SIZE_MAX && name_arg->index >= count) {
LOG_ERR(
"Invalid index %zu. Actual number of pools with name '%s' is %zu. ",
name_arg->index, name_arg->name, count);
utils_read_unlock(&pools_by_name_lock);
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
LL_FOREACH(entry->pools, it) {
if (name_arg->index != SIZE_MAX && nr++ != name_arg->index) {
continue;
}
va_list args2;
va_copy(args2, args);
umf_result_t r = ctl_query(&umf_pool_ctl_root, it->pool, source,
extra_name, queryType, arg, size, args2);
va_end(args2);
if (r == UMF_RESULT_ERROR_INVALID_CTL_PATH) {
va_copy(args2, args);
r = it->pool->ops.ext_ctl(it->pool->pool_priv, source, extra_name,
arg, size, queryType, args2);
va_end(args2);
}
if (r != UMF_RESULT_SUCCESS && ret == UMF_RESULT_SUCCESS) {
ret = r;
}
}
utils_read_unlock(&pools_by_name_lock);
return ret;
}
static umf_ctl_node_t CTL_NODE(by_name)[] = {
CTL_LEAF_SUBTREE(CTL_NONAME, by_name),
CTL_NODE_END,
};
umf_ctl_node_t CTL_NODE(pool)[] = {CTL_CHILD_WITH_ARG(by_handle),
CTL_CHILD_WITH_ARG(by_name),
CTL_LEAF_SUBTREE(default), CTL_NODE_END};
static void pool_ctl_init(void) {
utils_mutex_init(&pool_default_mtx);
CTL_REGISTER_MODULE(&umf_pool_ctl_root, stats);
}
static umf_result_t
umfDefaultCtlPoolHandle(void *hPool, umf_ctl_query_source_t operationType,
const char *name, void *arg, size_t size,
umf_ctl_query_type_t queryType, va_list args) {
(void)hPool;
(void)operationType;
(void)name;
(void)arg;
(void)size;
(void)queryType;
(void)args;
// if given path is not supported implementation should return UMF_RESULT_ERROR_INVALID_CTL_PATH
return UMF_RESULT_ERROR_INVALID_CTL_PATH;
}
static umf_result_t umfDefaultTrimMemory(void *provider,
size_t minBytesToKeep) {
(void)provider;
(void)minBytesToKeep;
return UMF_RESULT_ERROR_NOT_SUPPORTED;
}
static umf_result_t umfPoolPostInitialize(const umf_memory_pool_ops_t *ops,
void *pool_priv, ...) {
va_list args;
va_start(args, pool_priv);
umf_result_t ret =
ops->ext_ctl(pool_priv, CTL_QUERY_PROGRAMMATIC, "post_initialize", NULL,
0, CTL_QUERY_RUNNABLE, args);
va_end(args);
return ret;
}
// logical sum (OR) of all umf_pool_create_flags_t flags
static const umf_pool_create_flags_t UMF_POOL_CREATE_FLAG_ALL =
UMF_POOL_CREATE_FLAG_OWN_PROVIDER | UMF_POOL_CREATE_FLAG_DISABLE_TRACKING;
// windows do not allow to use uninitialized va_list so this function help us to initialize it.
static umf_result_t umfPoolCreateInternal(const umf_memory_pool_ops_t *ops,
umf_memory_provider_handle_t provider,
const void *params,
umf_pool_create_flags_t flags,
umf_memory_pool_handle_t *hPool) {
UMF_CHECK((ops != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((provider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
// validate flags
if (flags & ~UMF_POOL_CREATE_FLAG_ALL) {
LOG_ERR("Invalid flags: 0x%x", flags);
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
umf_result_t ret = UMF_RESULT_SUCCESS;
umf_memory_pool_ops_t compatible_ops;
if (ops->version != UMF_POOL_OPS_VERSION_CURRENT) {
LOG_WARN("Memory Pool ops version \"%d\" is different than the current "
"version \"%d\"",
ops->version, UMF_POOL_OPS_VERSION_CURRENT);
// Create a new ops compatible structure with the current version
memset(&compatible_ops, 0, sizeof(compatible_ops));
if (ops->version < UMF_MAKE_VERSION(1, 1)) {
LOG_INFO("Detected 1.0 version or below of Memory Pool ops, "
"upgrading to current version");
memcpy(&compatible_ops, ops,
offsetof(umf_memory_pool_ops_t, ext_trim_memory));
} else {
LOG_ERR("Unsupported Memory Pool ops version: %d", ops->version);
return UMF_RESULT_ERROR_NOT_SUPPORTED;
}
ops = &compatible_ops;
}
umf_memory_pool_handle_t pool =
umf_ba_global_alloc(sizeof(umf_memory_pool_t));
if (!pool) {
return UMF_RESULT_ERROR_OUT_OF_HOST_MEMORY;
}
if (!(flags & UMF_POOL_CREATE_FLAG_DISABLE_TRACKING)) {
// Wrap provider with memory tracking provider.
ret = umfTrackingMemoryProviderCreate(provider, pool, &pool->provider);
if (ret != UMF_RESULT_SUCCESS) {
goto err_provider_create;
}
} else {
pool->provider = provider;
}
utils_init_once(&mem_pool_ctl_initialized, pool_ctl_init);
pool->flags = flags;
pool->ops = *ops;
pool->tag = NULL;
memset(&pool->stats, 0, sizeof(pool->stats));
if (NULL == pool->ops.ext_ctl) {
pool->ops.ext_ctl = umfDefaultCtlPoolHandle;
}
if (NULL == pool->ops.ext_trim_memory) {
pool->ops.ext_trim_memory = umfDefaultTrimMemory;
}
if (NULL == utils_mutex_init(&pool->lock)) {
LOG_ERR("Failed to initialize mutex for pool");
ret = UMF_RESULT_ERROR_UNKNOWN;
goto err_lock_init;
}
ret = pool->ops.initialize(pool->provider, params, &pool->pool_priv);
if (ret != UMF_RESULT_SUCCESS) {
goto err_pool_init;
}
const char *pname = NULL;
ret = ops->get_name(pool->pool_priv, &pname);
if (ret != UMF_RESULT_SUCCESS) {
LOG_ERR("Failed to get pool name");
goto err_pool_init;
}
assert(pname != NULL);
utils_warn_invalid_name("Memory pool", pname);
ctl_default_apply(pool_default_list, pname, ops->ext_ctl, pool->pool_priv);
ret = umfPoolPostInitialize(&pool->ops, pool->pool_priv);
if (ret != UMF_RESULT_SUCCESS && ret != UMF_RESULT_ERROR_INVALID_CTL_PATH) {
LOG_ERR("Failed to post-initialize pool");
goto err_pool_init;
}
*hPool = pool;
pools_by_name_add(pool);
LOG_INFO("Memory pool created: %p", (void *)pool);
return UMF_RESULT_SUCCESS;
err_pool_init:
utils_mutex_destroy_not_free(&pool->lock);
err_lock_init:
if (!(flags & UMF_POOL_CREATE_FLAG_DISABLE_TRACKING)) {
umfMemoryProviderDestroy(pool->provider);
}
err_provider_create:
umf_ba_global_free(pool);
return ret;
}
umf_result_t umfPoolDestroy(umf_memory_pool_handle_t hPool) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
if (umf_ba_global_is_destroyed()) {
return UMF_RESULT_ERROR_UNKNOWN;
}
pools_by_name_remove(hPool);
umf_result_t ret = hPool->ops.finalize(hPool->pool_priv);
umf_memory_provider_handle_t hUpstreamProvider = NULL;
umfPoolGetMemoryProvider(hPool, &hUpstreamProvider);
if (!(hPool->flags & UMF_POOL_CREATE_FLAG_DISABLE_TRACKING)) {
// Destroy tracking provider.
umf_result_t ret2 = umfMemoryProviderDestroy(hPool->provider);
if (ret == UMF_RESULT_SUCCESS) {
ret = ret2;
}
}
if (hPool->flags & UMF_POOL_CREATE_FLAG_OWN_PROVIDER) {
// Destroy associated memory provider.
umf_result_t ret2 = umfMemoryProviderDestroy(hUpstreamProvider);
if (ret == UMF_RESULT_SUCCESS) {
ret = ret2;
}
}
utils_mutex_destroy_not_free(&hPool->lock);
LOG_INFO("Memory pool destroyed: %p", (void *)hPool);
// TODO: this free keeps memory in base allocator, so it can lead to OOM in some scenarios (it should be optimized)
umf_ba_global_free(hPool);
return ret;
}
umf_result_t umfFree(void *ptr) {
umf_memory_pool_handle_t hPool = NULL;
umf_result_t ret = umfPoolByPtr(ptr, &hPool);
if (ret == UMF_RESULT_SUCCESS) {
LOG_DEBUG("calling umfPoolFree(pool=%p, ptr=%p) ...", (void *)hPool,
ptr);
return umfPoolFree(hPool, ptr);
}
return ret;
}
umf_result_t umfPoolByPtr(const void *ptr, umf_memory_pool_handle_t *pool) {
UMF_CHECK(pool != NULL, UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK(ptr != NULL, UMF_RESULT_ERROR_INVALID_ARGUMENT);
umf_memory_properties_handle_t props = NULL;
umf_result_t ret = umfGetMemoryPropertiesHandle(ptr, &props);
if (ret != UMF_RESULT_SUCCESS || props == NULL || props->pool == NULL) {
*pool = NULL;
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
}
*pool = props->pool;
return UMF_RESULT_SUCCESS;
}
umf_result_t umfPoolGetMemoryProvider(umf_memory_pool_handle_t hPool,
umf_memory_provider_handle_t *hProvider) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((hProvider != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
if (hPool->flags & UMF_POOL_CREATE_FLAG_DISABLE_TRACKING) {
*hProvider = hPool->provider;
} else {
umfTrackingMemoryProviderGetUpstreamProvider(
umfMemoryProviderGetPriv(hPool->provider), hProvider);
}
return UMF_RESULT_SUCCESS;
}
umf_result_t umfPoolGetName(umf_memory_pool_handle_t pool, const char **name) {
UMF_CHECK((pool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((name != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return pool->ops.get_name(pool->pool_priv, name);
}
umf_result_t umfPoolCreate(const umf_memory_pool_ops_t *ops,
umf_memory_provider_handle_t provider,
const void *params, umf_pool_create_flags_t flags,
umf_memory_pool_handle_t *hPool) {
libumfInit();
umf_result_t ret =
umfPoolCreateInternal(ops, provider, params, flags, hPool);
if (ret != UMF_RESULT_SUCCESS) {
return ret;
}
assert(*hPool != NULL);
return UMF_RESULT_SUCCESS;
}
void *umfPoolMalloc(umf_memory_pool_handle_t hPool, size_t size) {
UMF_CHECK((hPool != NULL), NULL);
void *ret = hPool->ops.malloc(hPool->pool_priv, size);
if (!ret) {
return NULL;
}
utils_atomic_increment_size_t(&hPool->stats.alloc_count);
return ret;
}
void *umfPoolAlignedMalloc(umf_memory_pool_handle_t hPool, size_t size,
size_t alignment) {
UMF_CHECK((hPool != NULL), NULL);
void *ret = hPool->ops.aligned_malloc(hPool->pool_priv, size, alignment);
if (!ret) {
return NULL;
}
utils_atomic_increment_size_t(&hPool->stats.alloc_count);
return ret;
}
void *umfPoolCalloc(umf_memory_pool_handle_t hPool, size_t num, size_t size) {
UMF_CHECK((hPool != NULL), NULL);
void *ret = hPool->ops.calloc(hPool->pool_priv, num, size);
if (!ret) {
return NULL;
}
utils_atomic_increment_size_t(&hPool->stats.alloc_count);
return ret;
}
void *umfPoolRealloc(umf_memory_pool_handle_t hPool, void *ptr, size_t size) {
UMF_CHECK((hPool != NULL), NULL);
void *ret = hPool->ops.realloc(hPool->pool_priv, ptr, size);
if (size == 0 && ret == NULL && ptr != NULL) { // this is free(ptr)
utils_atomic_decrement_size_t(&hPool->stats.alloc_count);
} else if (ptr == NULL && ret != NULL) { // this is malloc(size)
utils_atomic_increment_size_t(&hPool->stats.alloc_count);
}
return ret;
}
umf_result_t umfPoolMallocUsableSize(umf_memory_pool_handle_t hPool,
const void *ptr, size_t *size) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hPool->ops.malloc_usable_size(hPool->pool_priv, ptr, size);
}
umf_result_t umfPoolFree(umf_memory_pool_handle_t hPool, void *ptr) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
umf_result_t ret = hPool->ops.free(hPool->pool_priv, ptr);
if (ret != UMF_RESULT_SUCCESS) {
return ret;
}
if (ptr != NULL) {
utils_atomic_decrement_size_t(&hPool->stats.alloc_count);
}
return ret;
}
umf_result_t umfPoolGetLastAllocationError(umf_memory_pool_handle_t hPool) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hPool->ops.get_last_allocation_error(hPool->pool_priv);
}
umf_result_t umfPoolSetTag(umf_memory_pool_handle_t hPool, void *tag,
void **oldTag) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
utils_mutex_lock(&hPool->lock);
if (oldTag) {
*oldTag = hPool->tag;
}
hPool->tag = tag;
utils_mutex_unlock(&hPool->lock);
return UMF_RESULT_SUCCESS;
}
umf_result_t umfPoolGetTag(umf_memory_pool_handle_t hPool, void **tag) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
UMF_CHECK((tag != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
utils_mutex_lock(&hPool->lock);
*tag = hPool->tag;
utils_mutex_unlock(&hPool->lock);
return UMF_RESULT_SUCCESS;
}
umf_result_t umfPoolTrimMemory(umf_memory_pool_handle_t hPool,
size_t minBytesToKeep) {
UMF_CHECK((hPool != NULL), UMF_RESULT_ERROR_INVALID_ARGUMENT);
return hPool->ops.ext_trim_memory(hPool->pool_priv, minBytesToKeep);
}
void umfPoolCtlDefaultsDestroy(void) {
utils_init_once(&mem_pool_ctl_initialized, pool_ctl_init);
ctl_default_destroy(&pool_default_list, &pool_default_mtx);
}