Docs: explain why unused `lttng_enabler::ctx` is kept around

[lttng-ust.git] / include / lttng / ust-events.h

diff --git a/include/lttng/ust-events.h b/include/lttng/ust-events.h
index fefb8585536c6173e1d624954f58a8fba89421e9..c1a851731a006eebfdf4fced1596d80d36df27fc 100644 (file)
--- a/include/lttng/ust-events.h
+++ b/include/lttng/ust-events.h
@@ -29,6 +29,7 @@
 
 #include <urcu/list.h>
 #include <urcu/hlist.h>
+#include <stddef.h>
 #include <stdint.h>
 #include <lttng/ust-config.h>
 #include <lttng/ust-abi.h>
@@ -365,6 +366,10 @@ struct lttng_enabler {
 
        struct lttng_ust_event event_param;
        struct lttng_channel *chan;
+       /*
+        * Unused, but kept around to make it explicit that the tracer can do
+        * it.
+        */
        struct lttng_ctx *ctx;
        unsigned int enabled:1;
 };
@@ -679,9 +684,35 @@ int lttng_add_procname_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_ip_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_cpu_id_to_ctx(struct lttng_ctx **ctx);
 int lttng_add_dyntest_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_cgroup_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_ipc_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_mnt_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_net_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_pid_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_user_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_uts_ns_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_vuid_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_veuid_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_vsuid_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_vgid_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_vegid_to_ctx(struct lttng_ctx **ctx);
+int lttng_add_vsgid_to_ctx(struct lttng_ctx **ctx);
 void lttng_context_vtid_reset(void);
 void lttng_context_vpid_reset(void);
 void lttng_context_procname_reset(void);
+void lttng_context_cgroup_ns_reset(void);
+void lttng_context_ipc_ns_reset(void);
+void lttng_context_mnt_ns_reset(void);
+void lttng_context_net_ns_reset(void);
+void lttng_context_pid_ns_reset(void);
+void lttng_context_user_ns_reset(void);
+void lttng_context_uts_ns_reset(void);
+void lttng_context_vuid_reset(void);
+void lttng_context_veuid_reset(void);
+void lttng_context_vsuid_reset(void);
+void lttng_context_vgid_reset(void);
+void lttng_context_vegid_reset(void);
+void lttng_context_vsgid_reset(void);
 
 #ifdef LTTNG_UST_HAVE_PERF_EVENT
 int lttng_add_perf_counter_to_ctx(uint32_t type,
@@ -725,7 +756,6 @@ void lttng_probes_prune_field_list(struct lttng_ust_field_list *list);
 struct lttng_ust_field_iter *
        lttng_ust_field_list_get_iter_next(struct lttng_ust_field_list *list);
 
-void lttng_filter_event_link_bytecode(struct lttng_event *event);
 void lttng_enabler_event_link_bytecode(struct lttng_event *event,
                struct lttng_enabler *enabler);
 void lttng_free_event_filter_runtime(struct lttng_event *event);
@@ -748,6 +778,7 @@ void lttng_ust_fixup_fd_tracker_tls(void);
 extern struct lttng_ctx *lttng_static_ctx;
 void lttng_context_init(void);
 void lttng_context_exit(void);
+void lttng_filter_event_link_bytecode(struct lttng_event *event);
 
 #ifdef __cplusplus
 }