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