ust-fd: Add close_range declaration

[lttng-ust.git] / include / lttng / tracepoint-types.h

diff --git a/include/lttng/tracepoint-types.h b/include/lttng/tracepoint-types.h
index 37a7662b605f8a9deb5bb3082bd65437c11312e7..f05fa4553e4d83f6e5ed09c2248055c48d57a8a7 100644 (file)
--- a/include/lttng/tracepoint-types.h
+++ b/include/lttng/tracepoint-types.h
@@ -1,29 +1,49 @@
-#ifndef _LTTNG_TRACEPOINT_TYPES_H
-#define _LTTNG_TRACEPOINT_TYPES_H
+// SPDX-FileCopyrightText: 2011-2012 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
+//
+// SPDX-License-Identifier: MIT
+
+#ifndef _LTTNG_UST_TRACEPOINT_TYPES_H
+#define _LTTNG_UST_TRACEPOINT_TYPES_H
+
+#include <stdint.h>
 
 /*
- * Copyright (c) 2011 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
- *
- * THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED
- * OR IMPLIED.  ANY USE IS AT YOUR OWN RISK.
+ * Tracepoint probe definition
  *
- * Permission is hereby granted to use or copy this program
- * for any purpose,  provided the above notices are retained on all copies.
- * Permission to modify the code and to distribute modified code is granted,
- * provided the above notices are retained, and a notice that the code was
- * modified is included with the above copyright notice.
+ * IMPORTANT: this structure is part of the ABI between instrumented
+ * applications and UST. This structure is fixed-size because it is part
+ * of a public array of structures. Rather than extending this
+ * structure, struct lttng_ust_tracepoint should be extended instead.
  */
 
-struct tracepoint_probe {
-       void *func;
+struct lttng_ust_tracepoint_probe {
+       void (*func)(void);
        void *data;
 };
 
-struct tracepoint {
-       const char *name;
+/*
+ * Tracepoint definition
+ *
+ * IMPORTANT: this structure is part of the ABI between instrumented
+ * applications and UST. Fields need to be only added at the end, never
+ * reordered, never removed.
+ *
+ * The field @struct_size should be used to determine the size of the
+ * structure. It should be queried before using additional fields added
+ * at the end of the structure.
+ */
+
+struct lttng_ust_tracepoint {
+       uint32_t struct_size;
+
+       const char *provider_name;
+       const char *event_name;
        int state;
-       struct tracepoint_probe *probes;
+       struct lttng_ust_tracepoint_probe *probes;
        int *tracepoint_provider_ref;
+       const char *signature;
+
+       /* End of base ABI. Fields below should be used after checking struct_size. */
 };
 
-#endif /* _LTTNG_TRACEPOINT_TYPES_H */
+#endif /* _LTTNG_UST_TRACEPOINT_TYPES_H */