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 <limits.h>
  23 #include <stddef.h>
  24 #include <stdint.h>
  25 #include <sys/types.h>
  26
  27 #include <lttng/ust-abi.h>
  28
  29 #ifndef LTTNG_PACKED
  30 #error "LTTNG_PACKED should be defined"
  31 #endif
  32
  33 #ifndef LTTNG_UST_UUID_LEN
  34 #define LTTNG_UST_UUID_LEN      16
  35 #endif
  36
  37 /* Default unix socket path */
  38 #define LTTNG_UST_SOCK_FILENAME                                 \
  39         "lttng-ust-sock-"                                       \
  40         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
  41
  42 /*
  43  * Shared memory files path are automatically related to shm root, e.g.
  44  * /dev/shm under linux.
  45  */
  46 #define LTTNG_UST_WAIT_FILENAME                                 \
  47         "lttng-ust-wait-"                                       \
  48         __ust_stringify(LTTNG_UST_ABI_MAJOR_VERSION)
  49
  50 struct lttng_ust_shm_handle;
  51 struct lttng_ust_lib_ring_buffer;
  52
  53 struct ustctl_consumer_channel_attr {
  54         enum lttng_ust_chan_type type;
  55         uint64_t subbuf_size;                   /* bytes */
  56         uint64_t num_subbuf;                    /* power of 2 */
  57         int overwrite;                          /* 1: overwrite, 0: discard */
  58         unsigned int switch_timer_interval;     /* usec */
  59         unsigned int read_timer_interval;       /* usec */
  60         enum lttng_ust_output output;           /* splice, mmap */
  61         uint32_t chan_id;                       /* channel ID */
  62         unsigned char uuid[LTTNG_UST_UUID_LEN]; /* Trace session unique ID */
  63         int64_t blocking_timeout;                       /* Blocking timeout (usec) */
  64 } LTTNG_PACKED;
  65
  66 /*
  67  * API used by sessiond.
  68  */
  69
  70 struct lttng_ust_context_attr {
  71         enum lttng_ust_context_type ctx;
  72         union {
  73                 struct lttng_ust_perf_counter_ctx perf_counter;
  74                 struct {
  75                         char *provider_name;
  76                         char *ctx_name;
  77                 } app_ctx;
  78         } u;
  79 };
  80
  81 /*
  82  * Error values: all the following functions return:
  83  * >= 0: Success (LTTNG_UST_OK)
  84  * < 0: error code.
  85  */
  86 int ustctl_register_done(int sock);
  87 int ustctl_create_session(int sock);
  88 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
  89                 struct lttng_ust_object_data *channel_data,
  90                 struct lttng_ust_object_data **event_data);
  91 int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
  92                 struct lttng_ust_object_data *obj_data,
  93                 struct lttng_ust_object_data **context_data);
  94 int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
  95                 struct lttng_ust_object_data *obj_data);
  96 int ustctl_set_exclusion(int sock, struct lttng_ust_event_exclusion *exclusion,
  97                 struct lttng_ust_object_data *obj_data);
  98
  99 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
 100 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
 101 int ustctl_start_session(int sock, int handle);
 102 int ustctl_stop_session(int sock, int handle);
 103
 104 /*
 105  * ustctl_tracepoint_list returns a tracepoint list handle, or negative
 106  * error value.
 107  */
 108 int ustctl_tracepoint_list(int sock);
 109
 110 /*
 111  * ustctl_tracepoint_list_get is used to iterate on the tp list
 112  * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 113  * returned.
 114  */
 115 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
 116                 struct lttng_ust_tracepoint_iter *iter);
 117
 118 /*
 119  * ustctl_tracepoint_field_list returns a tracepoint field list handle,
 120  * or negative error value.
 121  */
 122 int ustctl_tracepoint_field_list(int sock);
 123
 124 /*
 125  * ustctl_tracepoint_field_list_get is used to iterate on the tp field
 126  * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 127  * returned.
 128  */
 129 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 130                 struct lttng_ust_field_iter *iter);
 131
 132 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
 133 int ustctl_wait_quiescent(int sock);
 134
 135 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
 136
 137 int ustctl_calibrate(int sock, struct lttng_ust_calibrate *calibrate);
 138
 139 /* Release object created by members of this API. */
 140 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
 141 /* Release handle returned by create session. */
 142 int ustctl_release_handle(int sock, int handle);
 143
 144 int ustctl_recv_channel_from_consumer(int sock,
 145                 struct lttng_ust_object_data **channel_data);
 146 int ustctl_recv_stream_from_consumer(int sock,
 147                 struct lttng_ust_object_data **stream_data);
 148 int ustctl_send_channel_to_ust(int sock, int session_handle,
 149                 struct lttng_ust_object_data *channel_data);
 150 int ustctl_send_stream_to_ust(int sock,
 151                 struct lttng_ust_object_data *channel_data,
 152                 struct lttng_ust_object_data *stream_data);
 153
 154 /*
 155  * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
 156  * it succeeds (returns 0). It must be released using
 157  * ustctl_release_object() and then freed with free().
 158  */
 159 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
 160                 struct lttng_ust_object_data *src);
 161
 162 /*
 163  * API used by consumer.
 164  */
 165
 166 struct ustctl_consumer_channel;
 167 struct ustctl_consumer_stream;
 168 struct ustctl_consumer_channel_attr;
 169
 170 int ustctl_get_nr_stream_per_channel(void);
 171
 172 struct ustctl_consumer_channel *
 173         ustctl_create_channel(struct ustctl_consumer_channel_attr *attr,
 174                 const int *stream_fds, int nr_stream_fds);
 175 /*
 176  * Each stream created needs to be destroyed before calling
 177  * ustctl_destroy_channel().
 178  */
 179 void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
 180
 181 int ustctl_send_channel_to_sessiond(int sock,
 182                 struct ustctl_consumer_channel *channel);
 183 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 184 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 185 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 186 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 187
 188 int ustctl_write_metadata_to_channel(
 189                 struct ustctl_consumer_channel *channel,
 190                 const char *metadata_str,       /* NOT null-terminated */
 191                 size_t len);                    /* metadata length */
 192 ssize_t ustctl_write_one_packet_to_channel(
 193                 struct ustctl_consumer_channel *channel,
 194                 const char *metadata_str,       /* NOT null-terminated */
 195                 size_t len);                    /* metadata length */
 196
 197 /*
 198  * Send a NULL stream to finish iteration over all streams of a given
 199  * channel.
 200  */
 201 int ustctl_send_stream_to_sessiond(int sock,
 202                 struct ustctl_consumer_stream *stream);
 203 int ustctl_stream_close_wait_fd(struct ustctl_consumer_stream *stream);
 204 int ustctl_stream_close_wakeup_fd(struct ustctl_consumer_stream *stream);
 205 int ustctl_stream_get_wait_fd(struct ustctl_consumer_stream *stream);
 206 int ustctl_stream_get_wakeup_fd(struct ustctl_consumer_stream *stream);
 207
 208 /* Create/destroy stream buffers for read */
 209 struct ustctl_consumer_stream *
 210         ustctl_create_stream(struct ustctl_consumer_channel *channel,
 211                         int cpu);
 212 void ustctl_destroy_stream(struct ustctl_consumer_stream *stream);
 213
 214 /* For mmap mode, readable without "get" operation */
 215 int ustctl_get_mmap_len(struct ustctl_consumer_stream *stream,
 216                 unsigned long *len);
 217 int ustctl_get_max_subbuf_size(struct ustctl_consumer_stream *stream,
 218                 unsigned long *len);
 219
 220 /*
 221  * For mmap mode, operate on the current packet (between get/put or
 222  * get_next/put_next).
 223  */
 224 void *ustctl_get_mmap_base(struct ustctl_consumer_stream *stream);
 225 int ustctl_get_mmap_read_offset(struct ustctl_consumer_stream *stream,
 226                 unsigned long *off);
 227 int ustctl_get_subbuf_size(struct ustctl_consumer_stream *stream,
 228                 unsigned long *len);
 229 int ustctl_get_padded_subbuf_size(struct ustctl_consumer_stream *stream,
 230                 unsigned long *len);
 231 int ustctl_get_next_subbuf(struct ustctl_consumer_stream *stream);
 232 int ustctl_put_next_subbuf(struct ustctl_consumer_stream *stream);
 233
 234 /* snapshot */
 235
 236 int ustctl_snapshot(struct ustctl_consumer_stream *stream);
 237 int ustctl_snapshot_sample_positions(struct ustctl_consumer_stream *stream);
 238 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
 239                 unsigned long *pos);
 240 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
 241                 unsigned long *pos);
 242 int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
 243                 unsigned long *pos);
 244 int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
 245
 246 void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
 247                 int producer_active);
 248 void ustctl_clear_buffer(struct ustctl_consumer_stream *stream);
 249
 250 /* index */
 251
 252 /*
 253  * Getters which need to be used on the current packet (between get/put
 254  * or get_next/put_next.
 255  */
 256
 257 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
 258                 uint64_t *timestamp_begin);
 259 int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
 260         uint64_t *timestamp_end);
 261 int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
 262         uint64_t *events_discarded);
 263 int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
 264         uint64_t *content_size);
 265 int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
 266         uint64_t *packet_size);
 267 int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
 268                 uint64_t *seq);
 269
 270 /*
 271  * Getter returning state invariant for the stream, which can be used
 272  * without "get" operation.
 273  */
 274
 275 int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
 276                 uint64_t *stream_id);
 277 int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
 278                 uint64_t *id);
 279
 280 /*
 281  * Getter returning the current timestamp as perceived from the
 282  * tracer.
 283  */
 284 int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
 285                 uint64_t *ts);
 286
 287 /* returns whether UST has perf counters support. */
 288 int ustctl_has_perf_counters(void);
 289
 290 /* Regenerate the statedump. */
 291 int ustctl_regenerate_statedump(int sock, int handle);
 292
 293 /* event registry management */
 294
 295 enum ustctl_socket_type {
 296         USTCTL_SOCKET_CMD = 0,
 297         USTCTL_SOCKET_NOTIFY = 1,
 298 };
 299
 300 enum ustctl_notify_cmd {
 301         USTCTL_NOTIFY_CMD_EVENT = 0,
 302         USTCTL_NOTIFY_CMD_CHANNEL = 1,
 303         USTCTL_NOTIFY_CMD_ENUM = 2,
 304 };
 305
 306 enum ustctl_channel_header {
 307         USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
 308         USTCTL_CHANNEL_HEADER_COMPACT = 1,
 309         USTCTL_CHANNEL_HEADER_LARGE = 2,
 310 };
 311
 312 /* event type structures */
 313
 314 enum ustctl_abstract_types {
 315         ustctl_atype_integer,
 316         ustctl_atype_enum,      /* legacy */
 317         ustctl_atype_array,     /* legacy */
 318         ustctl_atype_sequence,  /* legacy */
 319         ustctl_atype_string,
 320         ustctl_atype_float,
 321         ustctl_atype_variant,   /* legacy */
 322         ustctl_atype_struct,    /* legacy */
 323         ustctl_atype_enum_nestable,
 324         ustctl_atype_array_nestable,
 325         ustctl_atype_sequence_nestable,
 326         ustctl_atype_struct_nestable,
 327         ustctl_atype_variant_nestable,
 328         NR_USTCTL_ABSTRACT_TYPES,
 329 };
 330
 331 enum ustctl_string_encodings {
 332         ustctl_encode_none = 0,
 333         ustctl_encode_UTF8 = 1,
 334         ustctl_encode_ASCII = 2,
 335         NR_USTCTL_STRING_ENCODINGS,
 336 };
 337
 338 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
 339 struct ustctl_integer_type {
 340         uint32_t size;          /* in bits */
 341         uint32_t signedness;
 342         uint32_t reverse_byte_order;
 343         uint32_t base;          /* 2, 8, 10, 16, for pretty print */
 344         int32_t encoding;       /* enum ustctl_string_encodings */
 345         uint16_t alignment;     /* in bits */
 346         char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
 347 } LTTNG_PACKED;
 348
 349 #define USTCTL_UST_FLOAT_TYPE_PADDING   24
 350 struct ustctl_float_type {
 351         uint32_t exp_dig;               /* exponent digits, in bits */
 352         uint32_t mant_dig;              /* mantissa digits, in bits */
 353         uint32_t reverse_byte_order;
 354         uint16_t alignment;     /* in bits */
 355         char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
 356 } LTTNG_PACKED;
 357
 358 #define USTCTL_UST_ENUM_VALUE_PADDING   15
 359 struct ustctl_enum_value {
 360         uint64_t value;
 361         uint8_t signedness;
 362         char padding[USTCTL_UST_ENUM_VALUE_PADDING];
 363 } LTTNG_PACKED;
 364
 365 enum ustctl_ust_enum_entry_options {
 366         USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 367 };
 368
 369 #define USTCTL_UST_ENUM_ENTRY_PADDING   32
 370 struct ustctl_enum_entry {
 371         struct ustctl_enum_value start, end; /* start and end are inclusive */
 372         char string[LTTNG_UST_SYM_NAME_LEN];
 373         union {
 374                 struct {
 375                         uint32_t options;
 376                 } LTTNG_PACKED extra;
 377                 char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
 378         } u;
 379 } LTTNG_PACKED;
 380
 381 /* legacy */
 382 #define USTCTL_UST_BASIC_TYPE_PADDING   296
 383 union _ustctl_basic_type {
 384         struct ustctl_integer_type integer;
 385         struct {
 386                 char name[LTTNG_UST_SYM_NAME_LEN];
 387                 struct ustctl_integer_type container_type;
 388                 uint64_t id;    /* enum ID in sessiond. */
 389         } enumeration;
 390         struct {
 391                 int32_t encoding;       /* enum ustctl_string_encodings */
 392         } string;
 393         struct ustctl_float_type _float;
 394         char padding[USTCTL_UST_BASIC_TYPE_PADDING];
 395 } LTTNG_PACKED;
 396
 397 /* legacy */
 398 struct ustctl_basic_type {
 399         enum ustctl_abstract_types atype;
 400         union {
 401                 union _ustctl_basic_type basic;
 402         } u;
 403 } LTTNG_PACKED;
 404
 405 /*
 406  * Padding is derived from largest member: u.legacy.sequence which
 407  * contains two basic types, each with USTCTL_UST_BASIC_TYPE_PADDING.
 408  */
 409 #define USTCTL_UST_TYPE_PADDING (2 * USTCTL_UST_BASIC_TYPE_PADDING)
 410 struct ustctl_type {
 411         enum ustctl_abstract_types atype;
 412         union {
 413                 struct ustctl_integer_type integer;
 414                 struct ustctl_float_type _float;
 415                 struct {
 416                         int32_t encoding;       /* enum ustctl_string_encodings */
 417                 } string;
 418                 struct {
 419                         char name[LTTNG_UST_SYM_NAME_LEN];
 420                         uint64_t id;    /* enum ID in sessiond. */
 421                         /* container_type follows after this struct ustctl_field. */
 422                 } enum_nestable;
 423                 struct {
 424                         uint32_t length;                /* num. elems. */
 425                         uint32_t alignment;
 426                         /* elem_type follows after this struct ustctl_field. */
 427                 } array_nestable;
 428                 struct {
 429                         char length_name[LTTNG_UST_SYM_NAME_LEN];
 430                         uint32_t alignment;             /* Alignment before elements. */
 431                         /* elem_type follows after the length_type. */
 432                 } sequence_nestable;
 433                 struct {
 434                         uint32_t nr_fields;
 435                         uint32_t alignment;
 436                         /* Followed by nr_fields struct ustctl_field. */
 437                 } struct_nestable;
 438                 struct {
 439                         uint32_t nr_choices;
 440                         char tag_name[LTTNG_UST_SYM_NAME_LEN];
 441                         uint32_t alignment;
 442                         /* Followed by nr_choices struct ustctl_field. */
 443                 } variant_nestable;
 444
 445                 /* Legacy ABI */
 446                 union {
 447                         union _ustctl_basic_type basic;
 448                         struct {
 449                                 struct ustctl_basic_type elem_type;
 450                                 uint32_t length;                /* num. elems. */
 451                         } array;
 452                         struct {
 453                                 struct ustctl_basic_type length_type;
 454                                 struct ustctl_basic_type elem_type;
 455                         } sequence;
 456                         struct {
 457                                 uint32_t nr_fields;
 458                                 /* Followed by nr_fields struct ustctl_field. */
 459                         } _struct;
 460                         struct {
 461                                 uint32_t nr_choices;
 462                                 char tag_name[LTTNG_UST_SYM_NAME_LEN];
 463                                 /* Followed by nr_choices struct ustctl_field. */
 464                         } variant;
 465                 } legacy;
 466                 char padding[USTCTL_UST_TYPE_PADDING];
 467         } u;
 468 } LTTNG_PACKED;
 469
 470 #define USTCTL_UST_FIELD_PADDING        28
 471 struct ustctl_field {
 472         char name[LTTNG_UST_SYM_NAME_LEN];
 473         struct ustctl_type type;
 474         char padding[USTCTL_UST_FIELD_PADDING];
 475 } LTTNG_PACKED;
 476
 477 /*
 478  * Returns 0 on success, negative error value on error.
 479  * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 480  * the output fields are not populated.
 481  */
 482 int ustctl_recv_reg_msg(int sock,
 483         enum ustctl_socket_type *type,
 484         uint32_t *major,
 485         uint32_t *minor,
 486         uint32_t *pid,
 487         uint32_t *ppid,
 488         uint32_t *uid,
 489         uint32_t *gid,
 490         uint32_t *bits_per_long,
 491         uint32_t *uint8_t_alignment,
 492         uint32_t *uint16_t_alignment,
 493         uint32_t *uint32_t_alignment,
 494         uint32_t *uint64_t_alignment,
 495         uint32_t *long_alignment,
 496         int *byte_order,
 497         char *name);    /* size LTTNG_UST_ABI_PROCNAME_LEN */
 498
 499 /*
 500  * Returns 0 on success, negative UST or system error value on error.
 501  * Receive the notification command. The "notify_cmd" can then be used
 502  * by the caller to find out which ustctl_recv_* function should be
 503  * called to receive the notification, and which ustctl_reply_* is
 504  * appropriate.
 505  */
 506 int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
 507
 508 /*
 509  * Returns 0 on success, negative UST or system error value on error.
 510  */
 511 int ustctl_recv_register_event(int sock,
 512         int *session_objd,              /* session descriptor (output) */
 513         int *channel_objd,              /* channel descriptor (output) */
 514         char *event_name,               /*
 515                                          * event name (output,
 516                                          * size LTTNG_UST_SYM_NAME_LEN)
 517                                          */
 518         int *loglevel,
 519         char **signature,               /*
 520                                          * event signature
 521                                          * (output, dynamically
 522                                          * allocated, must be free(3)'d
 523                                          * by the caller if function
 524                                          * returns success.)
 525                                          */
 526         size_t *nr_fields,
 527         struct ustctl_field **fields,
 528         char **model_emf_uri);
 529
 530 /*
 531  * Returns 0 on success, negative error value on error.
 532  */
 533 int ustctl_reply_register_event(int sock,
 534         uint32_t id,                    /* event id (input) */
 535         int ret_code);                  /* return code. 0 ok, negative error */
 536
 537 /*
 538  * Returns 0 on success, negative UST or system error value on error.
 539  */
 540 int ustctl_recv_register_enum(int sock,
 541         int *session_objd,
 542         char *enum_name,
 543         struct ustctl_enum_entry **entries,
 544         size_t *nr_entries);
 545
 546 /*
 547  * Returns 0 on success, negative error value on error.
 548  */
 549 int ustctl_reply_register_enum(int sock,
 550         uint64_t id,                    /* enum id (input) */
 551         int ret_code);
 552
 553 /*
 554  * Returns 0 on success, negative UST or system error value on error.
 555  */
 556 int ustctl_recv_register_channel(int sock,
 557         int *session_objd,              /* session descriptor (output) */
 558         int *channel_objd,              /* channel descriptor (output) */
 559         size_t *nr_fields,              /* context fields */
 560         struct ustctl_field **fields);
 561
 562 /*
 563  * Returns 0 on success, negative error value on error.
 564  */
 565 int ustctl_reply_register_channel(int sock,
 566         uint32_t chan_id,
 567         enum ustctl_channel_header header_type,
 568         int ret_code);                  /* return code. 0 ok, negative error */
 569
 570 #endif /* _LTTNG_UST_CTL_H */