Add new snapshot ustctl API
[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
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_filter_bytecode *filter;
52 enum lttng_ust_loglevel_type loglevel_type;
53 const struct lttng_event_exclusion *exclusion;
54 };
55
56 /*
57 * Application registration data structure.
58 */
59 struct ust_register_msg {
60 enum ustctl_socket_type type;
61 uint32_t major;
62 uint32_t minor;
63 uint32_t abi_major;
64 uint32_t abi_minor;
65 pid_t pid;
66 pid_t ppid;
67 uid_t uid;
68 gid_t gid;
69 uint32_t bits_per_long;
70 uint32_t uint8_t_alignment;
71 uint32_t uint16_t_alignment;
72 uint32_t uint32_t_alignment;
73 uint32_t uint64_t_alignment;
74 uint32_t long_alignment;
75 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
76 char name[LTTNG_UST_ABI_PROCNAME_LEN];
77 };
78
79 /*
80 * Global applications HT used by the session daemon. This table is indexed by
81 * PID using the pid_n node and pid value of an ust_app.
82 */
83 struct lttng_ht *ust_app_ht;
84
85 /*
86 * Global applications HT used by the session daemon. This table is indexed by
87 * socket using the sock_n node and sock value of an ust_app.
88 */
89 struct lttng_ht *ust_app_ht_by_sock;
90
91 /*
92 * Global applications HT used by the session daemon. This table is indexed by
93 * socket using the notify_sock_n node and notify_sock value of an ust_app.
94 */
95 struct lttng_ht *ust_app_ht_by_notify_sock;
96
97 /* Stream list containing ust_app_stream. */
98 struct ust_app_stream_list {
99 unsigned int count;
100 struct cds_list_head head;
101 };
102
103 struct ust_app_ctx {
104 int handle;
105 struct lttng_ust_context_attr ctx;
106 struct lttng_ust_object_data *obj;
107 struct lttng_ht_node_ulong node;
108 struct cds_list_head list;
109 };
110
111 struct ust_app_event {
112 int enabled;
113 int handle;
114 struct lttng_ust_object_data *obj;
115 struct lttng_ust_event attr;
116 char name[LTTNG_UST_SYM_NAME_LEN];
117 struct lttng_ht_node_str node;
118 struct lttng_filter_bytecode *filter;
119 struct lttng_event_exclusion *exclusion;
120 };
121
122 struct ust_app_stream {
123 int handle;
124 char pathname[PATH_MAX];
125 /* Format is %s_%d respectively channel name and CPU number. */
126 char name[DEFAULT_STREAM_NAME_LEN];
127 struct lttng_ust_object_data *obj;
128 /* Using a list of streams to keep order. */
129 struct cds_list_head list;
130 };
131
132 struct ust_app_channel {
133 int enabled;
134 int handle;
135 /* Channel and streams were sent to the UST tracer. */
136 int is_sent;
137 /* Unique key used to identify the channel on the consumer side. */
138 uint64_t key;
139 /* Id of the tracing channel set on creation. */
140 uint64_t tracing_channel_id;
141 /* Number of stream that this channel is expected to receive. */
142 unsigned int expected_stream_count;
143 char name[LTTNG_UST_SYM_NAME_LEN];
144 struct lttng_ust_object_data *obj;
145 struct ustctl_consumer_channel_attr attr;
146 struct ust_app_stream_list streams;
147 /* Session pointer that owns this object. */
148 struct ust_app_session *session;
149 /*
150 * Contexts are kept in a hash table for fast lookup and in an ordered list
151 * so we are able to enable them on the tracer side in the same order the
152 * user added them.
153 */
154 struct lttng_ht *ctx;
155 struct cds_list_head ctx_list;
156
157 struct lttng_ht *events;
158 uint64_t tracefile_size;
159 uint64_t tracefile_count;
160 /*
161 * Node indexed by channel name in the channels' hash table of a session.
162 */
163 struct lttng_ht_node_str node;
164 /*
165 * Node indexed by UST channel object descriptor (handle). Stored in the
166 * ust_objd hash table in the ust_app object.
167 */
168 struct lttng_ht_node_ulong ust_objd_node;
169 /* For delayed reclaim */
170 struct rcu_head rcu_head;
171 };
172
173 struct ust_app_session {
174 /*
175 * Lock protecting this session's ust app interaction. Held
176 * across command send/recv to/from app. Never nests within the
177 * session registry lock.
178 */
179 pthread_mutex_t lock;
180
181 int enabled;
182 /* started: has the session been in started state at any time ? */
183 int started; /* allows detection of start vs restart. */
184 int handle; /* used has unique identifier for app session */
185
186 bool deleted; /* Session deleted flag. Check with lock held. */
187
188 /*
189 * Tracing session ID. Multiple ust app session can have the same tracing
190 * session id making this value NOT unique to the object.
191 */
192 uint64_t tracing_id;
193 uint64_t id; /* Unique session identifier */
194 struct lttng_ht *channels; /* Registered channels */
195 struct lttng_ht_node_u64 node;
196 /*
197 * Node indexed by UST session object descriptor (handle). Stored in the
198 * ust_sessions_objd hash table in the ust_app object.
199 */
200 struct lttng_ht_node_ulong ust_objd_node;
201 char path[PATH_MAX];
202 /* UID/GID of the application owning the session */
203 uid_t uid;
204 gid_t gid;
205 /* Effective UID and GID. Same as the tracing session. */
206 uid_t euid;
207 gid_t egid;
208 struct cds_list_head teardown_node;
209 /*
210 * Once at least *one* session is created onto the application, the
211 * corresponding consumer is set so we can use it on unregistration.
212 */
213 struct consumer_output *consumer;
214 enum lttng_buffer_type buffer_type;
215 /* ABI of the session. Same value as the application. */
216 uint32_t bits_per_long;
217 /* For delayed reclaim */
218 struct rcu_head rcu_head;
219 /* If the channel's streams have to be outputed or not. */
220 unsigned int output_traces;
221 unsigned int live_timer_interval; /* usec */
222
223 /* Metadata channel attributes. */
224 struct ustctl_consumer_channel_attr metadata_attr;
225
226 char root_shm_path[PATH_MAX];
227 char shm_path[PATH_MAX];
228 };
229
230 /*
231 * Registered traceable applications. Libust registers to the session daemon
232 * and a linked list is kept of all running traceable app.
233 */
234 struct ust_app {
235 int sock;
236 pthread_mutex_t sock_lock; /* Protects sock protocol. */
237
238 int notify_sock;
239 pid_t pid;
240 pid_t ppid;
241 uid_t uid; /* User ID that owns the apps */
242 gid_t gid; /* Group ID that owns the apps */
243
244 /* App ABI */
245 uint32_t bits_per_long;
246 uint32_t uint8_t_alignment;
247 uint32_t uint16_t_alignment;
248 uint32_t uint32_t_alignment;
249 uint32_t uint64_t_alignment;
250 uint32_t long_alignment;
251 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
252
253 int compatible; /* If the lttng-ust tracer version does not match the
254 supported version of the session daemon, this flag is
255 set to 0 (NOT compatible) else 1. */
256 struct lttng_ust_tracer_version version;
257 uint32_t v_major; /* Version major number */
258 uint32_t v_minor; /* Version minor number */
259 /* Extra for the NULL byte. */
260 char name[UST_APP_PROCNAME_LEN + 1];
261 /* Type of buffer this application uses. */
262 enum lttng_buffer_type buffer_type;
263 struct lttng_ht *sessions;
264 struct lttng_ht_node_ulong pid_n;
265 struct lttng_ht_node_ulong sock_n;
266 struct lttng_ht_node_ulong notify_sock_n;
267 /*
268 * This is a list of ust app session that, once the app is going into
269 * teardown mode, in the RCU call, each node in this list is removed and
270 * deleted.
271 *
272 * Element of the list are added when an application unregisters after each
273 * ht_del of ust_app_session associated to this app. This list is NOT used
274 * when a session is destroyed.
275 */
276 struct cds_list_head teardown_head;
277 /*
278 * Hash table containing ust_app_channel indexed by channel objd.
279 */
280 struct lttng_ht *ust_objd;
281 /*
282 * Hash table containing ust_app_session indexed by objd.
283 */
284 struct lttng_ht *ust_sessions_objd;
285
286 /*
287 * If this application is of the agent domain and this is non negative then
288 * a lookup MUST be done to acquire a read side reference to the
289 * corresponding agent app object. If the lookup fails, this should be set
290 * to a negative value indicating that the agent application is gone.
291 */
292 int agent_app_sock;
293 };
294
295 #ifdef HAVE_LIBLTTNG_UST_CTL
296
297 int ust_app_register(struct ust_register_msg *msg, int sock);
298 int ust_app_register_done(struct ust_app *app);
299 int ust_app_version(struct ust_app *app);
300 void ust_app_unregister(int sock);
301 int ust_app_start_trace_all(struct ltt_ust_session *usess);
302 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
303 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
304 int ust_app_list_events(struct lttng_event **events);
305 int ust_app_list_event_fields(struct lttng_event_field **fields);
306 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
307 struct ltt_ust_channel *uchan);
308 int ust_app_create_event_glb(struct ltt_ust_session *usess,
309 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
310 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
311 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
312 pid_t pid);
313 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
314 struct ltt_ust_channel *uchan);
315 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
316 struct ltt_ust_channel *uchan);
317 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
318 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
319 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
320 struct ltt_ust_channel *uchan);
321 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
322 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
323 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
324 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
325 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
326 void ust_app_global_update_all(struct ltt_ust_session *usess);
327
328 void ust_app_clean_list(void);
329 int ust_app_ht_alloc(void);
330 struct ust_app *ust_app_find_by_pid(pid_t pid);
331 struct ust_app_stream *ust_app_alloc_stream(void);
332 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
333 int ust_app_recv_notify(int sock);
334 void ust_app_add(struct ust_app *app);
335 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
336 void ust_app_notify_sock_unregister(int sock);
337 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
338 struct consumer_socket *socket, int send_zero_data);
339 void ust_app_destroy(struct ust_app *app);
340 int ust_app_snapshot_record(struct ltt_ust_session *usess,
341 struct snapshot_output *output, int wait,
342 uint64_t nb_packets_per_stream);
343 uint64_t ust_app_get_size_one_more_packet_per_stream(
344 struct ltt_ust_session *usess, uint64_t cur_nr_packets);
345 struct ust_app *ust_app_find_by_sock(int sock);
346 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
347 struct cds_list_head *buffer_reg_uid_list,
348 struct consumer_output *consumer, uint64_t uchan_id,
349 int overwrite, uint64_t *discarded, uint64_t *lost);
350 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
351 struct ltt_ust_channel *uchan,
352 struct consumer_output *consumer,
353 int overwrite, uint64_t *discarded, uint64_t *lost);
354 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
355
356 static inline
357 int ust_app_supported(void)
358 {
359 return 1;
360 }
361
362 #else /* HAVE_LIBLTTNG_UST_CTL */
363
364 static inline
365 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
366 {
367 return 0;
368 }
369 static inline
370 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
371 {
372 return 0;
373 }
374 static inline
375 int ust_app_start_trace_all(struct ltt_ust_session *usess)
376 {
377 return 0;
378 }
379 static inline
380 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
381 {
382 return 0;
383 }
384 static inline
385 int ust_app_list_events(struct lttng_event **events)
386 {
387 return -ENOSYS;
388 }
389 static inline
390 int ust_app_list_event_fields(struct lttng_event_field **fields)
391 {
392 return -ENOSYS;
393 }
394 static inline
395 int ust_app_register(struct ust_register_msg *msg, int sock)
396 {
397 return -ENOSYS;
398 }
399 static inline
400 int ust_app_register_done(struct ust_app *app)
401 {
402 return -ENOSYS;
403 }
404 static inline
405 int ust_app_version(struct ust_app *app)
406 {
407 return -ENOSYS;
408 }
409 static inline
410 void ust_app_unregister(int sock)
411 {
412 }
413 static inline
414 void ust_app_lock_list(void)
415 {
416 }
417 static inline
418 void ust_app_unlock_list(void)
419 {
420 }
421 static inline
422 void ust_app_clean_list(void)
423 {
424 }
425 static inline
426 struct ust_app_list *ust_app_get_list(void)
427 {
428 return NULL;
429 }
430 static inline
431 struct ust_app *ust_app_get_by_pid(pid_t pid)
432 {
433 return NULL;
434 }
435 static inline
436 int ust_app_ht_alloc(void)
437 {
438 return 0;
439 }
440 static inline
441 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
442 {}
443 static inline
444 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
445 struct ltt_ust_channel *uchan)
446 {
447 return 0;
448 }
449 static inline
450 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
451 struct ltt_ust_channel *uchan)
452 {
453 return 0;
454 }
455 static inline
456 int ust_app_create_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_all_event_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 int ust_app_snapshot_record(struct ltt_ust_session *usess,
534 struct snapshot_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 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 #endif /* HAVE_LIBLTTNG_UST_CTL */
589
590 #endif /* _LTT_UST_APP_H */
This page took 0.040884 seconds and 4 git commands to generate.