2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 #ifndef _LTT_UST_APP_H
19 #define _LTT_UST_APP_H
23 #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_ust_filter_bytecode
*filter
;
52 enum lttng_ust_loglevel_type loglevel
;
53 const struct lttng_ust_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 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_ust_filter_bytecode
*filter
;
119 struct lttng_ust_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. */
137 /* Unique key used to identify the channel on the consumer side. */
139 /* Id of the tracing channel set on creation. */
140 uint64_t tracing_channel_id
;
141 /* Number of stream that this channel is expected to receive. */
142 unsigned int expected_stream_count
;
143 char name
[LTTNG_UST_SYM_NAME_LEN
];
144 struct lttng_ust_object_data
*obj
;
145 struct ustctl_consumer_channel_attr attr
;
146 struct ust_app_stream_list streams
;
147 /* Session pointer that owns this object. */
148 struct ust_app_session
*session
;
150 * Contexts are kept in a hash table for fast lookup and in an ordered list
151 * so we are able to enable them on the tracer side in the same order the
154 struct lttng_ht
*ctx
;
155 struct cds_list_head ctx_list
;
157 struct lttng_ht
*events
;
158 uint64_t tracefile_size
;
159 uint64_t tracefile_count
;
161 * Node indexed by channel name in the channels' hash table of a session.
163 struct lttng_ht_node_str node
;
165 * Node indexed by UST channel object descriptor (handle). Stored in the
166 * ust_objd hash table in the ust_app object.
168 struct lttng_ht_node_ulong ust_objd_node
;
169 /* For delayed reclaim */
170 struct rcu_head rcu_head
;
173 struct ust_app_session
{
175 * Lock protecting this session's ust app interaction. Held
176 * across command send/recv to/from app. Never nests within the
177 * session registry lock.
179 pthread_mutex_t lock
;
182 /* started: has the session been in started state at any time ? */
183 int started
; /* allows detection of start vs restart. */
184 int handle
; /* used has unique identifier for app session */
187 * Tracing session ID. Multiple ust app session can have the same tracing
188 * session id making this value NOT unique to the object.
191 uint64_t id
; /* Unique session identifier */
192 struct lttng_ht
*channels
; /* Registered channels */
193 struct lttng_ht_node_u64 node
;
195 /* UID/GID of the application owning the session */
198 /* Effective UID and GID. Same as the tracing session. */
201 struct cds_list_head teardown_node
;
203 * Once at least *one* session is created onto the application, the
204 * corresponding consumer is set so we can use it on unregistration.
206 struct consumer_output
*consumer
;
207 enum lttng_buffer_type buffer_type
;
208 /* ABI of the session. Same value as the application. */
209 uint32_t bits_per_long
;
210 /* For delayed reclaim */
211 struct rcu_head rcu_head
;
212 /* If the channel's streams have to be outputed or not. */
213 unsigned int output_traces
;
214 unsigned int live_timer_interval
; /* usec */
216 /* Metadata channel attributes. */
217 struct ustctl_consumer_channel_attr metadata_attr
;
221 * Registered traceable applications. Libust registers to the session daemon
222 * and a linked list is kept of all running traceable app.
229 uid_t uid
; /* User ID that owns the apps */
230 gid_t gid
; /* Group ID that owns the apps */
233 uint32_t bits_per_long
;
234 uint32_t uint8_t_alignment
;
235 uint32_t uint16_t_alignment
;
236 uint32_t uint32_t_alignment
;
237 uint32_t uint64_t_alignment
;
238 uint32_t long_alignment
;
239 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
241 int compatible
; /* If the lttng-ust tracer version does not match the
242 supported version of the session daemon, this flag is
243 set to 0 (NOT compatible) else 1. */
244 struct lttng_ust_tracer_version version
;
245 uint32_t v_major
; /* Version major number */
246 uint32_t v_minor
; /* Version minor number */
247 /* Extra for the NULL byte. */
248 char name
[UST_APP_PROCNAME_LEN
+ 1];
249 /* Type of buffer this application uses. */
250 enum lttng_buffer_type buffer_type
;
251 struct lttng_ht
*sessions
;
252 struct lttng_ht_node_ulong pid_n
;
253 struct lttng_ht_node_ulong sock_n
;
254 struct lttng_ht_node_ulong notify_sock_n
;
256 * This is a list of ust app session that, once the app is going into
257 * teardown mode, in the RCU call, each node in this list is removed and
260 * Element of the list are added when an application unregisters after each
261 * ht_del of ust_app_session associated to this app. This list is NOT used
262 * when a session is destroyed.
264 struct cds_list_head teardown_head
;
266 * Hash table containing ust_app_channel indexed by channel objd.
268 struct lttng_ht
*ust_objd
;
270 * If this application is of the JUL domain and this is non negative then a
271 * lookup MUST be done to acquire a read side reference to the
272 * corresponding JUL app object. If the lookup fails, this should be set to
273 * a negative value indicating that the JUL application is gone.
278 #ifdef HAVE_LIBLTTNG_UST_CTL
280 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
282 int ust_app_register_done(int sock
)
284 return ustctl_register_done(sock
);
286 int ust_app_version(struct ust_app
*app
);
287 void ust_app_unregister(int sock
);
288 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
289 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
290 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
291 int ust_app_list_events(struct lttng_event
**events
);
292 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
293 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
294 struct ltt_ust_channel
*uchan
);
295 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
296 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
297 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
298 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
300 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
301 struct ltt_ust_channel
*uchan
);
302 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
303 struct ltt_ust_channel
*uchan
);
304 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
305 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
306 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
307 struct ltt_ust_channel
*uchan
);
308 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
309 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
310 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
311 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
312 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
);
314 void ust_app_clean_list(void);
315 void ust_app_ht_alloc(void);
316 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
317 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
);
318 struct ust_app_stream
*ust_app_alloc_stream(void);
319 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
);
320 int ust_app_recv_notify(int sock
);
321 void ust_app_add(struct ust_app
*app
);
322 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
);
323 void ust_app_notify_sock_unregister(int sock
);
324 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
325 struct consumer_socket
*socket
, int send_zero_data
);
326 void ust_app_destroy(struct ust_app
*app
);
327 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
328 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
);
329 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
);
330 struct ust_app
*ust_app_find_by_sock(int sock
);
333 int ust_app_supported(void)
338 #else /* HAVE_LIBLTTNG_UST_CTL */
341 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
346 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
351 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
356 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
361 int ust_app_list_events(struct lttng_event
**events
)
366 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
371 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
376 int ust_app_register_done(int sock
)
381 int ust_app_version(struct ust_app
*app
)
386 void ust_app_unregister(int sock
)
390 void ust_app_lock_list(void)
394 void ust_app_unlock_list(void)
398 void ust_app_clean_list(void)
402 struct ust_app_list
*ust_app_get_list(void)
407 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
412 void ust_app_ht_alloc(void)
415 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
418 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
419 struct ltt_ust_channel
*uchan
)
424 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
425 struct ltt_ust_channel
*uchan
)
430 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
431 struct ltt_ust_channel
*uchan
)
436 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
437 struct ltt_ust_channel
*uchan
)
442 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
443 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
448 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
449 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
454 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
455 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
460 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
461 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
466 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
467 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
473 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
478 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
483 int ust_app_recv_notify(int sock
)
488 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
493 void ust_app_add(struct ust_app
*app
)
497 void ust_app_notify_sock_unregister(int sock
)
501 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
502 struct consumer_socket
*socket
, int send_zero_data
)
507 void ust_app_destroy(struct ust_app
*app
)
512 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
513 struct snapshot_output
*output
, int wait
, unsigned int nb_stream
)
518 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
524 int ust_app_supported(void)
529 struct ust_app
*ust_app_find_by_sock(int sock
)
534 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
539 #endif /* HAVE_LIBLTTNG_UST_CTL */
541 #endif /* _LTT_UST_APP_H */