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
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
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.
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.
20 #ifndef _LTTNG_UST_CTL_H
21 #define _LTTNG_UST_CTL_H
24 * ust-ctl stub API when UST is not present.
27 #include "lttng-ust-abi.h"
31 * Tracer channel attributes.
33 struct lttng_ust_channel_attr
{
34 int overwrite
; /* 1: overwrite, 0: discard */
35 uint64_t subbuf_size
; /* bytes */
36 uint64_t num_subbuf
; /* power of 2 */
37 unsigned int switch_timer_interval
; /* usec */
38 unsigned int read_timer_interval
; /* usec */
39 enum lttng_ust_output output
; /* splice, mmap */
46 uint64_t memory_map_size
;
50 int ustctl_register_done(int sock
)
55 int ustctl_create_session(int sock
)
60 int ustctl_open_metadata(int sock
, int session_handle
,
61 struct lttng_ust_channel_attr
*chops
,
62 struct object_data
**metadata_data
)
67 int ustctl_create_channel(int sock
, int session_handle
,
68 struct lttng_ust_channel_attr
*chops
,
69 struct object_data
**channel_data
)
74 int ustctl_create_stream(int sock
, struct object_data
*channel_data
,
75 struct object_data
**stream_data
)
80 int ustctl_create_event(int sock
, struct lttng_ust_event
*ev
,
81 struct object_data
*channel_data
,
82 struct object_data
**event_data
)
87 int ustctl_add_context(int sock
, struct lttng_ust_context
*ctx
,
88 struct object_data
*obj_data
,
89 struct object_data
**context_data
)
95 int ustctl_enable(int sock
, struct object_data
*object
)
100 int ustctl_disable(int sock
, struct object_data
*object
)
105 int ustctl_start_session(int sock
, int handle
)
110 int ustctl_stop_session(int sock
, int handle
)
116 int ustctl_tracepoint_list(int sock
) /* not implemented yet */
121 int ustctl_tracer_version(int sock
, struct lttng_ust_tracer_version
*v
)
126 int ustctl_wait_quiescent(int sock
)
131 /* Flush each buffers in this channel */
133 int ustctl_flush_buffer(int sock
, struct object_data
*channel_data
)
138 /* not implemented yet */
139 struct lttng_ust_calibrate
;
141 int ustctl_calibrate(int sock
, struct lttng_ust_calibrate
*calibrate
)
147 * Map channel shm_handle and add streams. Typically performed by the
148 * consumer to map the objects into its memory space.
151 struct shm_handle
*ustctl_map_channel(struct object_data
*chan_data
)
156 int ustctl_add_stream(struct shm_handle
*shm_handle
,
157 struct object_data
*stream_data
)
162 * Note: the object_data from which the shm_handle is derived can only
163 * be released after unmapping the handle.
166 void ustctl_unmap_channel(struct shm_handle
*shm_handle
)
170 /* Buffer operations */
173 struct lib_ring_buffer
;
175 /* Open/close stream buffers for read */
177 struct lib_ring_buffer
*ustctl_open_stream_read(struct shm_handle
*handle
,
183 void ustctl_close_stream_read(struct shm_handle
*handle
,
184 struct lib_ring_buffer
*buf
)
188 /* For mmap mode, readable without "get" operation */
190 int ustctl_get_mmap_len(struct shm_handle
*handle
,
191 struct lib_ring_buffer
*buf
,
197 int ustctl_get_max_subbuf_size(struct shm_handle
*handle
,
198 struct lib_ring_buffer
*buf
,
205 * For mmap mode, operate on the current packet (between get/put or
206 * get_next/put_next).
209 void *ustctl_get_mmap_base(struct shm_handle
*handle
,
210 struct lib_ring_buffer
*buf
)
215 int ustctl_get_mmap_read_offset(struct shm_handle
*handle
,
216 struct lib_ring_buffer
*buf
, unsigned long *off
)
221 int ustctl_get_subbuf_size(struct shm_handle
*handle
,
222 struct lib_ring_buffer
*buf
, unsigned long *len
)
227 int ustctl_get_padded_subbuf_size(struct shm_handle
*handle
,
228 struct lib_ring_buffer
*buf
, unsigned long *len
)
233 int ustctl_get_next_subbuf(struct shm_handle
*handle
,
234 struct lib_ring_buffer
*buf
)
239 int ustctl_put_next_subbuf(struct shm_handle
*handle
,
240 struct lib_ring_buffer
*buf
)
248 int ustctl_snapshot(struct shm_handle
*handle
,
249 struct lib_ring_buffer
*buf
)
254 int ustctl_snapshot_get_consumed(struct shm_handle
*handle
,
255 struct lib_ring_buffer
*buf
, unsigned long *pos
)
260 int ustctl_snapshot_get_produced(struct shm_handle
*handle
,
261 struct lib_ring_buffer
*buf
, unsigned long *pos
)
266 int ustctl_get_subbuf(struct shm_handle
*handle
,
267 struct lib_ring_buffer
*buf
, unsigned long *pos
)
272 int ustctl_put_subbuf(struct shm_handle
*handle
,
273 struct lib_ring_buffer
*buf
)
278 /* Release object created by members of this API */
280 void release_object(int sock
, struct object_data
*data
)
284 #endif /* _LTTNG_UST_CTL_H */
This page took 0.038057 seconds and 5 git commands to generate.