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
14 #include <common/index-allocator.h>
15 #include <common/uuid.h>
17 #include "trace-ust.h"
18 #include "ust-registry.h"
21 #define UST_APP_EVENT_LIST_SIZE 32
23 /* Process name (short). */
24 #define UST_APP_PROCNAME_LEN 16
26 struct lttng_bytecode
;
27 struct lttng_ust_filter_bytecode
;
29 extern int the_ust_consumerd64_fd
, the_ust_consumerd32_fd
;
32 * Object used to close the notify socket in a call_rcu(). Since the
33 * application might not be found, we need an independant object containing the
36 struct ust_app_notify_sock_obj
{
41 struct ust_app_ht_key
{
43 const struct lttng_bytecode
*filter
;
44 enum lttng_ust_abi_loglevel_type loglevel_type
;
46 const struct lttng_event_exclusion
*exclusion
;
50 * Application registration data structure.
52 struct ust_register_msg
{
53 enum lttng_ust_ctl_socket_type type
;
62 uint32_t bits_per_long
;
63 uint32_t uint8_t_alignment
;
64 uint32_t uint16_t_alignment
;
65 uint32_t uint32_t_alignment
;
66 uint32_t uint64_t_alignment
;
67 uint32_t long_alignment
;
68 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
69 char name
[LTTNG_UST_ABI_PROCNAME_LEN
];
73 * Global applications HT used by the session daemon. This table is indexed by
74 * PID using the pid_n node and pid value of an ust_app.
76 extern struct lttng_ht
*ust_app_ht
;
79 * Global applications HT used by the session daemon. This table is indexed by
80 * socket using the sock_n node and sock value of an ust_app.
82 * The 'sock' in question here is the 'command' socket.
84 extern struct lttng_ht
*ust_app_ht_by_sock
;
87 * Global applications HT used by the session daemon. This table is indexed by
88 * socket using the notify_sock_n node and notify_sock value of an ust_app.
90 extern struct lttng_ht
*ust_app_ht_by_notify_sock
;
92 /* Stream list containing ust_app_stream. */
93 struct ust_app_stream_list
{
95 struct cds_list_head head
;
100 struct lttng_ust_context_attr ctx
;
101 struct lttng_ust_abi_object_data
*obj
;
102 struct lttng_ht_node_ulong node
;
103 struct cds_list_head list
;
106 struct ust_app_event
{
109 struct lttng_ust_abi_object_data
*obj
;
110 struct lttng_ust_abi_event attr
;
111 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
112 struct lttng_ht_node_str node
;
113 struct lttng_bytecode
*filter
;
114 struct lttng_event_exclusion
*exclusion
;
117 struct ust_app_event_notifier_rule
{
119 uint64_t error_counter_index
;
121 struct lttng_ust_abi_object_data
*obj
;
122 /* Holds a strong reference. */
123 struct lttng_trigger
*trigger
;
124 /* Unique ID returned by the tracer to identify this event notifier. */
126 struct lttng_ht_node_u64 node
;
127 /* The trigger object owns the filter. */
128 const struct lttng_bytecode
*filter
;
130 struct lttng_event_exclusion
*exclusion
;
131 /* For delayed reclaim. */
132 struct rcu_head rcu_head
;
135 struct ust_app_stream
{
137 char pathname
[PATH_MAX
];
138 /* Format is %s_%d respectively channel name and CPU number. */
139 char name
[DEFAULT_STREAM_NAME_LEN
];
140 struct lttng_ust_abi_object_data
*obj
;
141 /* Using a list of streams to keep order. */
142 struct cds_list_head list
;
145 struct ust_app_channel
{
148 /* Channel and streams were sent to the UST tracer. */
151 * Unique key used to identify the channel on the consumer side.
152 * 0 is a reserved 'invalid' value used to indicate that the consumer
153 * does not know about this channel (i.e. an error occurred).
156 /* Id of the tracing channel set on creation. */
157 uint64_t tracing_channel_id
;
158 /* Number of stream that this channel is expected to receive. */
159 unsigned int expected_stream_count
;
160 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
161 struct lttng_ust_abi_object_data
*obj
;
162 struct lttng_ust_ctl_consumer_channel_attr attr
;
163 struct ust_app_stream_list streams
;
164 /* Session pointer that owns this object. */
165 struct ust_app_session
*session
;
167 * Contexts are kept in a hash table for fast lookup and in an ordered list
168 * so we are able to enable them on the tracer side in the same order the
171 struct lttng_ht
*ctx
;
172 struct cds_list_head ctx_list
;
174 struct lttng_ht
*events
;
175 uint64_t tracefile_size
;
176 uint64_t tracefile_count
;
177 uint64_t monitor_timer_interval
;
179 * Node indexed by channel name in the channels' hash table of a session.
181 struct lttng_ht_node_str node
;
183 * Node indexed by UST channel object descriptor (handle). Stored in the
184 * ust_objd hash table in the ust_app object.
186 struct lttng_ht_node_ulong ust_objd_node
;
187 /* For delayed reclaim */
188 struct rcu_head rcu_head
;
191 struct ust_app_session
{
193 * Lock protecting this session's ust app interaction. Held
194 * across command send/recv to/from app. Never nests within the
195 * session registry lock.
197 pthread_mutex_t lock
;
200 /* started: has the session been in started state at any time ? */
201 int started
; /* allows detection of start vs restart. */
202 int handle
; /* used has unique identifier for app session */
204 bool deleted
; /* Session deleted flag. Check with lock held. */
207 * Tracing session ID. Multiple ust app session can have the same tracing
208 * session id making this value NOT unique to the object.
211 uint64_t id
; /* Unique session identifier */
212 struct lttng_ht
*channels
; /* Registered channels */
213 struct lttng_ht_node_u64 node
;
215 * Node indexed by UST session object descriptor (handle). Stored in the
216 * ust_sessions_objd hash table in the ust_app object.
218 struct lttng_ht_node_ulong ust_objd_node
;
219 /* Starts with 'ust'; no leading slash. */
221 /* UID/GID of the application owning the session */
222 struct lttng_credentials real_credentials
;
223 /* Effective UID and GID. Same as the tracing session. */
224 struct lttng_credentials effective_credentials
;
225 struct cds_list_head teardown_node
;
227 * Once at least *one* session is created onto the application, the
228 * corresponding consumer is set so we can use it on unregistration.
230 struct consumer_output
*consumer
;
231 enum lttng_buffer_type buffer_type
;
232 /* ABI of the session. Same value as the application. */
233 uint32_t bits_per_long
;
234 /* For delayed reclaim */
235 struct rcu_head rcu_head
;
236 /* If the channel's streams have to be outputed or not. */
237 unsigned int output_traces
;
238 unsigned int live_timer_interval
; /* usec */
240 /* Metadata channel attributes. */
241 struct lttng_ust_ctl_consumer_channel_attr metadata_attr
;
243 char root_shm_path
[PATH_MAX
];
244 char shm_path
[PATH_MAX
];
248 * Registered traceable applications. Libust registers to the session daemon
249 * and a linked list is kept of all running traceable app.
253 pthread_mutex_t sock_lock
; /* Protects sock protocol. */
258 uid_t uid
; /* User ID that owns the apps */
259 gid_t gid
; /* Group ID that owns the apps */
262 uint32_t bits_per_long
;
263 uint32_t uint8_t_alignment
;
264 uint32_t uint16_t_alignment
;
265 uint32_t uint32_t_alignment
;
266 uint32_t uint64_t_alignment
;
267 uint32_t long_alignment
;
268 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
270 int compatible
; /* If the lttng-ust tracer version does not match the
271 supported version of the session daemon, this flag is
272 set to 0 (NOT compatible) else 1. */
273 struct lttng_ust_abi_tracer_version version
;
274 uint32_t v_major
; /* Version major number */
275 uint32_t v_minor
; /* Version minor number */
276 /* Extra for the NULL byte. */
277 char name
[UST_APP_PROCNAME_LEN
+ 1];
278 /* Type of buffer this application uses. */
279 enum lttng_buffer_type buffer_type
;
280 struct lttng_ht
*sessions
;
281 struct lttng_ht_node_ulong pid_n
;
282 struct lttng_ht_node_ulong sock_n
;
283 struct lttng_ht_node_ulong notify_sock_n
;
285 * This is a list of ust app session that, once the app is going into
286 * teardown mode, in the RCU call, each node in this list is removed and
289 * Element of the list are added when an application unregisters after each
290 * ht_del of ust_app_session associated to this app. This list is NOT used
291 * when a session is destroyed.
293 struct cds_list_head teardown_head
;
295 * Hash table containing ust_app_channel indexed by channel objd.
297 struct lttng_ht
*ust_objd
;
299 * Hash table containing ust_app_session indexed by objd.
301 struct lttng_ht
*ust_sessions_objd
;
304 * If this application is of the agent domain and this is non negative then
305 * a lookup MUST be done to acquire a read side reference to the
306 * corresponding agent app object. If the lookup fails, this should be set
307 * to a negative value indicating that the agent application is gone.
311 * Time at which the app is registred.
312 * Used for path creation
314 time_t registration_time
;
320 * Handle to the lttng_ust object representing the event
323 struct lttng_ust_abi_object_data
*object
;
324 struct lttng_pipe
*event_pipe
;
325 struct lttng_ust_abi_object_data
*counter
;
326 struct lttng_ust_abi_object_data
**counter_cpu
;
328 } event_notifier_group
;
330 * Hashtable indexing the application's event notifier rule's
331 * (ust_app_event_notifier_rule) by their token's value.
333 struct lttng_ht
*token_to_event_notifier_rule_ht
;
336 #ifdef HAVE_LIBLTTNG_UST_CTL
338 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
339 int ust_app_register_done(struct ust_app
*app
);
340 int ust_app_version(struct ust_app
*app
);
341 void ust_app_unregister(int sock
);
342 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
343 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
344 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
345 int ust_app_list_events(struct lttng_event
**events
);
346 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
347 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
348 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
349 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
350 struct ltt_ust_channel
*uchan
);
351 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
352 struct ltt_ust_channel
*uchan
);
353 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
354 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
355 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
356 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
357 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
358 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
359 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
);
360 void ust_app_global_update_all(struct ltt_ust_session
*usess
);
361 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
);
362 void ust_app_global_update_all_event_notifier_rules(void);
364 void ust_app_clean_list(void);
365 int ust_app_ht_alloc(void);
366 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
367 struct ust_app_stream
*ust_app_alloc_stream(void);
368 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
);
369 int ust_app_recv_notify(int sock
);
370 void ust_app_add(struct ust_app
*app
);
371 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
);
372 void ust_app_notify_sock_unregister(int sock
);
373 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
374 struct consumer_socket
*socket
, int send_zero_data
);
375 void ust_app_destroy(struct ust_app
*app
);
376 enum lttng_error_code
ust_app_snapshot_record(
377 const struct ltt_ust_session
*usess
,
378 const struct consumer_output
*output
, int wait
,
379 uint64_t nb_packets_per_stream
);
380 uint64_t ust_app_get_size_one_more_packet_per_stream(
381 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
);
382 struct ust_app
*ust_app_find_by_sock(int sock
);
383 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
384 struct cds_list_head
*buffer_reg_uid_list
,
385 struct consumer_output
*consumer
, uint64_t uchan_id
,
386 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
387 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
388 struct ltt_ust_channel
*uchan
,
389 struct consumer_output
*consumer
,
390 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
391 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
);
392 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
);
393 enum lttng_error_code
ust_app_create_channel_subdirectories(
394 const struct ltt_ust_session
*session
);
395 int ust_app_release_object(struct ust_app
*app
,
396 struct lttng_ust_abi_object_data
*data
);
397 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
);
398 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
);
400 int ust_app_setup_event_notifier_group(struct ust_app
*app
);
403 int ust_app_supported(void)
408 bool ust_app_supports_notifiers(const struct ust_app
*app
);
409 bool ust_app_supports_counters(const struct ust_app
*app
);
411 #else /* HAVE_LIBLTTNG_UST_CTL */
414 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
419 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
424 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
429 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
434 int ust_app_list_events(struct lttng_event
**events
)
439 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
444 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
449 int ust_app_register_done(struct ust_app
*app
)
454 int ust_app_version(struct ust_app
*app
)
459 void ust_app_unregister(int sock
)
463 void ust_app_lock_list(void)
467 void ust_app_unlock_list(void)
471 void ust_app_clean_list(void)
475 struct ust_app_list
*ust_app_get_list(void)
480 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
485 int ust_app_ht_alloc(void)
490 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
493 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
496 void ust_app_global_update_all_event_notifier_rules(void)
499 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
504 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
505 struct ltt_ust_channel
*uchan
)
510 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
511 struct ltt_ust_channel
*uchan
)
516 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
517 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
522 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
523 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
528 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
529 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
534 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
535 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
540 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
541 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
547 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
552 int ust_app_recv_notify(int sock
)
557 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
562 void ust_app_add(struct ust_app
*app
)
566 void ust_app_notify_sock_unregister(int sock
)
570 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
571 struct consumer_socket
*socket
, int send_zero_data
)
576 void ust_app_destroy(struct ust_app
*app
)
581 enum lttng_error_code
ust_app_snapshot_record(struct ltt_ust_session
*usess
,
582 const struct consumer_output
*output
, int wait
, uint64_t max_stream_size
)
587 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
592 void ust_app_update_event_notifier_error_count(
593 struct lttng_trigger
*lttng_trigger
)
598 int ust_app_supported(void)
603 bool ust_app_supports_notifiers(const struct ust_app
*app
)
608 bool ust_app_supports_counters(const struct ust_app
*app
)
613 struct ust_app
*ust_app_find_by_sock(int sock
)
618 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
623 uint64_t ust_app_get_size_one_more_packet_per_stream(
624 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
) {
628 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
629 struct cds_list_head
*buffer_reg_uid_list
,
630 struct consumer_output
*consumer
, int overwrite
,
631 uint64_t uchan_id
, uint64_t *discarded
, uint64_t *lost
)
637 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
638 struct ltt_ust_channel
*uchan
,
639 struct consumer_output
*consumer
,
640 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
646 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
652 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
658 enum lttng_error_code
ust_app_create_channel_subdirectories(
659 const struct ltt_ust_session
*session
)
665 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*data
)
671 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
677 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
682 #endif /* HAVE_LIBLTTNG_UST_CTL */
684 #endif /* _LTT_UST_APP_H */