[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>

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

struct ustctl_consumer_channel *
	ustctl_create_channel(struct ustctl_consumer_channel_attr *attr);
/*
 * 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 */

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

/* 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,
};

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_BASIC_TYPE_PADDING	296
union _ustctl_basic_type {
	struct ustctl_integer_type integer;
	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_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>
74d81a6c MD	24
	25	#ifndef LTTNG_UST_UUID_LEN
	26	#define LTTNG_UST_UUID_LEN 16
	27	#endif
	28
32ce8569 MD	29	/* Default unix socket path */
	30	#define LTTNG_UST_SOCK_FILENAME \
	31	"lttng-ust-sock-" \
	32	__ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
	33
	34	/*
	35	* Shared memory files path are automatically related to shm root, e.g.
	36	* /dev/shm under linux.
	37	*/
	38	#define LTTNG_UST_WAIT_FILENAME \
	39	"lttng-ust-wait-" \
	40	__ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
	41
74d81a6c MD	42	struct lttng_ust_shm_handle;
	43	struct lttng_ust_lib_ring_buffer;
	44
	45	struct ustctl_consumer_channel_attr {
	46	enum lttng_ust_chan_type type;
	47	uint64_t subbuf_size; /* bytes */
	48	uint64_t num_subbuf; /* power of 2 */
	49	int overwrite; /* 1: overwrite, 0: discard */
	50	unsigned int switch_timer_interval; /* usec */
	51	unsigned int read_timer_interval; /* usec */
	52	enum lttng_ust_output output; /* splice, mmap */
	53	unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
	54	} LTTNG_PACKED;
	55
	56	/*
	57	* API used by sessiond.
	58	*/
	59
7bc53e94 MD	60	/*
7bc53e94 MD	61	* Error values: all the following functions return:
c354a72c	62	* >= 0: Success (LTTNG_UST_OK)
7bc53e94 MD	63	* < 0: error code.
7bc53e94 MD	64	*/
1c5e467e	65	int ustctl_register_done(int sock);
f3105c67	66	int ustctl_create_session(int sock);
f3105c67	67	int ustctl_create_event(int sock, struct lttng_ust_event *ev,
61f02aea MD	68	struct lttng_ust_object_data *channel_data,
61f02aea MD	69	struct lttng_ust_object_data **event_data);
f3105c67	70	int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
61f02aea MD	71	struct lttng_ust_object_data *obj_data,
61f02aea MD	72	struct lttng_ust_object_data **context_data);
cd54f6d9 MD	73	int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
cd54f6d9 MD	74	struct lttng_ust_object_data *obj_data);
f3105c67	75
61f02aea MD	76	int ustctl_enable(int sock, struct lttng_ust_object_data *object);
61f02aea MD	77	int ustctl_disable(int sock, struct lttng_ust_object_data *object);
4a6ca058 MD	78	int ustctl_start_session(int sock, int handle);
4a6ca058 MD	79	int ustctl_stop_session(int sock, int handle);
f3105c67	80
b115631f MD	81	/*
	82	* ustctl_tracepoint_list returns a tracepoint list handle, or negative
	83	* error value.
	84	*/
	85	int ustctl_tracepoint_list(int sock);
74d81a6c	86
b115631f MD	87	/*
b115631f MD	88	* ustctl_tracepoint_list_get is used to iterate on the tp list
7bc53e94 MD	89	* handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
7bc53e94 MD	90	* returned.
b115631f MD	91	*/
b115631f MD	92	int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
cbef6901	93	struct lttng_ust_tracepoint_iter *iter);
b115631f	94
40003310 MD	95	/*
	96	* ustctl_tracepoint_field_list returns a tracepoint field list handle,
	97	* or negative error value.
	98	*/
	99	int ustctl_tracepoint_field_list(int sock);
	100
	101	/*
	102	* ustctl_tracepoint_field_list_get is used to iterate on the tp field
7bc53e94 MD	103	* list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
7bc53e94 MD	104	* returned.
40003310 MD	105	*/
	106	int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
	107	struct lttng_ust_field_iter *iter);
	108
f3105c67 MD	109	int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
	110	int ustctl_wait_quiescent(int sock);
	111
f1fffc57 MD	112	int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
f1fffc57 MD	113
f3105c67 MD	114	int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
f3105c67 MD	115
74d81a6c MD	116	/* Release object created by members of this API. */
	117	int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
	118	/* Release handle returned by create session. */
	119	int ustctl_release_handle(int sock, int handle);
	120
	121	int ustctl_recv_channel_from_consumer(int sock,
	122	struct lttng_ust_object_data **channel_data);
	123	int ustctl_recv_stream_from_consumer(int sock,
	124	struct lttng_ust_object_data **stream_data);
	125	int ustctl_send_channel_to_ust(int sock, int session_handle,
	126	struct lttng_ust_object_data *channel_data);
	127	int ustctl_send_stream_to_ust(int sock,
	128	struct lttng_ust_object_data *channel_data,
	129	struct lttng_ust_object_data *stream_data);
	130
