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