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