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         size_t largest_align;   /* in bytes */
 171 };
 172
 173 struct lttng_event_desc {
 174         const char *name;               /* lttng-modules name */
 175         const char *kname;              /* Linux kernel name (tracepoints) */
 176         void *probe_callback;
 177         const struct lttng_event_ctx *ctx;      /* context */
 178         const struct lttng_event_field *fields; /* event payload */
 179         unsigned int nr_fields;
 180         struct module *owner;
 181 };
 182
 183 struct lttng_probe_desc {
 184         const struct lttng_event_desc **event_desc;
 185         unsigned int nr_events;
 186         struct list_head head;                  /* chain registered probes */
 187 };
 188
 189 struct lttng_krp;                               /* Kretprobe handling */
 190
 191 /*
 192  * lttng_event structure is referred to by the tracing fast path. It must be
 193  * kept small.
 194  */
 195 struct lttng_event {
 196         unsigned int id;
 197         struct lttng_channel *chan;
 198         int enabled;
 199         const struct lttng_event_desc *desc;
 200         void *filter;
 201         struct lttng_ctx *ctx;
 202         enum lttng_kernel_instrumentation instrumentation;
 203         union {
 204                 struct {
 205                         struct kprobe kp;
 206                         char *symbol_name;
 207                 } kprobe;
 208                 struct {
 209                         struct lttng_krp *lttng_krp;
 210                         char *symbol_name;
 211                 } kretprobe;
 212                 struct {
 213                         char *symbol_name;
 214                 } ftrace;
 215         } u;
 216         struct list_head list;          /* Event list */
 217         unsigned int metadata_dumped:1;
 218 };
 219
 220 struct lttng_channel_ops {
 221         struct channel *(*channel_create)(const char *name,
 222                                 struct lttng_channel *lttng_chan,
 223                                 void *buf_addr,
 224                                 size_t subbuf_size, size_t num_subbuf,
 225                                 unsigned int switch_timer_interval,
 226                                 unsigned int read_timer_interval);
 227         void (*channel_destroy)(struct channel *chan);
 228         struct lib_ring_buffer *(*buffer_read_open)(struct channel *chan);
 229         int (*buffer_has_read_closed_stream)(struct channel *chan);
 230         void (*buffer_read_close)(struct lib_ring_buffer *buf);
 231         int (*event_reserve)(struct lib_ring_buffer_ctx *ctx,
 232                              uint32_t event_id);
 233         void (*event_commit)(struct lib_ring_buffer_ctx *ctx);
 234         void (*event_write)(struct lib_ring_buffer_ctx *ctx, const void *src,
 235                             size_t len);
 236         void (*event_write_from_user)(struct lib_ring_buffer_ctx *ctx,
 237                                       const void *src, size_t len);
 238         void (*event_memset)(struct lib_ring_buffer_ctx *ctx,
 239                              int c, size_t len);
 240         void (*event_strcpy)(struct lib_ring_buffer_ctx *ctx, const char *src,
 241                              size_t len);
 242         void (*event_strcpy_from_user)(struct lib_ring_buffer_ctx *ctx,
 243                                        const char __user *src, size_t len);
 244         /*
 245          * packet_avail_size returns the available size in the current
 246          * packet. Note that the size returned is only a hint, since it
 247          * may change due to concurrent writes.
 248          */
 249         size_t (*packet_avail_size)(struct channel *chan);
 250         wait_queue_head_t *(*get_writer_buf_wait_queue)(struct channel *chan, int cpu);
 251         wait_queue_head_t *(*get_hp_wait_queue)(struct channel *chan);
 252         int (*is_finalized)(struct channel *chan);
 253         int (*is_disabled)(struct channel *chan);
 254         int (*timestamp_begin) (const struct lib_ring_buffer_config *config,
 255                         struct lib_ring_buffer *bufb,
 256                         uint64_t *timestamp_begin);
 257         int (*timestamp_end) (const struct lib_ring_buffer_config *config,
 258                         struct lib_ring_buffer *bufb,
 259                         uint64_t *timestamp_end);
 260         int (*events_discarded) (const struct lib_ring_buffer_config *config,
 261                         struct lib_ring_buffer *bufb,
 262                         uint64_t *events_discarded);
 263         int (*content_size) (const struct lib_ring_buffer_config *config,
 264                         struct lib_ring_buffer *bufb,
 265                         uint64_t *content_size);
 266         int (*packet_size) (const struct lib_ring_buffer_config *config,
 267                         struct lib_ring_buffer *bufb,
 268                         uint64_t *packet_size);
 269         int (*stream_id) (const struct lib_ring_buffer_config *config,
 270                         struct lib_ring_buffer *bufb,
 271                         uint64_t *stream_id);
 272         int (*current_timestamp) (const struct lib_ring_buffer_config *config,
 273                         struct lib_ring_buffer *bufb,
 274                         uint64_t *ts);
 275 };
 276
 277 struct lttng_transport {
 278         char *name;
 279         struct module *owner;
 280         struct list_head node;
 281         struct lttng_channel_ops ops;
 282 };
 283
 284 struct lttng_channel {
 285         unsigned int id;
 286         struct channel *chan;           /* Channel buffers */
 287         int enabled;
 288         struct lttng_ctx *ctx;
 289         /* Event ID management */
 290         struct lttng_session *session;
 291         struct file *file;              /* File associated to channel */
 292         unsigned int free_event_id;     /* Next event ID to allocate */
 293         struct list_head list;          /* Channel list */
 294         struct lttng_channel_ops *ops;
 295         struct lttng_transport *transport;
 296         struct lttng_event **sc_table;  /* for syscall tracing */
 297         struct lttng_event **compat_sc_table;
 298         struct lttng_event *sc_unknown; /* for unknown syscalls */
 299         struct lttng_event *sc_compat_unknown;
 300         struct lttng_event *sc_exit;    /* for syscall exit */
 301         int header_type;                /* 0: unset, 1: compact, 2: large */
 302         enum channel_type channel_type;
 303         unsigned int metadata_dumped:1;
 304 };
 305
 306 struct lttng_metadata_stream {
 307         void *priv;                     /* Ring buffer private data */
 308         struct lttng_metadata_cache *metadata_cache;
 309         unsigned int metadata_in;       /* Bytes read from the cache */
 310         unsigned int metadata_out;      /* Bytes consumed from stream */
 311         int finalized;                  /* Has channel been finalized */
 312         wait_queue_head_t read_wait;    /* Reader buffer-level wait queue */
 313         struct list_head list;          /* Stream list */
 314         struct lttng_transport *transport;
 315         struct mutex lock;
 316 };
 317
 318 struct lttng_session {
 319         int active;                     /* Is trace session active ? */
 320         int been_active;                /* Has trace session been active ? */
 321         struct file *file;              /* File associated to session */
 322         struct list_head chan;          /* Channel list head */
 323         struct list_head events;        /* Event list head */
 324         struct list_head list;          /* Session list */
 325         unsigned int free_chan_id;      /* Next chan ID to allocate */
 326         uuid_le uuid;                   /* Trace session unique ID */
 327         struct lttng_metadata_cache *metadata_cache;
 328         unsigned int metadata_dumped:1;
 329 };
 330
 331 struct lttng_metadata_cache {
 332         char *data;                     /* Metadata cache */
 333         unsigned int cache_alloc;       /* Metadata allocated size (bytes) */
 334         unsigned int metadata_written;  /* Number of bytes written in metadata cache */
 335         struct kref refcount;           /* Metadata cache usage */
 336         struct list_head metadata_stream;       /* Metadata stream list */
 337         uuid_le uuid;                   /* Trace session unique ID (copy) */
 338 };
 339
 340 struct lttng_session *lttng_session_create(void);
 341 int lttng_session_enable(struct lttng_session *session);
 342 int lttng_session_disable(struct lttng_session *session);
 343 void lttng_session_destroy(struct lttng_session *session);
 344 void metadata_cache_destroy(struct kref *kref);
 345
 346 struct lttng_channel *lttng_channel_create(struct lttng_session *session,
 347                                        const char *transport_name,
 348                                        void *buf_addr,
 349                                        size_t subbuf_size, size_t num_subbuf,
 350                                        unsigned int switch_timer_interval,
 351                                        unsigned int read_timer_interval,
 352                                        enum channel_type channel_type);
 353 struct lttng_channel *lttng_global_channel_create(struct lttng_session *session,
 354                                        int overwrite, void *buf_addr,
 355                                        size_t subbuf_size, size_t num_subbuf,
 356                                        unsigned int switch_timer_interval,
 357                                        unsigned int read_timer_interval);
 358
 359 void lttng_metadata_channel_destroy(struct lttng_channel *chan);
 360 struct lttng_event *lttng_event_create(struct lttng_channel *chan,
 361                                    struct lttng_kernel_event *event_param,
 362                                    void *filter,
 363                                    const struct lttng_event_desc *internal_desc);
 364 struct lttng_event *lttng_event_compat_old_create(struct lttng_channel *chan,
 365                 struct lttng_kernel_old_event *old_event_param,
 366                 void *filter,
 367                 const struct lttng_event_desc *internal_desc);
 368
 369 int lttng_channel_enable(struct lttng_channel *channel);
 370 int lttng_channel_disable(struct lttng_channel *channel);
 371 int lttng_event_enable(struct lttng_event *event);
 372 int lttng_event_disable(struct lttng_event *event);
 373
 374 void lttng_transport_register(struct lttng_transport *transport);
 375 void lttng_transport_unregister(struct lttng_transport *transport);
 376
 377 void synchronize_trace(void);
 378 int lttng_abi_init(void);
 379 int lttng_abi_compat_old_init(void);
 380 void lttng_abi_exit(void);
 381 void lttng_abi_compat_old_exit(void);
 382
 383 int lttng_probe_register(struct lttng_probe_desc *desc);
 384 void lttng_probe_unregister(struct lttng_probe_desc *desc);
 385 const struct lttng_event_desc *lttng_event_get(const char *name);
 386 void lttng_event_put(const struct lttng_event_desc *desc);
 387 int lttng_probes_init(void);
 388 void lttng_probes_exit(void);
 389
 390 int lttng_metadata_output_channel(struct lttng_metadata_stream *stream,
 391                 struct channel *chan);
 392
 393 #if defined(CONFIG_HAVE_SYSCALL_TRACEPOINTS)
 394 int lttng_syscalls_register(struct lttng_channel *chan, void *filter);
 395 int lttng_syscalls_unregister(struct lttng_channel *chan);
 396 #else
 397 static inline int lttng_syscalls_register(struct lttng_channel *chan, void *filter)
 398 {
 399         return -ENOSYS;
 400 }
 401
 402 static inline int lttng_syscalls_unregister(struct lttng_channel *chan)
 403 {
 404         return 0;
 405 }
 406 #endif
 407
 408 struct lttng_ctx_field *lttng_append_context(struct lttng_ctx **ctx);
 409 void lttng_context_update(struct lttng_ctx *ctx);
 410 int lttng_find_context(struct lttng_ctx *ctx, const char *name);
 411 void lttng_remove_context_field(struct lttng_ctx **ctx,
 412                                 struct lttng_ctx_field *field);
 413 void lttng_destroy_context(struct lttng_ctx *ctx);
 414 int lttng_add_pid_to_ctx(struct lttng_ctx **ctx);
 415 int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 416 int lttng_add_prio_to_ctx(struct lttng_ctx **ctx);
 417 int lttng_add_nice_to_ctx(struct lttng_ctx **ctx);
 418 int lttng_add_vpid_to_ctx(struct lttng_ctx **ctx);
 419 int lttng_add_tid_to_ctx(struct lttng_ctx **ctx);
 420 int lttng_add_vtid_to_ctx(struct lttng_ctx **ctx);
 421 int lttng_add_ppid_to_ctx(struct lttng_ctx **ctx);
 422 int lttng_add_vppid_to_ctx(struct lttng_ctx **ctx);
 423 int lttng_add_hostname_to_ctx(struct lttng_ctx **ctx);
 424 #if defined(CONFIG_PERF_EVENTS) && (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,33))
 425 int lttng_add_perf_counter_to_ctx(uint32_t type,
 426                                   uint64_t config,
 427                                   const char *name,
 428                                   struct lttng_ctx **ctx);
 429 #else
 430 static inline
 431 int lttng_add_perf_counter_to_ctx(uint32_t type,
 432                                   uint64_t config,
 433                                   const char *name,
 434                                   struct lttng_ctx **ctx)
 435 {
 436         return -ENOSYS;
 437 }
 438 #endif
 439
 440 extern int lttng_statedump_start(struct lttng_session *session);
 441
 442 #ifdef CONFIG_KPROBES
 443 int lttng_kprobes_register(const char *name,
 444                 const char *symbol_name,
 445                 uint64_t offset,
 446                 uint64_t addr,
 447                 struct lttng_event *event);
 448 void lttng_kprobes_unregister(struct lttng_event *event);
 449 void lttng_kprobes_destroy_private(struct lttng_event *event);
 450 #else
 451 static inline
 452 int lttng_kprobes_register(const char *name,
 453                 const char *symbol_name,
 454                 uint64_t offset,
 455                 uint64_t addr,
 456                 struct lttng_event *event)
 457 {
 458         return -ENOSYS;
 459 }
 460
 461 static inline
 462 void lttng_kprobes_unregister(struct lttng_event *event)
 463 {
 464 }
 465
 466 static inline
 467 void lttng_kprobes_destroy_private(struct lttng_event *event)
 468 {
 469 }
 470 #endif
 471
 472 #ifdef CONFIG_KRETPROBES
 473 int lttng_kretprobes_register(const char *name,
 474                 const char *symbol_name,
 475                 uint64_t offset,
 476                 uint64_t addr,
 477                 struct lttng_event *event_entry,
 478                 struct lttng_event *event_exit);
 479 void lttng_kretprobes_unregister(struct lttng_event *event);
 480 void lttng_kretprobes_destroy_private(struct lttng_event *event);
 481 #else
 482 static inline
 483 int lttng_kretprobes_register(const char *name,
 484                 const char *symbol_name,
 485                 uint64_t offset,
 486                 uint64_t addr,
 487                 struct lttng_event *event_entry,
 488                 struct lttng_event *event_exit)
 489 {
 490         return -ENOSYS;
 491 }
 492
 493 static inline
 494 void lttng_kretprobes_unregister(struct lttng_event *event)
 495 {
 496 }
 497
 498 static inline
 499 void lttng_kretprobes_destroy_private(struct lttng_event *event)
 500 {
 501 }
 502 #endif
 503
 504 #ifdef CONFIG_DYNAMIC_FTRACE
 505 int lttng_ftrace_register(const char *name,
 506                           const char *symbol_name,
 507                           struct lttng_event *event);
 508 void lttng_ftrace_unregister(struct lttng_event *event);
 509 void lttng_ftrace_destroy_private(struct lttng_event *event);
 510 #else
 511 static inline
 512 int lttng_ftrace_register(const char *name,
 513                           const char *symbol_name,
 514                           struct lttng_event *event)
 515 {
 516         return -ENOSYS;
 517 }
 518
 519 static inline
 520 void lttng_ftrace_unregister(struct lttng_event *event)
 521 {
 522 }
 523
 524 static inline
 525 void lttng_ftrace_destroy_private(struct lttng_event *event)
 526 {
 527 }
 528 #endif
 529
 530 int lttng_calibrate(struct lttng_kernel_calibrate *calibrate);
 531
 532 extern const struct file_operations lttng_tracepoint_list_fops;
 533
 534 #if (LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,35))
 535 #define TRACEPOINT_HAS_DATA_ARG
 536 #endif
 537
 538 #endif /* _LTTNG_EVENTS_H */