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