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
   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 int ustctl_tracepoint_list(int sock);   /* not implemented yet */
  48 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
  49 int ustctl_wait_quiescent(int sock);
  50
  51 /* Flush each buffers in this channel */
  52 int ustctl_flush_buffer(int sock, struct lttng_ust_object_data *channel_data);
  53
  54 /* not implemented yet */
  55 struct lttng_ust_calibrate;
  56 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
  57
  58 /*
  59  * Map channel lttng_ust_shm_handle and add streams. Typically performed by the
  60  * consumer to map the objects into its memory space.
  61  */
  62 struct lttng_ust_shm_handle *ustctl_map_channel(struct lttng_ust_object_data *chan_data);
  63 int ustctl_add_stream(struct lttng_ust_shm_handle *lttng_ust_shm_handle,
  64                 struct lttng_ust_object_data *stream_data);
  65 /*
  66  * Note: the lttng_ust_object_data from which the lttng_ust_shm_handle is derived can only
  67  * be released after unmapping the handle.
  68  */
  69 void ustctl_unmap_channel(struct lttng_ust_shm_handle *lttng_ust_shm_handle);
  70
  71 /* Buffer operations */
  72
  73 struct lttng_ust_shm_handle;
  74 struct lttng_ust_lib_ring_buffer;
  75
  76 /* Open/close stream buffers for read */
  77 struct lttng_ust_lib_ring_buffer *ustctl_open_stream_read(struct lttng_ust_shm_handle *handle,
  78                 int cpu);
  79 void ustctl_close_stream_read(struct lttng_ust_shm_handle *handle,
  80                 struct lttng_ust_lib_ring_buffer *buf);
  81
  82 /* For mmap mode, readable without "get" operation */
  83 int ustctl_get_mmap_len(struct lttng_ust_shm_handle *handle,
  84                 struct lttng_ust_lib_ring_buffer *buf,
  85                 unsigned long *len);
  86 int ustctl_get_max_subbuf_size(struct lttng_ust_shm_handle *handle,
  87                 struct lttng_ust_lib_ring_buffer *buf,
  88                 unsigned long *len);
  89
  90 /*
  91  * For mmap mode, operate on the current packet (between get/put or
  92  * get_next/put_next).
  93  */
  94 void *ustctl_get_mmap_base(struct lttng_ust_shm_handle *handle,
  95                 struct lttng_ust_lib_ring_buffer *buf);
  96 int ustctl_get_mmap_read_offset(struct lttng_ust_shm_handle *handle,
  97                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *off);
  98 int ustctl_get_subbuf_size(struct lttng_ust_shm_handle *handle,
  99                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
 100 int ustctl_get_padded_subbuf_size(struct lttng_ust_shm_handle *handle,
 101                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *len);
 102 int ustctl_get_next_subbuf(struct lttng_ust_shm_handle *handle,
 103                 struct lttng_ust_lib_ring_buffer *buf);
 104 int ustctl_put_next_subbuf(struct lttng_ust_shm_handle *handle,
 105                 struct lttng_ust_lib_ring_buffer *buf);
 106
 107 /* snapshot */
 108
 109 int ustctl_snapshot(struct lttng_ust_shm_handle *handle,
 110                 struct lttng_ust_lib_ring_buffer *buf);
 111 int ustctl_snapshot_get_consumed(struct lttng_ust_shm_handle *handle,
 112                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 113 int ustctl_snapshot_get_produced(struct lttng_ust_shm_handle *handle,
 114                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 115 int ustctl_get_subbuf(struct lttng_ust_shm_handle *handle,
 116                 struct lttng_ust_lib_ring_buffer *buf, unsigned long *pos);
 117 int ustctl_put_subbuf(struct lttng_ust_shm_handle *handle,
 118                 struct lttng_ust_lib_ring_buffer *buf);
 119
 120 /* Release object created by members of this API */
 121 void release_object(int sock, struct lttng_ust_object_data *data);
 122
 123 #endif /* _LTTNG_UST_CTL_H */