Move to kernel style SPDX license identifiers
[lttng-ust.git] / include / lttng / tracepoint-event.h
index 65120d4b80d04523950e2e19b24f681ee47d7b26..938184552f928cafe3311259754825799692feda 100644 (file)
 /*
- * Copyright (C) 2009     Steven Rostedt <srostedt@redhat.com>
- * Copyright (C) 2011     Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+ * SPDX-License-Identifier: MIT
  *
- * This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Lesser General Public
- * License as published by the Free Software Foundation;
- * version 2.1 of the License.
- *
- * This library is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * Lesser General Public License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA
- *
- *
- * Trace files that want to automate creationg of all tracepoints defined
- * in their file should include this file. The following are macros that the
- * trace file may define:
- *
- * TRACEPOINT_SYSTEM defines the system the tracepoint is for:
- *     < [com_company_]project_[component_] >
- *
- * TRACEPOINT_INCLUDE_FILE if the file name is something other than
- *     TRACEPOINT_SYSTEM.h. This macro may be defined to tell
- *     define_trace.h what file to include.  Note, leave off the ".h".
- *
- * TRACEPOINT_INCLUDE_PATH if the path is something other than within
- *     the system's include/tracepoint/ path, then this macro can define
- *     the path to use. This path is relative to tracepoint-event.h, or
- *     to the include search path. Trick: Use a
- *       #define TRACEPOINT_INCLUDE_PATH .
- *     combined with -Ipath_to_header as compiler argument to allow
- *     searching for a header within your project build tree.
+ * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
  */
 
