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