[lttng-ust.git] / include / lttng / ust-ctl.h

/*
 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
 * Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 2 of the License only.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef _LTTNG_UST_CTL_H
#define _LTTNG_UST_CTL_H

#include <lttng/ust-abi.h>
#include <sys/types.h>
#include <limits.h>

#ifndef LTTNG_UST_UUID_LEN
#define LTTNG_UST_UUID_LEN	16
#endif

/* Default unix socket path */
#define LTTNG_UST_SOCK_FILENAME					\
	"lttng-ust-sock-"					\
	__ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)

/*
 * Shared memory files path are automatically related to shm root, e.g.
 * /dev/shm under linux.
 */
#define LTTNG_UST_WAIT_FILENAME					\
	"lttng-ust-wait-"					\
	__ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)

struct lttng_ust_shm_handle;
struct lttng_ust_lib_ring_buffer;

struct ustctl_consumer_channel_attr {
	enum lttng_ust_chan_type type;
	uint64_t subbuf_size;			/* bytes */
	uint64_t num_subbuf;			/* power of 2 */
	int overwrite;				/* 1: overwrite, 0: discard */
	unsigned int switch_timer_interval;	/* usec */
	unsigned int read_timer_interval;	/* usec */
	enum lttng_ust_output output;		/* splice, mmap */
	uint32_t chan_id;			/* channel ID */
	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
} LTTNG_PACKED;

/*
 * API used by sessiond.
 */

struct lttng_ust_context_attr {
	enum lttng_ust_context_type ctx;
	union {
		struct lttng_ust_perf_counter_ctx perf_counter;
		struct {
			char *provider_name;
			char *ctx_name;
		} app_ctx;
	} u;
};

/*
 * Error values: all the following functions return:
 * >= 0: Success (LTTNG_UST_OK)
 * < 0: error code.
 */
int ustctl_register_done(int sock);
int ustctl_create_session(int sock);
int ustctl_create_event(int sock, struct lttng_ust_event *ev,
		struct lttng_ust_object_data *channel_data,
		struct lttng_ust_object_data **event_data);
int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
		struct lttng_ust_object_data *obj_data,
		struct lttng_ust_object_data **context_data);
int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
		struct lttng_ust_object_data *obj_data);
int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion,
		struct lttng_ust_object_data *obj_data);

int ustctl_enable(int sock, struct lttng_ust_object_data *object);
int ustctl_disable(int sock, struct lttng_ust_object_data *object);
int ustctl_start_session(int sock, int handle);
int ustctl_stop_session(int sock, int handle);

/*
 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
 * error value.
 */
int ustctl_tracepoint_list(int sock);

/*
 * ustctl_tracepoint_list_get is used to iterate on the tp list
 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 * returned.
 */
int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
		struct lttng_ust_tracepoint_iter *iter);

/*
 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
 * or negative error value.
 */
int ustctl_tracepoint_field_list(int sock);

/*
 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 * returned.
 */
int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
		struct lttng_ust_field_iter *iter);

int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
int ustctl_wait_quiescent(int sock);

int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);

int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);

/* Release object created by members of this API. */
int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
/* Release handle returned by create session. */
int ustctl_release_handle(int sock, int handle);

int ustctl_recv_channel_from_consumer(int sock,
		struct lttng_ust_object_data **channel_data);
int ustctl_recv_stream_from_consumer(int sock,
		struct lttng_ust_object_data **stream_data);
int ustctl_send_channel_to_ust(int sock, int session_handle,
		struct lttng_ust_object_data *channel_data);
int ustctl_send_stream_to_ust(int sock,
		struct lttng_ust_object_data *channel_data,
		struct lttng_ust_object_data *stream_data);

/*
 * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
 * it succeeds (returns 0). It must be released using
 * ustctl_release_object() and then freed with free().
 */
int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
		struct lttng_ust_object_data *src);

/*
 * API used by consumer.
 */

struct ustctl_consumer_channel;
struct ustctl_consumer_stream;
struct ustctl_consumer_channel_attr;

int ustctl_get_nr_stream_per_channel(void);

struct ustctl_consumer_channel *
	ustctl_create_channel(struct ustctl_consumer_channel_attr *attr,
		const int *stream_fds, int nr_stream_fds);
