include/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 modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; version 2 of the License only.
   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_UST_CTL_H
  20 #define _LTTNG_UST_CTL_H
  21
  22 #include <lttng/ust-abi.h>
  23
  24 int ustctl_register_done(int sock);
  25 int ustctl_create_session(int sock);
  26 int ustctl_open_metadata(int sock, int session_handle,
  27                 struct lttng_ust_channel_attr *chops,
  28                 struct lttng_ust_object_data **metadata_data);
  29 int ustctl_create_channel(int sock, int session_handle,
  30                 struct lttng_ust_channel_attr *chops,
  31                 struct lttng_ust_object_data **channel_data);
  32 int ustctl_create_stream(int sock, struct lttng_ust_object_data *channel_data,
  33                 struct lttng_ust_object_data **stream_data);
  34 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
  35                 struct lttng_ust_object_data *channel_data,
  36                 struct lttng_ust_object_data **event_data);
  37 int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
  38                 struct lttng_ust_object_data *obj_data,
  39                 struct lttng_ust_object_data **context_data);
  40
  41 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
  42 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
  43 int ustctl_start_session(int sock, int handle);
  44 int ustctl_stop_session(int sock, int handle);
  45
  46 /*
  47  * ustctl_tracepoint_list returns a tracepoint list handle, or negative
  48  * error value.
  49  */
  50 int ustctl_tracepoint_list(int sock);
  51 /*
  52  * ustctl_tracepoint_list_get is used to iterate on the tp list
  53  * handle. End is iteration is reached when -ENOENT is returned.
  54  */
  55 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
  56                 struct lttng_ust_tracepoint_iter *iter);
  57
  58 /*
  59  * ustctl_tracepoint_field_list returns a tracepoint field list handle,
  60  * or negative error value.
  61  */
  62 int ustctl_tracepoint_field_list(int sock);
  63
  64 /*
  65  * ustctl_tracepoint_field_list_get is used to iterate on the tp field
  66  * list handle. End is iteration is reached when -ENOENT is returned.
  67  */
  68 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
  69                 struct lttng_ust_field_iter *iter);
  70
  71 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
  72 int ustctl_wait_quiescent(int sock);
  73
  74 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
  75
  76 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
  77
  78 /*
  79  * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
  80  * consumer to map the objects into its memory space.
  81  */
  82 struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
  83 int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
  84                 struct lttng_ust_object_data *stream_data);
  85 /*
  86  * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
  87  * be released after unmapping the handle.
  88  */
  89 void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
  90
  91 /* Buffer operations */
  92
  93 struct lttng_ust_shm_handle;
  94 struct lttng_ust_lib_ring_buffer;
  95
  96 /* Open/close stream buffers for read */
  97 struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
  98                 int cpu);
  99 void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
 100                 struct lttng_ust_lib_ring_buffer *buf);
 101
 102 /* For mmap mode, readable without "get" operation */
 103 int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
 104                 struct lttng_ust_lib_ring_buffer *buf,
 105                 unsigned long *len);
 106 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
 107                 struct lttng_ust_lib_ring_buffer *buf,
 108                 unsigned long *len);
 109
 110 /*
 111  * For mmap mode, operate on the current packet (between get/put or
 112  * get_next/put_next).
 113  */
 114 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
 115                 struct lttng_ust_lib_ring_buffer *buf);
 116 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
 117                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
 118 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
 119                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
 120 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
 121                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
 122 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
 123                 struct lttng_ust_lib_ring_buffer *buf);
 124 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
 125                 struct lttng_ust_lib_ring_buffer *buf);
 126
 127 /* snapshot */
 128
 129 int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
 130                 struct lttng_ust_lib_ring_buffer *buf);
 131 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
 132                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 133 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
 134                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 135 int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
 136                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 137 int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
 138                 struct lttng_ust_lib_ring_buffer *buf);
 139
 140 void ustctl_flush_buffer(struct lttng_ust_shm_handle *handle,
 141                 struct lttng_ust_lib_ring_buffer *buf,
 142                 int producer_active);
 143
 144 /* Release object created by members of this API. */
 145 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
 146 /* Release handle returned by create session. */
 147 int ustctl_release_handle(int sock, int handle);
 148
 149 #endif /* _LTTNG_UST_CTL_H */