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