/*
 * Each stream created needs to be destroyed before calling
 * ustctl_destroy_channel().
 */
void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);

int ustctl_send_channel_to_sessiond(int sock,
		struct ustctl_consumer_channel *channel);
int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);

int ustctl_write_metadata_to_channel(
		struct ustctl_consumer_channel *channel,
		const char *metadata_str,	/* NOT null-terminated */
		size_t len);			/* metadata length */
ssize_t ustctl_write_one_packet_to_channel(
		struct ustctl_consumer_channel *channel,
		const char *metadata_str,	/* NOT null-terminated */
		size_t len);			/* metadata length */

/*
 * Send a NULL stream to finish iteration over all streams of a given
 * channel.
 */
int ustctl_send_stream_to_sessiond(int sock,
		struct ustctl_consumer_stream *stream);
int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);

/* Create/destroy stream buffers for read */
struct ustctl_consumer_stream *
	ustctl_create_stream(struct ustctl_consumer_channel *channel,
			int cpu);
void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);

/* For mmap mode, readable without "get" operation */
int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
		unsigned long *len);
int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
		unsigned long *len);

/*
 * For mmap mode, operate on the current packet (between get/put or
 * get_next/put_next).
 */
void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream);
int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
		unsigned long *off);
int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
		unsigned long *len);
int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
		unsigned long *len);
int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);

/* snapshot */

int ustctl_snapshot(struct ustctl_consumer_stream *stream);
int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream *stream);
int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
		unsigned long *pos);
int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
		unsigned long *pos);
int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
		unsigned long *pos);
int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);

void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
		int producer_active);

/* index */
int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
		uint64_t *timestamp_begin);
int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
	uint64_t *timestamp_end);
int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
	uint64_t *events_discarded);
int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
	uint64_t *content_size);
int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
	uint64_t *packet_size);
int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
		uint64_t *stream_id);
int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
		uint64_t *ts);
int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
		uint64_t *seq);
int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
		uint64_t *id);

/* returns whether UST has perf counters support. */
int ustctl_has_perf_counters(void);

/* Regenerate the statedump. */
int ustctl_regenerate_statedump(int sock, int handle);

/* event registry management */

enum ustctl_socket_type {
	USTCTL_SOCKET_CMD = 0,
	USTCTL_SOCKET_NOTIFY = 1,
};

enum ustctl_notify_cmd {
	USTCTL_NOTIFY_CMD_EVENT = 0,
	USTCTL_NOTIFY_CMD_CHANNEL = 1,
	USTCTL_NOTIFY_CMD_ENUM = 2,
};

enum ustctl_channel_header {
	USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
	USTCTL_CHANNEL_HEADER_COMPACT = 1,
	USTCTL_CHANNEL_HEADER_LARGE = 2,
};

/* event type structures */

enum ustctl_abstract_types {
	ustctl_atype_integer,
	ustctl_atype_enum,
	ustctl_atype_array,
	ustctl_atype_sequence,
	ustctl_atype_string,
	ustctl_atype_float,
	ustctl_atype_variant,
	ustctl_atype_struct,
	NR_USTCTL_ABSTRACT_TYPES,
};

enum ustctl_string_encodings {
	ustctl_encode_none = 0,
	ustctl_encode_UTF8 = 1,
	ustctl_encode_ASCII = 2,
	NR_USTCTL_STRING_ENCODINGS,
};

#define USTCTL_UST_INTEGER_TYPE_PADDING	24
struct ustctl_integer_type {
	uint32_t size;		/* in bits */
	uint32_t signedness;
	uint32_t reverse_byte_order;
	uint32_t base;		/* 2, 8, 10, 16, for pretty print */
	int32_t encoding;	/* enum ustctl_string_encodings */
	uint16_t alignment;	/* in bits */
	char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
} LTTNG_PACKED;

#define USTCTL_UST_FLOAT_TYPE_PADDING	24
struct ustctl_float_type {
	uint32_t exp_dig;		/* exponent digits, in bits */
	uint32_t mant_dig;		/* mantissa digits, in bits */
	uint32_t reverse_byte_order;
	uint16_t alignment;	/* in bits */
	char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
} LTTNG_PACKED;

