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