lttng-events.h

   1 #ifndef _LTTNG_EVENTS_H
   2 #define _LTTNG_EVENTS_H
   3
   4 /*
   5  * lttng-events.h
   6  *
   7  * Holds LTTng per-session event registry.
   8  *
   9  * Copyright (C) 2010-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  10  *
  11  * This library is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU Lesser General Public
  13  * License as published by the Free Software Foundation; only
  14  * version 2.1 of the License.
  15  *
  16  * This library is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19  * Lesser General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU Lesser General Public
  22  * License along with this library; if not, write to the Free Software
  23  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  24  */
  25
  26 #include <linux/version.h>
  27 #include <linux/list.h>
  28 #include <linux/kprobes.h>
  29 #include <linux/kref.h>
  30 #include "wrapper/uuid.h"
  31 #include "lttng-abi.h"
  32 #include "lttng-abi-old.h"
  33
  34 #define lttng_is_signed_type(type)      (((type)(-1)) < 0)
  35
  36 struct lttng_channel;
  37 struct lttng_session;
  38 struct lttng_metadata_cache;
  39 struct lib_ring_buffer_ctx;
  40 struct perf_event;
  41 struct perf_event_attr;
  42 struct lib_ring_buffer_config;
  43
  44 /* Type description */
  45
  46 /* Update the astract_types name table in lttng-types.c along with this enum */
  47 enum abstract_types {
  48         atype_integer,
  49         atype_enum,
  50         atype_array,
  51         atype_sequence,
  52         atype_string,
  53         NR_ABSTRACT_TYPES,
  54 };
  55
  56 /* Update the string_encodings name table in lttng-types.c along with this enum */
  57 enum lttng_string_encodings {
  58         lttng_encode_none = 0,
  59         lttng_encode_UTF8 = 1,
  60         lttng_encode_ASCII = 2,
  61         NR_STRING_ENCODINGS,
  62 };
  63
  64 enum channel_type {
  65         PER_CPU_CHANNEL,
  66         METADATA_CHANNEL,
  67 };
  68
  69 struct lttng_enum_entry {
  70         unsigned long long start, end;  /* start and end are inclusive */
  71         const char *string;
  72 };
  73
  74 #define __type_integer(_type, _byte_order, _base, _encoding)    \
  75         {                                                       \
  76             .atype = atype_integer,                             \
  77             .u.basic.integer =                                  \
  78                 {                                               \
  79                   .size = sizeof(_type) * CHAR_BIT,             \
  80                   .alignment = lttng_alignof(_type) * CHAR_BIT, \
  81                   .signedness = lttng_is_signed_type(_type),    \
  82                   .reverse_byte_order = _byte_order != __BYTE_ORDER,    \
  83                   .base = _base,                                \
  84                   .encoding = lttng_encode_##_encoding,         \
  85                 },                                              \
  86         }                                                       \
  87
  88 struct lttng_integer_type {
  89         unsigned int size;              /* in bits */
  90         unsigned short alignment;       /* in bits */
  91         unsigned int signedness:1,
  92                 reverse_byte_order:1;
  93         unsigned int base;              /* 2, 8, 10, 16, for pretty print */
  94         enum lttng_string_encodings encoding;
  95 };
  96
  97 union _lttng_basic_type {
  98         struct lttng_integer_type integer;
  99         struct {
 100                 const char *name;
 101         } enumeration;
 102         struct {
 103                 enum lttng_string_encodings encoding;
 104         } string;
 105 };
 106
 107 struct lttng_basic_type {
 108         enum abstract_types atype;
 109         union {
 110                 union _lttng_basic_type basic;
 111         } u;
 112 };
 113
 114 struct lttng_type {
 115         enum abstract_types atype;
 116         union {
 117                 union _lttng_basic_type basic;
 118                 struct {
 119                         struct lttng_basic_type elem_type;
 120                         unsigned int length;            /* num. elems. */
 121                 } array;
 122                 struct {
 123                         struct lttng_basic_type length_type;
 124                         struct lttng_basic_type elem_type;
 125                 } sequence;
 126         } u;
 127 };
 128
 129 struct lttng_enum {
 130         const char *name;
 131         struct lttng_type container_type;
 132         const struct lttng_enum_entry *entries;
 133         unsigned int len;
 134 };
 135
 136 /* Event field description */
 137
 138 struct lttng_event_field {
 139         const char *name;
 140         struct lttng_type type;
 141 };
 142
 143 /*
 144  * We need to keep this perf counter field separately from struct
 145  * lttng_ctx_field because cpu hotplug needs fixed-location addresses.
 146  */
 147 struct lttng_perf_counter_field {
 148         struct notifier_block nb;
 149         int hp_enable;
 150         struct perf_event_attr *attr;
 151         struct perf_event **e;  /* per-cpu array */
 152 };
 153
 154 struct lttng_ctx_field {
 155         struct lttng_event_field event_field;
 156         size_t (*get_size)(size_t offset);
 157         void (*record)(struct lttng_ctx_field *field,
 158                        struct lib_ring_buffer_ctx *ctx,
 159                        struct lttng_channel *chan);
 160         union {
 161                 struct lttng_perf_counter_field *perf_counter;
 162         } u;
 163         void (*destroy)(struct lttng_ctx_field *field);
 164 };
 165
 166 struct lttng_ctx {
 167         struct lttng_ctx_field *fields;
 168         unsigned int nr_fields;
 169         unsigned int allocated_fields;
 170 };
 171
 172 struct lttng_event_desc {
 173         const char *name;
 174         void *probe_callback;
 175         const struct lttng_event_ctx *ctx;      /* context */
 176         const struct lttng_event_field *fields; /* event payload */
 177         unsigned int nr_fields;
 178         struct module *owner;
 179 };
 180
 181 struct lttng_probe_desc {
 182         const struct lttng_event_desc **event_desc;
 183         unsigned int nr_events;
 184         struct list_head head;                  /* chain registered probes */
 185 };
 186
 187 struct lttng_krp;                               /* Kretprobe handling */
 188
 189 /*
 190  * lttng_event structure is referred to by the tracing fast path. It must be
 191  * kept small.
 192  */
 193 struct lttng_event {
 194         unsigned int id;
 195         struct lttng_channel *chan;
 196         int enabled;
 197         const struct lttng_event_desc *desc;
 198         void *filter;
 199         struct lttng_ctx *ctx;
 200         enum lttng_kernel_instrumentation instrumentation;
 201         union {
 202                 struct {
 203                         struct kprobe kp;
 204                         char *symbol_name;
 205                 } kprobe;
 206                 struct {
 207                         struct lttng_krp *lttng_krp;
 208                         char *symbol_name;
 209                 } kretprobe;
 210                 struct {
 211                         char *symbol_name;
 212                 } ftrace;
 213         } u;
 214         struct list_head list;          /* Event list */
 215         unsigned int metadata_dumped:1;
 216 };
 217
 218 struct lttng_channel_ops {
 219         struct channel *(*channel_create)(const char *name,
 220                                 struct lttng_channel *lttng_chan,
 221                                 void *buf_addr,
 222                                 size_t subbuf_size, size_t num_subbuf,
 223                                 unsigned int switch_timer_interval,
 224                                 unsigned int read_timer_interval);
 225         void (*channel_destroy)(struct channel *chan);
 226         struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
 227         int (*buffer_has_read_closed_stream)(struct channel *chan);
 228         void (*buffer_read_close)(struct lib_ring_buffer *buf);
 229         int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
 230                              uint32_t event_id);
 231         void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
 232         void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
 233                             size_t len);
 234         void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
 235                                       const void *src, size_t len);
 236         void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
 237                              int c, size_t len);
 238         /*
 239          * packet_avail_size returns the available size in the current
 240          * packet. Note that the size returned is only a hint, since it
 241          * may change due to concurrent writes.
 242          */
 243         size_t (*packet_avail_size)(struct channel *chan);
 244         wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
 245         wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 246         int (*is_finalized)(struct channel *chan);
 247         int (*is_disabled)(struct channel *chan);
 248         int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
 249                         struct lib_ring_buffer *bufb,
 250                         uint64_t *timestamp_begin);
 251         int (*timestamp_end) (const struct lib_ring_buffer_config *config,
 252                         struct lib_ring_buffer *bufb,
 253                         uint64_t *timestamp_end);
 254         int (*events_discarded) (const struct lib_ring_buffer_config *config,
 255                         struct lib_ring_buffer *bufb,
 256                         uint64_t *events_discarded);
 257         int (*content_size) (const struct lib_ring_buffer_config *config,
 258                         struct lib_ring_buffer *bufb,
 259                         uint64_t *content_size);
 260         int (*packet_size) (const struct lib_ring_buffer_config *config,
 261                         struct lib_ring_buffer *bufb,
 262                         uint64_t *packet_size);
 263         int (*stream_id) (const struct lib_ring_buffer_config *config,
 264                         struct lib_ring_buffer *bufb,
 265                         uint64_t *stream_id);
 266 };
 267
 268 struct lttng_transport {
 269         char *name;
 270         struct module *owner;
 271         struct list_head node;
 272         struct lttng_channel_ops ops;
 273 };
 274
 275 struct lttng_channel {
 276         unsigned int id;
 277         struct channel *chan;           /* Channel buffers */
 278         int enabled;
 279         struct lttng_ctx *ctx;
 280         /* Event ID management */
 281         struct lttng_session *session;
 282         struct file *file;              /* File associated to channel */
 283         unsigned int free_event_id;     /* Next event ID to allocate */
 284         struct list_head list;          /* Channel list */
 285         struct lttng_channel_ops *ops;
 286         struct lttng_transport *transport;
 287         struct lttng_event **sc_table;  /* for syscall tracing */
 288         struct lttng_event **compat_sc_table;
 289         struct lttng_event *sc_unknown; /* for unknown syscalls */
 290         struct lttng_event *sc_compat_unknown;
 291         struct lttng_event *sc_exit;    /* for syscall exit */
 292         int header_type;                /* 0: unset, 1: compact, 2: large */
 293         enum channel_type channel_type;
 294         unsigned int metadata_dumped:1;
 295 };
 296
 297 struct lttng_metadata_stream {
 298         void *priv;                     /* Ring buffer private data */
 299         struct lttng_metadata_cache *metadata_cache;
 300         unsigned int metadata_in;       /* Bytes read from the cache */
 301         unsigned int metadata_out;      /* Bytes consumed from stream */
 302         int finalized;                  /* Has channel been finalized */
 303         wait_queue_head_t read_wait;    /* Reader buffer-level wait queue */
 304         struct list_head list;          /* Stream list */
 305         struct lttng_transport *transport;
 306 };
 307
 308 struct lttng_session {
 309         int active;                     /* Is trace session active ? */
 310         int been_active;                /* Has trace session been active ? */
 311         struct file *file;              /* File associated to session */
 312         struct list_head chan;          /* Channel list head */
 313         struct list_head events;        /* Event list head */
 314         struct list_head list;          /* Session list */
 315         unsigned int free_chan_id;      /* Next chan ID to allocate */
 316         uuid_le uuid;                   /* Trace session unique ID */
 317         struct lttng_metadata_cache *metadata_cache;
 318         unsigned int metadata_dumped:1;
 319 };
 320
 321 struct lttng_metadata_cache {
 322         char *data;                     /* Metadata cache */
 323         unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
 324         unsigned int metadata_written;  /* Number of bytes written in metadata cache */
 325         struct kref refcount;           /* Metadata cache usage */
 326         struct list_head metadata_stream;       /* Metadata stream list */
 327 };
 328
 329 struct lttng_session *lttng_session_create(void);
 330 int lttng_session_enable(struct lttng_session *session);
 331 int lttng_session_disable(struct lttng_session *session);
 332 void lttng_session_destroy(struct lttng_session *session);
 333 void metadata_cache_destroy(struct kref *kref);
 334
 335 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 336                                        const char *transport_name,
 337                                        void *buf_addr,
 338                                        size_t subbuf_size, size_t num_subbuf,
 339                                        unsigned int switch_timer_interval,
 340                                        unsigned int read_timer_interval,
 341                                        enum channel_type channel_type);
 342 struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
 343                                        int overwrite, void *buf_addr,
 344                                        size_t subbuf_size, size_t num_subbuf,
 345                                        unsigned int switch_timer_interval,
 346                                        unsigned int read_timer_interval);
 347
 348 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
 349 struct lttng_event *lttng_event_create(struct lttng_channel *chan,
 350                                    struct lttng_kernel_event *event_param,
 351                                    void *filter,
 352                                    const struct lttng_event_desc *internal_desc);
 353 struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
 354                 struct lttng_kernel_old_event *old_event_param,
 355                 void *filter,
 356                 const struct lttng_event_desc *internal_desc);
 357
 358 int lttng_channel_enable(struct lttng_channel *channel);
 359 int lttng_channel_disable(struct lttng_channel *channel);
 360 int lttng_event_enable(struct lttng_event *event);
 361 int lttng_event_disable(struct lttng_event *event);
 362
 363 void lttng_transport_register(struct lttng_transport *transport);
 364 void lttng_transport_unregister(struct lttng_transport *transport);
 365
 366 void synchronize_trace(void);
 367 int lttng_abi_init(void);
 368 int lttng_abi_compat_old_init(void);
 369 void lttng_abi_exit(void);
 370 void lttng_abi_compat_old_exit(void);
 371
 372 int lttng_probe_register(struct lttng_probe_desc *desc);
 373 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 374 const struct lttng_event_desc *lttng_event_get(const char *name);
 375 void lttng_event_put(const struct lttng_event_desc *desc);
 376 int lttng_probes_init(void);
 377 void lttng_probes_exit(void);
 378
 379 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
 380                 struct channel *chan);
 381
 382 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
 383 int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
 384 int lttng_syscalls_unregister(struct lttng_channel *chan);
 385 #else
 386 static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
 387 {
 388         return -ENOSYS;
 389 }
 390
 391 static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
 392 {
 393         return 0;
 394 }
 395 #endif
 396
 397 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
 398 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
 399 void lttng_remove_context_field(struct lttng_ctx **ctx,
 400                                 struct lttng_ctx_field *field);
 401 void lttng_destroy_context(struct lttng_ctx *ctx);
 402 int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
 403 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 404 int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
 405 int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
 406 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
 407 int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
 408 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
 409 int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
 410 int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
 411 int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
 412 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
 413 int lttng_add_perf_counter_to_ctx(uint32_t type,
 414                                   uint64_t config,
 415                                   const char *name,
 416                                   struct lttng_ctx **ctx);
 417 #else
 418 static inline
 419 int lttng_add_perf_counter_to_ctx(uint32_t type,
 420                                   uint64_t config,
 421                                   const char *name,
 422                                   struct lttng_ctx **ctx)
 423 {
 424         return -ENOSYS;
 425 }
 426 #endif
 427
 428 extern int lttng_statedump_start(struct lttng_session *session);
 429
 430 #ifdef CONFIG_KPROBES
 431 int lttng_kprobes_register(const char *name,
 432                 const char *symbol_name,
 433                 uint64_t offset,
 434                 uint64_t addr,
 435                 struct lttng_event *event);
 436 void lttng_kprobes_unregister(struct lttng_event *event);
 437 void lttng_kprobes_destroy_private(struct lttng_event *event);
 438 #else
 439 static inline
 440 int lttng_kprobes_register(const char *name,
 441                 const char *symbol_name,
 442                 uint64_t offset,
 443                 uint64_t addr,
 444                 struct lttng_event *event)
 445 {
 446         return -ENOSYS;
 447 }
 448
 449 static inline
 450 void lttng_kprobes_unregister(struct lttng_event *event)
 451 {
 452 }
 453
 454 static inline
 455 void lttng_kprobes_destroy_private(struct lttng_event *event)
 456 {
 457 }
 458 #endif
 459
 460 #ifdef CONFIG_KRETPROBES
 461 int lttng_kretprobes_register(const char *name,
 462                 const char *symbol_name,
 463                 uint64_t offset,
 464                 uint64_t addr,
 465                 struct lttng_event *event_entry,
 466                 struct lttng_event *event_exit);
 467 void lttng_kretprobes_unregister(struct lttng_event *event);
 468 void lttng_kretprobes_destroy_private(struct lttng_event *event);
 469 #else
 470 static inline
 471 int lttng_kretprobes_register(const char *name,
 472                 const char *symbol_name,
 473                 uint64_t offset,
 474                 uint64_t addr,
 475                 struct lttng_event *event_entry,
 476                 struct lttng_event *event_exit)
 477 {
 478         return -ENOSYS;
 479 }
 480
 481 static inline
 482 void lttng_kretprobes_unregister(struct lttng_event *event)
 483 {
 484 }
 485
 486 static inline
 487 void lttng_kretprobes_destroy_private(struct lttng_event *event)
 488 {
 489 }
 490 #endif
 491
 492 #ifdef CONFIG_DYNAMIC_FTRACE
 493 int lttng_ftrace_register(const char *name,
 494                           const char *symbol_name,
 495                           struct lttng_event *event);
 496 void lttng_ftrace_unregister(struct lttng_event *event);
 497 void lttng_ftrace_destroy_private(struct lttng_event *event);
 498 #else
 499 static inline
 500 int lttng_ftrace_register(const char *name,
 501                           const char *symbol_name,
 502                           struct lttng_event *event)
 503 {
 504         return -ENOSYS;
 505 }
 506
 507 static inline
 508 void lttng_ftrace_unregister(struct lttng_event *event)
 509 {
 510 }
 511
 512 static inline
 513 void lttng_ftrace_destroy_private(struct lttng_event *event)
 514 {
 515 }
 516 #endif
 517
 518 int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
 519
 520 extern const struct file_operations lttng_tracepoint_list_fops;
 521
 522 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
 523 #define TRACEPOINT_HAS_DATA_ARG
 524 #endif
 525
 526 #endif /* _LTTNG_EVENTS_H */