#define USTCTL_UST_ENUM_VALUE_PADDING	15
struct ustctl_enum_value {
	uint64_t value;
	uint8_t signedness;
	char padding[USTCTL_UST_ENUM_VALUE_PADDING];
} LTTNG_PACKED;

enum ustctl_ust_enum_entry_options {
	USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
};

#define USTCTL_UST_ENUM_ENTRY_PADDING	32
struct ustctl_enum_entry {
	struct ustctl_enum_value start, end; /* start and end are inclusive */
	char string[LTTNG_UST_SYM_NAME_LEN];
	union {
		struct {
			uint32_t options;
		} LTTNG_PACKED extra;
		char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
	} u;
} LTTNG_PACKED;

#define USTCTL_UST_BASIC_TYPE_PADDING	296
union _ustctl_basic_type {
	struct ustctl_integer_type integer;
	struct {
		char name[LTTNG_UST_SYM_NAME_LEN];
		struct ustctl_integer_type container_type;
		uint64_t id;	/* enum ID in sessiond. */
	} enumeration;
	struct {
		int32_t encoding;	/* enum ustctl_string_encodings */
	} string;
	struct ustctl_float_type _float;
	char padding[USTCTL_UST_BASIC_TYPE_PADDING];
} LTTNG_PACKED;

struct ustctl_basic_type {
	enum ustctl_abstract_types atype;
	union {
		union _ustctl_basic_type basic;
	} u;
} LTTNG_PACKED;

#define USTCTL_UST_TYPE_PADDING	128
struct ustctl_type {
	enum ustctl_abstract_types atype;
	union {
		union _ustctl_basic_type basic;
		struct {
			struct ustctl_basic_type elem_type;
			uint32_t length;		/* num. elems. */
		} array;
		struct {
			struct ustctl_basic_type length_type;
			struct ustctl_basic_type elem_type;
		} sequence;
		struct {
			uint32_t nr_choices;
			char tag_name[LTTNG_UST_SYM_NAME_LEN];
			/* Followed by nr_choices struct ustctl_field. */
		} variant;
		struct {
			uint32_t nr_fields;
			/* Followed by nr_fields struct ustctl_field. */
		} _struct;
		char padding[USTCTL_UST_TYPE_PADDING];
	} u;
} LTTNG_PACKED;

#define USTCTL_UST_FIELD_PADDING	28
struct ustctl_field {
	char name[LTTNG_UST_SYM_NAME_LEN];
	struct ustctl_type type;
	char padding[USTCTL_UST_FIELD_PADDING];
} LTTNG_PACKED;

/*
 * Returns 0 on success, negative error value on error.
 * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 * the output fields are not populated.
 */
int ustctl_recv_reg_msg(int sock,
	enum ustctl_socket_type *type,
	uint32_t *major,
	uint32_t *minor,
	uint32_t *pid,
	uint32_t *ppid,
	uint32_t *uid,
	uint32_t *gid,
	uint32_t *bits_per_long,
	uint32_t *uint8_t_alignment,
	uint32_t *uint16_t_alignment,
	uint32_t *uint32_t_alignment,
	uint32_t *uint64_t_alignment,
	uint32_t *long_alignment,
	int *byte_order,
	char *name);	/* size LTTNG_UST_ABI_PROCNAME_LEN */

/*
 * Returns 0 on success, negative UST or system error value on error.
 * Receive the notification command. The "notify_cmd" can then be used
 * by the caller to find out which ustctl_recv_* function should be
 * called to receive the notification, and which ustctl_reply_* is
 * appropriate.
 */
int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);

/*
 * Returns 0 on success, negative UST or system error value on error.
 */
int ustctl_recv_register_event(int sock,
	int *session_objd,		/* session descriptor (output) */
	int *channel_objd,		/* channel descriptor (output) */
	char *event_name,		/*
					 * event name (output,
					 * size LTTNG_UST_SYM_NAME_LEN)
					 */
	int *loglevel,
	char **signature,		/*
					 * event signature
					 * (output, dynamically
					 * allocated, must be free(3)'d
					 * by the caller if function
					 * returns success.)
					 */
	size_t *nr_fields,
	struct ustctl_field **fields,
	char **model_emf_uri);

