Commit | Line | Data |
---|---|---|
97ee3a89 DG |
1 | /* |
2 | * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca> | |
3 | * | |
d14d33bf AM |
4 | * This program is free software; you can redistribute it and/or modify |
5 | * it under the terms of the GNU General Public License, version 2 only, | |
6 | * as published by the Free Software Foundation. | |
97ee3a89 DG |
7 | * |
8 | * This program is distributed in the hope that it will be useful, | |
9 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
11 | * GNU General Public License for more details. | |
12 | * | |
d14d33bf AM |
13 | * You should have received a copy of the GNU General Public License along |
14 | * with this program; if not, write to the Free Software Foundation, Inc., | |
15 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. | |
97ee3a89 DG |
16 | */ |
17 | ||
18 | #ifndef _LTT_TRACE_UST_H | |
19 | #define _LTT_TRACE_UST_H | |
20 | ||
3bd1e081 | 21 | #include <config.h> |
97ee3a89 DG |
22 | #include <limits.h> |
23 | #include <urcu/list.h> | |
bec39940 | 24 | |
97ee3a89 | 25 | #include <lttng/lttng.h> |
10a8a223 | 26 | #include <common/hashtable/hashtable.h> |
ce2a9e76 | 27 | #include <common/defaults.h> |
3bd1e081 | 28 | |
00e2e675 | 29 | #include "consumer.h" |
022d91ba | 30 | #include "agent.h" |
48842b30 | 31 | #include "ust-ctl.h" |
97ee3a89 | 32 | |
18eace3b DG |
33 | struct ltt_ust_ht_key { |
34 | const char *name; | |
35 | const struct lttng_filter_bytecode *filter; | |
79a065a0 | 36 | enum lttng_ust_loglevel_type loglevel_type; |
e9a89251 | 37 | int loglevel_value; |
7724731b | 38 | const struct lttng_event_exclusion *exclusion; |
18eace3b DG |
39 | }; |
40 | ||
f6a9efaa DG |
41 | /* Context hash table nodes */ |
42 | struct ltt_ust_context { | |
43 | struct lttng_ust_context ctx; | |
bec39940 | 44 | struct lttng_ht_node_ulong node; |
31746f93 | 45 | struct cds_list_head list; |
97ee3a89 DG |
46 | }; |
47 | ||
48 | /* UST event */ | |
49 | struct ltt_ust_event { | |
37357452 | 50 | unsigned int enabled; |
f6a9efaa | 51 | struct lttng_ust_event attr; |
bec39940 | 52 | struct lttng_ht_node_str node; |
6b453b5e | 53 | char *filter_expression; |
0a3fca4d | 54 | struct lttng_filter_bytecode *filter; |
40024f8a | 55 | struct lttng_event_exclusion *exclusion; |
9732459c | 56 | bool internal; |
2bdd86d4 MD |
57 | }; |
58 | ||
97ee3a89 DG |
59 | /* UST channel */ |
60 | struct ltt_ust_channel { | |
7972aab2 | 61 | uint64_t id; /* unique id per session. */ |
37357452 | 62 | unsigned int enabled; |
0a3fca4d JG |
63 | /* |
64 | * A UST channel can be part of a userspace sub-domain such as JUL, | |
65 | * Log4j, Python. | |
66 | */ | |
67 | enum lttng_domain_type domain; | |
44d3bd01 | 68 | char name[LTTNG_UST_SYM_NAME_LEN]; |
ffe60014 | 69 | struct lttng_ust_channel_attr attr; |
bec39940 | 70 | struct lttng_ht *ctx; |
31746f93 | 71 | struct cds_list_head ctx_list; |
bec39940 DG |
72 | struct lttng_ht *events; |
73 | struct lttng_ht_node_str node; | |
1624d5b7 JD |
74 | uint64_t tracefile_size; |
75 | uint64_t tracefile_count; | |
97ee3a89 DG |
76 | }; |
77 | ||
f6a9efaa DG |
78 | /* UST domain global (LTTNG_DOMAIN_UST) */ |
79 | struct ltt_ust_domain_global { | |
bec39940 | 80 | struct lttng_ht *channels; |
7972aab2 | 81 | struct cds_list_head registry_buffer_uid_list; |
f6a9efaa DG |
82 | }; |
83 | ||
a9ad0c8f MD |
84 | struct ust_pid_tracker_node { |
85 | struct lttng_ht_node_ulong node; | |
86 | }; | |
87 | ||
88 | struct ust_pid_tracker { | |
89 | struct lttng_ht *ht; | |
90 | }; | |
91 | ||
97ee3a89 DG |
92 | /* UST session */ |
93 | struct ltt_ust_session { | |
d9bf3ca4 | 94 | uint64_t id; /* Unique identifier of session */ |
f6a9efaa | 95 | struct ltt_ust_domain_global domain_global; |
fefd409b DG |
96 | /* Hash table of agent indexed by agent domain. */ |
97 | struct lttng_ht *agents; | |
6df2e2c9 MD |
98 | /* UID/GID of the user owning the session */ |
99 | uid_t uid; | |
100 | gid_t gid; | |
14fb1ebe DG |
101 | /* Is the session active meaning has is been started or stopped. */ |
102 | unsigned int active:1; | |
00e2e675 | 103 | struct consumer_output *consumer; |
f3f0db50 DG |
104 | /* Sequence number for filters so the tracer knows the ordering. */ |
105 | uint64_t filter_seq_num; | |
7972aab2 DG |
106 | /* This indicates which type of buffer this session is set for. */ |
107 | enum lttng_buffer_type buffer_type; | |
108 | /* If set to 1, the buffer_type can not be changed anymore. */ | |
109 | int buffer_type_changed; | |
110 | /* For per UID buffer, every buffer reg object is kept of this session */ | |
111 | struct cds_list_head buffer_reg_uid_list; | |
112 | /* Next channel ID available for a newly registered channel. */ | |
113 | uint64_t next_channel_id; | |
114 | /* Once this value reaches UINT32_MAX, no more id can be allocated. */ | |
115 | uint64_t used_channel_id; | |
2bba9e53 DG |
116 | /* Tell or not if the session has to output the traces. */ |
117 | unsigned int output_traces; | |
27babd3a | 118 | unsigned int snapshot_mode; |
85076754 | 119 | unsigned int has_non_default_channel; |
ecc48a90 | 120 | unsigned int live_timer_interval; /* usec */ |
84ad93e8 DG |
121 | |
122 | /* Metadata channel attributes. */ | |
123 | struct lttng_ust_channel_attr metadata_attr; | |
d7ba1388 MD |
124 | |
125 | /* | |
126 | * Path where to keep the shared memory files. | |
127 | */ | |
3d071855 | 128 | char root_shm_path[PATH_MAX]; |
d7ba1388 | 129 | char shm_path[PATH_MAX]; |
a9ad0c8f MD |
130 | |
131 | struct ust_pid_tracker pid_tracker; | |
97ee3a89 DG |
132 | }; |
133 | ||
7972aab2 DG |
134 | /* |
135 | * Validate that the id has reached the maximum allowed or not. | |
136 | * | |
137 | * Return 0 if NOT else 1. | |
138 | */ | |
139 | static inline int trace_ust_is_max_id(uint64_t id) | |
140 | { | |
141 | return (id == UINT64_MAX) ? 1 : 0; | |
142 | } | |
143 | ||
144 | /* | |
145 | * Return next available channel id and increment the used counter. The | |
146 | * trace_ust_is_max_id function MUST be called before in order to validate if | |
147 | * the maximum number of IDs have been reached. If not, it is safe to call this | |
148 | * function. | |
149 | * | |
150 | * Return a unique channel ID. If max is reached, the used_channel_id counter | |
151 | * is returned. | |
152 | */ | |
153 | static inline uint64_t trace_ust_get_next_chan_id(struct ltt_ust_session *s) | |
154 | { | |
155 | if (trace_ust_is_max_id(s->used_channel_id)) { | |
156 | return s->used_channel_id; | |
157 | } | |
158 | ||
159 | s->used_channel_id++; | |
160 | return s->next_channel_id++; | |
161 | } | |
162 | ||
74d0b642 | 163 | #ifdef HAVE_LIBLTTNG_UST_CTL |
3bd1e081 | 164 | |
18eace3b DG |
165 | int trace_ust_ht_match_event(struct cds_lfht_node *node, const void *_key); |
166 | int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
167 | const void *_key); | |
168 | ||
97ee3a89 DG |
169 | /* |
170 | * Lookup functions. NULL is returned if not found. | |
171 | */ | |
18eace3b | 172 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, |
79a065a0 | 173 | char *name, struct lttng_filter_bytecode *filter, |
e9a89251 PP |
174 | enum lttng_ust_loglevel_type loglevel_type, int loglevel_value, |
175 | struct lttng_event_exclusion *exclusion); | |
bec39940 | 176 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 177 | char *name); |
fefd409b DG |
178 | struct agent *trace_ust_find_agent(struct ltt_ust_session *session, |
179 | enum lttng_domain_type domain_type); | |
97ee3a89 DG |
180 | |
181 | /* | |
182 | * Create functions malloc() the data structure. | |
183 | */ | |
d9bf3ca4 | 184 | struct ltt_ust_session *trace_ust_create_session(uint64_t session_id); |
0a3fca4d JG |
185 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr, |
186 | enum lttng_domain_type domain); | |
025faf73 | 187 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
6b453b5e | 188 | char *filter_expression, |
561c6897 | 189 | struct lttng_filter_bytecode *filter, |
9732459c JG |
190 | struct lttng_event_exclusion *exclusion, |
191 | bool internal_event); | |
55cc08a6 DG |
192 | struct ltt_ust_context *trace_ust_create_context( |
193 | struct lttng_event_context *ctx); | |
aa3514e9 MD |
194 | int trace_ust_match_context(struct ltt_ust_context *uctx, |
195 | struct lttng_event_context *ctx); | |
d5979e4a DG |
196 | void trace_ust_delete_channel(struct lttng_ht *ht, |
197 | struct ltt_ust_channel *channel); | |
97ee3a89 DG |
198 | |
199 | /* | |
200 | * Destroy functions free() the data structure and remove from linked list if | |
201 | * it's applies. | |
202 | */ | |
203 | void trace_ust_destroy_session(struct ltt_ust_session *session); | |
97ee3a89 DG |
204 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel); |
205 | void trace_ust_destroy_event(struct ltt_ust_event *event); | |
206 | ||
a9ad0c8f MD |
207 | int trace_ust_track_pid(struct ltt_ust_session *session, int pid); |
208 | int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid); | |
209 | ||
b4650bd0 MD |
210 | int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid); |
211 | ||
a5dfbb9d MD |
212 | ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session, |
213 | int32_t **_pids); | |
214 | ||
74d0b642 | 215 | #else /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 216 | |
37a86c61 DG |
217 | static inline int trace_ust_ht_match_event(struct cds_lfht_node *node, |
218 | const void *_key) | |
219 | { | |
220 | return 0; | |
221 | } | |
222 | static inline int trace_ust_ht_match_event_by_name(struct cds_lfht_node *node, | |
223 | const void *_key) | |
224 | { | |
225 | return 0; | |
226 | } | |
3bd1e081 | 227 | static inline |
bec39940 | 228 | struct ltt_ust_channel *trace_ust_find_channel_by_name(struct lttng_ht *ht, |
f6a9efaa | 229 | char *name) |
3bd1e081 MD |
230 | { |
231 | return NULL; | |
232 | } | |
f6a9efaa | 233 | |
3bd1e081 | 234 | static inline |
dec56f6c | 235 | struct ltt_ust_session *trace_ust_create_session(unsigned int session_id) |
3bd1e081 MD |
236 | { |
237 | return NULL; | |
238 | } | |
239 | static inline | |
0a3fca4d JG |
240 | struct ltt_ust_channel *trace_ust_create_channel(struct lttng_channel *attr, |
241 | enum lttng_domain_type domain) | |
3bd1e081 MD |
242 | { |
243 | return NULL; | |
244 | } | |
245 | static inline | |
025faf73 | 246 | struct ltt_ust_event *trace_ust_create_event(struct lttng_event *ev, |
6b453b5e | 247 | const char *filter_expression, |
561c6897 | 248 | struct lttng_filter_bytecode *filter, |
9732459c JG |
249 | struct lttng_event_exclusion *exclusion, |
250 | bool internal_event) | |
3bd1e081 MD |
251 | { |
252 | return NULL; | |
253 | } | |
3bd1e081 MD |
254 | static inline |
255 | void trace_ust_destroy_session(struct ltt_ust_session *session) | |
256 | { | |
257 | } | |
48842b30 | 258 | |
3bd1e081 MD |
259 | static inline |
260 | void trace_ust_destroy_channel(struct ltt_ust_channel *channel) | |
261 | { | |
262 | } | |
48842b30 | 263 | |
3bd1e081 MD |
264 | static inline |
265 | void trace_ust_destroy_event(struct ltt_ust_event *event) | |
266 | { | |
267 | } | |
34378f76 DG |
268 | static inline |
269 | struct ltt_ust_context *trace_ust_create_context( | |
270 | struct lttng_event_context *ctx) | |
271 | { | |
272 | return NULL; | |
273 | } | |
aa3514e9 MD |
274 | static inline |
275 | int trace_ust_match_context(struct ltt_ust_context *uctx, | |
276 | struct lttng_event_context *ctx) | |
277 | { | |
278 | return 0; | |
279 | } | |
e9a89251 PP |
280 | static inline |
281 | struct ltt_ust_event *trace_ust_find_event(struct lttng_ht *ht, | |
79a065a0 | 282 | char *name, struct lttng_filter_bytecode *filter, |
e9a89251 PP |
283 | enum lttng_ust_loglevel_type loglevel_type, int loglevel_value, |
284 | struct lttng_event_exclusion *exclusion) | |
37a86c61 DG |
285 | { |
286 | return NULL; | |
287 | } | |
d5979e4a DG |
288 | static inline |
289 | void trace_ust_delete_channel(struct lttng_ht *ht, | |
290 | struct ltt_ust_channel *channel) | |
291 | { | |
292 | return; | |
293 | } | |
fefd409b DG |
294 | static inline |
295 | struct agent *trace_ust_find_agent(struct ltt_ust_session *session, | |
296 | enum lttng_domain_type domain_type) | |
297 | { | |
298 | return NULL; | |
299 | } | |
a9ad0c8f MD |
300 | static inline |
301 | int trace_ust_track_pid(struct ltt_ust_session *session, int pid) | |
302 | { | |
303 | return 0; | |
304 | } | |
305 | static inline | |
306 | int trace_ust_untrack_pid(struct ltt_ust_session *session, int pid) | |
307 | { | |
308 | return 0; | |
309 | } | |
b4650bd0 MD |
310 | static inline |
311 | int trace_ust_pid_tracker_lookup(struct ltt_ust_session *session, int pid) | |
312 | { | |
313 | return 0; | |
314 | } | |
3646a051 | 315 | static inline |
a5dfbb9d MD |
316 | ssize_t trace_ust_list_tracker_pids(struct ltt_ust_session *session, |
317 | int32_t **_pids) | |
318 | { | |
319 | return -1; | |
320 | } | |
74d0b642 | 321 | #endif /* HAVE_LIBLTTNG_UST_CTL */ |
3bd1e081 | 322 | |
97ee3a89 | 323 | #endif /* _LTT_TRACE_UST_H */ |