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