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