Add JUL registration thread
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
... / ...
CommitLineData
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
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.
7 *
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.
12 *
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.
16 */
17
18#ifndef _LTT_UST_APP_H
19#define _LTT_UST_APP_H
20
21#include <stdint.h>
22
23#include <common/compat/uuid.h>
24#include "trace-ust.h"
25#include "ust-registry.h"
26
27#define UST_APP_EVENT_LIST_SIZE 32
28
29/* Process name (short). */
30#define UST_APP_PROCNAME_LEN 16
31
32struct lttng_filter_bytecode;
33struct lttng_ust_filter_bytecode;
34
35extern int ust_consumerd64_fd, ust_consumerd32_fd;
36
37/*
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
40 * notify socket fd.
41 */
42struct ust_app_notify_sock_obj {
43 int fd;
44 struct rcu_head head;
45};
46
47struct ust_app_ht_key {
48 const char *name;
49 const struct lttng_ust_filter_bytecode *filter;
50 enum lttng_ust_loglevel_type loglevel;
51};
52
53/*
54 * Application registration data structure.
55 */
56struct ust_register_msg {
57 enum ustctl_socket_type type;
58 uint32_t major;
59 uint32_t minor;
60 uint32_t abi_major;
61 uint32_t abi_minor;
62 pid_t pid;
63 pid_t ppid;
64 uid_t uid;
65 gid_t gid;
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];
74};
75
76/*
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.
79 */
80struct lttng_ht *ust_app_ht;
81
82/*
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.
85 */
86struct lttng_ht *ust_app_ht_by_sock;
87
88/*
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.
91 */
92struct lttng_ht *ust_app_ht_by_notify_sock;
93
94/* Stream list containing ust_app_stream. */
95struct ust_app_stream_list {
96 unsigned int count;
97 struct cds_list_head head;
98};
99
100struct ust_app_ctx {
101 int handle;
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;
106};
107
108struct ust_app_event {
109 int enabled;
110 int handle;
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;
116};
117
118struct ust_app_stream {
119 int handle;
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;
126};
127
128struct ust_app_channel {
129 int enabled;
130 int handle;
131 /* Channel and streams were sent to the UST tracer. */
132 int is_sent;
133 /* Unique key used to identify the channel on the consumer side. */
134 uint64_t key;
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;
145 /*
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
148 * user added them.
149 */
150 struct lttng_ht *ctx;
151 struct cds_list_head ctx_list;
152
153 struct lttng_ht *events;
154 uint64_t tracefile_size;
155 uint64_t tracefile_count;
156 /*
157 * Node indexed by channel name in the channels' hash table of a session.
158 */
159 struct lttng_ht_node_str node;
160 /*
161 * Node indexed by UST channel object descriptor (handle). Stored in the
162 * ust_objd hash table in the ust_app object.
163 */
164 struct lttng_ht_node_ulong ust_objd_node;
165 /* For delayed reclaim */
166 struct rcu_head rcu_head;
167};
168
169struct ust_app_session {
170 /*
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.
174 */
175 pthread_mutex_t lock;
176
177 int enabled;
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 */
181
182 /*
183 * Tracing session ID. Multiple ust app session can have the same tracing
184 * session id making this value NOT unique to the object.
185 */
186 uint64_t tracing_id;
187 uint64_t id; /* Unique session identifier */
188 struct lttng_ht *channels; /* Registered channels */
189 struct lttng_ht_node_u64 node;
190 char path[PATH_MAX];
191 /* UID/GID of the application owning the session */
192 uid_t uid;
193 gid_t gid;
194 /* Effective UID and GID. Same as the tracing session. */
195 uid_t euid;
196 gid_t egid;
197 struct cds_list_head teardown_node;
198 /*
199 * Once at least *one* session is created onto the application, the
200 * corresponding consumer is set so we can use it on unregistration.
201 */
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 */
211};
212
213/*
214 * Registered traceable applications. Libust registers to the session daemon
215 * and a linked list is kept of all running traceable app.
216 */
217struct ust_app {
218 int sock;
219 int notify_sock;
220 pid_t pid;
221 pid_t ppid;
222 uid_t uid; /* User ID that owns the apps */
223 gid_t gid; /* Group ID that owns the apps */
224
225 /* App ABI */
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 */
233
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;
248 /*
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
251 * deleted.
252 *
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.
256 */
257 struct cds_list_head teardown_head;
258 /*
259 * Hash table containing ust_app_channel indexed by channel objd.
260 */
261 struct lttng_ht *ust_objd;
262};
263
264#ifdef HAVE_LIBLTTNG_UST_CTL
265
266int ust_app_register(struct ust_register_msg *msg, int sock);
267static inline
268int ust_app_register_done(int sock)
269{
270 return ustctl_register_done(sock);
271}
272int ust_app_version(struct ust_app *app);
273void ust_app_unregister(int sock);
274unsigned long ust_app_list_count(void);
275int ust_app_start_trace_all(struct ltt_ust_session *usess);
276int ust_app_stop_trace_all(struct ltt_ust_session *usess);
277int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
278int ust_app_list_events(struct lttng_event **events);
279int ust_app_list_event_fields(struct lttng_event_field **fields);
280int ust_app_create_channel_glb(struct ltt_ust_session *usess,
281 struct ltt_ust_channel *uchan);
282int ust_app_create_event_glb(struct ltt_ust_session *usess,
283 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
284int ust_app_disable_event_pid(struct ltt_ust_session *usess,
285 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
286 pid_t pid);
287int ust_app_enable_event_pid(struct ltt_ust_session *usess,
288 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
289 pid_t pid);
290int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
291 struct ltt_ust_channel *uchan);
292int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
293 struct ltt_ust_channel *uchan);
294int ust_app_enable_event_glb(struct ltt_ust_session *usess,
295 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
296int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
297 struct ltt_ust_channel *uchan);
298int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
299 struct ltt_ust_channel *uchan);
300int ust_app_disable_event_glb(struct ltt_ust_session *usess,
301 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
302int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
303 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
304void ust_app_global_update(struct ltt_ust_session *usess, int sock);
305
306void ust_app_clean_list(void);
307void ust_app_ht_alloc(void);
308struct lttng_ht *ust_app_get_ht(void);
309struct ust_app *ust_app_find_by_pid(pid_t pid);
310int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
311struct ust_app_stream *ust_app_alloc_stream(void);
312int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
313int ust_app_recv_notify(int sock);
314void ust_app_add(struct ust_app *app);
315struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
316void ust_app_notify_sock_unregister(int sock);
317ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
318 struct consumer_socket *socket, int send_zero_data);
319void ust_app_destroy(struct ust_app *app);
320int ust_app_snapshot_record(struct ltt_ust_session *usess,
321 struct snapshot_output *output, int wait, unsigned int nb_streams);
322unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess);
323
324static inline
325int ust_app_supported(void)
326{
327 return 1;
328}
329
330#else /* HAVE_LIBLTTNG_UST_CTL */
331
332static inline
333int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
334{
335 return 0;
336}
337static inline
338int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
339{
340 return 0;
341}
342static inline
343int ust_app_start_trace_all(struct ltt_ust_session *usess)
344{
345 return 0;
346}
347static inline
348int ust_app_stop_trace_all(struct ltt_ust_session *usess)
349{
350 return 0;
351}
352static inline
353int ust_app_list_events(struct lttng_event **events)
354{
355 return -ENOSYS;
356}
357static inline
358int ust_app_list_event_fields(struct lttng_event_field **fields)
359{
360 return -ENOSYS;
361}
362static inline
363int ust_app_register(struct ust_register_msg *msg, int sock)
364{
365 return -ENOSYS;
366}
367static inline
368int ust_app_register_done(int sock)
369{
370 return -ENOSYS;
371}
372static inline
373int ust_app_version(struct ust_app *app)
374{
375 return -ENOSYS;
376}
377static inline
378void ust_app_unregister(int sock)
379{
380}
381static inline
382unsigned int ust_app_list_count(void)
383{
384 return 0;
385}
386static inline
387void ust_app_lock_list(void)
388{
389}
390static inline
391void ust_app_unlock_list(void)
392{
393}
394static inline
395void ust_app_clean_list(void)
396{
397}
398static inline
399struct ust_app_list *ust_app_get_list(void)
400{
401 return NULL;
402}
403static inline
404struct ust_app *ust_app_get_by_pid(pid_t pid)
405{
406 return NULL;
407}
408static inline
409struct lttng_ht *ust_app_get_ht(void)
410{
411 return NULL;
412}
413static inline
414void ust_app_ht_alloc(void)
415{}
416static inline
417void ust_app_global_update(struct ltt_ust_session *usess, int sock)
418{}
419static inline
420int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
421 struct ltt_ust_channel *uchan)
422{
423 return 0;
424}
425static inline
426int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
427 struct ltt_ust_channel *uchan)
428{
429 return 0;
430}
431static inline
432int ust_app_create_channel_glb(struct ltt_ust_session *usess,
433 struct ltt_ust_channel *uchan)
434{
435 return 0;
436}
437static inline
438int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
439 struct ltt_ust_channel *uchan)
440{
441 return 0;
442}
443static inline
444int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
445 struct ltt_ust_channel *uchan)
446{
447 return 0;
448}
449static inline
450int ust_app_create_event_glb(struct ltt_ust_session *usess,
451 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
452{
453 return 0;
454}
455static inline
456int ust_app_disable_event_glb(struct ltt_ust_session *usess,
457 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
458{
459 return 0;
460}
461static inline
462int ust_app_enable_event_glb(struct ltt_ust_session *usess,
463 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
464{
465 return 0;
466}
467static inline
468int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
469 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
470{
471 return 0;
472}
473static inline
474int ust_app_enable_event_pid(struct ltt_ust_session *usess,
475 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
476 pid_t pid)
477{
478 return 0;
479}
480static inline
481int ust_app_disable_event_pid(struct ltt_ust_session *usess,
482 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
483 pid_t pid)
484{
485 return 0;
486}
487static inline
488int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
489{
490 return 0;
491}
492static inline
493int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
494{
495 return 0;
496}
497static inline
498int ust_app_recv_notify(int sock)
499{
500 return 0;
501}
502static inline
503struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
504{
505 return NULL;
506}
507static inline
508void ust_app_add(struct ust_app *app)
509{
510}
511static inline
512void ust_app_notify_sock_unregister(int sock)
513{
514}
515static inline
516ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
517 struct consumer_socket *socket, int send_zero_data)
518{
519 return 0;
520}
521static inline
522void ust_app_destroy(struct ust_app *app)
523{
524 return;
525}
526static inline
527int ust_app_snapshot_record(struct ltt_ust_session *usess,
528 struct snapshot_output *output, int wait, unsigned int nb_stream)
529{
530 return 0;
531}
532static inline
533unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
534{
535 return 0;
536}
537
538static inline
539int ust_app_supported(void)
540{
541 return 0;
542}
543
544#endif /* HAVE_LIBLTTNG_UST_CTL */
545
546#endif /* _LTT_UST_APP_H */
This page took 0.023839 seconds and 4 git commands to generate.