2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
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/uuid.h>
16 #include "trace-ust.h"
17 #include "ust-registry.h"
20 #define UST_APP_EVENT_LIST_SIZE 32
22 /* Process name (short). */
23 #define UST_APP_PROCNAME_LEN 16
25 struct lttng_filter_bytecode
;
26 struct lttng_ust_filter_bytecode
;
28 extern int ust_consumerd64_fd
, ust_consumerd32_fd
;
31 * Object used to close the notify socket in a call_rcu(). Since the
32 * application might not be found, we need an independant object containing the
35 struct ust_app_notify_sock_obj
{
40 struct ust_app_ht_key
{
42 const struct lttng_filter_bytecode
*filter
;
43 enum lttng_ust_loglevel_type loglevel_type
;
44 const struct lttng_event_exclusion
*exclusion
;
48 * Application registration data structure.
50 struct ust_register_msg
{
51 enum ustctl_socket_type type
;
60 uint32_t bits_per_long
;
61 uint32_t uint8_t_alignment
;
62 uint32_t uint16_t_alignment
;
63 uint32_t uint32_t_alignment
;
64 uint32_t uint64_t_alignment
;
65 uint32_t long_alignment
;
66 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
67 char name
[LTTNG_UST_ABI_PROCNAME_LEN
];
71 * Global applications HT used by the session daemon. This table is indexed by
72 * PID using the pid_n node and pid value of an ust_app.
74 extern struct lttng_ht
*ust_app_ht
;
77 * Global applications HT used by the session daemon. This table is indexed by
78 * socket using the sock_n node and sock value of an ust_app.
80 * The 'sock' in question here is the 'command' socket.
82 extern struct lttng_ht
*ust_app_ht_by_sock
;
85 * Global applications HT used by the session daemon. This table is indexed by
86 * socket using the notify_sock_n node and notify_sock value of an ust_app.
88 extern struct lttng_ht
*ust_app_ht_by_notify_sock
;
90 /* Stream list containing ust_app_stream. */
91 struct ust_app_stream_list
{
93 struct cds_list_head head
;
98 struct lttng_ust_context_attr ctx
;
99 struct lttng_ust_object_data
*obj
;
100 struct lttng_ht_node_ulong node
;
101 struct cds_list_head list
;
104 struct ust_app_event
{
107 struct lttng_ust_object_data
*obj
;
108 struct lttng_ust_event attr
;
109 char name
[LTTNG_UST_SYM_NAME_LEN
];
110 struct lttng_ht_node_str node
;
111 struct lttng_filter_bytecode
*filter
;
112 struct lttng_event_exclusion
*exclusion
;
115 struct ust_app_token_event_rule
{
118 struct lttng_ust_object_data
*obj
;
119 struct lttng_event_rule
*event_rule
;
121 struct lttng_ht_node_u64 node
;
122 /* The event_rule object own this pointer */
123 const struct lttng_filter_bytecode
*filter
;
124 /* The event_rule object own this pointer */
125 struct lttng_event_exclusion
*exclusion
;
128 struct ust_app_stream
{
130 char pathname
[PATH_MAX
];
131 /* Format is %s_%d respectively channel name and CPU number. */
132 char name
[DEFAULT_STREAM_NAME_LEN
];
133 struct lttng_ust_object_data
*obj
;
134 /* Using a list of streams to keep order. */
135 struct cds_list_head list
;
138 struct ust_app_channel
{
141 /* Channel and streams were sent to the UST tracer. */
144 * Unique key used to identify the channel on the consumer side.
145 * 0 is a reserved 'invalid' value used to indicate that the consumer
146 * does not know about this channel (i.e. an error occurred).
149 /* Id of the tracing channel set on creation. */
150 uint64_t tracing_channel_id
;
151 /* Number of stream that this channel is expected to receive. */
152 unsigned int expected_stream_count
;
153 char name
[LTTNG_UST_SYM_NAME_LEN
];
154 struct lttng_ust_object_data
*obj
;
155 struct ustctl_consumer_channel_attr attr
;
156 struct ust_app_stream_list streams
;
157 /* Session pointer that owns this object. */
158 struct ust_app_session
*session
;
160 * Contexts are kept in a hash table for fast lookup and in an ordered list
161 * so we are able to enable them on the tracer side in the same order the
164 struct lttng_ht
*ctx
;
165 struct cds_list_head ctx_list
;
167 struct lttng_ht
*events
;
168 uint64_t tracefile_size
;
169 uint64_t tracefile_count
;
170 uint64_t monitor_timer_interval
;
172 * Node indexed by channel name in the channels' hash table of a session.
174 struct lttng_ht_node_str node
;
176 * Node indexed by UST channel object descriptor (handle). Stored in the
177 * ust_objd hash table in the ust_app object.
179 struct lttng_ht_node_ulong ust_objd_node
;
180 /* For delayed reclaim */
181 struct rcu_head rcu_head
;
184 struct ust_app_session
{
186 * Lock protecting this session's ust app interaction. Held
187 * across command send/recv to/from app. Never nests within the
188 * session registry lock.
190 pthread_mutex_t lock
;
193 /* started: has the session been in started state at any time ? */
194 int started
; /* allows detection of start vs restart. */
195 int handle
; /* used has unique identifier for app session */
197 bool deleted
; /* Session deleted flag. Check with lock held. */
200 * Tracing session ID. Multiple ust app session can have the same tracing
201 * session id making this value NOT unique to the object.
204 uint64_t id
; /* Unique session identifier */
205 struct lttng_ht
*channels
; /* Registered channels */
206 struct lttng_ht_node_u64 node
;
208 * Node indexed by UST session object descriptor (handle). Stored in the
209 * ust_sessions_objd hash table in the ust_app object.
211 struct lttng_ht_node_ulong ust_objd_node
;
212 /* Starts with 'ust'; no leading slash. */
214 /* UID/GID of the application owning the session */
215 struct lttng_credentials real_credentials
;
216 /* Effective UID and GID. Same as the tracing session. */
217 struct lttng_credentials effective_credentials
;
218 struct cds_list_head teardown_node
;
220 * Once at least *one* session is created onto the application, the
221 * corresponding consumer is set so we can use it on unregistration.
223 struct consumer_output
*consumer
;
224 enum lttng_buffer_type buffer_type
;
225 /* ABI of the session. Same value as the application. */
226 uint32_t bits_per_long
;
227 /* For delayed reclaim */
228 struct rcu_head rcu_head
;
229 /* If the channel's streams have to be outputed or not. */
230 unsigned int output_traces
;
231 unsigned int live_timer_interval
; /* usec */
233 /* Metadata channel attributes. */
234 struct ustctl_consumer_channel_attr metadata_attr
;
236 char root_shm_path
[PATH_MAX
];
237 char shm_path
[PATH_MAX
];
241 * Registered traceable applications. Libust registers to the session daemon
242 * and a linked list is kept of all running traceable app.
246 pthread_mutex_t sock_lock
; /* Protects sock protocol. */
251 uid_t uid
; /* User ID that owns the apps */
252 gid_t gid
; /* Group ID that owns the apps */
255 uint32_t bits_per_long
;
256 uint32_t uint8_t_alignment
;
257 uint32_t uint16_t_alignment
;
258 uint32_t uint32_t_alignment
;
259 uint32_t uint64_t_alignment
;
260 uint32_t long_alignment
;
261 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
263 int compatible
; /* If the lttng-ust tracer version does not match the
264 supported version of the session daemon, this flag is
265 set to 0 (NOT compatible) else 1. */
266 struct lttng_ust_tracer_version version
;
267 uint32_t v_major
; /* Version major number */
268 uint32_t v_minor
; /* Version minor number */
269 /* Extra for the NULL byte. */
270 char name
[UST_APP_PROCNAME_LEN
+ 1];
271 /* Type of buffer this application uses. */
272 enum lttng_buffer_type buffer_type
;
273 struct lttng_ht
*sessions
;
274 struct lttng_ht_node_ulong pid_n
;
275 struct lttng_ht_node_ulong sock_n
;
276 struct lttng_ht_node_ulong notify_sock_n
;
278 * This is a list of ust app session that, once the app is going into
279 * teardown mode, in the RCU call, each node in this list is removed and
282 * Element of the list are added when an application unregisters after each
283 * ht_del of ust_app_session associated to this app. This list is NOT used
284 * when a session is destroyed.
286 struct cds_list_head teardown_head
;
288 * Hash table containing ust_app_channel indexed by channel objd.
290 struct lttng_ht
*ust_objd
;
292 * Hash table containing ust_app_session indexed by objd.
294 struct lttng_ht
*ust_sessions_objd
;
297 * If this application is of the agent domain and this is non negative then
298 * a lookup MUST be done to acquire a read side reference to the
299 * corresponding agent app object. If the lookup fails, this should be set
300 * to a negative value indicating that the agent application is gone.
304 * Time at which the app is registred.
305 * Used for path creation
307 time_t registration_time
;
312 struct lttng_ust_object_data
*handle
;
313 struct lttng_pipe
*trigger_event_pipe
;
314 } token_communication
;
315 struct lttng_ht
*tokens_ht
;
318 #ifdef HAVE_LIBLTTNG_UST_CTL
320 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
321 int ust_app_register_done(struct ust_app
*app
);
322 int ust_app_version(struct ust_app
*app
);
323 void ust_app_unregister(int sock
);
324 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
325 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
326 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
327 int ust_app_list_events(struct lttng_event
**events
);
328 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
329 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
330 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
331 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
332 struct ltt_ust_channel
*uchan
);
333 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
334 struct ltt_ust_channel
*uchan
);
335 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
336 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
337 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
338 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
339 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
340 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
341 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
);
342 void ust_app_global_update_all(struct ltt_ust_session
*usess
);
343 void ust_app_global_update_tokens(struct ust_app
*app
);
344 void ust_app_global_update_all_tokens(void);
346 void ust_app_clean_list(void);
347 int ust_app_ht_alloc(void);
348 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
349 struct ust_app_stream
*ust_app_alloc_stream(void);
350 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
);
351 int ust_app_recv_notify(int sock
);
352 void ust_app_add(struct ust_app
*app
);
353 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
);
354 void ust_app_notify_sock_unregister(int sock
);
355 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
356 struct consumer_socket
*socket
, int send_zero_data
);
357 void ust_app_destroy(struct ust_app
*app
);
358 enum lttng_error_code
ust_app_snapshot_record(
359 const struct ltt_ust_session
*usess
,
360 const struct consumer_output
*output
, int wait
,
361 uint64_t nb_packets_per_stream
);
362 uint64_t ust_app_get_size_one_more_packet_per_stream(
363 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
);
364 struct ust_app
*ust_app_find_by_sock(int sock
);
365 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
366 struct cds_list_head
*buffer_reg_uid_list
,
367 struct consumer_output
*consumer
, uint64_t uchan_id
,
368 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
369 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
370 struct ltt_ust_channel
*uchan
,
371 struct consumer_output
*consumer
,
372 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
373 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
);
374 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
);
375 enum lttng_error_code
ust_app_create_channel_subdirectories(
376 const struct ltt_ust_session
*session
);
377 int ust_app_release_object(struct ust_app
*app
,
378 struct lttng_ust_object_data
*data
);
379 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
);
381 int ust_app_setup_trigger_group(struct ust_app
*app
);
384 int ust_app_supported(void)
389 #else /* HAVE_LIBLTTNG_UST_CTL */
392 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
397 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
402 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
407 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
412 int ust_app_list_events(struct lttng_event
**events
)
417 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
422 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
427 int ust_app_register_done(struct ust_app
*app
)
432 int ust_app_version(struct ust_app
*app
)
437 void ust_app_unregister(int sock
)
441 void ust_app_lock_list(void)
445 void ust_app_unlock_list(void)
449 void ust_app_clean_list(void)
453 struct ust_app_list
*ust_app_get_list(void)
458 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
463 int ust_app_ht_alloc(void)
468 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
471 void ust_app_global_update_tokens(struct ust_app
*app
)
474 void ust_app_global_update_all_tokens(void)
477 int ust_app_setup_trigger_group(struct ust_app
*app
)
482 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
483 struct ltt_ust_channel
*uchan
)
488 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
489 struct ltt_ust_channel
*uchan
)
494 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
495 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
500 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
501 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
506 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
507 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
512 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
513 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
518 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
519 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
525 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
530 int ust_app_recv_notify(int sock
)
535 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
540 void ust_app_add(struct ust_app
*app
)
544 void ust_app_notify_sock_unregister(int sock
)
548 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
549 struct consumer_socket
*socket
, int send_zero_data
)
554 void ust_app_destroy(struct ust_app
*app
)
559 enum lttng_error_code
ust_app_snapshot_record(struct ltt_ust_session
*usess
,
560 const struct consumer_output
*output
, int wait
, uint64_t max_stream_size
)
565 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
571 int ust_app_supported(void)
576 struct ust_app
*ust_app_find_by_sock(int sock
)
581 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
586 uint64_t ust_app_get_size_one_more_packet_per_stream(
587 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
) {
591 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
592 struct cds_list_head
*buffer_reg_uid_list
,
593 struct consumer_output
*consumer
, int overwrite
,
594 uint64_t uchan_id
, uint64_t *discarded
, uint64_t *lost
)
600 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
601 struct ltt_ust_channel
*uchan
,
602 struct consumer_output
*consumer
,
603 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
609 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
615 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
621 enum lttng_error_code
ust_app_create_channel_subdirectories(
622 const struct ltt_ust_session
*session
)
628 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
634 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
639 #endif /* HAVE_LIBLTTNG_UST_CTL */
641 #endif /* _LTT_UST_APP_H */