Refactor: lttng_ustctl_flush_buffer is a duplicate of lttng_ustconsumer_flush_buffer
[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);
71int lttng_ustconsumer_get_current_timestamp(
72 struct lttng_consumer_stream *stream, uint64_t *ts);
73int lttng_ustconsumer_get_sequence_number(
74 struct lttng_consumer_stream *stream, uint64_t *seq);
75
76#else /* HAVE_LIBLTTNG_UST_CTL */
77
78static inline
79ssize_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
87static inline
88ssize_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
96static inline
97int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
98{
99 return -ENOSYS;
100}
101
102static inline
103int lttng_ustconsumer_sample_snapshot_positions(
104 struct lttng_consumer_stream *stream)
105{
106 return -ENOSYS;
107}
108
109static inline
110int lttng_ustconsumer_get_produced_snapshot(
111 struct lttng_consumer_stream *stream, unsigned long *pos)
112{
113 return -ENOSYS;
114}
115
116static inline
117int lttng_ustconsumer_get_consumed_snapshot(
118 struct lttng_consumer_stream *stream, unsigned long *pos)
119{
120 return -ENOSYS;
121}
122
123static inline
124int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
125 int sock, struct pollfd *consumer_sockpoll)
126{
127 return -ENOSYS;
128}
129
130static inline
131int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
132{
133 return -ENOSYS;
134}
135
136static inline
137void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
138{
139}
140
141static inline
142void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
143{
144}
145
146static inline
147int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
148{
149 return -ENOSYS;
150}
151
152static inline
153void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
154{
155}
156
157static inline
158int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
159 struct lttng_consumer_local_data *ctx, bool *rotated)
160{
161 return -ENOSYS;
162}
163
164static inline
165int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
166{
167 return -ENOSYS;
168}
169
170static inline
171void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
172{
173}
174
175static inline
176int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
177 unsigned long *off)
178{
179 return -ENOSYS;
180}
181static inline
182int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
183{
184 return -ENOSYS;
185}
186static inline
187void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
188{
189 return NULL;
190}
191static inline
192void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
193{
194}
195static inline
196void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
197{
198}
199static inline
200void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
201{
202}
203static inline
204int 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}
210static inline
211int 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}
216static inline
217int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
218 struct lttng_consumer_stream *metadata)
219{
220 return -ENOSYS;
221}
222static inline
223void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
224 int producer)
225{
226}
227static inline
228int lttng_ustconsumer_get_current_timestamp(
229 struct lttng_consumer_stream *stream, uint64_t *ts)
230{
231 return -ENOSYS;
232}
233static inline
234int lttng_ustconsumer_get_sequence_number(
235 struct lttng_consumer_stream *stream, uint64_t *seq)
236{
237 return -ENOSYS;
238}
239static inline
240int 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.024219 seconds and 5 git commands to generate.