[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 <sys/types.h>

#include "lttng-ust-abi.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, power of 2 */
	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,
	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 {
		enum ustctl_string_encodings encoding;
	} string;
	struct ustctl_float_type _float;
	struct {
		char name[LTTNG_UST_SYM_NAME_LEN];
	} enumeration;
	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_value,
	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,
	unsigned int *nr_entries);

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