lttng-sessiond/lttng-ust-ctl.h

   1 /*
   2  * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
   3  *                      Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; only version 2
   8  * of the License.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18  */
  19
  20 #ifndef _LTTNG_UST_CTL_H
  21 #define _LTTNG_UST_CTL_H
  22
  23 #include "lttng-ust-abi.h"
  24
  25 int ustctl_register_done(int sock);
  26 int ustctl_create_session(int sock);
  27 int ustctl_open_metadata(int sock, int session_handle,
  28                 struct lttng_ust_channel_attr *chops,
  29                 struct lttng_ust_object_data **metadata_data);
  30 int ustctl_create_channel(int sock, int session_handle,
  31                 struct lttng_ust_channel_attr *chops,
  32                 struct lttng_ust_object_data **channel_data);
  33 int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
  34                 struct lttng_ust_object_data **stream_data);
  35 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
  36                 struct lttng_ust_object_data *channel_data,
  37                 struct lttng_ust_object_data **event_data);
  38 int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
  39                 struct lttng_ust_object_data *obj_data,
  40                 struct lttng_ust_object_data **context_data);
  41
  42 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
  43 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
  44 int ustctl_start_session(int sock, int handle);
  45 int ustctl_stop_session(int sock, int handle);
  46
  47 /*
  48  * ustctl_tracepoint_list returns a tracepoint list handle, or negative
  49  * error value.
  50  */
  51 int ustctl_tracepoint_list(int sock);
  52 /*
  53  * ustctl_tracepoint_list_get is used to iterate on the tp list
  54  * handle. End is iteration is reached when -ENOENT is returned.
  55  */
  56 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
  57                 struct lttng_ust_tracepoint_iter *iter);
  58
  59 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
  60 int ustctl_wait_quiescent(int sock);
  61
  62 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
  63
  64 /* not implemented yet */
  65 struct lttng_ust_calibrate;
  66 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
  67
  68 /*
  69  * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
  70  * consumer to map the objects into its memory space.
  71  */
  72 struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
  73 int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
  74                 struct lttng_ust_object_data *stream_data);
  75 /*
  76  * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
  77  * be released after unmapping the handle.
  78  */
  79 void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
  80
  81 /* Buffer operations */
  82
  83 struct lttng_ust_shm_handle;
  84 struct lttng_ust_lib_ring_buffer;
  85
  86 /* Open/close stream buffers for read */
  87 struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
  88                 int cpu);
  89 void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
  90                 struct lttng_ust_lib_ring_buffer *buf);
  91
  92 /* For mmap mode, readable without "get" operation */
  93 int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
  94                 struct lttng_ust_lib_ring_buffer *buf,
  95                 unsigned long *len);
  96 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
  97                 struct lttng_ust_lib_ring_buffer *buf,
  98                 unsigned long *len);
  99
 100 /*
 101  * For mmap mode, operate on the current packet (between get/put or
 102  * get_next/put_next).
 103  */
 104 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
 105                 struct lttng_ust_lib_ring_buffer *buf);
 106 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
 107                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
 108 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
 109                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
 110 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
 111                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
 112 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
 113                 struct lttng_ust_lib_ring_buffer *buf);
 114 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
 115                 struct lttng_ust_lib_ring_buffer *buf);
 116
 117 /* snapshot */
 118
 119 int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
 120                 struct lttng_ust_lib_ring_buffer *buf);
 121 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
 122                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 123 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
 124                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 125 int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
 126                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 127 int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
 128                 struct lttng_ust_lib_ring_buffer *buf);
 129
 130 void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
 131                 struct lttng_ust_lib_ring_buffer *buf,
 132                 int producer_active);
 133
 134 /* Release object created by members of this API */
 135 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
 136 /* Release handle returned by create session. */
 137 int ustctl_release_handle(int sock, int handle);
 138
 139 #endif /* _LTTNG_UST_CTL_H */