-#ifdef __cplusplus
-extern "C" {
-#endif
-
 #ifdef TRACEPOINT_CREATE_PROBES
 
-/* Prevent recursion */
-#undef TRACEPOINT_CREATE_PROBES
+#define __tp_stringify1(x)     #x
+#define __tp_stringify(x)      __tp_stringify1(x)
 
-#ifndef __tp_stringify
-#define __tp_stringify_1(x...) #x
-#define __tp_stringify(x...)   __tp_stringify_1(x)
-#endif
+#undef TRACEPOINT_EVENT_INSTANCE
+#define TRACEPOINT_EVENT_INSTANCE(_provider, _template, _name, _args)
 
 #undef TRACEPOINT_EVENT
-#define TRACEPOINT_EVENT(name, proto, args, fields)            \
-       _DEFINE_TRACEPOINT(name)
+#define TRACEPOINT_EVENT(_provider, _name, _args, _fields)             \
+       TRACEPOINT_EVENT_CLASS(_provider, _name, _TP_PARAMS(_args),     \
+                       _TP_PARAMS(_fields))                            \
+       TRACEPOINT_EVENT_INSTANCE(_provider, _name, _name,              \
+                       _TP_PARAMS(_args))
 
-#undef TRACEPOINT_EVENT_INSTANCE
-#define TRACEPOINT_EVENT_INSTANCE(template, name, proto, args) \
-       _DEFINE_TRACEPOINT(name)
 
-#undef TRACEPOINT_EVENT_NOARGS
-#define TRACEPOINT_EVENT_NOARGS(name, fields)                  \
-       _DEFINE_TRACEPOINT(name)
-
-#undef TRACEPOINT_EVENT_INSTANCE_NOARGS
-#define TRACEPOINT_EVENT_INSTANCE_NOARGS(template, name)       \
-       _DEFINE_TRACEPOINT(name)
+#undef TRACEPOINT_CREATE_PROBES
 
-#undef TRACEPOINT_INCLUDE
-#undef __TRACEPOINT_INCLUDE
+#define TRACEPOINT_HEADER_MULTI_READ
 
-#ifndef TRACEPOINT_INCLUDE_FILE
-# define TRACEPOINT_INCLUDE_FILE TRACEPOINT_SYSTEM
-# define UNDEF_TRACEPOINT_INCLUDE_FILE
+/*
+ * LTTng-UST 2.0 expects TRACEPOINT_INCLUDE_FILE, but this approach has
+ * the unwanted side-effect of expanding any macro name found within
+ * TRACEPOINT_INCLUDE_FILE.
+ *
+ * Starting from LTTng-UST 2.1, we expect the TRACEPOINT_INCLUDE to be
+ * defined by probes as a string. We still check for
+ * TRACEPOINT_INCLUDE_FILE for API backward compatibility.
+ */
+#ifdef TRACEPOINT_INCLUDE_FILE
+#define TRACEPOINT_INCLUDE     __tp_stringify(TRACEPOINT_INCLUDE_FILE)
 #endif
 
-#ifndef TRACEPOINT_INCLUDE_PATH
-# define __TRACEPOINT_INCLUDE(system) <tracepoint/system.h>
-# define UNDEF_TRACEPOINT_INCLUDE_PATH
-#else
-# define __TRACEPOINT_INCLUDE(system)                          \
-       __tp_stringify(TRACEPOINT_INCLUDE_PATH/system.h)
-#endif
+#include TRACEPOINT_INCLUDE
 
-# define TRACEPOINT_INCLUDE(system) __TRACEPOINT_INCLUDE(system)
+#include <lttng/ust-tracepoint-event.h>
 
-/* Let the trace headers be reread */
-#define TRACEPOINT_HEADER_MULTI_READ
+#undef TRACEPOINT_HEADER_MULTI_READ
+#undef TRACEPOINT_INCLUDE_FILE
+#undef TRACEPOINT_INCLUDE
 
-#include TRACEPOINT_INCLUDE(TRACEPOINT_INCLUDE_FILE)
+#define TRACEPOINT_CREATE_PROBES
 
-#include <lttng/ust-tracepoint-event.h>
+/*
+ * Put back definitions to the state they were when defined by
+ * tracepoint.h.
+ */
+#undef TP_ARGS
+#define TP_ARGS(...)       __VA_ARGS__
 
 #undef TRACEPOINT_EVENT
+#define TRACEPOINT_EVENT(provider, name, args, fields)                 \
+       _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
+       _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
+
 #undef TRACEPOINT_EVENT_CLASS
+#define TRACEPOINT_EVENT_CLASS(provider, name, args, fields)
+
 #undef TRACEPOINT_EVENT_INSTANCE
-#undef TRACEPOINT_EVENT_NOARGS
-#undef TRACEPOINT_EVENT_CLASS_NOARGS
-#undef TRACEPOINT_EVENT_INSTANCE_NOARGS
-#undef TRACEPOINT_HEADER_MULTI_READ
+#define TRACEPOINT_EVENT_INSTANCE(provider, _template, name, args)     \
+       _DECLARE_TRACEPOINT(provider, name, _TP_PARAMS(args))           \
+       _DEFINE_TRACEPOINT(provider, name, _TP_PARAMS(args))
 
-/* Only undef what we defined in this file */
-#ifdef UNDEF_TRACEPOINT_INCLUDE_FILE
-# undef TRACEPOINT_INCLUDE_FILE
-# undef UNDEF_TRACEPOINT_INCLUDE_FILE
-#endif
+#undef TRACEPOINT_LOGLEVEL
+#define TRACEPOINT_LOGLEVEL(provider, name, loglevel)
 
-#ifdef UNDEF_TRACEPOINT_INCLUDE_PATH
-# undef TRACEPOINT_INCLUDE_PATH
-# undef UNDEF_TRACEPOINT_INCLUDE_PATH
-#endif
-
-/* We may be processing more files */
-#define TRACEPOINT_CREATE_PROBES
+#undef TRACEPOINT_MODEL_EMF_URI
+#define TRACEPOINT_MODEL_EMF_URI(provider, name, uri)
 
 #endif /* TRACEPOINT_CREATE_PROBES */
-
-#ifdef __cplusplus 
-}
-#endif
This page took 0.027557 seconds and 4 git commands to generate.