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