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>
24 #include <lttng/domain.h>
25 #include <lttng/event.h>
29 /* section is NULL if the entry is not in a section */
35 /* Instance of a configuration writer. */
38 /* Instance of a configuration document */
39 struct config_document
;
41 struct config_element
;
44 * Return the config string representation of a kernel type.
47 const char *config_get_domain_str(enum lttng_domain_type domain
);
50 * Return the event_type int value of lttng_event_type enumeration based on the
54 int config_get_event_type(const char *event_type
);
57 * A config_entry_handler_cb receives config_entry structures belonging to the
58 * sections the handler has been registered to.
60 * The config_entry and its members are only valid for the duration of the call
61 * and must not be freed.
63 * config_entry_handler_cb may return negative value to indicate an error in
64 * the configuration file.
66 typedef int (*config_entry_handler_cb
)(const struct config_entry
*, void *);
69 * Read a section's entries in an INI configuration file.
71 * path may be NULL, in which case the following paths will be tried:
72 * 1) $HOME/.lttng/lttng.conf
73 * 2) /etc/lttng/lttng.conf
75 * handler will only be called with entries belonging to the provided section.
76 * If section is NULL, all entries will be relayed to handler. If section is
77 * "", only the global entries are relayed.
79 * Returns 0 on success. Negative values are error codes. If the return value
80 * is positive, it represents the line number on which a parsing error occurred.
83 int config_get_section_entries(const char *path
, const char *section
,
84 config_entry_handler_cb handler
, void *user_data
);
87 * Parse a configuration value.
89 * This function expects either an unsigned integer or a boolean text option.
90 * The following strings are recognized: true, yes, on, false, no and off.
92 * Returns either the value of the parsed integer, or 0/1 if a boolean text
93 * string was recognized. Negative values indicate an error.
96 int config_parse_value(const char *value
);
99 * Create an instance of a configuration writer.
101 * fd_output File to which the XML content must be written. The file will be
102 * closed once the config_writer has been destroyed.
104 * indent If other than 0 the XML will be pretty printed
105 * with indentation and newline.
107 * Returns an instance of a configuration writer on success, NULL on
111 struct config_writer
*config_writer_create(int fd_output
, int indent
);
114 * Destroy an instance of a configuration writer.
116 * writer An instance of a configuration writer.
118 * Returns zero if the XML document could be closed cleanly. Negative values
122 int config_writer_destroy(struct config_writer
*writer
);
125 * Open an element tag.
127 * writer An instance of a configuration writer.
129 * element_name Element tag name.
131 * Returns zero if the XML element could be opened.
132 * Negative values indicate an error.
135 int config_writer_open_element(struct config_writer
*writer
,
136 const char *element_name
);
139 * Write an element tag attribute.
141 * writer An instance of a configuration writer.
143 * name Attribute name.
145 * Returns zero if the XML element's attribute could be written.
146 * Negative values indicate an error.
149 int config_writer_write_attribute(struct config_writer
*writer
,
150 const char *name
, const char *value
);
153 * Close the current element tag.
155 * writer An instance of a configuration writer.
157 * Returns zero if the XML document could be closed cleanly.
158 * Negative values indicate an error.
161 int config_writer_close_element(struct config_writer
*writer
);
164 * Write an element of type unsigned int.
166 * writer An instance of a configuration writer.
168 * element_name Element name.
170 * value Unsigned int value of the element
172 * Returns zero if the element's value could be written.
173 * Negative values indicate an error.
176 int config_writer_write_element_unsigned_int(struct config_writer
*writer
,
177 const char *element_name
, uint64_t value
);
180 * Write an element of type signed int.
182 * writer An instance of a configuration writer.
184 * element_name Element name.
186 * value Signed int value of the element
188 * Returns zero if the element's value could be written.
189 * Negative values indicate an error.
191 int config_writer_write_element_signed_int(struct config_writer
*writer
,
192 const char *element_name
, int64_t value
);
195 * Write an element of type boolean.
197 * writer An instance of a configuration writer.
199 * element_name Element name.
201 * value Boolean value of the element
203 * Returns zero if the element's value could be written.
204 * Negative values indicate an error.
207 int config_writer_write_element_bool(struct config_writer
*writer
,
208 const char *element_name
, int value
);
211 * Write an element of type string.
213 * writer An instance of a configuration writer.
215 * element_name Element name.
217 * value String value of the element
219 * Returns zero if the element's value could be written.
220 * Negative values indicate an error.
223 int config_writer_write_element_string(struct config_writer
*writer
,
224 const char *element_name
, const char *value
);
227 * Write an element of type config_element.
229 * writer An instance of a configuration writer.
231 * element The config_element instance.
233 * Returns zero if the element could be written.
234 * Negative values indicate an error.
237 int config_writer_write_config_element(struct config_writer
*writer
,
238 const struct config_element
*element
);
240 * Load session configurations from a file.
242 * path Path to an LTTng session configuration file. All *.lttng files
243 * will be loaded if path is a directory. If path is NULL, the default
244 * paths will be searched in the following order:
245 * 1) $HOME/.lttng/sessions
246 * 2) /etc/lttng/sessions
248 * session_name Name of the session to load. Will load all
249 * sessions from path if NULL.
251 * override Override current session configuration if it exists.
252 * autoload Tell to load the auto session(s).
254 * Returns zero if the session could be loaded successfully. Returns
255 * a negative LTTNG_ERR code on error.
258 int config_load_session(const char *path
, const char *session_name
,
259 int override
, unsigned int autoload
);
262 * Load session configuration from a document
264 * document The document to be loaded as a configuration
265 * session_name Name of the session to load. Will load all sessions from the
266 * passed document if NULL
268 * override Override current session configuration if it exists.
270 * Returns zero if the session could be loaded successfully. Returns
271 * a negative LTTNG_ERR code on error.
274 int config_load_configuration_sessions(struct config_document
*document
,
275 const char *session_name
, int override
);
278 * Get the document corresponding to the path.
280 * path Path to a configuration file.
281 * xsd_validation Whether or not to do a xsd validation
283 * Returns an new allocated config_document when successful.
284 * Returns NULL on error;
286 * The caller is responsible of freeing the document via config_document_free.
289 struct config_document
*config_document_get(const char *path
);
292 * Free an allocated document.
294 * document The document to free.
297 void config_document_free(struct config_document
*document
);
300 * Replace the value of a document element
302 * document The document containing the element to be modified.
303 * xpath The xpath string to the element.
304 * value The value to be placed inside the element.
306 * Returns zero if the session could be loaded successfully. Returns
307 * a negative LTTNG_ERR code on error.
310 int config_document_replace_element_value(struct config_document
*document
, const char *xpath
, const char *value
);
313 * Swap a document node by the passed element.
315 * document The document containing the element to be modified.
316 * xpath The xpath string to the element.
317 * element The replacement element.
319 * Returns zero if the session could be loaded successfully. Returns
320 * a negative LTTNG_ERR code on error.
323 int config_document_replace_element(struct config_document
*document
, const char *xpath
, const struct config_element
*element
);
326 * Get the value of a document element.
328 * document The document to be searched.
329 * xpath The xpath string to the element.
331 * Return null if multiple values exists or there is no
332 * value for the passed path.
335 char *config_document_get_element_value(struct config_document
*document
, const char *xpath
);
338 * Check if an element exists inside a document.
340 * document The document to be searched.
341 * xpath The xpath string to the element.
343 * Returns 1 on success and 0 on failure.
346 int config_document_element_exist(struct config_document
*document
, const char *xpath
);
352 void config_element_free(struct config_element
*element
);
355 struct config_element
*config_element_create(const char *name
, const char *value
);
358 * Add a child element to an element.
360 * parent The parent element.
361 * child The element to add as a child.
363 * Returns zero if the session could be loaded successfully. Returns
364 * a negative LTTNG_ERR code on error.
367 int config_element_add_child(struct config_element
*parent
, const struct config_element
*child
);
370 * Insert element to an existing document.
372 * document The document to be modified.
373 * xpath The xpath string to the insertion path.
374 * element The element to be inserted.
376 * Returns zero if the session could be loaded successfully. Returns
377 * a negative LTTNG_ERR code on error.
380 int config_document_insert_element(struct config_document
*document
, const char *xpath
, const struct config_element
*element
);
383 #endif /* _CONFIG_H */