Rename LTTng index in CTF index
[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 const struct lttng_ust_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 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_ust_filter_bytecode *filter;
119 struct lttng_ust_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 /*
187 * Tracing session ID. Multiple ust app session can have the same tracing
188 * session id making this value NOT unique to the object.
189 */
190 uint64_t tracing_id;
191 uint64_t id; /* Unique session identifier */
192 struct lttng_ht *channels; /* Registered channels */
193 struct lttng_ht_node_u64 node;
194 char path[PATH_MAX];
195 /* UID/GID of the application owning the session */
196 uid_t uid;
197 gid_t gid;
198 /* Effective UID and GID. Same as the tracing session. */
199 uid_t euid;
200 gid_t egid;
201 struct cds_list_head teardown_node;
202 /*
203 * Once at least *one* session is created onto the application, the
204 * corresponding consumer is set so we can use it on unregistration.
205 */
206 struct consumer_output *consumer;
207 enum lttng_buffer_type buffer_type;
208 /* ABI of the session. Same value as the application. */
209 uint32_t bits_per_long;
210 /* For delayed reclaim */
211 struct rcu_head rcu_head;
212 /* If the channel's streams have to be outputed or not. */
213 unsigned int output_traces;
214 unsigned int live_timer_interval; /* usec */
215 };
216
217 /*
218 * Registered traceable applications. Libust registers to the session daemon
219 * and a linked list is kept of all running traceable app.
220 */
221 struct ust_app {
222 int sock;
223 int notify_sock;
224 pid_t pid;
225 pid_t ppid;
226 uid_t uid; /* User ID that owns the apps */
227 gid_t gid; /* Group ID that owns the apps */
228
229 /* App ABI */
230 uint32_t bits_per_long;
231 uint32_t uint8_t_alignment;
232 uint32_t uint16_t_alignment;
233 uint32_t uint32_t_alignment;
234 uint32_t uint64_t_alignment;
235 uint32_t long_alignment;
236 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
237
238 int compatible; /* If the lttng-ust tracer version does not match the
239 supported version of the session daemon, this flag is
240 set to 0 (NOT compatible) else 1. */
241 struct lttng_ust_tracer_version version;
242 uint32_t v_major; /* Version major number */
243 uint32_t v_minor; /* Version minor number */
244 /* Extra for the NULL byte. */
245 char name[UST_APP_PROCNAME_LEN + 1];
246 /* Type of buffer this application uses. */
247 enum lttng_buffer_type buffer_type;
248 struct lttng_ht *sessions;
249 struct lttng_ht_node_ulong pid_n;
250 struct lttng_ht_node_ulong sock_n;
251 struct lttng_ht_node_ulong notify_sock_n;
252 /*
253 * This is a list of ust app session that, once the app is going into
254 * teardown mode, in the RCU call, each node in this list is removed and
255 * deleted.
256 *
257 * Element of the list are added when an application unregisters after each
258 * ht_del of ust_app_session associated to this app. This list is NOT used
259 * when a session is destroyed.
260 */
261 struct cds_list_head teardown_head;
262 /*
263 * Hash table containing ust_app_channel indexed by channel objd.
264 */
265 struct lttng_ht *ust_objd;
266 /*
267 * If this application is of the JUL domain and this is non negative then a
268 * lookup MUST be done to acquire a read side reference to the
269 * corresponding JUL app object. If the lookup fails, this should be set to
270 * a negative value indicating that the JUL application is gone.
271 */
272 int jul_app_sock;
273 };
274
275 #ifdef HAVE_LIBLTTNG_UST_CTL
276
277 int ust_app_register(struct ust_register_msg *msg, int sock);
278 static inline
279 int ust_app_register_done(int sock)
280 {
281 return ustctl_register_done(sock);
282 }
283 int ust_app_version(struct ust_app *app);
284 void ust_app_unregister(int sock);
285 unsigned long ust_app_list_count(void);
286 int ust_app_start_trace_all(struct ltt_ust_session *usess);
287 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
288 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
289 int ust_app_list_events(struct lttng_event **events);
290 int ust_app_list_event_fields(struct lttng_event_field **fields);
291 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
292 struct ltt_ust_channel *uchan);
293 int ust_app_create_event_glb(struct ltt_ust_session *usess,
294 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
295 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
296 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
297 pid_t pid);
298 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
299 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
300 pid_t pid);
301 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
302 struct ltt_ust_channel *uchan);
303 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
304 struct ltt_ust_channel *uchan);
305 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
306 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
307 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
308 struct ltt_ust_channel *uchan);
309 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
310 struct ltt_ust_channel *uchan);
311 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
312 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
313 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
314 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
315 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
316
317 void ust_app_clean_list(void);
318 void ust_app_ht_alloc(void);
319 struct lttng_ht *ust_app_get_ht(void);
320 struct ust_app *ust_app_find_by_pid(pid_t pid);
321 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
322 struct ust_app_stream *ust_app_alloc_stream(void);
323 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
324 int ust_app_recv_notify(int sock);
325 void ust_app_add(struct ust_app *app);
326 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
327 void ust_app_notify_sock_unregister(int sock);
328 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
329 struct consumer_socket *socket, int send_zero_data);
330 void ust_app_destroy(struct ust_app *app);
331 int ust_app_snapshot_record(struct ltt_ust_session *usess,
332 struct snapshot_output *output, int wait, unsigned int nb_streams);
333 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess);
334 struct ust_app *ust_app_find_by_sock(int sock);
335
336 static inline
337 int ust_app_supported(void)
338 {
339 return 1;
340 }
341
342 #else /* HAVE_LIBLTTNG_UST_CTL */
343
344 static inline
345 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
346 {
347 return 0;
348 }
349 static inline
350 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
351 {
352 return 0;
353 }
354 static inline
355 int ust_app_start_trace_all(struct ltt_ust_session *usess)
356 {
357 return 0;
358 }
359 static inline
360 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
361 {
362 return 0;
363 }
364 static inline
365 int ust_app_list_events(struct lttng_event **events)
366 {
367 return -ENOSYS;
368 }
369 static inline
370 int ust_app_list_event_fields(struct lttng_event_field **fields)
371 {
372 return -ENOSYS;
373 }
374 static inline
375 int ust_app_register(struct ust_register_msg *msg, int sock)
376 {
377 return -ENOSYS;
378 }
379 static inline
380 int ust_app_register_done(int sock)
381 {
382 return -ENOSYS;
383 }
384 static inline
385 int ust_app_version(struct ust_app *app)
386 {
387 return -ENOSYS;
388 }
389 static inline
390 void ust_app_unregister(int sock)
391 {
392 }
393 static inline
394 unsigned int ust_app_list_count(void)
395 {
396 return 0;
397 }
398 static inline
399 void ust_app_lock_list(void)
400 {
401 }
402 static inline
403 void ust_app_unlock_list(void)
404 {
405 }
406 static inline
407 void ust_app_clean_list(void)
408 {
409 }
410 static inline
411 struct ust_app_list *ust_app_get_list(void)
412 {
413 return NULL;
414 }
415 static inline
416 struct ust_app *ust_app_get_by_pid(pid_t pid)
417 {
418 return NULL;
419 }
420 static inline
421 struct lttng_ht *ust_app_get_ht(void)
422 {
423 return NULL;
424 }
425 static inline
426 void ust_app_ht_alloc(void)
427 {}
428 static inline
429 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
430 {}
431 static inline
432 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
433 struct ltt_ust_channel *uchan)
434 {
435 return 0;
436 }
437 static inline
438 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
439 struct ltt_ust_channel *uchan)
440 {
441 return 0;
442 }
443 static inline
444 int ust_app_create_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_disable_all_event_glb(struct ltt_ust_session *usess,
451 struct ltt_ust_channel *uchan)
452 {
453 return 0;
454 }
455 static inline
456 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
457 struct ltt_ust_channel *uchan)
458 {
459 return 0;
460 }
461 static inline
462 int ust_app_create_event_glb(struct ltt_ust_session *usess,
463 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
464 {
465 return 0;
466 }
467 static inline
468 int ust_app_disable_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_enable_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_add_ctx_channel_glb(struct ltt_ust_session *usess,
481 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
482 {
483 return 0;
484 }
485 static inline
486 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
487 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
488 pid_t pid)
489 {
490 return 0;
491 }
492 static inline
493 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
494 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
495 pid_t pid)
496 {
497 return 0;
498 }
499 static inline
500 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
501 {
502 return 0;
503 }
504 static inline
505 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
506 {
507 return 0;
508 }
509 static inline
510 int ust_app_recv_notify(int sock)
511 {
512 return 0;
513 }
514 static inline
515 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
516 {
517 return NULL;
518 }
519 static inline
520 void ust_app_add(struct ust_app *app)
521 {
522 }
523 static inline
524 void ust_app_notify_sock_unregister(int sock)
525 {
526 }
527 static inline
528 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
529 struct consumer_socket *socket, int send_zero_data)
530 {
531 return 0;
532 }
533 static inline
534 void ust_app_destroy(struct ust_app *app)
535 {
536 return;
537 }
538 static inline
539 int ust_app_snapshot_record(struct ltt_ust_session *usess,
540 struct snapshot_output *output, int wait, unsigned int nb_stream)
541 {
542 return 0;
543 }
544 static inline
545 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
546 {
547 return 0;
548 }
549
550 static inline
551 int ust_app_supported(void)
552 {
553 return 0;
554 }
555 static inline
556 struct ust_app *ust_app_find_by_sock(int sock)
557 {
558 return NULL;
559 }
560 static inline
561 struct ust_app *ust_app_find_by_pid(pid_t pid)
562 {
563 return NULL;
564 }
565
566 #endif /* HAVE_LIBLTTNG_UST_CTL */
567
568 #endif /* _LTT_UST_APP_H */
This page took 0.044003 seconds and 4 git commands to generate.