ff0720d18c503518ec485253a225964ef3377dee
[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 "trace-ust.h"
26 #include "ust-registry.h"
27
28 #define UST_APP_EVENT_LIST_SIZE 32
29
30 /* Process name (short). */
31 #define UST_APP_PROCNAME_LEN 16
32
33 struct lttng_filter_bytecode;
34 struct lttng_ust_filter_bytecode;
35
36 extern int ust_consumerd64_fd, ust_consumerd32_fd;
37
38 /*
39 * Object used to close the notify socket in a call_rcu(). Since the
40 * application might not be found, we need an independant object containing the
41 * notify socket fd.
42 */
43 struct ust_app_notify_sock_obj {
44 int fd;
45 struct rcu_head head;
46 };
47
48 struct ust_app_ht_key {
49 const char *name;
50 const struct lttng_filter_bytecode *filter;
51 enum lttng_ust_loglevel_type loglevel_type;
52 const struct lttng_event_exclusion *exclusion;
53 };
54
55 /*
56 * Application registration data structure.
57 */
58 struct ust_register_msg {
59 enum ustctl_socket_type type;
60 uint32_t major;
61 uint32_t minor;
62 uint32_t abi_major;
63 uint32_t abi_minor;
64 pid_t pid;
65 pid_t ppid;
66 uid_t uid;
67 gid_t gid;
68 uint32_t bits_per_long;
69 uint32_t uint8_t_alignment;
70 uint32_t uint16_t_alignment;
71 uint32_t uint32_t_alignment;
72 uint32_t uint64_t_alignment;
73 uint32_t long_alignment;
74 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
75 char name[LTTNG_UST_ABI_PROCNAME_LEN];
76 };
77
78 /*
79 * Global applications HT used by the session daemon. This table is indexed by
80 * PID using the pid_n node and pid value of an ust_app.
81 */
82 struct lttng_ht *ust_app_ht;
83
84 /*
85 * Global applications HT used by the session daemon. This table is indexed by
86 * socket using the sock_n node and sock value of an ust_app.
87 */
88 struct lttng_ht *ust_app_ht_by_sock;
89
90 /*
91 * Global applications HT used by the session daemon. This table is indexed by
92 * socket using the notify_sock_n node and notify_sock value of an ust_app.
93 */
94 struct lttng_ht *ust_app_ht_by_notify_sock;
95
96 /* Stream list containing ust_app_stream. */
97 struct ust_app_stream_list {
98 unsigned int count;
99 struct cds_list_head head;
100 };
101
102 struct ust_app_ctx {
103 int handle;
104 struct lttng_ust_context ctx;
105 struct lttng_ust_object_data *obj;
106 struct lttng_ht_node_ulong node;
107 struct cds_list_head list;
108 };
109
110 struct ust_app_event {
111 int enabled;
112 int handle;
113 struct lttng_ust_object_data *obj;
114 struct lttng_ust_event attr;
115 char name[LTTNG_UST_SYM_NAME_LEN];
116 struct lttng_ht_node_str node;
117 struct lttng_filter_bytecode *filter;
118 struct lttng_event_exclusion *exclusion;
119 };
120
121 struct ust_app_stream {
122 int handle;
123 char pathname[PATH_MAX];
124 /* Format is %s_%d respectively channel name and CPU number. */
125 char name[DEFAULT_STREAM_NAME_LEN];
126 struct lttng_ust_object_data *obj;
127 /* Using a list of streams to keep order. */
128 struct cds_list_head list;
129 };
130
131 struct ust_app_channel {
132 int enabled;
133 int handle;
134 /* Channel and streams were sent to the UST tracer. */
135 int is_sent;
136 /* Unique key used to identify the channel on the consumer side. */
137 uint64_t key;
138 /* Id of the tracing channel set on creation. */
139 uint64_t tracing_channel_id;
140 /* Number of stream that this channel is expected to receive. */
141 unsigned int expected_stream_count;
142 char name[LTTNG_UST_SYM_NAME_LEN];
143 struct lttng_ust_object_data *obj;
144 struct ustctl_consumer_channel_attr attr;
145 struct ust_app_stream_list streams;
146 /* Session pointer that owns this object. */
147 struct ust_app_session *session;
148 /*
149 * Contexts are kept in a hash table for fast lookup and in an ordered list
150 * so we are able to enable them on the tracer side in the same order the
151 * user added them.
152 */
153 struct lttng_ht *ctx;
154 struct cds_list_head ctx_list;
155
156 struct lttng_ht *events;
157 uint64_t tracefile_size;
158 uint64_t tracefile_count;
159 /*
160 * Node indexed by channel name in the channels' hash table of a session.
161 */
162 struct lttng_ht_node_str node;
163 /*
164 * Node indexed by UST channel object descriptor (handle). Stored in the
165 * ust_objd hash table in the ust_app object.
166 */
167 struct lttng_ht_node_ulong ust_objd_node;
168 /* For delayed reclaim */
169 struct rcu_head rcu_head;
170 };
171
172 struct ust_app_session {
173 /*
174 * Lock protecting this session's ust app interaction. Held
175 * across command send/recv to/from app. Never nests within the
176 * session registry lock.
177 */
178 pthread_mutex_t lock;
179
180 int enabled;
181 /* started: has the session been in started state at any time ? */
182 int started; /* allows detection of start vs restart. */
183 int handle; /* used has unique identifier for app session */
184
185 bool deleted; /* Session deleted flag. Check with lock held. */
186
187 /*
188 * Tracing session ID. Multiple ust app session can have the same tracing
189 * session id making this value NOT unique to the object.
190 */
191 uint64_t tracing_id;
192 uint64_t id; /* Unique session identifier */
193 struct lttng_ht *channels; /* Registered channels */
194 struct lttng_ht_node_u64 node;
195 char path[PATH_MAX];
196 /* UID/GID of the application owning the session */
197 uid_t uid;
198 gid_t gid;
199 /* Effective UID and GID. Same as the tracing session. */
200 uid_t euid;
201 gid_t egid;
202 struct cds_list_head teardown_node;
203 /*
204 * Once at least *one* session is created onto the application, the
205 * corresponding consumer is set so we can use it on unregistration.
206 */
207 struct consumer_output *consumer;
208 enum lttng_buffer_type buffer_type;
209 /* ABI of the session. Same value as the application. */
210 uint32_t bits_per_long;
211 /* For delayed reclaim */
212 struct rcu_head rcu_head;
213 /* If the channel's streams have to be outputed or not. */
214 unsigned int output_traces;
215 unsigned int live_timer_interval; /* usec */
216
217 /* Metadata channel attributes. */
218 struct ustctl_consumer_channel_attr metadata_attr;
219
220 char root_shm_path[PATH_MAX];
221 char shm_path[PATH_MAX];
222 };
223
224 /*
225 * Registered traceable applications. Libust registers to the session daemon
226 * and a linked list is kept of all running traceable app.
227 */
228 struct ust_app {
229 int sock;
230 pthread_mutex_t sock_lock; /* Protects sock protocol. */
231
232 int notify_sock;
233 pid_t pid;
234 pid_t ppid;
235 uid_t uid; /* User ID that owns the apps */
236 gid_t gid; /* Group ID that owns the apps */
237
238 /* App ABI */
239 uint32_t bits_per_long;
240 uint32_t uint8_t_alignment;
241 uint32_t uint16_t_alignment;
242 uint32_t uint32_t_alignment;
243 uint32_t uint64_t_alignment;
244 uint32_t long_alignment;
245 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
246
247 int compatible; /* If the lttng-ust tracer version does not match the
248 supported version of the session daemon, this flag is
249 set to 0 (NOT compatible) else 1. */
250 struct lttng_ust_tracer_version version;
251 uint32_t v_major; /* Version major number */
252 uint32_t v_minor; /* Version minor number */
253 /* Extra for the NULL byte. */
254 char name[UST_APP_PROCNAME_LEN + 1];
255 /* Type of buffer this application uses. */
256 enum lttng_buffer_type buffer_type;
257 struct lttng_ht *sessions;
258 struct lttng_ht_node_ulong pid_n;
259 struct lttng_ht_node_ulong sock_n;
260 struct lttng_ht_node_ulong notify_sock_n;
261 /*
262 * This is a list of ust app session that, once the app is going into
263 * teardown mode, in the RCU call, each node in this list is removed and
264 * deleted.
265 *
266 * Element of the list are added when an application unregisters after each
267 * ht_del of ust_app_session associated to this app. This list is NOT used
268 * when a session is destroyed.
269 */
270 struct cds_list_head teardown_head;
271 /*
272 * Hash table containing ust_app_channel indexed by channel objd.
273 */
274 struct lttng_ht *ust_objd;
275
276 /*
277 * If this application is of the agent domain and this is non negative then
278 * a lookup MUST be done to acquire a read side reference to the
279 * corresponding agent app object. If the lookup fails, this should be set
280 * to a negative value indicating that the agent application is gone.
281 */
282 int agent_app_sock;
283 };
284
285 #ifdef HAVE_LIBLTTNG_UST_CTL
286
287 int ust_app_register(struct ust_register_msg *msg, int sock);
288 int ust_app_register_done(struct ust_app *app);
289 int ust_app_version(struct ust_app *app);
290 void ust_app_unregister(int sock);
291 int ust_app_start_trace_all(struct ltt_ust_session *usess);
292 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
293 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
294 int ust_app_list_events(struct lttng_event **events);
295 int ust_app_list_event_fields(struct lttng_event_field **fields);
296 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
297 struct ltt_ust_channel *uchan);
298 int ust_app_create_event_glb(struct ltt_ust_session *usess,
299 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
300 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
301 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
302 pid_t pid);
303 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
304 struct ltt_ust_channel *uchan);
305 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
306 struct ltt_ust_channel *uchan);
307 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
308 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
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, struct ust_app *app);
316 void ust_app_global_update_all(struct ltt_ust_session *usess);
317
318 void ust_app_clean_list(void);
319 int ust_app_ht_alloc(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,
333 uint64_t nb_packets_per_stream);
334 uint64_t ust_app_get_size_one_more_packet_per_stream(
335 struct ltt_ust_session *usess, uint64_t cur_nr_packets);
336 struct ust_app *ust_app_find_by_sock(int sock);
337
338 static inline
339 int ust_app_supported(void)
340 {
341 return 1;
342 }
343
344 #else /* HAVE_LIBLTTNG_UST_CTL */
345
346 static inline
347 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
348 {
349 return 0;
350 }
351 static inline
352 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
353 {
354 return 0;
355 }
356 static inline
357 int ust_app_start_trace_all(struct ltt_ust_session *usess)
358 {
359 return 0;
360 }
361 static inline
362 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
363 {
364 return 0;
365 }
366 static inline
367 int ust_app_list_events(struct lttng_event **events)
368 {
369 return -ENOSYS;
370 }
371 static inline
372 int ust_app_list_event_fields(struct lttng_event_field **fields)
373 {
374 return -ENOSYS;
375 }
376 static inline
377 int ust_app_register(struct ust_register_msg *msg, int sock)
378 {
379 return -ENOSYS;
380 }
381 static inline
382 int ust_app_register_done(struct ust_app *app)
383 {
384 return -ENOSYS;
385 }
386 static inline
387 int ust_app_version(struct ust_app *app)
388 {
389 return -ENOSYS;
390 }
391 static inline
392 void ust_app_unregister(int sock)
393 {
394 }
395 static inline
396 void ust_app_lock_list(void)
397 {
398 }
399 static inline
400 void ust_app_unlock_list(void)
401 {
402 }
403 static inline
404 void ust_app_clean_list(void)
405 {
406 }
407 static inline
408 struct ust_app_list *ust_app_get_list(void)
409 {
410 return NULL;
411 }
412 static inline
413 struct ust_app *ust_app_get_by_pid(pid_t pid)
414 {
415 return NULL;
416 }
417 static inline
418 int ust_app_ht_alloc(void)
419 {
420 return 0;
421 }
422 static inline
423 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
424 {}
425 static inline
426 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
427 struct ltt_ust_channel *uchan)
428 {
429 return 0;
430 }
431 static inline
432 int ust_app_enable_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_create_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_enable_all_event_glb(struct ltt_ust_session *usess,
445 struct ltt_ust_channel *uchan)
446 {
447 return 0;
448 }
449 static inline
450 int ust_app_create_event_glb(struct ltt_ust_session *usess,
451 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
452 {
453 return 0;
454 }
455 static inline
456 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
457 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
458 {
459 return 0;
460 }
461 static inline
462 int ust_app_enable_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_add_ctx_channel_glb(struct ltt_ust_session *usess,
469 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
470 {
471 return 0;
472 }
473 static inline
474 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
475 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
476 pid_t pid)
477 {
478 return 0;
479 }
480 static inline
481 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
482 {
483 return 0;
484 }
485 static inline
486 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
487 {
488 return 0;
489 }
490 static inline
491 int ust_app_recv_notify(int sock)
492 {
493 return 0;
494 }
495 static inline
496 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
497 {
498 return NULL;
499 }
500 static inline
501 void ust_app_add(struct ust_app *app)
502 {
503 }
504 static inline
505 void ust_app_notify_sock_unregister(int sock)
506 {
507 }
508 static inline
509 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
510 struct consumer_socket *socket, int send_zero_data)
511 {
512 return 0;
513 }
514 static inline
515 void ust_app_destroy(struct ust_app *app)
516 {
517 return;
518 }
519 static inline
520 int ust_app_snapshot_record(struct ltt_ust_session *usess,
521 struct snapshot_output *output, int wait, uint64_t max_stream_size)
522 {
523 return 0;
524 }
525 static inline
526 unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
527 {
528 return 0;
529 }
530
531 static inline
532 int ust_app_supported(void)
533 {
534 return 0;
535 }
536 static inline
537 struct ust_app *ust_app_find_by_sock(int sock)
538 {
539 return NULL;
540 }
541 static inline
542 struct ust_app *ust_app_find_by_pid(pid_t pid)
543 {
544 return NULL;
545 }
546 static inline
547 uint64_t ust_app_get_size_one_more_packet_per_stream(
548 struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
549 return 0;
550 }
551
552 #endif /* HAVE_LIBLTTNG_UST_CTL */
553
554 #endif /* _LTT_UST_APP_H */
This page took 0.040192 seconds and 3 git commands to generate.