[lttng-tools.git] / lttng-sessiond / 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; only version 2
 * of the License.
 *
 * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 */

#ifndef _LTTNG_UST_CTL_H
#define _LTTNG_UST_CTL_H

#include <ust/lttng-ust-abi.h>

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_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);

int ustctl_tracepoint_list(int sock);	/* not implemented yet */
int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
int ustctl_wait_quiescent(int sock);

/* Flush each buffers in this channel */
int ustctl_flush_buffer(int sock, struct lttng_ust_object_data *channel_data);

/* not implemented yet */
struct lttng_ust_calibrate;
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);

/* Release object created by members of this API */
void release_object(int sock, struct lttng_ust_object_data *data);

#endif /* _LTTNG_UST_CTL_H */
Commit	Line	Data
2bdd86d4 MD	1	/*
	2	* Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
	3	* Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public License
	7	* as published by the Free Software Foundation; only version 2
	8	* of the License.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
	18	*/
	19
	20	#ifndef _LTTNG_UST_CTL_H
	21	#define _LTTNG_UST_CTL_H
	22
13161846	23	#include <ust/lttng-ust-abi.h>
2bdd86d4	24
13161846 DG	25	int ustctl_register_done(int sock);
13161846 DG	26	int ustctl_create_session(int sock);
2bdd86d4 MD	27	int ustctl_open_metadata(int sock, int session_handle,
2bdd86d4 MD	28	struct lttng_ust_channel_attr *chops,
13161846	29	struct lttng_ust_object_data **metadata_data);
2bdd86d4 MD	30	int ustctl_create_channel(int sock, int session_handle,
2bdd86d4 MD	31	struct lttng_ust_channel_attr *chops,
13161846 DG	32	struct lttng_ust_object_data **channel_data);
	33	int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
	34	struct lttng_ust_object_data **stream_data);
2bdd86d4	35	int ustctl_create_event(int sock, struct lttng_ust_event *ev,
13161846 DG	36	struct lttng_ust_object_data *channel_data,
13161846 DG	37	struct lttng_ust_object_data **event_data);
2bdd86d4	38	int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
13161846 DG	39	struct lttng_ust_object_data *obj_data,
13161846 DG	40	struct lttng_ust_object_data **context_data);
2bdd86d4	41
13161846 DG	42	int ustctl_enable(int sock, struct lttng_ust_object_data *object);
	43	int ustctl_disable(int sock, struct lttng_ust_object_data *object);
	44	int ustctl_start_session(int sock, int handle);
	45	int ustctl_stop_session(int sock, int handle);
2bdd86d4	46
13161846 DG	47	int ustctl_tracepoint_list(int sock); /* not implemented yet */
	48	int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
	49	int ustctl_wait_quiescent(int sock);
2bdd86d4 MD	50
2bdd86d4 MD	51	/* Flush each buffers in this channel */
13161846	52	int ustctl_flush_buffer(int sock, struct lttng_ust_object_data *channel_data);
2bdd86d4 MD	53
	54	/* not implemented yet */
	55	struct lttng_ust_calibrate;
13161846	56	int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
2bdd86d4 MD	57
2bdd86d4 MD	58	/*
13161846	59	* Map channel lttng_ust_shm_handle and add streams. Typically performed by the
2bdd86d4 MD	60	* consumer to map the objects into its memory space.
2bdd86d4 MD	61	*/
13161846 DG	62	struct lttng_ust_shm_handle ustctl_map_channel(struct lttng_ust_object_data chan_data);
	63	int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
	64	struct lttng_ust_object_data *stream_data);
2bdd86d4	65	/*
13161846	66	* Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
2bdd86d4 MD	67	* be released after unmapping the handle.
2bdd86d4 MD	68	*/
13161846	69	void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
2bdd86d4 MD	70
	71	/* Buffer operations */
	72
13161846 DG	73	struct lttng_ust_shm_handle;
13161846 DG	74	struct lttng_ust_lib_ring_buffer;
2bdd86d4 MD	75
2bdd86d4 MD	76	/* Open/close stream buffers for read */
13161846 DG	77	struct lttng_ust_lib_ring_buffer ustctl_open_stream_read(struct lttng_ust_shm_handle handle,
	78	int cpu);
	79	void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
	80	struct lttng_ust_lib_ring_buffer *buf);
2bdd86d4 MD	81
2bdd86d4 MD	82	/* For mmap mode, readable without "get" operation */
13161846 DG	83	int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
	84	struct lttng_ust_lib_ring_buffer *buf,
	85	unsigned long *len);
	86	int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
	87	struct lttng_ust_lib_ring_buffer *buf,
	88	unsigned long *len);
2bdd86d4 MD	89
	90	/*
	91	* For mmap mode, operate on the current packet (between get/put or
	92	* get_next/put_next).
	93	*/
13161846 DG	94	void ustctl_get_mmap_base(struct lttng_ust_shm_handle handle,
	95	struct lttng_ust_lib_ring_buffer *buf);
	96	int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
	97	struct lttng_ust_lib_ring_buffer buf, unsigned long off);
	98	int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
	99	struct lttng_ust_lib_ring_buffer buf, unsigned long len);
	100	int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
	101	struct lttng_ust_lib_ring_buffer buf, unsigned long len);
	102	int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
	103	struct lttng_ust_lib_ring_buffer *buf);
	104	int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
	105	struct lttng_ust_lib_ring_buffer *buf);
2bdd86d4 MD	106
	107	/* snapshot */
	108
13161846 DG	109	int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
	110	struct lttng_ust_lib_ring_buffer *buf);
	111	int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
	112	struct lttng_ust_lib_ring_buffer buf, unsigned long pos);
	113	int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
	114	struct lttng_ust_lib_ring_buffer buf, unsigned long pos);
	115	int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
	116	struct lttng_ust_lib_ring_buffer buf, unsigned long pos);
	117	int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
	118	struct lttng_ust_lib_ring_buffer *buf);
2bdd86d4 MD	119
2bdd86d4 MD	120	/* Release object created by members of this API */
13161846	121	void release_object(int sock, struct lttng_ust_object_data *data);
2bdd86d4 MD	122
2bdd86d4 MD	123	#endif /* _LTTNG_UST_CTL_H */