2 * Copyright (C) 2013 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License, version 2 only, as
6 * published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 51
15 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <common/config/ini.h>
22 #include <common/config/config-session-abi.h>
23 #include <common/macros.h>
27 /* section is NULL if the entry is not in a section */
33 struct config_load_session_override_attr
{
40 /* Instance of a configuration writer. */
44 * A config_entry_handler_cb receives config_entry structures belonging to the
45 * sections the handler has been registered to.
47 * The config_entry and its members are only valid for the duration of the call
48 * and must not be freed.
50 * config_entry_handler_cb may return negative value to indicate an error in
51 * the configuration file.
53 typedef int (*config_entry_handler_cb
)(const struct config_entry
*, void *);
56 * Read a section's entries in an INI configuration file.
58 * path may be NULL, in which case the following paths will be tried:
59 * 1) $HOME/.lttng/lttng.conf
60 * 2) /etc/lttng/lttng.conf
62 * handler will only be called with entries belonging to the provided section.
63 * If section is NULL, all entries will be relayed to handler. If section is
64 * "", only the global entries are relayed.
66 * Returns 0 on success. Negative values are error codes. If the return value
67 * is positive, it represents the line number on which a parsing error occurred.
70 int config_get_section_entries(const char *path
, const char *section
,
71 config_entry_handler_cb handler
, void *user_data
);
74 * Parse a configuration value.
76 * This function expects either an unsigned integer or a boolean text option.
77 * The following strings are recognized: true, yes, on, false, no and off.
79 * Returns either the value of the parsed integer, or 0/1 if a boolean text
80 * string was recognized. Negative values indicate an error.
83 int config_parse_value(const char *value
);
86 * Create an instance of a configuration writer.
88 * fd_output File to which the XML content must be written. The file will be
89 * closed once the config_writer has been destroyed.
91 * indent If other than 0 the XML will be pretty printed
92 * with indentation and newline.
94 * Returns an instance of a configuration writer on success, NULL on
98 struct config_writer
*config_writer_create(int fd_output
, int indent
);
101 * Destroy an instance of a configuration writer.
103 * writer An instance of a configuration writer.
105 * Returns zero if the XML document could be closed cleanly. Negative values
109 int config_writer_destroy(struct config_writer
*writer
);
112 * Open an element tag.
114 * writer An instance of a configuration writer.
116 * element_name Element tag name.
118 * Returns zero if the XML element could be opened.
119 * Negative values indicate an error.
122 int config_writer_open_element(struct config_writer
*writer
,
123 const char *element_name
);
126 * Write an element tag attribute.
128 * writer An instance of a configuration writer.
130 * name Attribute name.
132 * Returns zero if the XML element's attribute could be written.
133 * Negative values indicate an error.
136 int config_writer_write_attribute(struct config_writer
*writer
,
137 const char *name
, const char *value
);
140 * Close the current element tag.
142 * writer An instance of a configuration writer.
144 * Returns zero if the XML document could be closed cleanly.
145 * Negative values indicate an error.
148 int config_writer_close_element(struct config_writer
*writer
);
151 * Write an element of type unsigned int.
153 * writer An instance of a configuration writer.
155 * element_name Element name.
157 * value Unsigned int value of the element
159 * Returns zero if the element's value could be written.
160 * Negative values indicate an error.
163 int config_writer_write_element_unsigned_int(struct config_writer
*writer
,
164 const char *element_name
, uint64_t value
);
167 * Write an element of type signed int.
169 * writer An instance of a configuration writer.
171 * element_name Element name.
173 * value Signed int value of the element
175 * Returns zero if the element's value could be written.
176 * Negative values indicate an error.
178 int config_writer_write_element_signed_int(struct config_writer
*writer
,
179 const char *element_name
, int64_t value
);
182 * Write an element of type boolean.
184 * writer An instance of a configuration writer.
186 * element_name Element name.
188 * value Boolean value of the element
190 * Returns zero if the element's value could be written.
191 * Negative values indicate an error.
194 int config_writer_write_element_bool(struct config_writer
*writer
,
195 const char *element_name
, int value
);
198 * Write an element of type string.
200 * writer An instance of a configuration writer.
202 * element_name Element name.
204 * value String value of the element
206 * Returns zero if the element's value could be written.
207 * Negative values indicate an error.
210 int config_writer_write_element_string(struct config_writer
*writer
,
211 const char *element_name
, const char *value
);
214 * Load session configurations from a file.
216 * path Path to an LTTng session configuration file. All *.lttng files
217 * will be loaded if path is a directory. If path is NULL, the default
218 * paths will be searched in the following order:
219 * 1) $HOME/.lttng/sessions
220 * 2) /etc/lttng/sessions
222 * session_name Name of the session to load. Will load all
223 * sessions from path if NULL.
225 * overwrite Overwrite current session configuration if it exists.
226 * autoload Tell to load the auto session(s).
227 * overrides The override attribute structure specifying override parameters.
229 * Returns zero if the session could be loaded successfully. Returns
230 * a negative LTTNG_ERR code on error.
233 int config_load_session(const char *path
, const char *session_name
,
234 int overwrite
, unsigned int autoload
,
235 const struct config_load_session_override_attr
*overrides
);
237 #endif /* _CONFIG_H */