include/lttng/ust-ctl.h

   1 /*
   2  * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
   3  * Copyright (C) 2011-2013 - 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 #include <sys/types.h>
  24
  25 #ifndef LTTNG_UST_UUID_LEN
  26 #define LTTNG_UST_UUID_LEN      16
  27 #endif
  28
  29 /* Default unix socket path */
  30 #define LTTNG_UST_SOCK_FILENAME                                 \
  31         "lttng-ust-sock-"                                       \
  32         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
  33
  34 /*
  35  * Shared memory files path are automatically related to shm root, e.g.
  36  * /dev/shm under linux.
  37  */
  38 #define LTTNG_UST_WAIT_FILENAME                                 \
  39         "lttng-ust-wait-"                                       \
  40         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
  41
  42 struct lttng_ust_shm_handle;
  43 struct lttng_ust_lib_ring_buffer;
  44
  45 struct ustctl_consumer_channel_attr {
  46         enum lttng_ust_chan_type type;
  47         uint64_t subbuf_size;                   /* bytes */
  48         uint64_t num_subbuf;                    /* power of 2 */
  49         int overwrite;                          /* 1: overwrite, 0: discard */
  50         unsigned int switch_timer_interval;     /* usec */
  51         unsigned int read_timer_interval;       /* usec */
  52         enum lttng_ust_output output;           /* splice, mmap */
  53         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
  54 } LTTNG_PACKED;
  55
  56 /*
  57  * API used by sessiond.
  58  */
  59
  60 /*
  61  * Error values: all the following functions return:
  62  * >= 0: Success (LTTNG_UST_OK)
  63  * < 0: error code.
  64  */
  65 int ustctl_register_done(int sock);
  66 int ustctl_create_session(int sock);
  67 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
  68                 struct lttng_ust_object_data *channel_data,
  69                 struct lttng_ust_object_data **event_data);
  70 int ustctl_add_context(int sock, struct lttng_ust_context *ctx,
  71                 struct lttng_ust_object_data *obj_data,
  72                 struct lttng_ust_object_data **context_data);
  73 int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
  74                 struct lttng_ust_object_data *obj_data);
  75
  76 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
  77 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
  78 int ustctl_start_session(int sock, int handle);
  79 int ustctl_stop_session(int sock, int handle);
  80
  81 /*
  82  * ustctl_tracepoint_list returns a tracepoint list handle, or negative
  83  * error value.
  84  */
  85 int ustctl_tracepoint_list(int sock);
  86
  87 /*
  88  * ustctl_tracepoint_list_get is used to iterate on the tp list
  89  * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
  90  * returned.
  91  */
  92 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
  93                 struct lttng_ust_tracepoint_iter *iter);
  94
  95 /*
  96  * ustctl_tracepoint_field_list returns a tracepoint field list handle,
  97  * or negative error value.
  98  */
  99 int ustctl_tracepoint_field_list(int sock);
 100
 101 /*
 102  * ustctl_tracepoint_field_list_get is used to iterate on the tp field
 103  * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 104  * returned.
 105  */
 106 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 107                 struct lttng_ust_field_iter *iter);
 108
 109 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
 110 int ustctl_wait_quiescent(int sock);
 111
 112 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
 113
 114 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
 115
 116 /* Release object created by members of this API. */
 117 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
 118 /* Release handle returned by create session. */
 119 int ustctl_release_handle(int sock, int handle);
 120
 121 int ustctl_recv_channel_from_consumer(int sock,
 122                 struct lttng_ust_object_data **channel_data);
 123 int ustctl_recv_stream_from_consumer(int sock,
 124                 struct lttng_ust_object_data **stream_data);
 125 int ustctl_send_channel_to_ust(int sock, int session_handle,
 126                 struct lttng_ust_object_data *channel_data);
 127 int ustctl_send_stream_to_ust(int sock,
 128                 struct lttng_ust_object_data *channel_data,
 129                 struct lttng_ust_object_data *stream_data);
 130
 131 /*
 132  * API used by consumer.
 133  */
 134
 135 struct ustctl_consumer_channel;
 136 struct ustctl_consumer_stream;
 137 struct ustctl_consumer_channel_attr;
 138
 139 struct ustctl_consumer_channel *
 140         ustctl_create_channel(struct ustctl_consumer_channel_attr *attr);
 141 /*
 142  * Each stream created needs to be destroyed before calling
 143  * ustctl_destroy_channel().
 144  */
 145 void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
 146
 147 int ustctl_send_channel_to_sessiond(int sock,
 148                 struct ustctl_consumer_channel *channel);
 149 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 150 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 151 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 152 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 153
 154 int ustctl_write_metadata_to_channel(
 155                 struct ustctl_consumer_channel *channel,
 156                 const char *metadata_str,       /* NOT null-terminated */
 157                 size_t len);                    /* metadata length */
 158
 159 /*
 160  * Send a NULL stream to finish iteration over all streams of a given
 161  * channel.
 162  */
 163 int ustctl_send_stream_to_sessiond(int sock,
 164                 struct ustctl_consumer_stream *stream);
 165 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
 166 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
 167 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
 168 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);
 169
 170 /* Create/destroy stream buffers for read */
 171 struct ustctl_consumer_stream *
 172         ustctl_create_stream(struct ustctl_consumer_channel *channel,
 173                         int cpu);
 174 void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);
 175
 176 /* For mmap mode, readable without "get" operation */
 177 int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
 178                 unsigned long *len);
 179 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
 180                 unsigned long *len);
 181
 182 /*
 183  * For mmap mode, operate on the current packet (between get/put or
 184  * get_next/put_next).
 185  */
 186 void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream);
 187 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
 188                 unsigned long *off);
 189 int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
 190                 unsigned long *len);
 191 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
 192                 unsigned long *len);
 193 int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
 194 int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);
 195
 196 /* snapshot */
 197
 198 int ustctl_snapshot(struct ustctl_consumer_stream *stream);
 199 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
 200                 unsigned long *pos);
 201 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
 202                 unsigned long *pos);
 203 int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
 204                 unsigned long *pos);
 205 int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
 206
 207 void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
 208                 int producer_active);
 209
 210 /* event registry management */
 211
 212 enum ustctl_socket_type {
 213         USTCTL_SOCKET_CMD = 0,
 214         USTCTL_SOCKET_NOTIFY = 1,
 215 };
 216
 217 enum ustctl_notify_cmd {
 218         USTCTL_NOTIFY_CMD_EVENT = 0,
 219         USTCTL_NOTIFY_CMD_CHANNEL = 1,
 220 };
 221
 222 enum ustctl_channel_header {
 223         USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
 224         USTCTL_CHANNEL_HEADER_COMPACT = 1,
 225         USTCTL_CHANNEL_HEADER_LARGE = 2,
 226 };
 227
 228 /* event type structures */
 229
 230 enum ustctl_abstract_types {
 231         ustctl_atype_integer,
 232         ustctl_atype_enum,
 233         ustctl_atype_array,
 234         ustctl_atype_sequence,
 235         ustctl_atype_string,
 236         ustctl_atype_float,
 237         NR_USTCTL_ABSTRACT_TYPES,
 238 };
 239
 240 enum ustctl_string_encodings {
 241         ustctl_encode_none = 0,
 242         ustctl_encode_UTF8 = 1,
 243         ustctl_encode_ASCII = 2,
 244         NR_USTCTL_STRING_ENCODINGS,
 245 };
 246
 247 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
 248 struct ustctl_integer_type {
 249         uint32_t size;          /* in bits */
 250         uint32_t signedness;
 251         uint32_t reverse_byte_order;
 252         uint32_t base;          /* 2, 8, 10, 16, for pretty print */
 253         enum ustctl_string_encodings encoding;
 254         uint16_t alignment;     /* in bits */
 255         char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
 256 } LTTNG_PACKED;
 257
 258 #define USTCTL_UST_FLOAT_TYPE_PADDING   24
 259 struct ustctl_float_type {
 260         uint32_t exp_dig;               /* exponent digits, in bits */
 261         uint32_t mant_dig;              /* mantissa digits, in bits */
 262         uint32_t reverse_byte_order;
 263         uint16_t alignment;     /* in bits */
 264         char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
 265 } LTTNG_PACKED;
 266
 267 #define USTCTL_UST_BASIC_TYPE_PADDING   296
 268 union _ustctl_basic_type {
 269         struct ustctl_integer_type integer;
 270         struct {
 271                 enum ustctl_string_encodings encoding;
 272         } string;
 273         struct ustctl_float_type _float;
 274         char padding[USTCTL_UST_BASIC_TYPE_PADDING];
 275 } LTTNG_PACKED;
 276
 277 struct ustctl_basic_type {
 278         enum ustctl_abstract_types atype;
 279         union {
 280                 union _ustctl_basic_type basic;
 281         } u;
 282 } LTTNG_PACKED;
 283
 284 #define USTCTL_UST_TYPE_PADDING 128
 285 struct ustctl_type {
 286         enum ustctl_abstract_types atype;
 287         union {
 288                 union _ustctl_basic_type basic;
 289                 struct {
 290                         struct ustctl_basic_type elem_type;
 291                         uint32_t length;                /* num. elems. */
 292                 } array;
 293                 struct {
 294                         struct ustctl_basic_type length_type;
 295                         struct ustctl_basic_type elem_type;
 296                 } sequence;
 297                 char padding[USTCTL_UST_TYPE_PADDING];
 298         } u;
 299 } LTTNG_PACKED;
 300
 301 #define USTCTL_UST_FIELD_PADDING        28
 302 struct ustctl_field {
 303         char name[LTTNG_UST_SYM_NAME_LEN];
 304         struct ustctl_type type;
 305         char padding[USTCTL_UST_FIELD_PADDING];
 306 } LTTNG_PACKED;
 307
 308 /*
 309  * Returns 0 on success, negative error value on error.
 310  * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 311  * the output fields are not populated.
 312  */
 313 int ustctl_recv_reg_msg(int sock,
 314         enum ustctl_socket_type *type,
 315         uint32_t *major,
 316         uint32_t *minor,
 317         uint32_t *pid,
 318         uint32_t *ppid,
 319         uint32_t *uid,
 320         uint32_t *gid,
 321         uint32_t *bits_per_long,
 322         uint32_t *uint8_t_alignment,
 323         uint32_t *uint16_t_alignment,
 324         uint32_t *uint32_t_alignment,
 325         uint32_t *uint64_t_alignment,
 326         uint32_t *long_alignment,
 327         int *byte_order,
 328         char *name);    /* size LTTNG_UST_ABI_PROCNAME_LEN */
 329
 330 /*
 331  * Returns 0 on success, negative UST or system error value on error.
 332  * Receive the notification command. The "notify_cmd" can then be used
 333  * by the caller to find out which ustctl_recv_* function should be
 334  * called to receive the notification, and which ustctl_reply_* is
 335  * appropriate.
 336  */
 337 int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
 338
 339 /*
 340  * Returns 0 on success, negative UST or system error value on error.
 341  */
 342 int ustctl_recv_register_event(int sock,
 343         int *session_objd,              /* session descriptor (output) */
 344         int *channel_objd,              /* channel descriptor (output) */
 345         char *event_name,               /*
 346                                          * event name (output,
 347                                          * size LTTNG_UST_SYM_NAME_LEN)
 348                                          */
 349         int *loglevel,
 350         char **signature,               /*
 351                                          * event signature
 352                                          * (output, dynamically
 353                                          * allocated, must be free(3)'d
 354                                          * by the caller if function
 355                                          * returns success.)
 356                                          */
 357         size_t *nr_fields,
 358         struct ustctl_field **fields,
 359         char **model_emf_uri);
 360
 361 /*
 362  * Returns 0 on success, negative error value on error.
 363  */
 364 int ustctl_reply_register_event(int sock,
 365         uint32_t id,                    /* event id (input) */
 366         int ret_code);                  /* return code. 0 ok, negative error */
 367
 368 /*
 369  * Returns 0 on success, negative UST or system error value on error.
 370  */
 371 int ustctl_recv_register_channel(int sock,
 372         int *session_objd,              /* session descriptor (output) */
 373         int *channel_objd,              /* channel descriptor (output) */
 374         size_t *nr_fields,              /* context fields */
 375         struct ustctl_field **fields);
 376
 377 /*
 378  * Returns 0 on success, negative error value on error.
 379  */
 380 int ustctl_reply_register_channel(int sock,
 381         uint32_t chan_id,
 382         enum ustctl_channel_header header_type,
 383         int ret_code);                  /* return code. 0 ok, negative error */
 384
 385 #endif /* _LTTNG_UST_CTL_H */