common: split ini-config in its own convenience library
authorSimon Marchi <simon.marchi@efficios.com>
Fri, 15 Oct 2021 19:15:51 +0000 (15:15 -0400)
committerJérémie Galarneau <jeremie.galarneau@efficios.com>
Fri, 19 Nov 2021 23:31:05 +0000 (18:31 -0500)
The src/common/config contains code related to two kinds of unrelated
"config": the ini config, used for configuration files, and the XML
session configuration (used for loading/saving sessions, and
incidentally MI).

Split the ini config in its own convenience library, in
src/common/ini-config and keep the rest under src/common/config.

Move ini-related things out of config/session-config.{cpp,h} and into
ini-config/ini-config.{cpp,h}.

Change-Id: Ia0b2b6cdcc15198e20444aa30f1fc86c053176d9
Signed-off-by: Simon Marchi <simon.marchi@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>
17 files changed:
configure.ac
src/bin/lttng-relayd/main.cpp
src/bin/lttng-relayd/tcp_keep_alive.cpp
src/bin/lttng-sessiond/main.cpp
src/common/Makefile.am
src/common/config/Makefile.am
src/common/config/ini.cpp [deleted file]
src/common/config/ini.h [deleted file]
src/common/config/session-config.cpp
src/common/config/session-config.h
src/common/ini-config/Makefile.am [new file with mode: 0644]
src/common/ini-config/ini-config.cpp [new file with mode: 0644]
src/common/ini-config/ini-config.h [new file with mode: 0644]
src/common/ini-config/ini.cpp [new file with mode: 0644]
src/common/ini-config/ini.h [new file with mode: 0644]
tests/unit/ini_config/Makefile.am
tests/unit/ini_config/ini_config.cpp

