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