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