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