[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.
 */

/*
 * 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 *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_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);

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

/* 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,
	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 */
	enum ustctl_string_encodings encoding;
	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_ENTRY_PADDING	32
struct ustctl_enum_entry {
	uint64_t start, end;		/* start and end are inclusive */
	char string[LTTNG_UST_SYM_NAME_LEN];
	char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
};

#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 {
		enum ustctl_string_encodings encoding;
	} 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;
		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
	1	/*
	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Copyright (C) 2011-2013 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
	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.
	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	*
	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.
	17	*/
	18
	19	#ifndef _LTTNG_UST_CTL_H
	20	#define _LTTNG_UST_CTL_H
	21
	22	#include <lttng/ust-abi.h>
	23	#include <sys/types.h>
	24	#include <limits.h>
	25
	26	#ifndef LTTNG_UST_UUID_LEN
	27	#define LTTNG_UST_UUID_LEN 16
	28	#endif
	29
	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
	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 */
	54	uint32_t chan_id; /* channel ID */
	55	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
	56	} LTTNG_PACKED;
	57
	58	/*
	59	* API used by sessiond.
	60	*/
	61
	62	/*
	63	* Error values: all the following functions return:
	64	* >= 0: Success (LTTNG_UST_OK)
	65	* < 0: error code.
	66	*/
	67	int ustctl_register_done(int sock);
	68	int ustctl_create_session(int sock);
	69	int ustctl_create_event(int sock, struct lttng_ust_event *ev,
	70	struct lttng_ust_object_data *channel_data,
	71	struct lttng_ust_object_data **event_data);
	72	int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
	73	struct lttng_ust_object_data *obj_data,
	74	struct lttng_ust_object_data **context_data);
	75	int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
	76	struct lttng_ust_object_data *obj_data);
	77	int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion,
	78	struct lttng_ust_object_data *obj_data);
	79
	80	int ustctl_enable(int sock, struct lttng_ust_object_data *object);
	81	int ustctl_disable(int sock, struct lttng_ust_object_data *object);
	82	int ustctl_start_session(int sock, int handle);
	83	int ustctl_stop_session(int sock, int handle);
	84
	85	/*
	86	* ustctl_tracepoint_list returns a tracepoint list handle, or negative
	87	* error value.
	88	*/
	89	int ustctl_tracepoint_list(int sock);
	90
	91	/*
	92	* ustctl_tracepoint_list_get is used to iterate on the tp list
	93	* handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
	94	* returned.
	95	*/
	96	int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
	97	struct lttng_ust_tracepoint_iter *iter);
	98
	99	/*
	100	* ustctl_tracepoint_field_list returns a tracepoint field list handle,
	101	* or negative error value.
	102	*/
	103	int ustctl_tracepoint_field_list(int sock);
	104
	105	/*
	106	* ustctl_tracepoint_field_list_get is used to iterate on the tp field
	107	* list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
	108	* returned.
	109	*/
	110	int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
	111	struct lttng_ust_field_iter *iter);
	112
	113	int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
	114	int ustctl_wait_quiescent(int sock);
	115
	116	int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
	117
	118	int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
	119
	120	/* Release object created by members of this API. */
	121	int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
	122	/* Release handle returned by create session. */
	123	int ustctl_release_handle(int sock, int handle);
	124
	125	int ustctl_recv_channel_from_consumer(int sock,
	126	struct lttng_ust_object_data **channel_data);
	127	int ustctl_recv_stream_from_consumer(int sock,
	128	struct lttng_ust_object_data **stream_data);
	129	int ustctl_send_channel_to_ust(int sock, int session_handle,
	130	struct lttng_ust_object_data *channel_data);
	131	int ustctl_send_stream_to_ust(int sock,
	132	struct lttng_ust_object_data *channel_data,
	133	struct lttng_ust_object_data *stream_data);
	134
	135	/*
	136	* ustctl_duplicate_ust_object_data allocated a new object in "dest" if
	137	* it succeeds (returns 0). It must be released using
	138	* ustctl_release_object() and then freed with free().
	139	*/
	140	int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
	141	struct lttng_ust_object_data *src);
	142
	143	/*
	144	* API used by consumer.
	145	*/
	146
	147	struct ustctl_consumer_channel;
	148	struct ustctl_consumer_stream;
	149	struct ustctl_consumer_channel_attr;
	150
	151	int ustctl_get_nr_stream_per_channel(void);
	152
	153	struct ustctl_consumer_channel *
	154	ustctl_create_channel(struct ustctl_consumer_channel_attr *attr,
	155	const int *stream_fds, int nr_stream_fds);
	156	/*
	157	* Each stream created needs to be destroyed before calling
	158	* ustctl_destroy_channel().
	159	*/
	160	void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
	161
	162	int ustctl_send_channel_to_sessiond(int sock,
	163	struct ustctl_consumer_channel *channel);
	164	int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
	165	int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
	166	int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
	167	int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
	168
	169	int ustctl_write_metadata_to_channel(
	170	struct ustctl_consumer_channel *channel,
	171	const char metadata_str, / NOT null-terminated */
	172	size_t len); /* metadata length */
	173	ssize_t ustctl_write_one_packet_to_channel(
	174	struct ustctl_consumer_channel *channel,
	175	const char metadata_str, / NOT null-terminated */
	176	size_t len); /* metadata length */
	177
	178	/*
	179	* Send a NULL stream to finish iteration over all streams of a given
	180	* channel.
	181	*/
	182	int ustctl_send_stream_to_sessiond(int sock,
	183	struct ustctl_consumer_stream *stream);
	184	int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
	185	int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
	186	int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
	187	int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);
	188
	189	/* Create/destroy stream buffers for read */
	190	struct ustctl_consumer_stream *
	191	ustctl_create_stream(struct ustctl_consumer_channel *channel,
	192	int cpu);
	193	void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);
	194
	195	/* For mmap mode, readable without "get" operation */
	196	int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
	197	unsigned long *len);
	198	int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
	199	unsigned long *len);
	200
	201	/*
	202	* For mmap mode, operate on the current packet (between get/put or
	203	* get_next/put_next).
	204	*/
	205	void ustctl_get_mmap_base(struct ustctl_consumer_stream stream);
	206	int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
	207	unsigned long *off);
	208	int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
	209	unsigned long *len);
	210	int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
	211	unsigned long *len);
	212	int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
	213	int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);
	214
	215	/* snapshot */
	216
	217	int ustctl_snapshot(struct ustctl_consumer_stream *stream);
	218	int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
	219	unsigned long *pos);
	220	int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
	221	unsigned long *pos);
	222	int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
	223	unsigned long *pos);
	224	int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
	225
	226	void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
	227	int producer_active);
	228
	229	/* index */
	230	int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
	231	uint64_t *timestamp_begin);
	232	int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
	233	uint64_t *timestamp_end);
	234	int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
	235	uint64_t *events_discarded);
	236	int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
	237	uint64_t *content_size);
	238	int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
	239	uint64_t *packet_size);
	240	int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
	241	uint64_t *stream_id);
	242	int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
	243	uint64_t *ts);
	244
	245	/* returns whether UST has perf counters support. */
	246	int ustctl_has_perf_counters(void);
	247
	248	/* event registry management */
	249
	250	enum ustctl_socket_type {
	251	USTCTL_SOCKET_CMD = 0,
	252	USTCTL_SOCKET_NOTIFY = 1,
	253	};
	254
	255	enum ustctl_notify_cmd {
	256	USTCTL_NOTIFY_CMD_EVENT = 0,
	257	USTCTL_NOTIFY_CMD_CHANNEL = 1,
	258	USTCTL_NOTIFY_CMD_ENUM = 2,
	259	};
	260
	261	enum ustctl_channel_header {
	262	USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
	263	USTCTL_CHANNEL_HEADER_COMPACT = 1,
	264	USTCTL_CHANNEL_HEADER_LARGE = 2,
	265	};
	266
	267	/* event type structures */
	268
	269	enum ustctl_abstract_types {
	270	ustctl_atype_integer,
	271	ustctl_atype_enum,
	272	ustctl_atype_array,
	273	ustctl_atype_sequence,
	274	ustctl_atype_string,
	275	ustctl_atype_float,
	276	NR_USTCTL_ABSTRACT_TYPES,
	277	};
	278
	279	enum ustctl_string_encodings {
	280	ustctl_encode_none = 0,
	281	ustctl_encode_UTF8 = 1,
	282	ustctl_encode_ASCII = 2,
	283	NR_USTCTL_STRING_ENCODINGS,
	284	};
	285
	286	#define USTCTL_UST_INTEGER_TYPE_PADDING 24
	287	struct ustctl_integer_type {
	288	uint32_t size; /* in bits */
	289	uint32_t signedness;
	290	uint32_t reverse_byte_order;
	291	uint32_t base; /* 2, 8, 10, 16, for pretty print */
	292	enum ustctl_string_encodings encoding;
	293	uint16_t alignment; /* in bits */
	294	char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
	295	} LTTNG_PACKED;
	296
	297	#define USTCTL_UST_FLOAT_TYPE_PADDING 24
	298	struct ustctl_float_type {
	299	uint32_t exp_dig; /* exponent digits, in bits */
	300	uint32_t mant_dig; /* mantissa digits, in bits */
	301	uint32_t reverse_byte_order;
	302	uint16_t alignment; /* in bits */
	303	char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
	304	} LTTNG_PACKED;
	305
	306	#define USTCTL_UST_ENUM_ENTRY_PADDING 32
	307	struct ustctl_enum_entry {
	308	uint64_t start, end; /* start and end are inclusive */
	309	char string[LTTNG_UST_SYM_NAME_LEN];
	310	char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
	311	};
	312
	313	#define USTCTL_UST_BASIC_TYPE_PADDING 296
	314	union _ustctl_basic_type {
	315	struct ustctl_integer_type integer;
	316	struct {
	317	char name[LTTNG_UST_SYM_NAME_LEN];
	318	struct ustctl_integer_type container_type;
	319	uint64_t id; /* enum ID in sessiond. */
	320	} enumeration;
	321	struct {
	322	enum ustctl_string_encodings encoding;
	323	} string;
	324	struct ustctl_float_type _float;
	325	char padding[USTCTL_UST_BASIC_TYPE_PADDING];
	326	} LTTNG_PACKED;
	327
	328	struct ustctl_basic_type {
	329	enum ustctl_abstract_types atype;
	330	union {
	331	union _ustctl_basic_type basic;
	332	} u;
	333	} LTTNG_PACKED;
	334
	335	#define USTCTL_UST_TYPE_PADDING 128
	336	struct ustctl_type {
	337	enum ustctl_abstract_types atype;
	338	union {
	339	union _ustctl_basic_type basic;
	340	struct {
	341	struct ustctl_basic_type elem_type;
	342	uint32_t length; /* num. elems. */
	343	} array;
	344	struct {
	345	struct ustctl_basic_type length_type;
	346	struct ustctl_basic_type elem_type;
	347	} sequence;
	348	char padding[USTCTL_UST_TYPE_PADDING];
	349	} u;
	350	} LTTNG_PACKED;
	351
	352	#define USTCTL_UST_FIELD_PADDING 28
	353	struct ustctl_field {
	354	char name[LTTNG_UST_SYM_NAME_LEN];
	355	struct ustctl_type type;
	356	char padding[USTCTL_UST_FIELD_PADDING];
	357	} LTTNG_PACKED;
	358
	359	/*
	360	* Returns 0 on success, negative error value on error.
	361	* If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
	362	* the output fields are not populated.
	363	*/
	364	int ustctl_recv_reg_msg(int sock,
	365	enum ustctl_socket_type *type,
	366	uint32_t *major,
	367	uint32_t *minor,
	368	uint32_t *pid,
	369	uint32_t *ppid,
	370	uint32_t *uid,
	371	uint32_t *gid,
	372	uint32_t *bits_per_long,
	373	uint32_t *uint8_t_alignment,
	374	uint32_t *uint16_t_alignment,
	375	uint32_t *uint32_t_alignment,
	376	uint32_t *uint64_t_alignment,
	377	uint32_t *long_alignment,
	378	int *byte_order,
	379	char name); / size LTTNG_UST_ABI_PROCNAME_LEN */
	380
	381	/*
	382	* Returns 0 on success, negative UST or system error value on error.
	383	* Receive the notification command. The "notify_cmd" can then be used
	384	* by the caller to find out which ustctl_recv_* function should be
	385	* called to receive the notification, and which ustctl_reply_* is
	386	* appropriate.
	387	*/
	388	int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
	389
	390	/*
	391	* Returns 0 on success, negative UST or system error value on error.
	392	*/
	393	int ustctl_recv_register_event(int sock,
	394	int session_objd, / session descriptor (output) */
	395	int channel_objd, / channel descriptor (output) */
	396	char event_name, /
	397	* event name (output,
	398	* size LTTNG_UST_SYM_NAME_LEN)
	399	*/
	400	int *loglevel,
	401	char *signature, /
	402	* event signature
	403	* (output, dynamically
	404	* allocated, must be free(3)'d
	405	* by the caller if function
	406	* returns success.)
	407	*/
	408	size_t *nr_fields,
	409	struct ustctl_field **fields,
	410	char **model_emf_uri);
	411
	412	/*
	413	* Returns 0 on success, negative error value on error.
	414	*/
	415	int ustctl_reply_register_event(int sock,
	416	uint32_t id, /* event id (input) */
	417	int ret_code); /* return code. 0 ok, negative error */
	418
	419	/*
	420	* Returns 0 on success, negative UST or system error value on error.
	421	*/
	422	int ustctl_recv_register_enum(int sock,
	423	int *session_objd,
	424	char *enum_name,
	425	struct ustctl_enum_entry **entries,
	426	size_t *nr_entries);
	427
	428	/*
	429	* Returns 0 on success, negative error value on error.
	430	*/
	431	int ustctl_reply_register_enum(int sock,
	432	uint64_t id, /* enum id (input) */
	433	int ret_code);
	434
	435	/*
	436	* Returns 0 on success, negative UST or system error value on error.
	437	*/
	438	int ustctl_recv_register_channel(int sock,
	439	int session_objd, / session descriptor (output) */
	440	int channel_objd, / channel descriptor (output) */
	441	size_t nr_fields, / context fields */
	442	struct ustctl_field **fields);
	443
	444	/*
	445	* Returns 0 on success, negative error value on error.
	446	*/
	447	int ustctl_reply_register_channel(int sock,
	448	uint32_t chan_id,
	449	enum ustctl_channel_header header_type,
	450	int ret_code); /* return code. 0 ok, negative error */
	451
	452	#endif /* _LTTNG_UST_CTL_H */