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