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