include/lttng/load.h

   1 /*
   2  * Copyright (C) 2014 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   3  *                      David Goulet <dgoulet@efficios.com>
   4  *
   5  * This library is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU Lesser General Public License, version 2.1 only,
   7  * as published by the Free Software Foundation.
   8  *
   9  * This library is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  12  * for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public License
  15  * along with this library; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  17  */
  18
  19 #ifndef LTTNG_LOAD_H
  20 #define LTTNG_LOAD_H
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 /*
  27  * The lttng_load_session_attr object is opaque to the user. Use the helper
  28  * functions below to use it.
  29  */
  30 struct lttng_load_session_attr;
  31
  32 /*
  33  * Return a newly allocated load session attribute object or NULL on error.
  34  */
  35 struct lttng_load_session_attr *lttng_load_session_attr_create(void);
  36
  37 /*
  38  * Free a given load session attribute object.
  39  */
  40 void lttng_load_session_attr_destroy(struct lttng_load_session_attr *attr);
  41
  42
  43 /*
  44  * Load session attribute getter family of functions.
  45  */
  46
  47 /* Return session name. NULL indicates all sessions must be loaded. */
  48 const char *lttng_load_session_attr_get_session_name(
  49         struct lttng_load_session_attr *attr);
  50 /*
  51  * Return input URL. A NULL value indicates the default session
  52  * configuration location. The URL format used is documented in lttng-create(1).
  53  * NULL indicates that the default session configuration path is used.
  54  */
  55 const char *lttng_load_session_attr_get_input_url(
  56         struct lttng_load_session_attr *attr);
  57
  58 /*
  59  * Return the configuration overwrite attribute. This attribute indicates
  60  * whether or not the loaded session should be loaded even if a session with the
  61  * same name already exists. If such a session exists, it is destroyed before
  62  * the replacement is loaded.
  63  */
  64 int lttng_load_session_attr_get_overwrite(
  65         struct lttng_load_session_attr *attr);
  66
  67 /*
  68  * Return the destination URL configuration override attribute. This attribute
  69  * indicates a destination URL override to be applied during the loading of the
  70  * configuration.
  71  *
  72  * NULL indicates no override will be applied on configuration load.
  73  */
  74 const char *lttng_load_session_attr_get_override_url(
  75         struct lttng_load_session_attr *attr);
  76
  77 /*
  78  * Return the configuration override control URL attribute. This attribute
  79  * indicates a control URL override to be applied during the loading of the
  80  * configuration(s).
  81  *
  82  * NULL indicates no control URL override will be applied on configuration load.
  83  */
  84 const char *lttng_load_session_attr_get_override_ctrl_url(
  85         struct lttng_load_session_attr *attr);
  86
  87 /*
  88  * Return the configuration override data URL attribute. This attribute
  89  * indicate a data URL override to be applied during the loading of the
  90  * configuration(s).
  91  *
  92  * NULL indicates no data URL override will be applied on configuration load.
  93  */
  94 const char *lttng_load_session_attr_get_override_data_url(
  95         struct lttng_load_session_attr *attr);
  96
  97 /*
  98  * Load session attribute setter family of functions.
  99  *
 100  * For every set* call, 0 is returned on success or else -LTTNG_ERR_INVALID is
 101  * returned indicating that at least one given parameter is invalid.
 102  */
 103
 104 /*
 105  * Set the name of the session to load. A NULL name means all sessions
 106  * found at the input URL will be loaded.
 107  */
 108 int lttng_load_session_attr_set_session_name(
 109         struct lttng_load_session_attr *attr, const char *session_name);
 110
 111 /*
 112  * Set the URL of the session configuration to load. A NULL value indicates the
 113  * use of the default session configuration location.
 114  *
 115  * Note that file:// is the only supported URL format.
 116  */
 117 int lttng_load_session_attr_set_input_url(
 118         struct lttng_load_session_attr *attr, const char *url);
 119
 120 /*
 121  * Set the overwrite attribute. If set to true, current sessions matching the
 122  * loaded sessions will be destroyed and be replaced by the session(s) being
 123  * loaded.
 124  */
 125 int lttng_load_session_attr_set_overwrite(
 126         struct lttng_load_session_attr *attr, int overwrite);
 127
 128 /*
 129  * The following setter are for overriding sessions attributes during the
 130  * loading of a configuration files. Those attributes prevail upon those
 131  * specified in the loaded configuration file.
 132  * */
 133
 134 /*
 135  * Set the url override attribute.
 136  *
 137  * Supported format:
 138  *    file://TRACEPATH
 139  *    NETPROTO://(HOST | IPADDR)[:CTRLPORT[:DATAPORT]][/TRACEPATH]
 140  *
 141  *     Where NETPROTO is one of {tcp, tcp6}
 142  *
 143  * See lttng-create(1) for more detail.
 144  */
 145 int lttng_load_session_attr_set_override_url(
 146         struct lttng_load_session_attr *attr, const char *url);
 147
 148 /*
 149  * Set the control url override attribute.
 150  *
 151  * Supported format:
 152  *     NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
 153  *
 154  *     Where NETPROTO is one of {tcp, tcp6}
 155  *
 156  * See lttng-create(1) for more detail.
 157  */
 158 int lttng_load_session_attr_set_override_ctrl_url(
 159         struct lttng_load_session_attr *attr, const char *url);
 160
 161 /*
 162  * Set the data url override attribute.
 163  *
 164  * Supported format:
 165  *     NETPROTO://(HOST | IPADDR)[:PORT][/TRACEPATH]
 166  *
 167  *     Where NETPROTO is one of {tcp, tcp6}
 168  *
 169  * See lttng-create(1) for more detail.
 170  */
 171 int lttng_load_session_attr_set_override_data_url(
 172         struct lttng_load_session_attr *attr, const char *url);
 173
 174 /*
 175  * Load session configuration(s).
 176  *
 177  * The lttng_load_session_attr object must not be NULL. No ownership of the
 178  * object is kept by the function; it must be released by the caller.
 179  *
 180  * Returns 0 on success or a negative LTTNG_ERR value on error.
 181  */
 182 int lttng_load_session(struct lttng_load_session_attr *attr);
 183
 184 #ifdef __cplusplus
 185 }
 186 #endif
 187
 188 #endif /* LTTNG_LOAD_H */