common: split ini-config in its own convenience library
[lttng-tools.git] / src / common / config / session-config.h
index 939cb6cbf0ff1cd4e76e2c819ffc2e178e241bbd..b97c5ad41a9b25b6c64854165dc5130a6f3941c1 100644 (file)
@@ -1,85 +1,32 @@
 /*
- * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
+ * Copyright (C) 2013 Jérémie Galarneau <jeremie.galarneau@efficios.com>
  *
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License, version 2 only, as
- * published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
  *
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
 #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;
+       char *data_url;
+       char *session_name;
 };
 
 /* 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.
- */
-LTTNG_HIDDEN
-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.
- */
-LTTNG_HIDDEN
-int config_parse_value(const char *value);
-
 /*
  * Create an instance of a configuration writer.
  *
- * fd_output File to which the XML content must be written. The file will be
- * closed once the config_writer has been destroyed.
+ * fd_output File to which the XML content must be written. fd_output is
+ * owned by the caller.
  *
  * indent If other than 0 the XML will be pretty printed
  * with indentation and newline.
@@ -87,7 +34,6 @@ int config_parse_value(const char *value);
  * Returns an instance of a configuration writer on success, NULL on
  * error.
  */
-LTTNG_HIDDEN
 struct config_writer *config_writer_create(int fd_output, int indent);
 
 /*
@@ -98,7 +44,6 @@ struct config_writer *config_writer_create(int fd_output, int indent);
  * Returns zero if the XML document could be closed cleanly. Negative values
  * indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_destroy(struct config_writer *writer);
 
 /*
@@ -111,7 +56,6 @@ int config_writer_destroy(struct config_writer *writer);
  * Returns zero if the XML element could be opened.
  * Negative values indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_open_element(struct config_writer *writer,
                const char *element_name);
 
@@ -125,7 +69,6 @@ int config_writer_open_element(struct config_writer *writer,
  * Returns zero if the XML element's attribute could be written.
  * Negative values indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_write_attribute(struct config_writer *writer,
                const char *name, const char *value);
 
@@ -137,7 +80,6 @@ int config_writer_write_attribute(struct config_writer *writer,
  * Returns zero if the XML document could be closed cleanly.
  * Negative values indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_close_element(struct config_writer *writer);
 
 /*
@@ -152,7 +94,6 @@ int config_writer_close_element(struct config_writer *writer);
  * Returns zero if the element's value could be written.
  * Negative values indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_write_element_unsigned_int(struct config_writer *writer,
                const char *element_name, uint64_t value);
 
@@ -167,7 +108,7 @@ int config_writer_write_element_unsigned_int(struct config_writer *writer,
  *
  * Returns zero if the element's value could be written.
  * Negative values indicate an error.
- */LTTNG_HIDDEN
+ */
 int config_writer_write_element_signed_int(struct config_writer *writer,
                const char *element_name, int64_t value);
 
@@ -183,7 +124,6 @@ int config_writer_write_element_signed_int(struct config_writer *writer,
  * Returns zero if the element's value could be written.
  * Negative values indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_write_element_bool(struct config_writer *writer,
                const char *element_name, int value);
 
@@ -199,10 +139,25 @@ int config_writer_write_element_bool(struct config_writer *writer,
  * Returns zero if the element's value could be written.
  * Negative values indicate an error.
  */
-LTTNG_HIDDEN
 int config_writer_write_element_string(struct config_writer *writer,
                const char *element_name, const char *value);
 
+/*
+ * Write an element of type double.
+ *
+ * writer An instance of a configuration writer.
+ *
+ * element_name Element name.
+ *
+ * value Double value of the element
+ *
+ * Returns zero if the element's value could be written.
+ * Negative values indicate an error.
+ */
+int config_writer_write_element_double(struct config_writer *writer,
+               const char *element_name,
+               double value);
+
 /*
  * Load session configurations from a file.
  *
@@ -215,14 +170,15 @@ int config_writer_write_element_string(struct config_writer *writer,
  * session_name Name of the session to load. Will load all
  * sessions from path if NULL.
  *
- * override Override current session configuration if it exists.
+ * overwrite Overwrite current session configuration if it exists.
  * autoload Tell to load the auto session(s).
+ * overrides The override attribute structure specifying override parameters.
  *
  * Returns zero if the session could be loaded successfully. Returns
  * a negative LTTNG_ERR code on error.
  */
-LTTNG_HIDDEN
 int config_load_session(const char *path, const char *session_name,
-               int override, unsigned int autoload);
+               int overwrite, unsigned int autoload,
+               const struct config_load_session_override_attr *overrides);
 
 #endif /* _CONFIG_H */
This page took 0.025871 seconds and 4 git commands to generate.