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  * SPDX-License-Identifier: GPL-2.0-only
   6  *
   7  */
   8
   9 #ifndef _LTTNG_USTCONSUMER_H
  10 #define _LTTNG_USTCONSUMER_H
  11
  12 #include <common/compat/errno.h>
  13 #include <common/consumer/consumer.h>
  14 #include <stdbool.h>
  15
  16 #ifdef HAVE_LIBLTTNG_UST_CTL
  17
  18 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream);
  19 int lttng_ustconsumer_sample_snapshot_positions(
  20                 struct lttng_consumer_stream *stream);
  21
  22 int lttng_ustconsumer_get_produced_snapshot(
  23                 struct lttng_consumer_stream *stream, unsigned long *pos);
  24 int lttng_ustconsumer_get_consumed_snapshot(
  25                 struct lttng_consumer_stream *stream, unsigned long *pos);
  26
  27 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
  28                 int sock, struct pollfd *consumer_sockpoll);
  29
  30 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
  31 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
  32 extern void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan);
  33 extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
  34 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
  35
  36 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
  37                 struct lttng_consumer_local_data *ctx);
  38 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
  39
  40 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
  41
  42 int lttng_ust_flush_buffer(struct lttng_consumer_stream *stream,
  43                 int producer_active);
  44 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
  45                 uint64_t *stream_id);
  46 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
  47 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht);
  48 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata);
  49 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
  50 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
  51                 uint64_t len, uint64_t version,
  52                 struct lttng_consumer_channel *channel, int timer, int wait);
  53 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
  54                 struct lttng_consumer_channel *channel, int timer, int wait);
  55 enum sync_metadata_status lttng_ustconsumer_sync_metadata(
  56                 struct lttng_consumer_local_data *ctx,
  57                 struct lttng_consumer_stream *metadata);
  58 int lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
  59                 int producer);
  60 int lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream);
  61 int lttng_ustconsumer_get_current_timestamp(
  62                 struct lttng_consumer_stream *stream, uint64_t *ts);
  63 int lttng_ustconsumer_get_sequence_number(
  64                 struct lttng_consumer_stream *stream, uint64_t *seq);
  65 void lttng_ustconsumer_sigbus_handle(void *addr);
  66
  67 #else /* HAVE_LIBLTTNG_UST_CTL */
  68
  69 static inline
  70 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
  71                 struct lttng_consumer_local_data *ctx,
  72                 struct lttng_consumer_stream *stream, unsigned long len,
  73                 unsigned long padding)
  74 {
  75         return -ENOSYS;
  76 }
  77
  78 static inline
  79 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
  80                 struct lttng_consumer_local_data *ctx,
  81                 struct lttng_consumer_stream *uststream, unsigned long len,
  82                 unsigned long padding)
  83 {
  84         return -ENOSYS;
  85 }
  86
  87 static inline
  88 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
  89 {
  90         return -ENOSYS;
  91 }
  92
  93 static inline
  94 int lttng_ustconsumer_sample_snapshot_positions(
  95                 struct lttng_consumer_stream *stream)
  96 {
  97         return -ENOSYS;
  98 }
  99
 100 static inline
 101 int lttng_ustconsumer_get_produced_snapshot(
 102                 struct lttng_consumer_stream *stream, unsigned long *pos)
 103 {
 104         return -ENOSYS;
 105 }
 106
 107 static inline
 108 int lttng_ustconsumer_get_consumed_snapshot(
 109                 struct lttng_consumer_stream *stream, unsigned long *pos)
 110 {
 111         return -ENOSYS;
 112 }
 113
 114 static inline
 115 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
 116                 int sock, struct pollfd *consumer_sockpoll)
 117 {
 118         return -ENOSYS;
 119 }
 120
 121 static inline
 122 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
 123 {
 124         return -ENOSYS;
 125 }
 126
 127 static inline
 128 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
 129 {
 130 }
 131
 132 static inline
 133 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel *chan)
 134 {
 135 }
 136
 137 static inline
 138 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
 139 {
 140         return -ENOSYS;
 141 }
 142
 143 static inline
 144 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
 145 {
 146 }
 147
 148 static inline
 149 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
 150                 struct lttng_consumer_local_data *ctx)
 151 {
 152         return -ENOSYS;
 153 }
 154
 155 static inline
 156 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
 157 {
 158         return -ENOSYS;
 159 }
 160
 161 static inline
 162 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
 163 {
 164 }
 165
 166 static inline
 167 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
 168 {
 169         return -ENOSYS;
 170 }
 171 static inline
 172 int lttng_ust_flush_buffer(struct lttng_consumer_stream *stream,
 173                 int producer_active)
 174 {
 175         return -ENOSYS;
 176 }
 177 static inline
 178 void lttng_ustconsumer_close_all_metadata(struct lttng_ht *ht)
 179 {
 180 }
 181 static inline
 182 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel *metadata)
 183 {
 184 }
 185 static inline
 186 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
 187 {
 188 }
 189 static inline
 190 int lttng_ustconsumer_recv_metadata(int sock, uint64_t key, uint64_t offset,
 191                 uint64_t len, uint64_t version,
 192                 struct lttng_consumer_channel *channel, int timer)
 193 {
 194         return -ENOSYS;
 195 }
 196 static inline
 197 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data *ctx,
 198                 struct lttng_consumer_channel *channel, int timer, int wait)
 199 {
 200         return -ENOSYS;
 201 }
 202 static inline
 203 enum sync_metadata_status lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data *ctx,
 204                 struct lttng_consumer_stream *metadata)
 205 {
 206         return SYNC_METADATA_STATUS_ERROR;
 207 }
 208 static inline
 209 int lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream *stream,
 210                 int producer)
 211 {
 212         return -ENOSYS;
 213 }
 214 static inline
 215 int lttng_ustconsumer_clear_buffer(struct lttng_consumer_stream *stream)
 216 {
 217         return -ENOSYS;
 218 }
 219 static inline
 220 int lttng_ustconsumer_get_current_timestamp(
 221                 struct lttng_consumer_stream *stream, uint64_t *ts)
 222 {
 223         return -ENOSYS;
 224 }
 225 static inline
 226 int lttng_ustconsumer_get_sequence_number(
 227                 struct lttng_consumer_stream *stream, uint64_t *seq)
 228 {
 229         return -ENOSYS;
 230 }
 231 static inline
 232 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream *stream,
 233                 uint64_t *stream_id)
 234 {
 235         return -ENOSYS;
 236 }
 237 static inline
 238 void lttng_ustconsumer_sigbus_handle(void *addr)
 239 {
 240 }
 241 #endif /* HAVE_LIBLTTNG_UST_CTL */
 242
 243 #endif /* _LTTNG_USTCONSUMER_H */