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