Docs: Add documentation explaining the meaning of "internal" events

[lttng-tools.git] / src / bin / lttng-sessiond / trace-ust.h

diff --git a/src/bin/lttng-sessiond/trace-ust.h b/src/bin/lttng-sessiond/trace-ust.h
index 7d64269089d7a4f140754505c624dab74c3a6c8e..4a818df1a06ab996d6510d0d6e785ac40f20b004 100644 (file)
--- a/src/bin/lttng-sessiond/trace-ust.h
+++ b/src/bin/lttng-sessiond/trace-ust.h
@@ -27,9 +27,10 @@
 #include <common/defaults.h>
 
 #include "consumer.h"
-#include "agent.h"
 #include "ust-ctl.h"
 
+struct agent;
+
 struct ltt_ust_ht_key {
        const char *name;
        const struct lttng_filter_bytecode *filter;
@@ -52,6 +53,13 @@ struct ltt_ust_event {
        char *filter_expression;
        struct lttng_ust_filter_bytecode *filter;
        struct lttng_event_exclusion *exclusion;
+       /*
+        * An internal event is an event which was created by the session daemon
+        * through which, for example, events emitted in Agent domains are
+        * "funelled". This is used to hide internal events from external
+        * clients as they should never be modified by the external world.
+        */
+       bool internal;
 };
 
 /* UST channel */
@@ -185,7 +193,8 @@ struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr);
 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
                char *filter_expression,
                struct lttng_filter_bytecode *filter,
-               struct lttng_event_exclusion *exclusion);
+               struct lttng_event_exclusion *exclusion,
+               bool internal_event);
 struct ltt_ust_context *trace_ust_create_context(
                struct lttng_event_context *ctx);
 int trace_ust_match_context(struct ltt_ust_context *uctx,
@@ -204,6 +213,8 @@ void trace_ust_destroy_event(struct ltt_ust_event *event);
 int trace_ust_track_pid(struct ltt_ust_session *session, int pid);
 int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid);
 
+int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid);
+
 ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
                int32_t **_pids);
 
@@ -240,7 +251,8 @@ static inline
 struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev,
                const char *filter_expression,
                struct lttng_filter_bytecode *filter,
-               struct lttng_event_exclusion *exclusion)
+               struct lttng_event_exclusion *exclusion,
+               bool internal_event)
 {
        return NULL;
 }
@@ -298,6 +310,12 @@ int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid)
 {
        return 0;
 }
+static inline
+int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid)
+{
+       return 0;
+}
+static inline
 ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session,
                int32_t **_pids)
 {