X-Git-Url: https://git.lttng.org/?a=blobdiff_plain;f=src%2Fcommon%2Fconfig%2Fsession-config.h;h=a6955b0b95b4e9435114187c6ebeb1adfd8093fd;hb=ca806b0b247f89c62ac628a7779ae84049a8c2d7;hp=2fed612a1cfbd5783891ec16e99808dc386e3645;hpb=f40ef1d56886bc58f5d7e147d77f818f46b66456;p=lttng-tools.git diff --git a/src/common/config/session-config.h b/src/common/config/session-config.h index 2fed612a1..a6955b0b9 100644 --- a/src/common/config/session-config.h +++ b/src/common/config/session-config.h @@ -1,18 +1,8 @@ /* - * Copyright (C) 2013 - Jérémie Galarneau + * Copyright (C) 2013 Jérémie Galarneau * - * 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 @@ -30,6 +20,13 @@ struct config_entry { 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; @@ -57,9 +54,8 @@ typedef int (*config_entry_handler_cb)(const struct config_entry *, void *); * "", 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 occured. + * 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); @@ -72,14 +68,13 @@ int config_get_section_entries(const char *path, const char *section, * 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 +82,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 +92,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); /* @@ -108,13 +101,25 @@ int config_writer_destroy(struct config_writer *writer); * * element_name Element tag name. * - * Returns zero if the XML document could be closed cleanly. + * 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); +/* + * Write an element tag attribute. + * + * writer An instance of a configuration writer. + * + * name Attribute name. + * + * Returns zero if the XML element's attribute could be written. + * Negative values indicate an error. + */ +int config_writer_write_attribute(struct config_writer *writer, + const char *name, const char *value); + /* * Close the current element tag. * @@ -123,7 +128,6 @@ int config_writer_open_element(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); /* @@ -138,7 +142,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); @@ -153,7 +156,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); @@ -169,7 +172,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); @@ -185,10 +187,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. * @@ -201,14 +218,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 */