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.hpp>
15 #include <common/format.hpp>
16 #include <common/uuid.hpp>
18 #include "trace-ust.hpp"
19 #include "ust-registry.hpp"
20 #include "session.hpp"
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;
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 {
149 * Unique key used to identify the channel on the consumer side.
150 * 0 is a reserved 'invalid' value used to indicate that the consumer
151 * does not know about this channel (i.e. an error occurred).
154 /* Id of the tracing channel set on creation. */
155 uint64_t tracing_channel_id;
156 /* Number of stream that this channel is expected to receive. */
157 unsigned int expected_stream_count;
158 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
159 struct lttng_ust_abi_object_data *obj;
160 struct lttng_ust_ctl_consumer_channel_attr attr;
161 struct ust_app_stream_list streams;
162 /* Session pointer that owns this object. */
163 struct ust_app_session *session;
165 * Contexts are kept in a hash table for fast lookup and in an ordered list
166 * so we are able to enable them on the tracer side in the same order the
169 struct lttng_ht *ctx;
170 struct cds_list_head ctx_list;
172 struct lttng_ht *events;
173 uint64_t tracefile_size;
174 uint64_t tracefile_count;
175 uint64_t monitor_timer_interval;
177 * Node indexed by channel name in the channels' hash table of a session.
179 struct lttng_ht_node_str node;
181 * Node indexed by UST channel object descriptor (handle). Stored in the
182 * ust_objd hash table in the ust_app object.
184 struct lttng_ht_node_ulong ust_objd_node;
185 /* For delayed reclaim */
186 struct rcu_head rcu_head;
189 struct ust_app_session {
191 * Lock protecting this session's ust app interaction. Held
192 * across command send/recv to/from app. Never nests within the
193 * session registry lock.
195 pthread_mutex_t lock;
198 /* started: has the session been in started state at any time ? */
199 int started; /* allows detection of start vs restart. */
200 int handle; /* used has unique identifier for app session */
202 bool deleted; /* Session deleted flag. Check with lock held. */
205 * Tracing session ID. Multiple ust app session can have the same tracing
206 * session id making this value NOT unique to the object.
209 uint64_t id; /* Unique session identifier */
210 struct lttng_ht *channels; /* Registered channels */
211 struct lttng_ht_node_u64 node;
213 * Node indexed by UST session object descriptor (handle). Stored in the
214 * ust_sessions_objd hash table in the ust_app object.
216 struct lttng_ht_node_ulong ust_objd_node;
217 /* Starts with 'ust'; no leading slash. */
219 /* UID/GID of the application owning the session */
220 struct lttng_credentials real_credentials;
221 /* Effective UID and GID. Same as the tracing session. */
222 struct lttng_credentials effective_credentials;
223 struct cds_list_head teardown_node;
225 * Once at least *one* session is created onto the application, the
226 * corresponding consumer is set so we can use it on unregistration.
228 struct consumer_output *consumer;
229 enum lttng_buffer_type buffer_type;
230 /* ABI of the session. Same value as the application. */
231 uint32_t bits_per_long;
232 /* For delayed reclaim */
233 struct rcu_head rcu_head;
234 /* If the channel's streams have to be outputed or not. */
235 unsigned int output_traces;
236 unsigned int live_timer_interval; /* usec */
238 /* Metadata channel attributes. */
239 struct lttng_ust_ctl_consumer_channel_attr metadata_attr;
241 char root_shm_path[PATH_MAX];
242 char shm_path[PATH_MAX];
246 * Registered traceable applications. Libust registers to the session daemon
247 * and a linked list is kept of all running traceable app.
251 pthread_mutex_t sock_lock; /* Protects sock protocol. */
256 uid_t uid; /* User ID that owns the apps */
257 gid_t gid; /* Group ID that owns the apps */
260 lttng::sessiond::trace::abi abi;
262 int compatible; /* If the lttng-ust tracer version does not match the
263 supported version of the session daemon, this flag is
264 set to 0 (NOT compatible) else 1. */
265 struct lttng_ust_abi_tracer_version version;
266 uint32_t v_major; /* Version major number */
267 uint32_t v_minor; /* Version minor number */
268 /* Extra for the NULL byte. */
269 char name[UST_APP_PROCNAME_LEN + 1];
270 /* Type of buffer this application uses. */
271 enum lttng_buffer_type buffer_type;
272 struct lttng_ht *sessions;
273 struct lttng_ht_node_ulong pid_n;
274 struct lttng_ht_node_ulong sock_n;
275 struct lttng_ht_node_ulong notify_sock_n;
277 * This is a list of ust app session that, once the app is going into
278 * teardown mode, in the RCU call, each node in this list is removed and
281 * Element of the list are added when an application unregisters after each
282 * ht_del of ust_app_session associated to this app. This list is NOT used
283 * when a session is destroyed.
285 struct cds_list_head teardown_head;
287 * Hash table containing ust_app_channel indexed by channel objd.
289 struct lttng_ht *ust_objd;
291 * Hash table containing ust_app_session indexed by objd.
293 struct lttng_ht *ust_sessions_objd;
296 * If this application is of the agent domain and this is non negative then
297 * a lookup MUST be done to acquire a read side reference to the
298 * corresponding agent app object. If the lookup fails, this should be set
299 * to a negative value indicating that the agent application is gone.
303 * Time at which the app is registred.
304 * Used for path creation
306 time_t registration_time;
312 * Handle to the lttng_ust object representing the event
315 struct lttng_ust_abi_object_data *object;
316 struct lttng_pipe *event_pipe;
317 struct lttng_ust_abi_object_data *counter;
318 struct lttng_ust_abi_object_data **counter_cpu;
320 } event_notifier_group;
322 * Hashtable indexing the application's event notifier rule's
323 * (ust_app_event_notifier_rule) by their token's value.
325 struct lttng_ht *token_to_event_notifier_rule_ht;
329 struct fmt::formatter<ust_app> : fmt::formatter<std::string> {
330 template <typename FormatCtx>
331 typename FormatCtx::iterator format(const ust_app& app, FormatCtx& ctx)
333 return fmt::format_to(ctx.out(),
334 "{{ procname = `{}`, ppid = {}, pid = {}, uid = {}, gid = {}, version = {}.{}, registration time = {} }}",
335 app.name, app.ppid, app.pid, app.uid, app.gid, app.v_major,
337 lttng::utils::time_to_iso8601_str(app.registration_time));
342 #ifdef HAVE_LIBLTTNG_UST_CTL
344 int ust_app_register(struct ust_register_msg *msg, int sock);
345 int ust_app_register_done(struct ust_app *app);
346 int ust_app_version(struct ust_app *app);
347 void ust_app_unregister(int sock);
348 int ust_app_start_trace_all(struct ltt_ust_session *usess);
349 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
350 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
351 int ust_app_list_events(struct lttng_event **events);
352 int ust_app_list_event_fields(struct lttng_event_field **fields);
353 int ust_app_create_event_glb(struct ltt_ust_session *usess,
354 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
355 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
356 struct ltt_ust_channel *uchan);
357 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
358 struct ltt_ust_channel *uchan);
359 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
360 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
361 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
362 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
363 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
364 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
365 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
366 void ust_app_global_update_all(struct ltt_ust_session *usess);
367 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
368 void ust_app_global_update_all_event_notifier_rules(void);
370 void ust_app_clean_list(void);
371 int ust_app_ht_alloc(void);
372 struct ust_app *ust_app_find_by_pid(pid_t pid);
373 struct ust_app_stream *ust_app_alloc_stream(void);
374 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
375 int ust_app_recv_notify(int sock);
376 void ust_app_add(struct ust_app *app);
377 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
378 void ust_app_notify_sock_unregister(int sock);
379 ssize_t ust_app_push_metadata(const ust_registry_session::locked_ptr& registry,
380 struct consumer_socket *socket,
382 void ust_app_destroy(struct ust_app *app);
383 enum lttng_error_code ust_app_snapshot_record(
384 const struct ltt_ust_session *usess,
385 const struct consumer_output *output,
386 uint64_t nb_packets_per_stream);
387 uint64_t ust_app_get_size_one_more_packet_per_stream(
388 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
389 struct ust_app *ust_app_find_by_sock(int sock);
390 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
391 struct cds_list_head *buffer_reg_uid_list,
392 struct consumer_output *consumer, uint64_t uchan_id,
393 int overwrite, uint64_t *discarded, uint64_t *lost);
394 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
395 struct ltt_ust_channel *uchan,
396 struct consumer_output *consumer,
397 int overwrite, uint64_t *discarded, uint64_t *lost);
398 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
399 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
400 enum lttng_error_code ust_app_create_channel_subdirectories(
401 const struct ltt_ust_session *session);
402 int ust_app_release_object(struct ust_app *app,
403 struct lttng_ust_abi_object_data *data);
404 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
405 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
407 int ust_app_setup_event_notifier_group(struct ust_app *app);
410 int ust_app_supported(void)
415 bool ust_app_supports_notifiers(const struct ust_app *app);
416 bool ust_app_supports_counters(const struct ust_app *app);
418 #else /* HAVE_LIBLTTNG_UST_CTL */
421 int ust_app_destroy_trace_all(
422 struct ltt_ust_session *usess __attribute__((unused)))
428 int ust_app_start_trace(
429 struct ltt_ust_session *usess __attribute__((unused)),
430 struct ust_app *app __attribute__((unused)))
436 int ust_app_start_trace_all(
437 struct ltt_ust_session *usess __attribute__((unused)))
443 int ust_app_stop_trace_all(
444 struct ltt_ust_session *usess __attribute__((unused)))
450 int ust_app_list_events(
451 struct lttng_event **events __attribute__((unused)))
457 int ust_app_list_event_fields(
458 struct lttng_event_field **fields __attribute__((unused)))
464 int ust_app_register(
465 struct ust_register_msg *msg __attribute__((unused)),
466 int sock __attribute__((unused)))
472 int ust_app_register_done(struct ust_app *app __attribute__((unused)))
478 int ust_app_version(struct ust_app *app __attribute__((unused)))
484 void ust_app_unregister(int sock __attribute__((unused)))
489 void ust_app_clean_list(void)
494 struct ust_app_list *ust_app_get_list(void)
500 struct ust_app *ust_app_get_by_pid(pid_t pid __attribute__((unused)))
506 int ust_app_ht_alloc(void)
512 void ust_app_global_update(
513 struct ltt_ust_session *usess __attribute__((unused)),
514 struct ust_app *app __attribute__((unused)))
518 void ust_app_global_update_event_notifier_rules(
519 struct ust_app *app __attribute__((unused)))
523 void ust_app_global_update_all_event_notifier_rules(void)
527 int ust_app_setup_event_notifier_group(
528 struct ust_app *app __attribute__((unused)))
534 int ust_app_disable_channel_glb(
535 struct ltt_ust_session *usess __attribute__((unused)),
536 struct ltt_ust_channel *uchan __attribute__((unused)))
542 int ust_app_enable_channel_glb(
543 struct ltt_ust_session *usess __attribute__((unused)),
544 struct ltt_ust_channel *uchan __attribute__((unused)))
550 int ust_app_create_event_glb(
551 struct ltt_ust_session *usess __attribute__((unused)),
552 struct ltt_ust_channel *uchan __attribute__((unused)),
553 struct ltt_ust_event *uevent __attribute__((unused)))
559 int ust_app_disable_event_glb(
560 struct ltt_ust_session *usess __attribute__((unused)),
561 struct ltt_ust_channel *uchan __attribute__((unused)),
562 struct ltt_ust_event *uevent __attribute__((unused)))
568 int ust_app_enable_event_glb(
569 struct ltt_ust_session *usess __attribute__((unused)),
570 struct ltt_ust_channel *uchan __attribute__((unused)),
571 struct ltt_ust_event *uevent __attribute__((unused)))
577 int ust_app_add_ctx_channel_glb(
578 struct ltt_ust_session *usess __attribute__((unused)),
579 struct ltt_ust_channel *uchan __attribute__((unused)),
580 struct ltt_ust_context *uctx __attribute__((unused)))
586 int ust_app_enable_event_pid(
587 struct ltt_ust_session *usess __attribute__((unused)),
588 struct ltt_ust_channel *uchan __attribute__((unused)),
589 struct ltt_ust_event *uevent __attribute__((unused)),
590 pid_t pid __attribute__((unused)))
596 int ust_app_recv_registration(
597 int sock __attribute__((unused)),
598 struct ust_register_msg *msg __attribute__((unused)))
604 int ust_app_recv_notify(int sock __attribute__((unused)))
610 struct ust_app *ust_app_create(
611 struct ust_register_msg *msg __attribute__((unused)),
612 int sock __attribute__((unused)))
618 void ust_app_add(struct ust_app *app __attribute__((unused)))
623 void ust_app_notify_sock_unregister(int sock __attribute__((unused)))
628 ssize_t ust_app_push_metadata(
629 ust_registry_session *registry __attribute__((unused)),
630 struct consumer_socket *socket __attribute__((unused)),
631 int send_zero_data __attribute__((unused)))
637 void ust_app_destroy(struct ust_app *app __attribute__((unused)))
643 enum lttng_error_code ust_app_snapshot_record(
644 struct ltt_ust_session *usess __attribute__((unused)),
645 const struct consumer_output *output __attribute__((unused)),
646 uint64_t max_stream_size __attribute__((unused)))
648 return LTTNG_ERR_UNK;
652 unsigned int ust_app_get_nb_stream(
653 struct ltt_ust_session *usess __attribute__((unused)))
659 void ust_app_update_event_notifier_error_count(
660 struct lttng_trigger *lttng_trigger __attribute__((unused)))
666 int ust_app_supported(void)
672 bool ust_app_supports_notifiers(
673 const struct ust_app *app __attribute__((unused)))
679 bool ust_app_supports_counters(
680 const struct ust_app *app __attribute__((unused)))
686 struct ust_app *ust_app_find_by_sock(int sock __attribute__((unused)))
692 struct ust_app *ust_app_find_by_pid(pid_t pid __attribute__((unused)))
698 uint64_t ust_app_get_size_one_more_packet_per_stream(
699 const struct ltt_ust_session *usess __attribute__((unused)),
700 uint64_t cur_nr_packets __attribute__((unused))) {
705 int ust_app_uid_get_channel_runtime_stats(
706 uint64_t ust_session_id __attribute__((unused)),
707 struct cds_list_head *buffer_reg_uid_list __attribute__((unused)),
708 struct consumer_output *consumer __attribute__((unused)),
709 int overwrite __attribute__((unused)),
710 uint64_t uchan_id __attribute__((unused)),
711 uint64_t *discarded __attribute__((unused)),
712 uint64_t *lost __attribute__((unused)))
718 int ust_app_pid_get_channel_runtime_stats(
719 struct ltt_ust_session *usess __attribute__((unused)),
720 struct ltt_ust_channel *uchan __attribute__((unused)),
721 struct consumer_output *consumer __attribute__((unused)),
722 int overwrite __attribute__((unused)),
723 uint64_t *discarded __attribute__((unused)),
724 uint64_t *lost __attribute__((unused)))
730 int ust_app_regenerate_statedump_all(
731 struct ltt_ust_session *usess __attribute__((unused)))
737 enum lttng_error_code ust_app_rotate_session(
738 struct ltt_session *session __attribute__((unused)))
740 return LTTNG_ERR_UNK;
744 enum lttng_error_code ust_app_create_channel_subdirectories(
745 const struct ltt_ust_session *session __attribute__((unused)))
747 return LTTNG_ERR_UNK;
751 int ust_app_release_object(struct ust_app *app __attribute__((unused)),
752 struct lttng_ust_abi_object_data *data __attribute__((unused)))
758 enum lttng_error_code ust_app_clear_session(
759 struct ltt_session *session __attribute__((unused)))
761 return LTTNG_ERR_UNK;
765 enum lttng_error_code ust_app_open_packets(
766 struct ltt_session *session __attribute__((unused)))
768 return LTTNG_ERR_UNK;
771 #endif /* HAVE_LIBLTTNG_UST_CTL */
773 #endif /* _LTT_UST_APP_H */