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 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_data_pending(struct lttng_consumer_stream *stream);
  54 void lttng_ustconsumer_close_metadata(struct lttng_ht *ht);
  55 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
  56 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
  57                 uint64_t len, struct lttng_consumer_channel *channel,
  58                 int timer, int wait);
  59 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
  60                 struct lttng_consumer_channel *channel, int timer, int wait);
  61 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
  62                 struct lttng_consumer_stream *metadata);
  63 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
  64                 int producer);
  65 int lttng_ustconsumer_get_current_timestamp(
  66                 struct lttng_consumer_stream *stream, uint64_t *ts);
  67
  68 #else /* HAVE_LIBLTTNG_UST_CTL */
  69
  70 static inline
  71 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
  72                 struct lttng_consumer_local_data *ctx,
  73                 struct lttng_consumer_stream *stream, unsigned long len,
  74                 unsigned long padding)
  75 {
  76         return -ENOSYS;
  77 }
  78
  79 static inline
  80 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
  81                 struct lttng_consumer_local_data *ctx,
  82                 struct lttng_consumer_stream *uststream, unsigned long len,
  83                 unsigned long padding)
  84 {
  85         return -ENOSYS;
  86 }
  87
  88 static inline
  89 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
  90 {
  91         return -ENOSYS;
  92 }
  93
  94 static inline
  95 int lttng_ustconsumer_get_produced_snapshot(
  96                 struct lttng_consumer_stream *stream, 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_consumer_stream *stream,
 150                 unsigned long *off)
 151 {
 152         return -ENOSYS;
 153 }
 154 static inline
 155 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
 156 {
 157         return -ENOSYS;
 158 }
 159 static inline
 160 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
 161 {
 162         return NULL;
 163 }
 164 static inline
 165 void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
 166 {
 167 }
 168 static inline
 169 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
 170 {
 171 }
 172 static inline
 173 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
 174                 uint64_t len, struct lttng_consumer_channel *channel,
 175                 int timer)
 176 {
 177         return -ENOSYS;
 178 }
 179 static inline
 180 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
 181                 struct lttng_consumer_channel *channel, int timer, int wait)
 182 {
 183         return -ENOSYS;
 184 }
 185 static inline
 186 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
 187                 struct lttng_consumer_stream *metadata)
 188 {
 189         return -ENOSYS;
 190 }
 191 static inline
 192 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
 193                 int producer)
 194 {
 195 }
 196 static inline
 197 int lttng_ustconsumer_get_current_timestamp(
 198                 struct lttng_consumer_stream *stream, uint64_t *ts)
 199 {
 200         return -ENOSYS;
 201 }
 202 #endif /* HAVE_LIBLTTNG_UST_CTL */
 203
 204 #endif /* _LTTNG_USTCONSUMER_H */