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/uuid.hpp>
17 #include "trace-ust.hpp"
18 #include "ust-registry.hpp"
19 #include "session.hpp"
21 #define UST_APP_EVENT_LIST_SIZE 32
23 /* Process name (short). */
24 #define UST_APP_PROCNAME_LEN 16
26 struct lttng_bytecode;
27 struct lttng_ust_filter_bytecode;
29 extern int the_ust_consumerd64_fd, the_ust_consumerd32_fd;
32 * Object used to close the notify socket in a call_rcu(). Since the
33 * application might not be found, we need an independant object containing the
36 struct ust_app_notify_sock_obj {
41 struct ust_app_ht_key {
43 const struct lttng_bytecode *filter;
44 enum lttng_ust_abi_loglevel_type loglevel_type;
45 const struct lttng_event_exclusion *exclusion;
49 * Application registration data structure.
51 struct ust_register_msg {
52 enum lttng_ust_ctl_socket_type type;
61 uint32_t bits_per_long;
62 uint32_t uint8_t_alignment;
63 uint32_t uint16_t_alignment;
64 uint32_t uint32_t_alignment;
65 uint32_t uint64_t_alignment;
66 uint32_t long_alignment;
67 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
68 char name[LTTNG_UST_ABI_PROCNAME_LEN];
72 * Global applications HT used by the session daemon. This table is indexed by
73 * PID using the pid_n node and pid value of an ust_app.
75 extern struct lttng_ht *ust_app_ht;
78 * Global applications HT used by the session daemon. This table is indexed by
79 * socket using the sock_n node and sock value of an ust_app.
81 * The 'sock' in question here is the 'command' socket.
83 extern struct lttng_ht *ust_app_ht_by_sock;
86 * Global applications HT used by the session daemon. This table is indexed by
87 * socket using the notify_sock_n node and notify_sock value of an ust_app.
89 extern struct lttng_ht *ust_app_ht_by_notify_sock;
91 /* Stream list containing ust_app_stream. */
92 struct ust_app_stream_list {
94 struct cds_list_head head;
99 struct lttng_ust_context_attr ctx;
100 struct lttng_ust_abi_object_data *obj;
101 struct lttng_ht_node_ulong node;
102 struct cds_list_head list;
105 struct ust_app_event {
108 struct lttng_ust_abi_object_data *obj;
109 struct lttng_ust_abi_event attr;
110 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
111 struct lttng_ht_node_str node;
112 struct lttng_bytecode *filter;
113 struct lttng_event_exclusion *exclusion;
116 struct ust_app_event_notifier_rule {
118 uint64_t error_counter_index;
120 struct lttng_ust_abi_object_data *obj;
121 /* Holds a strong reference. */
122 struct lttng_trigger *trigger;
123 /* Unique ID returned by the tracer to identify this event notifier. */
125 struct lttng_ht_node_u64 node;
126 /* The trigger object owns the filter. */
127 const struct lttng_bytecode *filter;
129 struct lttng_event_exclusion *exclusion;
130 /* For delayed reclaim. */
131 struct rcu_head rcu_head;
134 struct ust_app_stream {
136 char pathname[PATH_MAX];
137 /* Format is %s_%d respectively channel name and CPU number. */
138 char name[DEFAULT_STREAM_NAME_LEN];
139 struct lttng_ust_abi_object_data *obj;
140 /* Using a list of streams to keep order. */
141 struct cds_list_head list;
144 struct ust_app_channel {
147 /* Channel and streams were sent to the UST tracer. */
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 uint32_t bits_per_long;
262 uint32_t uint8_t_alignment;
263 uint32_t uint16_t_alignment;
264 uint32_t uint32_t_alignment;
265 uint32_t uint64_t_alignment;
266 uint32_t long_alignment;
267 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
269 int compatible; /* If the lttng-ust tracer version does not match the
270 supported version of the session daemon, this flag is
271 set to 0 (NOT compatible) else 1. */
272 struct lttng_ust_abi_tracer_version version;
273 uint32_t v_major; /* Version major number */
274 uint32_t v_minor; /* Version minor number */
275 /* Extra for the NULL byte. */
276 char name[UST_APP_PROCNAME_LEN + 1];
277 /* Type of buffer this application uses. */
278 enum lttng_buffer_type buffer_type;
279 struct lttng_ht *sessions;
280 struct lttng_ht_node_ulong pid_n;
281 struct lttng_ht_node_ulong sock_n;
282 struct lttng_ht_node_ulong notify_sock_n;
284 * This is a list of ust app session that, once the app is going into
285 * teardown mode, in the RCU call, each node in this list is removed and
288 * Element of the list are added when an application unregisters after each
289 * ht_del of ust_app_session associated to this app. This list is NOT used
290 * when a session is destroyed.
292 struct cds_list_head teardown_head;
294 * Hash table containing ust_app_channel indexed by channel objd.
296 struct lttng_ht *ust_objd;
298 * Hash table containing ust_app_session indexed by objd.
300 struct lttng_ht *ust_sessions_objd;
303 * If this application is of the agent domain and this is non negative then
304 * a lookup MUST be done to acquire a read side reference to the
305 * corresponding agent app object. If the lookup fails, this should be set
306 * to a negative value indicating that the agent application is gone.
310 * Time at which the app is registred.
311 * Used for path creation
313 time_t registration_time;
319 * Handle to the lttng_ust object representing the event
322 struct lttng_ust_abi_object_data *object;
323 struct lttng_pipe *event_pipe;
324 struct lttng_ust_abi_object_data *counter;
325 struct lttng_ust_abi_object_data **counter_cpu;
327 } event_notifier_group;
329 * Hashtable indexing the application's event notifier rule's
330 * (ust_app_event_notifier_rule) by their token's value.
332 struct lttng_ht *token_to_event_notifier_rule_ht;
335 #ifdef HAVE_LIBLTTNG_UST_CTL
337 int ust_app_register(struct ust_register_msg *msg, int sock);
338 int ust_app_register_done(struct ust_app *app);
339 int ust_app_version(struct ust_app *app);
340 void ust_app_unregister(int sock);
341 int ust_app_start_trace_all(struct ltt_ust_session *usess);
342 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
343 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
344 int ust_app_list_events(struct lttng_event **events);
345 int ust_app_list_event_fields(struct lttng_event_field **fields);
346 int ust_app_create_event_glb(struct ltt_ust_session *usess,
347 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
348 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
349 struct ltt_ust_channel *uchan);
350 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
351 struct ltt_ust_channel *uchan);
352 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
353 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
354 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
355 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
356 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
357 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
358 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
359 void ust_app_global_update_all(struct ltt_ust_session *usess);
360 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
361 void ust_app_global_update_all_event_notifier_rules(void);
363 void ust_app_clean_list(void);
364 int ust_app_ht_alloc(void);
365 struct ust_app *ust_app_find_by_pid(pid_t pid);
366 struct ust_app_stream *ust_app_alloc_stream(void);
367 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
368 int ust_app_recv_notify(int sock);
369 void ust_app_add(struct ust_app *app);
370 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
371 void ust_app_notify_sock_unregister(int sock);
372 ssize_t ust_app_push_metadata(ust_registry_session *registry,
373 struct consumer_socket *socket, int send_zero_data);
374 void ust_app_destroy(struct ust_app *app);
375 enum lttng_error_code ust_app_snapshot_record(
376 const struct ltt_ust_session *usess,
377 const struct consumer_output *output,
378 uint64_t nb_packets_per_stream);
379 uint64_t ust_app_get_size_one_more_packet_per_stream(
380 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
381 struct ust_app *ust_app_find_by_sock(int sock);
382 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
383 struct cds_list_head *buffer_reg_uid_list,
384 struct consumer_output *consumer, uint64_t uchan_id,
385 int overwrite, uint64_t *discarded, uint64_t *lost);
386 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
387 struct ltt_ust_channel *uchan,
388 struct consumer_output *consumer,
389 int overwrite, uint64_t *discarded, uint64_t *lost);
390 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
391 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
392 enum lttng_error_code ust_app_create_channel_subdirectories(
393 const struct ltt_ust_session *session);
394 int ust_app_release_object(struct ust_app *app,
395 struct lttng_ust_abi_object_data *data);
396 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
397 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
399 int ust_app_setup_event_notifier_group(struct ust_app *app);
402 int ust_app_supported(void)
407 bool ust_app_supports_notifiers(const struct ust_app *app);
408 bool ust_app_supports_counters(const struct ust_app *app);
410 #else /* HAVE_LIBLTTNG_UST_CTL */
413 int ust_app_destroy_trace_all(
414 struct ltt_ust_session *usess __attribute__((unused)))
420 int ust_app_start_trace(
421 struct ltt_ust_session *usess __attribute__((unused)),
422 struct ust_app *app __attribute__((unused)))
428 int ust_app_start_trace_all(
429 struct ltt_ust_session *usess __attribute__((unused)))
435 int ust_app_stop_trace_all(
436 struct ltt_ust_session *usess __attribute__((unused)))
442 int ust_app_list_events(
443 struct lttng_event **events __attribute__((unused)))
449 int ust_app_list_event_fields(
450 struct lttng_event_field **fields __attribute__((unused)))
456 int ust_app_register(
457 struct ust_register_msg *msg __attribute__((unused)),
458 int sock __attribute__((unused)))
464 int ust_app_register_done(struct ust_app *app __attribute__((unused)))
470 int ust_app_version(struct ust_app *app __attribute__((unused)))
476 void ust_app_unregister(int sock __attribute__((unused)))
481 void ust_app_clean_list(void)
486 struct ust_app_list *ust_app_get_list(void)
492 struct ust_app *ust_app_get_by_pid(pid_t pid __attribute__((unused)))
498 int ust_app_ht_alloc(void)
504 void ust_app_global_update(
505 struct ltt_ust_session *usess __attribute__((unused)),
506 struct ust_app *app __attribute__((unused)))
510 void ust_app_global_update_event_notifier_rules(
511 struct ust_app *app __attribute__((unused)))
515 void ust_app_global_update_all_event_notifier_rules(void)
519 int ust_app_setup_event_notifier_group(
520 struct ust_app *app __attribute__((unused)))
526 int ust_app_disable_channel_glb(
527 struct ltt_ust_session *usess __attribute__((unused)),
528 struct ltt_ust_channel *uchan __attribute__((unused)))
534 int ust_app_enable_channel_glb(
535 struct ltt_ust_session *usess __attribute__((unused)),
536 struct ltt_ust_channel *uchan __attribute__((unused)))
542 int ust_app_create_event_glb(
543 struct ltt_ust_session *usess __attribute__((unused)),
544 struct ltt_ust_channel *uchan __attribute__((unused)),
545 struct ltt_ust_event *uevent __attribute__((unused)))
551 int ust_app_disable_event_glb(
552 struct ltt_ust_session *usess __attribute__((unused)),
553 struct ltt_ust_channel *uchan __attribute__((unused)),
554 struct ltt_ust_event *uevent __attribute__((unused)))
560 int ust_app_enable_event_glb(
561 struct ltt_ust_session *usess __attribute__((unused)),
562 struct ltt_ust_channel *uchan __attribute__((unused)),
563 struct ltt_ust_event *uevent __attribute__((unused)))
569 int ust_app_add_ctx_channel_glb(
570 struct ltt_ust_session *usess __attribute__((unused)),
571 struct ltt_ust_channel *uchan __attribute__((unused)),
572 struct ltt_ust_context *uctx __attribute__((unused)))
578 int ust_app_enable_event_pid(
579 struct ltt_ust_session *usess __attribute__((unused)),
580 struct ltt_ust_channel *uchan __attribute__((unused)),
581 struct ltt_ust_event *uevent __attribute__((unused)),
582 pid_t pid __attribute__((unused)))
588 int ust_app_recv_registration(
589 int sock __attribute__((unused)),
590 struct ust_register_msg *msg __attribute__((unused)))
596 int ust_app_recv_notify(int sock __attribute__((unused)))
602 struct ust_app *ust_app_create(
603 struct ust_register_msg *msg __attribute__((unused)),
604 int sock __attribute__((unused)))
610 void ust_app_add(struct ust_app *app __attribute__((unused)))
615 void ust_app_notify_sock_unregister(int sock __attribute__((unused)))
620 ssize_t ust_app_push_metadata(
621 ust_registry_session *registry __attribute__((unused)),
622 struct consumer_socket *socket __attribute__((unused)),
623 int send_zero_data __attribute__((unused)))
629 void ust_app_destroy(struct ust_app *app __attribute__((unused)))
635 enum lttng_error_code ust_app_snapshot_record(
636 struct ltt_ust_session *usess __attribute__((unused)),
637 const struct consumer_output *output __attribute__((unused)),
638 uint64_t max_stream_size __attribute__((unused)))
640 return LTTNG_ERR_UNK;
644 unsigned int ust_app_get_nb_stream(
645 struct ltt_ust_session *usess __attribute__((unused)))
651 void ust_app_update_event_notifier_error_count(
652 struct lttng_trigger *lttng_trigger __attribute__((unused)))
658 int ust_app_supported(void)
664 bool ust_app_supports_notifiers(
665 const struct ust_app *app __attribute__((unused)))
671 bool ust_app_supports_counters(
672 const struct ust_app *app __attribute__((unused)))
678 struct ust_app *ust_app_find_by_sock(int sock __attribute__((unused)))
684 struct ust_app *ust_app_find_by_pid(pid_t pid __attribute__((unused)))
690 uint64_t ust_app_get_size_one_more_packet_per_stream(
691 const struct ltt_ust_session *usess __attribute__((unused)),
692 uint64_t cur_nr_packets __attribute__((unused))) {
697 int ust_app_uid_get_channel_runtime_stats(
698 uint64_t ust_session_id __attribute__((unused)),
699 struct cds_list_head *buffer_reg_uid_list __attribute__((unused)),
700 struct consumer_output *consumer __attribute__((unused)),
701 int overwrite __attribute__((unused)),
702 uint64_t uchan_id __attribute__((unused)),
703 uint64_t *discarded __attribute__((unused)),
704 uint64_t *lost __attribute__((unused)))
710 int ust_app_pid_get_channel_runtime_stats(
711 struct ltt_ust_session *usess __attribute__((unused)),
712 struct ltt_ust_channel *uchan __attribute__((unused)),
713 struct consumer_output *consumer __attribute__((unused)),
714 int overwrite __attribute__((unused)),
715 uint64_t *discarded __attribute__((unused)),
716 uint64_t *lost __attribute__((unused)))
722 int ust_app_regenerate_statedump_all(
723 struct ltt_ust_session *usess __attribute__((unused)))
729 enum lttng_error_code ust_app_rotate_session(
730 struct ltt_session *session __attribute__((unused)))
732 return LTTNG_ERR_UNK;
736 enum lttng_error_code ust_app_create_channel_subdirectories(
737 const struct ltt_ust_session *session __attribute__((unused)))
739 return LTTNG_ERR_UNK;
743 int ust_app_release_object(struct ust_app *app __attribute__((unused)),
744 struct lttng_ust_abi_object_data *data __attribute__((unused)))
750 enum lttng_error_code ust_app_clear_session(
751 struct ltt_session *session __attribute__((unused)))
753 return LTTNG_ERR_UNK;
757 enum lttng_error_code ust_app_open_packets(
758 struct ltt_session *session __attribute__((unused)))
760 return LTTNG_ERR_UNK;
763 #endif /* HAVE_LIBLTTNG_UST_CTL */
765 #endif /* _LTT_UST_APP_H */