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