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