/*
 * Returns 0 on success, negative error value on error.
 */
int ustctl_reply_register_event(int sock,
	uint32_t id,			/* event id (input) */
	int ret_code);			/* return code. 0 ok, negative error */

/*
 * Returns 0 on success, negative UST or system error value on error.
 */
int ustctl_recv_register_enum(int sock,
	int *session_objd,
	char *enum_name,
	struct ustctl_enum_entry **entries,
	size_t *nr_entries);

/*
 * Returns 0 on success, negative error value on error.
 */
int ustctl_reply_register_enum(int sock,
	uint64_t id,			/* enum id (input) */
	int ret_code);

/*
 * Returns 0 on success, negative UST or system error value on error.
 */
int ustctl_recv_register_channel(int sock,
	int *session_objd,		/* session descriptor (output) */
	int *channel_objd,		/* channel descriptor (output) */
	size_t *nr_fields,		/* context fields */
	struct ustctl_field **fields);

/*
 * Returns 0 on success, negative error value on error.
 */
int ustctl_reply_register_channel(int sock,
	uint32_t chan_id,
	enum ustctl_channel_header header_type,
	int ret_code);			/* return code. 0 ok, negative error */

#endif /* _LTTNG_UST_CTL_H */
Commit	Line	Data
f3105c67 MD	1	/*
f3105c67 MD	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
74d81a6c	3	* Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
f3105c67	4	*
e92f3e28 MD	5	* This program is free software; you can redistribute it and/or modify
	6	* it under the terms of the GNU General Public License as published by
	7	* the Free Software Foundation; version 2 of the License only.
f3105c67 MD	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
e92f3e28 MD	14	* You should have received a copy of the GNU General Public License along
	15	* with this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
f3105c67 MD	17	*/
	18
	19	#ifndef _LTTNG_UST_CTL_H
	20	#define _LTTNG_UST_CTL_H
	21
4318ae1b	22	#include <lttng/ust-abi.h>
32ce8569	23	#include <sys/types.h>
a9ff648c	24	#include <limits.h>
74d81a6c MD	25
	26	#ifndef LTTNG_UST_UUID_LEN
	27	#define LTTNG_UST_UUID_LEN 16
	28	#endif
	29
32ce8569 MD	30	/* Default unix socket path */
	31	#define LTTNG_UST_SOCK_FILENAME \
	32	"lttng-ust-sock-" \
	33	__ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
	34
	35	/*
	36	* Shared memory files path are automatically related to shm root, e.g.
	37	* /dev/shm under linux.
	38	*/
	39	#define LTTNG_UST_WAIT_FILENAME \
	40	"lttng-ust-wait-" \
	41	__ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
	42
74d81a6c MD	43	struct lttng_ust_shm_handle;
	44	struct lttng_ust_lib_ring_buffer;
	45
	46	struct ustctl_consumer_channel_attr {
	47	enum lttng_ust_chan_type type;
	48	uint64_t subbuf_size; /* bytes */
	49	uint64_t num_subbuf; /* power of 2 */
	50	int overwrite; /* 1: overwrite, 0: discard */
	51	unsigned int switch_timer_interval; /* usec */
	52	unsigned int read_timer_interval; /* usec */
	53	enum lttng_ust_output output; /* splice, mmap */
6ca18e66	54	uint32_t chan_id; /* channel ID */
74d81a6c MD	55	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
	56	} LTTNG_PACKED;
	57
	58	/*
	59	* API used by sessiond.
	60	*/
	61
53f0df51 JG	62	struct lttng_ust_context_attr {
	63	enum lttng_ust_context_type ctx;
	64	union {
	65	struct lttng_ust_perf_counter_ctx perf_counter;
	66	struct {
	67	char *provider_name;
	68	char *ctx_name;
	69	} app_ctx;
	70	} u;
	71	};
	72
