217c592d7c9adebaa22892d38c3a20e7b171586c
[lttng-tools.git] / include / lttng / lttng-ustconsumer.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
6 * modify it under the terms of the GNU General Public License
7 * as published by the Free Software Foundation; only version 2
8 * of the License.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20 #ifndef _LTTNG_USTCONSUMER_H
21 #define _LTTNG_USTCONSUMER_H
22
23 #include <config.h>
24 #include <lttng/lttng-consumer.h>
25 #include <errno.h>
26
27 #ifdef HAVE_LIBLTTNG_UST_CTL
28
29 /*
30 * Mmap the ring buffer, read it and write the data to the tracefile.
31 *
32 * Returns the number of bytes written.
33 */
34 extern int lttng_ustconsumer_on_read_subbuffer_mmap(
35 struct lttng_consumer_local_data *ctx,
36 struct lttng_consumer_stream *stream, unsigned long len);
37
38 /* Not implemented */
39 extern int lttng_ustconsumer_on_read_subbuffer_splice(
40 struct lttng_consumer_local_data *ctx,
41 struct lttng_consumer_stream *stream, unsigned long len);
42
43 /*
44 * Take a snapshot for a specific fd
45 *
46 * Returns 0 on success, < 0 on error
47 */
48 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
49 struct lttng_consumer_stream *stream);
50
51 /*
52 * Get the produced position
53 *
54 * Returns 0 on success, < 0 on error
55 */
56 int lttng_ustconsumer_get_produced_snapshot(
57 struct lttng_consumer_local_data *ctx,
58 struct lttng_consumer_stream *stream,
59 unsigned long *pos);
60
61 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
62 int sock, struct pollfd *consumer_sockpoll);
63
64 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
65 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
66 extern int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream);
67 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
68
69 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
70 struct lttng_consumer_local_data *ctx);
71 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
72
73 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
74
75 #else /* HAVE_LIBLTTNG_UST_CTL */
76
77 static inline
78 int lttng_ustconsumer_on_read_subbuffer_mmap(
79 struct lttng_consumer_local_data *ctx,
80 struct lttng_consumer_stream *stream, unsigned long len)
81 {
82 return -ENOSYS;
83 }
84
85 static inline
86 int lttng_ustconsumer_on_read_subbuffer_splice(
87 struct lttng_consumer_local_data *ctx,
88 struct lttng_consumer_stream *uststream, unsigned long len)
89 {
90 return -ENOSYS;
91 }
92
93 static inline
94 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
95 struct lttng_consumer_stream *stream)
96 {
97 return -ENOSYS;
98 }
99
100 static inline
101 int lttng_ustconsumer_get_produced_snapshot(
102 struct lttng_consumer_local_data *ctx,
103 struct lttng_consumer_stream *stream,
104 unsigned long *pos)
105 {
106 return -ENOSYS;
107 }
108
109 static inline
110 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
111 int sock, struct pollfd *consumer_sockpoll)
112 {
113 return -ENOSYS;
114 }
115
116 static inline
117 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
118 {
119 return -ENOSYS;
120 }
121
122 static inline
123 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
124 {
125 }
126
127 static inline
128 int lttng_ustconsumer_allocate_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 #endif /* HAVE_LIBLTTNG_UST_CTL */
157
158 #endif /* _LTTNG_USTCONSUMER_H */
This page took 0.034844 seconds and 5 git commands to generate.