Merge remote-tracking branch 'cbab-github/tests-cleanup' into cbab
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
CommitLineData
91d76f53
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
d14d33bf
AM
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.
91d76f53
DG
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 *
d14d33bf
AM
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.
91d76f53
DG
16 */
17
f6a9efaa
DG
18#ifndef _LTT_UST_APP_H
19#define _LTT_UST_APP_H
91d76f53 20
099e26bd 21#include <stdint.h>
1e307fab 22
ffe60014 23#include <common/compat/uuid.h>
44d3bd01 24#include "trace-ust.h"
d0b96690 25#include "ust-registry.h"
44d3bd01 26
b551a063
DG
27#define UST_APP_EVENT_LIST_SIZE 32
28
d88aee68
DG
29/* Process name (short). */
30#define UST_APP_PROCNAME_LEN 16
d0b96690 31
53a80697
MD
32struct lttng_filter_bytecode;
33struct lttng_ust_filter_bytecode;
34
7753dea8 35extern int ust_consumerd64_fd, ust_consumerd32_fd;
ba5d816e 36
d88aee68
DG
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
18eace3b
DG
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
099e26bd
DG
53/*
54 * Application registration data structure.
55 */
56struct ust_register_msg {
d0b96690 57 enum ustctl_socket_type type;
099e26bd
DG
58 uint32_t major;
59 uint32_t minor;
d0b96690
DG
60 uint32_t abi_major;
61 uint32_t abi_minor;
099e26bd
DG
62 pid_t pid;
63 pid_t ppid;
64 uid_t uid;
65 gid_t gid;
0df502fd 66 uint32_t bits_per_long;
d0b96690
DG
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];
099e26bd
DG
74};
75
48842b30 76/*
852d0037
DG
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.
48842b30 79 */
bec39940 80struct lttng_ht *ust_app_ht;
f6a9efaa 81
852d0037
DG
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;
91d76f53 87
d0b96690
DG
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
030a66fa
DG
94/* Stream list containing ust_app_stream. */
95struct ust_app_stream_list {
96 unsigned int count;
97 struct cds_list_head head;
98};
99
55cc08a6
DG
100struct ust_app_ctx {
101 int handle;
102 struct lttng_ust_context ctx;
103 struct lttng_ust_object_data *obj;
bec39940 104 struct lttng_ht_node_ulong node;
55cc08a6
DG
105};
106
48842b30
DG
107struct ust_app_event {
108 int enabled;
109 int handle;
13161846 110 struct lttng_ust_object_data *obj;
284d8f55 111 struct lttng_ust_event attr;
48842b30 112 char name[LTTNG_UST_SYM_NAME_LEN];
bec39940 113 struct lttng_ht_node_str node;
53a80697 114 struct lttng_ust_filter_bytecode *filter;
48842b30
DG
115};
116
030a66fa
DG
117struct ust_app_stream {
118 int handle;
119 char pathname[PATH_MAX];
120 /* Format is %s_%d respectively channel name and CPU number. */
121 char name[DEFAULT_STREAM_NAME_LEN];
122 struct lttng_ust_object_data *obj;
123 /* Using a list of streams to keep order. */
124 struct cds_list_head list;
125};
126
48842b30
DG
127struct ust_app_channel {
128 int enabled;
129 int handle;
ffe60014
DG
130 /* Channel and streams were sent to the UST tracer. */
131 int is_sent;
132 /* Unique key used to identify the channel on the consumer side. */
d88aee68 133 uint64_t key;
ffe60014
DG
134 /* Number of stream that this channel is expected to receive. */
135 unsigned int expected_stream_count;
48842b30 136 char name[LTTNG_UST_SYM_NAME_LEN];
13161846 137 struct lttng_ust_object_data *obj;
ffe60014 138 struct ustctl_consumer_channel_attr attr;
030a66fa 139 struct ust_app_stream_list streams;
d0b96690
DG
140 /* Session pointer that owns this object. */
141 struct ust_app_session *session;
bec39940
DG
142 struct lttng_ht *ctx;
143 struct lttng_ht *events;
d0b96690
DG
144 /*
145 * UST event registry. The ONLY writer is the application thread.
146 */
147 struct ust_registry_channel registry;
148 /*
149 * Node indexed by channel name in the channels' hash table of a session.
150 */
bec39940 151 struct lttng_ht_node_str node;
d0b96690
DG
152 /*
153 * Node indexed by UST channel object descriptor (handle). Stored in the
154 * ust_objd hash table in the ust_app object.
155 */
156 struct lttng_ht_node_ulong ust_objd_node;
48842b30
DG
157};
158
159struct ust_app_session {
d0b96690
DG
160 /*
161 * Lock protecting this session's ust app interaction. Held
162 * across command send/recv to/from app. Never nests within the
163 * session registry lock.
164 */
165 pthread_mutex_t lock;
166
48842b30 167 int enabled;
8be98f9a
MD
168 /* started: has the session been in started state at any time ? */
169 int started; /* allows detection of start vs restart. */
a991f516
MD
170 int handle; /* used has unique identifier for app session */
171 int id; /* session unique identifier */
ffe60014 172 struct ust_app_channel *metadata;
d0b96690 173 struct ust_registry_session registry;
bec39940
DG
174 struct lttng_ht *channels; /* Registered channels */
175 struct lttng_ht_node_ulong node;
176 char path[PATH_MAX];
6df2e2c9
MD
177 /* UID/GID of the user owning the session */
178 uid_t uid;
179 gid_t gid;
d42f20df 180 struct cds_list_head teardown_node;
d88aee68
DG
181 /*
182 * Once at least *one* session is created onto the application, the
183 * corresponding consumer is set so we can use it on unregistration.
184 */
185 struct consumer_output *consumer;
48842b30
DG
186};
187
f6a9efaa
DG
188/*
189 * Registered traceable applications. Libust registers to the session daemon
050349bb 190 * and a linked list is kept of all running traceable app.
91d76f53 191 */
56fff090 192struct ust_app {
852d0037 193 int sock;
d0b96690 194 int notify_sock;
852d0037 195 pid_t pid;
099e26bd
DG
196 pid_t ppid;
197 uid_t uid; /* User ID that owns the apps */
aea829b3 198 gid_t gid; /* Group ID that owns the apps */
d0b96690
DG
199
200 /* App ABI */
201 uint32_t bits_per_long;
202 uint32_t uint8_t_alignment;
203 uint32_t uint16_t_alignment;
204 uint32_t uint32_t_alignment;
205 uint32_t uint64_t_alignment;
206 uint32_t long_alignment;
207 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
208
e0c7ec2b
DG
209 int compatible; /* If the lttng-ust tracer version does not match the
210 supported version of the session daemon, this flag is
211 set to 0 (NOT compatible) else 1. */
212 struct lttng_ust_tracer_version version;
d0b96690
DG
213 uint32_t v_major; /* Version major number */
214 uint32_t v_minor; /* Version minor number */
d88aee68
DG
215 /* Extra for the NULL byte. */
216 char name[UST_APP_PROCNAME_LEN + 1];
bec39940 217 struct lttng_ht *sessions;
852d0037
DG
218 struct lttng_ht_node_ulong pid_n;
219 struct lttng_ht_node_ulong sock_n;
d0b96690 220 struct lttng_ht_node_ulong notify_sock_n;
d42f20df
DG
221 /*
222 * This is a list of ust app session that, once the app is going into
223 * teardown mode, in the RCU call, each node in this list is removed and
224 * deleted.
225 *
226 * Element of the list are added when an application unregisters after each
227 * ht_del of ust_app_session associated to this app. This list is NOT used
228 * when a session is destroyed.
229 */
230 struct cds_list_head teardown_head;
d0b96690
DG
231 /*
232 * Hash table containing ust_app_channel indexed by channel objd.
233 */
234 struct lttng_ht *ust_objd;
91d76f53
DG
235};
236
74d0b642 237#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 238
56fff090 239int ust_app_register(struct ust_register_msg *msg, int sock);
f2ca2e25
GF
240static inline
241int ust_app_register_done(int sock)
242{
243 return ustctl_register_done(sock);
244}
d0b96690 245int ust_app_version(struct ust_app *app);
56fff090 246void ust_app_unregister(int sock);
f6a9efaa 247unsigned long ust_app_list_count(void);
421cb601 248int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
8be98f9a 249int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
421cb601 250int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a 251int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 252int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063 253int ust_app_list_events(struct lttng_event **events);
f37d259d 254int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d
DG
255int ust_app_create_channel_glb(struct ltt_ust_session *usess,
256 struct ltt_ust_channel *uchan);
257int ust_app_create_event_glb(struct ltt_ust_session *usess,
258 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
7f79d3a1
DG
259int ust_app_disable_event_pid(struct ltt_ust_session *usess,
260 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
261 pid_t pid);
76d45b40
DG
262int ust_app_enable_event_pid(struct ltt_ust_session *usess,
263 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
264 pid_t pid);
35a9059d 265int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 266 struct ltt_ust_channel *uchan);
35a9059d 267int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 268 struct ltt_ust_channel *uchan);
35a9059d 269int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 270 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
35a9059d
DG
271int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
272 struct ltt_ust_channel *uchan);
273int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e 274 struct ltt_ust_channel *uchan);
35a9059d
DG
275int ust_app_disable_event_glb(struct ltt_ust_session *usess,
276 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
55cc08a6
DG
277int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
278 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
487cf67c 279void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53 280
56fff090 281void ust_app_clean_list(void);
f6a9efaa 282void ust_app_ht_alloc(void);
bec39940 283struct lttng_ht *ust_app_get_ht(void);
f6a9efaa 284struct ust_app *ust_app_find_by_pid(pid_t pid);
4466912f 285int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
ffe60014 286struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690
DG
287int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
288int ust_app_recv_notify(int sock);
289void ust_app_add(struct ust_app *app);
290struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
d88aee68 291void ust_app_notify_sock_unregister(int sock);
44d3bd01 292
74d0b642 293#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 294
cc920def
DG
295static inline
296int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
297{
298 return 0;
299}
d974f197 300static inline
421cb601
DG
301int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
302{
303 return 0;
304}
305static inline
306int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197 307{
5cf5d0e7 308 return 0;
d974f197 309}
3bd1e081 310static inline
cc920def
DG
311int ust_app_stop_trace_all(struct ltt_ust_session *usess)
312{
313 return 0;
314}
315static inline
b551a063
DG
316int ust_app_list_events(struct lttng_event **events)
317{
db7c0497 318 return -ENOSYS;
b551a063
DG
319}
320static inline
da0bdb87
MD
321int ust_app_list_event_fields(struct lttng_event_field **fields)
322{
323 return -ENOSYS;
324}
325static inline
3bd1e081
MD
326int ust_app_register(struct ust_register_msg *msg, int sock)
327{
328 return -ENOSYS;
329}
330static inline
f2ca2e25
GF
331int ust_app_register_done(int sock)
332{
333 return -ENOSYS;
334}
335static inline
d0b96690
DG
336int ust_app_version(struct ust_app *app)
337{
338 return -ENOSYS;
339}
340static inline
3bd1e081
MD
341void ust_app_unregister(int sock)
342{
343}
344static inline
345unsigned int ust_app_list_count(void)
346{
347 return 0;
348}
3bd1e081
MD
349static inline
350void ust_app_lock_list(void)
351{
352}
353static inline
354void ust_app_unlock_list(void)
355{
356}
357static inline
358void ust_app_clean_list(void)
359{
360}
361static inline
362struct ust_app_list *ust_app_get_list(void)
363{
364 return NULL;
365}
366static inline
367struct ust_app *ust_app_get_by_pid(pid_t pid)
368{
369 return NULL;
370}
48842b30 371static inline
bec39940 372struct lttng_ht *ust_app_get_ht(void)
d974f197
DG
373{
374 return NULL;
375}
376static inline
377void ust_app_ht_alloc(void)
cc920def
DG
378{}
379static inline
380void ust_app_global_update(struct ltt_ust_session *usess, int sock)
381{}
382static inline
35a9059d 383int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def 384 struct ltt_ust_channel *uchan)
d974f197 385{
cc920def 386 return 0;
d974f197 387}
487cf67c 388static inline
35a9059d 389int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def 390 struct ltt_ust_channel *uchan)
487cf67c 391{
cc920def
DG
392 return 0;
393}
394static inline
35a9059d 395int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def
DG
396 struct ltt_ust_channel *uchan)
397{
398 return 0;
399}
400static inline
35a9059d
DG
401int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
402 struct ltt_ust_channel *uchan)
cc920def
DG
403{
404 return 0;
405}
406static inline
35a9059d 407int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def
DG
408 struct ltt_ust_channel *uchan)
409{
410 return 0;
411}
412static inline
35a9059d
DG
413int ust_app_create_event_glb(struct ltt_ust_session *usess,
414 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
415{
416 return 0;
417}
418static inline
419int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def
DG
420 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
421{
422 return 0;
487cf67c 423}
edb67388 424static inline
35a9059d 425int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388
DG
426 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
427{
428 return 0;
429}
55cc08a6 430static inline
55cc08a6
DG
431int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
432 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
433{
434 return 0;
435}
76d45b40
DG
436static inline
437int ust_app_enable_event_pid(struct ltt_ust_session *usess,
438 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
439 pid_t pid)
440{
441 return 0;
442}
7f79d3a1
DG
443static inline
444int ust_app_disable_event_pid(struct ltt_ust_session *usess,
445 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
446 pid_t pid)
447{
448 return 0;
449}
e0c7ec2b 450static inline
d0b96690 451int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
e0c7ec2b
DG
452{
453 return 0;
454}
4466912f 455static inline
d0b96690
DG
456int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
457{
458 return 0;
459}
460static inline
461int ust_app_recv_notify(int sock)
4466912f
DG
462{
463 return 0;
464}
d0b96690
DG
465static inline
466struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
467{
468 return NULL;
469}
470static inline
471void ust_app_add(struct ust_app *app)
472{
473}
d88aee68
DG
474static inline
475void ust_app_notify_sock_unregister(int sock)
476{
477}
48842b30 478
74d0b642 479#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 480
f6a9efaa 481#endif /* _LTT_UST_APP_H */
This page took 0.055214 seconds and 4 git commands to generate.