7bc53e94 MD	73	/*
7bc53e94 MD	74	* Error values: all the following functions return:
c354a72c	75	* >= 0: Success (LTTNG_UST_OK)
7bc53e94 MD	76	* < 0: error code.
7bc53e94 MD	77	*/
1c5e467e	78	int ustctl_register_done(int sock);
f3105c67	79	int ustctl_create_session(int sock);
f3105c67	80	int ustctl_create_event(int sock, struct lttng_ust_event *ev,
61f02aea MD	81	struct lttng_ust_object_data *channel_data,
61f02aea MD	82	struct lttng_ust_object_data **event_data);
53f0df51	83	int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
61f02aea MD	84	struct lttng_ust_object_data *obj_data,
61f02aea MD	85	struct lttng_ust_object_data **context_data);
cd54f6d9 MD	86	int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
cd54f6d9 MD	87	struct lttng_ust_object_data *obj_data);
da57c034 JI	88	int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion,
da57c034 JI	89	struct lttng_ust_object_data *obj_data);
f3105c67	90
61f02aea MD	91	int ustctl_enable(int sock, struct lttng_ust_object_data *object);
61f02aea MD	92	int ustctl_disable(int sock, struct lttng_ust_object_data *object);
4a6ca058 MD	93	int ustctl_start_session(int sock, int handle);
4a6ca058 MD	94	int ustctl_stop_session(int sock, int handle);
f3105c67	95
b115631f MD	96	/*
	97	* ustctl_tracepoint_list returns a tracepoint list handle, or negative
	98	* error value.
	99	*/
	100	int ustctl_tracepoint_list(int sock);
74d81a6c	101
b115631f MD	102	/*
b115631f MD	103	* ustctl_tracepoint_list_get is used to iterate on the tp list
7bc53e94 MD	104	* handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
7bc53e94 MD	105	* returned.
b115631f MD	106	*/
b115631f MD	107	int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
cbef6901	108	struct lttng_ust_tracepoint_iter *iter);
b115631f	109
40003310 MD	110	/*
	111	* ustctl_tracepoint_field_list returns a tracepoint field list handle,
	112	* or negative error value.
	113	*/
	114	int ustctl_tracepoint_field_list(int sock);
	115
	116	/*
	117	* ustctl_tracepoint_field_list_get is used to iterate on the tp field
7bc53e94 MD	118	* list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
7bc53e94 MD	119	* returned.
40003310 MD	120	*/
	121	int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
	122	struct lttng_ust_field_iter *iter);
	123
f3105c67 MD	124	int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
	125	int ustctl_wait_quiescent(int sock);
	126
f1fffc57 MD	127	int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
f1fffc57 MD	128
f3105c67 MD	129	int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
f3105c67 MD	130
74d81a6c MD	131	/* Release object created by members of this API. */
	132	int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
	133	/* Release handle returned by create session. */
	134	int ustctl_release_handle(int sock, int handle);
	135
	136	int ustctl_recv_channel_from_consumer(int sock,
	137	struct lttng_ust_object_data **channel_data);
	138	int ustctl_recv_stream_from_consumer(int sock,
	139	struct lttng_ust_object_data **stream_data);
	140	int ustctl_send_channel_to_ust(int sock, int session_handle,
	141	struct lttng_ust_object_data *channel_data);
	142	int ustctl_send_stream_to_ust(int sock,
	143	struct lttng_ust_object_data *channel_data,
	144	struct lttng_ust_object_data *stream_data);
	145
12f3dabc MD	146	/*
	147	* ustctl_duplicate_ust_object_data allocated a new object in "dest" if
	148	* it succeeds (returns 0). It must be released using
	149	* ustctl_release_object() and then freed with free().
	150	*/
	151	int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
	152	struct lttng_ust_object_data *src);
	153
f3105c67	154	/*
74d81a6c	155	* API used by consumer.
f3105c67	156	*/
74d81a6c MD	157
	158	struct ustctl_consumer_channel;
	159	struct ustctl_consumer_stream;
	160	struct ustctl_consumer_channel_attr;
	161
5ea386c3 MD	162	int ustctl_get_nr_stream_per_channel(void);
5ea386c3 MD	163
74d81a6c	164	struct ustctl_consumer_channel *
5ea386c3 MD	165	ustctl_create_channel(struct ustctl_consumer_channel_attr *attr,
5ea386c3 MD	166	const int *stream_fds, int nr_stream_fds);
5224b5c8	167	/*
74d81a6c MD	168	* Each stream created needs to be destroyed before calling
74d81a6c MD	169	* ustctl_destroy_channel().
5224b5c8	170	*/
74d81a6c	171	void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
f3105c67	172
74d81a6c MD	173	int ustctl_send_channel_to_sessiond(int sock,
74d81a6c MD	174	struct ustctl_consumer_channel *channel);
ff0f5728 MD	175	int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
	176	int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
	177	int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
	178	int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
