2 * Copyright (C) 2011 EfficiOS Inc.
4 * SPDX-License-Identifier: GPL-2.0-only
8 #ifndef _LTT_TRACE_KERNEL_H
9 #define _LTT_TRACE_KERNEL_H
11 #include "consumer.hpp"
12 #include "tracker.hpp"
14 #include <common/defaults.hpp>
15 #include <common/lttng-kernel-old.hpp>
16 #include <common/lttng-kernel.hpp>
18 #include <lttng/lttng.h>
20 #include <urcu/list.h>
22 /* Kernel event list */
23 struct ltt_kernel_event_list {
24 struct cds_list_head head;
27 /* Channel stream list */
28 struct ltt_kernel_stream_list {
29 struct cds_list_head head;
33 struct ltt_kernel_channel_list {
34 struct cds_list_head head;
37 struct ltt_kernel_context {
38 struct lttng_kernel_abi_context ctx;
39 struct cds_list_head list;
40 /* Indicates whether or not the context is in a list. */
45 struct ltt_kernel_event {
48 enum lttng_event_type type;
49 struct lttng_kernel_abi_event *event;
50 struct cds_list_head list;
51 char *filter_expression;
52 struct lttng_bytecode *filter;
53 struct lttng_userspace_probe_location *userspace_probe_location;
57 struct ltt_kernel_event_notifier_rule {
59 uint64_t error_counter_index;
61 enum lttng_event_type type;
62 struct lttng_trigger *trigger;
64 const struct lttng_bytecode *filter;
65 struct lttng_userspace_probe_location *userspace_probe_location;
66 struct cds_lfht_node ht_node;
67 /* call_rcu delayed reclaim. */
68 struct rcu_head rcu_node;
72 struct ltt_kernel_channel {
74 uint64_t key; /* Key to reference this channel with the consumer. */
76 unsigned int stream_count;
77 unsigned int event_count;
78 bool published_to_notification_thread;
79 struct cds_list_head ctx_list;
80 struct lttng_channel *channel;
81 struct ltt_kernel_event_list events_list;
82 struct ltt_kernel_stream_list stream_list;
83 struct cds_list_head list;
84 /* Session pointer which has a reference to this object. */
85 struct ltt_kernel_session *session;
86 bool sent_to_consumer;
90 struct ltt_kernel_metadata {
92 uint64_t key; /* Key to reference this channel with the consumer. */
93 struct lttng_channel *conf;
97 struct ltt_kernel_stream {
101 bool sent_to_consumer;
102 /* Format is %s_%d respectively channel name and CPU number. */
103 char name[DEFAULT_STREAM_NAME_LEN];
104 uint64_t tracefile_size;
105 uint64_t tracefile_count;
106 struct cds_list_head list;
110 struct ltt_kernel_session {
112 int metadata_stream_fd;
113 int consumer_fds_sent;
114 unsigned int channel_count;
115 unsigned int stream_count_global;
116 struct ltt_kernel_metadata *metadata;
117 struct ltt_kernel_channel_list channel_list;
118 /* UID/GID of the user owning the session */
121 struct consumer_output *consumer;
122 /* Tracing session id */
124 /* Session is active or not meaning it has been started or stopped. */
126 /* Tell or not if the session has to output the traces. */
127 unsigned int output_traces;
128 unsigned int snapshot_mode;
129 unsigned int has_non_default_channel;
130 bool is_live_session;
131 /* Current trace chunk of the ltt_session. */
132 struct lttng_trace_chunk *current_trace_chunk;
134 struct process_attr_tracker *tracker_pid;
135 struct process_attr_tracker *tracker_vpid;
136 struct process_attr_tracker *tracker_uid;
137 struct process_attr_tracker *tracker_vuid;
138 struct process_attr_tracker *tracker_gid;
139 struct process_attr_tracker *tracker_vgid;
143 * Lookup functions. NULL is returned if not found.
145 struct ltt_kernel_event *trace_kernel_get_event_by_name(char *name,
146 struct ltt_kernel_channel *channel,
147 enum lttng_event_type type);
148 struct ltt_kernel_event *trace_kernel_find_event(char *name,
149 struct ltt_kernel_channel *channel,
150 enum lttng_event_type type,
151 struct lttng_bytecode *filter);
152 struct ltt_kernel_channel *trace_kernel_get_channel_by_name(const char *name,
153 struct ltt_kernel_session *session);
156 * Create functions malloc() the data structure.
158 struct ltt_kernel_session *trace_kernel_create_session();
159 struct ltt_kernel_channel *trace_kernel_create_channel(struct lttng_channel *chan);
160 enum lttng_error_code trace_kernel_create_event(struct lttng_event *ev,
161 char *filter_expression,
162 struct lttng_bytecode *filter,
163 struct ltt_kernel_event **kernel_event);
164 struct ltt_kernel_metadata *trace_kernel_create_metadata();
165 struct ltt_kernel_stream *trace_kernel_create_stream(const char *name, unsigned int count);
166 struct ltt_kernel_context *trace_kernel_create_context(struct lttng_kernel_abi_context *ctx);
167 /* Trigger is only non-const to acquire a reference. */
168 enum lttng_error_code trace_kernel_create_event_notifier_rule(
169 struct lttng_trigger *trigger,
171 uint64_t error_counter_index,
172 struct ltt_kernel_event_notifier_rule **event_notifier_rule);
173 struct ltt_kernel_context *trace_kernel_copy_context(struct ltt_kernel_context *ctx);
174 enum lttng_error_code trace_kernel_init_event_notifier_from_event_rule(
175 const struct lttng_event_rule *rule,
176 struct lttng_kernel_abi_event_notifier *kernel_event_notifier);
179 * Destroy functions free() the data structure and remove from linked list if
182 void trace_kernel_destroy_session(struct ltt_kernel_session *session);
183 void trace_kernel_destroy_metadata(struct ltt_kernel_metadata *metadata);
184 void trace_kernel_destroy_channel(struct ltt_kernel_channel *channel);
185 void trace_kernel_destroy_event(struct ltt_kernel_event *event);
186 void trace_kernel_destroy_stream(struct ltt_kernel_stream *stream);
187 void trace_kernel_destroy_context(struct ltt_kernel_context *ctx);
188 void trace_kernel_destroy_event_notifier_rule(struct ltt_kernel_event_notifier_rule *rule);
189 void trace_kernel_free_session(struct ltt_kernel_session *session);
191 #endif /* _LTT_TRACE_KERNEL_H */