2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19 #ifndef _LTT_UST_APP_H
20 #define _LTT_UST_APP_H
24 #include <common/compat/uuid.h>
26 #include "trace-ust.h"
27 #include "ust-registry.h"
29 #define UST_APP_EVENT_LIST_SIZE 32
31 /* Process name (short). */
32 #define UST_APP_PROCNAME_LEN 16
34 struct lttng_filter_bytecode
;
35 struct lttng_ust_filter_bytecode
;
37 extern int ust_consumerd64_fd
, ust_consumerd32_fd
;
40 * Object used to close the notify socket in a call_rcu(). Since the
41 * application might not be found, we need an independant object containing the
44 struct ust_app_notify_sock_obj
{
49 struct ust_app_ht_key
{
51 const struct lttng_filter_bytecode
*filter
;
52 enum lttng_ust_loglevel_type loglevel_type
;
53 const struct lttng_event_exclusion
*exclusion
;
57 * Application registration data structure.
59 struct ust_register_msg
{
60 enum ustctl_socket_type type
;
69 uint32_t bits_per_long
;
70 uint32_t uint8_t_alignment
;
71 uint32_t uint16_t_alignment
;
72 uint32_t uint32_t_alignment
;
73 uint32_t uint64_t_alignment
;
74 uint32_t long_alignment
;
75 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
76 char name
[LTTNG_UST_ABI_PROCNAME_LEN
];
80 * Global applications HT used by the session daemon. This table is indexed by
81 * PID using the pid_n node and pid value of an ust_app.
83 struct lttng_ht
*ust_app_ht
;
86 * Global applications HT used by the session daemon. This table is indexed by
87 * socket using the sock_n node and sock value of an ust_app.
89 struct lttng_ht
*ust_app_ht_by_sock
;
92 * Global applications HT used by the session daemon. This table is indexed by
93 * socket using the notify_sock_n node and notify_sock value of an ust_app.
95 struct lttng_ht
*ust_app_ht_by_notify_sock
;
97 /* Stream list containing ust_app_stream. */
98 struct ust_app_stream_list
{
100 struct cds_list_head head
;
105 struct lttng_ust_context_attr ctx
;
106 struct lttng_ust_object_data
*obj
;
107 struct lttng_ht_node_ulong node
;
108 struct cds_list_head list
;
111 struct ust_app_event
{
114 struct lttng_ust_object_data
*obj
;
115 struct lttng_ust_event attr
;
116 char name
[LTTNG_UST_SYM_NAME_LEN
];
117 struct lttng_ht_node_str node
;
118 struct lttng_filter_bytecode
*filter
;
119 struct lttng_event_exclusion
*exclusion
;
122 struct ust_app_stream
{
124 char pathname
[PATH_MAX
];
125 /* Format is %s_%d respectively channel name and CPU number. */
126 char name
[DEFAULT_STREAM_NAME_LEN
];
127 struct lttng_ust_object_data
*obj
;
128 /* Using a list of streams to keep order. */
129 struct cds_list_head list
;
132 struct ust_app_channel
{
135 /* Channel and streams were sent to the UST tracer. */
138 * Unique key used to identify the channel on the consumer side.
139 * 0 is a reserved 'invalid' value used to indicate that the consumer
140 * does not know about this channel (i.e. an error occured).
143 /* Id of the tracing channel set on creation. */
144 uint64_t tracing_channel_id
;
145 /* Number of stream that this channel is expected to receive. */
146 unsigned int expected_stream_count
;
147 char name
[LTTNG_UST_SYM_NAME_LEN
];
148 struct lttng_ust_object_data
*obj
;
149 struct ustctl_consumer_channel_attr attr
;
150 struct ust_app_stream_list streams
;
151 /* Session pointer that owns this object. */
152 struct ust_app_session
*session
;
154 * Contexts are kept in a hash table for fast lookup and in an ordered list
155 * so we are able to enable them on the tracer side in the same order the
158 struct lttng_ht
*ctx
;
159 struct cds_list_head ctx_list
;
161 struct lttng_ht
*events
;
162 uint64_t tracefile_size
;
163 uint64_t tracefile_count
;
164 uint64_t monitor_timer_interval
;
166 * Node indexed by channel name in the channels' hash table of a session.
168 struct lttng_ht_node_str node
;
170 * Node indexed by UST channel object descriptor (handle). Stored in the
171 * ust_objd hash table in the ust_app object.
173 struct lttng_ht_node_ulong ust_objd_node
;
174 /* For delayed reclaim */
175 struct rcu_head rcu_head
;
178 struct ust_app_session
{
180 * Lock protecting this session's ust app interaction. Held
181 * across command send/recv to/from app. Never nests within the
182 * session registry lock.
184 pthread_mutex_t lock
;
187 /* started: has the session been in started state at any time ? */
188 int started
; /* allows detection of start vs restart. */
189 int handle
; /* used has unique identifier for app session */
191 bool deleted
; /* Session deleted flag. Check with lock held. */
194 * Tracing session ID. Multiple ust app session can have the same tracing
195 * session id making this value NOT unique to the object.
198 uint64_t id
; /* Unique session identifier */
199 struct lttng_ht
*channels
; /* Registered channels */
200 struct lttng_ht_node_u64 node
;
202 * Node indexed by UST session object descriptor (handle). Stored in the
203 * ust_sessions_objd hash table in the ust_app object.
205 struct lttng_ht_node_ulong ust_objd_node
;
207 /* UID/GID of the application owning the session */
210 /* Effective UID and GID. Same as the tracing session. */
213 struct cds_list_head teardown_node
;
215 * Once at least *one* session is created onto the application, the
216 * corresponding consumer is set so we can use it on unregistration.
218 struct consumer_output
*consumer
;
219 enum lttng_buffer_type buffer_type
;
220 /* ABI of the session. Same value as the application. */
221 uint32_t bits_per_long
;
222 /* For delayed reclaim */
223 struct rcu_head rcu_head
;
224 /* If the channel's streams have to be outputed or not. */
225 unsigned int output_traces
;
226 unsigned int live_timer_interval
; /* usec */
228 /* Metadata channel attributes. */
229 struct ustctl_consumer_channel_attr metadata_attr
;
231 char root_shm_path
[PATH_MAX
];
232 char shm_path
[PATH_MAX
];
236 * Registered traceable applications. Libust registers to the session daemon
237 * and a linked list is kept of all running traceable app.
241 pthread_mutex_t sock_lock
; /* Protects sock protocol. */
246 uid_t uid
; /* User ID that owns the apps */
247 gid_t gid
; /* Group ID that owns the apps */
250 uint32_t bits_per_long
;
251 uint32_t uint8_t_alignment
;
252 uint32_t uint16_t_alignment
;
253 uint32_t uint32_t_alignment
;
254 uint32_t uint64_t_alignment
;
255 uint32_t long_alignment
;
256 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
258 int compatible
; /* If the lttng-ust tracer version does not match the
259 supported version of the session daemon, this flag is
260 set to 0 (NOT compatible) else 1. */
261 struct lttng_ust_tracer_version version
;
262 uint32_t v_major
; /* Version major number */
263 uint32_t v_minor
; /* Version minor number */
264 /* Extra for the NULL byte. */
265 char name
[UST_APP_PROCNAME_LEN
+ 1];
266 /* Type of buffer this application uses. */
267 enum lttng_buffer_type buffer_type
;
268 struct lttng_ht
*sessions
;
269 struct lttng_ht_node_ulong pid_n
;
270 struct lttng_ht_node_ulong sock_n
;
271 struct lttng_ht_node_ulong notify_sock_n
;
273 * This is a list of ust app session that, once the app is going into
274 * teardown mode, in the RCU call, each node in this list is removed and
277 * Element of the list are added when an application unregisters after each
278 * ht_del of ust_app_session associated to this app. This list is NOT used
279 * when a session is destroyed.
281 struct cds_list_head teardown_head
;
283 * Hash table containing ust_app_channel indexed by channel objd.
285 struct lttng_ht
*ust_objd
;
287 * Hash table containing ust_app_session indexed by objd.
289 struct lttng_ht
*ust_sessions_objd
;
292 * If this application is of the agent domain and this is non negative then
293 * a lookup MUST be done to acquire a read side reference to the
294 * corresponding agent app object. If the lookup fails, this should be set
295 * to a negative value indicating that the agent application is gone.
300 #ifdef HAVE_LIBLTTNG_UST_CTL
302 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
303 int ust_app_register_done(struct ust_app
*app
);
304 int ust_app_version(struct ust_app
*app
);
305 void ust_app_unregister(int sock
);
306 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
307 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
308 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
309 int ust_app_list_events(struct lttng_event
**events
);
310 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
311 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
312 struct ltt_ust_channel
*uchan
);
313 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
314 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
315 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
316 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
318 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
319 struct ltt_ust_channel
*uchan
);
320 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
321 struct ltt_ust_channel
*uchan
);
322 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
323 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
324 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
325 struct ltt_ust_channel
*uchan
);
326 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
327 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
328 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
329 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
330 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
);
331 void ust_app_global_update_all(struct ltt_ust_session
*usess
);
333 void ust_app_clean_list(void);
334 int ust_app_ht_alloc(void);
335 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
336 struct ust_app_stream
*ust_app_alloc_stream(void);
337 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
);
338 int ust_app_recv_notify(int sock
);
339 void ust_app_add(struct ust_app
*app
);
340 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
);
341 void ust_app_notify_sock_unregister(int sock
);
342 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
343 struct consumer_socket
*socket
, int send_zero_data
);
344 void ust_app_destroy(struct ust_app
*app
);
345 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
346 struct snapshot_output
*output
, int wait
,
347 uint64_t nb_packets_per_stream
);
348 uint64_t ust_app_get_size_one_more_packet_per_stream(
349 struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
);
350 struct ust_app
*ust_app_find_by_sock(int sock
);
351 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
352 struct cds_list_head
*buffer_reg_uid_list
,
353 struct consumer_output
*consumer
, uint64_t uchan_id
,
354 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
355 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
356 struct ltt_ust_channel
*uchan
,
357 struct consumer_output
*consumer
,
358 int overwrite
, uint64_t *discarded
, uint64_t *lost
);
359 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
);
362 int ust_app_supported(void)
367 #else /* HAVE_LIBLTTNG_UST_CTL */
370 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
375 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
380 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
385 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
390 int ust_app_list_events(struct lttng_event
**events
)
395 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
400 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
405 int ust_app_register_done(struct ust_app
*app
)
410 int ust_app_version(struct ust_app
*app
)
415 void ust_app_unregister(int sock
)
419 void ust_app_lock_list(void)
423 void ust_app_unlock_list(void)
427 void ust_app_clean_list(void)
431 struct ust_app_list
*ust_app_get_list(void)
436 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
441 int ust_app_ht_alloc(void)
446 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
449 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
450 struct ltt_ust_channel
*uchan
)
455 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
456 struct ltt_ust_channel
*uchan
)
461 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
462 struct ltt_ust_channel
*uchan
)
467 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
468 struct ltt_ust_channel
*uchan
)
473 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
474 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
479 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
480 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
485 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
486 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
491 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
492 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
497 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
498 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
504 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
509 int ust_app_recv_notify(int sock
)
514 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
519 void ust_app_add(struct ust_app
*app
)
523 void ust_app_notify_sock_unregister(int sock
)
527 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
528 struct consumer_socket
*socket
, int send_zero_data
)
533 void ust_app_destroy(struct ust_app
*app
)
538 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
539 struct snapshot_output
*output
, int wait
, uint64_t max_stream_size
)
544 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
550 int ust_app_supported(void)
555 struct ust_app
*ust_app_find_by_sock(int sock
)
560 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
565 uint64_t ust_app_get_size_one_more_packet_per_stream(
566 struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
) {
570 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
571 struct cds_list_head
*buffer_reg_uid_list
,
572 struct consumer_output
*consumer
, int overwrite
,
573 uint64_t uchan_id
, uint64_t *discarded
, uint64_t *lost
)
579 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
580 struct ltt_ust_channel
*uchan
,
581 struct consumer_output
*consumer
,
582 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
588 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
593 #endif /* HAVE_LIBLTTNG_UST_CTL */
595 #endif /* _LTT_UST_APP_H */