c9023c93 MD	179
	180	int ustctl_write_metadata_to_channel(
	181	struct ustctl_consumer_channel *channel,
	182	const char metadata_str, / NOT null-terminated */
	183	size_t len); /* metadata length */
3ef94b0e JD	184	ssize_t ustctl_write_one_packet_to_channel(
	185	struct ustctl_consumer_channel *channel,
	186	const char metadata_str, / NOT null-terminated */
	187	size_t len); /* metadata length */
c9023c93	188
74d81a6c MD	189	/*
	190	* Send a NULL stream to finish iteration over all streams of a given
	191	* channel.
	192	*/
	193	int ustctl_send_stream_to_sessiond(int sock,
	194	struct ustctl_consumer_stream *stream);
	195	int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
	196	int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
ff0f5728 MD	197	int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
ff0f5728 MD	198	int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);
f3105c67	199
74d81a6c MD	200	/* Create/destroy stream buffers for read */
	201	struct ustctl_consumer_stream *
	202	ustctl_create_stream(struct ustctl_consumer_channel *channel,
	203	int cpu);
	204	void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);
f3105c67 MD	205
f3105c67 MD	206	/* For mmap mode, readable without "get" operation */
74d81a6c	207	int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
f3105c67	208	unsigned long *len);
74d81a6c	209	int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
f3105c67 MD	210	unsigned long *len);
	211
	212	/*
	213	* For mmap mode, operate on the current packet (between get/put or
	214	* get_next/put_next).
	215	*/
74d81a6c MD	216	void ustctl_get_mmap_base(struct ustctl_consumer_stream stream);
	217	int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
	218	unsigned long *off);
	219	int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
	220	unsigned long *len);
	221	int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
	222	unsigned long *len);
	223	int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
	224	int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);
f3105c67 MD	225
	226	/* snapshot */
	227
74d81a6c	228	int ustctl_snapshot(struct ustctl_consumer_stream *stream);
f45930b7	229	int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream *stream);
74d81a6c MD	230	int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
	231	unsigned long *pos);
	232	int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
	233	unsigned long *pos);
	234	int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
	235	unsigned long *pos);
	236	int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
5f9d3dbc	237
74d81a6c MD	238	void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
74d81a6c MD	239	int producer_active);
f3105c67	240
b2f3252a JD	241	/* index */
	242	int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
	243	uint64_t *timestamp_begin);
	244	int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
	245	uint64_t *timestamp_end);
	246	int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
	247	uint64_t *events_discarded);
	248	int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
	249	uint64_t *content_size);
	250	int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
	251	uint64_t *packet_size);
	252	int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
	253	uint64_t *stream_id);
fca361e8 JD	254	int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
fca361e8 JD	255	uint64_t *ts);
1ff31389 JD	256	int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
1ff31389 JD	257	uint64_t *seq);
45a00b05 JD	258	int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
45a00b05 JD	259	uint64_t *id);
b2f3252a	260
57201bb3 MD	261	/* returns whether UST has perf counters support. */
	262	int ustctl_has_perf_counters(void);
	263
f53329f3 JD	264	/* Regenerate the statedump. */
	265	int ustctl_regenerate_statedump(int sock, int handle);
	266
