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
  34 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
  35                 int sock, struct pollfd *consumer_sockpoll);
  36
  37 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
  38 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
  39 extern int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream);
  40 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
  41
  42 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
  43                 struct lttng_consumer_local_data *ctx);
  44 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
  45
  46 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
  47
  48 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
  49                 unsigned long *off);
  50 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream);
  51 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream);
  52 void lttng_ustconsumer_close_metadata(struct lttng_ht *ht);
  53 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream);
  54
  55 #else /* HAVE_LIBLTTNG_UST_CTL */
  56
  57 static inline
  58 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
  59                 struct lttng_consumer_local_data *ctx,
  60                 struct lttng_consumer_stream *stream, unsigned long len,
  61                 unsigned long padding)
  62 {
  63         return -ENOSYS;
  64 }
  65
  66 static inline
  67 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
  68                 struct lttng_consumer_local_data *ctx,
  69                 struct lttng_consumer_stream *uststream, unsigned long len,
  70                 unsigned long padding)
  71 {
  72         return -ENOSYS;
  73 }
  74
  75 static inline
  76 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream *stream)
  77 {
  78         return -ENOSYS;
  79 }
  80
  81 static inline
  82 int lttng_ustconsumer_get_produced_snapshot(
  83                 struct lttng_consumer_stream *stream, unsigned long *pos)
  84 {
  85         return -ENOSYS;
  86 }
  87
  88 static inline
  89 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
  90                 int sock, struct pollfd *consumer_sockpoll)
  91 {
  92         return -ENOSYS;
  93 }
  94
  95 static inline
  96 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
  97 {
  98         return -ENOSYS;
  99 }
 100
 101 static inline
 102 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
 103 {
 104 }
 105
 106 static inline
 107 int lttng_ustconsumer_add_stream(struct lttng_consumer_stream *stream)
 108 {
 109         return -ENOSYS;
 110 }
 111
 112 static inline
 113 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
 114 {
 115 }
 116
 117 static inline
 118 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
 119                 struct lttng_consumer_local_data *ctx)
 120 {
 121         return -ENOSYS;
 122 }
 123
 124 static inline
 125 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
 126 {
 127         return -ENOSYS;
 128 }
 129
 130 static inline
 131 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
 132 {
 133 }
 134
 135 static inline
 136 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream *stream,
 137                 unsigned long *off)
 138 {
 139         return -ENOSYS;
 140 }
 141 static inline
 142 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream *stream)
 143 {
 144         return -ENOSYS;
 145 }
 146 static inline
 147 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream *stream)
 148 {
 149         return NULL;
 150 }
 151 static inline
 152 void lttng_ustconsumer_close_metadata(struct lttng_ht *ht)
 153 {
 154 }
 155 static inline
 156 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream *stream)
 157 {
 158 }
 159 #endif /* HAVE_LIBLTTNG_UST_CTL */
 160
 161 #endif /* _LTTNG_USTCONSUMER_H */