include/lttng/lttng.h

   1 /*
   2  * lttng.h
   3  *
   4  * Linux Trace Toolkit Control Library Header File
   5  *
   6  * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
   7  *
   8  * This library is free software; you can redistribute it and/or modify it
   9  * under the terms of the GNU Lesser General Public License, version 2.1 only,
  10  * as published by the Free Software Foundation.
  11  *
  12  * This library is distributed in the hope that it will be useful, but WITHOUT
  13  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
  15  * for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General Public License
  18  * along with this library; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  20  */
  21
  22 #ifndef LTTNG_H
  23 #define LTTNG_H
  24
  25 /* Error codes that can be returned by API calls */
  26 #include <lttng/lttng-error.h>
  27
  28 /* Include every LTTng ABI/API available. */
  29 #include <lttng/channel.h>
  30 #include <lttng/domain.h>
  31 #include <lttng/event.h>
  32 #include <lttng/handle.h>
  33 #include <lttng/health.h>
  34 #include <lttng/save.h>
  35 #include <lttng/session.h>
  36 #include <lttng/snapshot.h>
  37 #include <lttng/endpoint.h>
  38 #include <lttng/action/action.h>
  39 #include <lttng/action/notify.h>
  40 #include <lttng/condition/condition.h>
  41 #include <lttng/condition/buffer-usage.h>
  42 #include <lttng/condition/session-consumed-size.h>
  43 #include <lttng/condition/session-rotation.h>
  44 #include <lttng/condition/evaluation.h>
  45 #include <lttng/notification/channel.h>
  46 #include <lttng/notification/notification.h>
  47 #include <lttng/trigger/trigger.h>
  48 #include <lttng/rotation.h>
  49
  50 #ifdef __cplusplus
  51 extern "C" {
  52 #endif
  53
  54 enum lttng_calibrate_type {
  55         LTTNG_CALIBRATE_FUNCTION              = 0,
  56 };
  57
  58 /* Machine interface output type */
  59 enum lttng_mi_output_type {
  60         LTTNG_MI_XML                          = 1 /* XML output */
  61 };
  62
  63 #define LTTNG_CALIBRATE_PADDING1           16
  64 struct lttng_calibrate {
  65         enum lttng_calibrate_type type;
  66
  67         char padding[LTTNG_CALIBRATE_PADDING1];
  68 };
  69
  70 /*
  71  * Check if a session daemon is alive.
  72  *
  73  * Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
  74  * error code.
  75  */
  76 extern int lttng_session_daemon_alive(void);
  77
  78 /*
  79  * Set the tracing group for the *current* flow of execution.
  80  *
  81  * On success, returns 0 else a negative LTTng error code.
  82  */
  83 extern int lttng_set_tracing_group(const char *name);
  84
  85 /*
  86  * This call registers an "outside consumer" for a session and an lttng domain.
  87  * No consumer will be spawned and all fds/commands will go through the socket
  88  * path given (socket_path).
  89  *
  90  * NOTE that this is not recommended unless you absolutely know what you are
  91  * doing.
  92  *
  93  * Return 0 on success else a negative LTTng error code.
  94  */
  95 extern int lttng_register_consumer(struct lttng_handle *handle,
  96                 const char *socket_path);
  97
  98 /*
  99  * Start tracing for *all* domain(s) in the session.
 100  *
 101  * Return 0 on success else a negative LTTng error code.
 102  */
 103 extern int lttng_start_tracing(const char *session_name);
 104
 105 /*
 106  * Stop tracing for *all* domain(s) in the session.
 107  *
 108  * This call will wait for data availability for each domain of the session so
 109  * this can take an abritrary amount of time. However, when returning you have
 110  * the guarantee that the data is ready to be read and analyze. Use the
 111  * _no_wait call below to avoid this behavior.
 112  *
 113  * The session_name can't be NULL.
 114  *
 115  * Return 0 on success else a negative LTTng error code.
 116  */
 117 extern int lttng_stop_tracing(const char *session_name);
 118
 119 /*
 120  * Behave exactly like lttng_stop_tracing but does not wait for data
 121  * availability.
 122  */
 123 extern int lttng_stop_tracing_no_wait(const char *session_name);
 124
 125 /*
 126  * Deprecated: As of LTTng 2.9, this function always returns
 127  * -LTTNG_ERR_UND.
 128  */
 129 extern int lttng_calibrate(struct lttng_handle *handle,
 130                 struct lttng_calibrate *calibrate);
 131
 132 /*
 133  * Set URL for a consumer for a session and domain.
 134  *
 135  * Both data and control URL must be defined. If both URLs are the same, only
 136  * the control URL is used even for network streaming.
 137  *
 138  * Default port are 5342 and 5343 respectively for control and data which uses
 139  * the TCP protocol.
 140  *
 141  * URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
 142  *
 143  * Possible protocols are:
 144  * > file://...
 145  *   Local filesystem full path.
 146  *
 147  * > net[6]://...
 148  *   This will use the default network transport layer which is TCP for both
 149  *   control (PORT1) and data port (PORT2).
 150  *
 151  * > tcp[6]://...
 152  *   TCP only streaming. For this one, both data and control URL must be given.
 153  *
 154  * Return 0 on success else a negative LTTng error code.
 155  */
 156 extern int lttng_set_consumer_url(struct lttng_handle *handle,
 157                 const char *control_url, const char *data_url);
 158
 159 /*
 160  * For a given session name, this call checks if the data is ready to be read
 161  * or is still being extracted by the consumer(s) (pending) hence not ready to
 162  * be used by any readers.
 163  *
 164  * Return 0 if there is _no_ data pending in the buffers thus having a
 165  * guarantee that the data can be read safely. Else, return 1 if there is still
 166  * traced data is pending. On error, a negative value is returned and readable
 167  * by lttng_strerror().
 168  */
 169 extern int lttng_data_pending(const char *session_name);
 170
 171 /*
 172  * Deprecated, replaced by lttng_regenerate_metadata.
 173  */
 174 LTTNG_DEPRECATED()
 175 extern int lttng_metadata_regenerate(const char *session_name);
 176
 177 /*
 178  * Trigger the regeneration of the metadata for a session.
 179  * The new metadata overwrite the previous one locally or remotely (through
 180  * the lttng-relayd). Only kernel, per-uid and non-live sessions are supported.
 181  * Return 0 on success, a negative LTTng error code on error.
 182  */
 183 extern int lttng_regenerate_metadata(const char *session_name);
 184
 185 /*
 186  * Trigger the regeneration of the statedump for a session. The new statedump
 187  * information is appended to the currently active trace, the session needs to
 188  * be active.
 189  *
 190  * Return 0 on success, a negative LTTng error code on error.
 191  */
 192 extern int lttng_regenerate_statedump(const char *session_name);
 193
 194 #ifdef __cplusplus
 195 }
 196 #endif
 197
 198 #endif /* LTTNG_H */