tracepoint.h: move code after used prototype declaration
[ust.git] / include / ust / tracepoint.h
index 18ee28b064e9e39e3519f43d8514daec9562256b..d793e58ca8da5b2ca18f0179709255c4b1e5b788 100644 (file)
@@ -2,7 +2,7 @@
 #define _UST_TRACEPOINT_H
 
 /*
- * Copyright (C) 2008 Mathieu Desnoyers <mathieu.desnoyers@polymtl.ca>
+ * Copyright (C) 2008-2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  * Copyright (C) 2009 Pierre-Marc Fournier
  * Copyright (C) 2009 Steven Rostedt <rostedt@goodmis.org>
  *
@@ -45,28 +45,6 @@ struct tracepoint {
  */
 #define tracepoint(name, args...)      __trace_##name(args)
 
-/*
- * Library should be made known to libust by declaring TRACEPOINT_LIB in
- * the source file. (Usually at the end of the file, in the outermost
- * scope).
- */
-#define TRACEPOINT_LIB                                                 \
-       extern struct tracepoint * const __start___tracepoints_ptrs[] __attribute__((weak, visibility("hidden"))); \
-       extern struct tracepoint * const __stop___tracepoints_ptrs[] __attribute__((weak, visibility("hidden"))); \
-       static struct tracepoint * __tracepoint_ptr_dummy               \
-       __attribute__((used, section("__tracepoints_ptrs")));           \
-       static void __attribute__((constructor)) __tracepoints__init(void) \
-       {                                                               \
-               tracepoint_register_lib(__start___tracepoints_ptrs,     \
-                                       __stop___tracepoints_ptrs -     \
-                                       __start___tracepoints_ptrs);    \
-       }                                                               \
-                                                                       \
-       static void __attribute__((destructor)) __tracepoints__destroy(void) \
-       {                                                               \
-               tracepoint_unregister_lib(__start___tracepoints_ptrs);  \
-       }
-
 /*
  * it_func[0] is never NULL because there is at least one element in the array
  * when the array itself is non NULL.
@@ -182,22 +160,75 @@ int __tracepoint_probe_register(const char *name, void *probe, void *data);
 extern
 int __tracepoint_probe_unregister(const char *name, void *probe, void *data);
 
-struct tracepoint_lib {
-       struct tracepoint * const *tracepoints_start;
-       int tracepoints_count;
-       struct cds_list_head list;
-};
-
 extern
 int tracepoint_register_lib(struct tracepoint * const *tracepoints_start,
                            int tracepoints_count);
 extern
 int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start);
 
+/*
+ * These weak symbols, the constructor, and destructor take care of
+ * registering only _one_ instance of the tracepoints per shared-ojbect
+ * (or for the whole main program).
+ * The dummy tracepoint entry ensures that the start/stop pointers get
+ * initialized by the linker when no tracepoints are present in a
+ * shared-object (or main program).
+ */
+extern struct tracepoint * const __start___tracepoints_ptrs[]
+       __attribute__((weak, visibility("hidden")));
+extern struct tracepoint * const __stop___tracepoints_ptrs[]
+       __attribute__((weak, visibility("hidden")));
+int __tracepoint_registered
+       __attribute__((weak, visibility("hidden")));
+
+static void __attribute__((constructor)) __tracepoints__init(void)
+{
+       if (__tracepoint_registered++)
+               return;
+       tracepoint_register_lib(__start___tracepoints_ptrs,
+                               __stop___tracepoints_ptrs -
+                               __start___tracepoints_ptrs);
+}
+
+static void __attribute__((destructor)) __tracepoints__destroy(void)
+{
+       if (--__tracepoint_registered)
+               return;
+       tracepoint_unregister_lib(__start___tracepoints_ptrs);
+}
 
 #ifndef TRACEPOINT_EVENT
 /*
- * For use with the TRACEPOINT_EVENT macro:
+ * Usage of the TRACEPOINT_EVENT macro:
+ *
+ * In short, an example:
+ *
+ * TRACEPOINT_EVENT(< [com_company_]project_[component_]event >,
+ *     TP_PROTO(int arg0, void *arg1, char *string, size_t strlen,
+ *              long *arg4, size_t arg4_len),
+ *     TP_ARGS(arg0, arg1, string, strlen, arg4, arg4_len),
+ *     TP_FIELDS(
+ *
+ *         * Integer, printed in base 10 * 
+ *         ctf_integer(int, field_a, arg0)
+ *
+ *         * Integer, printed with 0x base 16 * 
+ *         ctf_integer_hex(unsigned long, field_d, arg1)
+ *
+ *         * Array Sequence, printed as UTF8-encoded array of bytes * 
+ *         ctf_array_text(char, field_b, string, FIXED_LEN)
+ *         ctf_sequence_text(char, field_c, string, size_t, strlen)
+ *
+ *         * String, printed as UTF8-encoded string * 
+ *         ctf_string(field_e, string)
+ *
+ *         * Array sequence of signed integer values * 
+ *         ctf_array(long, field_f, arg4, FIXED_LEN4)
+ *         ctf_sequence(long, field_g, arg4, size_t, arg4_len)
+ *     )
+ * )
+ *
+ * In more detail:
  *
  * We define a tracepoint, its arguments, and its 'fast binary record'
  * layout.
@@ -217,8 +248,10 @@ int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start);
  *   project_event
  *
  * Where "project" is the name of the project,
- *       "component" is the name of the project component where the
- *         tracepoint is located (optional),
+ *       "component" is the name of the project component (which may
+ *       include several levels of sub-components, e.g.
+ *       ...component_subcomponent_...) where the tracepoint is located
+ *       (optional),
  *       "event" is the name of the tracepoint event.
  *
  * For projects issued from a single company wishing to advertise that
@@ -232,8 +265,10 @@ int tracepoint_unregister_lib(struct tracepoint * const *tracepoints_start);
  *
  * Where "company" is the name of the company,
  *       "project" is the name of the project,
- *       "component" is the name of the project component where the
- *         tracepoint is located (optional),
+ *       "component" is the name of the project component (which may
+ *       include several levels of sub-components, e.g.
+ *       ...component_subcomponent_...) where the tracepoint is located
+ *       (optional),
  *       "event" is the name of the tracepoint event.
  *
  *
This page took 0.024346 seconds and 4 git commands to generate.