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
12 #include "session.hpp"
13 #include "trace-ust.hpp"
14 #include "ust-field-convert.hpp"
15 #include "ust-registry-session.hpp"
16 #include "ust-registry.hpp"
18 #include <common/format.hpp>
19 #include <common/index-allocator.hpp>
20 #include <common/uuid.hpp>
24 #define UST_APP_EVENT_LIST_SIZE 32
26 /* Process name (short). */
27 #define UST_APP_PROCNAME_LEN 16
29 struct lttng_bytecode;
30 struct lttng_ust_filter_bytecode;
32 extern int the_ust_consumerd64_fd, the_ust_consumerd32_fd;
35 * Object used to close the notify socket in a call_rcu(). Since the
36 * application might not be found, we need an independant object containing the
39 struct ust_app_notify_sock_obj {
44 struct ust_app_ht_key {
46 const struct lttng_bytecode *filter;
47 enum lttng_ust_abi_loglevel_type loglevel_type;
48 const struct lttng_event_exclusion *exclusion;
52 * Application registration data structure.
54 struct ust_register_msg {
55 enum lttng_ust_ctl_socket_type type;
64 uint32_t bits_per_long;
65 uint32_t uint8_t_alignment;
66 uint32_t uint16_t_alignment;
67 uint32_t uint32_t_alignment;
68 uint32_t uint64_t_alignment;
69 uint32_t long_alignment;
70 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
71 char name[LTTNG_UST_ABI_PROCNAME_LEN];
75 * Global applications HT used by the session daemon. This table is indexed by
76 * PID using the pid_n node and pid value of an ust_app.
78 extern struct lttng_ht *ust_app_ht;
81 * Global applications HT used by the session daemon. This table is indexed by
82 * socket using the sock_n node and sock value of an ust_app.
84 * The 'sock' in question here is the 'command' socket.
86 extern struct lttng_ht *ust_app_ht_by_sock;
89 * Global applications HT used by the session daemon. This table is indexed by
90 * socket using the notify_sock_n node and notify_sock value of an ust_app.
92 extern struct lttng_ht *ust_app_ht_by_notify_sock;
94 /* Stream list containing ust_app_stream. */
95 struct ust_app_stream_list {
97 struct cds_list_head head;
102 struct lttng_ust_context_attr ctx;
103 struct lttng_ust_abi_object_data *obj;
104 struct lttng_ht_node_ulong node;
105 struct cds_list_head list;
108 struct ust_app_event {
111 struct lttng_ust_abi_object_data *obj;
112 struct lttng_ust_abi_event attr;
113 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
114 struct lttng_ht_node_str node;
115 struct lttng_bytecode *filter;
116 struct lttng_event_exclusion *exclusion;
119 struct ust_app_event_notifier_rule {
121 uint64_t error_counter_index;
123 struct lttng_ust_abi_object_data *obj;
124 /* Holds a strong reference. */
125 struct lttng_trigger *trigger;
126 /* Unique ID returned by the tracer to identify this event notifier. */
128 struct lttng_ht_node_u64 node;
129 /* The trigger object owns the filter. */
130 const struct lttng_bytecode *filter;
132 struct lttng_event_exclusion *exclusion;
133 /* For delayed reclaim. */
134 struct rcu_head rcu_head;
137 struct ust_app_stream {
139 char pathname[PATH_MAX];
140 /* Format is %s_%d respectively channel name and CPU number. */
141 char name[DEFAULT_STREAM_NAME_LEN];
142 struct lttng_ust_abi_object_data *obj;
143 /* Using a list of streams to keep order. */
144 struct cds_list_head list;
147 struct ust_app_channel {
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 bool 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.
252 /* Traffic initiated from the session daemon to the application. */
254 pthread_mutex_t sock_lock; /* Protects sock protocol. */
256 /* Traffic initiated from the application to the session daemon. */
260 uid_t uid; /* User ID that owns the apps */
261 gid_t gid; /* Group ID that owns the apps */
264 lttng::sessiond::trace::abi abi;
266 int compatible; /* If the lttng-ust tracer version does not match the
267 supported version of the session daemon, this flag is
268 set to 0 (NOT compatible) else 1. */
269 struct lttng_ust_abi_tracer_version version;
270 uint32_t v_major; /* Version major number */
271 uint32_t v_minor; /* Version minor number */
272 /* Extra for the NULL byte. */
273 char name[UST_APP_PROCNAME_LEN + 1];
274 /* Type of buffer this application uses. */
275 enum lttng_buffer_type buffer_type;
276 struct lttng_ht *sessions;
277 struct lttng_ht_node_ulong pid_n;
278 struct lttng_ht_node_ulong sock_n;
279 struct lttng_ht_node_ulong notify_sock_n;
281 * This is a list of ust app session that, once the app is going into
282 * teardown mode, in the RCU call, each node in this list is removed and
285 * Element of the list are added when an application unregisters after each
286 * ht_del of ust_app_session associated to this app. This list is NOT used
287 * when a session is destroyed.
289 struct cds_list_head teardown_head;
291 * Hash table containing ust_app_channel indexed by channel objd.
293 struct lttng_ht *ust_objd;
295 * Hash table containing ust_app_session indexed by objd.
297 struct lttng_ht *ust_sessions_objd;
300 * If this application is of the agent domain and this is non negative then
301 * a lookup MUST be done to acquire a read side reference to the
302 * corresponding agent app object. If the lookup fails, this should be set
303 * to a negative value indicating that the agent application is gone.
307 * Time at which the app is registred.
308 * Used for path creation
310 time_t registration_time;
316 * Handle to the lttng_ust object representing the event
319 struct lttng_ust_abi_object_data *object;
320 struct lttng_pipe *event_pipe;
321 struct lttng_ust_abi_object_data *counter;
322 struct lttng_ust_abi_object_data **counter_cpu;
324 } event_notifier_group;
326 * Hashtable indexing the application's event notifier rule's
327 * (ust_app_event_notifier_rule) by their token's value.
329 struct lttng_ht *token_to_event_notifier_rule_ht;
331 lttng::sessiond::ust::ctl_field_quirks ctl_field_quirks() const;
335 * Due to a bug in g++ < 7.1, this specialization must be enclosed in the fmt namespace,
336 * see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56480.
340 struct formatter<ust_app> : formatter<std::string> {
341 template <typename FormatContextType>
342 typename FormatContextType::iterator format(const ust_app& app, FormatContextType& ctx)
346 "{{ procname = `{}`, ppid = {}, pid = {}, uid = {}, gid = {}, version = {}.{}, registration time = {} }}",
354 lttng::utils::time_to_iso8601_str(app.registration_time));
357 } /* namespace fmt */
359 #ifdef HAVE_LIBLTTNG_UST_CTL
361 int ust_app_register(struct ust_register_msg *msg, int sock);
362 int ust_app_register_done(struct ust_app *app);
363 int ust_app_version(struct ust_app *app);
364 void ust_app_unregister(int sock);
365 int ust_app_start_trace_all(struct ltt_ust_session *usess);
366 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
367 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
368 int ust_app_list_events(struct lttng_event **events);
369 int ust_app_list_event_fields(struct lttng_event_field **fields);
370 int ust_app_create_event_glb(struct ltt_ust_session *usess,
371 struct ltt_ust_channel *uchan,
372 struct ltt_ust_event *uevent);
373 int ust_app_disable_channel_glb(struct ltt_ust_session *usess, struct ltt_ust_channel *uchan);
374 int ust_app_enable_channel_glb(struct ltt_ust_session *usess, struct ltt_ust_channel *uchan);
375 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
376 struct ltt_ust_channel *uchan,
377 struct ltt_ust_event *uevent);
378 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
379 struct ltt_ust_channel *uchan,
380 struct ltt_ust_event *uevent);
381 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
382 struct ltt_ust_channel *uchan,
383 struct ltt_ust_context *uctx);
384 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
385 void ust_app_global_update_all(struct ltt_ust_session *usess);
386 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
387 void ust_app_global_update_all_event_notifier_rules();
389 void ust_app_clean_list();
390 int ust_app_ht_alloc();
391 struct ust_app *ust_app_find_by_pid(pid_t pid);
392 struct ust_app_stream *ust_app_alloc_stream();
393 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
394 int ust_app_recv_notify(int sock);
395 void ust_app_add(struct ust_app *app);
396 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
397 void ust_app_notify_sock_unregister(int sock);
398 ssize_t ust_app_push_metadata(const lttng::sessiond::ust::registry_session::locked_ptr& registry,
399 struct consumer_socket *socket,
401 void ust_app_destroy(struct ust_app *app);
402 enum lttng_error_code ust_app_snapshot_record(const struct ltt_ust_session *usess,
403 const struct consumer_output *output,
404 uint64_t nb_packets_per_stream);
405 uint64_t ust_app_get_size_one_more_packet_per_stream(const struct ltt_ust_session *usess,
406 uint64_t cur_nr_packets);
407 struct ust_app *ust_app_find_by_sock(int sock);
408 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
409 struct cds_list_head *buffer_reg_uid_list,
410 struct consumer_output *consumer,
415 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
416 struct ltt_ust_channel *uchan,
417 struct consumer_output *consumer,
421 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
422 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
423 enum lttng_error_code ust_app_create_channel_subdirectories(const struct ltt_ust_session *session);
424 int ust_app_release_object(struct ust_app *app, struct lttng_ust_abi_object_data *data);
425 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
426 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
428 int ust_app_setup_event_notifier_group(struct ust_app *app);
430 static inline int ust_app_supported()
435 bool ust_app_supports_notifiers(const struct ust_app *app);
436 bool ust_app_supports_counters(const struct ust_app *app);
438 #else /* HAVE_LIBLTTNG_UST_CTL */
440 static inline int ust_app_destroy_trace_all(struct ltt_ust_session *usess __attribute__((unused)))
445 static inline int ust_app_start_trace(struct ltt_ust_session *usess __attribute__((unused)),
446 struct ust_app *app __attribute__((unused)))
451 static inline int ust_app_start_trace_all(struct ltt_ust_session *usess __attribute__((unused)))
456 static inline int ust_app_stop_trace_all(struct ltt_ust_session *usess __attribute__((unused)))
461 static inline int ust_app_list_events(struct lttng_event **events __attribute__((unused)))
466 static inline int ust_app_list_event_fields(struct lttng_event_field **fields
467 __attribute__((unused)))
472 static inline int ust_app_register(struct ust_register_msg *msg __attribute__((unused)),
473 int sock __attribute__((unused)))
478 static inline int ust_app_register_done(struct ust_app *app __attribute__((unused)))
483 static inline int ust_app_version(struct ust_app *app __attribute__((unused)))
488 static inline void ust_app_unregister(int sock __attribute__((unused)))
492 static inline void ust_app_clean_list(void)
496 static inline struct ust_app_list *ust_app_get_list(void)
501 static inline struct ust_app *ust_app_get_by_pid(pid_t pid __attribute__((unused)))
506 static inline int ust_app_ht_alloc(void)
511 static inline void ust_app_global_update(struct ltt_ust_session *usess __attribute__((unused)),
512 struct ust_app *app __attribute__((unused)))
516 static inline void ust_app_global_update_event_notifier_rules(struct ust_app *app
517 __attribute__((unused)))
521 static inline void ust_app_global_update_all_event_notifier_rules(void)
525 static inline int ust_app_setup_event_notifier_group(struct ust_app *app __attribute__((unused)))
530 static inline int ust_app_disable_channel_glb(struct ltt_ust_session *usess __attribute__((unused)),
531 struct ltt_ust_channel *uchan __attribute__((unused)))
536 static inline int ust_app_enable_channel_glb(struct ltt_ust_session *usess __attribute__((unused)),
537 struct ltt_ust_channel *uchan __attribute__((unused)))
542 static inline int ust_app_create_event_glb(struct ltt_ust_session *usess __attribute__((unused)),
543 struct ltt_ust_channel *uchan __attribute__((unused)),
544 struct ltt_ust_event *uevent __attribute__((unused)))
549 static inline int ust_app_disable_event_glb(struct ltt_ust_session *usess __attribute__((unused)),
550 struct ltt_ust_channel *uchan __attribute__((unused)),
551 struct ltt_ust_event *uevent __attribute__((unused)))
556 static inline int ust_app_enable_event_glb(struct ltt_ust_session *usess __attribute__((unused)),
557 struct ltt_ust_channel *uchan __attribute__((unused)),
558 struct ltt_ust_event *uevent __attribute__((unused)))
563 static inline int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess __attribute__((unused)),
564 struct ltt_ust_channel *uchan __attribute__((unused)),
565 struct ltt_ust_context *uctx __attribute__((unused)))
570 static inline int ust_app_enable_event_pid(struct ltt_ust_session *usess __attribute__((unused)),
571 struct ltt_ust_channel *uchan __attribute__((unused)),
572 struct ltt_ust_event *uevent __attribute__((unused)),
573 pid_t pid __attribute__((unused)))
578 static inline int ust_app_recv_registration(int sock __attribute__((unused)),
579 struct ust_register_msg *msg __attribute__((unused)))
584 static inline int ust_app_recv_notify(int sock __attribute__((unused)))
589 static inline struct ust_app *ust_app_create(struct ust_register_msg *msg __attribute__((unused)),
590 int sock __attribute__((unused)))
595 static inline void ust_app_add(struct ust_app *app __attribute__((unused)))
599 static inline void ust_app_notify_sock_unregister(int sock __attribute__((unused)))
603 static inline ssize_t ust_app_push_metadata(lttng::sessiond::ust::registry_session *registry
604 __attribute__((unused)),
605 struct consumer_socket *socket __attribute__((unused)),
606 int send_zero_data __attribute__((unused)))
611 static inline void ust_app_destroy(struct ust_app *app __attribute__((unused)))
616 static inline enum lttng_error_code
617 ust_app_snapshot_record(struct ltt_ust_session *usess __attribute__((unused)),
618 const struct consumer_output *output __attribute__((unused)),
619 uint64_t max_stream_size __attribute__((unused)))
621 return LTTNG_ERR_UNK;
624 static inline unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess
625 __attribute__((unused)))
630 static inline void ust_app_update_event_notifier_error_count(struct lttng_trigger *lttng_trigger
631 __attribute__((unused)))
636 static inline int ust_app_supported(void)
641 static inline bool ust_app_supports_notifiers(const struct ust_app *app __attribute__((unused)))
646 static inline bool ust_app_supports_counters(const struct ust_app *app __attribute__((unused)))
651 static inline struct ust_app *ust_app_find_by_sock(int sock __attribute__((unused)))
656 static inline struct ust_app *ust_app_find_by_pid(pid_t pid __attribute__((unused)))
661 static inline uint64_t
662 ust_app_get_size_one_more_packet_per_stream(const struct ltt_ust_session *usess
663 __attribute__((unused)),
664 uint64_t cur_nr_packets __attribute__((unused)))
669 static inline int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
670 __attribute__((unused)),
671 struct cds_list_head *buffer_reg_uid_list
672 __attribute__((unused)),
673 struct consumer_output *consumer
674 __attribute__((unused)),
675 int overwrite __attribute__((unused)),
676 uint64_t uchan_id __attribute__((unused)),
677 uint64_t *discarded __attribute__((unused)),
678 uint64_t *lost __attribute__((unused)))
684 ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess __attribute__((unused)),
685 struct ltt_ust_channel *uchan __attribute__((unused)),
686 struct consumer_output *consumer __attribute__((unused)),
687 int overwrite __attribute__((unused)),
688 uint64_t *discarded __attribute__((unused)),
689 uint64_t *lost __attribute__((unused)))
694 static inline int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess
695 __attribute__((unused)))
700 static inline enum lttng_error_code ust_app_rotate_session(struct ltt_session *session
701 __attribute__((unused)))
703 return LTTNG_ERR_UNK;
706 static inline enum lttng_error_code
707 ust_app_create_channel_subdirectories(const struct ltt_ust_session *session __attribute__((unused)))
709 return LTTNG_ERR_UNK;
712 static inline int ust_app_release_object(struct ust_app *app __attribute__((unused)),
713 struct lttng_ust_abi_object_data *data
714 __attribute__((unused)))
719 static inline enum lttng_error_code ust_app_clear_session(struct ltt_session *session
720 __attribute__((unused)))
722 return LTTNG_ERR_UNK;
725 static inline enum lttng_error_code ust_app_open_packets(struct ltt_session *session
726 __attribute__((unused)))
728 return LTTNG_ERR_UNK;
731 #endif /* HAVE_LIBLTTNG_UST_CTL */
733 #endif /* _LTT_UST_APP_H */