[lttng-ust.git] / include / lttng / ust-ctl.h

/*
 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
 *                      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>

/*
 * Error values: all the following functions return:
 * >= 0: Sucess (LTTNG_UST_OK)
 * < 0: error code.
 */
int ustctl_register_done(int sock);
int ustctl_create_session(int sock);
int ustctl_open_metadata(int sock, int session_handle,
		struct lttng_ust_channel_attr *chops,
		struct lttng_ust_object_data **metadata_data);
int ustctl_create_channel(int sock, int session_handle,
		struct lttng_ust_channel_attr *chops,
		struct lttng_ust_object_data **channel_data);
int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
		struct lttng_ust_object_data **stream_data);
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);

/*
 * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
 * consumer to map the objects into its memory space.
 */
struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
		struct lttng_ust_object_data *stream_data);
/*
 * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
 * be released after unmapping the handle.
 */
void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);

/* Buffer operations */

struct lttng_ust_shm_handle;
struct lttng_ust_lib_ring_buffer;

/* Open/close stream buffers for read */
struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
		int cpu);
void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
                struct lttng_ust_lib_ring_buffer *buf);

/* For mmap mode, readable without "get" operation */
int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf,
		unsigned long *len);
int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf,
		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 lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf);
int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf);
int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf);

/* snapshot */

int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf);
int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf);

void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
		struct lttng_ust_lib_ring_buffer *buf,
		int producer_active);

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

#endif /* _LTTNG_UST_CTL_H */
Commit	Line	Data
f3105c67 MD	1	/*
	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	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>
f3105c67	23
7bc53e94 MD	24	/*
	25	* Error values: all the following functions return:
	26	* >= 0: Sucess (LTTNG_UST_OK)
	27	* < 0: error code.
	28	*/
1c5e467e	29	int ustctl_register_done(int sock);
f3105c67 MD	30	int ustctl_create_session(int sock);
	31	int ustctl_open_metadata(int sock, int session_handle,
	32	struct lttng_ust_channel_attr *chops,
61f02aea	33	struct lttng_ust_object_data **metadata_data);
f3105c67 MD	34	int ustctl_create_channel(int sock, int session_handle,
f3105c67 MD	35	struct lttng_ust_channel_attr *chops,
61f02aea MD	36	struct lttng_ust_object_data **channel_data);
	37	int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
	38	struct lttng_ust_object_data **stream_data);
f3105c67	39	int ustctl_create_event(int sock, struct lttng_ust_event *ev,
61f02aea MD	40	struct lttng_ust_object_data *channel_data,
61f02aea MD	41	struct lttng_ust_object_data **event_data);
f3105c67	42	int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
61f02aea MD	43	struct lttng_ust_object_data *obj_data,
61f02aea MD	44	struct lttng_ust_object_data **context_data);
cd54f6d9 MD	45	int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
cd54f6d9 MD	46	struct lttng_ust_object_data *obj_data);
f3105c67	47
61f02aea MD	48	int ustctl_enable(int sock, struct lttng_ust_object_data *object);
61f02aea MD	49	int ustctl_disable(int sock, struct lttng_ust_object_data *object);
4a6ca058 MD	50	int ustctl_start_session(int sock, int handle);
4a6ca058 MD	51	int ustctl_stop_session(int sock, int handle);
f3105c67	52
b115631f MD	53	/*
	54	* ustctl_tracepoint_list returns a tracepoint list handle, or negative
	55	* error value.
	56	*/
	57	int ustctl_tracepoint_list(int sock);
	58	/*
	59	* ustctl_tracepoint_list_get is used to iterate on the tp list
7bc53e94 MD	60	* handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
7bc53e94 MD	61	* returned.
b115631f MD	62	*/
b115631f MD	63	int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
cbef6901	64	struct lttng_ust_tracepoint_iter *iter);
b115631f	65
40003310 MD	66	/*
	67	* ustctl_tracepoint_field_list returns a tracepoint field list handle,
	68	* or negative error value.
	69	*/
	70	int ustctl_tracepoint_field_list(int sock);
	71
	72	/*
	73	* ustctl_tracepoint_field_list_get is used to iterate on the tp field
7bc53e94 MD	74	* list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
7bc53e94 MD	75	* returned.
40003310 MD	76	*/
	77	int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
	78	struct lttng_ust_field_iter *iter);
	79
