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