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>
24 #include "trace-ust.h"
25 #include "ust-registry.h"
27 #define UST_APP_EVENT_LIST_SIZE 32
29 /* Process name (short). */
30 #define UST_APP_PROCNAME_LEN 16
32 struct lttng_filter_bytecode
;
33 struct lttng_ust_filter_bytecode
;
35 extern int ust_consumerd64_fd
, ust_consumerd32_fd
;
38 * Object used to close the notify socket in a call_rcu(). Since the
39 * application might not be found, we need an independant object containing the
42 struct ust_app_notify_sock_obj
{
47 struct ust_app_ht_key
{
49 const struct lttng_ust_filter_bytecode
*filter
;
50 enum lttng_ust_loglevel_type loglevel
;
54 * Application registration data structure.
56 struct ust_register_msg
{
57 enum ustctl_socket_type type
;
66 uint32_t bits_per_long
;
67 uint32_t uint8_t_alignment
;
68 uint32_t uint16_t_alignment
;
69 uint32_t uint32_t_alignment
;
70 uint32_t uint64_t_alignment
;
71 uint32_t long_alignment
;
72 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
73 char name
[LTTNG_UST_ABI_PROCNAME_LEN
];
77 * Global applications HT used by the session daemon. This table is indexed by
78 * PID using the pid_n node and pid value of an ust_app.
80 struct lttng_ht
*ust_app_ht
;
83 * Global applications HT used by the session daemon. This table is indexed by
84 * socket using the sock_n node and sock value of an ust_app.
86 struct lttng_ht
*ust_app_ht_by_sock
;
89 * Global applications HT used by the session daemon. This table is indexed by
90 * socket using the notify_sock_n node and notify_sock value of an ust_app.
92 struct lttng_ht
*ust_app_ht_by_notify_sock
;
94 /* Stream list containing ust_app_stream. */
95 struct ust_app_stream_list
{
97 struct cds_list_head head
;
102 struct lttng_ust_context ctx
;
103 struct lttng_ust_object_data
*obj
;
104 struct lttng_ht_node_ulong node
;
105 struct cds_list_head list
;
108 struct ust_app_event
{
111 struct lttng_ust_object_data
*obj
;
112 struct lttng_ust_event attr
;
113 char name
[LTTNG_UST_SYM_NAME_LEN
];
114 struct lttng_ht_node_str node
;
115 struct lttng_ust_filter_bytecode
*filter
;
118 struct ust_app_stream
{
120 char pathname
[PATH_MAX
];
121 /* Format is %s_%d respectively channel name and CPU number. */
122 char name
[DEFAULT_STREAM_NAME_LEN
];
123 struct lttng_ust_object_data
*obj
;
124 /* Using a list of streams to keep order. */
125 struct cds_list_head list
;
128 struct ust_app_channel
{
131 /* Channel and streams were sent to the UST tracer. */
133 /* Unique key used to identify the channel on the consumer side. */
135 /* Id of the tracing channel set on creation. */
136 uint64_t tracing_channel_id
;
137 /* Number of stream that this channel is expected to receive. */
138 unsigned int expected_stream_count
;
139 char name
[LTTNG_UST_SYM_NAME_LEN
];
140 struct lttng_ust_object_data
*obj
;
141 struct ustctl_consumer_channel_attr attr
;
142 struct ust_app_stream_list streams
;
143 /* Session pointer that owns this object. */
144 struct ust_app_session
*session
;
146 * Contexts are kept in a hash table for fast lookup and in an ordered list
147 * so we are able to enable them on the tracer side in the same order the
150 struct lttng_ht
*ctx
;
151 struct cds_list_head ctx_list
;
153 struct lttng_ht
*events
;
154 uint64_t tracefile_size
;
155 uint64_t tracefile_count
;
157 * Node indexed by channel name in the channels' hash table of a session.
159 struct lttng_ht_node_str node
;
161 * Node indexed by UST channel object descriptor (handle). Stored in the
162 * ust_objd hash table in the ust_app object.
164 struct lttng_ht_node_ulong ust_objd_node
;
165 /* For delayed reclaim */
166 struct rcu_head rcu_head
;
169 struct ust_app_session
{
171 * Lock protecting this session's ust app interaction. Held
172 * across command send/recv to/from app. Never nests within the
173 * session registry lock.
175 pthread_mutex_t lock
;
178 /* started: has the session been in started state at any time ? */
179 int started
; /* allows detection of start vs restart. */
180 int handle
; /* used has unique identifier for app session */
183 * Tracing session ID. Multiple ust app session can have the same tracing
184 * session id making this value NOT unique to the object.
187 uint64_t id
; /* Unique session identifier */
188 struct lttng_ht
*channels
; /* Registered channels */
189 struct lttng_ht_node_u64 node
;
191 /* UID/GID of the application owning the session */
194 /* Effective UID and GID. Same as the tracing session. */
197 struct cds_list_head teardown_node
;
199 * Once at least *one* session is created onto the application, the
200 * corresponding consumer is set so we can use it on unregistration.
202 struct consumer_output
*consumer
;
203 enum lttng_buffer_type buffer_type
;
204 /* ABI of the session. Same value as the application. */
205 uint32_t bits_per_long
;
206 /* For delayed reclaim */
207 struct rcu_head rcu_head
;
208 /* If the channel's streams have to be outputed or not. */
209 unsigned int output_traces
;
210 unsigned int live_timer_interval
; /* usec */
214 * Registered traceable applications. Libust registers to the session daemon
215 * and a linked list is kept of all running traceable app.
222 uid_t uid
; /* User ID that owns the apps */
223 gid_t gid
; /* Group ID that owns the apps */
226 uint32_t bits_per_long
;
227 uint32_t uint8_t_alignment
;
228 uint32_t uint16_t_alignment
;
229 uint32_t uint32_t_alignment
;
230 uint32_t uint64_t_alignment
;
231 uint32_t long_alignment
;
232 int byte_order
; /* BIG_ENDIAN or LITTLE_ENDIAN */
234 int compatible
; /* If the lttng-ust tracer version does not match the
235 supported version of the session daemon, this flag is
236 set to 0 (NOT compatible) else 1. */
237 struct lttng_ust_tracer_version version
;
238 uint32_t v_major
; /* Version major number */
239 uint32_t v_minor
; /* Version minor number */
240 /* Extra for the NULL byte. */
241 char name
[UST_APP_PROCNAME_LEN
+ 1];
242 /* Type of buffer this application uses. */
243 enum lttng_buffer_type buffer_type
;
244 struct lttng_ht
*sessions
;
245 struct lttng_ht_node_ulong pid_n
;
246 struct lttng_ht_node_ulong sock_n
;
247 struct lttng_ht_node_ulong notify_sock_n
;
249 * This is a list of ust app session that, once the app is going into
250 * teardown mode, in the RCU call, each node in this list is removed and
253 * Element of the list are added when an application unregisters after each
254 * ht_del of ust_app_session associated to this app. This list is NOT used
255 * when a session is destroyed.
257 struct cds_list_head teardown_head
;
259 * Hash table containing ust_app_channel indexed by channel objd.
261 struct lttng_ht
*ust_objd
;
264 #ifdef HAVE_LIBLTTNG_UST_CTL
266 int ust_app_register(struct ust_register_msg
*msg
, int sock
);
268 int ust_app_register_done(int sock
)
270 return ustctl_register_done(sock
);
272 int ust_app_version(struct ust_app
*app
);
273 void ust_app_unregister(int sock
);
274 unsigned long ust_app_list_count(void);
275 int ust_app_start_trace_all(struct ltt_ust_session
*usess
);
276 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
);
277 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
);
278 int ust_app_list_events(struct lttng_event
**events
);
279 int ust_app_list_event_fields(struct lttng_event_field
**fields
);
280 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
281 struct ltt_ust_channel
*uchan
);
282 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
283 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
284 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
285 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
287 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
288 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
290 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
291 struct ltt_ust_channel
*uchan
);
292 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
293 struct ltt_ust_channel
*uchan
);
294 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
295 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
296 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
297 struct ltt_ust_channel
*uchan
);
298 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
299 struct ltt_ust_channel
*uchan
);
300 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
301 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
);
302 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
303 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
);
304 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
);
306 void ust_app_clean_list(void);
307 void ust_app_ht_alloc(void);
308 struct lttng_ht
*ust_app_get_ht(void);
309 struct ust_app
*ust_app_find_by_pid(pid_t pid
);
310 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
);
311 struct ust_app_stream
*ust_app_alloc_stream(void);
312 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
);
313 int ust_app_recv_notify(int sock
);
314 void ust_app_add(struct ust_app
*app
);
315 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
);
316 void ust_app_notify_sock_unregister(int sock
);
317 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
318 struct consumer_socket
*socket
, int send_zero_data
);
319 void ust_app_destroy(struct ust_app
*app
);
320 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
321 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
);
322 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
);
325 int ust_app_supported(void)
330 #else /* HAVE_LIBLTTNG_UST_CTL */
333 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
338 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
343 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
348 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
353 int ust_app_list_events(struct lttng_event
**events
)
358 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
363 int ust_app_register(struct ust_register_msg
*msg
, int sock
)
368 int ust_app_register_done(int sock
)
373 int ust_app_version(struct ust_app
*app
)
378 void ust_app_unregister(int sock
)
382 unsigned int ust_app_list_count(void)
387 void ust_app_lock_list(void)
391 void ust_app_unlock_list(void)
395 void ust_app_clean_list(void)
399 struct ust_app_list
*ust_app_get_list(void)
404 struct ust_app
*ust_app_get_by_pid(pid_t pid
)
409 struct lttng_ht
*ust_app_get_ht(void)
414 void ust_app_ht_alloc(void)
417 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
420 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
421 struct ltt_ust_channel
*uchan
)
426 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
427 struct ltt_ust_channel
*uchan
)
432 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
433 struct ltt_ust_channel
*uchan
)
438 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
439 struct ltt_ust_channel
*uchan
)
444 int ust_app_enable_all_event_glb(struct ltt_ust_session
*usess
,
445 struct ltt_ust_channel
*uchan
)
450 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
451 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
456 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
457 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
462 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
463 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
468 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
469 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
474 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
475 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
481 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
482 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
,
488 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
493 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
498 int ust_app_recv_notify(int sock
)
503 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
508 void ust_app_add(struct ust_app
*app
)
512 void ust_app_notify_sock_unregister(int sock
)
516 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
517 struct consumer_socket
*socket
, int send_zero_data
)
522 void ust_app_destroy(struct ust_app
*app
)
527 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
528 struct snapshot_output
*output
, int wait
, unsigned int nb_stream
)
533 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
539 int ust_app_supported(void)
544 #endif /* HAVE_LIBLTTNG_UST_CTL */
546 #endif /* _LTT_UST_APP_H */