[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 <limits.h>
#include <stddef.h>
#include <stdint.h>
#include <sys/types.h>

#include <lttng/ust-abi.h>

#ifndef LTTNG_PACKED
#error "LTTNG_PACKED should be defined"
#endif

#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 */
	int64_t blocking_timeout;			/* Blocking timeout (usec) */
} LTTNG_PACKED;

/*
 * API used by sessiond.
 */

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

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

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

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

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

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

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

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

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

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

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

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

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

/*
 * API used by consumer.
 */

struct ustctl_consumer_channel;
struct ustctl_consumer_stream;
struct ustctl_consumer_channel_attr;

int ustctl_get_nr_stream_per_channel(void);

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

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

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

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

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

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

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

/* snapshot */

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

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

/* index */

/*
 * Getters which need to be used on the current packet (between get/put
 * or get_next/put_next.
 */

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_sequence_number(struct ustctl_consumer_stream *stream,
		uint64_t *seq);

/*
 * Getter returning state invariant for the stream, which can be used
 * without "get" operation.
 */

int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
		uint64_t *stream_id);
int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
		uint64_t *id);

/*
 * Getter returning the current timestamp as perceived from the
 * tracer.
 */
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);

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

/* event registry management */

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

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

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

/* event type structures */

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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