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