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_all_metadata(struct lttng_ht *ht);
  55 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
  56 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
  57 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
  58                 uint64_t len, struct lttng_consumer_channel *channel,
  59                 int timer, int wait);
  60 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
  61                 struct lttng_consumer_channel *channel, int timer, int wait);
  62 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
  63                 struct lttng_consumer_stream *metadata);
  64 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
  65                 int producer);
  66 int lttng_ustconsumer_get_current_timestamp(
  67                 struct lttng_consumer_stream *stream, uint64_t *ts);
  68
  69 #else /* HAVE_LIBLTTNG_UST_CTL */
  70
  71 static inline
  72 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
  73                 struct lttng_consumer_local_data *ctx,
  74                 struct lttng_consumer_stream *stream, unsigned long len,
  75                 unsigned long padding)
  76 {
  77         return -ENOSYS;
  78 }
  79
  80 static inline
  81 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
  82                 struct lttng_consumer_local_data *ctx,
  83                 struct lttng_consumer_stream *uststream, unsigned long len,
  84                 unsigned long padding)
  85 {
  86         return -ENOSYS;
  87 }
  88
  89 static inline
  90 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
  91 {
  92         return -ENOSYS;
  93 }
  94
  95 static inline
  96 int lttng_ustconsumer_get_produced_snapshot(
  97                 struct lttng_consumer_stream *stream, unsigned long *pos)
  98 {
  99         return -ENOSYS;
 100 }
 101
 102 static inline
 103 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
 104                 int sock, struct pollfd *consumer_sockpoll)
 105 {
 106         return -ENOSYS;
 107 }
 108
 109 static inline
 110 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
 111 {
 112         return -ENOSYS;
 113 }
 114
 115 static inline
 116 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
 117 {
 118 }
 119
 120 static inline
 121 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
 122 {
 123         return -ENOSYS;
 124 }
 125
 126 static inline
 127 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
 128 {
 129 }
 130
 131 static inline
 132 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
 133                 struct lttng_consumer_local_data *ctx)
 134 {
 135         return -ENOSYS;
 136 }
 137
 138 static inline
 139 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
 140 {
 141         return -ENOSYS;
 142 }
 143
 144 static inline
 145 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
 146 {
 147 }
 148
 149 static inline
 150 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
 151                 unsigned long *off)
 152 {
 153         return -ENOSYS;
 154 }
 155 static inline
 156 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
 157 {
 158         return -ENOSYS;
 159 }
 160 static inline
 161 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
 162 {
 163         return NULL;
 164 }
 165 static inline
 166 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
 167 {
 168 }
 169 static inline
 170 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
 171 {
 172 }
 173 static inline
 174 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
 175 {
 176 }
 177 static inline
 178 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
 179                 uint64_t len, struct lttng_consumer_channel *channel,
 180                 int timer)
 181 {
 182         return -ENOSYS;
 183 }
 184 static inline
 185 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
 186                 struct lttng_consumer_channel *channel, int timer, int wait)
 187 {
 188         return -ENOSYS;
 189 }
 190 static inline
 191 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
 192                 struct lttng_consumer_stream *metadata)
 193 {
 194         return -ENOSYS;
 195 }
 196 static inline
 197 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
 198                 int producer)
 199 {
 200 }
 201 static inline
 202 int lttng_ustconsumer_get_current_timestamp(
 203                 struct lttng_consumer_stream *stream, uint64_t *ts)
 204 {
 205         return -ENOSYS;
 206 }
 207 #endif /* HAVE_LIBLTTNG_UST_CTL */
 208
 209 #endif /* _LTTNG_USTCONSUMER_H */