f3105c67 MD	80	int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
	81	int ustctl_wait_quiescent(int sock);
	82
f1fffc57 MD	83	int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
f1fffc57 MD	84
f3105c67 MD	85	int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
f3105c67 MD	86
f3105c67	87	/*
38fae1d3	88	* Map channel lttng_ust_shm_handle and add streams. Typically performed by the
f3105c67 MD	89	* consumer to map the objects into its memory space.
f3105c67 MD	90	*/
38fae1d3 MD	91	struct lttng_ust_shm_handle ustctl_map_channel(struct lttng_ust_object_data chan_data);
38fae1d3 MD	92	int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
61f02aea	93	struct lttng_ust_object_data *stream_data);
5224b5c8	94	/*
38fae1d3	95	* Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
5224b5c8 MD	96	* be released after unmapping the handle.
5224b5c8 MD	97	*/
38fae1d3	98	void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
f3105c67 MD	99
	100	/* Buffer operations */
	101
38fae1d3	102	struct lttng_ust_shm_handle;
4cfec15c	103	struct lttng_ust_lib_ring_buffer;
f3105c67	104
6e922b24	105	/* Open/close stream buffers for read */
4cfec15c	106	struct lttng_ust_lib_ring_buffer ustctl_open_stream_read(struct lttng_ust_shm_handle handle,
6e922b24	107	int cpu);
38fae1d3	108	void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
4cfec15c	109	struct lttng_ust_lib_ring_buffer *buf);
6e922b24	110
f3105c67	111	/* For mmap mode, readable without "get" operation */
38fae1d3	112	int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
4cfec15c	113	struct lttng_ust_lib_ring_buffer *buf,
f3105c67	114	unsigned long *len);
38fae1d3	115	int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
4cfec15c	116	struct lttng_ust_lib_ring_buffer *buf,
f3105c67 MD	117	unsigned long *len);
	118
	119	/*
	120	* For mmap mode, operate on the current packet (between get/put or
	121	* get_next/put_next).
	122	*/
38fae1d3	123	void ustctl_get_mmap_base(struct lttng_ust_shm_handle handle,
4cfec15c	124	struct lttng_ust_lib_ring_buffer *buf);
38fae1d3	125	int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
4cfec15c	126	struct lttng_ust_lib_ring_buffer buf, unsigned long off);
38fae1d3	127	int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
4cfec15c	128	struct lttng_ust_lib_ring_buffer buf, unsigned long len);
38fae1d3	129	int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
4cfec15c	130	struct lttng_ust_lib_ring_buffer buf, unsigned long len);
38fae1d3	131	int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
4cfec15c	132	struct lttng_ust_lib_ring_buffer *buf);
38fae1d3	133	int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
4cfec15c	134	struct lttng_ust_lib_ring_buffer *buf);
f3105c67 MD	135
	136	/* snapshot */
	137
38fae1d3	138	int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
4cfec15c	139	struct lttng_ust_lib_ring_buffer *buf);
38fae1d3	140	int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
4cfec15c	141	struct lttng_ust_lib_ring_buffer buf, unsigned long pos);
38fae1d3	142	int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
4cfec15c	143	struct lttng_ust_lib_ring_buffer buf, unsigned long pos);
38fae1d3	144	int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
4cfec15c	145	struct lttng_ust_lib_ring_buffer buf, unsigned long pos);
38fae1d3	146	int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
4cfec15c	147	struct lttng_ust_lib_ring_buffer *buf);
f3105c67	148
02a15cfb	149	void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
b52190f2 MD	150	struct lttng_ust_lib_ring_buffer *buf,
b52190f2 MD	151	int producer_active);
5f9d3dbc	152
2be0e72c	153	/* Release object created by members of this API. */
d26228ae	154	int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
2be0e72c MD	155	/* Release handle returned by create session. */
2be0e72c MD	156	int ustctl_release_handle(int sock, int handle);
f3105c67 MD	157
f3105c67 MD	158	#endif /* _LTTNG_UST_CTL_H */