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