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