Add non-root support for UST tracing
[lttng-tools.git] / lttng-sessiond / lttng-ust-ctl.h
... / ...
CommitLineData
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
23#include "lttng-ust-abi.h"
24
25int ustctl_register_done(int sock);
26int ustctl_create_session(int sock);
27int ustctl_open_metadata(int sock, int session_handle,
28 struct lttng_ust_channel_attr *chops,
29 struct lttng_ust_object_data **metadata_data);
30int ustctl_create_channel(int sock, int session_handle,
31 struct lttng_ust_channel_attr *chops,
32 struct lttng_ust_object_data **channel_data);
33int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
34 struct lttng_ust_object_data **stream_data);
35int ustctl_create_event(int sock, struct lttng_ust_event *ev,
36 struct lttng_ust_object_data *channel_data,
37 struct lttng_ust_object_data **event_data);
38int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
39 struct lttng_ust_object_data *obj_data,
40 struct lttng_ust_object_data **context_data);
41
42int ustctl_enable(int sock, struct lttng_ust_object_data *object);
43int ustctl_disable(int sock, struct lttng_ust_object_data *object);
44int ustctl_start_session(int sock, int handle);
45int ustctl_stop_session(int sock, int handle);
46
47/*
48 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
49 * error value.
50 */
51int ustctl_tracepoint_list(int sock);
52/*
53 * ustctl_tracepoint_list_get is used to iterate on the tp list
54 * handle. End is iteration is reached when -ENOENT is returned.
55 */
56int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
57 struct lttng_ust_tracepoint_iter *iter);
58
59int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
60int ustctl_wait_quiescent(int sock);
61
62/* not implemented yet */
63struct lttng_ust_calibrate;
64int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
65
66/*
67 * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
68 * consumer to map the objects into its memory space.
69 */
70struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
71int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
72 struct lttng_ust_object_data *stream_data);
73/*
74 * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
75 * be released after unmapping the handle.
76 */
77void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
78
79/* Buffer operations */
80
81struct lttng_ust_shm_handle;
82struct lttng_ust_lib_ring_buffer;
83
84/* Open/close stream buffers for read */
85struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
86 int cpu);
87void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
88 struct lttng_ust_lib_ring_buffer *buf);
89
90/* For mmap mode, readable without "get" operation */
91int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
92 struct lttng_ust_lib_ring_buffer *buf,
93 unsigned long *len);
94int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
95 struct lttng_ust_lib_ring_buffer *buf,
96 unsigned long *len);
97
98/*
99 * For mmap mode, operate on the current packet (between get/put or
100 * get_next/put_next).
101 */
102void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
103 struct lttng_ust_lib_ring_buffer *buf);
104int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
105 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
106int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
107 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
108int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
109 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
110int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
111 struct lttng_ust_lib_ring_buffer *buf);
112int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
113 struct lttng_ust_lib_ring_buffer *buf);
114
115/* snapshot */
116
117int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
118 struct lttng_ust_lib_ring_buffer *buf);
119int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
120 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
121int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
122 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
123int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
124 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
125int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
126 struct lttng_ust_lib_ring_buffer *buf);
127
128void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
129 struct lttng_ust_lib_ring_buffer *buf,
130 int producer_active);
131
132/* Release object created by members of this API */
133int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
134
135#endif /* _LTTNG_UST_CTL_H */
This page took 0.024551 seconds and 4 git commands to generate.