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