include/lttng/lttng.h

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