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