32ce8569 MD	267	/* event registry management */
	268
	269	enum ustctl_socket_type {
	270	USTCTL_SOCKET_CMD = 0,
	271	USTCTL_SOCKET_NOTIFY = 1,
	272	};
	273
	274	enum ustctl_notify_cmd {
	275	USTCTL_NOTIFY_CMD_EVENT = 0,
	276	USTCTL_NOTIFY_CMD_CHANNEL = 1,
c785c634	277	USTCTL_NOTIFY_CMD_ENUM = 2,
32ce8569 MD	278	};
	279
	280	enum ustctl_channel_header {
	281	USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
	282	USTCTL_CHANNEL_HEADER_COMPACT = 1,
	283	USTCTL_CHANNEL_HEADER_LARGE = 2,
	284	};
	285
	286	/* event type structures */
	287
	288	enum ustctl_abstract_types {
	289	ustctl_atype_integer,
	290	ustctl_atype_enum,
	291	ustctl_atype_array,
	292	ustctl_atype_sequence,
	293	ustctl_atype_string,
	294	ustctl_atype_float,
53569322 MD	295	ustctl_atype_variant,
53569322 MD	296	ustctl_atype_struct,
32ce8569 MD	297	NR_USTCTL_ABSTRACT_TYPES,
	298	};
	299
	300	enum ustctl_string_encodings {
	301	ustctl_encode_none = 0,
	302	ustctl_encode_UTF8 = 1,
	303	ustctl_encode_ASCII = 2,
	304	NR_USTCTL_STRING_ENCODINGS,
	305	};
	306
	307	#define USTCTL_UST_INTEGER_TYPE_PADDING 24
	308	struct ustctl_integer_type {
	309	uint32_t size; /* in bits */
	310	uint32_t signedness;
	311	uint32_t reverse_byte_order;
	312	uint32_t base; /* 2, 8, 10, 16, for pretty print */
735ea6a8	313	int32_t encoding; /* enum ustctl_string_encodings */
32ce8569 MD	314	uint16_t alignment; /* in bits */
	315	char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
	316	} LTTNG_PACKED;
	317
	318	#define USTCTL_UST_FLOAT_TYPE_PADDING 24
	319	struct ustctl_float_type {
	320	uint32_t exp_dig; /* exponent digits, in bits */
	321	uint32_t mant_dig; /* mantissa digits, in bits */
	322	uint32_t reverse_byte_order;
	323	uint16_t alignment; /* in bits */
	324	char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
	325	} LTTNG_PACKED;
	326
a6f80644 MD	327	#define USTCTL_UST_ENUM_VALUE_PADDING 15
	328	struct ustctl_enum_value {
	329	uint64_t value;
	330	uint8_t signedness;
	331	char padding[USTCTL_UST_ENUM_VALUE_PADDING];
	332	} LTTNG_PACKED;
	333
3e762260 PP	334	enum ustctl_ust_enum_entry_options {
	335	USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
	336	};
	337
