Skip to content

Commit 495ba7a

Browse files
KFilipekKFilipek
committed
[CTL] Add support for defaults
1 parent 8401c15 commit 495ba7a

File tree

16 files changed

+450
-130
lines changed

16 files changed

+450
-130
lines changed

‎benchmark/benchmark_umf.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ struct provider_interface {
4444
if (state.thread_index() != 0) {
4545
return;
4646
}
47-
umfCtlExec("umf.provider.by_handle.stats.reset", provider, NULL);
47+
umfCtlExec("umf.provider.by_handle.stats.reset", provider, NULL, 0);
4848
}
4949

5050
void postBench([[maybe_unused]] ::benchmark::State &state) {
@@ -53,7 +53,7 @@ struct provider_interface {
5353
}
5454
size_t arg;
5555
umf_result_t ret = umfCtlGet(
56-
"umf.provider.by_handle.stats.allocated_memory", provider, &arg);
56+
"umf.provider.by_handle.stats.allocated_memory", provider, &arg, 0);
5757
if (ret == UMF_RESULT_SUCCESS) {
5858
state.counters["provider_memory_allocated"] =
5959
static_cast<double>(arg);

‎include/umf/base.h‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -66,27 +66,30 @@ typedef enum umf_ctl_query_type {
6666
/// @param name name of an attribute to be retrieved
6767
/// @param ctx pointer to the pool or the provider
6868
/// @param arg [out] pointer to the variable where the value will be stored
69+
/// @param size size of the value, depends on the context
6970
/// @return UMF_RESULT_SUCCESS on success or UMF_RESULT_ERROR_UNKNOWN on failure.
7071
///
71-
umf_result_t umfCtlGet(const char *name, void *ctx, void *arg);
72+
umf_result_t umfCtlGet(const char *name, void *ctx, void *arg, size_t size);
7273

7374
///
7475
/// @brief Set value of a specified attribute at the given name.
7576
/// @param name name of an attribute to be set
76-
/// @param ctx pointer to the pool or the provider
77+
/// @param ctx pointer to the pool or the provider, NULL for the 'default' path
7778
/// @param arg [in] pointer to the value that will be set
79+
/// @param size [in] size of the value, depends on the context
7880
/// @return UMF_RESULT_SUCCESS on success or UMF_RESULT_ERROR_UNKNOWN on failure.
7981
///
80-
umf_result_t umfCtlSet(const char *name, void *ctx, void *arg);
82+
umf_result_t umfCtlSet(const char *name, void *ctx, void *arg, size_t size);
8183

8284
///
8385
/// @brief Execute callback related with the specified attribute.
8486
/// @param name name of an attribute to be executed
8587
/// @param ctx pointer to the pool or the provider
8688
/// @param arg [in/out] pointer to the value, can be used as an input or output
89+
/// @param size [in] size of the value, depends on the context
8790
/// @return UMF_RESULT_SUCCESS on success or UMF_RESULT_ERROR_UNKNOWN on failure.
8891
///
89-
umf_result_t umfCtlExec(const char *name, void *ctx, void *arg);
92+
umf_result_t umfCtlExec(const char *name, void *ctx, void *arg, size_t size);
9093

9194
#ifdef __cplusplus
9295
}

‎include/umf/memory_pool_ops.h‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,16 +131,17 @@ typedef struct umf_memory_pool_ops_t {
131131
/// The function is used to perform various control operations
132132
/// on the memory pool.
133133
///
134-
/// @param hPool handle to the memory pool.
134+
/// @param pool handle to the memory pool.
135135
/// @param operationType type of the operation to be performed.
136136
/// @param name name associated with the operation.
137137
/// @param arg argument for the operation.
138+
/// @param size size of the argument [optional - check path requirements]
138139
/// @param queryType type of the query to be performed.
139140
///
140141
/// @return umf_result_t result of the control operation.
141142
///
142-
umf_result_t (*ctl)(void *hPool, int operationType, const char *name,
143-
void *arg, umf_ctl_query_type_t queryType);
143+
umf_result_t (*ctl)(void *pool, int operationType, const char *name,
144+
void *arg, size_t size, umf_ctl_query_type_t queryType);
144145

145146
///
146147
/// @brief Get the name of the memory pool.

‎src/ctl/ctl.c‎

Lines changed: 17 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,6 @@
3636
#include <stdio.h>
3737
#endif
3838

39-
#define CTL_MAX_ENTRIES 100
40-
4139
#define MAX_CONFIG_FILE_LEN (1 << 20) /* 1 megabyte */
4240

4341
#define CTL_STRING_QUERY_SEPARATOR ";"
@@ -49,21 +47,6 @@
4947
static int ctl_global_first_free = 0;
5048
static umf_ctl_node_t CTL_NODE(global)[CTL_MAX_ENTRIES];
5149

52-
/*
53-
* This is the top level node of the ctl tree structure. Each node can contain
54-
* children and leaf nodes.
55-
*
56-
* Internal nodes simply create a new path in the tree whereas child nodes are
57-
* the ones providing the read/write functionality by the means of callbacks.
58-
*
59-
* Each tree node must be NULL-terminated, CTL_NODE_END macro is provided for
60-
* convenience.
61-
*/
62-
struct ctl {
63-
umf_ctl_node_t root[CTL_MAX_ENTRIES];
64-
int first_free;
65-
};
66-
6750
void *Zalloc(size_t sz) {
6851
void *ptr = umf_ba_global_alloc(sz);
6952
if (ptr) {
@@ -81,36 +64,6 @@ char *Strdup(const char *s) {
8164
return p;
8265
}
8366

84-
umf_result_t umfCtlGet(const char *name, void *ctx, void *arg) {
85-
if (name == NULL || arg == NULL || ctx == NULL) {
86-
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
87-
}
88-
return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name, CTL_QUERY_READ,
89-
arg)
90-
? UMF_RESULT_ERROR_UNKNOWN
91-
: UMF_RESULT_SUCCESS;
92-
}
93-
94-
umf_result_t umfCtlSet(const char *name, void *ctx, void *arg) {
95-
if (name == NULL || arg == NULL || ctx == NULL) {
96-
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
97-
}
98-
return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name, CTL_QUERY_WRITE,
99-
arg)
100-
? UMF_RESULT_ERROR_UNKNOWN
101-
: UMF_RESULT_SUCCESS;
102-
}
103-
104-
umf_result_t umfCtlExec(const char *name, void *ctx, void *arg) {
105-
if (name == NULL || arg == NULL || ctx == NULL) {
106-
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
107-
}
108-
return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name,
109-
CTL_QUERY_RUNNABLE, arg)
110-
? UMF_RESULT_ERROR_UNKNOWN
111-
: UMF_RESULT_SUCCESS;
112-
}
113-
11467
/*
11568
* ctl_find_node -- (internal) searches for a matching entry point in the
11669
* provided nodes
@@ -287,10 +240,10 @@ static void ctl_query_cleanup_real_args(const umf_ctl_node_t *n, void *real_arg,
287240
*/
288241
static int ctl_exec_query_read(void *ctx, const umf_ctl_node_t *n,
289242
umf_ctl_query_source_t source, void *arg,
290-
umf_ctl_index_utlist_t *indexes,
243+
size_t size, umf_ctl_index_utlist_t *indexes,
291244
const char *extra_name,
292245
umf_ctl_query_type_t query_type) {
293-
(void)extra_name, (void)query_type;
246+
(void)query_type;
294247
assert(n != NULL);
295248
assert(n->cb[CTL_QUERY_READ] != NULL);
296249
assert(MAX_CTL_QUERY_TYPE != query_type);
@@ -300,7 +253,7 @@ static int ctl_exec_query_read(void *ctx, const umf_ctl_node_t *n,
300253
return -1;
301254
}
302255

303-
return n->cb[CTL_QUERY_READ](ctx, source, arg, indexes, NULL,
256+
return n->cb[CTL_QUERY_READ](ctx, source, arg, size, indexes, extra_name,
304257
MAX_CTL_QUERY_TYPE);
305258
}
306259

@@ -309,10 +262,10 @@ static int ctl_exec_query_read(void *ctx, const umf_ctl_node_t *n,
309262
*/
310263
static int ctl_exec_query_write(void *ctx, const umf_ctl_node_t *n,
311264
umf_ctl_query_source_t source, void *arg,
312-
umf_ctl_index_utlist_t *indexes,
265+
size_t size, umf_ctl_index_utlist_t *indexes,
313266
const char *extra_name,
314267
umf_ctl_query_type_t query_type) {
315-
(void)extra_name, (void)query_type;
268+
(void)query_type;
316269
assert(n != NULL);
317270
assert(n->cb[CTL_QUERY_WRITE] != NULL);
318271
assert(MAX_CTL_QUERY_TYPE != query_type);
@@ -327,8 +280,8 @@ static int ctl_exec_query_write(void *ctx, const umf_ctl_node_t *n,
327280
return -1;
328281
}
329282

330-
int ret = n->cb[CTL_QUERY_WRITE](ctx, source, real_arg, indexes, NULL,
331-
MAX_CTL_QUERY_TYPE);
283+
int ret = n->cb[CTL_QUERY_WRITE](ctx, source, real_arg, size, indexes,
284+
extra_name, MAX_CTL_QUERY_TYPE);
332285
ctl_query_cleanup_real_args(n, real_arg, source);
333286

334287
return ret;
@@ -339,31 +292,32 @@ static int ctl_exec_query_write(void *ctx, const umf_ctl_node_t *n,
339292
*/
340293
static int ctl_exec_query_runnable(void *ctx, const umf_ctl_node_t *n,
341294
umf_ctl_query_source_t source, void *arg,
342-
umf_ctl_index_utlist_t *indexes,
295+
size_t size, umf_ctl_index_utlist_t *indexes,
343296
const char *extra_name,
344297
umf_ctl_query_type_t query_type) {
345298
(void)extra_name, (void)query_type;
346299
assert(n != NULL);
347300
assert(n->cb[CTL_QUERY_RUNNABLE] != NULL);
348301
assert(MAX_CTL_QUERY_TYPE != query_type);
349-
return n->cb[CTL_QUERY_RUNNABLE](ctx, source, arg, indexes, NULL,
350-
MAX_CTL_QUERY_TYPE);
302+
return n->cb[CTL_QUERY_RUNNABLE](ctx, source, arg, size, indexes,
303+
extra_name, MAX_CTL_QUERY_TYPE);
351304
}
352305

353306
static int ctl_exec_query_subtree(void *ctx, const umf_ctl_node_t *n,
354307
umf_ctl_query_source_t source, void *arg,
355-
umf_ctl_index_utlist_t *indexes,
308+
size_t size, umf_ctl_index_utlist_t *indexes,
356309
const char *extra_name,
357310
umf_ctl_query_type_t query_type) {
358311
assert(n != NULL);
359312
assert(n->cb[CTL_QUERY_SUBTREE] != NULL);
360313
assert(MAX_CTL_QUERY_TYPE != query_type);
361-
return n->cb[CTL_QUERY_SUBTREE](ctx, source, arg, indexes, extra_name,
314+
return n->cb[CTL_QUERY_SUBTREE](ctx, source, arg, size, indexes, extra_name,
362315
query_type);
363316
}
364317

365318
typedef int (*umf_ctl_exec_query_t)(void *ctx, const umf_ctl_node_t *n,
366319
umf_ctl_query_source_t source, void *arg,
320+
size_t size,
367321
umf_ctl_index_utlist_t *indexes,
368322
const char *extra_name,
369323
umf_ctl_query_type_t query_type);
@@ -380,7 +334,8 @@ static umf_ctl_exec_query_t ctl_exec_query[MAX_CTL_QUERY_TYPE] = {
380334
* from the ctl tree
381335
*/
382336
int ctl_query(struct ctl *ctl, void *ctx, umf_ctl_query_source_t source,
383-
const char *name, umf_ctl_query_type_t type, void *arg) {
337+
const char *name, umf_ctl_query_type_t type, void *arg,
338+
size_t size) {
384339
if (name == NULL) {
385340
errno = EINVAL;
386341
return -1;
@@ -417,10 +372,9 @@ int ctl_query(struct ctl *ctl, void *ctx, umf_ctl_query_source_t source,
417372
goto out;
418373
}
419374

420-
const char *extra_name = &name[0] + name_offset;
421375
ret =
422376
ctl_exec_query[n->type == CTL_NODE_SUBTREE ? CTL_QUERY_SUBTREE : type](
423-
ctx, n, source, arg, indexes, extra_name, type);
377+
ctx, n, source, arg, size, indexes, name + name_offset, type);
424378
out:
425379
ctl_delete_indexes(indexes);
426380

@@ -487,7 +441,7 @@ static int ctl_load_config(struct ctl *ctl, void *ctx, char *buf) {
487441
}
488442

489443
r = ctl_query(ctl, ctx, CTL_QUERY_CONFIG_INPUT, name, CTL_QUERY_WRITE,
490-
value);
444+
value, 0);
491445

492446
if (r < 0 && ctx != NULL) {
493447
return -1;

‎src/ctl/ctl.h‎

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
extern "C" {
2828
#endif
2929

30-
struct ctl;
30+
#define CTL_MAX_ENTRIES 100
3131

3232
typedef struct ctl_index_utlist {
3333
const char *name;
@@ -46,7 +46,7 @@ typedef enum ctl_query_source {
4646
} umf_ctl_query_source_t;
4747

4848
typedef int (*node_callback)(void *ctx, umf_ctl_query_source_t type, void *arg,
49-
umf_ctl_index_utlist_t *indexes,
49+
size_t size, umf_ctl_index_utlist_t *indexes,
5050
const char *extra_name,
5151
umf_ctl_query_type_t query_type);
5252

@@ -98,8 +98,23 @@ typedef struct ctl_node {
9898
const struct ctl_node *children;
9999
} umf_ctl_node_t;
100100

101+
/*
102+
* This is the top level node of the ctl tree structure. Each node can contain
103+
* children and leaf nodes.
104+
*
105+
* Internal nodes simply create a new path in the tree whereas child nodes are
106+
* the ones providing the read/write functionality by the means of callbacks.
107+
*
108+
* Each tree node must be NULL-terminated, CTL_NODE_END macro is provided for
109+
* convenience.
110+
*/
111+
struct ctl {
112+
umf_ctl_node_t root[CTL_MAX_ENTRIES];
113+
int first_free;
114+
};
115+
101116
struct ctl *ctl_new(void);
102-
void ctl_delete(struct ctl *stats);
117+
void ctl_delete(struct ctl *c);
103118

104119
void initialize_global_ctl(void);
105120

@@ -138,7 +153,8 @@ int ctl_arg_string(const void *arg, void *dest, size_t dest_size);
138153
#define CTL_NODE(name, ...) ctl_node_##__VA_ARGS__##_##name
139154

140155
int ctl_query(struct ctl *ctl, void *ctx, umf_ctl_query_source_t source,
141-
const char *name, umf_ctl_query_type_t type, void *arg);
156+
const char *name, umf_ctl_query_type_t type, void *arg,
157+
size_t size);
142158

143159
/* Declaration of a new child node */
144160
#define CTL_CHILD(name, ...) \

‎src/libumf.c‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,42 @@ void umfTearDown(void) {
9797
}
9898

9999
int umfGetCurrentVersion(void) { return UMF_VERSION_CURRENT; }
100+
101+
umf_result_t umfCtlGet(const char *name, void *ctx, void *arg, size_t size) {
102+
if (name == NULL || arg == NULL) {
103+
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
104+
}
105+
// using ctx is disallowed for default settings
106+
if (ctx && strstr(name, ".default.")) {
107+
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
108+
}
109+
return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name, CTL_QUERY_READ,
110+
arg, size)
111+
? UMF_RESULT_ERROR_UNKNOWN
112+
: UMF_RESULT_SUCCESS;
113+
}
114+
115+
umf_result_t umfCtlSet(const char *name, void *ctx, void *arg, size_t size) {
116+
// Context can be NULL when setting defaults
117+
if (name == NULL || arg == NULL || size == 0) {
118+
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
119+
}
120+
// using ctx is disallowed for default settings
121+
if (ctx && strstr(name, ".default.")) {
122+
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
123+
}
124+
return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name, CTL_QUERY_WRITE,
125+
arg, size)
126+
? UMF_RESULT_ERROR_UNKNOWN
127+
: UMF_RESULT_SUCCESS;
128+
}
129+
130+
umf_result_t umfCtlExec(const char *name, void *ctx, void *arg, size_t size) {
131+
if (name == NULL || arg == NULL || ctx == NULL) {
132+
return UMF_RESULT_ERROR_INVALID_ARGUMENT;
133+
}
134+
return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name,
135+
CTL_QUERY_RUNNABLE, arg, size)
136+
? UMF_RESULT_ERROR_UNKNOWN
137+
: UMF_RESULT_SUCCESS;
138+
}

0 commit comments

Comments
 (0)