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