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 int ustctl_get_timestamp_begin(struct ustctl_consumer_stream *stream,
 244                 uint64_t *timestamp_begin);
 245 int ustctl_get_timestamp_end(struct ustctl_consumer_stream *stream,
 246         uint64_t *timestamp_end);
 247 int ustctl_get_events_discarded(struct ustctl_consumer_stream *stream,
 248         uint64_t *events_discarded);
 249 int ustctl_get_content_size(struct ustctl_consumer_stream *stream,
 250         uint64_t *content_size);
 251 int ustctl_get_packet_size(struct ustctl_consumer_stream *stream,
 252         uint64_t *packet_size);
 253 int ustctl_get_stream_id(struct ustctl_consumer_stream *stream,
 254                 uint64_t *stream_id);
 255 int ustctl_get_current_timestamp(struct ustctl_consumer_stream *stream,
 256                 uint64_t *ts);
 257 int ustctl_get_sequence_number(struct ustctl_consumer_stream *stream,
 258                 uint64_t *seq);
 259 int ustctl_get_instance_id(struct ustctl_consumer_stream *stream,
 260                 uint64_t *id);
 261
 262 /* returns whether UST has perf counters support. */
 263 int ustctl_has_perf_counters(void);
 264
 265 /* Regenerate the statedump. */
 266 int ustctl_regenerate_statedump(int sock, int handle);
 267
 268 /* event registry management */
 269
 270 enum ustctl_socket_type {
 271         USTCTL_SOCKET_CMD = 0,
 272         USTCTL_SOCKET_NOTIFY = 1,
 273 };
 274
 275 enum ustctl_notify_cmd {
 276         USTCTL_NOTIFY_CMD_EVENT = 0,
 277         USTCTL_NOTIFY_CMD_CHANNEL = 1,
 278         USTCTL_NOTIFY_CMD_ENUM = 2,
 279 };
 280
 281 enum ustctl_channel_header {
 282         USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
 283         USTCTL_CHANNEL_HEADER_COMPACT = 1,
 284         USTCTL_CHANNEL_HEADER_LARGE = 2,
 285 };
 286
 287 /* event type structures */
 288
 289 enum ustctl_abstract_types {
 290         ustctl_atype_integer,
 291         ustctl_atype_enum,
 292         ustctl_atype_array,
 293         ustctl_atype_sequence,
 294         ustctl_atype_string,
 295         ustctl_atype_float,
 296         ustctl_atype_variant,
 297         ustctl_atype_struct,
 298         NR_USTCTL_ABSTRACT_TYPES,
 299 };
 300
 301 enum ustctl_string_encodings {
 302         ustctl_encode_none = 0,
 303         ustctl_encode_UTF8 = 1,
 304         ustctl_encode_ASCII = 2,
 305         NR_USTCTL_STRING_ENCODINGS,
 306 };
 307
 308 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
 309 struct ustctl_integer_type {
 310         uint32_t size;          /* in bits */
 311         uint32_t signedness;
 312         uint32_t reverse_byte_order;
 313         uint32_t base;          /* 2, 8, 10, 16, for pretty print */
 314         int32_t encoding;       /* enum ustctl_string_encodings */
 315         uint16_t alignment;     /* in bits */
 316         char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
 317 } LTTNG_PACKED;
 318
 319 #define USTCTL_UST_FLOAT_TYPE_PADDING   24
 320 struct ustctl_float_type {
 321         uint32_t exp_dig;               /* exponent digits, in bits */
 322         uint32_t mant_dig;              /* mantissa digits, in bits */
 323         uint32_t reverse_byte_order;
 324         uint16_t alignment;     /* in bits */
 325         char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
 326 } LTTNG_PACKED;
 327
 328 #define USTCTL_UST_ENUM_VALUE_PADDING   15
 329 struct ustctl_enum_value {
 330         uint64_t value;
 331         uint8_t signedness;
 332         char padding[USTCTL_UST_ENUM_VALUE_PADDING];
 333 } LTTNG_PACKED;
 334
 335 enum ustctl_ust_enum_entry_options {
 336         USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 337 };
 338
 339 #define USTCTL_UST_ENUM_ENTRY_PADDING   32
 340 struct ustctl_enum_entry {
 341         struct ustctl_enum_value start, end; /* start and end are inclusive */
 342         char string[LTTNG_UST_SYM_NAME_LEN];
 343         union {
 344                 struct {
 345                         uint32_t options;
 346                 } LTTNG_PACKED extra;
 347                 char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
 348         } u;
 349 } LTTNG_PACKED;
 350
 351 #define USTCTL_UST_BASIC_TYPE_PADDING   296
 352 union _ustctl_basic_type {
 353         struct ustctl_integer_type integer;
 354         struct {
 355                 char name[LTTNG_UST_SYM_NAME_LEN];
 356                 struct ustctl_integer_type container_type;
 357                 uint64_t id;    /* enum ID in sessiond. */
 358         } enumeration;
 359         struct {
 360                 int32_t encoding;       /* enum ustctl_string_encodings */
 361         } string;
 362         struct ustctl_float_type _float;
 363         char padding[USTCTL_UST_BASIC_TYPE_PADDING];
 364 } LTTNG_PACKED;
 365
 366 struct ustctl_basic_type {
 367         enum ustctl_abstract_types atype;
 368         union {
 369                 union _ustctl_basic_type basic;
 370         } u;
 371 } LTTNG_PACKED;
 372
 373 #define USTCTL_UST_TYPE_PADDING 128
 374 struct ustctl_type {
 375         enum ustctl_abstract_types atype;
 376         union {
 377                 union _ustctl_basic_type basic;
 378                 struct {
 379                         struct ustctl_basic_type elem_type;
 380                         uint32_t length;                /* num. elems. */
 381                 } array;
 382                 struct {
 383                         struct ustctl_basic_type length_type;
 384                         struct ustctl_basic_type elem_type;
 385                 } sequence;
 386                 struct {
 387                         uint32_t nr_choices;
 388                         char tag_name[LTTNG_UST_SYM_NAME_LEN];
 389                         /* Followed by nr_choices struct ustctl_field. */
 390                 } variant;
 391                 struct {
 392                         uint32_t nr_fields;
 393                         /* Followed by nr_fields struct ustctl_field. */
 394                 } _struct;
 395                 char padding[USTCTL_UST_TYPE_PADDING];
 396         } u;
 397 } LTTNG_PACKED;
 398
 399 #define USTCTL_UST_FIELD_PADDING        28
 400 struct ustctl_field {
 401         char name[LTTNG_UST_SYM_NAME_LEN];
 402         struct ustctl_type type;
 403         char padding[USTCTL_UST_FIELD_PADDING];
 404 } LTTNG_PACKED;
 405
 406 /*
 407  * Returns 0 on success, negative error value on error.
 408  * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 409  * the output fields are not populated.
 410  */
 411 int ustctl_recv_reg_msg(int sock,
 412         enum ustctl_socket_type *type,
 413         uint32_t *major,
 414         uint32_t *minor,
 415         uint32_t *pid,
 416         uint32_t *ppid,
 417         uint32_t *uid,
 418         uint32_t *gid,
 419         uint32_t *bits_per_long,
 420         uint32_t *uint8_t_alignment,
 421         uint32_t *uint16_t_alignment,
 422         uint32_t *uint32_t_alignment,
 423         uint32_t *uint64_t_alignment,
 424         uint32_t *long_alignment,
 425         int *byte_order,
 426         char *name);    /* size LTTNG_UST_ABI_PROCNAME_LEN */
 427
 428 /*
 429  * Returns 0 on success, negative UST or system error value on error.
 430  * Receive the notification command. The "notify_cmd" can then be used
 431  * by the caller to find out which ustctl_recv_* function should be
 432  * called to receive the notification, and which ustctl_reply_* is
 433  * appropriate.
 434  */
 435 int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
 436
 437 /*
 438  * Returns 0 on success, negative UST or system error value on error.
 439  */
 440 int ustctl_recv_register_event(int sock,
 441         int *session_objd,              /* session descriptor (output) */
 442         int *channel_objd,              /* channel descriptor (output) */
 443         char *event_name,               /*
 444                                          * event name (output,
 445                                          * size LTTNG_UST_SYM_NAME_LEN)
 446                                          */
 447         int *loglevel,
 448         char **signature,               /*
 449                                          * event signature
 450                                          * (output, dynamically
 451                                          * allocated, must be free(3)'d
 452                                          * by the caller if function
 453                                          * returns success.)
 454                                          */
 455         size_t *nr_fields,
 456         struct ustctl_field **fields,
 457         char **model_emf_uri);
 458
 459 /*
 460  * Returns 0 on success, negative error value on error.
 461  */
 462 int ustctl_reply_register_event(int sock,
 463         uint32_t id,                    /* event id (input) */
 464         int ret_code);                  /* return code. 0 ok, negative error */
 465
 466 /*
 467  * Returns 0 on success, negative UST or system error value on error.
 468  */
 469 int ustctl_recv_register_enum(int sock,
 470         int *session_objd,
 471         char *enum_name,
 472         struct ustctl_enum_entry **entries,
 473         size_t *nr_entries);
 474
 475 /*
 476  * Returns 0 on success, negative error value on error.
 477  */
 478 int ustctl_reply_register_enum(int sock,
 479         uint64_t id,                    /* enum id (input) */
 480         int ret_code);
 481
 482 /*
 483  * Returns 0 on success, negative UST or system error value on error.
 484  */
 485 int ustctl_recv_register_channel(int sock,
 486         int *session_objd,              /* session descriptor (output) */
 487         int *channel_objd,              /* channel descriptor (output) */
 488         size_t *nr_fields,              /* context fields */
 489         struct ustctl_field **fields);
 490
 491 /*
 492  * Returns 0 on success, negative error value on error.
 493  */
 494 int ustctl_reply_register_channel(int sock,
 495         uint32_t chan_id,
 496         enum ustctl_channel_header header_type,
 497         int ret_code);                  /* return code. 0 ok, negative error */
 498
 499 #endif /* _LTTNG_UST_CTL_H */