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 "ust-registry-session.hpp"
21 #include "session.hpp"
22 #include "ust-field-convert.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 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 lttng::sessiond::trace::abi abi;
264 int compatible; /* If the lttng-ust tracer version does not match the
265 supported version of the session daemon, this flag is
266 set to 0 (NOT compatible) else 1. */
267 struct lttng_ust_abi_tracer_version version;
268 uint32_t v_major; /* Version major number */
269 uint32_t v_minor; /* Version minor number */
270 /* Extra for the NULL byte. */
271 char name[UST_APP_PROCNAME_LEN + 1];
272 /* Type of buffer this application uses. */
273 enum lttng_buffer_type buffer_type;
274 struct lttng_ht *sessions;
275 struct lttng_ht_node_ulong pid_n;
276 struct lttng_ht_node_ulong sock_n;
277 struct lttng_ht_node_ulong notify_sock_n;
279 * This is a list of ust app session that, once the app is going into
280 * teardown mode, in the RCU call, each node in this list is removed and
283 * Element of the list are added when an application unregisters after each
284 * ht_del of ust_app_session associated to this app. This list is NOT used
285 * when a session is destroyed.
287 struct cds_list_head teardown_head;
289 * Hash table containing ust_app_channel indexed by channel objd.
291 struct lttng_ht *ust_objd;
293 * Hash table containing ust_app_session indexed by objd.
295 struct lttng_ht *ust_sessions_objd;
298 * If this application is of the agent domain and this is non negative then
299 * a lookup MUST be done to acquire a read side reference to the
300 * corresponding agent app object. If the lookup fails, this should be set
301 * to a negative value indicating that the agent application is gone.
305 * Time at which the app is registred.
306 * Used for path creation
308 time_t registration_time;
314 * Handle to the lttng_ust object representing the event
317 struct lttng_ust_abi_object_data *object;
318 struct lttng_pipe *event_pipe;
319 struct lttng_ust_abi_object_data *counter;
320 struct lttng_ust_abi_object_data **counter_cpu;
322 } event_notifier_group;
324 * Hashtable indexing the application's event notifier rule's
325 * (ust_app_event_notifier_rule) by their token's value.
327 struct lttng_ht *token_to_event_notifier_rule_ht;
329 lttng::sessiond::ust::ctl_field_quirks ctl_field_quirks() const;
333 * Due to a bug in g++ < 7.1, this specialization must be enclosed in the fmt namespace,
334 * see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56480.
338 struct formatter<ust_app> : formatter<std::string> {
339 template <typename FormatContextType>
340 typename FormatContextType::iterator format(const ust_app& app, FormatContextType& ctx)
342 return format_to(ctx.out(),
343 "{{ procname = `{}`, ppid = {}, pid = {}, uid = {}, gid = {}, version = {}.{}, registration time = {} }}",
344 app.name, app.ppid, app.pid, app.uid, app.gid, app.v_major,
346 lttng::utils::time_to_iso8601_str(app.registration_time));
349 } /* namespace fmt */
351 #ifdef HAVE_LIBLTTNG_UST_CTL
353 int ust_app_register(struct ust_register_msg *msg, int sock);
354 int ust_app_register_done(struct ust_app *app);
355 int ust_app_version(struct ust_app *app);
356 void ust_app_unregister(int sock);
357 int ust_app_start_trace_all(struct ltt_ust_session *usess);
358 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
359 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
360 int ust_app_list_events(struct lttng_event **events);
361 int ust_app_list_event_fields(struct lttng_event_field **fields);
362 int ust_app_create_event_glb(struct ltt_ust_session *usess,
363 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
364 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
365 struct ltt_ust_channel *uchan);
366 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
367 struct ltt_ust_channel *uchan);
368 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
369 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
370 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
371 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
372 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
373 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
374 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
375 void ust_app_global_update_all(struct ltt_ust_session *usess);
376 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
377 void ust_app_global_update_all_event_notifier_rules();
379 void ust_app_clean_list();
380 int ust_app_ht_alloc();
381 struct ust_app *ust_app_find_by_pid(pid_t pid);
382 struct ust_app_stream *ust_app_alloc_stream();
383 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
384 int ust_app_recv_notify(int sock);
385 void ust_app_add(struct ust_app *app);
386 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
387 void ust_app_notify_sock_unregister(int sock);
388 ssize_t ust_app_push_metadata(const lttng::sessiond::ust::registry_session::locked_ptr& registry,
389 struct consumer_socket *socket,
391 void ust_app_destroy(struct ust_app *app);
392 enum lttng_error_code ust_app_snapshot_record(
393 const struct ltt_ust_session *usess,
394 const struct consumer_output *output,
395 uint64_t nb_packets_per_stream);
396 uint64_t ust_app_get_size_one_more_packet_per_stream(
397 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
398 struct ust_app *ust_app_find_by_sock(int sock);
399 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
400 struct cds_list_head *buffer_reg_uid_list,
401 struct consumer_output *consumer, uint64_t uchan_id,
402 int overwrite, uint64_t *discarded, uint64_t *lost);
403 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
404 struct ltt_ust_channel *uchan,
405 struct consumer_output *consumer,
406 int overwrite, uint64_t *discarded, uint64_t *lost);
407 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
408 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
409 enum lttng_error_code ust_app_create_channel_subdirectories(
410 const struct ltt_ust_session *session);
411 int ust_app_release_object(struct ust_app *app,
412 struct lttng_ust_abi_object_data *data);
413 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
414 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
416 int ust_app_setup_event_notifier_group(struct ust_app *app);
419 int ust_app_supported()
424 bool ust_app_supports_notifiers(const struct ust_app *app);
425 bool ust_app_supports_counters(const struct ust_app *app);
427 #else /* HAVE_LIBLTTNG_UST_CTL */
430 int ust_app_destroy_trace_all(
431 struct ltt_ust_session *usess __attribute__((unused)))
437 int ust_app_start_trace(
438 struct ltt_ust_session *usess __attribute__((unused)),
439 struct ust_app *app __attribute__((unused)))
445 int ust_app_start_trace_all(
446 struct ltt_ust_session *usess __attribute__((unused)))
452 int ust_app_stop_trace_all(
453 struct ltt_ust_session *usess __attribute__((unused)))
459 int ust_app_list_events(
460 struct lttng_event **events __attribute__((unused)))
466 int ust_app_list_event_fields(
467 struct lttng_event_field **fields __attribute__((unused)))
473 int ust_app_register(
474 struct ust_register_msg *msg __attribute__((unused)),
475 int sock __attribute__((unused)))
481 int ust_app_register_done(struct ust_app *app __attribute__((unused)))
487 int ust_app_version(struct ust_app *app __attribute__((unused)))
493 void ust_app_unregister(int sock __attribute__((unused)))
498 void ust_app_clean_list(void)
503 struct ust_app_list *ust_app_get_list(void)
509 struct ust_app *ust_app_get_by_pid(pid_t pid __attribute__((unused)))
515 int ust_app_ht_alloc(void)
521 void ust_app_global_update(
522 struct ltt_ust_session *usess __attribute__((unused)),
523 struct ust_app *app __attribute__((unused)))
527 void ust_app_global_update_event_notifier_rules(
528 struct ust_app *app __attribute__((unused)))
532 void ust_app_global_update_all_event_notifier_rules(void)
536 int ust_app_setup_event_notifier_group(
537 struct ust_app *app __attribute__((unused)))
543 int ust_app_disable_channel_glb(
544 struct ltt_ust_session *usess __attribute__((unused)),
545 struct ltt_ust_channel *uchan __attribute__((unused)))
551 int ust_app_enable_channel_glb(
552 struct ltt_ust_session *usess __attribute__((unused)),
553 struct ltt_ust_channel *uchan __attribute__((unused)))
559 int ust_app_create_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_disable_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_enable_event_glb(
578 struct ltt_ust_session *usess __attribute__((unused)),
579 struct ltt_ust_channel *uchan __attribute__((unused)),
580 struct ltt_ust_event *uevent __attribute__((unused)))
586 int ust_app_add_ctx_channel_glb(
587 struct ltt_ust_session *usess __attribute__((unused)),
588 struct ltt_ust_channel *uchan __attribute__((unused)),
589 struct ltt_ust_context *uctx __attribute__((unused)))
595 int ust_app_enable_event_pid(
596 struct ltt_ust_session *usess __attribute__((unused)),
597 struct ltt_ust_channel *uchan __attribute__((unused)),
598 struct ltt_ust_event *uevent __attribute__((unused)),
599 pid_t pid __attribute__((unused)))
605 int ust_app_recv_registration(
606 int sock __attribute__((unused)),
607 struct ust_register_msg *msg __attribute__((unused)))
613 int ust_app_recv_notify(int sock __attribute__((unused)))
619 struct ust_app *ust_app_create(
620 struct ust_register_msg *msg __attribute__((unused)),
621 int sock __attribute__((unused)))
627 void ust_app_add(struct ust_app *app __attribute__((unused)))
632 void ust_app_notify_sock_unregister(int sock __attribute__((unused)))
637 ssize_t ust_app_push_metadata(
638 lttng::sessiond::ust::registry_session *registry __attribute__((unused)),
639 struct consumer_socket *socket __attribute__((unused)),
640 int send_zero_data __attribute__((unused)))
646 void ust_app_destroy(struct ust_app *app __attribute__((unused)))
652 enum lttng_error_code ust_app_snapshot_record(
653 struct ltt_ust_session *usess __attribute__((unused)),
654 const struct consumer_output *output __attribute__((unused)),
655 uint64_t max_stream_size __attribute__((unused)))
657 return LTTNG_ERR_UNK;
661 unsigned int ust_app_get_nb_stream(
662 struct ltt_ust_session *usess __attribute__((unused)))
668 void ust_app_update_event_notifier_error_count(
669 struct lttng_trigger *lttng_trigger __attribute__((unused)))
675 int ust_app_supported(void)
681 bool ust_app_supports_notifiers(
682 const struct ust_app *app __attribute__((unused)))
688 bool ust_app_supports_counters(
689 const struct ust_app *app __attribute__((unused)))
695 struct ust_app *ust_app_find_by_sock(int sock __attribute__((unused)))
701 struct ust_app *ust_app_find_by_pid(pid_t pid __attribute__((unused)))
707 uint64_t ust_app_get_size_one_more_packet_per_stream(
708 const struct ltt_ust_session *usess __attribute__((unused)),
709 uint64_t cur_nr_packets __attribute__((unused))) {
714 int ust_app_uid_get_channel_runtime_stats(
715 uint64_t ust_session_id __attribute__((unused)),
716 struct cds_list_head *buffer_reg_uid_list __attribute__((unused)),
717 struct consumer_output *consumer __attribute__((unused)),
718 int overwrite __attribute__((unused)),
719 uint64_t uchan_id __attribute__((unused)),
720 uint64_t *discarded __attribute__((unused)),
721 uint64_t *lost __attribute__((unused)))
727 int ust_app_pid_get_channel_runtime_stats(
728 struct ltt_ust_session *usess __attribute__((unused)),
729 struct ltt_ust_channel *uchan __attribute__((unused)),
730 struct consumer_output *consumer __attribute__((unused)),
731 int overwrite __attribute__((unused)),
732 uint64_t *discarded __attribute__((unused)),
733 uint64_t *lost __attribute__((unused)))
739 int ust_app_regenerate_statedump_all(
740 struct ltt_ust_session *usess __attribute__((unused)))
746 enum lttng_error_code ust_app_rotate_session(
747 struct ltt_session *session __attribute__((unused)))
749 return LTTNG_ERR_UNK;
753 enum lttng_error_code ust_app_create_channel_subdirectories(
754 const struct ltt_ust_session *session __attribute__((unused)))
756 return LTTNG_ERR_UNK;
760 int ust_app_release_object(struct ust_app *app __attribute__((unused)),
761 struct lttng_ust_abi_object_data *data __attribute__((unused)))
767 enum lttng_error_code ust_app_clear_session(
768 struct ltt_session *session __attribute__((unused)))
770 return LTTNG_ERR_UNK;
774 enum lttng_error_code ust_app_open_packets(
775 struct ltt_session *session __attribute__((unused)))
777 return LTTNG_ERR_UNK;
780 #endif /* HAVE_LIBLTTNG_UST_CTL */
782 #endif /* _LTT_UST_APP_H */