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