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"
23 #define UST_APP_EVENT_LIST_SIZE 32
25 /* Process name (short). */
26 #define UST_APP_PROCNAME_LEN 16
28 struct lttng_bytecode;
29 struct lttng_ust_filter_bytecode;
31 extern int the_ust_consumerd64_fd, the_ust_consumerd32_fd;
34 * Object used to close the notify socket in a call_rcu(). Since the
35 * application might not be found, we need an independant object containing the
38 struct ust_app_notify_sock_obj {
43 struct ust_app_ht_key {
45 const struct lttng_bytecode *filter;
46 enum lttng_ust_abi_loglevel_type loglevel_type;
47 const struct lttng_event_exclusion *exclusion;
51 * Application registration data structure.
53 struct ust_register_msg {
54 enum lttng_ust_ctl_socket_type type;
63 uint32_t bits_per_long;
64 uint32_t uint8_t_alignment;
65 uint32_t uint16_t_alignment;
66 uint32_t uint32_t_alignment;
67 uint32_t uint64_t_alignment;
68 uint32_t long_alignment;
69 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
70 char name[LTTNG_UST_ABI_PROCNAME_LEN];
74 * Global applications HT used by the session daemon. This table is indexed by
75 * PID using the pid_n node and pid value of an ust_app.
77 extern struct lttng_ht *ust_app_ht;
80 * Global applications HT used by the session daemon. This table is indexed by
81 * socket using the sock_n node and sock value of an ust_app.
83 * The 'sock' in question here is the 'command' socket.
85 extern struct lttng_ht *ust_app_ht_by_sock;
88 * Global applications HT used by the session daemon. This table is indexed by
89 * socket using the notify_sock_n node and notify_sock value of an ust_app.
91 extern struct lttng_ht *ust_app_ht_by_notify_sock;
93 /* Stream list containing ust_app_stream. */
94 struct ust_app_stream_list {
96 struct cds_list_head head;
101 struct lttng_ust_context_attr ctx;
102 struct lttng_ust_abi_object_data *obj;
103 struct lttng_ht_node_ulong node;
104 struct cds_list_head list;
107 struct ust_app_event {
110 struct lttng_ust_abi_object_data *obj;
111 struct lttng_ust_abi_event attr;
112 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
113 struct lttng_ht_node_str node;
114 struct lttng_bytecode *filter;
115 struct lttng_event_exclusion *exclusion;
118 struct ust_app_event_notifier_rule {
120 uint64_t error_counter_index;
122 struct lttng_ust_abi_object_data *obj;
123 /* Holds a strong reference. */
124 struct lttng_trigger *trigger;
125 /* Unique ID returned by the tracer to identify this event notifier. */
127 struct lttng_ht_node_u64 node;
128 /* The trigger object owns the filter. */
129 const struct lttng_bytecode *filter;
131 struct lttng_event_exclusion *exclusion;
132 /* For delayed reclaim. */
133 struct rcu_head rcu_head;
136 struct ust_app_stream {
138 char pathname[PATH_MAX];
139 /* Format is %s_%d respectively channel name and CPU number. */
140 char name[DEFAULT_STREAM_NAME_LEN];
141 struct lttng_ust_abi_object_data *obj;
142 /* Using a list of streams to keep order. */
143 struct cds_list_head list;
146 struct ust_app_channel {
150 * Unique key used to identify the channel on the consumer side.
151 * 0 is a reserved 'invalid' value used to indicate that the consumer
152 * does not know about this channel (i.e. an error occurred).
155 /* Id of the tracing channel set on creation. */
156 uint64_t tracing_channel_id;
157 /* Number of stream that this channel is expected to receive. */
158 unsigned int expected_stream_count;
159 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
160 struct lttng_ust_abi_object_data *obj;
161 struct lttng_ust_ctl_consumer_channel_attr attr;
162 struct ust_app_stream_list streams;
163 /* Session pointer that owns this object. */
164 struct ust_app_session *session;
166 * Contexts are kept in a hash table for fast lookup and in an ordered list
167 * so we are able to enable them on the tracer side in the same order the
170 struct lttng_ht *ctx;
171 struct cds_list_head ctx_list;
173 struct lttng_ht *events;
174 uint64_t tracefile_size;
175 uint64_t tracefile_count;
176 uint64_t monitor_timer_interval;
178 * Node indexed by channel name in the channels' hash table of a session.
180 struct lttng_ht_node_str node;
182 * Node indexed by UST channel object descriptor (handle). Stored in the
183 * ust_objd hash table in the ust_app object.
185 struct lttng_ht_node_ulong ust_objd_node;
186 /* For delayed reclaim */
187 struct rcu_head rcu_head;
190 struct ust_app_session {
192 * Lock protecting this session's ust app interaction. Held
193 * across command send/recv to/from app. Never nests within the
194 * session registry lock.
196 pthread_mutex_t lock;
199 /* started: has the session been in started state at any time ? */
200 int started; /* allows detection of start vs restart. */
201 int handle; /* used has unique identifier for app session */
203 bool deleted; /* Session deleted flag. Check with lock held. */
206 * Tracing session ID. Multiple ust app session can have the same tracing
207 * session id making this value NOT unique to the object.
210 uint64_t id; /* Unique session identifier */
211 struct lttng_ht *channels; /* Registered channels */
212 struct lttng_ht_node_u64 node;
214 * Node indexed by UST session object descriptor (handle). Stored in the
215 * ust_sessions_objd hash table in the ust_app object.
217 struct lttng_ht_node_ulong ust_objd_node;
218 /* Starts with 'ust'; no leading slash. */
220 /* UID/GID of the application owning the session */
221 struct lttng_credentials real_credentials;
222 /* Effective UID and GID. Same as the tracing session. */
223 struct lttng_credentials effective_credentials;
224 struct cds_list_head teardown_node;
226 * Once at least *one* session is created onto the application, the
227 * corresponding consumer is set so we can use it on unregistration.
229 struct consumer_output *consumer;
230 enum lttng_buffer_type buffer_type;
231 /* ABI of the session. Same value as the application. */
232 uint32_t bits_per_long;
233 /* For delayed reclaim */
234 struct rcu_head rcu_head;
235 /* If the channel's streams have to be outputed or not. */
236 unsigned int output_traces;
237 unsigned int live_timer_interval; /* usec */
239 /* Metadata channel attributes. */
240 struct lttng_ust_ctl_consumer_channel_attr metadata_attr;
242 char root_shm_path[PATH_MAX];
243 char shm_path[PATH_MAX];
247 * Registered traceable applications. Libust registers to the session daemon
248 * and a linked list is kept of all running traceable app.
252 pthread_mutex_t sock_lock; /* Protects sock protocol. */
257 uid_t uid; /* User ID that owns the apps */
258 gid_t gid; /* Group ID that owns the apps */
261 lttng::sessiond::trace::abi abi;
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_abi_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;
313 * Handle to the lttng_ust object representing the event
316 struct lttng_ust_abi_object_data *object;
317 struct lttng_pipe *event_pipe;
318 struct lttng_ust_abi_object_data *counter;
319 struct lttng_ust_abi_object_data **counter_cpu;
321 } event_notifier_group;
323 * Hashtable indexing the application's event notifier rule's
324 * (ust_app_event_notifier_rule) by their token's value.
326 struct lttng_ht *token_to_event_notifier_rule_ht;
330 * Due to a bug in g++ < 7.1, this specialization must be enclosed in the fmt namespace,
331 * see https://gcc.gnu.org/bugzilla/show_bug.cgi?id=56480.
335 struct formatter<ust_app> : formatter<std::string> {
336 template <typename FormatCtx>
337 typename FormatCtx::iterator format(const ust_app& app, FormatCtx& ctx)
339 return format_to(ctx.out(),
340 "{{ procname = `{}`, ppid = {}, pid = {}, uid = {}, gid = {}, version = {}.{}, registration time = {} }}",
341 app.name, app.ppid, app.pid, app.uid, app.gid, app.v_major,
343 lttng::utils::time_to_iso8601_str(app.registration_time));
346 } /* namespace fmt */
348 #ifdef HAVE_LIBLTTNG_UST_CTL
350 int ust_app_register(struct ust_register_msg *msg, int sock);
351 int ust_app_register_done(struct ust_app *app);
352 int ust_app_version(struct ust_app *app);
353 void ust_app_unregister(int sock);
354 int ust_app_start_trace_all(struct ltt_ust_session *usess);
355 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
356 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
357 int ust_app_list_events(struct lttng_event **events);
358 int ust_app_list_event_fields(struct lttng_event_field **fields);
359 int ust_app_create_event_glb(struct ltt_ust_session *usess,
360 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
361 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
362 struct ltt_ust_channel *uchan);
363 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
364 struct ltt_ust_channel *uchan);
365 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
366 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
367 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
368 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
369 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
370 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
371 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
372 void ust_app_global_update_all(struct ltt_ust_session *usess);
373 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
374 void ust_app_global_update_all_event_notifier_rules(void);
376 void ust_app_clean_list(void);
377 int ust_app_ht_alloc(void);
378 struct ust_app *ust_app_find_by_pid(pid_t pid);
379 struct ust_app_stream *ust_app_alloc_stream(void);
380 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
381 int ust_app_recv_notify(int sock);
382 void ust_app_add(struct ust_app *app);
383 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
384 void ust_app_notify_sock_unregister(int sock);
385 ssize_t ust_app_push_metadata(const lttng::sessiond::ust::registry_session::locked_ptr& registry,
386 struct consumer_socket *socket,
388 void ust_app_destroy(struct ust_app *app);
389 enum lttng_error_code ust_app_snapshot_record(
390 const struct ltt_ust_session *usess,
391 const struct consumer_output *output,
392 uint64_t nb_packets_per_stream);
393 uint64_t ust_app_get_size_one_more_packet_per_stream(
394 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
395 struct ust_app *ust_app_find_by_sock(int sock);
396 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
397 struct cds_list_head *buffer_reg_uid_list,
398 struct consumer_output *consumer, uint64_t uchan_id,
399 int overwrite, uint64_t *discarded, uint64_t *lost);
400 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
401 struct ltt_ust_channel *uchan,
402 struct consumer_output *consumer,
403 int overwrite, uint64_t *discarded, uint64_t *lost);
404 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
405 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
406 enum lttng_error_code ust_app_create_channel_subdirectories(
407 const struct ltt_ust_session *session);
408 int ust_app_release_object(struct ust_app *app,
409 struct lttng_ust_abi_object_data *data);
410 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
411 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
413 int ust_app_setup_event_notifier_group(struct ust_app *app);
416 int ust_app_supported(void)
421 bool ust_app_supports_notifiers(const struct ust_app *app);
422 bool ust_app_supports_counters(const struct ust_app *app);
424 #else /* HAVE_LIBLTTNG_UST_CTL */
427 int ust_app_destroy_trace_all(
428 struct ltt_ust_session *usess __attribute__((unused)))
434 int ust_app_start_trace(
435 struct ltt_ust_session *usess __attribute__((unused)),
436 struct ust_app *app __attribute__((unused)))
442 int ust_app_start_trace_all(
443 struct ltt_ust_session *usess __attribute__((unused)))
449 int ust_app_stop_trace_all(
450 struct ltt_ust_session *usess __attribute__((unused)))
456 int ust_app_list_events(
457 struct lttng_event **events __attribute__((unused)))
463 int ust_app_list_event_fields(
464 struct lttng_event_field **fields __attribute__((unused)))
470 int ust_app_register(
471 struct ust_register_msg *msg __attribute__((unused)),
472 int sock __attribute__((unused)))
478 int ust_app_register_done(struct ust_app *app __attribute__((unused)))
484 int ust_app_version(struct ust_app *app __attribute__((unused)))
490 void ust_app_unregister(int sock __attribute__((unused)))
495 void ust_app_clean_list(void)
500 struct ust_app_list *ust_app_get_list(void)
506 struct ust_app *ust_app_get_by_pid(pid_t pid __attribute__((unused)))
512 int ust_app_ht_alloc(void)
518 void ust_app_global_update(
519 struct ltt_ust_session *usess __attribute__((unused)),
520 struct ust_app *app __attribute__((unused)))
524 void ust_app_global_update_event_notifier_rules(
525 struct ust_app *app __attribute__((unused)))
529 void ust_app_global_update_all_event_notifier_rules(void)
533 int ust_app_setup_event_notifier_group(
534 struct ust_app *app __attribute__((unused)))
540 int ust_app_disable_channel_glb(
541 struct ltt_ust_session *usess __attribute__((unused)),
542 struct ltt_ust_channel *uchan __attribute__((unused)))
548 int ust_app_enable_channel_glb(
549 struct ltt_ust_session *usess __attribute__((unused)),
550 struct ltt_ust_channel *uchan __attribute__((unused)))
556 int ust_app_create_event_glb(
557 struct ltt_ust_session *usess __attribute__((unused)),
558 struct ltt_ust_channel *uchan __attribute__((unused)),
559 struct ltt_ust_event *uevent __attribute__((unused)))
565 int ust_app_disable_event_glb(
566 struct ltt_ust_session *usess __attribute__((unused)),
567 struct ltt_ust_channel *uchan __attribute__((unused)),
568 struct ltt_ust_event *uevent __attribute__((unused)))
574 int ust_app_enable_event_glb(
575 struct ltt_ust_session *usess __attribute__((unused)),
576 struct ltt_ust_channel *uchan __attribute__((unused)),
577 struct ltt_ust_event *uevent __attribute__((unused)))
583 int ust_app_add_ctx_channel_glb(
584 struct ltt_ust_session *usess __attribute__((unused)),
585 struct ltt_ust_channel *uchan __attribute__((unused)),
586 struct ltt_ust_context *uctx __attribute__((unused)))
592 int ust_app_enable_event_pid(
593 struct ltt_ust_session *usess __attribute__((unused)),
594 struct ltt_ust_channel *uchan __attribute__((unused)),
595 struct ltt_ust_event *uevent __attribute__((unused)),
596 pid_t pid __attribute__((unused)))
602 int ust_app_recv_registration(
603 int sock __attribute__((unused)),
604 struct ust_register_msg *msg __attribute__((unused)))
610 int ust_app_recv_notify(int sock __attribute__((unused)))
616 struct ust_app *ust_app_create(
617 struct ust_register_msg *msg __attribute__((unused)),
618 int sock __attribute__((unused)))
624 void ust_app_add(struct ust_app *app __attribute__((unused)))
629 void ust_app_notify_sock_unregister(int sock __attribute__((unused)))
634 ssize_t ust_app_push_metadata(
635 lttng::sessiond::ust::registry_session *registry __attribute__((unused)),
636 struct consumer_socket *socket __attribute__((unused)),
637 int send_zero_data __attribute__((unused)))
643 void ust_app_destroy(struct ust_app *app __attribute__((unused)))
649 enum lttng_error_code ust_app_snapshot_record(
650 struct ltt_ust_session *usess __attribute__((unused)),
651 const struct consumer_output *output __attribute__((unused)),
652 uint64_t max_stream_size __attribute__((unused)))
654 return LTTNG_ERR_UNK;
658 unsigned int ust_app_get_nb_stream(
659 struct ltt_ust_session *usess __attribute__((unused)))
665 void ust_app_update_event_notifier_error_count(
666 struct lttng_trigger *lttng_trigger __attribute__((unused)))
672 int ust_app_supported(void)
678 bool ust_app_supports_notifiers(
679 const struct ust_app *app __attribute__((unused)))
685 bool ust_app_supports_counters(
686 const struct ust_app *app __attribute__((unused)))
692 struct ust_app *ust_app_find_by_sock(int sock __attribute__((unused)))
698 struct ust_app *ust_app_find_by_pid(pid_t pid __attribute__((unused)))
704 uint64_t ust_app_get_size_one_more_packet_per_stream(
705 const struct ltt_ust_session *usess __attribute__((unused)),
706 uint64_t cur_nr_packets __attribute__((unused))) {
711 int ust_app_uid_get_channel_runtime_stats(
712 uint64_t ust_session_id __attribute__((unused)),
713 struct cds_list_head *buffer_reg_uid_list __attribute__((unused)),
714 struct consumer_output *consumer __attribute__((unused)),
715 int overwrite __attribute__((unused)),
716 uint64_t uchan_id __attribute__((unused)),
717 uint64_t *discarded __attribute__((unused)),
718 uint64_t *lost __attribute__((unused)))
724 int ust_app_pid_get_channel_runtime_stats(
725 struct ltt_ust_session *usess __attribute__((unused)),
726 struct ltt_ust_channel *uchan __attribute__((unused)),
727 struct consumer_output *consumer __attribute__((unused)),
728 int overwrite __attribute__((unused)),
729 uint64_t *discarded __attribute__((unused)),
730 uint64_t *lost __attribute__((unused)))
736 int ust_app_regenerate_statedump_all(
737 struct ltt_ust_session *usess __attribute__((unused)))
743 enum lttng_error_code ust_app_rotate_session(
744 struct ltt_session *session __attribute__((unused)))
746 return LTTNG_ERR_UNK;
750 enum lttng_error_code ust_app_create_channel_subdirectories(
751 const struct ltt_ust_session *session __attribute__((unused)))
753 return LTTNG_ERR_UNK;
757 int ust_app_release_object(struct ust_app *app __attribute__((unused)),
758 struct lttng_ust_abi_object_data *data __attribute__((unused)))
764 enum lttng_error_code ust_app_clear_session(
765 struct ltt_session *session __attribute__((unused)))
767 return LTTNG_ERR_UNK;
771 enum lttng_error_code ust_app_open_packets(
772 struct ltt_session *session __attribute__((unused)))
774 return LTTNG_ERR_UNK;
777 #endif /* HAVE_LIBLTTNG_UST_CTL */
779 #endif /* _LTT_UST_APP_H */