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 } LTTNG_PACKED;
  57
  58 /*
  59  * API used by sessiond.
  60  */
  61
  62 struct lttng_ust_context_attr {
  63         enum lttng_ust_context_type ctx;
  64         union {
  65                 struct lttng_ust_perf_counter_ctx perf_counter;
  66                 struct {
  67                         char *provider_name;
  68                         char *ctx_name;
  69                 } app_ctx;
  70         } u;
  71 };
  72
  73 /*
  74  * Error values: all the following functions return:
  75  * >= 0: Success (LTTNG_UST_OK)
  76  * < 0: error code.
  77  */
  78 int ustctl_register_done(int sock);
  79 int ustctl_create_session(int sock);
  80 int ustctl_create_event(int sock, struct lttng_ust_event *ev,
  81                 struct lttng_ust_object_data *channel_data,
  82                 struct lttng_ust_object_data **event_data);
  83 int ustctl_add_context(int sock, struct lttng_ust_context_attr *ctx,
  84                 struct lttng_ust_object_data *obj_data,
  85                 struct lttng_ust_object_data **context_data);
  86 int ustctl_set_filter(int sock, struct lttng_ust_filter_bytecode *bytecode,
  87                 struct lttng_ust_object_data *obj_data);
  88
  89 int ustctl_enable(int sock, struct lttng_ust_object_data *object);
  90 int ustctl_disable(int sock, struct lttng_ust_object_data *object);
  91 int ustctl_start_session(int sock, int handle);
  92 int ustctl_stop_session(int sock, int handle);
  93
  94 /*
  95  * ustctl_tracepoint_list returns a tracepoint list handle, or negative
  96  * error value.
  97  */
  98 int ustctl_tracepoint_list(int sock);
  99
 100 /*
 101  * ustctl_tracepoint_list_get is used to iterate on the tp list
 102  * handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 103  * returned.
 104  */
 105 int ustctl_tracepoint_list_get(int sock, int tp_list_handle,
 106                 struct lttng_ust_tracepoint_iter *iter);
 107
 108 /*
 109  * ustctl_tracepoint_field_list returns a tracepoint field list handle,
 110  * or negative error value.
 111  */
 112 int ustctl_tracepoint_field_list(int sock);
 113
 114 /*
 115  * ustctl_tracepoint_field_list_get is used to iterate on the tp field
 116  * list handle. End is iteration is reached when -LTTNG_UST_ERR_NOENT is
 117  * returned.
 118  */
 119 int ustctl_tracepoint_field_list_get(int sock, int tp_field_list_handle,
 120                 struct lttng_ust_field_iter *iter);
 121
 122 int ustctl_tracer_version(int sock, struct lttng_ust_tracer_version *v);
 123 int ustctl_wait_quiescent(int sock);
 124
 125 int ustctl_sock_flush_buffer(int sock, struct lttng_ust_object_data *object);
 126
 127 /* Release object created by members of this API. */
 128 int ustctl_release_object(int sock, struct lttng_ust_object_data *data);
 129 /* Release handle returned by create session. */
 130 int ustctl_release_handle(int sock, int handle);
 131
 132 int ustctl_recv_channel_from_consumer(int sock,
 133                 struct lttng_ust_object_data **channel_data);
 134 int ustctl_recv_stream_from_consumer(int sock,
 135                 struct lttng_ust_object_data **stream_data);
 136 int ustctl_send_channel_to_ust(int sock, int session_handle,
 137                 struct lttng_ust_object_data *channel_data);
 138 int ustctl_send_stream_to_ust(int sock,
 139                 struct lttng_ust_object_data *channel_data,
 140                 struct lttng_ust_object_data *stream_data);
 141
 142 /*
 143  * ustctl_duplicate_ust_object_data allocated a new object in "dest" if
 144  * it succeeds (returns 0). It must be released using
 145  * ustctl_release_object() and then freed with free().
 146  */
 147 int ustctl_duplicate_ust_object_data(struct lttng_ust_object_data **dest,
 148                 struct lttng_ust_object_data *src);
 149
 150 /*
 151  * API used by consumer.
 152  */
 153
 154 struct ustctl_consumer_channel;
 155 struct ustctl_consumer_stream;
 156 struct ustctl_consumer_channel_attr;
 157
 158 struct ustctl_consumer_channel *
 159         ustctl_create_channel(struct ustctl_consumer_channel_attr *attr);
 160 /*
 161  * Each stream created needs to be destroyed before calling
 162  * ustctl_destroy_channel().
 163  */
 164 void ustctl_destroy_channel(struct ustctl_consumer_channel *chan);
 165
 166 int ustctl_send_channel_to_sessiond(int sock,
 167                 struct ustctl_consumer_channel *channel);
 168 int ustctl_channel_close_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 169 int ustctl_channel_close_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 170 int ustctl_channel_get_wait_fd(struct ustctl_consumer_channel *consumer_chan);
 171 int ustctl_channel_get_wakeup_fd(struct ustctl_consumer_channel *consumer_chan);
 172
 173 int ustctl_write_metadata_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_sample_positions(struct ustctl_consumer_stream *stream);
 219 int ustctl_snapshot_get_consumed(struct ustctl_consumer_stream *stream,
 220                 unsigned long *pos);
 221 int ustctl_snapshot_get_produced(struct ustctl_consumer_stream *stream,
 222                 unsigned long *pos);
 223 int ustctl_get_subbuf(struct ustctl_consumer_stream *stream,
 224                 unsigned long *pos);
 225 int ustctl_put_subbuf(struct ustctl_consumer_stream *stream);
 226
 227 void ustctl_flush_buffer(struct ustctl_consumer_stream *stream,
 228                 int producer_active);
 229
 230 /* event registry management */
 231
 232 enum ustctl_socket_type {
 233         USTCTL_SOCKET_CMD = 0,
 234         USTCTL_SOCKET_NOTIFY = 1,
 235 };
 236
 237 enum ustctl_notify_cmd {
 238         USTCTL_NOTIFY_CMD_EVENT = 0,
 239         USTCTL_NOTIFY_CMD_CHANNEL = 1,
 240         USTCTL_NOTIFY_CMD_ENUM = 2,
 241 };
 242
 243 enum ustctl_channel_header {
 244         USTCTL_CHANNEL_HEADER_UNKNOWN = 0,
 245         USTCTL_CHANNEL_HEADER_COMPACT = 1,
 246         USTCTL_CHANNEL_HEADER_LARGE = 2,
 247 };
 248
 249 /* event type structures */
 250
 251 enum ustctl_abstract_types {
 252         ustctl_atype_integer,
 253         ustctl_atype_enum,
 254         ustctl_atype_array,
 255         ustctl_atype_sequence,
 256         ustctl_atype_string,
 257         ustctl_atype_float,
 258         NR_USTCTL_ABSTRACT_TYPES,
 259 };
 260
 261 enum ustctl_string_encodings {
 262         ustctl_encode_none = 0,
 263         ustctl_encode_UTF8 = 1,
 264         ustctl_encode_ASCII = 2,
 265         NR_USTCTL_STRING_ENCODINGS,
 266 };
 267
 268 #define USTCTL_UST_INTEGER_TYPE_PADDING 24
 269 struct ustctl_integer_type {
 270         uint32_t size;          /* in bits */
 271         uint32_t signedness;
 272         uint32_t reverse_byte_order;
 273         uint32_t base;          /* 2, 8, 10, 16, for pretty print */
 274         int32_t encoding;
 275         uint16_t alignment;     /* in bits */
 276         char padding[USTCTL_UST_INTEGER_TYPE_PADDING];
 277 } LTTNG_PACKED;
 278
 279 #define USTCTL_UST_FLOAT_TYPE_PADDING   24
 280 struct ustctl_float_type {
 281         uint32_t exp_dig;               /* exponent digits, in bits */
 282         uint32_t mant_dig;              /* mantissa digits, in bits */
 283         uint32_t reverse_byte_order;
 284         uint16_t alignment;     /* in bits */
 285         char padding[USTCTL_UST_FLOAT_TYPE_PADDING];
 286 } LTTNG_PACKED;
 287
 288 #define USTCTL_UST_ENUM_VALUE_PADDING   15
 289 struct ustctl_enum_value {
 290         uint64_t value;
 291         uint8_t signedness;
 292         char padding[USTCTL_UST_ENUM_VALUE_PADDING];
 293 } LTTNG_PACKED;
 294
 295 enum ustctl_ust_enum_entry_options {
 296         USTCTL_UST_ENUM_ENTRY_OPTION_IS_AUTO = 1U << 0,
 297 };
 298
 299 #define USTCTL_UST_ENUM_ENTRY_PADDING   32
 300 struct ustctl_enum_entry {
 301         struct ustctl_enum_value start, end; /* start and end are inclusive */
 302         char string[LTTNG_UST_SYM_NAME_LEN];
 303         union {
 304                 struct {
 305                         uint32_t options;
 306                 } LTTNG_PACKED extra;
 307                 char padding[USTCTL_UST_ENUM_ENTRY_PADDING];
 308         } u;
 309 } LTTNG_PACKED;
 310
 311 #define USTCTL_UST_BASIC_TYPE_PADDING   296
 312 union _ustctl_basic_type {
 313         struct ustctl_integer_type integer;
 314         struct {
 315                 int32_t encoding;
 316         } string;
 317         struct ustctl_float_type _float;
 318         struct {
 319                 char name[LTTNG_UST_SYM_NAME_LEN];
 320         } enumeration;
 321         char padding[USTCTL_UST_BASIC_TYPE_PADDING];
 322 } LTTNG_PACKED;
 323
 324 struct ustctl_basic_type {
 325         enum ustctl_abstract_types atype;
 326         union {
 327                 union _ustctl_basic_type basic;
 328         } u;
 329 } LTTNG_PACKED;
 330
 331 #define USTCTL_UST_TYPE_PADDING 128
 332 struct ustctl_type {
 333         enum ustctl_abstract_types atype;
 334         union {
 335                 union _ustctl_basic_type basic;
 336                 struct {
 337                         struct ustctl_basic_type elem_type;
 338                         uint32_t length;                /* num. elems. */
 339                 } array;
 340                 struct {
 341                         struct ustctl_basic_type length_type;
 342                         struct ustctl_basic_type elem_type;
 343                 } sequence;
 344                 char padding[USTCTL_UST_TYPE_PADDING];
 345         } u;
 346 } LTTNG_PACKED;
 347
 348 #define USTCTL_UST_FIELD_PADDING        28
 349 struct ustctl_field {
 350         char name[LTTNG_UST_SYM_NAME_LEN];
 351         struct ustctl_type type;
 352         char padding[USTCTL_UST_FIELD_PADDING];
 353 } LTTNG_PACKED;
 354
 355 /*
 356  * Returns 0 on success, negative error value on error.
 357  * If an error other than -LTTNG_UST_ERR_UNSUP_MAJOR is returned,
 358  * the output fields are not populated.
 359  */
 360 int ustctl_recv_reg_msg(int sock,
 361         enum ustctl_socket_type *type,
 362         uint32_t *major,
 363         uint32_t *minor,
 364         uint32_t *pid,
 365         uint32_t *ppid,
 366         uint32_t *uid,
 367         uint32_t *gid,
 368         uint32_t *bits_per_long,
 369         uint32_t *uint8_t_alignment,
 370         uint32_t *uint16_t_alignment,
 371         uint32_t *uint32_t_alignment,
 372         uint32_t *uint64_t_alignment,
 373         uint32_t *long_alignment,
 374         int *byte_order,
 375         char *name);    /* size LTTNG_UST_ABI_PROCNAME_LEN */
 376
 377 /*
 378  * Returns 0 on success, negative UST or system error value on error.
 379  * Receive the notification command. The "notify_cmd" can then be used
 380  * by the caller to find out which ustctl_recv_* function should be
 381  * called to receive the notification, and which ustctl_reply_* is
 382  * appropriate.
 383  */
 384 int ustctl_recv_notify(int sock, enum ustctl_notify_cmd *notify_cmd);
 385
 386 /*
 387  * Returns 0 on success, negative UST or system error value on error.
 388  */
 389 int ustctl_recv_register_event(int sock,
 390         int *session_objd,              /* session descriptor (output) */
 391         int *channel_objd,              /* channel descriptor (output) */
 392         char *event_name,               /*
 393                                          * event name (output,
 394                                          * size LTTNG_UST_SYM_NAME_LEN)
 395                                          */
 396         int *loglevel_value,
 397         char **signature,               /*
 398                                          * event signature
 399                                          * (output, dynamically
 400                                          * allocated, must be free(3)'d
 401                                          * by the caller if function
 402                                          * returns success.)
 403                                          */
 404         size_t *nr_fields,
 405         struct ustctl_field **fields,
 406         char **model_emf_uri);
 407
 408 /*
 409  * Returns 0 on success, negative error value on error.
 410  */
 411 int ustctl_reply_register_event(int sock,
 412         uint32_t id,                    /* event id (input) */
 413         int ret_code);                  /* return code. 0 ok, negative error */
 414
 415 /*
 416  * Returns 0 on success, negative UST or system error value on error.
 417  */
 418 int ustctl_recv_register_enum(int sock,
 419         int *session_objd,
 420         char *enum_name,
 421         struct ustctl_enum_entry **entries,
 422         unsigned int *nr_entries);
 423
 424 /*
 425  * Returns 0 on success, negative error value on error.
 426  */
 427 int ustctl_reply_register_enum(int sock,
 428         int64_t id,                     /* enum id (input) */
 429         int ret_code);
 430
 431 /*
 432  * Returns 0 on success, negative UST or system error value on error.
 433  */
 434 int ustctl_recv_register_channel(int sock,
 435         int *session_objd,              /* session descriptor (output) */
 436         int *channel_objd,              /* channel descriptor (output) */
 437         size_t *nr_fields,              /* context fields */
 438         struct ustctl_field **fields);
 439
 440 /*
 441  * Returns 0 on success, negative error value on error.
 442  */
 443 int ustctl_reply_register_channel(int sock,
 444         uint32_t chan_id,
 445         enum ustctl_channel_header header_type,
 446         int ret_code);                  /* return code. 0 ok, negative error */
 447
 448 #endif /* _LTTNG_UST_CTL_H */