/usr/include/lttng/lttng.h is in liblttng-ctl-dev 2.7.1-2~fakesync1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 | /*
* lttng.h
*
* Linux Trace Toolkit Control Library Header File
*
* Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License, version 2.1 only,
* as published by the Free Software Foundation.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef LTTNG_H
#define LTTNG_H
/* Error codes that can be returned by API calls */
#include <lttng/lttng-error.h>
/* Include every LTTng ABI/API available. */
#include <lttng/channel.h>
#include <lttng/domain.h>
#include <lttng/event.h>
#include <lttng/handle.h>
#include <lttng/health.h>
#include <lttng/save.h>
#include <lttng/session.h>
#include <lttng/snapshot.h>
#ifdef __cplusplus
extern "C" {
#endif
enum lttng_calibrate_type {
LTTNG_CALIBRATE_FUNCTION = 0,
};
/* Machine interface output type */
enum lttng_mi_output_type {
LTTNG_MI_XML = 1 /* XML output */
};
#define LTTNG_CALIBRATE_PADDING1 16
struct lttng_calibrate {
enum lttng_calibrate_type type;
char padding[LTTNG_CALIBRATE_PADDING1];
};
/*
* Check if a session daemon is alive.
*
* Return 1 if alive or 0 if not. On error, returns a negative negative LTTng
* error code.
*/
extern int lttng_session_daemon_alive(void);
/*
* Set the tracing group for the *current* flow of execution.
*
* On success, returns 0 else a negative LTTng error code.
*/
extern int lttng_set_tracing_group(const char *name);
/*
* This call registers an "outside consumer" for a session and an lttng domain.
* No consumer will be spawned and all fds/commands will go through the socket
* path given (socket_path).
*
* NOTE that this is not recommended unless you absolutely know what you are
* doing.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_register_consumer(struct lttng_handle *handle,
const char *socket_path);
/*
* Start tracing for *all* domain(s) in the session.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_start_tracing(const char *session_name);
/*
* Stop tracing for *all* domain(s) in the session.
*
* This call will wait for data availability for each domain of the session so
* this can take an abritrary amount of time. However, when returning you have
* the guarantee that the data is ready to be read and analyze. Use the
* _no_wait call below to avoid this behavior.
*
* The session_name can't be NULL.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_stop_tracing(const char *session_name);
/*
* Behave exactly like lttng_stop_tracing but does not wait for data
* availability.
*/
extern int lttng_stop_tracing_no_wait(const char *session_name);
/*
* Calibrate LTTng overhead.
*
* The chan and handle params can not be NULL.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_calibrate(struct lttng_handle *handle,
struct lttng_calibrate *calibrate);
/*
* Set URL for a consumer for a session and domain.
*
* Both data and control URL must be defined. If both URLs are the same, only
* the control URL is used even for network streaming.
*
* Default port are 5342 and 5343 respectively for control and data which uses
* the TCP protocol.
*
* URL format: proto://[HOST|IP][:PORT1[:PORT2]][/TRACE_PATH]
*
* Possible protocols are:
* > file://...
* Local filesystem full path.
*
* > net[6]://...
* This will use the default network transport layer which is TCP for both
* control (PORT1) and data port (PORT2).
*
* > tcp[6]://...
* TCP only streaming. For this one, both data and control URL must be given.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_set_consumer_url(struct lttng_handle *handle,
const char *control_url, const char *data_url);
/*
* For a given session name, this call checks if the data is ready to be read
* or is still being extracted by the consumer(s) (pending) hence not ready to
* be used by any readers.
*
* Return 0 if there is _no_ data pending in the buffers thus having a
* guarantee that the data can be read safely. Else, return 1 if there is still
* traced data is pending. On error, a negative value is returned and readable
* by lttng_strerror().
*/
extern int lttng_data_pending(const char *session_name);
#ifdef __cplusplus
}
#endif
#endif /* LTTNG_H */
|