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 {
148 * Unique key used to identify the channel on the consumer side.
149 * 0 is a reserved 'invalid' value used to indicate that the consumer
150 * does not know about this channel (i.e. an error occurred).
153 /* Id of the tracing channel set on creation. */
154 uint64_t tracing_channel_id;
155 /* Number of stream that this channel is expected to receive. */
156 unsigned int expected_stream_count;
157 char name[LTTNG_UST_ABI_SYM_NAME_LEN];
158 struct lttng_ust_abi_object_data *obj;
159 struct lttng_ust_ctl_consumer_channel_attr attr;
160 struct ust_app_stream_list streams;
161 /* Session pointer that owns this object. */
162 struct ust_app_session *session;
164 * Contexts are kept in a hash table for fast lookup and in an ordered list
165 * so we are able to enable them on the tracer side in the same order the
168 struct lttng_ht *ctx;
169 struct cds_list_head ctx_list;
171 struct lttng_ht *events;
172 uint64_t tracefile_size;
173 uint64_t tracefile_count;
174 uint64_t monitor_timer_interval;
176 * Node indexed by channel name in the channels' hash table of a session.
178 struct lttng_ht_node_str node;
180 * Node indexed by UST channel object descriptor (handle). Stored in the
181 * ust_objd hash table in the ust_app object.
183 struct lttng_ht_node_ulong ust_objd_node;
184 /* For delayed reclaim */
185 struct rcu_head rcu_head;
188 struct ust_app_session {
190 * Lock protecting this session's ust app interaction. Held
191 * across command send/recv to/from app. Never nests within the
192 * session registry lock.
194 pthread_mutex_t lock;
197 /* started: has the session been in started state at any time ? */
198 int started; /* allows detection of start vs restart. */
199 int handle; /* used has unique identifier for app session */
201 bool deleted; /* Session deleted flag. Check with lock held. */
204 * Tracing session ID. Multiple ust app session can have the same tracing
205 * session id making this value NOT unique to the object.
208 uint64_t id; /* Unique session identifier */
209 struct lttng_ht *channels; /* Registered channels */
210 struct lttng_ht_node_u64 node;
212 * Node indexed by UST session object descriptor (handle). Stored in the
213 * ust_sessions_objd hash table in the ust_app object.
215 struct lttng_ht_node_ulong ust_objd_node;
216 /* Starts with 'ust'; no leading slash. */
218 /* UID/GID of the application owning the session */
219 struct lttng_credentials real_credentials;
220 /* Effective UID and GID. Same as the tracing session. */
221 struct lttng_credentials effective_credentials;
222 struct cds_list_head teardown_node;
224 * Once at least *one* session is created onto the application, the
225 * corresponding consumer is set so we can use it on unregistration.
227 struct consumer_output *consumer;
228 enum lttng_buffer_type buffer_type;
229 /* ABI of the session. Same value as the application. */
230 uint32_t bits_per_long;
231 /* For delayed reclaim */
232 struct rcu_head rcu_head;
233 /* If the channel's streams have to be outputed or not. */
234 unsigned int output_traces;
235 unsigned int live_timer_interval; /* usec */
237 /* Metadata channel attributes. */
238 struct lttng_ust_ctl_consumer_channel_attr metadata_attr;
240 char root_shm_path[PATH_MAX];
241 char shm_path[PATH_MAX];
245 * Registered traceable applications. Libust registers to the session daemon
246 * and a linked list is kept of all running traceable app.
250 pthread_mutex_t sock_lock; /* Protects sock protocol. */
255 uid_t uid; /* User ID that owns the apps */
256 gid_t gid; /* Group ID that owns the apps */
259 uint32_t bits_per_long;
260 uint32_t uint8_t_alignment;
261 uint32_t uint16_t_alignment;
262 uint32_t uint32_t_alignment;
263 uint32_t uint64_t_alignment;
264 uint32_t long_alignment;
265 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
267 int compatible; /* If the lttng-ust tracer version does not match the
268 supported version of the session daemon, this flag is
269 set to 0 (NOT compatible) else 1. */
270 struct lttng_ust_abi_tracer_version version;
271 uint32_t v_major; /* Version major number */
272 uint32_t v_minor; /* Version minor number */
273 /* Extra for the NULL byte. */
274 char name[UST_APP_PROCNAME_LEN + 1];
275 /* Type of buffer this application uses. */
276 enum lttng_buffer_type buffer_type;
277 struct lttng_ht *sessions;
278 struct lttng_ht_node_ulong pid_n;
279 struct lttng_ht_node_ulong sock_n;
280 struct lttng_ht_node_ulong notify_sock_n;
282 * This is a list of ust app session that, once the app is going into
283 * teardown mode, in the RCU call, each node in this list is removed and
286 * Element of the list are added when an application unregisters after each
287 * ht_del of ust_app_session associated to this app. This list is NOT used
288 * when a session is destroyed.
290 struct cds_list_head teardown_head;
292 * Hash table containing ust_app_channel indexed by channel objd.
294 struct lttng_ht *ust_objd;
296 * Hash table containing ust_app_session indexed by objd.
298 struct lttng_ht *ust_sessions_objd;
301 * If this application is of the agent domain and this is non negative then
302 * a lookup MUST be done to acquire a read side reference to the
303 * corresponding agent app object. If the lookup fails, this should be set
304 * to a negative value indicating that the agent application is gone.
308 * Time at which the app is registred.
309 * Used for path creation
311 time_t registration_time;
317 * Handle to the lttng_ust object representing the event
320 struct lttng_ust_abi_object_data *object;
321 struct lttng_pipe *event_pipe;
322 struct lttng_ust_abi_object_data *counter;
323 struct lttng_ust_abi_object_data **counter_cpu;
325 } event_notifier_group;
327 * Hashtable indexing the application's event notifier rule's
328 * (ust_app_event_notifier_rule) by their token's value.
330 struct lttng_ht *token_to_event_notifier_rule_ht;
333 #ifdef HAVE_LIBLTTNG_UST_CTL
335 int ust_app_register(struct ust_register_msg *msg, int sock);
336 int ust_app_register_done(struct ust_app *app);
337 int ust_app_version(struct ust_app *app);
338 void ust_app_unregister(int sock);
339 int ust_app_start_trace_all(struct ltt_ust_session *usess);
340 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
341 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
342 int ust_app_list_events(struct lttng_event **events);
343 int ust_app_list_event_fields(struct lttng_event_field **fields);
344 int ust_app_create_event_glb(struct ltt_ust_session *usess,
345 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
346 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
347 struct ltt_ust_channel *uchan);
348 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
349 struct ltt_ust_channel *uchan);
350 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
351 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
352 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
353 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
354 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
355 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
356 void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
357 void ust_app_global_update_all(struct ltt_ust_session *usess);
358 void ust_app_global_update_event_notifier_rules(struct ust_app *app);
359 void ust_app_global_update_all_event_notifier_rules(void);
361 void ust_app_clean_list(void);
362 int ust_app_ht_alloc(void);
363 struct ust_app *ust_app_find_by_pid(pid_t pid);
364 struct ust_app_stream *ust_app_alloc_stream(void);
365 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
366 int ust_app_recv_notify(int sock);
367 void ust_app_add(struct ust_app *app);
368 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
369 void ust_app_notify_sock_unregister(int sock);
370 ssize_t ust_app_push_metadata(ust_registry_session *registry,
371 struct consumer_socket *socket, int send_zero_data);
372 void ust_app_destroy(struct ust_app *app);
373 enum lttng_error_code ust_app_snapshot_record(
374 const struct ltt_ust_session *usess,
375 const struct consumer_output *output,
376 uint64_t nb_packets_per_stream);
377 uint64_t ust_app_get_size_one_more_packet_per_stream(
378 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
379 struct ust_app *ust_app_find_by_sock(int sock);
380 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
381 struct cds_list_head *buffer_reg_uid_list,
382 struct consumer_output *consumer, uint64_t uchan_id,
383 int overwrite, uint64_t *discarded, uint64_t *lost);
384 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
385 struct ltt_ust_channel *uchan,
386 struct consumer_output *consumer,
387 int overwrite, uint64_t *discarded, uint64_t *lost);
388 int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
389 enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
390 enum lttng_error_code ust_app_create_channel_subdirectories(
391 const struct ltt_ust_session *session);
392 int ust_app_release_object(struct ust_app *app,
393 struct lttng_ust_abi_object_data *data);
394 enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
395 enum lttng_error_code ust_app_open_packets(struct ltt_session *session);
397 int ust_app_setup_event_notifier_group(struct ust_app *app);
400 int ust_app_supported(void)
405 bool ust_app_supports_notifiers(const struct ust_app *app);
406 bool ust_app_supports_counters(const struct ust_app *app);
408 #else /* HAVE_LIBLTTNG_UST_CTL */
411 int ust_app_destroy_trace_all(
412 struct ltt_ust_session *usess __attribute__((unused)))
418 int ust_app_start_trace(
419 struct ltt_ust_session *usess __attribute__((unused)),
420 struct ust_app *app __attribute__((unused)))
426 int ust_app_start_trace_all(
427 struct ltt_ust_session *usess __attribute__((unused)))
433 int ust_app_stop_trace_all(
434 struct ltt_ust_session *usess __attribute__((unused)))
440 int ust_app_list_events(
441 struct lttng_event **events __attribute__((unused)))
447 int ust_app_list_event_fields(
448 struct lttng_event_field **fields __attribute__((unused)))
454 int ust_app_register(
455 struct ust_register_msg *msg __attribute__((unused)),
456 int sock __attribute__((unused)))
462 int ust_app_register_done(struct ust_app *app __attribute__((unused)))
468 int ust_app_version(struct ust_app *app __attribute__((unused)))
474 void ust_app_unregister(int sock __attribute__((unused)))
479 void ust_app_clean_list(void)
484 struct ust_app_list *ust_app_get_list(void)
490 struct ust_app *ust_app_get_by_pid(pid_t pid __attribute__((unused)))
496 int ust_app_ht_alloc(void)
502 void ust_app_global_update(
503 struct ltt_ust_session *usess __attribute__((unused)),
504 struct ust_app *app __attribute__((unused)))
508 void ust_app_global_update_event_notifier_rules(
509 struct ust_app *app __attribute__((unused)))
513 void ust_app_global_update_all_event_notifier_rules(void)
517 int ust_app_setup_event_notifier_group(
518 struct ust_app *app __attribute__((unused)))
524 int ust_app_disable_channel_glb(
525 struct ltt_ust_session *usess __attribute__((unused)),
526 struct ltt_ust_channel *uchan __attribute__((unused)))
532 int ust_app_enable_channel_glb(
533 struct ltt_ust_session *usess __attribute__((unused)),
534 struct ltt_ust_channel *uchan __attribute__((unused)))
540 int ust_app_create_event_glb(
541 struct ltt_ust_session *usess __attribute__((unused)),
542 struct ltt_ust_channel *uchan __attribute__((unused)),
543 struct ltt_ust_event *uevent __attribute__((unused)))
549 int ust_app_disable_event_glb(
550 struct ltt_ust_session *usess __attribute__((unused)),
551 struct ltt_ust_channel *uchan __attribute__((unused)),
552 struct ltt_ust_event *uevent __attribute__((unused)))
558 int ust_app_enable_event_glb(
559 struct ltt_ust_session *usess __attribute__((unused)),
560 struct ltt_ust_channel *uchan __attribute__((unused)),
561 struct ltt_ust_event *uevent __attribute__((unused)))
567 int ust_app_add_ctx_channel_glb(
568 struct ltt_ust_session *usess __attribute__((unused)),
569 struct ltt_ust_channel *uchan __attribute__((unused)),
570 struct ltt_ust_context *uctx __attribute__((unused)))
576 int ust_app_enable_event_pid(
577 struct ltt_ust_session *usess __attribute__((unused)),
578 struct ltt_ust_channel *uchan __attribute__((unused)),
579 struct ltt_ust_event *uevent __attribute__((unused)),
580 pid_t pid __attribute__((unused)))
586 int ust_app_recv_registration(
587 int sock __attribute__((unused)),
588 struct ust_register_msg *msg __attribute__((unused)))
594 int ust_app_recv_notify(int sock __attribute__((unused)))
600 struct ust_app *ust_app_create(
601 struct ust_register_msg *msg __attribute__((unused)),
602 int sock __attribute__((unused)))
608 void ust_app_add(struct ust_app *app __attribute__((unused)))
613 void ust_app_notify_sock_unregister(int sock __attribute__((unused)))
618 ssize_t ust_app_push_metadata(
619 ust_registry_session *registry __attribute__((unused)),
620 struct consumer_socket *socket __attribute__((unused)),
621 int send_zero_data __attribute__((unused)))
627 void ust_app_destroy(struct ust_app *app __attribute__((unused)))
633 enum lttng_error_code ust_app_snapshot_record(
634 struct ltt_ust_session *usess __attribute__((unused)),
635 const struct consumer_output *output __attribute__((unused)),
636 uint64_t max_stream_size __attribute__((unused)))
638 return LTTNG_ERR_UNK;
642 unsigned int ust_app_get_nb_stream(
643 struct ltt_ust_session *usess __attribute__((unused)))
649 void ust_app_update_event_notifier_error_count(
650 struct lttng_trigger *lttng_trigger __attribute__((unused)))
656 int ust_app_supported(void)
662 bool ust_app_supports_notifiers(
663 const struct ust_app *app __attribute__((unused)))
669 bool ust_app_supports_counters(
670 const struct ust_app *app __attribute__((unused)))
676 struct ust_app *ust_app_find_by_sock(int sock __attribute__((unused)))
682 struct ust_app *ust_app_find_by_pid(pid_t pid __attribute__((unused)))
688 uint64_t ust_app_get_size_one_more_packet_per_stream(
689 const struct ltt_ust_session *usess __attribute__((unused)),
690 uint64_t cur_nr_packets __attribute__((unused))) {
695 int ust_app_uid_get_channel_runtime_stats(
696 uint64_t ust_session_id __attribute__((unused)),
697 struct cds_list_head *buffer_reg_uid_list __attribute__((unused)),
698 struct consumer_output *consumer __attribute__((unused)),
699 int overwrite __attribute__((unused)),
700 uint64_t uchan_id __attribute__((unused)),
701 uint64_t *discarded __attribute__((unused)),
702 uint64_t *lost __attribute__((unused)))
708 int ust_app_pid_get_channel_runtime_stats(
709 struct ltt_ust_session *usess __attribute__((unused)),
710 struct ltt_ust_channel *uchan __attribute__((unused)),
711 struct consumer_output *consumer __attribute__((unused)),
712 int overwrite __attribute__((unused)),
713 uint64_t *discarded __attribute__((unused)),
714 uint64_t *lost __attribute__((unused)))
720 int ust_app_regenerate_statedump_all(
721 struct ltt_ust_session *usess __attribute__((unused)))
727 enum lttng_error_code ust_app_rotate_session(
728 struct ltt_session *session __attribute__((unused)))
730 return LTTNG_ERR_UNK;
734 enum lttng_error_code ust_app_create_channel_subdirectories(
735 const struct ltt_ust_session *session __attribute__((unused)))
737 return LTTNG_ERR_UNK;
741 int ust_app_release_object(struct ust_app *app __attribute__((unused)),
742 struct lttng_ust_abi_object_data *data __attribute__((unused)))
748 enum lttng_error_code ust_app_clear_session(
749 struct ltt_session *session __attribute__((unused)))
751 return LTTNG_ERR_UNK;
755 enum lttng_error_code ust_app_open_packets(
756 struct ltt_session *session __attribute__((unused)))
758 return LTTNG_ERR_UNK;
761 #endif /* HAVE_LIBLTTNG_UST_CTL */
763 #endif /* _LTT_UST_APP_H */