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