Fix: comment in ust-ctl.h
[lttng-ust.git] / include / lttng / ust-ctl.h
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 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.
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 *
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.
17 */
18
19 #ifndef _LTTNG_UST_CTL_H
20 #define _LTTNG_UST_CTL_H
21
22 #include <lttng/ust-abi.h>
23
24 /*
25 * Error values: all the following functions return:
26 * >= 0: Success (LTTNG_UST_OK)
27 * < 0: error code.
28 */
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_event(int sock, struct lttng_ust_event *ev,
38 struct lttng_ust_object_data *channel_data,
39 struct lttng_ust_object_data **event_data);
40 int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
41 struct lttng_ust_object_data *obj_data,
42 struct lttng_ust_object_data **context_data);
43 int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
44 struct lttng_ust_object_data *obj_data);
45
46 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
47 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
48 int ustctl_start_session(int sock, int handle);
49 int ustctl_stop_session(int sock, int handle);
50
51 /*
52 * Return -LTTNG_UST_ERR_NOENT if no more stream is available for creation.
53 * Return 0 on success.
54 * Return negative error value on system error.
55 * Return positive error value on UST error.
56 */
57 int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
58 struct lttng_ust_object_data **stream_data);
59
60 /*
61 * ustctl_tracepoint_list returns a tracepoint list handle, or negative
62 * error value.
63 */
64 int ustctl_tracepoint_list(int sock);
65 /*
66 * ustctl_tracepoint_list_get is used to iterate on the tp list
67 * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
68 * returned.
69 */
70 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
71 struct lttng_ust_tracepoint_iter *iter);
72
73 /*
74 * ustctl_tracepoint_field_list returns a tracepoint field list handle,
75 * or negative error value.
76 */
77 int ustctl_tracepoint_field_list(int sock);
78
79 /*
80 * ustctl_tracepoint_field_list_get is used to iterate on the tp field
81 * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
82 * returned.
83 */
84 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
85 struct lttng_ust_field_iter *iter);
86
87 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
88 int ustctl_wait_quiescent(int sock);
89
90 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
91
92 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
93
94 /*
95 * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
96 * consumer to map the objects into its memory space.
97 */
98 struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
99 int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
100 struct lttng_ust_object_data *stream_data);
101 /*
102 * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
103 * be released after unmapping the handle.
104 */
105 void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
106
107 /* Buffer operations */
108
109 struct lttng_ust_shm_handle;
110 struct lttng_ust_lib_ring_buffer;
111
112 /* Open/close stream buffers for read */
113 struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
114 int cpu);
115 void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
116 struct lttng_ust_lib_ring_buffer *buf);
117
118 /* For mmap mode, readable without "get" operation */
119 int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
120 struct lttng_ust_lib_ring_buffer *buf,
121 unsigned long *len);
122 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
123 struct lttng_ust_lib_ring_buffer *buf,
124 unsigned long *len);
125
126 /*
127 * For mmap mode, operate on the current packet (between get/put or
128 * get_next/put_next).
129 */
130 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
131 struct lttng_ust_lib_ring_buffer *buf);
132 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
133 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
134 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
135 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
136 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
137 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
138 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
139 struct lttng_ust_lib_ring_buffer *buf);
140 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
141 struct lttng_ust_lib_ring_buffer *buf);
142
143 /* snapshot */
144
145 int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
146 struct lttng_ust_lib_ring_buffer *buf);
147 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
148 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
149 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
150 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
151 int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
152 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
153 int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
154 struct lttng_ust_lib_ring_buffer *buf);
155
156 void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
157 struct lttng_ust_lib_ring_buffer *buf,
158 int producer_active);
159
160 /* Release object created by members of this API. */
161 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
162 /* Release handle returned by create session. */
163 int ustctl_release_handle(int sock, int handle);
164
165 #endif /* _LTTNG_UST_CTL_H */
This page took 0.034901 seconds and 4 git commands to generate.