Kernel-ctl: Expose kernel clear buffer operation
[lttng-tools.git] / src / common / ust-consumer / ust-consumer.h
1 /*
2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 - 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, version 2 only,
7 * as published by the Free Software Foundation.
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_USTCONSUMER_H
20 #define _LTTNG_USTCONSUMER_H
21
22 #include <errno.h>
23
24 #include <common/consumer/consumer.h>
25 #include <stdbool.h>
26
27 #ifdef HAVE_LIBLTTNG_UST_CTL
28
29 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
30 int lttng_ustconsumer_sample_snapshot_positions(
31 struct lttng_consumer_stream *stream);
32
33 int lttng_ustconsumer_get_produced_snapshot(
34 struct lttng_consumer_stream *stream, unsigned long *pos);
35 int lttng_ustconsumer_get_consumed_snapshot(
36 struct lttng_consumer_stream *stream, unsigned long *pos);
37
38 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
39 int sock, struct pollfd *consumer_sockpoll);
40
41 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
42 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
43 extern void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan);
44 extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
45 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
46
47 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
48 struct lttng_consumer_local_data *ctx, bool *rotated);
49 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
50
51 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
52
53 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
54 unsigned long *off);
55 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream);
56 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
57 uint64_t *stream_id);
58 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
59 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht);
60 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
61 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
62 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
63 uint64_t len, uint64_t version,
64 struct lttng_consumer_channel *channel, int timer, int wait);
65 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
66 struct lttng_consumer_channel *channel, int timer, int wait);
67 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
68 struct lttng_consumer_stream *metadata);
69 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
70 int producer);
71 int lttng_ustconsumer_get_current_timestamp(
72 struct lttng_consumer_stream *stream, uint64_t *ts);
73 int lttng_ustconsumer_get_sequence_number(
74 struct lttng_consumer_stream *stream, uint64_t *seq);
75
76 #else /* HAVE_LIBLTTNG_UST_CTL */
77
78 static inline
79 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
80 struct lttng_consumer_local_data *ctx,
81 struct lttng_consumer_stream *stream, unsigned long len,
82 unsigned long padding)
83 {
84 return -ENOSYS;
85 }
86
87 static inline
88 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
89 struct lttng_consumer_local_data *ctx,
90 struct lttng_consumer_stream *uststream, unsigned long len,
91 unsigned long padding)
92 {
93 return -ENOSYS;
94 }
95
96 static inline
97 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
98 {
99 return -ENOSYS;
100 }
101
102 static inline
103 int lttng_ustconsumer_sample_snapshot_positions(
104 struct lttng_consumer_stream *stream)
105 {
106 return -ENOSYS;
107 }
108
109 static inline
110 int lttng_ustconsumer_get_produced_snapshot(
111 struct lttng_consumer_stream *stream, unsigned long *pos)
112 {
113 return -ENOSYS;
114 }
115
116 static inline
117 int lttng_ustconsumer_get_consumed_snapshot(
118 struct lttng_consumer_stream *stream, unsigned long *pos)
119 {
120 return -ENOSYS;
121 }
122
123 static inline
124 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
125 int sock, struct pollfd *consumer_sockpoll)
126 {
127 return -ENOSYS;
128 }
129
130 static inline
131 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
132 {
133 return -ENOSYS;
134 }
135
136 static inline
137 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
138 {
139 }
140
141 static inline
142 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
143 {
144 }
145
146 static inline
147 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
148 {
149 return -ENOSYS;
150 }
151
152 static inline
153 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
154 {
155 }
156
157 static inline
158 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
159 struct lttng_consumer_local_data *ctx, bool *rotated)
160 {
161 return -ENOSYS;
162 }
163
164 static inline
165 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
166 {
167 return -ENOSYS;
168 }
169
170 static inline
171 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
172 {
173 }
174
175 static inline
176 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
177 unsigned long *off)
178 {
179 return -ENOSYS;
180 }
181 static inline
182 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
183 {
184 return -ENOSYS;
185 }
186 static inline
187 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
188 {
189 return NULL;
190 }
191 static inline
192 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
193 {
194 }
195 static inline
196 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
197 {
198 }
199 static inline
200 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
201 {
202 }
203 static inline
204 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
205 uint64_t len, uint64_t version,
206 struct lttng_consumer_channel *channel, int timer)
207 {
208 return -ENOSYS;
209 }
210 static inline
211 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
212 struct lttng_consumer_channel *channel, int timer, int wait)
213 {
214 return -ENOSYS;
215 }
216 static inline
217 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
218 struct lttng_consumer_stream *metadata)
219 {
220 return -ENOSYS;
221 }
222 static inline
223 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
224 int producer)
225 {
226 }
227 static inline
228 int lttng_ustconsumer_get_current_timestamp(
229 struct lttng_consumer_stream *stream, uint64_t *ts)
230 {
231 return -ENOSYS;
232 }
233 static inline
234 int lttng_ustconsumer_get_sequence_number(
235 struct lttng_consumer_stream *stream, uint64_t *seq)
236 {
237 return -ENOSYS;
238 }
239 static inline
240 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
241 uint64_t *stream_id)
242 {
243 return -ENOSYS;
244 }
245 #endif /* HAVE_LIBLTTNG_UST_CTL */
246
247 #endif /* _LTTNG_USTCONSUMER_H */
This page took 0.035369 seconds and 5 git commands to generate.