Fix: build failure with -fno-common
[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 extern 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 extern 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 extern 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_event_glb(struct ltt_ust_session *usess,
319 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
320 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
321 struct ltt_ust_channel *uchan);
322 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
323 struct ltt_ust_channel *uchan);
324 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
325 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
326 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
327 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
328 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
329 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
330 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
331 void ust_app_global_update_all(struct ltt_ust_session *usess);
332
333 void ust_app_clean_list(void);
334 int ust_app_ht_alloc(void);
335 struct ust_app *ust_app_find_by_pid(pid_t pid);
336 struct ust_app_stream *ust_app_alloc_stream(void);
337 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
338 int ust_app_recv_notify(int sock);
339 void ust_app_add(struct ust_app *app);
340 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
341 void ust_app_notify_sock_unregister(int sock);
342 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
343 struct consumer_socket *socket, int send_zero_data);
344 void ust_app_destroy(struct ust_app *app);
345 enum lttng_error_code ust_app_snapshot_record(
346 const struct ltt_ust_session *usess,
347 const struct consumer_output *output, int wait,
348 uint64_t nb_packets_per_stream);
349 uint64_t ust_app_get_size_one_more_packet_per_stream(
350 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
351 struct ust_app *ust_app_find_by_sock(int sock);
352 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
353 struct cds_list_head *buffer_reg_uid_list,
354 struct consumer_output *consumer, uint64_t uchan_id,
355 int overwrite, uint64_t *discarded, uint64_t *lost);
356 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
357 struct ltt_ust_channel *uchan,
358 struct consumer_output *consumer,
359 int overwrite, uint64_t *discarded, uint64_t *lost);
360 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
361 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
362 enum lttng_error_code ust_app_create_channel_subdirectories(
363 const struct ltt_ust_session *session);
364 int ust_app_release_object(struct ust_app *app,
365 struct lttng_ust_object_data *data);
366 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
367
368 static inline
369 int ust_app_supported(void)
370 {
371 return 1;
372 }
373
374 #else /* HAVE_LIBLTTNG_UST_CTL */
375
376 static inline
377 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
378 {
379 return 0;
380 }
381 static inline
382 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
383 {
384 return 0;
385 }
386 static inline
387 int ust_app_start_trace_all(struct ltt_ust_session *usess)
388 {
389 return 0;
390 }
391 static inline
392 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
393 {
394 return 0;
395 }
396 static inline
397 int ust_app_list_events(struct lttng_event **events)
398 {
399 return -ENOSYS;
400 }
401 static inline
402 int ust_app_list_event_fields(struct lttng_event_field **fields)
403 {
404 return -ENOSYS;
405 }
406 static inline
407 int ust_app_register(struct ust_register_msg *msg, int sock)
408 {
409 return -ENOSYS;
410 }
411 static inline
412 int ust_app_register_done(struct ust_app *app)
413 {
414 return -ENOSYS;
415 }
416 static inline
417 int ust_app_version(struct ust_app *app)
418 {
419 return -ENOSYS;
420 }
421 static inline
422 void ust_app_unregister(int sock)
423 {
424 }
425 static inline
426 void ust_app_lock_list(void)
427 {
428 }
429 static inline
430 void ust_app_unlock_list(void)
431 {
432 }
433 static inline
434 void ust_app_clean_list(void)
435 {
436 }
437 static inline
438 struct ust_app_list *ust_app_get_list(void)
439 {
440 return NULL;
441 }
442 static inline
443 struct ust_app *ust_app_get_by_pid(pid_t pid)
444 {
445 return NULL;
446 }
447 static inline
448 int ust_app_ht_alloc(void)
449 {
450 return 0;
451 }
452 static inline
453 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
454 {}
455 static inline
456 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
457 struct ltt_ust_channel *uchan)
458 {
459 return 0;
460 }
461 static inline
462 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
463 struct ltt_ust_channel *uchan)
464 {
465 return 0;
466 }
467 static inline
468 int ust_app_create_event_glb(struct ltt_ust_session *usess,
469 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
470 {
471 return 0;
472 }
473 static inline
474 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
475 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
476 {
477 return 0;
478 }
479 static inline
480 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
481 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
482 {
483 return 0;
484 }
485 static inline
486 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
487 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
488 {
489 return 0;
490 }
491 static inline
492 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
493 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
494 pid_t pid)
495 {
496 return 0;
497 }
498 static inline
499 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
500 {
501 return 0;
502 }
503 static inline
504 int ust_app_recv_notify(int sock)
505 {
506 return 0;
507 }
508 static inline
509 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
510 {
511 return NULL;
512 }
513 static inline
514 void ust_app_add(struct ust_app *app)
515 {
516 }
517 static inline
518 void ust_app_notify_sock_unregister(int sock)
519 {
520 }
521 static inline
522 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
523 struct consumer_socket *socket, int send_zero_data)
524 {
525 return 0;
526 }
527 static inline
528 void ust_app_destroy(struct ust_app *app)
529 {
530 return;
531 }
532 static inline
533 enum lttng_error_code ust_app_snapshot_record(struct ltt_ust_session *usess,
534 const struct consumer_output *output, int wait, uint64_t max_stream_size)
535 {
536 return 0;
537 }
538 static inline
539 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
540 {
541 return 0;
542 }
543
544 static inline
545 int ust_app_supported(void)
546 {
547 return 0;
548 }
549 static inline
550 struct ust_app *ust_app_find_by_sock(int sock)
551 {
552 return NULL;
553 }
554 static inline
555 struct ust_app *ust_app_find_by_pid(pid_t pid)
556 {
557 return NULL;
558 }
559 static inline
560 uint64_t ust_app_get_size_one_more_packet_per_stream(
561 const struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
562 return 0;
563 }
564 static inline
565 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
566 struct cds_list_head *buffer_reg_uid_list,
567 struct consumer_output *consumer, int overwrite,
568 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
569 {
570 return 0;
571 }
572
573 static inline
574 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
575 struct ltt_ust_channel *uchan,
576 struct consumer_output *consumer,
577 int overwrite, uint64_t *discarded, uint64_t *lost)
578 {
579 return 0;
580 }
581
582 static inline
583 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
584 {
585 return 0;
586 }
587
588 static inline
589 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session)
590 {
591 return 0;
592 }
593
594 static inline
595 enum lttng_error_code ust_app_create_channel_subdirectories(
596 const struct ltt_ust_session *session)
597 {
598 return 0;
599 }
600
601 static inline
602 int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
603 {
604 return 0;
605 }
606
607 static inline
608 enum lttng_error_code ust_app_clear_session(struct ltt_session *session)
609 {
610 return 0;
611 }
612
613 #endif /* HAVE_LIBLTTNG_UST_CTL */
614
615 #endif /* _LTT_UST_APP_H */
This page took 0.08452 seconds and 5 git commands to generate.