2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
10 #define _LTT_UST_APP_H
15 #include <common/index-allocator.h>
16 #include <common/uuid.h>
18 #include "trace-ust.h"
19 #include "ust-registry.h"
22 #define UST_APP_EVENT_LIST_SIZE 32
24 /* Process name (short). */
25 #define UST_APP_PROCNAME_LEN 16
27 struct lttng_bytecode
;
28 struct lttng_ust_filter_bytecode
;
30 extern int the_ust_consumerd64_fd
, the_ust_consumerd32_fd
;
33 * Object used to close the notify socket in a call_rcu(). Since the
34 * application might not be found, we need an independant object containing the
37 struct ust_app_notify_sock_obj
{
42 struct ust_app_ht_key
{
44 const struct lttng_bytecode
*filter
;
45 enum lttng_ust_abi_loglevel_type loglevel_type
;
47 const struct lttng_event_exclusion
*exclusion
;
51 * Application registration data structure.
53 struct ust_register_msg
{
54 enum lttng_ust_ctl_socket_type type
;
63 uint32_t bits_per_long
;
64 uint32_t uint8_t_alignment
;
65 uint32_t uint16_t_alignment
;
66 uint32_t uint32_t_alignment
;
67 uint32_t uint64_t_alignment
;
68 uint32_t long_alignment
;
69 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
70 char name
[LTTNG_UST_ABI_PROCNAME_LEN
];
74 * Global applications HT used by the session daemon. This table is indexed by
75 * PID using the pid_n node and pid value of an ust_app.
77 extern struct lttng_ht
*ust_app_ht
;
80 * Global applications HT used by the session daemon. This table is indexed by
81 * socket using the sock_n node and sock value of an ust_app.
83 * The 'sock' in question here is the 'command' socket.
85 extern struct lttng_ht
*ust_app_ht_by_sock
;
88 * Global applications HT used by the session daemon. This table is indexed by
89 * socket using the notify_sock_n node and notify_sock value of an ust_app.
91 extern struct lttng_ht
*ust_app_ht_by_notify_sock
;
93 /* Stream list containing ust_app_stream. */
94 struct ust_app_stream_list
{
96 struct cds_list_head head
;
101 struct lttng_ust_context_attr ctx
;
102 struct lttng_ust_abi_object_data
*obj
;
103 struct lttng_ht_node_ulong node
;
104 struct cds_list_head list
;
107 struct ust_app_event
{
110 struct lttng_ust_abi_object_data
*obj
;
111 struct lttng_ust_abi_event attr
;
112 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
113 struct lttng_ht_node_str node
;
114 struct lttng_bytecode
*filter
;
115 struct lttng_event_exclusion
*exclusion
;
118 struct ust_app_event_notifier_rule
{
120 uint64_t error_counter_index
;
122 struct lttng_ust_abi_object_data
*obj
;
123 /* Holds a strong reference. */
124 struct lttng_trigger
*trigger
;
125 /* Unique ID returned by the tracer to identify this event notifier. */
127 struct lttng_ht_node_u64 node
;
128 /* The trigger object owns the filter. */
129 const struct lttng_bytecode
*filter
;
131 struct lttng_event_exclusion
*exclusion
;
132 /* For delayed reclaim. */
133 struct rcu_head rcu_head
;
136 struct ust_app_stream
{
138 char pathname
[PATH_MAX
];
139 /* Format is %s_%d respectively channel name and CPU number. */
140 char name
[DEFAULT_STREAM_NAME_LEN
];
141 struct lttng_ust_abi_object_data
*obj
;
142 /* Using a list of streams to keep order. */
143 struct cds_list_head list
;
146 struct ust_app_channel
{
149 /* Channel and streams were sent to the UST tracer. */
152 * Unique key used to identify the channel on the consumer side.
153 * 0 is a reserved 'invalid' value used to indicate that the consumer
154 * does not know about this channel (i.e. an error occurred).
157 /* Id of the tracing channel set on creation. */
158 uint64_t tracing_channel_id
;
159 /* Number of stream that this channel is expected to receive. */
160 unsigned int expected_stream_count
;
161 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
162 struct lttng_ust_abi_object_data
*obj
;
163 struct lttng_ust_ctl_consumer_channel_attr attr
;
164 struct ust_app_stream_list streams
;
165 /* Session pointer that owns this object. */
166 struct ust_app_session
*session
;
168 * Contexts are kept in a hash table for fast lookup and in an ordered list
169 * so we are able to enable them on the tracer side in the same order the
172 struct lttng_ht
*ctx
;
173 struct cds_list_head ctx_list
;
175 struct lttng_ht
*events
;
176 uint64_t tracefile_size
;
177 uint64_t tracefile_count
;
178 uint64_t monitor_timer_interval
;
180 * Node indexed by channel name in the channels' hash table of a session.
182 struct lttng_ht_node_str node
;
184 * Node indexed by UST channel object descriptor (handle). Stored in the
185 * ust_objd hash table in the ust_app object.
187 struct lttng_ht_node_ulong ust_objd_node
;
188 /* For delayed reclaim */
189 struct rcu_head rcu_head
;
192 struct ust_app_session
{
194 * Lock protecting this session's ust app interaction. Held
195 * across command send/recv to/from app. Never nests within the
196 * session registry lock.
198 pthread_mutex_t lock
;
201 /* started: has the session been in started state at any time ? */
202 int started
; /* allows detection of start vs restart. */
203 int handle
; /* used has unique identifier for app session */
205 bool deleted
; /* Session deleted flag. Check with lock held. */
208 * Tracing session ID. Multiple ust app session can have the same tracing
209 * session id making this value NOT unique to the object.
212 uint64_t id
; /* Unique session identifier */
213 struct lttng_ht
*channels
; /* Registered channels */
214 struct lttng_ht_node_u64 node
;
216 * Node indexed by UST session object descriptor (handle). Stored in the
217 * ust_sessions_objd hash table in the ust_app object.
219 struct lttng_ht_node_ulong ust_objd_node
;
220 /* Starts with 'ust'; no leading slash. */
222 /* UID/GID of the application owning the session */
223 struct lttng_credentials real_credentials
;
224 /* Effective UID and GID. Same as the tracing session. */
225 struct lttng_credentials effective_credentials
;
226 struct cds_list_head teardown_node
;
228 * Once at least *one* session is created onto the application, the
229 * corresponding consumer is set so we can use it on unregistration.
231 struct consumer_output
*consumer
;
232 enum lttng_buffer_type buffer_type
;
233 /* ABI of the session. Same value as the application. */
234 uint32_t bits_per_long
;
235 /* For delayed reclaim */
236 struct rcu_head rcu_head
;
237 /* If the channel's streams have to be outputed or not. */
238 unsigned int output_traces
;
239 unsigned int live_timer_interval
; /* usec */
241 /* Metadata channel attributes. */
242 struct lttng_ust_ctl_consumer_channel_attr metadata_attr
;
244 char root_shm_path
[PATH_MAX
];
245 char shm_path
[PATH_MAX
];
249 * Registered traceable applications. Libust registers to the session daemon
250 * and a linked list is kept of all running traceable app.
254 * The lifetime of 'sock' holds a reference to the application; the
255 * application management thread will release a reference to the
256 * application if the application dies.
260 pthread_mutex_t sock_lock
; /* Protects sock protocol. */
265 uid_t uid
; /* User ID that owns the apps */
266 gid_t gid
; /* Group ID that owns the apps */
269 uint32_t bits_per_long
;
270 uint32_t uint8_t_alignment
;
271 uint32_t uint16_t_alignment
;
272 uint32_t uint32_t_alignment
;
273 uint32_t uint64_t_alignment
;
274 uint32_t long_alignment
;
275 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
277 int compatible
; /* If the lttng-ust tracer version does not match the
278 supported version of the session daemon, this flag is
279 set to 0 (NOT compatible) else 1. */
280 struct lttng_ust_abi_tracer_version version
;
281 uint32_t v_major
; /* Version major number */
282 uint32_t v_minor
; /* Version minor number */
283 /* Extra for the NULL byte. */
284 char name
[UST_APP_PROCNAME_LEN
+ 1];
285 /* Type of buffer this application uses. */
286 enum lttng_buffer_type buffer_type
;
287 struct lttng_ht
*sessions
;
288 struct lttng_ht_node_ulong pid_n
;
289 struct lttng_ht_node_ulong sock_n
;
290 struct lttng_ht_node_ulong notify_sock_n
;
292 * This is a list of ust app session that, once the app is going into
293 * teardown mode, in the RCU call, each node in this list is removed and
296 * Element of the list are added when an application unregisters after each
297 * ht_del of ust_app_session associated to this app. This list is NOT used
298 * when a session is destroyed.
300 struct cds_list_head teardown_head
;
302 * Hash table containing ust_app_channel indexed by channel objd.
304 struct lttng_ht
*ust_objd
;
306 * Hash table containing ust_app_session indexed by objd.
308 struct lttng_ht
*ust_sessions_objd
;
311 * If this application is of the agent domain and this is non negative then
312 * a lookup MUST be done to acquire a read side reference to the
313 * corresponding agent app object. If the lookup fails, this should be set
314 * to a negative value indicating that the agent application is gone.
318 * Time at which the app is registred.
319 * Used for path creation
321 time_t registration_time
;
327 * Handle to the lttng_ust object representing the event
330 struct lttng_ust_abi_object_data
*object
;
331 struct lttng_pipe
*event_pipe
;
332 struct lttng_ust_abi_object_data
*counter
;
333 struct lttng_ust_abi_object_data
**counter_cpu
;
335 } event_notifier_group
;
337 * Hashtable indexing the application's event notifier rule's
338 * (ust_app_event_notifier_rule) by their token's value.
340 struct lttng_ht
*token_to_event_notifier_rule_ht
;
343 #ifdef HAVE_LIBLTTNG_UST_CTL
345 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
346 int ust_app_register_done(struct ust_app
*app
);
347 int ust_app_version(struct ust_app
*app
);
348 void ust_app_unregister_by_socket(int sock
);
349 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
350 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
351 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
352 int ust_app_list_events(struct lttng_event
**events
);
353 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
354 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
355 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
356 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
357 struct ltt_ust_channel
*uchan
);
358 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
359 struct ltt_ust_channel
*uchan
);
360 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
361 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
362 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
363 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
364 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
365 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
366 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
);
367 void ust_app_global_update_all(struct ltt_ust_session
*usess
);
368 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
);
369 void ust_app_global_update_all_event_notifier_rules(void);
371 void ust_app_clean_list(void);
372 int ust_app_ht_alloc(void);
373 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
374 struct ust_app_stream
*ust_app_alloc_stream(void);
375 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
);
376 int ust_app_recv_notify(int sock
);
377 void ust_app_add(struct ust_app
*app
);
378 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
);
379 void ust_app_notify_sock_unregister(int sock
);
380 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
381 struct consumer_socket
*socket
, int send_zero_data
);
382 enum lttng_error_code
ust_app_snapshot_record(
383 const struct ltt_ust_session
*usess
,
384 const struct consumer_output
*output
, int wait
,
385 uint64_t nb_packets_per_stream
);
386 uint64_t ust_app_get_size_one_more_packet_per_stream(
387 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
);
388 struct ust_app
*ust_app_find_by_sock(int sock
);
389 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
390 struct cds_list_head
*buffer_reg_uid_list
,
391 struct consumer_output
*consumer
, uint64_t uchan_id
,
392 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
393 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
394 struct ltt_ust_channel
*uchan
,
395 struct consumer_output
*consumer
,
396 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
397 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
);
398 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
);
399 enum lttng_error_code
ust_app_create_channel_subdirectories(
400 const struct ltt_ust_session
*session
);
401 int ust_app_release_object(struct ust_app
*app
,
402 struct lttng_ust_abi_object_data
*data
);
403 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
);
404 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
);
406 int ust_app_setup_event_notifier_group(struct ust_app
*app
);
409 int ust_app_supported(void)
414 bool ust_app_supports_notifiers(const struct ust_app
*app
);
415 bool ust_app_supports_counters(const struct ust_app
*app
);
417 bool ust_app_get(struct ust_app
*app
);
418 void ust_app_put(struct ust_app
*app
);
420 #else /* HAVE_LIBLTTNG_UST_CTL */
423 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
428 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
433 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
438 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
443 int ust_app_list_events(struct lttng_event
**events
)
448 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
453 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
458 int ust_app_register_done(struct ust_app
*app
)
463 int ust_app_version(struct ust_app
*app
)
468 void ust_app_unregister_by_socket(int sock
)
472 void ust_app_lock_list(void)
476 void ust_app_unlock_list(void)
480 void ust_app_clean_list(void)
484 struct ust_app_list
*ust_app_get_list(void)
489 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
494 int ust_app_ht_alloc(void)
499 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
502 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
505 void ust_app_global_update_all_event_notifier_rules(void)
508 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
513 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
514 struct ltt_ust_channel
*uchan
)
519 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
520 struct ltt_ust_channel
*uchan
)
525 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
526 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
531 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
532 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
537 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
538 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
543 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
544 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
549 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
550 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
556 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
561 int ust_app_recv_notify(int sock
)
566 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
571 void ust_app_add(struct ust_app
*app
)
575 void ust_app_notify_sock_unregister(int sock
)
579 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
580 struct consumer_socket
*socket
, int send_zero_data
)
585 enum lttng_error_code
ust_app_snapshot_record(struct ltt_ust_session
*usess
,
586 const struct consumer_output
*output
, int wait
, uint64_t max_stream_size
)
591 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
596 void ust_app_update_event_notifier_error_count(
597 struct lttng_trigger
*lttng_trigger
)
602 int ust_app_supported(void)
607 bool ust_app_supports_notifiers(const struct ust_app
*app
)
612 bool ust_app_supports_counters(const struct ust_app
*app
)
617 struct ust_app
*ust_app_find_by_sock(int sock
)
622 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
627 uint64_t ust_app_get_size_one_more_packet_per_stream(
628 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
) {
632 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
633 struct cds_list_head
*buffer_reg_uid_list
,
634 struct consumer_output
*consumer
, int overwrite
,
635 uint64_t uchan_id
, uint64_t *discarded
, uint64_t *lost
)
641 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
642 struct ltt_ust_channel
*uchan
,
643 struct consumer_output
*consumer
,
644 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
650 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
656 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
662 enum lttng_error_code
ust_app_create_channel_subdirectories(
663 const struct ltt_ust_session
*session
)
669 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*data
)
675 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
681 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
687 void ust_app_get(struct ust_app
*app
)
692 void ust_app_put(struct ust_app
*app
)
696 #endif /* HAVE_LIBLTTNG_UST_CTL */
698 #endif /* _LTT_UST_APP_H */