Update licensing info
[lttng-modules.git] / probes / lttng-events.h
index ee7e5d9694fdd6790c152f5ab54f3d9ea95582a2..16e268044aefda3a77534605f6b67198ecc56474 100644 (file)
@@ -1,21 +1,20 @@
-#include <lttng.h>
-#include <lttng-types.h>
+/*
+ * lttng-events.h
+ *
+ * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
+ * Copyright (C) 2010-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ *
+ * Dual LGPL v2.1/GPL v2 license.
+ */
+
 #include <linux/debugfs.h>
-#include <linux/ringbuffer/frontend_types.h>
+#include "lttng.h"
+#include "lttng-types.h"
+#include "../wrapper/vmalloc.h"        /* for wrapper_vmalloc_sync_all() */
+#include "../wrapper/ringbuffer/frontend_types.h"
 #include "../ltt-events.h"
 #include "../ltt-tracer-core.h"
 
-struct lttng_event_field {
-       const char *name;
-       const struct lttng_type type;
-};
-
-struct lttng_event_desc {
-       const struct lttng_event_field *fields;
-       const char *name;
-       unsigned int nr_fields;
-};
-
 /*
  * Macro declarations used for all stages.
  */
@@ -54,6 +53,28 @@ struct lttng_event_desc {
 /*
  * Stage 1 of the trace events.
  *
+ * Create dummy trace calls for each events, verifying that the LTTng module
+ * TRACE_EVENT headers match the kernel arguments. Will be optimized out by the
+ * compiler.
+ */
+
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
+
+#undef TP_PROTO
+#define TP_PROTO(args...) args
+
+#undef TP_ARGS
+#define TP_ARGS(args...) args
+
+#undef DEFINE_EVENT
+#define DEFINE_EVENT(_template, _name, _proto, _args)                  \
+void trace_##_name(_proto);
+
+#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
+
+/*
+ * Stage 2 of the trace events.
+ *
  * Create event field type metadata section.
  * Each event produce an array of fields.
  */
@@ -64,43 +85,75 @@ struct lttng_event_desc {
 
 #undef __field
 #define __field(_type, _item)                                  \
-       { .name = #_item, .type = { .atype = atype_integer, .name = #_type} },
+       {                                                       \
+         .name = #_item,                                       \
+         .type = __type_integer(_type, __BYTE_ORDER, 10, none),\
+       },
 
 #undef __field_ext
 #define __field_ext(_type, _item, _filter_type)                __field(_type, _item)
 
-#undef __array
-#define __array(_type, _item, _length)                         \
+#undef __field_network
+#define __field_network(_type, _item)                          \
        {                                                       \
-               .name = #_item,                                 \
-               .type = {                                       \
+         .name = #_item,                                       \
+         .type = __type_integer(_type, __BIG_ENDIAN, 10, none),\
+       },
+
+#undef __array_enc
+#define __array_enc(_type, _item, _length, _encoding)          \
+       {                                                       \
+         .name = #_item,                                       \
+         .type =                                               \
+               {                                               \
                  .atype = atype_array,                         \
-                 .name = NULL,                                 \
-                 .u.array.elem_type = #_type,                  \
-                 .u.array.length = _length,                    \
+                 .u.array =                                    \
+                       {                                       \
+                           .length = _length,                  \
+                           .elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
+                       },                                      \
                },                                              \
        },
 
-#undef __dynamic_array
-#define __dynamic_array(_type, _item, _length)                 \
+#undef __array
+#define __array(_type, _item, _length)                         \
+       __array_enc(_type, _item, _length, none)
+
+#undef __array_text
+#define __array_text(_type, _item, _length)                    \
+       __array_enc(_type, _item, _length, UTF8)
+
+#undef __dynamic_array_enc
+#define __dynamic_array_enc(_type, _item, _length, _encoding)  \
        {                                                       \
-               .name = #_item,                                 \
-               .type = {                                       \
+         .name = #_item,                                       \
+         .type =                                               \
+               {                                               \
                  .atype = atype_sequence,                      \
-                 .name = NULL,                                 \
-                 .u.sequence.elem_type = #_type,               \
-                 .u.sequence.length_type = "u32",              \
+                 .u.sequence =                                 \
+                       {                                       \
+                           .length_type = __type_integer(u32, __BYTE_ORDER, 10, none), \
+                           .elem_type = __type_integer(_type, __BYTE_ORDER, 10, _encoding), \
+                       },                                      \
                },                                              \
        },
 
+#undef __dynamic_array
+#define __dynamic_array(_type, _item, _length)                 \
+       __dynamic_array_enc(_type, _item, _length, none)
+
+#undef __dynamic_array_text
+#define __dynamic_array_text(_type, _item, _length)            \
+       __dynamic_array_enc(_type, _item, _length, UTF8)
+
 #undef __string
 #define __string(_item, _src)                                  \
        {                                                       \
-               .name = #_item,                                 \
-               .type = {                                       \
+         .name = #_item,                                       \
+         .type =                                               \
+               {                                               \
                  .atype = atype_string,                        \
-                 .name = NULL,                                 \
-                 .u.string.encoding = lttng_encode_UTF8,       \
+                 .u.basic.string.encoding = lttng_encode_UTF8, \
                },                                              \
        },
 
@@ -115,8 +168,27 @@ struct lttng_event_desc {
 
 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
+#undef __type_integer
+
 /*
- * Stage 2 of the trace events.
+ * Stage 3 of the trace events.
+ *
+ * Create probe callback prototypes.
+ */
+
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
+
+#undef TP_PROTO
+#define TP_PROTO(args...) args
+
+#undef DECLARE_EVENT_CLASS
+#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
+static void __event_probe__##_name(void *__data, _proto);
+
+#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
+
+/*
+ * Stage 4 of the trace events.
  *
  * Create an array of events.
  */
@@ -130,7 +202,9 @@ struct lttng_event_desc {
                {                                                              \
                        .fields = __event_fields___##_template,                \
                        .name = #_name,                                        \
+                       .probe_callback = (void *) &__event_probe__##_template,\
                        .nr_fields = ARRAY_SIZE(__event_fields___##_template), \
+                       .owner = THIS_MODULE,                                  \
                },
 
 #define TP_ID1(_token, _system)        _token##_system
@@ -143,121 +217,27 @@ static const struct lttng_event_desc TP_ID(__event_desc___, TRACE_SYSTEM)[] = {
 #undef TP_ID1
 #undef TP_ID
 
+
 /*
- * Stage 3 of the trace events.
+ * Stage 5 of the trace events.
  *
- * Create seq file metadata output.
+ * Create a toplevel descriptor for the whole probe.
  */
 
 #define TP_ID1(_token, _system)        _token##_system
 #define TP_ID(_token, _system) TP_ID1(_token, _system)
 
-static void *TP_ID(__lttng_seq_start__, TRACE_SYSTEM)(struct seq_file *m,
-                                                     loff_t *pos)
-{
-       const struct lttng_event_desc *desc =
-               &TP_ID(__event_desc___, TRACE_SYSTEM)[*pos];
-
-       if (desc > &TP_ID(__event_desc___, TRACE_SYSTEM)
-                       [ARRAY_SIZE(TP_ID(__event_desc___, TRACE_SYSTEM)) - 1])
-               return NULL;
-       return (void *) desc;
-}
-
-static void *TP_ID(__lttng_seq_next__, TRACE_SYSTEM)(struct seq_file *m,
-                                                    void *p, loff_t *ppos)
-{
-       const struct lttng_event_desc *desc =
-               &TP_ID(__event_desc___, TRACE_SYSTEM)[++(*ppos)];
-
-       if (desc > &TP_ID(__event_desc___, TRACE_SYSTEM)
-                       [ARRAY_SIZE(TP_ID(__event_desc___, TRACE_SYSTEM)) - 1])
-               return NULL;
-       return (void *) desc;
-}
-
-static void TP_ID(__lttng_seq_stop__, TRACE_SYSTEM)(struct seq_file *m,
-                                                   void *p)
-{
-}
-
-static int TP_ID(__lttng_seq_show__, TRACE_SYSTEM)(struct seq_file *m,
-                                                  void *p)
-{
-       const struct lttng_event_desc *desc = p;
-       int i;
-
-       seq_printf(m,   "event {\n"
-                       "\tname = %s;\n"
-                       "\tid = UNKNOWN;\n"
-                       "\tstream = UNKNOWN;\n"
-                       "\tfields = {\n",
-                       desc->name);
-       for (i = 0; i < desc->nr_fields; i++) {
-               if (desc->fields[i].type.name)  /* Named type */
-                       seq_printf(m,   "\t\t%s",
-                                       desc->fields[i].type.name);
-               else                            /* Nameless type */
-                       lttng_print_event_type(m, 2, &desc->fields[i].type);
-               seq_printf(m,   " %s;\n", desc->fields[i].name);
-       }
-       seq_printf(m,   "\t};\n");
-       seq_printf(m,   "};\n");
-       return 0;
-}
-
-static const
-struct seq_operations TP_ID(__lttng_types_seq_ops__, TRACE_SYSTEM) = {
-       .start = TP_ID(__lttng_seq_start__, TRACE_SYSTEM),
-       .next = TP_ID(__lttng_seq_next__, TRACE_SYSTEM),
-       .stop = TP_ID(__lttng_seq_stop__, TRACE_SYSTEM),
-       .show = TP_ID(__lttng_seq_show__, TRACE_SYSTEM),
-};
-
-static int
-TP_ID(__lttng_types_open__, TRACE_SYSTEM)(struct inode *inode, struct file *file)
-{
-       return seq_open(file, &TP_ID(__lttng_types_seq_ops__, TRACE_SYSTEM));
-}
-
-static const
-struct file_operations TP_ID(__lttng_types_fops__, TRACE_SYSTEM) = {
-        .open = TP_ID(__lttng_types_open__, TRACE_SYSTEM),
-        .read = seq_read,
-        .llseek = seq_lseek,
-        .release = seq_release_private,
+/* non-const because list head will be modified when registered. */
+static struct lttng_probe_desc TP_ID(__probe_desc___, TRACE_SYSTEM) = {
+       .event_desc = TP_ID(__event_desc___, TRACE_SYSTEM),
+       .nr_events = ARRAY_SIZE(TP_ID(__event_desc___, TRACE_SYSTEM)),
 };
 
-static struct dentry *TP_ID(__lttng_types_dentry__, TRACE_SYSTEM);
-
-static int TP_ID(__lttng_types_init__, TRACE_SYSTEM)(void)
-{
-       int ret = 0;
-
-       TP_ID(__lttng_types_dentry__, TRACE_SYSTEM) =
-               debugfs_create_file("lttng-events-" __stringify(TRACE_SYSTEM),
-                                   S_IWUSR, NULL, NULL,
-                                   &TP_ID(__lttng_types_fops__, TRACE_SYSTEM));
-       if (IS_ERR(TP_ID(__lttng_types_dentry__, TRACE_SYSTEM))
-           || !TP_ID(__lttng_types_dentry__, TRACE_SYSTEM)) {
-               printk(KERN_ERR "Error creating LTTng type export file\n");
-               ret = -ENOMEM;
-               goto error;
-       }
-error:
-       return ret;
-}
-
-static void TP_ID(__lttng_types_exit__, TRACE_SYSTEM)(void)
-{
-       debugfs_remove(TP_ID(__lttng_types_dentry__, TRACE_SYSTEM));
-}
-
 #undef TP_ID1
 #undef TP_ID
 
 /*
- * Stage 4 of the trace events.
+ * Stage 6 of the trace events.
  *
  * Create static inline function that calculates event size.
  */
@@ -268,7 +248,7 @@ static void TP_ID(__lttng_types_exit__, TRACE_SYSTEM)(void)
 
 #undef __field
 #define __field(_type, _item)                                                 \
-       __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
+       __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
        __event_len += sizeof(_type);
 
 #undef __field_ext
@@ -276,15 +256,25 @@ static void TP_ID(__lttng_types_exit__, TRACE_SYSTEM)(void)
 
 #undef __array
 #define __array(_type, _item, _length)                                        \
-       __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
+       __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
        __event_len += sizeof(_type) * (_length);
 
+#undef __array_text
+#define __array_text(_type, _item, _length)                                   \
+       __array(_type, _item, _length)
+
 #undef __dynamic_array
 #define __dynamic_array(_type, _item, _length)                                \
-       __event_len += lib_ring_buffer_align(__event_len, __alignof__(u32));   \
+       __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(u32));   \
        __event_len += sizeof(u32);                                            \
-       __event_len += lib_ring_buffer_align(__event_len, __alignof__(_type)); \
-       __event_len += sizeof(_type) * (_length);
+       __event_len += lib_ring_buffer_align(__event_len, ltt_alignof(_type)); \
+       __dynamic_len[__dynamic_len_idx] = (_length);                          \
+       __event_len += sizeof(_type) * __dynamic_len[__dynamic_len_idx];       \
+       __dynamic_len_idx++;
+
+#undef __dynamic_array_text
+#define __dynamic_array_text(_type, _item, _length)                           \
+       __dynamic_array(_type, _item, _length)
 
 #undef __string
 #define __string(_item, _src)                                                 \
@@ -311,10 +301,8 @@ static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
 
 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
-
-
 /*
- * Stage 5 of the trace events.
+ * Stage 7 of the trace events.
  *
  * Create static inline function that calculates event payload alignment.
  */
@@ -325,19 +313,27 @@ static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
 
 #undef __field
 #define __field(_type, _item)                                            \
-       __event_align = max_t(size_t, __event_align, __alignof__(_type));
+       __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
 
 #undef __field_ext
 #define __field_ext(_type, _item, _filter_type)        __field(_type, _item)
 
 #undef __array
 #define __array(_type, _item, _length)                                   \
-       __event_align = max_t(size_t, __event_align, __alignof__(_type));
+       __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
+
+#undef __array_text
+#define __array_text(_type, _item, _length)                              \
+       __array(_type, _item, _length)
 
 #undef __dynamic_array
 #define __dynamic_array(_type, _item, _length)                           \
-       __event_align = max_t(size_t, __event_align, __alignof__(u32));   \
-       __event_align = max_t(size_t, __event_align, __alignof__(_type));
+       __event_align = max_t(size_t, __event_align, ltt_alignof(u32));   \
+       __event_align = max_t(size_t, __event_align, ltt_alignof(_type));
+
+#undef __dynamic_array_text
+#define __dynamic_array_text(_type, _item, _length)                      \
+       __dynamic_array(_type, _item, _length)
 
 #undef __string
 #define __string(_item, _src)
@@ -361,7 +357,7 @@ static inline size_t __event_get_align__##_name(_proto)                           \
 
 
 /*
- * Stage 6 of the trace events.
+ * Stage 8 of the trace events.
  *
  * Create structure declaration that allows the "assign" macros to access the
  * field types.
@@ -380,9 +376,17 @@ static inline size_t __event_get_align__##_name(_proto)                          \
 #undef __array
 #define __array(_type, _item, _length) _type   _item;
 
+#undef __array_text
+#define __array_text(_type, _item, _length)                              \
+       __array(_type, _item, _length)
+
 #undef __dynamic_array
 #define __dynamic_array(_type, _item, _length) _type   _item;
 
+#undef __dynamic_array_text
+#define __dynamic_array_text(_type, _item, _length)                      \
+       __dynamic_array(_type, _item, _length)
+
 #undef __string
 #define __string(_item, _src)  char _item;
 
@@ -399,7 +403,7 @@ struct __event_typemap__##_name {                                         \
 
 
 /*
- * Stage 7 of the trace events.
+ * Stage 9 of the trace events.
  *
  * Create the probe function : call even size calculation and write event data
  * into the buffer.
@@ -424,6 +428,10 @@ __end_field_##_item:
        goto __assign_##_item;                                          \
 __end_field_##_item:
 
+#undef __array_text
+#define __array_text(_type, _item, _length)                            \
+       __array(_type, _item, _length)
+
 #undef __dynamic_array
 #define __dynamic_array(_type, _item, _length)                         \
        goto __assign_##_item##_1;                                      \
@@ -431,6 +439,10 @@ __end_field_##_item##_1:                                           \
        goto __assign_##_item##_2;                                      \
 __end_field_##_item##_2:
 
+#undef __dynamic_array_text
+#define __dynamic_array_text(_type, _item, _length)                    \
+       __dynamic_array(_type, _item, _length)
+
 #undef __string
 #define __string(_item, _src)                                          \
        goto __assign_##_item;                                          \
@@ -445,7 +457,7 @@ __end_field_##_item:
 __assign_##dest:                                                       \
        {                                                               \
                __typeof__(__typemap.dest) __tmp = (src);               \
-               lib_ring_buffer_align_ctx(&ctx, __alignof__(__tmp));    \
+               lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__tmp));    \
                __chan->ops->event_write(&ctx, &__tmp, sizeof(__tmp));  \
        }                                                               \
        goto __end_field_##dest;
@@ -453,22 +465,25 @@ __assign_##dest:                                                  \
 #undef tp_memcpy
 #define tp_memcpy(dest, src, len)                                      \
 __assign_##dest:                                                       \
-       lib_ring_buffer_align_ctx(&ctx, __alignof__(__typemap.dest));   \
+       if (0)                                                          \
+               (void) __typemap.dest;                                  \
+       lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest));   \
        __chan->ops->event_write(&ctx, src, len);                       \
        goto __end_field_##dest;
 
 #undef tp_memcpy_dyn
-#define tp_memcpy_dyn(dest, src, len)                                  \
+#define tp_memcpy_dyn(dest, src)                                       \
 __assign_##dest##_1:                                                   \
        {                                                               \
-               u32 __tmpl = (len);                                     \
-               lib_ring_buffer_align_ctx(&ctx, __alignof__(u32));      \
+               u32 __tmpl = __dynamic_len[__dynamic_len_idx];          \
+               lib_ring_buffer_align_ctx(&ctx, ltt_alignof(u32));      \
                __chan->ops->event_write(&ctx, &__tmpl, sizeof(u32));   \
        }                                                               \
        goto __end_field_##dest##_1;                                    \
 __assign_##dest##_2:                                                   \
-       lib_ring_buffer_align_ctx(&ctx, __alignof__(__typemap.dest));   \
-       __chan->ops->event_write(&ctx, src, len);                       \
+       lib_ring_buffer_align_ctx(&ctx, ltt_alignof(__typemap.dest));   \
+       __chan->ops->event_write(&ctx, src,                             \
+               sizeof(__typemap.dest) * __get_dynamic_array_len(dest));\
        goto __end_field_##dest##_2;
 
 #undef tp_strcpy
@@ -514,11 +529,13 @@ static void __event_probe__##_name(void *__data, _proto)                \
                                                                              \
        if (0)                                                                \
                (void) __dynamic_len_idx;       /* don't warn if unused */    \
+       if (!ACCESS_ONCE(__chan->session->active))                            \
+               return;                                                       \
        __event_len = __event_get_size__##_name(__dynamic_len, _args);        \
        __event_align = __event_get_align__##_name(_args);                    \
-       lib_ring_buffer_ctx_init(&ctx, __chan->chan, NULL, __event_len,       \
+       lib_ring_buffer_ctx_init(&ctx, __chan->chan, __event, __event_len,    \
                                 __event_align, -1);                          \
-       __ret = __chan->ops->event_reserve(&ctx);                             \
+       __ret = __chan->ops->event_reserve(&ctx, __event->id);                \
        if (__ret < 0)                                                        \
                return;                                                       \
        /* Control code (field ordering) */                                   \
@@ -531,9 +548,8 @@ static void __event_probe__##_name(void *__data, _proto)                  \
 
 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
-
 /*
- * Stage 8 of the trace events.
+ * Stage 10 of the trace events.
  *
  * Register/unregister probes at module load/unload.
  */
@@ -547,32 +563,17 @@ static void __event_probe__##_name(void *__data, _proto)                \
 #define module_exit_eval1(_token, _system)     module_exit(_token##_system)
 #define module_exit_eval(_token, _system)      module_exit_eval1(_token, _system)
 
-#undef DEFINE_EVENT
-#define DEFINE_EVENT(_template, _name, _proto, _args)                         \
-       ret = ltt_probe_register(#_name, (void *) __event_probe__##_template); \
-       WARN_ON_ONCE(ret);
-
 static int TP_ID(__lttng_events_init__, TRACE_SYSTEM)(void)
 {
-       int ret = 0;
-
-       ret = TP_ID(__lttng_types_init__, TRACE_SYSTEM)();
-       if (ret)
-               return ret;
-#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
-       return ret;
+       wrapper_vmalloc_sync_all();
+       return ltt_probe_register(&TP_ID(__probe_desc___, TRACE_SYSTEM));
 }
 
 module_init_eval(__lttng_events_init__, TRACE_SYSTEM);
 
-#undef DEFINE_EVENT
-#define DEFINE_EVENT(_template, _name, _proto, _args)                         \
-       ltt_probe_unregister(#_name);
-
 static void TP_ID(__lttng_events_exit__, TRACE_SYSTEM)(void)
 {
-#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
-       TP_ID(__lttng_types_exit__, TRACE_SYSTEM)();
+       ltt_probe_unregister(&TP_ID(__probe_desc___, TRACE_SYSTEM));
 }
 
 module_exit_eval(__lttng_events_exit__, TRACE_SYSTEM);
This page took 0.045884 seconds and 4 git commands to generate.