6b507ed99f9a9fa1f2640f0d7a06f25315fd46ee
[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 /*
30 * Take a snapshot for a specific fd
31 *
32 * Returns 0 on success, < 0 on error
33 */
34 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
35 struct lttng_consumer_stream *stream);
36
37 /*
38 * Get the produced position
39 *
40 * Returns 0 on success, < 0 on error
41 */
42 int lttng_ustconsumer_get_produced_snapshot(
43 struct lttng_consumer_local_data *ctx,
44 struct lttng_consumer_stream *stream,
45 unsigned long *pos);
46
47 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
48 int sock, struct pollfd *consumer_sockpoll);
49
50 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
51 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
52 extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
53 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
54
55 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
56 struct lttng_consumer_local_data *ctx);
57 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
58
59 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
60
61 extern int lttng_ustctl_get_mmap_read_offset(
62 struct lttng_ust_shm_handle *handle,
63 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
64
65 #else /* HAVE_LIBLTTNG_UST_CTL */
66
67 static inline
68 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
69 struct lttng_consumer_local_data *ctx,
70 struct lttng_consumer_stream *stream, unsigned long len,
71 unsigned long padding)
72 {
73 return -ENOSYS;
74 }
75
76 static inline
77 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
78 struct lttng_consumer_local_data *ctx,
79 struct lttng_consumer_stream *uststream, unsigned long len,
80 unsigned long padding)
81 {
82 return -ENOSYS;
83 }
84
85 static inline
86 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
87 struct lttng_consumer_stream *stream)
88 {
89 return -ENOSYS;
90 }
91
92 static inline
93 int lttng_ustconsumer_get_produced_snapshot(
94 struct lttng_consumer_local_data *ctx,
95 struct lttng_consumer_stream *stream,
96 unsigned long *pos)
97 {
98 return -ENOSYS;
99 }
100
101 static inline
102 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
103 int sock, struct pollfd *consumer_sockpoll)
104 {
105 return -ENOSYS;
106 }
107
108 static inline
109 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
110 {
111 return -ENOSYS;
112 }
113
114 static inline
115 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
116 {
117 }
118
119 static inline
120 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
121 {
122 return -ENOSYS;
123 }
124
125 static inline
126 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
127 {
128 }
129
130 static inline
131 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
132 struct lttng_consumer_local_data *ctx)
133 {
134 return -ENOSYS;
135 }
136
137 static inline
138 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
139 {
140 return -ENOSYS;
141 }
142
143 static inline
144 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
145 {
146 }
147
148 static inline
149 int lttng_ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
150 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off)
151 {
152 return -ENOSYS;
153 }
154 #endif /* HAVE_LIBLTTNG_UST_CTL */
155
156 #endif /* _LTTNG_USTCONSUMER_H */
This page took 0.048258 seconds and 4 git commands to generate.