[CTL] Add sample CTL test

Author: KFilipek

src/CMakeLists.txt

@@ -26,7 +26,8 @@ set(BA_SOURCES
     ${CMAKE_CURRENT_SOURCE_DIR}/base_alloc/base_alloc_global.c)
 
 set(CTL_SOURCES ${CMAKE_CURRENT_SOURCE_DIR}/ctl/alloc.c
-                ${CMAKE_CURRENT_SOURCE_DIR}/ctl/ctl.c)
+                ${CMAKE_CURRENT_SOURCE_DIR}/ctl/ctl.c
+                ${CMAKE_CURRENT_SOURCE_DIR}/ctl/ctl_debug.c)
 
 if(LINUX)
     set(BA_SOURCES ${BA_SOURCES} ${CTL_SOURCES}

src/ctl/ctl.h

@@ -115,7 +115,7 @@ int ctl_arg_integer(const void *arg, void *dest, size_t dest_size);
 
 #define CTL_ARG_LONG_LONG                                                      \
     {sizeof(long long),                                                        \
-     {{0, sizeof(long long), ctl_arg_integer}, CTL_ARG_PARSER_END}};
+     {{0, sizeof(long long), ctl_arg_integer}, CTL_ARG_PARSER_END}}
 
 int ctl_arg_string(const void *arg, void *dest, size_t dest_size);
 #define CTL_ARG_STRING(len)                                                    \
@@ -191,13 +191,13 @@ int ctl_query(struct ctl *ctl, void *ctx, enum ctl_query_source source,
 #define CTL_LEAF_RW(name)                                                      \
     {                                                                          \
         CTL_STR(name), CTL_NODE_LEAF,                                          \
-            {CTL_READ_HANDLER(name), CTL_WRITE_HANDLER(name), NULL},           \
+            {CTL_READ_HANDLER(name, ), CTL_WRITE_HANDLER(name, ), NULL},           \
             &CTL_ARG(name), NULL                                               \
     }
 
 #define CTL_REGISTER_MODULE(_ctl, name)                                        \
     ctl_register_module_node((_ctl), CTL_STR(name),                            \
-                             (struct ctl_node *)CTL_NODE(name))
+                             (struct ctl_node *)CTL_NODE(name, ))
 
 #ifdef __cplusplus
 }

src/ctl/ctl_debug.c

@@ -0,0 +1,79 @@
+// SPDX-License-Identifier: BSD-3-Clause
+/* Copyright 2018-2021, Intel Corporation */
+
+/*
+ * ctl_debug.c -- implementation of the debug CTL namespace
+ */
+
+#include "ctl.h"
+#include "ctl_debug.h"
+
+static struct ctl* ctl_debug;
+
+static int alloc_pattern = 0;
+
+struct ctl* get_debug_ctl(void) {
+	return ctl_debug;
+}
+
+/*
+ * CTL_WRITE_HANDLER(alloc_pattern) -- sets the alloc_pattern field in heap
+ */
+static int
+CTL_WRITE_HANDLER(alloc_pattern, )(void *ctx,
+	enum ctl_query_source source, void *arg, struct ctl_indexes *indexes)
+{
+	/* suppress unused-parameter errors */
+	(void)source, (void)indexes, (void)ctx;
+
+	int arg_in = *(int *)arg;
+	alloc_pattern = arg_in;
+	return 0;
+}
+
+/*
+ * CTL_READ_HANDLER(alloc_pattern) -- returns alloc_pattern heap field
+ */
+static int
+CTL_READ_HANDLER(alloc_pattern, )(void *ctx,
+	enum ctl_query_source source, void *arg, struct ctl_indexes *indexes)
+{
+	/* suppress unused-parameter errors */
+	(void)source, (void)indexes, (void)ctx;
+
+	int *arg_out = arg;
+	*arg_out = alloc_pattern;
+	return 0;
+}
+
+static const struct ctl_argument CTL_ARG(alloc_pattern) = CTL_ARG_LONG_LONG;
+
+static const struct ctl_node CTL_NODE(heap, )[] = {
+	CTL_LEAF_RW(alloc_pattern),
+
+	CTL_NODE_END
+};
+
+static const struct ctl_node CTL_NODE(debug, )[] = {
+	CTL_CHILD(heap, ),
+
+	CTL_NODE_END
+};
+
+/*
+ * debug_ctl_register -- registers ctl nodes for "debug" module
+ */
+void
+debug_ctl_register(struct ctl *ctl)
+{
+	CTL_REGISTER_MODULE(ctl, debug);
+}
+
+void initialize_debug_ctl(void) {
+	ctl_debug = ctl_new();
+	debug_ctl_register(ctl_debug);
+}
+
+void deinitialize_debug_ctl(void) {
+	ctl_delete(ctl_debug);
+}

src/ctl/ctl_debug.h

@@ -0,0 +1,23 @@
+/* SPDX-License-Identifier: BSD-3-Clause */
+/* Copyright 2018-2020, Intel Corporation */
+
+/*
+ * ctl_debug.h -- definitions for CTL test
+ */
+#ifndef LIBPMEMOBJ_CTL_DEBUG_H
+#define LIBPMEMOBJ_CTL_DEBUG_H 1
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void debug_ctl_register(struct ctl *ctl);
+struct ctl* get_debug_ctl(void);
+void initialize_debug_ctl(void);
+void deinitialize_debug_ctl(void);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

test/CMakeLists.txt

@@ -173,6 +173,11 @@ add_umf_test(
     SRCS utils/utils_log.cpp ${UMF_UTILS_SOURCES}
     LIBS ${UMF_LOGGER_LIBS})
 
+    add_umf_test(
+    NAME ctl
+    SRCS ctl/test.cpp
+    LIBS ${UMF_UTILS_FOR_TEST}
+)
 add_umf_test(
     NAME utils_common
     SRCS utils/utils.cpp

test/ctl/config.txt

@@ -0,0 +1 @@
+debug.heap.alloc_pattern=1

test/ctl/test.cpp

@@ -0,0 +1,19 @@
+#include <common/base.hpp>
+#include <ctl/ctl.h>
+#include <ctl/ctl_debug.h>
+
+using namespace umf_test;
+
+TEST_F(test, ctl_debug) {
+    initialize_debug_ctl();
+    auto ctl_handler = get_debug_ctl();
+    ctl_load_config_from_string(ctl_handler, NULL, "debug.heap.alloc_pattern=1");
+
+    int value = 0;
+    ctl_query(ctl_handler, NULL, CTL_QUERY_PROGRAMMATIC, "debug.heap.alloc_pattern",
+              CTL_QUERY_READ, &value);
+    ASSERT_EQ(value, 1);
+
+    debug_ctl_register(ctl_handler);
+    deinitialize_debug_ctl();
+}