index abb61d27fe42765898d38a6c832f1eb13d50a7cd..b2f73dc276d1cc50e405cc805e41c68bdc9db049 100644 (file)
@@ -1155,6 +1155,7 @@ AC_CONFIG_FILES([
        src/common/index/Makefile
        src/common/health/Makefile
        src/common/config/Makefile
+       src/common/ini-config/Makefile
        src/common/string-utils/Makefile
        src/common/fd-tracker/Makefile
        src/common/filter/Makefile
index 1da83086e82b4d7107fc4d36e5c97d1cf173b388..71690f1da90f0d3ecdd96a6a1834d798e532e302 100644 (file)
@@ -50,7 +50,7 @@
 #include <common/uri.h>
 #include <common/utils.h>
 #include <common/align.h>
-#include <common/config/session-config.h>
+#include <common/ini-config/ini-config.h>
 #include <common/dynamic-buffer.h>
 #include <common/buffer-view.h>
 #include <common/string-utils/format.h>
index 94bf4ab9332742f42ea3c8e8872f6ea545f253f9..c52a55ffba4cb1493d1b9ce60d743ed6ee62b552 100644 (file)
@@ -14,7 +14,7 @@
 #include <common/compat/getenv.h>
 #include <common/time.h>
 #include <common/defaults.h>
-#include <common/config/session-config.h>
+#include <common/ini-config/ini-config.h>
 
 #include "tcp_keep_alive.h"
 
index e5e71889147aad8fb0076375e3f0ba3314ec1736..a676b257fc818b8b8dea711731ad3d7b2ac2e23f 100644 (file)
@@ -39,6 +39,7 @@
 #include <common/utils.h>
 #include <common/daemonize.h>
 #include <common/config/session-config.h>
+#include <common/ini-config/ini-config.h>
 #include <common/dynamic-buffer.h>
 #include <lttng/event-internal.h>
 
index 48e18f311c1f242ae5eff38d6e3767dc2178c39e..a12edcb58681ca2769ab9053ea870e79e8ed8397 100644 (file)
@@ -7,6 +7,7 @@ SUBDIRS = \
        bytecode \
        compat \
        config \
+       ini-config \
        fd-tracker \
        string-utils \
        filter \
@@ -26,6 +27,7 @@ DIST_SUBDIRS = \
        testpoint \
        index \
        config \
+       ini-config \
        consumer \
        string-utils \
        fd-tracker \
@@ -118,6 +120,7 @@ endif
 libcommon_la_LIBADD = \
        $(top_builddir)/src/common/bytecode/libbytecode.la \
        $(top_builddir)/src/common/config/libconfig.la \
+       $(top_builddir)/src/common/ini-config/libini-config.la \
        $(top_builddir)/src/common/compat/libcompat.la \
        $(top_builddir)/src/common/hashtable/libhashtable.la \
        $(top_builddir)/src/common/fd-tracker/libfd-tracker.la \
index faa4a38356d35dea93831449c588e3053734844c..a273523cf55a5c4725625fcf87dc9e5b406eeef9 100644 (file)
@@ -5,8 +5,6 @@ noinst_LTLIBRARIES = libconfig.la
 libconfig_la_SOURCES = \
        config-internal.h \
        config-session-abi.h \
-       ini.cpp \
-       ini.h \
        session-config.cpp \
        session-config.h
 libconfig_la_CPPFLAGS = $(libxml2_CFLAGS) $(AM_CPPFLAGS)
diff --git a/src/common/config/ini.cpp b/src/common/config/ini.cpp
deleted file mode 100644 (file)
index 1d967a4..0000000
+++ /dev/null
@@ -1,218 +0,0 @@
-/*
- * inih -- simple .INI file parser
- *
- * The "inih" library is distributed under the New BSD license:
- *
- * Copyright (C) 2009 Brush Technology - All rights reserved.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *     * Redistributions of source code must retain the above copyright notice,
- *     this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *     notice, this list of conditions and the following disclaimer in the
- *     documentation and/or other materials provided with the distribution.
- *     * Neither the name of Brush Technology nor the names of its contributors
- *     may be used to endorse or promote products derived from this software
- *     without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY BRUSH TECHNOLOGY ''AS IS'' AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
- * EVENT SHALL BRUSH TECHNOLOGY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * http://code.google.com/p/inih/
- */
-
-#include <stdio.h>
-#include <ctype.h>
-#include <string.h>
-#include <common/common.h>
-
-#include "ini.h"
-
-#if !INI_USE_STACK
-#include <stdlib.h>
-#endif
-
-#define MAX_SECTION 50
-#define MAX_NAME 50
-
-/* Strip whitespace chars off end of given string, in place. Return s. */
-static char* rstrip(char* s)
-{
-       char* p = s + strlen(s);
-
-       while (p > s && isspace((unsigned char)(*--p)))
-               *p = '\0';
-       return s;
-}
-
-/* Return pointer to first non-whitespace char in given string. */
-static char* lskip(const char* s)
-{
-       while (*s && isspace((unsigned char)(*s)))
-               s++;
-       return (char*)s;
-}
-
-/*
- * Return pointer to first char c or ';' comment in given string, or pointer to
- * null at end of string if neither found. ';' must be prefixed by a whitespace
- * character to register as a comment.
- */
-static char* find_char_or_comment(const char* s, char c)
-{
-       int was_whitespace = 0;
-
-       while (*s && *s != c && !(was_whitespace && *s == ';')) {
-               was_whitespace = isspace((unsigned char)(*s));
-               s++;
-       }
-       return (char*)s;
-}
-
-/* Version of strncpy that ensures dest (size bytes) is null-terminated. */
-static char* strncpy0(char* dest, const char* src, size_t size)
-{
-       strncpy(dest, src, size - 1);
-       dest[size - 1] = '\0';
-       return dest;
-}
-
-/* See documentation in header file. */
-int ini_parse_file(FILE* file, ini_entry_handler handler, void* user)
-{
-       /* Uses a fair bit of stack (use heap instead if you need to) */
-#if INI_USE_STACK
-       char line[INI_MAX_LINE];
-#else
-       char* line;
-#endif
-       char section[MAX_SECTION] = "";
-       char prev_name[MAX_NAME] = "";
-
-       char* start;
-       char* end;
-       char* name;
-       char* value;
-       int lineno = 0;
-       int error = 0;
-
-#if !INI_USE_STACK
-       line = (char*)zmalloc(INI_MAX_LINE);
-       if (!line) {
-               return -2;
-       }
-#endif
-
-       /* Scan through file line by line */
-       while (fgets(line, INI_MAX_LINE, file) != NULL) {
-               lineno++;
-
-               start = line;
-#if INI_ALLOW_BOM
-               if (lineno == 1 && (unsigned char)start[0] == 0xEF &&
-                       (unsigned char)start[1] == 0xBB &&
-                       (unsigned char)start[2] == 0xBF) {
-                       start += 3;
-               }
-#endif
-               start = lskip(rstrip(start));
-
-               if (*start == ';' || *start == '#') {
-                       /*
-                        * Per Python ConfigParser, allow '#' comments at
-                        * start of line.
-                        */
-               }
-#if INI_ALLOW_MULTILINE
-               else if (*prev_name && *start && start > line) {
-                       /* Non-black line with leading whitespace, treat as
-                        * continuation of previous name's value
-                        * (as per Python ConfigParser).
-                        */
-                       if (handler(user, section, prev_name, start) < 0 &&
-                               !error) {
-                               error = lineno;
-                       }
-               }
-#endif
-               else if (*start == '[') {
-                       /* A "[section]" line */
-                       end = find_char_or_comment(start + 1, ']');
-                       if (*end == ']') {
-                               *end = '\0';
-                               strncpy0(section, start + 1, sizeof(section));
-                               *prev_name = '\0';
-                       }
-                       else if (!error) {
-                               /* No ']' found on section line */
-                               error = lineno;
-                       }
-               }
-               else if (*start && *start != ';') {
-                       /* Not a comment, must be a name[=:]value pair */
-                       end = find_char_or_comment(start, '=');
-                       if (*end != '=') {
-                               end = find_char_or_comment(start, ':');
-                       }
-                       if (*end == '=' || *end == ':') {
-                               *end = '\0';
-                               name = rstrip(start);
-                               value = lskip(end + 1);
-                               end = find_char_or_comment(value, '\0');
-                               if (*end == ';') {
-                                       *end = '\0';
-                               }
-
-                               rstrip(value);
-
-                               /*
-                                * Valid name[=:]value pair found, call
-                                * handler
-                                */
-                               strncpy0(prev_name, name, sizeof(prev_name));
-                               if (handler(user, section, name, value) < 0 &&
-                                       !error) {
-                                       error = lineno;
-                               }
-                       }
-                       else if (!error) {
-                               /* No '=' or ':' found on name[=:]value line */
-                               error = lineno;
-                       }
-               }
-       }
-
-#if !INI_USE_STACK
-       free(line);
-#endif
-
-       return error;
-}
-
-/* See documentation in header file. */
-int ini_parse(const char* filename, ini_entry_handler handler, void* user)
-{
-       FILE* file;
-       int error;
-
-       file = fopen(filename, "r");
-       if (!file) {
-               return -1;
-       }
-
-       error = ini_parse_file(file, handler, user);
-       fclose(file);
-       return error;
-}
diff --git a/src/common/config/ini.h b/src/common/config/ini.h
deleted file mode 100644 (file)
index 34b3654..0000000
+++ /dev/null
@@ -1,94 +0,0 @@
-/*
- * inih -- simple .INI file parser
- *
- * The "inih" library is distributed under the New BSD license:
- *
- * Copyright (C) 2009 Brush Technology - All rights reserved.
- *
- * SPDX-License-Identifier: BSD-3-Clause
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions are met:
- *
- *     * Redistributions of source code must retain the above copyright notice,
- *     this list of conditions and the following disclaimer.
- *     * Redistributions in binary form must reproduce the above copyright
- *     notice, this list of conditions and the following disclaimer in the
- *     documentation and/or other materials provided with the distribution.
- *     * Neither the name of Brush Technology nor the names of its contributors
- *     may be used to endorse or promote products derived from this software
- *     without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY BRUSH TECHNOLOGY ''AS IS'' AND ANY EXPRESS OR
- * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
- * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
- * EVENT SHALL BRUSH TECHNOLOGY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
- * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
- * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
- * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
- * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * http://code.google.com/p/inih/
- */
-
-#ifndef __INI_H__
-#define __INI_H__
-
-/* Make this header file easier to include in C++ code */
-#include <stdio.h>
-
-typedef int (*ini_entry_handler)(void *, const char *, const char *,
-               const char *);
-
-/*
- * Parse given INI-style file. May have [section]s, name=value pairs
- * (whitespace stripped), and comments starting with ';' (semicolon). Section
- * is "" if name=value pair parsed before any section heading. name:value
- * pairs are also supported as a concession to Python's ConfigParser.
- *
- * For each name=value pair parsed, call handler function with given user
- * pointer as well as section, name, and value (data only valid for duration
- * of handler call). Handler should return zero on success, < 0 on error.
- *
- * Returns 0 on success, line number of first error on parse error (doesn't
- * stop on first error), -1 on file open error, or -2 on memory allocation
- * error (only when INI_USE_STACK is zero).
- */
-int ini_parse(const char *filename, ini_entry_handler handler, void *user);
-
-/*
- * Same as ini_parse(), but takes a FILE* instead of filename. This doesn't
- * close the file when it's finished -- the caller must do that.
- */
-int ini_parse_file(FILE *file, ini_entry_handler handler, void *user);
-
-/*
- * Nonzero to allow multi-line value parsing, in the style of Python's
- * ConfigParser. If allowed, ini_parse() will call the handler with the same
- * name for each subsequent line parsed.
- */
-#ifndef INI_ALLOW_MULTILINE
-#define INI_ALLOW_MULTILINE 1
-#endif
-
-/*
- * Nonzero to allow a UTF-8 BOM sequence (0xEF 0xBB 0xBF) at the start of
- * the file. See http://code.google.com/p/inih/issues/detail?id=21
- */
-#ifndef INI_ALLOW_BOM
-#define INI_ALLOW_BOM 1
-#endif
-
-/* Nonzero to use stack, zero to use heap (malloc/free). */
-#ifndef INI_USE_STACK
-#define INI_USE_STACK 1
-#endif
-
-/* Maximum line length for any line in INI file. */
-#ifndef INI_MAX_LINE
-#define INI_MAX_LINE 200
-#endif
-
-#endif /* __INI_H__ */
index 4d57d581a8548674b34cc1093dec81690110fba9..19d587c610de6aa6acd7338861b7445682d48405 100644 (file)
 
 #define CONFIG_USERSPACE_PROBE_LOOKUP_METHOD_NAME_MAX_LEN 7
 
-struct handler_filter_args {
-       const char* section;
-       config_entry_handler_cb handler;
-       void *user_data;
-};
-
 struct session_config_validation_ctx {
        xmlSchemaParserCtxtPtr parser_ctx;
        xmlSchemaPtr schema;
@@ -52,12 +46,6 @@ struct session_config_validation_ctx {
 };
 
 const char * const config_element_all = "all";
-LTTNG_EXPORT const char *config_str_yes = "yes";
-LTTNG_EXPORT const char *config_str_true = "true";
-LTTNG_EXPORT const char *config_str_on = "on";
-LTTNG_EXPORT const char *config_str_no = "no";
-LTTNG_EXPORT const char *config_str_false = "false";
-LTTNG_EXPORT const char *config_str_off = "off";
 LTTNG_EXPORT const char *config_xml_encoding = "UTF-8";
 LTTNG_EXPORT size_t config_xml_encoding_bytes_per_char = 2;    /* Size of the encoding's largest character */
 LTTNG_EXPORT const char *config_xml_indent_string = "\t";
@@ -252,151 +240,6 @@ struct consumer_output {
        char *data_uri;
 };
 
-static int config_entry_handler_filter(struct handler_filter_args *args,
-               const char *section, const char *name, const char *value)
-{
-       int ret = 0;
-       struct config_entry entry = { section, name, value };
-
-       LTTNG_ASSERT(args);
-
-       if (!section || !name || !value) {
-               ret = -EIO;
-               goto end;
-       }
-
-       if (args->section) {
-               if (strcmp(args->section, section)) {
-                       goto end;
-               }
-       }
-
-       ret = args->handler(&entry, args->user_data);
-end:
-       return ret;
-}
-
-int config_get_section_entries(const char *override_path, const char *section,
-               config_entry_handler_cb handler, void *user_data)
-{
-       int ret = 0;
-       const char *path;
-       FILE *config_file = NULL;
-       struct handler_filter_args filter = { section, handler, user_data };
-
-       /* First, try system-wide conf. file. */
-       path = DEFAULT_DAEMON_SYSTEM_CONFIGPATH;
-
-       config_file = fopen(path, "r");
-       if (config_file) {
-               DBG("Loading daemon conf file at %s", path);
-               /*
-                * Return value is not very important here since error or not, we
-                * continue and try the next possible conf. file.
-                */
-               (void) ini_parse_file(config_file,
-                               (ini_entry_handler) config_entry_handler_filter,
-                               (void *) &filter);
-               fclose(config_file);
-       }
-
-       /* Second is the user local configuration. */
-       path = utils_get_home_dir();
-       if (path) {
-               char fullpath[PATH_MAX];
-
-               ret = snprintf(fullpath, sizeof(fullpath),
-                               DEFAULT_DAEMON_HOME_CONFIGPATH, path);
-               if (ret < 0) {
-                       PERROR("snprintf user conf. path");
-                       goto error;
-               }
-
-               config_file = fopen(fullpath, "r");
-               if (config_file) {
-                       DBG("Loading daemon user conf file at %s", path);
-                       /*
-                        * Return value is not very important here since error or not, we
-                        * continue and try the next possible conf. file.
-                        */
-                       (void) ini_parse_file(config_file,
-                                       (ini_entry_handler) config_entry_handler_filter,
-                                       (void *) &filter);
-                       fclose(config_file);
-               }
-       }
-
-       /* Final path is the one that the user might have provided. */
-       if (override_path) {
-               config_file = fopen(override_path, "r");
-               if (config_file) {
-                       DBG("Loading daemon command line conf file at %s", override_path);
-                       (void) ini_parse_file(config_file,
-                                       (ini_entry_handler) config_entry_handler_filter,
-                                       (void *) &filter);
-                       fclose(config_file);
-               } else {
-                       ERR("Failed to open daemon configuration file at %s",
-                               override_path);
-                       ret = -ENOENT;
-                       goto error;
-               }
-       }
-
-       /* Everything went well. */
-       ret = 0;
-
-error:
-       return ret;
-}
-
-int config_parse_value(const char *value)
-{
-       int i, ret = 0;
-       char *endptr, *lower_str;
-       size_t len;
-       unsigned long v;
-
-       len = strlen(value);
-       if (!len) {
-               ret = -1;
-               goto end;
-       }
-
-       v = strtoul(value, &endptr, 10);
-       if (endptr != value) {
-               ret = v;
-               goto end;
-       }
-
-       lower_str = (char *) zmalloc(len + 1);
-       if (!lower_str) {
-               PERROR("zmalloc");
-               ret = -errno;
-               goto end;
-       }
-
-       for (i = 0; i < len; i++) {
-               lower_str[i] = tolower(value[i]);
-       }
-
-       if (!strcmp(lower_str, config_str_yes) ||
-               !strcmp(lower_str, config_str_true) ||
-               !strcmp(lower_str, config_str_on)) {
-               ret = 1;
-       } else if (!strcmp(lower_str, config_str_no) ||
-               !strcmp(lower_str, config_str_false) ||
-               !strcmp(lower_str, config_str_off)) {
-               ret = 0;
-       } else {
-               ret = -1;
-       }
-
-       free(lower_str);
-end:
-       return ret;
-}
-
 /*
  * Returns a xmlChar string which must be released using xmlFree().
  */
index a6955b0b95b4e9435114187c6ebeb1adfd8093fd..b97c5ad41a9b25b6c64854165dc5130a6f3941c1 100644 (file)
@@ -8,18 +8,10 @@
 #ifndef _CONFIG_H
 #define _CONFIG_H
 
-#include <common/config/ini.h>
 #include <common/config/config-session-abi.h>
 #include <common/macros.h>
 #include <stdint.h>
 
-struct config_entry {
-       /* section is NULL if the entry is not in a section */
-       const char *section;
-       const char *name;
-       const char *value;
-};
-
 struct config_load_session_override_attr {
        char *path_url;
        char *ctrl_url;
@@ -30,46 +22,6 @@ struct config_load_session_override_attr {
 /* Instance of a configuration writer. */
 struct config_writer;
 
-/*
- * A config_entry_handler_cb receives config_entry structures belonging to the
- * sections the handler has been registered to.
- *
- * The config_entry and its members are only valid for the duration of the call
- * and must not be freed.
- *
- * config_entry_handler_cb may return negative value to indicate an error in
- * the configuration file.
- */
-typedef int (*config_entry_handler_cb)(const struct config_entry *, void *);
-
-/*
- * Read a section's entries in an INI configuration file.
- *
- * path may be NULL, in which case the following paths will be tried:
- *     1) $HOME/.lttng/lttng.conf
- *     2) /etc/lttng/lttng.conf
- *
- * handler will only be called with entries belonging to the provided section.
- * If section is NULL, all entries will be relayed to handler. If section is
- * "", only the global entries are relayed.
- *
- * Returns 0 on success. Negative values are error codes. If the return value
- * is positive, it represents the line number on which a parsing error occurred.
- */
-int config_get_section_entries(const char *path, const char *section,
-               config_entry_handler_cb handler, void *user_data);
-
-/*
- * Parse a configuration value.
- *
- * This function expects either an unsigned integer or a boolean text option.
- * The following strings are recognized: true, yes, on, false, no and off.
- *
- * Returns either the value of the parsed integer, or 0/1 if a boolean text
- * string was recognized. Negative values indicate an error.
- */
-int config_parse_value(const char *value);
-
 /*
  * Create an instance of a configuration writer.
  *
diff --git a/src/common/ini-config/Makefile.am b/src/common/ini-config/Makefile.am
new file mode 100644 (file)
index 0000000..7f0ee8d
--- /dev/null
@@ -0,0 +1,9 @@
+# SPDX-License-Identifier: GPL-2.0-only
+
+noinst_LTLIBRARIES = libini-config.la
+
+libini_config_la_SOURCES = \
+       ini.cpp \
+       ini.h \
+       ini-config.cpp \
+       ini-config.h
diff --git a/src/common/ini-config/ini-config.cpp b/src/common/ini-config/ini-config.cpp
new file mode 100644 (file)
index 0000000..797de01
--- /dev/null
@@ -0,0 +1,173 @@
+/*
+ * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ */
+
+#include "ini-config.h"
+
+#include <common/defaults.h>
+#include <common/error.h>
+#include <common/ini-config/ini.h>
+#include <common/macros.h>
+#include <common/utils.h>
+#include <ctype.h>
+
+LTTNG_EXPORT const char *config_str_yes = "yes";
+LTTNG_EXPORT const char *config_str_true = "true";
+LTTNG_EXPORT const char *config_str_on = "on";
+LTTNG_EXPORT const char *config_str_no = "no";
+LTTNG_EXPORT const char *config_str_false = "false";
+LTTNG_EXPORT const char *config_str_off = "off";
+
+struct handler_filter_args {
+       const char* section;
+       config_entry_handler_cb handler;
+       void *user_data;
+};
+
+static int config_entry_handler_filter(struct handler_filter_args *args,
+               const char *section, const char *name, const char *value)
+{
+       int ret = 0;
+       struct config_entry entry = { section, name, value };
+
+       LTTNG_ASSERT(args);
+
+       if (!section || !name || !value) {
+               ret = -EIO;
+               goto end;
+       }
+
+       if (args->section) {
+               if (strcmp(args->section, section)) {
+                       goto end;
+               }
+       }
+
+       ret = args->handler(&entry, args->user_data);
+end:
+       return ret;
+}
+
+int config_get_section_entries(const char *override_path, const char *section,
+               config_entry_handler_cb handler, void *user_data)
+{
+       int ret = 0;
+       const char *path;
+       FILE *config_file = NULL;
+       struct handler_filter_args filter = { section, handler, user_data };
+
+       /* First, try system-wide conf. file. */
+       path = DEFAULT_DAEMON_SYSTEM_CONFIGPATH;
+
+       config_file = fopen(path, "r");
+       if (config_file) {
+               DBG("Loading daemon conf file at %s", path);
+               /*
+                * Return value is not very important here since error or not, we
+                * continue and try the next possible conf. file.
+                */
+               (void) ini_parse_file(config_file,
+                               (ini_entry_handler) config_entry_handler_filter,
+                               (void *) &filter);
+               fclose(config_file);
+       }
+
+       /* Second is the user local configuration. */
+       path = utils_get_home_dir();
+       if (path) {
+               char fullpath[PATH_MAX];
+
+               ret = snprintf(fullpath, sizeof(fullpath),
+                               DEFAULT_DAEMON_HOME_CONFIGPATH, path);
+               if (ret < 0) {
+                       PERROR("snprintf user conf. path");
+                       goto error;
+               }
+
+               config_file = fopen(fullpath, "r");
+               if (config_file) {
+                       DBG("Loading daemon user conf file at %s", path);
+                       /*
+                        * Return value is not very important here since error or not, we
+                        * continue and try the next possible conf. file.
+                        */
+                       (void) ini_parse_file(config_file,
+                                       (ini_entry_handler) config_entry_handler_filter,
+                                       (void *) &filter);
+                       fclose(config_file);
+               }
+       }
+
+       /* Final path is the one that the user might have provided. */
+       if (override_path) {
+               config_file = fopen(override_path, "r");
+               if (config_file) {
+                       DBG("Loading daemon command line conf file at %s", override_path);
+                       (void) ini_parse_file(config_file,
+                                       (ini_entry_handler) config_entry_handler_filter,
+                                       (void *) &filter);
+                       fclose(config_file);
+               } else {
+                       ERR("Failed to open daemon configuration file at %s",
+                               override_path);
+                       ret = -ENOENT;
+                       goto error;
+               }
+       }
+
+       /* Everything went well. */
+       ret = 0;
+
+error:
+       return ret;
+}
+
+int config_parse_value(const char *value)
+{
+       int i, ret = 0;
+       char *endptr, *lower_str;
+       size_t len;
+       unsigned long v;
+
+       len = strlen(value);
+       if (!len) {
+               ret = -1;
+               goto end;
+       }
+
+       v = strtoul(value, &endptr, 10);
+       if (endptr != value) {
+               ret = v;
+               goto end;
+       }
+
+       lower_str = (char *) zmalloc(len + 1);
+       if (!lower_str) {
+               PERROR("zmalloc");
+               ret = -errno;
+               goto end;
+       }
+
+       for (i = 0; i < len; i++) {
+               lower_str[i] = tolower(value[i]);
+       }
+
+       if (!strcmp(lower_str, config_str_yes) ||
+               !strcmp(lower_str, config_str_true) ||
+               !strcmp(lower_str, config_str_on)) {
+               ret = 1;
+       } else if (!strcmp(lower_str, config_str_no) ||
+               !strcmp(lower_str, config_str_false) ||
+               !strcmp(lower_str, config_str_off)) {
+               ret = 0;
+       } else {
+               ret = -1;
+       }
+
+       free(lower_str);
+end:
+       return ret;
+}
diff --git a/src/common/ini-config/ini-config.h b/src/common/ini-config/ini-config.h
new file mode 100644 (file)
index 0000000..3e41605
--- /dev/null
@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ *
+ * SPDX-License-Identifier: GPL-2.0-only
+ *
+ */
+
+#ifndef INI_CONFIG_H
+#define INI_CONFIG_H
+
+struct config_entry {
+       /* section is NULL if the entry is not in a section */
+       const char *section;
+       const char *name;
+       const char *value;
+};
+
+/*
+ * A config_entry_handler_cb receives config_entry structures belonging to the
+ * sections the handler has been registered to.
+ *
+ * The config_entry and its members are only valid for the duration of the call
+ * and must not be freed.
+ *
+ * config_entry_handler_cb may return negative value to indicate an error in
+ * the configuration file.
+ */
+typedef int (*config_entry_handler_cb)(const struct config_entry *, void *);
+
+/*
+ * Read a section's entries in an INI configuration file.
+ *
+ * path may be NULL, in which case the following paths will be tried:
+ *     1) $HOME/.lttng/lttng.conf
+ *     2) /etc/lttng/lttng.conf
+ *
+ * handler will only be called with entries belonging to the provided section.
+ * If section is NULL, all entries will be relayed to handler. If section is
+ * "", only the global entries are relayed.
+ *
+ * Returns 0 on success. Negative values are error codes. If the return value
+ * is positive, it represents the line number on which a parsing error occurred.
+ */
+int config_get_section_entries(const char *path, const char *section,
+               config_entry_handler_cb handler, void *user_data);
+
+/*
+ * Parse a configuration value.
+ *
+ * This function expects either an unsigned integer or a boolean text option.
+ * The following strings are recognized: true, yes, on, false, no and off.
+ *
+ * Returns either the value of the parsed integer, or 0/1 if a boolean text
+ * string was recognized. Negative values indicate an error.
+ */
+int config_parse_value(const char *value);
+
+#endif /* INI_CONFIG_H */
diff --git a/src/common/ini-config/ini.cpp b/src/common/ini-config/ini.cpp
new file mode 100644 (file)
index 0000000..1d967a4
--- /dev/null
@@ -0,0 +1,218 @@
+/*
+ * inih -- simple .INI file parser
+ *
+ * The "inih" library is distributed under the New BSD license:
+ *
+ * Copyright (C) 2009 Brush Technology - All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Brush Technology nor the names of its contributors
+ *     may be used to endorse or promote products derived from this software
+ *     without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY BRUSH TECHNOLOGY ''AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+ * EVENT SHALL BRUSH TECHNOLOGY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://code.google.com/p/inih/
+ */
+
+#include <stdio.h>
+#include <ctype.h>
+#include <string.h>
+#include <common/common.h>
+
+#include "ini.h"
+
+#if !INI_USE_STACK
+#include <stdlib.h>
+#endif
+
+#define MAX_SECTION 50
+#define MAX_NAME 50
+
+/* Strip whitespace chars off end of given string, in place. Return s. */
+static char* rstrip(char* s)
+{
+       char* p = s + strlen(s);
+
+       while (p > s && isspace((unsigned char)(*--p)))
+               *p = '\0';
+       return s;
+}
+
+/* Return pointer to first non-whitespace char in given string. */
+static char* lskip(const char* s)
+{
+       while (*s && isspace((unsigned char)(*s)))
+               s++;
+       return (char*)s;
+}
+
+/*
+ * Return pointer to first char c or ';' comment in given string, or pointer to
+ * null at end of string if neither found. ';' must be prefixed by a whitespace
+ * character to register as a comment.
+ */
+static char* find_char_or_comment(const char* s, char c)
+{
+       int was_whitespace = 0;
+
+       while (*s && *s != c && !(was_whitespace && *s == ';')) {
+               was_whitespace = isspace((unsigned char)(*s));
+               s++;
+       }
+       return (char*)s;
+}
+
+/* Version of strncpy that ensures dest (size bytes) is null-terminated. */
+static char* strncpy0(char* dest, const char* src, size_t size)
+{
+       strncpy(dest, src, size - 1);
+       dest[size - 1] = '\0';
+       return dest;
+}
+
+/* See documentation in header file. */
+int ini_parse_file(FILE* file, ini_entry_handler handler, void* user)
+{
+       /* Uses a fair bit of stack (use heap instead if you need to) */
+#if INI_USE_STACK
+       char line[INI_MAX_LINE];
+#else
+       char* line;
+#endif
+       char section[MAX_SECTION] = "";
+       char prev_name[MAX_NAME] = "";
+
+       char* start;
+       char* end;
+       char* name;
+       char* value;
+       int lineno = 0;
+       int error = 0;
+
+#if !INI_USE_STACK
+       line = (char*)zmalloc(INI_MAX_LINE);
+       if (!line) {
+               return -2;
+       }
+#endif
+
+       /* Scan through file line by line */
+       while (fgets(line, INI_MAX_LINE, file) != NULL) {
+               lineno++;
+
+               start = line;
+#if INI_ALLOW_BOM
+               if (lineno == 1 && (unsigned char)start[0] == 0xEF &&
+                       (unsigned char)start[1] == 0xBB &&
+                       (unsigned char)start[2] == 0xBF) {
+                       start += 3;
+               }
+#endif
+               start = lskip(rstrip(start));
+
+               if (*start == ';' || *start == '#') {
+                       /*
+                        * Per Python ConfigParser, allow '#' comments at
+                        * start of line.
+                        */
+               }
+#if INI_ALLOW_MULTILINE
+               else if (*prev_name && *start && start > line) {
+                       /* Non-black line with leading whitespace, treat as
+                        * continuation of previous name's value
+                        * (as per Python ConfigParser).
+                        */
+                       if (handler(user, section, prev_name, start) < 0 &&
+                               !error) {
+                               error = lineno;
+                       }
+               }
+#endif
+               else if (*start == '[') {
+                       /* A "[section]" line */
+                       end = find_char_or_comment(start + 1, ']');
+                       if (*end == ']') {
+                               *end = '\0';
+                               strncpy0(section, start + 1, sizeof(section));
+                               *prev_name = '\0';
+                       }
+                       else if (!error) {
+                               /* No ']' found on section line */
+                               error = lineno;
+                       }
+               }
+               else if (*start && *start != ';') {
+                       /* Not a comment, must be a name[=:]value pair */
+                       end = find_char_or_comment(start, '=');
+                       if (*end != '=') {
+                               end = find_char_or_comment(start, ':');
+                       }
+                       if (*end == '=' || *end == ':') {
+                               *end = '\0';
+                               name = rstrip(start);
+                               value = lskip(end + 1);
+                               end = find_char_or_comment(value, '\0');
+                               if (*end == ';') {
+                                       *end = '\0';
+                               }
+
+                               rstrip(value);
+
+                               /*
+                                * Valid name[=:]value pair found, call
+                                * handler
+                                */
+                               strncpy0(prev_name, name, sizeof(prev_name));
+                               if (handler(user, section, name, value) < 0 &&
+                                       !error) {
+                                       error = lineno;
+                               }
+                       }
+                       else if (!error) {
+                               /* No '=' or ':' found on name[=:]value line */
+                               error = lineno;
+                       }
+               }
+       }
+
+#if !INI_USE_STACK
+       free(line);
+#endif
+
+       return error;
+}
+
+/* See documentation in header file. */
+int ini_parse(const char* filename, ini_entry_handler handler, void* user)
+{
+       FILE* file;
+       int error;
+
+       file = fopen(filename, "r");
+       if (!file) {
+               return -1;
+       }
+
+       error = ini_parse_file(file, handler, user);
+       fclose(file);
+       return error;
+}
diff --git a/src/common/ini-config/ini.h b/src/common/ini-config/ini.h
new file mode 100644 (file)
index 0000000..34b3654
--- /dev/null
@@ -0,0 +1,94 @@
+/*
+ * inih -- simple .INI file parser
+ *
+ * The "inih" library is distributed under the New BSD license:
+ *
+ * Copyright (C) 2009 Brush Technology - All rights reserved.
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     * Redistributions of source code must retain the above copyright notice,
+ *     this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in the
+ *     documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Brush Technology nor the names of its contributors
+ *     may be used to endorse or promote products derived from this software
+ *     without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY BRUSH TECHNOLOGY ''AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+ * EVENT SHALL BRUSH TECHNOLOGY BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+ * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+ * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * http://code.google.com/p/inih/
+ */
+
+#ifndef __INI_H__
+#define __INI_H__
+
+/* Make this header file easier to include in C++ code */
+#include <stdio.h>
+
+typedef int (*ini_entry_handler)(void *, const char *, const char *,
+               const char *);
+
+/*
+ * Parse given INI-style file. May have [section]s, name=value pairs
+ * (whitespace stripped), and comments starting with ';' (semicolon). Section
+ * is "" if name=value pair parsed before any section heading. name:value
+ * pairs are also supported as a concession to Python's ConfigParser.
+ *
+ * For each name=value pair parsed, call handler function with given user
+ * pointer as well as section, name, and value (data only valid for duration
+ * of handler call). Handler should return zero on success, < 0 on error.
+ *
+ * Returns 0 on success, line number of first error on parse error (doesn't
+ * stop on first error), -1 on file open error, or -2 on memory allocation
+ * error (only when INI_USE_STACK is zero).
+ */
+int ini_parse(const char *filename, ini_entry_handler handler, void *user);
+
+/*
+ * Same as ini_parse(), but takes a FILE* instead of filename. This doesn't
+ * close the file when it's finished -- the caller must do that.
+ */
+int ini_parse_file(FILE *file, ini_entry_handler handler, void *user);
+
+/*
+ * Nonzero to allow multi-line value parsing, in the style of Python's
+ * ConfigParser. If allowed, ini_parse() will call the handler with the same
+ * name for each subsequent line parsed.
+ */
+#ifndef INI_ALLOW_MULTILINE
+#define INI_ALLOW_MULTILINE 1
+#endif
+
+/*
+ * Nonzero to allow a UTF-8 BOM sequence (0xEF 0xBB 0xBF) at the start of
+ * the file. See http://code.google.com/p/inih/issues/detail?id=21
+ */
+#ifndef INI_ALLOW_BOM
+#define INI_ALLOW_BOM 1
+#endif
+
+/* Nonzero to use stack, zero to use heap (malloc/free). */
+#ifndef INI_USE_STACK
+#define INI_USE_STACK 1
+#endif
+
+/* Maximum line length for any line in INI file. */
+#ifndef INI_MAX_LINE
+#define INI_MAX_LINE 200
+#endif
+
+#endif /* __INI_H__ */
index 0039697752bdca6309325a294f7f4ddb97bd6241..f7bf287708f822a918ab8b67bbc3684d1bb2cffb 100644 (file)
@@ -3,7 +3,6 @@
 AM_CPPFLAGS += -I$(top_srcdir)/tests/utils/
 
 LIBTAP=$(top_builddir)/tests/utils/tap/libtap.la
-LIBCONFIG=$(top_builddir)/src/common/config/libconfig.la
 LIBCOMMON=$(top_builddir)/src/common/libcommon.la
 LIBHASHTABLE=$(top_builddir)/src/common/hashtable/libhashtable.la
 
@@ -11,8 +10,7 @@ noinst_PROGRAMS = ini_config
 EXTRA_DIST = test_ini_config sample.ini
 
 ini_config_SOURCES = ini_config.cpp
-ini_config_LDADD = $(LIBTAP) $(LIBCONFIG) $(LIBCOMMON) $(LIBHASHTABLE) \
-       $(top_builddir)/src/lib/lttng-ctl/liblttng-ctl.la
+ini_config_LDADD = $(LIBTAP) $(LIBCOMMON) $(LIBHASHTABLE)
 
 all-local:
        @if [ x"$(srcdir)" != x"$(builddir)" ]; then \
index 6775ddd3f2f7d5f0902df5a6c796e78eeb75d091..c2a753edece66593a336529a21a2bde8c0eca677 100644 (file)
@@ -6,7 +6,7 @@
  */
 
 #include <tap/tap.h>
-#include <common/config/session-config.h>
+#include <common/ini-config/ini-config.h>
 #include <common/utils.h>
 #include <string.h>
 #include <lttng/constant.h>
This page took 0.065071 seconds and 4 git commands to generate.