Fix RCU-related hangs: incorrect lttng_ht_destroy use
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
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.
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 *
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.
16 */
17
18 #ifndef _LTT_UST_APP_H
19 #define _LTT_UST_APP_H
20
21 #include <stdint.h>
22
23 #include <common/compat/uuid.h>
24 #include "trace-ust.h"
25 #include "ust-registry.h"
26
27 #define UST_APP_EVENT_LIST_SIZE 32
28
29 /* Process name (short). */
30 #define UST_APP_PROCNAME_LEN 16
31
32 struct lttng_filter_bytecode;
33 struct lttng_ust_filter_bytecode;
34
35 extern int ust_consumerd64_fd, ust_consumerd32_fd;
36
37 /*
38 * Object used to close the notify socket in a call_rcu(). Since the
39 * application might not be found, we need an independant object containing the
40 * notify socket fd.
41 */
42 struct ust_app_notify_sock_obj {
43 int fd;
44 struct rcu_head head;
45 };
46
47 struct ust_app_ht_key {
48 const char *name;
49 const struct lttng_ust_filter_bytecode *filter;
50 enum lttng_ust_loglevel_type loglevel;
51 };
52
53 /*
54 * Application registration data structure.
55 */
56 struct ust_register_msg {
57 enum ustctl_socket_type type;
58 uint32_t major;
59 uint32_t minor;
60 uint32_t abi_major;
61 uint32_t abi_minor;
62 pid_t pid;
63 pid_t ppid;
64 uid_t uid;
65 gid_t gid;
66 uint32_t bits_per_long;
67 uint32_t uint8_t_alignment;
68 uint32_t uint16_t_alignment;
69 uint32_t uint32_t_alignment;
70 uint32_t uint64_t_alignment;
71 uint32_t long_alignment;
72 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
73 char name[LTTNG_UST_ABI_PROCNAME_LEN];
74 };
75
76 /*
77 * Global applications HT used by the session daemon. This table is indexed by
78 * PID using the pid_n node and pid value of an ust_app.
79 */
80 struct lttng_ht *ust_app_ht;
81
82 /*
83 * Global applications HT used by the session daemon. This table is indexed by
84 * socket using the sock_n node and sock value of an ust_app.
85 */
86 struct lttng_ht *ust_app_ht_by_sock;
87
88 /*
89 * Global applications HT used by the session daemon. This table is indexed by
90 * socket using the notify_sock_n node and notify_sock value of an ust_app.
91 */
92 struct lttng_ht *ust_app_ht_by_notify_sock;
93
94 /* Stream list containing ust_app_stream. */
95 struct ust_app_stream_list {
96 unsigned int count;
97 struct cds_list_head head;
98 };
99
100 struct ust_app_ctx {
101 int handle;
102 struct lttng_ust_context ctx;
103 struct lttng_ust_object_data *obj;
104 struct lttng_ht_node_ulong node;
105 };
106
107 struct ust_app_event {
108 int enabled;
109 int handle;
110 struct lttng_ust_object_data *obj;
111 struct lttng_ust_event attr;
112 char name[LTTNG_UST_SYM_NAME_LEN];
113 struct lttng_ht_node_str node;
114 struct lttng_ust_filter_bytecode *filter;
115 };
116
117 struct ust_app_stream {
118 int handle;
119 char pathname[PATH_MAX];
120 /* Format is %s_%d respectively channel name and CPU number. */
121 char name[DEFAULT_STREAM_NAME_LEN];
122 struct lttng_ust_object_data *obj;
123 /* Using a list of streams to keep order. */
124 struct cds_list_head list;
125 };
126
127 struct ust_app_channel {
128 int enabled;
129 int handle;
130 /* Channel and streams were sent to the UST tracer. */
131 int is_sent;
132 /* Unique key used to identify the channel on the consumer side. */
133 uint64_t key;
134 /* Id of the tracing channel set on creation. */
135 uint64_t tracing_channel_id;
136 /* Number of stream that this channel is expected to receive. */
137 unsigned int expected_stream_count;
138 char name[LTTNG_UST_SYM_NAME_LEN];
139 struct lttng_ust_object_data *obj;
140 struct ustctl_consumer_channel_attr attr;
141 struct ust_app_stream_list streams;
142 /* Session pointer that owns this object. */
143 struct ust_app_session *session;
144 struct lttng_ht *ctx;
145 struct lttng_ht *events;
146 uint64_t tracefile_size;
147 uint64_t tracefile_count;
148 /*
149 * Node indexed by channel name in the channels' hash table of a session.
150 */
151 struct lttng_ht_node_str node;
152 /*
153 * Node indexed by UST channel object descriptor (handle). Stored in the
154 * ust_objd hash table in the ust_app object.
155 */
156 struct lttng_ht_node_ulong ust_objd_node;
157 /* For delayed reclaim */
158 struct rcu_head rcu_head;
159 };
160
161 struct ust_app_session {
162 /*
163 * Lock protecting this session's ust app interaction. Held
164 * across command send/recv to/from app. Never nests within the
165 * session registry lock.
166 */
167 pthread_mutex_t lock;
168
169 int enabled;
170 /* started: has the session been in started state at any time ? */
171 int started; /* allows detection of start vs restart. */
172 int handle; /* used has unique identifier for app session */
173
174 /*
175 * Tracing session ID. Multiple ust app session can have the same tracing
176 * session id making this value NOT unique to the object.
177 */
178 int tracing_id;
179 uint64_t id; /* Unique session identifier */
180 struct lttng_ht *channels; /* Registered channels */
181 struct lttng_ht_node_ulong node;
182 char path[PATH_MAX];
183 /* UID/GID of the application owning the session */
184 uid_t uid;
185 gid_t gid;
186 /* Effective UID and GID. Same as the tracing session. */
187 uid_t euid;
188 gid_t egid;
189 struct cds_list_head teardown_node;
190 /*
191 * Once at least *one* session is created onto the application, the
192 * corresponding consumer is set so we can use it on unregistration.
193 */
194 struct consumer_output *consumer;
195 enum lttng_buffer_type buffer_type;
196 /* ABI of the session. Same value as the application. */
197 uint32_t bits_per_long;
198 /* For delayed reclaim */
199 struct rcu_head rcu_head;
200 };
201
202 /*
203 * Registered traceable applications. Libust registers to the session daemon
204 * and a linked list is kept of all running traceable app.
205 */
206 struct ust_app {
207 int sock;
208 int notify_sock;
209 pid_t pid;
210 pid_t ppid;
211 uid_t uid; /* User ID that owns the apps */
212 gid_t gid; /* Group ID that owns the apps */
213
214 /* App ABI */
215 uint32_t bits_per_long;
216 uint32_t uint8_t_alignment;
217 uint32_t uint16_t_alignment;
218 uint32_t uint32_t_alignment;
219 uint32_t uint64_t_alignment;
220 uint32_t long_alignment;
221 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
222
223 int compatible; /* If the lttng-ust tracer version does not match the
224 supported version of the session daemon, this flag is
225 set to 0 (NOT compatible) else 1. */
226 struct lttng_ust_tracer_version version;
227 uint32_t v_major; /* Version major number */
228 uint32_t v_minor; /* Version minor number */
229 /* Extra for the NULL byte. */
230 char name[UST_APP_PROCNAME_LEN + 1];
231 /* Type of buffer this application uses. */
232 enum lttng_buffer_type buffer_type;
233 struct lttng_ht *sessions;
234 struct lttng_ht_node_ulong pid_n;
235 struct lttng_ht_node_ulong sock_n;
236 struct lttng_ht_node_ulong notify_sock_n;
237 /*
238 * This is a list of ust app session that, once the app is going into
239 * teardown mode, in the RCU call, each node in this list is removed and
240 * deleted.
241 *
242 * Element of the list are added when an application unregisters after each
243 * ht_del of ust_app_session associated to this app. This list is NOT used
244 * when a session is destroyed.
245 */
246 struct cds_list_head teardown_head;
247 /*
248 * Hash table containing ust_app_channel indexed by channel objd.
249 */
250 struct lttng_ht *ust_objd;
251 };
252
253 #ifdef HAVE_LIBLTTNG_UST_CTL
254
255 int ust_app_register(struct ust_register_msg *msg, int sock);
256 static inline
257 int ust_app_register_done(int sock)
258 {
259 return ustctl_register_done(sock);
260 }
261 int ust_app_version(struct ust_app *app);
262 void ust_app_unregister(int sock);
263 unsigned long ust_app_list_count(void);
264 int ust_app_start_trace_all(struct ltt_ust_session *usess);
265 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
266 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
267 int ust_app_list_events(struct lttng_event **events);
268 int ust_app_list_event_fields(struct lttng_event_field **fields);
269 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
270 struct ltt_ust_channel *uchan);
271 int ust_app_create_event_glb(struct ltt_ust_session *usess,
272 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
273 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
274 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
275 pid_t pid);
276 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
277 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
278 pid_t pid);
279 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
280 struct ltt_ust_channel *uchan);
281 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
282 struct ltt_ust_channel *uchan);
283 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
284 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
285 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
286 struct ltt_ust_channel *uchan);
287 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
288 struct ltt_ust_channel *uchan);
289 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
290 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
291 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
292 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
293 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
294
295 void ust_app_clean_list(void);
296 void ust_app_ht_alloc(void);
297 struct lttng_ht *ust_app_get_ht(void);
298 struct ust_app *ust_app_find_by_pid(pid_t pid);
299 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
300 struct ust_app_stream *ust_app_alloc_stream(void);
301 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
302 int ust_app_recv_notify(int sock);
303 void ust_app_add(struct ust_app *app);
304 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
305 void ust_app_notify_sock_unregister(int sock);
306 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
307 struct consumer_socket *socket, int send_zero_data);
308
309 #else /* HAVE_LIBLTTNG_UST_CTL */
310
311 static inline
312 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
313 {
314 return 0;
315 }
316 static inline
317 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
318 {
319 return 0;
320 }
321 static inline
322 int ust_app_start_trace_all(struct ltt_ust_session *usess)
323 {
324 return 0;
325 }
326 static inline
327 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
328 {
329 return 0;
330 }
331 static inline
332 int ust_app_list_events(struct lttng_event **events)
333 {
334 return -ENOSYS;
335 }
336 static inline
337 int ust_app_list_event_fields(struct lttng_event_field **fields)
338 {
339 return -ENOSYS;
340 }
341 static inline
342 int ust_app_register(struct ust_register_msg *msg, int sock)
343 {
344 return -ENOSYS;
345 }
346 static inline
347 int ust_app_register_done(int sock)
348 {
349 return -ENOSYS;
350 }
351 static inline
352 int ust_app_version(struct ust_app *app)
353 {
354 return -ENOSYS;
355 }
356 static inline
357 void ust_app_unregister(int sock)
358 {
359 }
360 static inline
361 unsigned int ust_app_list_count(void)
362 {
363 return 0;
364 }
365 static inline
366 void ust_app_lock_list(void)
367 {
368 }
369 static inline
370 void ust_app_unlock_list(void)
371 {
372 }
373 static inline
374 void ust_app_clean_list(void)
375 {
376 }
377 static inline
378 struct ust_app_list *ust_app_get_list(void)
379 {
380 return NULL;
381 }
382 static inline
383 struct ust_app *ust_app_get_by_pid(pid_t pid)
384 {
385 return NULL;
386 }
387 static inline
388 struct lttng_ht *ust_app_get_ht(void)
389 {
390 return NULL;
391 }
392 static inline
393 void ust_app_ht_alloc(void)
394 {}
395 static inline
396 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
397 {}
398 static inline
399 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
400 struct ltt_ust_channel *uchan)
401 {
402 return 0;
403 }
404 static inline
405 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
406 struct ltt_ust_channel *uchan)
407 {
408 return 0;
409 }
410 static inline
411 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
412 struct ltt_ust_channel *uchan)
413 {
414 return 0;
415 }
416 static inline
417 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
418 struct ltt_ust_channel *uchan)
419 {
420 return 0;
421 }
422 static inline
423 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
424 struct ltt_ust_channel *uchan)
425 {
426 return 0;
427 }
428 static inline
429 int ust_app_create_event_glb(struct ltt_ust_session *usess,
430 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
431 {
432 return 0;
433 }
434 static inline
435 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
436 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
437 {
438 return 0;
439 }
440 static inline
441 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
442 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
443 {
444 return 0;
445 }
446 static inline
447 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
448 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
449 {
450 return 0;
451 }
452 static inline
453 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
454 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
455 pid_t pid)
456 {
457 return 0;
458 }
459 static inline
460 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
461 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
462 pid_t pid)
463 {
464 return 0;
465 }
466 static inline
467 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
468 {
469 return 0;
470 }
471 static inline
472 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
473 {
474 return 0;
475 }
476 static inline
477 int ust_app_recv_notify(int sock)
478 {
479 return 0;
480 }
481 static inline
482 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
483 {
484 return NULL;
485 }
486 static inline
487 void ust_app_add(struct ust_app *app)
488 {
489 }
490 static inline
491 void ust_app_notify_sock_unregister(int sock)
492 {
493 }
494 static inline
495 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
496 struct consumer_socket *socket, int send_zero_data)
497 {
498 return 0;
499 }
500
501 #endif /* HAVE_LIBLTTNG_UST_CTL */
502
503 #endif /* _LTT_UST_APP_H */
This page took 0.060124 seconds and 4 git commands to generate.