[CTL] Add support for defaults

Author: KFilipek

benchmark/benchmark_umf.hpp

@@ -45,16 +45,17 @@ struct provider_interface {
             return;
         }
         umfCtlExec("umf.provider.by_handle.stats.peak_memory.reset", provider,
-                   NULL);
+                   NULL, 0);
     }
 
     void postBench([[maybe_unused]] ::benchmark::State &state) {
         if (state.thread_index() != 0) {
             return;
         }
         size_t arg;
-        umf_result_t ret = umfCtlGet(
-            "umf.provider.by_handle.stats.allocated_memory", provider, &arg);
+        umf_result_t ret =
+            umfCtlGet("umf.provider.by_handle.stats.allocated_memory", provider,
+                      &arg, sizeof(arg));
         if (ret == UMF_RESULT_SUCCESS) {
             state.counters["provider_memory_allocated"] =
                 static_cast<double>(arg);

include/umf/base.h

@@ -66,27 +66,30 @@ typedef enum umf_ctl_query_type {
 /// @param name name of an attribute to be retrieved
 /// @param ctx pointer to the pool or the provider
 /// @param arg [out] pointer to the variable where the value will be stored
+/// @param size size of the value, depends on the context
 /// @return UMF_RESULT_SUCCESS on success or UMF_RESULT_ERROR_UNKNOWN on failure.
 ///
-umf_result_t umfCtlGet(const char *name, void *ctx, void *arg);
+umf_result_t umfCtlGet(const char *name, void *ctx, void *arg, size_t size);
 
 ///
 /// @brief Set value of a specified attribute at the given name.
 /// @param name name of an attribute to be set
-/// @param ctx pointer to the pool or the provider
+/// @param ctx pointer to the pool or the provider, NULL for the 'default' path
 /// @param arg [in] pointer to the value that will be set
+/// @param size [in] size of the value, depends on the context
 /// @return UMF_RESULT_SUCCESS on success or UMF_RESULT_ERROR_UNKNOWN on failure.
 ///
-umf_result_t umfCtlSet(const char *name, void *ctx, void *arg);
+umf_result_t umfCtlSet(const char *name, void *ctx, void *arg, size_t size);
 
 ///
 /// @brief Execute callback related with the specified attribute.
 /// @param name name of an attribute to be executed
 /// @param ctx pointer to the pool or the provider
 /// @param arg [in/out] pointer to the value, can be used as an input or output
+/// @param size [in] size of the value, depends on the context
 /// @return UMF_RESULT_SUCCESS on success or UMF_RESULT_ERROR_UNKNOWN on failure.
 ///
-umf_result_t umfCtlExec(const char *name, void *ctx, void *arg);
+umf_result_t umfCtlExec(const char *name, void *ctx, void *arg, size_t size);
 
 #ifdef __cplusplus
 }

include/umf/memory_pool_ops.h

@@ -131,21 +131,27 @@ typedef struct umf_memory_pool_ops_t {
     ///        The function is used to perform various control operations
     ///        on the memory pool.
     ///
-    /// @param hPool handle to the memory pool.
+    /// @param pool handle to the memory pool.
     /// @param operationType type of the operation to be performed.
     /// @param name name associated with the operation.
     /// @param arg argument for the operation.
+    /// @param size size of the argument [optional - check path requirements]
     /// @param queryType type of the query to be performed.
     ///
     /// @return umf_result_t result of the control operation.
     ///
-    umf_result_t (*ctl)(void *hPool, int operationType, const char *name,
-                        void *arg, umf_ctl_query_type_t queryType);
+    umf_result_t (*ctl)(void *pool, int operationType, const char *name,
+                        void *arg, size_t size, umf_ctl_query_type_t queryType);
 
     ///
-    /// @brief Get the name of the memory pool.
-    /// @param pool pointer to the memory pool
-    /// @return name of the memory pool
+    /// @brief Retrieves the name of the memory pool [optional]
+    /// @param pool valid pointer to the memory pool or NULL value
+    /// \details
+    /// * Implementations *must* return a literal null-terminated string.
+    ///
+    /// * Implementations *must* return default pool name when NULL is provided,
+    ///   otherwise the pool's name is returned.
+    /// @return A constant character string representing the pool's name.
     ///
     const char *(*get_name)(void *pool);
 } umf_memory_pool_ops_t;

include/umf/memory_provider_ops.h

@@ -259,12 +259,13 @@ typedef struct umf_memory_provider_ops_t {
     /// @param operationType type of the operation to be performed.
     /// @param name name associated with the operation.
     /// @param arg argument for the operation.
+    /// @param size size of the argument [optional - check path requirements]
     /// @param queryType type of the query to be performed.
     ///
     /// @return umf_result_t result of the control operation.
     ///
     umf_result_t (*ctl)(void *hProvider, int operationType, const char *name,
-                        void *arg, umf_ctl_query_type_t queryType);
+                        void *arg, size_t size, umf_ctl_query_type_t queryType);
 
 } umf_memory_provider_ops_t;
 

src/ctl/ctl.c

@@ -36,8 +36,6 @@
 #include <stdio.h>
 #endif
 
-#define CTL_MAX_ENTRIES 100
-
 #define MAX_CONFIG_FILE_LEN (1 << 20) /* 1 megabyte */
 
 #define CTL_STRING_QUERY_SEPARATOR ";"
@@ -49,21 +47,6 @@
 static int ctl_global_first_free = 0;
 static umf_ctl_node_t CTL_NODE(global)[CTL_MAX_ENTRIES];
 
-/*
- * This is the top level node of the ctl tree structure. Each node can contain
- * children and leaf nodes.
- *
- * Internal nodes simply create a new path in the tree whereas child nodes are
- * the ones providing the read/write functionality by the means of callbacks.
- *
- * Each tree node must be NULL-terminated, CTL_NODE_END macro is provided for
- * convenience.
- */
-struct ctl {
-    umf_ctl_node_t root[CTL_MAX_ENTRIES];
-    int first_free;
-};
-
 void *Zalloc(size_t sz) {
     void *ptr = umf_ba_global_alloc(sz);
     if (ptr) {
@@ -81,36 +64,6 @@ char *Strdup(const char *s) {
     return p;
 }
 
-umf_result_t umfCtlGet(const char *name, void *ctx, void *arg) {
-    if (name == NULL || arg == NULL || ctx == NULL) {
-        return UMF_RESULT_ERROR_INVALID_ARGUMENT;
-    }
-    return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name, CTL_QUERY_READ,
-                     arg)
-               ? UMF_RESULT_ERROR_UNKNOWN
-               : UMF_RESULT_SUCCESS;
-}
-
-umf_result_t umfCtlSet(const char *name, void *ctx, void *arg) {
-    if (name == NULL || arg == NULL || ctx == NULL) {
-        return UMF_RESULT_ERROR_INVALID_ARGUMENT;
-    }
-    return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name, CTL_QUERY_WRITE,
-                     arg)
-               ? UMF_RESULT_ERROR_UNKNOWN
-               : UMF_RESULT_SUCCESS;
-}
-
-umf_result_t umfCtlExec(const char *name, void *ctx, void *arg) {
-    if (name == NULL || ctx == NULL) {
-        return UMF_RESULT_ERROR_INVALID_ARGUMENT;
-    }
-    return ctl_query(NULL, ctx, CTL_QUERY_PROGRAMMATIC, name,
-                     CTL_QUERY_RUNNABLE, arg)
-               ? UMF_RESULT_ERROR_UNKNOWN
-               : UMF_RESULT_SUCCESS;
-}
-
 /*
  * ctl_find_node -- (internal) searches for a matching entry point in the
  *    provided nodes
@@ -296,10 +249,10 @@ static void ctl_query_cleanup_real_args(const umf_ctl_node_t *n, void *real_arg,
  */
 static int ctl_exec_query_read(void *ctx, const umf_ctl_node_t *n,
                                umf_ctl_query_source_t source, void *arg,
-                               umf_ctl_index_utlist_t *indexes,
+                               size_t size, umf_ctl_index_utlist_t *indexes,
                                const char *extra_name,
                                umf_ctl_query_type_t query_type) {
-    (void)extra_name, (void)query_type;
+    (void)query_type;
     assert(n != NULL);
     assert(n->cb[CTL_QUERY_READ] != NULL);
     assert(MAX_CTL_QUERY_TYPE != query_type);
@@ -309,7 +262,7 @@ static int ctl_exec_query_read(void *ctx, const umf_ctl_node_t *n,
         return -1;
     }
 
-    return n->cb[CTL_QUERY_READ](ctx, source, arg, indexes, NULL,
+    return n->cb[CTL_QUERY_READ](ctx, source, arg, size, indexes, extra_name,
                                  MAX_CTL_QUERY_TYPE);
 }
 
@@ -318,10 +271,10 @@ static int ctl_exec_query_read(void *ctx, const umf_ctl_node_t *n,
  */
 static int ctl_exec_query_write(void *ctx, const umf_ctl_node_t *n,
                                 umf_ctl_query_source_t source, void *arg,
-                                umf_ctl_index_utlist_t *indexes,
+                                size_t size, umf_ctl_index_utlist_t *indexes,
                                 const char *extra_name,
                                 umf_ctl_query_type_t query_type) {
-    (void)extra_name, (void)query_type;
+    (void)query_type;
     assert(n != NULL);
     assert(n->cb[CTL_QUERY_WRITE] != NULL);
     assert(MAX_CTL_QUERY_TYPE != query_type);
@@ -336,8 +289,8 @@ static int ctl_exec_query_write(void *ctx, const umf_ctl_node_t *n,
         return -1;
     }
 
-    int ret = n->cb[CTL_QUERY_WRITE](ctx, source, real_arg, indexes, NULL,
-                                     MAX_CTL_QUERY_TYPE);
+    int ret = n->cb[CTL_QUERY_WRITE](ctx, source, real_arg, size, indexes,
+                                     extra_name, MAX_CTL_QUERY_TYPE);
     ctl_query_cleanup_real_args(n, real_arg, source);
 
     return ret;
@@ -348,31 +301,32 @@ static int ctl_exec_query_write(void *ctx, const umf_ctl_node_t *n,
  */
 static int ctl_exec_query_runnable(void *ctx, const umf_ctl_node_t *n,
                                    umf_ctl_query_source_t source, void *arg,
-                                   umf_ctl_index_utlist_t *indexes,
+                                   size_t size, umf_ctl_index_utlist_t *indexes,
                                    const char *extra_name,
                                    umf_ctl_query_type_t query_type) {
-    (void)extra_name, (void)query_type;
+    (void)query_type;
     assert(n != NULL);
     assert(n->cb[CTL_QUERY_RUNNABLE] != NULL);
     assert(MAX_CTL_QUERY_TYPE != query_type);
-    return n->cb[CTL_QUERY_RUNNABLE](ctx, source, arg, indexes, NULL,
-                                     MAX_CTL_QUERY_TYPE);
+    return n->cb[CTL_QUERY_RUNNABLE](ctx, source, arg, size, indexes,
+                                     extra_name, MAX_CTL_QUERY_TYPE);
 }
 
 static int ctl_exec_query_subtree(void *ctx, const umf_ctl_node_t *n,
                                   umf_ctl_query_source_t source, void *arg,
-                                  umf_ctl_index_utlist_t *indexes,
+                                  size_t size, umf_ctl_index_utlist_t *indexes,
                                   const char *extra_name,
                                   umf_ctl_query_type_t query_type) {
     assert(n != NULL);
     assert(n->cb[CTL_QUERY_SUBTREE] != NULL);
     assert(MAX_CTL_QUERY_TYPE != query_type);
-    return n->cb[CTL_QUERY_SUBTREE](ctx, source, arg, indexes, extra_name,
+    return n->cb[CTL_QUERY_SUBTREE](ctx, source, arg, size, indexes, extra_name,
                                     query_type);
 }
 
 typedef int (*umf_ctl_exec_query_t)(void *ctx, const umf_ctl_node_t *n,
                                     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 query_type);
@@ -389,7 +343,8 @@ static umf_ctl_exec_query_t ctl_exec_query[MAX_CTL_QUERY_TYPE] = {
  *    from the ctl tree
  */
 int ctl_query(struct ctl *ctl, void *ctx, umf_ctl_query_source_t source,
-              const char *name, umf_ctl_query_type_t type, void *arg) {
+              const char *name, umf_ctl_query_type_t type, void *arg,
+              size_t size) {
     if (name == NULL) {
         errno = EINVAL;
         return -1;
@@ -426,10 +381,9 @@ int ctl_query(struct ctl *ctl, void *ctx, umf_ctl_query_source_t source,
         goto out;
     }
 
-    const char *extra_name = &name[0] + name_offset;
     ret =
         ctl_exec_query[n->type == CTL_NODE_SUBTREE ? CTL_QUERY_SUBTREE : type](
-            ctx, n, source, arg, indexes, extra_name, type);
+            ctx, n, source, arg, size, indexes, name + name_offset, type);
 out:
     ctl_delete_indexes(indexes);
 
@@ -496,7 +450,7 @@ static int ctl_load_config(struct ctl *ctl, void *ctx, char *buf) {
         }
 
         r = ctl_query(ctl, ctx, CTL_QUERY_CONFIG_INPUT, name, CTL_QUERY_WRITE,
-                      value);
+                      value, 0);
 
         if (r < 0 && ctx != NULL) {
             return -1;
@@ -590,24 +544,6 @@ int ctl_load_config_from_file(struct ctl *ctl, void *ctx,
 }
 #endif
 
-/*
- * ctl_new -- allocates and initializes ctl data structures
- */
-struct ctl *ctl_new(void) {
-    struct ctl *c = Zalloc(sizeof(struct ctl));
-    if (c == NULL) {
-        return NULL;
-    }
-
-    c->first_free = 0;
-    return c;
-}
-
-/*
- * ctl_delete -- deletes ctl
- */
-void ctl_delete(struct ctl *c) { umf_ba_global_free(c); }
-
 /*
  * ctl_parse_ll -- (internal) parses and returns a long long signed integer
  */

src/ctl/ctl.h

@@ -27,7 +27,7 @@
 extern "C" {
 #endif
 
-struct ctl;
+#define CTL_MAX_ENTRIES 100
 
 typedef struct ctl_index_utlist {
     const char *name;
@@ -46,7 +46,7 @@ typedef enum ctl_query_source {
 } umf_ctl_query_source_t;
 
 typedef int (*node_callback)(void *ctx, umf_ctl_query_source_t type, void *arg,
-                             umf_ctl_index_utlist_t *indexes,
+                             size_t size, umf_ctl_index_utlist_t *indexes,
                              const char *extra_name,
                              umf_ctl_query_type_t query_type);
 
@@ -98,8 +98,20 @@ typedef struct ctl_node {
     const struct ctl_node *children;
 } umf_ctl_node_t;
 
-struct ctl *ctl_new(void);
-void ctl_delete(struct ctl *stats);
+/*
+ * This is the top level node of the ctl tree structure. Each node can contain
+ * children and leaf nodes.
+ *
+ * Internal nodes simply create a new path in the tree whereas child nodes are
+ * the ones providing the read/write functionality by the means of callbacks.
+ *
+ * Each tree node must be NULL-terminated, CTL_NODE_END macro is provided for
+ * convenience.
+ */
+struct ctl {
+    umf_ctl_node_t root[CTL_MAX_ENTRIES];
+    int first_free;
+};
 
 void initialize_global_ctl(void);
 
@@ -138,7 +150,8 @@ int ctl_arg_string(const void *arg, void *dest, size_t dest_size);
 #define CTL_NODE(name, ...) ctl_node_##__VA_ARGS__##_##name
 
 int ctl_query(struct ctl *ctl, void *ctx, umf_ctl_query_source_t source,
-              const char *name, umf_ctl_query_type_t type, void *arg);
+              const char *name, umf_ctl_query_type_t type, void *arg,
+              size_t size);
 
 /* Declaration of a new child node */
 #define CTL_CHILD(name, ...)                                                   \