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