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