c785c634 MD	338	#define USTCTL_UST_ENUM_ENTRY_PADDING 32
c785c634 MD	339	struct ustctl_enum_entry {
a6f80644	340	struct ustctl_enum_value start, end; /* start and end are inclusive */
c785c634	341	char string[LTTNG_UST_SYM_NAME_LEN];
3e762260 PP	342	union {
	343	struct {
	344	uint32_t options;
	345	} LTTNG_PACKED extra;
	346	char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
	347	} u;
a6f80644	348	} LTTNG_PACKED;
c785c634	349
32ce8569 MD	350	#define USTCTL_UST_BASIC_TYPE_PADDING 296
	351	union _ustctl_basic_type {
	352	struct ustctl_integer_type integer;
c785c634 MD	353	struct {
	354	char name[LTTNG_UST_SYM_NAME_LEN];
	355	struct ustctl_integer_type container_type;
	356	uint64_t id; /* enum ID in sessiond. */
	357	} enumeration;
32ce8569	358	struct {
735ea6a8	359	int32_t encoding; /* enum ustctl_string_encodings */
32ce8569 MD	360	} string;
	361	struct ustctl_float_type _float;
	362	char padding[USTCTL_UST_BASIC_TYPE_PADDING];
	363	} LTTNG_PACKED;
	364
	365	struct ustctl_basic_type {
	366	enum ustctl_abstract_types atype;
	367	union {
	368	union _ustctl_basic_type basic;
	369	} u;
	370	} LTTNG_PACKED;
	371
	372	#define USTCTL_UST_TYPE_PADDING 128
	373	struct ustctl_type {
	374	enum ustctl_abstract_types atype;
	375	union {
	376	union _ustctl_basic_type basic;
	377	struct {
	378	struct ustctl_basic_type elem_type;
	379	uint32_t length; /* num. elems. */
	380	} array;
	381	struct {
	382	struct ustctl_basic_type length_type;
	383	struct ustctl_basic_type elem_type;
	384	} sequence;
53569322 MD	385	struct {
	386	uint32_t nr_choices;
	387	char tag_name[LTTNG_UST_SYM_NAME_LEN];
	388	/* Followed by nr_choices struct ustctl_field. */
	389	} variant;
	390	struct {
	391	uint32_t nr_fields;
	392	/* Followed by nr_fields struct ustctl_field. */
	393	} _struct;
32ce8569 MD	394	char padding[USTCTL_UST_TYPE_PADDING];
	395	} u;
	396	} LTTNG_PACKED;
	397
	398	#define USTCTL_UST_FIELD_PADDING 28
	399	struct ustctl_field {
	400	char name[LTTNG_UST_SYM_NAME_LEN];
	401	struct ustctl_type type;
	402	char padding[USTCTL_UST_FIELD_PADDING];
	403	} LTTNG_PACKED;
	404
	405	/*
	406	* Returns 0 on success, negative error value on error.
	407	* If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
	408	* the output fields are not populated.
	409	*/
	410	int ustctl_recv_reg_msg(int sock,
	411	enum ustctl_socket_type *type,
	412	uint32_t *major,
	413	uint32_t *minor,
	414	uint32_t *pid,
	415	uint32_t *ppid,
	416	uint32_t *uid,
	417	uint32_t *gid,
	418	uint32_t *bits_per_long,
	419	uint32_t *uint8_t_alignment,
	420	uint32_t *uint16_t_alignment,
	421	uint32_t *uint32_t_alignment,
	422	uint32_t *uint64_t_alignment,
	423	uint32_t *long_alignment,
	424	int *byte_order,
	425	char name); / size LTTNG_UST_ABI_PROCNAME_LEN */
	426
	427	/*
	428	* Returns 0 on success, negative UST or system error value on error.
	429	* Receive the notification command. The "notify_cmd" can then be used
	430	* by the caller to find out which ustctl_recv_* function should be
	431	* called to receive the notification, and which ustctl_reply_* is
	432	* appropriate.
	433	*/
	434	int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
	435
	436	/*
	437	* Returns 0 on success, negative UST or system error value on error.
	438	*/
	439	int ustctl_recv_register_event(int sock,
	440	int session_objd, / session descriptor (output) */
	441	int channel_objd, / channel descriptor (output) */
	442	char event_name, /
	443	* event name (output,
	444	* size LTTNG_UST_SYM_NAME_LEN)
	445	*/
	446	int *loglevel,
	447	char *signature, /
	448	* event signature
	449	* (output, dynamically
	450	* allocated, must be free(3)'d
	451	* by the caller if function
	452	* returns success.)
	453	*/
	454	size_t *nr_fields,
	455	struct ustctl_field **fields,
	456	char **model_emf_uri);
	457
458	/*
459	* Returns 0 on success, negative error value on error.
460	*/
461	int ustctl_reply_register_event(int sock,
462	uint32_t id, /* event id (input) */
463	int ret_code); /* return code. 0 ok, negative error */
464
c785c634 MD	465	/*
	466	* Returns 0 on success, negative UST or system error value on error.
	467	*/
	468	int ustctl_recv_register_enum(int sock,
	469	int *session_objd,
	470	char *enum_name,
	471	struct ustctl_enum_entry **entries,
	472	size_t *nr_entries);
	473
	474	/*
	475	* Returns 0 on success, negative error value on error.
	476	*/
	477	int ustctl_reply_register_enum(int sock,
	478	uint64_t id, /* enum id (input) */
	479	int ret_code);
	480
32ce8569 MD	481	/*
	482	* Returns 0 on success, negative UST or system error value on error.
	483	*/
	484	int ustctl_recv_register_channel(int sock,
	485	int session_objd, / session descriptor (output) */
	486	int channel_objd, / channel descriptor (output) */
	487	size_t nr_fields, / context fields */
	488	struct ustctl_field **fields);
	489
	490	/*
	491	* Returns 0 on success, negative error value on error.
	492	*/
	493	int ustctl_reply_register_channel(int sock,
	494	uint32_t chan_id,
	495	enum ustctl_channel_header header_type,
	496	int ret_code); /* return code. 0 ok, negative error */
	497
f3105c67	498	#endif /* _LTTNG_UST_CTL_H */