Docs: document the meaning of a ust app channel key set to 0
[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/compat/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 occured).
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 char path[PATH_MAX];
210 /* UID/GID of the application owning the session */
211 uid_t uid;
212 gid_t gid;
213 /* Effective UID and GID. Same as the tracing session. */
214 uid_t euid;
215 gid_t egid;
216 struct cds_list_head teardown_node;
217 /*
218 * Once at least *one* session is created onto the application, the
219 * corresponding consumer is set so we can use it on unregistration.
220 */
221 struct consumer_output *consumer;
222 enum lttng_buffer_type buffer_type;
223 /* ABI of the session. Same value as the application. */
224 uint32_t bits_per_long;
225 /* For delayed reclaim */
226 struct rcu_head rcu_head;
227 /* If the channel's streams have to be outputed or not. */
228 unsigned int output_traces;
229 unsigned int live_timer_interval; /* usec */
230
231 /* Metadata channel attributes. */
232 struct ustctl_consumer_channel_attr metadata_attr;
233
234 char root_shm_path[PATH_MAX];
235 char shm_path[PATH_MAX];
236 };
237
238 /*
239 * Registered traceable applications. Libust registers to the session daemon
240 * and a linked list is kept of all running traceable app.
241 */
242 struct ust_app {
243 int sock;
244 pthread_mutex_t sock_lock; /* Protects sock protocol. */
245
246 int notify_sock;
247 pid_t pid;
248 pid_t ppid;
249 uid_t uid; /* User ID that owns the apps */
250 gid_t gid; /* Group ID that owns the apps */
251
252 /* App ABI */
253 uint32_t bits_per_long;
254 uint32_t uint8_t_alignment;
255 uint32_t uint16_t_alignment;
256 uint32_t uint32_t_alignment;
257 uint32_t uint64_t_alignment;
258 uint32_t long_alignment;
259 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
260
261 int compatible; /* If the lttng-ust tracer version does not match the
262 supported version of the session daemon, this flag is
263 set to 0 (NOT compatible) else 1. */
264 struct lttng_ust_tracer_version version;
265 uint32_t v_major; /* Version major number */
266 uint32_t v_minor; /* Version minor number */
267 /* Extra for the NULL byte. */
268 char name[UST_APP_PROCNAME_LEN + 1];
269 /* Type of buffer this application uses. */
270 enum lttng_buffer_type buffer_type;
271 struct lttng_ht *sessions;
272 struct lttng_ht_node_ulong pid_n;
273 struct lttng_ht_node_ulong sock_n;
274 struct lttng_ht_node_ulong notify_sock_n;
275 /*
276 * This is a list of ust app session that, once the app is going into
277 * teardown mode, in the RCU call, each node in this list is removed and
278 * deleted.
279 *
280 * Element of the list are added when an application unregisters after each
281 * ht_del of ust_app_session associated to this app. This list is NOT used
282 * when a session is destroyed.
283 */
284 struct cds_list_head teardown_head;
285 /*
286 * Hash table containing ust_app_channel indexed by channel objd.
287 */
288 struct lttng_ht *ust_objd;
289 /*
290 * Hash table containing ust_app_session indexed by objd.
291 */
292 struct lttng_ht *ust_sessions_objd;
293
294 /*
295 * If this application is of the agent domain and this is non negative then
296 * a lookup MUST be done to acquire a read side reference to the
297 * corresponding agent app object. If the lookup fails, this should be set
298 * to a negative value indicating that the agent application is gone.
299 */
300 int agent_app_sock;
301 };
302
303 #ifdef HAVE_LIBLTTNG_UST_CTL
304
305 int ust_app_register(struct ust_register_msg *msg, int sock);
306 int ust_app_register_done(struct ust_app *app);
307 int ust_app_version(struct ust_app *app);
308 void ust_app_unregister(int sock);
309 int ust_app_start_trace_all(struct ltt_ust_session *usess);
310 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
311 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
312 int ust_app_list_events(struct lttng_event **events);
313 int ust_app_list_event_fields(struct lttng_event_field **fields);
314 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
315 struct ltt_ust_channel *uchan);
316 int ust_app_create_event_glb(struct ltt_ust_session *usess,
317 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
318 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
319 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
320 pid_t pid);
321 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
322 struct ltt_ust_channel *uchan);
323 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
324 struct ltt_ust_channel *uchan);
325 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
326 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
327 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
328 struct ltt_ust_channel *uchan);
329 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
330 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
331 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
332 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
333 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
334 void ust_app_global_update_all(struct ltt_ust_session *usess);
335
336 void ust_app_clean_list(void);
337 int ust_app_ht_alloc(void);
338 struct ust_app *ust_app_find_by_pid(pid_t pid);
339 struct ust_app_stream *ust_app_alloc_stream(void);
340 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
341 int ust_app_recv_notify(int sock);
342 void ust_app_add(struct ust_app *app);
343 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
344 void ust_app_notify_sock_unregister(int sock);
345 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
346 struct consumer_socket *socket, int send_zero_data);
347 void ust_app_destroy(struct ust_app *app);
348 int ust_app_snapshot_record(struct ltt_ust_session *usess,
349 struct snapshot_output *output, int wait,
350 uint64_t nb_packets_per_stream);
351 uint64_t ust_app_get_size_one_more_packet_per_stream(
352 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 int ust_app_rotate_session(struct ltt_session *session, bool *ust_active);
364
365 static inline
366 int ust_app_supported(void)
367 {
368 return 1;
369 }
370
371 #else /* HAVE_LIBLTTNG_UST_CTL */
372
373 static inline
374 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
375 {
376 return 0;
377 }
378 static inline
379 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
380 {
381 return 0;
382 }
383 static inline
384 int ust_app_start_trace_all(struct ltt_ust_session *usess)
385 {
386 return 0;
387 }
388 static inline
389 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
390 {
391 return 0;
392 }
393 static inline
394 int ust_app_list_events(struct lttng_event **events)
395 {
396 return -ENOSYS;
397 }
398 static inline
399 int ust_app_list_event_fields(struct lttng_event_field **fields)
400 {
401 return -ENOSYS;
402 }
403 static inline
404 int ust_app_register(struct ust_register_msg *msg, int sock)
405 {
406 return -ENOSYS;
407 }
408 static inline
409 int ust_app_register_done(struct ust_app *app)
410 {
411 return -ENOSYS;
412 }
413 static inline
414 int ust_app_version(struct ust_app *app)
415 {
416 return -ENOSYS;
417 }
418 static inline
419 void ust_app_unregister(int sock)
420 {
421 }
422 static inline
423 void ust_app_lock_list(void)
424 {
425 }
426 static inline
427 void ust_app_unlock_list(void)
428 {
429 }
430 static inline
431 void ust_app_clean_list(void)
432 {
433 }
434 static inline
435 struct ust_app_list *ust_app_get_list(void)
436 {
437 return NULL;
438 }
439 static inline
440 struct ust_app *ust_app_get_by_pid(pid_t pid)
441 {
442 return NULL;
443 }
444 static inline
445 int ust_app_ht_alloc(void)
446 {
447 return 0;
448 }
449 static inline
450 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
451 {}
452 static inline
453 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
454 struct ltt_ust_channel *uchan)
455 {
456 return 0;
457 }
458 static inline
459 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
460 struct ltt_ust_channel *uchan)
461 {
462 return 0;
463 }
464 static inline
465 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
466 struct ltt_ust_channel *uchan)
467 {
468 return 0;
469 }
470 static inline
471 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
472 struct ltt_ust_channel *uchan)
473 {
474 return 0;
475 }
476 static inline
477 int ust_app_create_event_glb(struct ltt_ust_session *usess,
478 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
479 {
480 return 0;
481 }
482 static inline
483 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
484 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
485 {
486 return 0;
487 }
488 static inline
489 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
490 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
491 {
492 return 0;
493 }
494 static inline
495 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
496 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
497 {
498 return 0;
499 }
500 static inline
501 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
502 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
503 pid_t pid)
504 {
505 return 0;
506 }
507 static inline
508 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
509 {
510 return 0;
511 }
512 static inline
513 int ust_app_recv_notify(int sock)
514 {
515 return 0;
516 }
517 static inline
518 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
519 {
520 return NULL;
521 }
522 static inline
523 void ust_app_add(struct ust_app *app)
524 {
525 }
526 static inline
527 void ust_app_notify_sock_unregister(int sock)
528 {
529 }
530 static inline
531 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
532 struct consumer_socket *socket, int send_zero_data)
533 {
534 return 0;
535 }
536 static inline
537 void ust_app_destroy(struct ust_app *app)
538 {
539 return;
540 }
541 static inline
542 int ust_app_snapshot_record(struct ltt_ust_session *usess,
543 struct snapshot_output *output, int wait, uint64_t max_stream_size)
544 {
545 return 0;
546 }
547 static inline
548 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
549 {
550 return 0;
551 }
552
553 static inline
554 int ust_app_supported(void)
555 {
556 return 0;
557 }
558 static inline
559 struct ust_app *ust_app_find_by_sock(int sock)
560 {
561 return NULL;
562 }
563 static inline
564 struct ust_app *ust_app_find_by_pid(pid_t pid)
565 {
566 return NULL;
567 }
568 static inline
569 uint64_t ust_app_get_size_one_more_packet_per_stream(
570 struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
571 return 0;
572 }
573 static inline
574 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
575 struct cds_list_head *buffer_reg_uid_list,
576 struct consumer_output *consumer, int overwrite,
577 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
578 {
579 return 0;
580 }
581
582 static inline
583 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
584 struct ltt_ust_channel *uchan,
585 struct consumer_output *consumer,
586 int overwrite, uint64_t *discarded, uint64_t *lost)
587 {
588 return 0;
589 }
590
591 static inline
592 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
593 {
594 return 0;
595 }
596
597 static inline
598 int ust_app_rotate_session(struct ltt_session *session, bool *ust_active)
599 {
600 return 0;
601 }
602
603 #endif /* HAVE_LIBLTTNG_UST_CTL */
604
605 #endif /* _LTT_UST_APP_H */
This page took 0.066178 seconds and 4 git commands to generate.