/usr/include/lttng/session.h is in liblttng-ctl-dev 2.5.2-1.
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 | /*
* Copyright (C) 2014 - David Goulet <dgoulet@efficios.com>
*
* 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_SESSION_H
#define LTTNG_SESSION_H
#ifdef __cplusplus
extern "C" {
#endif
/*
* Basic session information.
*
* The "enabled" field is only used when listing the sessions which indicate if
* it's started or not.
*
* The structures should be initialized to zero before use.
*/
#define LTTNG_SESSION_PADDING1 12
struct lttng_session {
char name[NAME_MAX];
/* The path where traces are written */
char path[PATH_MAX];
uint32_t enabled; /* enabled/started: 1, disabled/stopped: 0 */
uint32_t snapshot_mode;
unsigned int live_timer_interval; /* usec */
char padding[LTTNG_SESSION_PADDING1];
};
/*
* Create a tracing session using a name and an optional URL.
*
* If _url_ is NULL, no consumer is created for the session. The name can't be
* NULL here.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_create_session(const char *name, const char *url);
/*
* Create a tracing session that will exclusively be used for snapshot meaning
* the session will be in no output mode and every channel enabled for that
* session will be set in overwrite mode and in mmap output since splice is not
* supported.
*
* Name can't be NULL. If an url is given, it will be used to create a default
* snapshot output using it as a destination. If NULL, no output will be
* defined and an add-output call will be needed.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_create_session_snapshot(const char *name,
const char *snapshot_url);
/*
* Create a session exclusively used for live reading.
*
* In this mode, the switch-timer parameter is forced for each UST channel, a
* live-switch-timer is enabled for kernel channels, manually setting
* switch-timer is forbidden. Synchronization beacons are sent to the relayd,
* indexes are sent and metadata is checked for each packet.
*
* Name can't be NULL. If no URL is given, the default is to send the data to
* net://127.0.0.1. The timer_interval is in usec and by default set to 1000000
* (1 second).
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_create_session_live(const char *name, const char *url,
unsigned int timer_interval);
/*
* Destroy a tracing session.
*
* The session will not be usable, tracing will be stopped thus buffers will be
* flushed.
*
* The name can't be NULL here.
*
* Return 0 on success else a negative LTTng error code.
*/
extern int lttng_destroy_session(const char *name);
/*
* List all the tracing sessions.
*
* Return the size (number of entries) of the "lttng_session" array. Caller
* must free sessions. On error, a negative LTTng error code is returned.
*/
extern int lttng_list_sessions(struct lttng_session **sessions);
#ifdef __cplusplus
}
#endif
#endif /* LTTNG_SESSION_H */
|