12f3dabc MD	131	/*
	132	* ustctl_duplicate_ust_object_data allocated a new object in "dest" if
	133	* it succeeds (returns 0). It must be released using
	134	* ustctl_release_object() and then freed with free().
	135	*/
	136	int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
	137	struct lttng_ust_object_data *src);
	138
f3105c67	139	/*
74d81a6c	140	* API used by consumer.
f3105c67	141	*/
74d81a6c MD	142
	143	struct ustctl_consumer_channel;
	144	struct ustctl_consumer_stream;
	145	struct ustctl_consumer_channel_attr;
	146
	147	struct ustctl_consumer_channel *
	148	ustctl_create_channel(struct ustctl_consumer_channel_attr *attr);
5224b5c8	149	/*
74d81a6c MD	150	* Each stream created needs to be destroyed before calling
74d81a6c MD	151	* ustctl_destroy_channel().
5224b5c8	152	*/
74d81a6c	153	void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
f3105c67	154
74d81a6c MD	155	int ustctl_send_channel_to_sessiond(int sock,
74d81a6c MD	156	struct ustctl_consumer_channel *channel);
ff0f5728 MD	157	int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
	158	int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
	159	int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
	160	int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
c9023c93 MD	161
	162	int ustctl_write_metadata_to_channel(
	163	struct ustctl_consumer_channel *channel,
	164	const char metadata_str, / NOT null-terminated */
	165	size_t len); /* metadata length */
	166
74d81a6c MD	167	/*
	168	* Send a NULL stream to finish iteration over all streams of a given
	169	* channel.
	170	*/
	171	int ustctl_send_stream_to_sessiond(int sock,
	172	struct ustctl_consumer_stream *stream);
	173	int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
	174	int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
ff0f5728 MD	175	int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
ff0f5728 MD	176	int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);
f3105c67	177
74d81a6c MD	178	/* Create/destroy stream buffers for read */
	179	struct ustctl_consumer_stream *
	180	ustctl_create_stream(struct ustctl_consumer_channel *channel,
	181	int cpu);
	182	void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);
f3105c67 MD	183
f3105c67 MD	184	/* For mmap mode, readable without "get" operation */
74d81a6c	185	int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
f3105c67	186	unsigned long *len);
74d81a6c	187	int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
f3105c67 MD	188	unsigned long *len);
	189
	190	/*
	191	* For mmap mode, operate on the current packet (between get/put or
	192	* get_next/put_next).
	193	*/
74d81a6c MD	194	void ustctl_get_mmap_base(struct ustctl_consumer_stream stream);
	195	int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
	196	unsigned long *off);
	197	int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
	198	unsigned long *len);
	199	int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
	200	unsigned long *len);
	201	int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
	202	int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);
f3105c67 MD	203
	204	/* snapshot */
	205
74d81a6c MD	206	int ustctl_snapshot(struct ustctl_consumer_stream *stream);
	207	int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
	208	unsigned long *pos);
	209	int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
	210	unsigned long *pos);
	211	int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
	212	unsigned long *pos);
	213	int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
