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