2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
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.
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.
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.
19 #ifndef _LTTNG_UST_CTL_H
20 #define _LTTNG_UST_CTL_H
22 #include <lttng/ust-abi.h>
25 * Error values: all the following functions return:
26 * >= 0: Sucess (LTTNG_UST_OK)
29 int ustctl_register_done(int sock
);
30 int ustctl_create_session(int sock
);
31 int ustctl_open_metadata(int sock
, int session_handle
,
32 struct lttng_ust_channel_attr
*chops
,
33 struct lttng_ust_object_data
**metadata_data
);
34 int ustctl_create_channel(int sock
, int session_handle
,
35 struct lttng_ust_channel_attr
*chops
,
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
);
39 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
40 struct lttng_ust_object_data
*channel_data
,
41 struct lttng_ust_object_data
**event_data
);
42 int ustctl_add_context(int sock
, struct lttng_ust_context
*ctx
,
43 struct lttng_ust_object_data
*obj_data
,
44 struct lttng_ust_object_data
**context_data
);
45 int ustctl_set_filter(int sock
, struct lttng_ust_filter_bytecode
*bytecode
,
46 struct lttng_ust_object_data
*obj_data
);
48 int ustctl_enable(int sock
, struct lttng_ust_object_data
*object
);
49 int ustctl_disable(int sock
, struct lttng_ust_object_data
*object
);
50 int ustctl_start_session(int sock
, int handle
);
51 int ustctl_stop_session(int sock
, int handle
);
54 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
57 int ustctl_tracepoint_list(int sock
);
59 * ustctl_tracepoint_list_get is used to iterate on the tp list
60 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
63 int ustctl_tracepoint_list_get(int sock
, int tp_list_handle
,
64 struct lttng_ust_tracepoint_iter
*iter
);
67 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
68 * or negative error value.
70 int ustctl_tracepoint_field_list(int sock
);
73 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
74 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
77 int ustctl_tracepoint_field_list_get(int sock
, int tp_field_list_handle
,
78 struct lttng_ust_field_iter
*iter
);
80 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
);
81 int ustctl_wait_quiescent(int sock
);
83 int ustctl_sock_flush_buffer(int sock
, struct lttng_ust_object_data
*object
);
85 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
);
88 * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
89 * consumer to map the objects into its memory space.
91 struct lttng_ust_shm_handle
*ustctl_map_channel(struct lttng_ust_object_data
*chan_data
);
92 int ustctl_add_stream(struct lttng_ust_shm_handle
*lttng_ust_shm_handle
,
93 struct lttng_ust_object_data
*stream_data
);
95 * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
96 * be released after unmapping the handle.
98 void ustctl_unmap_channel(struct lttng_ust_shm_handle
*lttng_ust_shm_handle
);
100 /* Buffer operations */
102 struct lttng_ust_shm_handle
;
103 struct lttng_ust_lib_ring_buffer
;
105 /* Open/close stream buffers for read */
106 struct lttng_ust_lib_ring_buffer
*ustctl_open_stream_read(struct lttng_ust_shm_handle
*handle
,
108 void ustctl_close_stream_read(struct lttng_ust_shm_handle
*handle
,
109 struct lttng_ust_lib_ring_buffer
*buf
);
111 /* For mmap mode, readable without "get" operation */
112 int ustctl_get_mmap_len(struct lttng_ust_shm_handle
*handle
,
113 struct lttng_ust_lib_ring_buffer
*buf
,
115 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle
*handle
,
116 struct lttng_ust_lib_ring_buffer
*buf
,
120 * For mmap mode, operate on the current packet (between get/put or
121 * get_next/put_next).
123 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle
*handle
,
124 struct lttng_ust_lib_ring_buffer
*buf
);
125 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle
*handle
,
126 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *off
);
127 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle
*handle
,
128 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *len
);
129 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle
*handle
,
130 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *len
);
131 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle
*handle
,
132 struct lttng_ust_lib_ring_buffer
*buf
);
133 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle
*handle
,
134 struct lttng_ust_lib_ring_buffer
*buf
);
138 int ustctl_snapshot(struct lttng_ust_shm_handle
*handle
,
139 struct lttng_ust_lib_ring_buffer
*buf
);
140 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle
*handle
,
141 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
);
142 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle
*handle
,
143 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
);
144 int ustctl_get_subbuf(struct lttng_ust_shm_handle
*handle
,
145 struct lttng_ust_lib_ring_buffer
*buf
, unsigned long *pos
);
146 int ustctl_put_subbuf(struct lttng_ust_shm_handle
*handle
,
147 struct lttng_ust_lib_ring_buffer
*buf
);
149 void ustctl_flush_buffer(struct lttng_ust_shm_handle
*handle
,
150 struct lttng_ust_lib_ring_buffer
*buf
,
151 int producer_active
);
153 /* Release object created by members of this API. */
154 int ustctl_release_object(int sock
, struct lttng_ust_object_data
*data
);
155 /* Release handle returned by create session. */
156 int ustctl_release_handle(int sock
, int handle
);
158 #endif /* _LTTNG_UST_CTL_H */