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 /*
  30  * Mmap the ring buffer, read it and write the data to the tracefile.
  31  *
  32  * Returns the number of bytes written, else negative value on error.
  33  */
  34 extern ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
  35                 struct lttng_consumer_local_data *ctx,
  36                 struct lttng_consumer_stream *stream, unsigned long len);
  37
  38 /* Not implemented */
  39 extern ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
  40                 struct lttng_consumer_local_data *ctx,
  41                 struct lttng_consumer_stream *stream, unsigned long len);
  42
  43 /*
  44  * Take a snapshot for a specific fd
  45  *
  46  * Returns 0 on success, < 0 on error
  47  */
  48 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
  49         struct lttng_consumer_stream *stream);
  50
  51 /*
  52  * Get the produced position
  53  *
  54  * Returns 0 on success, < 0 on error
  55  */
  56 int lttng_ustconsumer_get_produced_snapshot(
  57         struct lttng_consumer_local_data *ctx,
  58         struct lttng_consumer_stream *stream,
  59         unsigned long *pos);
  60
  61 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
  62                 int sock, struct pollfd *consumer_sockpoll);
  63
  64 extern int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan);
  65 extern void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan);
  66 extern int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream);
  67 extern void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream);
  68
  69 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
  70                 struct lttng_consumer_local_data *ctx);
  71 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream);
  72
  73 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream);
  74
  75 int lttng_ustconsumer_check_pipe(struct lttng_consumer_stream *stream,
  76                 struct lttng_consumer_local_data *ctx);
  77
  78 #else /* HAVE_LIBLTTNG_UST_CTL */
  79
  80 static inline
  81 ssize_t lttng_ustconsumer_on_read_subbuffer_mmap(
  82                 struct lttng_consumer_local_data *ctx,
  83                 struct lttng_consumer_stream *stream, unsigned long len)
  84 {
  85         return -ENOSYS;
  86 }
  87
  88 static inline
  89 ssize_t lttng_ustconsumer_on_read_subbuffer_splice(
  90                 struct lttng_consumer_local_data *ctx,
  91                 struct lttng_consumer_stream *uststream, unsigned long len)
  92 {
  93         return -ENOSYS;
  94 }
  95
  96 static inline
  97 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_local_data *ctx,
  98         struct lttng_consumer_stream *stream)
  99 {
 100         return -ENOSYS;
 101 }
 102
 103 static inline
 104 int lttng_ustconsumer_get_produced_snapshot(
 105         struct lttng_consumer_local_data *ctx,
 106         struct lttng_consumer_stream *stream,
 107         unsigned long *pos)
 108 {
 109         return -ENOSYS;
 110 }
 111
 112 static inline
 113 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data *ctx,
 114                 int sock, struct pollfd *consumer_sockpoll)
 115 {
 116         return -ENOSYS;
 117 }
 118
 119 static inline
 120 int lttng_ustconsumer_allocate_channel(struct lttng_consumer_channel *chan)
 121 {
 122         return -ENOSYS;
 123 }
 124
 125 static inline
 126 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel *chan)
 127 {
 128 }
 129
 130 static inline
 131 int lttng_ustconsumer_allocate_stream(struct lttng_consumer_stream *stream)
 132 {
 133         return -ENOSYS;
 134 }
 135
 136 static inline
 137 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream *stream)
 138 {
 139 }
 140
 141 static inline
 142 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream *stream,
 143                 struct lttng_consumer_local_data *ctx)
 144 {
 145         return -ENOSYS;
 146 }
 147
 148 static inline
 149 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream *stream)
 150 {
 151         return -ENOSYS;
 152 }
 153
 154 static inline
 155 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream *stream)
 156 {
 157 }
 158
 159 static inline
 160 int lttng_ustconsumer_check_pipe(struct lttng_consumer_stream *stream,
 161                 struct lttng_consumer_local_data *ctx)
 162 {
 163         return -ENOSYS;
 164 }
 165
 166 #endif /* HAVE_LIBLTTNG_UST_CTL */
 167
 168 #endif /* _LTTNG_USTCONSUMER_H */