5f9d3dbc	214
74d81a6c MD	215	void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
74d81a6c MD	216	int producer_active);
f3105c67	217
32ce8569 MD	218	/* event registry management */
	219
	220	enum ustctl_socket_type {
	221	USTCTL_SOCKET_CMD = 0,
	222	USTCTL_SOCKET_NOTIFY = 1,
	223	};
	224
	225	enum ustctl_notify_cmd {
	226	USTCTL_NOTIFY_CMD_EVENT = 0,
	227	USTCTL_NOTIFY_CMD_CHANNEL = 1,
	228	};
	229
	230	enum ustctl_channel_header {
	231	USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
	232	USTCTL_CHANNEL_HEADER_COMPACT = 1,
	233	USTCTL_CHANNEL_HEADER_LARGE = 2,
	234	};
	235
	236	/* event type structures */
	237
	238	enum ustctl_abstract_types {
	239	ustctl_atype_integer,
	240	ustctl_atype_enum,
	241	ustctl_atype_array,
	242	ustctl_atype_sequence,
	243	ustctl_atype_string,
	244	ustctl_atype_float,
	245	NR_USTCTL_ABSTRACT_TYPES,
	246	};
	247
	248	enum ustctl_string_encodings {
	249	ustctl_encode_none = 0,
	250	ustctl_encode_UTF8 = 1,
	251	ustctl_encode_ASCII = 2,
	252	NR_USTCTL_STRING_ENCODINGS,
	253	};
	254
	255	#define USTCTL_UST_INTEGER_TYPE_PADDING 24
	256	struct ustctl_integer_type {
	257	uint32_t size; /* in bits */
	258	uint32_t signedness;
	259	uint32_t reverse_byte_order;
	260	uint32_t base; /* 2, 8, 10, 16, for pretty print */
	261	enum ustctl_string_encodings encoding;
	262	uint16_t alignment; /* in bits */
	263	char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
	264	} LTTNG_PACKED;
	265
	266	#define USTCTL_UST_FLOAT_TYPE_PADDING 24
	267	struct ustctl_float_type {
	268	uint32_t exp_dig; /* exponent digits, in bits */
	269	uint32_t mant_dig; /* mantissa digits, in bits */
	270	uint32_t reverse_byte_order;
	271	uint16_t alignment; /* in bits */
	272	char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
	273	} LTTNG_PACKED;
	274
	275	#define USTCTL_UST_BASIC_TYPE_PADDING 296
	276	union _ustctl_basic_type {
	277	struct ustctl_integer_type integer;
	278	struct {
	279	enum ustctl_string_encodings encoding;
	280	} string;
	281	struct ustctl_float_type _float;
282	char padding[USTCTL_UST_BASIC_TYPE_PADDING];
283	} LTTNG_PACKED;
284
285	struct ustctl_basic_type {
286	enum ustctl_abstract_types atype;
287	union {
288	union _ustctl_basic_type basic;
289	} u;
290	} LTTNG_PACKED;
291
292	#define USTCTL_UST_TYPE_PADDING 128
293	struct ustctl_type {
294	enum ustctl_abstract_types atype;
295	union {
296	union _ustctl_basic_type basic;
297	struct {
298	struct ustctl_basic_type elem_type;
299	uint32_t length; /* num. elems. */
300	} array;
301	struct {
302	struct ustctl_basic_type length_type;
303	struct ustctl_basic_type elem_type;
304	} sequence;
305	char padding[USTCTL_UST_TYPE_PADDING];
306	} u;
307	} LTTNG_PACKED;
308
309	#define USTCTL_UST_FIELD_PADDING 28
310	struct ustctl_field {
311	char name[LTTNG_UST_SYM_NAME_LEN];
312	struct ustctl_type type;
313	char padding[USTCTL_UST_FIELD_PADDING];
314	} LTTNG_PACKED;
315
316	/*
317	* Returns 0 on success, negative error value on error.
318	* If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
319	* the output fields are not populated.
320	*/
321	int ustctl_recv_reg_msg(int sock,
322	enum ustctl_socket_type *type,
323	uint32_t *major,
324	uint32_t *minor,
325	uint32_t *pid,
326	uint32_t *ppid,
327	uint32_t *uid,
328	uint32_t *gid,
329	uint32_t *bits_per_long,
330	uint32_t *uint8_t_alignment,
331	uint32_t *uint16_t_alignment,
332	uint32_t *uint32_t_alignment,
333	uint32_t *uint64_t_alignment,
334	uint32_t *long_alignment,
335	int *byte_order,
336	char name); / size LTTNG_UST_ABI_PROCNAME_LEN */
337
338	/*
339	* Returns 0 on success, negative UST or system error value on error.
340	* Receive the notification command. The "notify_cmd" can then be used
341	* by the caller to find out which ustctl_recv_* function should be
342	* called to receive the notification, and which ustctl_reply_* is
343	* appropriate.
344	*/
345	int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
346
347	/*
348	* Returns 0 on success, negative UST or system error value on error.
349	*/
350	int ustctl_recv_register_event(int sock,
351	int session_objd, / session descriptor (output) */
352	int channel_objd, / channel descriptor (output) */
353	char event_name, /
354	* event name (output,
355	* size LTTNG_UST_SYM_NAME_LEN)
356	*/
357	int *loglevel,
358	char *signature, /
359	* event signature
360	* (output, dynamically
361	* allocated, must be free(3)'d
362	* by the caller if function
363	* returns success.)
364	*/
365	size_t *nr_fields,
366	struct ustctl_field **fields,
367	char **model_emf_uri);
368
369	/*
370	* Returns 0 on success, negative error value on error.
371	*/
372	int ustctl_reply_register_event(int sock,
373	uint32_t id, /* event id (input) */
374	int ret_code); /* return code. 0 ok, negative error */
375
376	/*
377	* Returns 0 on success, negative UST or system error value on error.
378	*/
379	int ustctl_recv_register_channel(int sock,
380	int session_objd, / session descriptor (output) */
381	int channel_objd, / channel descriptor (output) */
382	size_t nr_fields, / context fields */
383	struct ustctl_field **fields);
384
385	/*
386	* Returns 0 on success, negative error value on error.
387	*/
388	int ustctl_reply_register_channel(int sock,
389	uint32_t chan_id,
390	enum ustctl_channel_header header_type,
391	int ret_code); /* return code. 0 ok, negative error */
392
f3105c67	393	#endif /* _LTTNG_UST_CTL_H */