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