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