Add serialization function
[lttng-modules.git] / probes / lttng-events.h
index 61fac2fec8ff618cecd409cea610d016218fcfc6..6c48524827cede91f43d02cdcd4cead5fa9087df 100644 (file)
@@ -1,23 +1,9 @@
 #include <lttng.h>
 #include <lttng-types.h>
-
-/*
- * Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
- * strcpy().
- */
-#undef tp_assign
-#define tp_assign(dest, src)                                           \
-       lib_ring_buffer_align_ctx(config, &ctx, sizeof(src));           \
-       lib_ring_buffer_write(config, &ctx, &src, sizeof(src));
-
-#undef tp_memcpy
-#define tp_memcpy(dest, src, len)                                      \
-       lib_ring_buffer_align_ctx(config, &ctx, sizeof(*(src)));        \
-       lib_ring_buffer_write(config, &ctx, &src, len);
-
-/* TODO */
-#undef tp_strcpy
-#define tp_strcpy(dest, src)           __assign_str(dest, src);
+#include <linux/debugfs.h>
+#include <linux/ringbuffer/frontend_types.h>
+#include "../ltt-events.h"
+#include "../ltt-tracer-core.h"
 
 struct lttng_event_field {
        const char *name;
@@ -26,13 +12,12 @@ struct lttng_event_field {
 
 struct lttng_event_desc {
        const struct lttng_event_field *fields;
+       const char *name;
+       unsigned int nr_fields;
 };
 
 /*
- * Stage 1 of the trace events.
- *
- * Create event field type metadata section.
- * Each event produce an array of fields.
+ * Macro declarations used for all stages.
  */
 
 /*
@@ -44,6 +29,7 @@ struct lttng_event_desc {
  *
  * TRACE_EVENT is a one to one mapping between tracepoint and template.
  */
+
 #undef TRACE_EVENT
 #define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
        DECLARE_EVENT_CLASS(name,                              \
@@ -54,6 +40,26 @@ struct lttng_event_desc {
                             PARAMS(print))                    \
        DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
 
+#undef DEFINE_EVENT_PRINT
+#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
+       DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
+
+/* Callbacks are meaningless to LTTng. */
+#undef TRACE_EVENT_FN
+#define TRACE_EVENT_FN(name, proto, args, tstruct,                     \
+               assign, print, reg, unreg)                              \
+       TRACE_EVENT(name, PARAMS(proto), PARAMS(args),                  \
+               PARAMS(tstruct), PARAMS(assign), PARAMS(print))         \
+
+/*
+ * Stage 1 of the trace events.
+ *
+ * Create event field type metadata section.
+ * Each event produce an array of fields.
+ */
+
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
+
 /* Named field types must be defined in lttng-types.h */
 
 #undef __field
@@ -61,8 +67,7 @@ struct lttng_event_desc {
        { .name = #_item, .type = { .atype = atype_integer, .name = #_type} },
 
 #undef __field_ext
-#define __field_ext(_type, _item, _filter_type)                        \
-       { .name = #_item, .type = { .atype = atype_integer, .name = #_type} },
+#define __field_ext(_type, _item, _filter_type)                __field(_type, _item)
 
 #undef __array
 #define __array(_type, _item, _length)                         \
@@ -91,7 +96,7 @@ struct lttng_event_desc {
 #undef __string
 #define __string(_item, _src)                                  \
        {                                                       \
-               .name = _item,                                  \
+               .name = #_item,                                 \
                .type = {                                       \
                  .atype = atype_string,                        \
                  .name = NULL,                                 \
@@ -99,153 +104,406 @@ struct lttng_event_desc {
                },                                              \
        },
 
-#undef TP_PROTO
-#define TP_PROTO(args...)
-
-#undef TP_ARGS
-#define TP_ARGS(args...)
-
 #undef TP_STRUCT__entry
 #define TP_STRUCT__entry(args...) args /* Only one used in this phase */
 
-#undef TP_fast_assign
-#define TP_fast_assign(args...)
-
-#undef TP_printk
-#define TP_printk(args...)
-
 #undef DECLARE_EVENT_CLASS
-#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
-       static const struct lttng_event_field __event_fields___##name[] = { \
-               tstruct                                                 \
+#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print) \
+       static const struct lttng_event_field __event_fields___##_name[] = { \
+               _tstruct                                                     \
        };
 
-#undef DEFINE_EVENT
-#define DEFINE_EVENT(template, name, proto, args)
+#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
-#undef DEFINE_EVENT_PRINT
-#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
-       DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
+/*
+ * Stage 2 of the trace events.
+ *
+ * Create an array of events.
+ */
 
-/* Callbacks are meaningless to LTTng. */
-#undef TRACE_EVENT_FN
-#define TRACE_EVENT_FN(name, proto, args, tstruct,                     \
-               assign, print, reg, unreg)                              \
-       TRACE_EVENT(name, PARAMS(proto), PARAMS(args),                  \
-               PARAMS(tstruct), PARAMS(assign), PARAMS(print))         \
+/* Named field types must be defined in lttng-types.h */
 
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
+
+#undef DEFINE_EVENT
+#define DEFINE_EVENT(_template, _name, _proto, _args)                         \
+               {                                                              \
+                       .fields = __event_fields___##_template,                \
+                       .name = #_name,                                        \
+                       .nr_fields = ARRAY_SIZE(__event_fields___##_template), \
+               },
+
+#define TP_ID1(_token, _system)        _token##_system
+#define TP_ID(_token, _system) TP_ID1(_token, _system)
+
+static const struct lttng_event_desc TP_ID(__event_desc___, TRACE_SYSTEM)[] = {
 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
+};
+
+#undef TP_ID1
+#undef TP_ID
 
 /*
- * Stage 2 of the trace events.
+ * Stage 3 of the trace events.
  *
- * Create an array of events.
+ * Create seq file metadata output.
  */
 
+#define TP_ID1(_token, _system)        _token##_system
+#define TP_ID(_token, _system) TP_ID1(_token, _system)
+#define module_init_eval1(_token, _system)     module_init(_token##_system)
+#define module_init_eval(_token, _system)      module_init_eval1(_token, _system)
+#define module_exit_eval1(_token, _system)     module_exit(_token##_system)
+#define module_exit_eval(_token, _system)      module_exit_eval1(_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,
+};
+
+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;
+}
+
+module_init_eval(__lttng_types_init__, TRACE_SYSTEM);
+
+static void TP_ID(__lttng_types_exit__, TRACE_SYSTEM)(void)
+{
+       debugfs_remove(TP_ID(__lttng_types_dentry__, TRACE_SYSTEM));
+}
+
+module_exit_eval(__lttng_types_exit__, TRACE_SYSTEM);
+
+#undef module_init_eval
+#undef module_exit_eval
+#undef TP_ID1
+#undef TP_ID
+
 /*
- * DECLARE_EVENT_CLASS can be used to add a generic function
- * handlers for events. That is, if all events have the same
- * parameters and just have distinct trace points.
- * Each tracepoint can be defined with DEFINE_EVENT and that
- * will map the DECLARE_EVENT_CLASS to the tracepoint.
+ * Stage 4 of the trace events.
  *
- * TRACE_EVENT is a one to one mapping between tracepoint and template.
+ * Create static inline function that calculates event size.
  */
-#undef TRACE_EVENT
-#define TRACE_EVENT(name, proto, args, tstruct, assign, print) \
-       DECLARE_EVENT_CLASS(name,                              \
-                            PARAMS(proto),                    \
-                            PARAMS(args),                     \
-                            PARAMS(tstruct),                  \
-                            PARAMS(assign),                   \
-                            PARAMS(print))                    \
-       DEFINE_EVENT(name, name, PARAMS(proto), PARAMS(args))
+
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
 
 /* Named field types must be defined in lttng-types.h */
 
 #undef __field
-#define __field(_type, _item)
+#define __field(_type, _item)                                            \
+       __event_len += lib_ring_buffer_align(__event_len, sizeof(_type)); \
+       __event_len += sizeof(_type);
 
 #undef __field_ext
-#define __field_ext(_type, _item, _filter_type)
+#define __field_ext(_type, _item, _filter_type)        __field(_type, _item)
 
 #undef __array
-#define __array(_type, _item, _length)
+#define __array(_type, _item, _length)                                   \
+       __event_len += lib_ring_buffer_align(__event_len, sizeof(_type)); \
+       __event_len += sizeof(_type) * (_length);
 
 #undef __dynamic_array
-#define __dynamic_array(_type, _item, _length)
+#define __dynamic_array(_type, _item, _length)                           \
+       __event_len += lib_ring_buffer_align(__event_len, sizeof(u32));   \
+       __event_len += sizeof(u32);                                       \
+       __event_len += lib_ring_buffer_align(__event_len, sizeof(_type)); \
+       __event_len += sizeof(_type) * (_length);
 
 #undef __string
-#define __string(_item, _src)
+#define __string(_item, _src)                                          \
+       __event_len += __dynamic_len[__dynamic_len_idx++] = strlen(_src) + 1;
 
 #undef TP_PROTO
-#define TP_PROTO(args...)
-
-#undef TP_ARGS
-#define TP_ARGS(args...)
+#define TP_PROTO(args...) args
 
 #undef TP_STRUCT__entry
-#define TP_STRUCT__entry(args...)
+#define TP_STRUCT__entry(args...) args
 
-#undef TP_fast_assign
-#define TP_fast_assign(args...)
+#undef DECLARE_EVENT_CLASS
+#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
+static inline size_t __event_get_size__##_name(size_t *__dynamic_len, _proto) \
+{                                                                            \
+       size_t __event_len = 0;                                               \
+       unsigned int __dynamic_len_idx = 0;                                   \
+                                                                             \
+       if (0)                                                                \
+               (void) __dynamic_len_idx;       /* don't warn if unused */    \
+       _tstruct                                                              \
+       return __event_len;                                                   \
+}
 
-#undef TP_printk
-#define TP_printk(args...)
+#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
-#undef DECLARE_EVENT_CLASS
-#define DECLARE_EVENT_CLASS(name, proto, args, tstruct, assign, print) \
-               { .fields = __event_fields___##name },
 
-#undef DEFINE_EVENT
-#define DEFINE_EVENT(template, name, proto, args)
 
-#undef DEFINE_EVENT_PRINT
-#define DEFINE_EVENT_PRINT(template, name, proto, args, print) \
-       DEFINE_EVENT(template, name, PARAMS(proto), PARAMS(args))
+/*
+ * Stage 5 of the trace events.
+ *
+ * Create static inline function that calculates event payload alignment.
+ */
 
-/* Callbacks are meaningless to LTTng. */
-#undef TRACE_EVENT_FN
-#define TRACE_EVENT_FN(name, proto, args, tstruct,                     \
-               assign, print, reg, unreg)                              \
-       TRACE_EVENT(name, PARAMS(proto), PARAMS(args),                  \
-               PARAMS(tstruct), PARAMS(assign), PARAMS(print))         \
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
 
-#define TRACE_EVENT_DESC_1(_system)    __event_desc___##_system
-#define TRACE_EVENT_DESC(_system)      TRACE_EVENT_DESC_1(_system)
+/* Named field types must be defined in lttng-types.h */
 
-static const struct lttng_event_desc TRACE_EVENT_DESC(TRACE_SYSTEM)[] = {
-#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
-};
+#undef __field
+#define __field(_type, _item)                                            \
+       __event_align = max_t(size_t, __event_align, sizeof(_type));
+
+#undef __field_ext
+#define __field_ext(_type, _item, _filter_type)        __field(_type, _item)
 
-#undef TRACE_EVENT_DESC_1
-#undef TRACE_EVENT_DESC
+#undef __array
+#define __array(_type, _item, _length)                                   \
+       __event_align = max_t(size_t, __event_align, sizeof(_type));
 
-#if 0
+#undef __dynamic_array
+#define __dynamic_array(_type, _item, _length)                           \
+       __event_align = max_t(size_t, __event_align, sizeof(u32));        \
+       __event_align = max_t(size_t, __event_align, sizeof(_type));
 
-/*
- * Stage 3 of the trace events.
- *
- * Create static inline function that calculates event size.
- */
+#undef __string
+#define __string(_item, _src)
+
+#undef TP_PROTO
+#define TP_PROTO(args...) args
 
+#undef TP_STRUCT__entry
+#define TP_STRUCT__entry(args...) args
 
+#undef DECLARE_EVENT_CLASS
+#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
+static inline size_t __event_get_align__##_name(_proto)                              \
+{                                                                            \
+       size_t __event_align = 1;                                             \
+       _tstruct                                                              \
+       return __event_align;                                                 \
+}
 
 #include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
 
+
+
 /*
- * Stage 4 of the trace events.
+ * Stage 6 of the trace events.
  *
  * Create the probe function : call even size calculation and write event data
  * into the buffer.
+ *
+ * Note: the order of fields in TP_fast_assign and TP_STRUCT__entry must be the
+ * same.
  */
 
+#include "lttng-events-reset.h"        /* Reset all macros within TRACE_EVENT */
 
+#undef __field
+#define __field(_type, _item)                                          \
+       lib_ring_buffer_align_ctx(&ctx, sizeof(_type));                 \
+       goto __assign_##_item;                                          \
+__end_field_##_item:
 
-#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
+#undef __field_ext
+#define __field_ext(_type, _item, _filter_type)        __field(_type, _item)
 
+#undef __array
+#define __array(_type, _item, _length)                                 \
+       lib_ring_buffer_align_ctx(&ctx, sizeof(_type));                 \
+       goto __assign_##_item;                                          \
+__end_field_##_item:
+
+#undef __dynamic_array
+#define __dynamic_array(_type, _item, _length)                         \
+       lib_ring_buffer_align_ctx(&ctx, sizeof(u32));                   \
+       goto __assign_##_item##_1;                                      \
+__end_field_##_item##_1:                                               \
+       lib_ring_buffer_align_ctx(&ctx, sizeof(_type));                 \
+       goto __assign_##_item##_2;                                      \
+__end_field_##_item##_2:
 
+#undef __string
+#define __string(_item, _src)                                          \
+       goto __assign_##_item;                                          \
+__end_field_##_item:
+
+/*
+ * Macros mapping tp_assign() to "=", tp_memcpy() to memcpy() and tp_strcpy() to
+ * strcpy().
+ */
+#undef tp_assign
+#define tp_assign(dest, src)                                           \
+__assign_##dest:                                                       \
+       {                                                               \
+               __typeof__(src) __tmp = (src);                          \
+               __chan->ops->event_write(&ctx, &__tmp, sizeof(src));    \
+       }                                                               \
+       goto __end_field_##dest;
+
+#undef tp_memcpy
+#define tp_memcpy(dest, src, len)                                      \
+__assign_##dest:                                                       \
+       __chan->ops->event_write(&ctx, src, len);                       \
+       goto __end_field_##dest;
+
+#undef tp_memcpy_dyn
+#define tp_memcpy_dyn(dest, src, len)                                  \
+__assign_##dest##_1:                                                   \
+       {                                                               \
+               __typeof__(len) __tmpl = (len);                         \
+               __chan->ops->event_write(&ctx, &__tmpl, sizeof(u32));   \
+       }                                                               \
+       goto __end_field_##dest##_1;                                    \
+__assign_##dest##_2:                                                   \
+       __chan->ops->event_write(&ctx, src, len);                       \
+       goto __end_field_##dest##_2;
 
+#undef tp_strcpy
+#define tp_strcpy(dest, src)                                           \
+       tp_memcpy(dest, src, __get_dynamic_array_len(dest));            \
+
+/* Named field types must be defined in lttng-types.h */
+
+#undef __get_str
+#define __get_str(field)               field
+
+#undef __get_dynamic_array
+#define __get_dynamic_array(field)     field
+
+/* Beware: this get len actually consumes the len value */
+#undef __get_dynamic_array_len
+#define __get_dynamic_array_len(field) __dynamic_len[__dynamic_len_idx++]
+
+#undef TP_PROTO
+#define TP_PROTO(args...) args
+
+#undef TP_ARGS
+#define TP_ARGS(args...) args
+
+#undef TP_STRUCT__entry
+#define TP_STRUCT__entry(args...) args
+
+#undef TP_fast_assign
+#define TP_fast_assign(args...) args
+
+#undef DECLARE_EVENT_CLASS
+#define DECLARE_EVENT_CLASS(_name, _proto, _args, _tstruct, _assign, _print)  \
+static void __event_probe__##_name(void *__data, _proto)                     \
+{                                                                            \
+       struct ltt_event *__event = __data;                                   \
+       struct ltt_channel *__chan = __event->chan;                           \
+       struct lib_ring_buffer_ctx ctx;                                       \
+       size_t __event_len, __event_align;                                    \
+       size_t __dynamic_len_idx = 0;                                         \
+       size_t __dynamic_len[ARRAY_SIZE(__event_fields___##_name)];           \
+       int __ret;                                                            \
+                                                                             \
+       if (0)                                                                \
+               (void) __dynamic_len_idx;       /* don't warn if unused */    \
+       __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,       \
+                                __event_align, -1);                          \
+       __ret = __chan->ops->event_reserve(&ctx);                             \
+       if (__ret < 0)                                                        \
+               return;                                                       \
+       /* Control code (field ordering) */                                   \
+       _tstruct                                                              \
+       __chan->ops->event_commit(&ctx);                                      \
+       return;                                                               \
+       /* Copy code, steered by control code */                              \
+       _assign                                                               \
+}
+
+#include TRACE_INCLUDE(TRACE_INCLUDE_FILE)
+
+
+#if 0
 
 #include <linux/ftrace_event.h>
 
This page took 0.029586 seconds and 4 git commands to generate.