86f747d6b6714b3d8b7230cea290ad89ac3c30a3
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17 */
18
19 #ifndef _LTT_UST_APP_H
20 #define _LTT_UST_APP_H
21
22 #include <stdint.h>
23
24 #include <common/uuid.h>
25
26 #include "trace-ust.h"
27 #include "ust-registry.h"
28 #include "session.h"
29
30 #define UST_APP_EVENT_LIST_SIZE 32
31
32 /* Process name (short). */
33 #define UST_APP_PROCNAME_LEN 16
34
35 struct lttng_filter_bytecode;
36 struct lttng_ust_filter_bytecode;
37
38 extern int ust_consumerd64_fd, ust_consumerd32_fd;
39
40 /*
41 * Object used to close the notify socket in a call_rcu(). Since the
42 * application might not be found, we need an independant object containing the
43 * notify socket fd.
44 */
45 struct ust_app_notify_sock_obj {
46 int fd;
47 struct rcu_head head;
48 };
49
50 struct ust_app_ht_key {
51 const char *name;
52 const struct lttng_filter_bytecode *filter;
53 enum lttng_ust_loglevel_type loglevel_type;
54 const struct lttng_event_exclusion *exclusion;
55 };
56
57 /*
58 * Application registration data structure.
59 */
60 struct ust_register_msg {
61 enum ustctl_socket_type type;
62 uint32_t major;
63 uint32_t minor;
64 uint32_t abi_major;
65 uint32_t abi_minor;
66 pid_t pid;
67 pid_t ppid;
68 uid_t uid;
69 gid_t gid;
70 uint32_t bits_per_long;
71 uint32_t uint8_t_alignment;
72 uint32_t uint16_t_alignment;
73 uint32_t uint32_t_alignment;
74 uint32_t uint64_t_alignment;
75 uint32_t long_alignment;
76 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
77 char name[LTTNG_UST_ABI_PROCNAME_LEN];
78 };
79
80 /*
81 * Global applications HT used by the session daemon. This table is indexed by
82 * PID using the pid_n node and pid value of an ust_app.
83 */
84 struct lttng_ht *ust_app_ht;
85
86 /*
87 * Global applications HT used by the session daemon. This table is indexed by
88 * socket using the sock_n node and sock value of an ust_app.
89 *
90 * The 'sock' in question here is the 'command' socket.
91 */
92 struct lttng_ht *ust_app_ht_by_sock;
93
94 /*
95 * Global applications HT used by the session daemon. This table is indexed by
96 * socket using the notify_sock_n node and notify_sock value of an ust_app.
97 */
98 struct lttng_ht *ust_app_ht_by_notify_sock;
99
100 /* Stream list containing ust_app_stream. */
101 struct ust_app_stream_list {
102 unsigned int count;
103 struct cds_list_head head;
104 };
105
106 struct ust_app_ctx {
107 int handle;
108 struct lttng_ust_context_attr ctx;
109 struct lttng_ust_object_data *obj;
110 struct lttng_ht_node_ulong node;
111 struct cds_list_head list;
112 };
113
114 struct ust_app_event {
115 int enabled;
116 int handle;
117 struct lttng_ust_object_data *obj;
118 struct lttng_ust_event attr;
119 char name[LTTNG_UST_SYM_NAME_LEN];
120 struct lttng_ht_node_str node;
121 struct lttng_filter_bytecode *filter;
122 struct lttng_event_exclusion *exclusion;
123 };
124
125 struct ust_app_stream {
126 int handle;
127 char pathname[PATH_MAX];
128 /* Format is %s_%d respectively channel name and CPU number. */
129 char name[DEFAULT_STREAM_NAME_LEN];
130 struct lttng_ust_object_data *obj;
131 /* Using a list of streams to keep order. */
132 struct cds_list_head list;
133 };
134
135 struct ust_app_channel {
136 int enabled;
137 int handle;
138 /* Channel and streams were sent to the UST tracer. */
139 int is_sent;
140 /*
141 * Unique key used to identify the channel on the consumer side.
142 * 0 is a reserved 'invalid' value used to indicate that the consumer
143 * does not know about this channel (i.e. an error occurred).
144 */
145 uint64_t key;
146 /* Id of the tracing channel set on creation. */
147 uint64_t tracing_channel_id;
148 /* Number of stream that this channel is expected to receive. */
149 unsigned int expected_stream_count;
150 char name[LTTNG_UST_SYM_NAME_LEN];
151 struct lttng_ust_object_data *obj;
152 struct ustctl_consumer_channel_attr attr;
153 struct ust_app_stream_list streams;
154 /* Session pointer that owns this object. */
155 struct ust_app_session *session;
156 /*
157 * Contexts are kept in a hash table for fast lookup and in an ordered list
158 * so we are able to enable them on the tracer side in the same order the
159 * user added them.
160 */
161 struct lttng_ht *ctx;
162 struct cds_list_head ctx_list;
163
164 struct lttng_ht *events;
165 uint64_t tracefile_size;
166 uint64_t tracefile_count;
167 uint64_t monitor_timer_interval;
168 /*
169 * Node indexed by channel name in the channels' hash table of a session.
170 */
171 struct lttng_ht_node_str node;
172 /*
173 * Node indexed by UST channel object descriptor (handle). Stored in the
174 * ust_objd hash table in the ust_app object.
175 */
176 struct lttng_ht_node_ulong ust_objd_node;
177 /* For delayed reclaim */
178 struct rcu_head rcu_head;
179 };
180
181 struct ust_app_session {
182 /*
183 * Lock protecting this session's ust app interaction. Held
184 * across command send/recv to/from app. Never nests within the
185 * session registry lock.
186 */
187 pthread_mutex_t lock;
188
189 int enabled;
190 /* started: has the session been in started state at any time ? */
191 int started; /* allows detection of start vs restart. */
192 int handle; /* used has unique identifier for app session */
193
194 bool deleted; /* Session deleted flag. Check with lock held. */
195
196 /*
197 * Tracing session ID. Multiple ust app session can have the same tracing
198 * session id making this value NOT unique to the object.
199 */
200 uint64_t tracing_id;
201 uint64_t id; /* Unique session identifier */
202 struct lttng_ht *channels; /* Registered channels */
203 struct lttng_ht_node_u64 node;
204 /*
205 * Node indexed by UST session object descriptor (handle). Stored in the
206 * ust_sessions_objd hash table in the ust_app object.
207 */
208 struct lttng_ht_node_ulong ust_objd_node;
209 /* Starts with 'ust'; no leading slash. */
210 char path[PATH_MAX];
211 /* UID/GID of the application owning the session */
212 struct lttng_credentials real_credentials;
213 /* Effective UID and GID. Same as the tracing session. */
214 struct lttng_credentials effective_credentials;
215 struct cds_list_head teardown_node;
216 /*
217 * Once at least *one* session is created onto the application, the
218 * corresponding consumer is set so we can use it on unregistration.
219 */
220 struct consumer_output *consumer;
221 enum lttng_buffer_type buffer_type;
222 /* ABI of the session. Same value as the application. */
223 uint32_t bits_per_long;
224 /* For delayed reclaim */
225 struct rcu_head rcu_head;
226 /* If the channel's streams have to be outputed or not. */
227 unsigned int output_traces;
228 unsigned int live_timer_interval; /* usec */
229
230 /* Metadata channel attributes. */
231 struct ustctl_consumer_channel_attr metadata_attr;
232
233 char root_shm_path[PATH_MAX];
234 char shm_path[PATH_MAX];
235 };
236
237 /*
238 * Registered traceable applications. Libust registers to the session daemon
239 * and a linked list is kept of all running traceable app.
240 */
241 struct ust_app {
242 int sock;
243 pthread_mutex_t sock_lock; /* Protects sock protocol. */
244
245 int notify_sock;
246 pid_t pid;
247 pid_t ppid;
248 uid_t uid; /* User ID that owns the apps */
249 gid_t gid; /* Group ID that owns the apps */
250
251 /* App ABI */
252 uint32_t bits_per_long;
253 uint32_t uint8_t_alignment;
254 uint32_t uint16_t_alignment;
255 uint32_t uint32_t_alignment;
256 uint32_t uint64_t_alignment;
257 uint32_t long_alignment;
258 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
259
260 int compatible; /* If the lttng-ust tracer version does not match the
261 supported version of the session daemon, this flag is
262 set to 0 (NOT compatible) else 1. */
263 struct lttng_ust_tracer_version version;
264 uint32_t v_major; /* Version major number */
265 uint32_t v_minor; /* Version minor number */
266 /* Extra for the NULL byte. */
267 char name[UST_APP_PROCNAME_LEN + 1];
268 /* Type of buffer this application uses. */
269 enum lttng_buffer_type buffer_type;
270 struct lttng_ht *sessions;
271 struct lttng_ht_node_ulong pid_n;
272 struct lttng_ht_node_ulong sock_n;
273 struct lttng_ht_node_ulong notify_sock_n;
274 /*
275 * This is a list of ust app session that, once the app is going into
276 * teardown mode, in the RCU call, each node in this list is removed and
277 * deleted.
278 *
279 * Element of the list are added when an application unregisters after each
280 * ht_del of ust_app_session associated to this app. This list is NOT used
281 * when a session is destroyed.
282 */
283 struct cds_list_head teardown_head;
284 /*
285 * Hash table containing ust_app_channel indexed by channel objd.
286 */
287 struct lttng_ht *ust_objd;
288 /*
289 * Hash table containing ust_app_session indexed by objd.
290 */
291 struct lttng_ht *ust_sessions_objd;
292
293 /*
294 * If this application is of the agent domain and this is non negative then
295 * a lookup MUST be done to acquire a read side reference to the
296 * corresponding agent app object. If the lookup fails, this should be set
297 * to a negative value indicating that the agent application is gone.
298 */
299 int agent_app_sock;
300 /*
301 * Time at which the app is registred.
302 * Used for path creation
303 */
304 time_t registration_time;
305 };
306
307 #ifdef HAVE_LIBLTTNG_UST_CTL
308
309 int ust_app_register(struct ust_register_msg *msg, int sock);
310 int ust_app_register_done(struct ust_app *app);
311 int ust_app_version(struct ust_app *app);
312 void ust_app_unregister(int sock);
313 int ust_app_start_trace_all(struct ltt_ust_session *usess);
314 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
315 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
316 int ust_app_list_events(struct lttng_event **events);
317 int ust_app_list_event_fields(struct lttng_event_field **fields);
318 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
319 struct ltt_ust_channel *uchan);
320 int ust_app_create_event_glb(struct ltt_ust_session *usess,
321 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
322 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
323 struct ltt_ust_channel *uchan);
324 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
325 struct ltt_ust_channel *uchan);
326 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
327 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
328 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
329 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
330 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
331 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
332 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
333 void ust_app_global_update_all(struct ltt_ust_session *usess);
334
335 void ust_app_clean_list(void);
336 int ust_app_ht_alloc(void);
337 struct ust_app *ust_app_find_by_pid(pid_t pid);
338 struct ust_app_stream *ust_app_alloc_stream(void);
339 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
340 int ust_app_recv_notify(int sock);
341 void ust_app_add(struct ust_app *app);
342 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
343 void ust_app_notify_sock_unregister(int sock);
344 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
345 struct consumer_socket *socket, int send_zero_data);
346 void ust_app_destroy(struct ust_app *app);
347 enum lttng_error_code ust_app_snapshot_record(
348 const struct ltt_ust_session *usess,
349 const struct consumer_output *output, int wait,
350 uint64_t nb_packets_per_stream);
351 uint64_t ust_app_get_size_one_more_packet_per_stream(
352 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
353 struct ust_app *ust_app_find_by_sock(int sock);
354 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
355 struct cds_list_head *buffer_reg_uid_list,
356 struct consumer_output *consumer, uint64_t uchan_id,
357 int overwrite, uint64_t *discarded, uint64_t *lost);
358 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
359 struct ltt_ust_channel *uchan,
360 struct consumer_output *consumer,
361 int overwrite, uint64_t *discarded, uint64_t *lost);
362 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
363 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
364 enum lttng_error_code ust_app_create_channel_subdirectories(
365 const struct ltt_ust_session *session);
366 int ust_app_release_object(struct ust_app *app,
367 struct lttng_ust_object_data *data);
368
369 static inline
370 int ust_app_supported(void)
371 {
372 return 1;
373 }
374
375 #else /* HAVE_LIBLTTNG_UST_CTL */
376
377 static inline
378 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
379 {
380 return 0;
381 }
382 static inline
383 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
384 {
385 return 0;
386 }
387 static inline
388 int ust_app_start_trace_all(struct ltt_ust_session *usess)
389 {
390 return 0;
391 }
392 static inline
393 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
394 {
395 return 0;
396 }
397 static inline
398 int ust_app_list_events(struct lttng_event **events)
399 {
400 return -ENOSYS;
401 }
402 static inline
403 int ust_app_list_event_fields(struct lttng_event_field **fields)
404 {
405 return -ENOSYS;
406 }
407 static inline
408 int ust_app_register(struct ust_register_msg *msg, int sock)
409 {
410 return -ENOSYS;
411 }
412 static inline
413 int ust_app_register_done(struct ust_app *app)
414 {
415 return -ENOSYS;
416 }
417 static inline
418 int ust_app_version(struct ust_app *app)
419 {
420 return -ENOSYS;
421 }
422 static inline
423 void ust_app_unregister(int sock)
424 {
425 }
426 static inline
427 void ust_app_lock_list(void)
428 {
429 }
430 static inline
431 void ust_app_unlock_list(void)
432 {
433 }
434 static inline
435 void ust_app_clean_list(void)
436 {
437 }
438 static inline
439 struct ust_app_list *ust_app_get_list(void)
440 {
441 return NULL;
442 }
443 static inline
444 struct ust_app *ust_app_get_by_pid(pid_t pid)
445 {
446 return NULL;
447 }
448 static inline
449 int ust_app_ht_alloc(void)
450 {
451 return 0;
452 }
453 static inline
454 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
455 {}
456 static inline
457 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
458 struct ltt_ust_channel *uchan)
459 {
460 return 0;
461 }
462 static inline
463 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
464 struct ltt_ust_channel *uchan)
465 {
466 return 0;
467 }
468 static inline
469 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
470 struct ltt_ust_channel *uchan)
471 {
472 return 0;
473 }
474 static inline
475 int ust_app_create_event_glb(struct ltt_ust_session *usess,
476 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
477 {
478 return 0;
479 }
480 static inline
481 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
482 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
483 {
484 return 0;
485 }
486 static inline
487 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
488 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
489 {
490 return 0;
491 }
492 static inline
493 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
494 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
495 {
496 return 0;
497 }
498 static inline
499 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
500 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
501 pid_t pid)
502 {
503 return 0;
504 }
505 static inline
506 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
507 {
508 return 0;
509 }
510 static inline
511 int ust_app_recv_notify(int sock)
512 {
513 return 0;
514 }
515 static inline
516 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
517 {
518 return NULL;
519 }
520 static inline
521 void ust_app_add(struct ust_app *app)
522 {
523 }
524 static inline
525 void ust_app_notify_sock_unregister(int sock)
526 {
527 }
528 static inline
529 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
530 struct consumer_socket *socket, int send_zero_data)
531 {
532 return 0;
533 }
534 static inline
535 void ust_app_destroy(struct ust_app *app)
536 {
537 return;
538 }
539 static inline
540 enum lttng_error_code ust_app_snapshot_record(struct ltt_ust_session *usess,
541 const struct consumer_output *output, int wait, uint64_t max_stream_size)
542 {
543 return 0;
544 }
545 static inline
546 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
547 {
548 return 0;
549 }
550
551 static inline
552 int ust_app_supported(void)
553 {
554 return 0;
555 }
556 static inline
557 struct ust_app *ust_app_find_by_sock(int sock)
558 {
559 return NULL;
560 }
561 static inline
562 struct ust_app *ust_app_find_by_pid(pid_t pid)
563 {
564 return NULL;
565 }
566 static inline
567 uint64_t ust_app_get_size_one_more_packet_per_stream(
568 const struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
569 return 0;
570 }
571 static inline
572 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
573 struct cds_list_head *buffer_reg_uid_list,
574 struct consumer_output *consumer, int overwrite,
575 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
576 {
577 return 0;
578 }
579
580 static inline
581 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
582 struct ltt_ust_channel *uchan,
583 struct consumer_output *consumer,
584 int overwrite, uint64_t *discarded, uint64_t *lost)
585 {
586 return 0;
587 }
588
589 static inline
590 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
591 {
592 return 0;
593 }
594
595 static inline
596 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session)
597 {
598 return 0;
599 }
600
601 static inline
602 enum lttng_error_code ust_app_create_channel_subdirectories(
603 const struct ltt_ust_session *session)
604 {
605 return 0;
606 }
607
608 static inline
609 int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
610 {
611 return 0;
612 }
613
614 #endif /* HAVE_LIBLTTNG_UST_CTL */
615
616 #endif /* _LTT_UST_APP_H */
This page took 0.064474 seconds and 3 git commands to generate.