Move ust channel registry inside session registry
[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 * Node indexed by channel name in the channels' hash table of a session.
146 */
bec39940 147 struct lttng_ht_node_str node;
d0b96690
DG
148 /*
149 * Node indexed by UST channel object descriptor (handle). Stored in the
150 * ust_objd hash table in the ust_app object.
151 */
152 struct lttng_ht_node_ulong ust_objd_node;
48842b30
DG
153};
154
155struct ust_app_session {
d0b96690
DG
156 /*
157 * Lock protecting this session's ust app interaction. Held
158 * across command send/recv to/from app. Never nests within the
159 * session registry lock.
160 */
161 pthread_mutex_t lock;
162
48842b30 163 int enabled;
8be98f9a
MD
164 /* started: has the session been in started state at any time ? */
165 int started; /* allows detection of start vs restart. */
a991f516
MD
166 int handle; /* used has unique identifier for app session */
167 int id; /* session unique identifier */
ffe60014 168 struct ust_app_channel *metadata;
45893984 169 struct ust_registry_session *registry;
bec39940
DG
170 struct lttng_ht *channels; /* Registered channels */
171 struct lttng_ht_node_ulong node;
172 char path[PATH_MAX];
6df2e2c9
MD
173 /* UID/GID of the user owning the session */
174 uid_t uid;
175 gid_t gid;
d42f20df 176 struct cds_list_head teardown_node;
d88aee68
DG
177 /*
178 * Once at least *one* session is created onto the application, the
179 * corresponding consumer is set so we can use it on unregistration.
180 */
181 struct consumer_output *consumer;
48842b30
DG
182};
183
f6a9efaa
DG
184/*
185 * Registered traceable applications. Libust registers to the session daemon
050349bb 186 * and a linked list is kept of all running traceable app.
91d76f53 187 */
56fff090 188struct ust_app {
852d0037 189 int sock;
d0b96690 190 int notify_sock;
852d0037 191 pid_t pid;
099e26bd
DG
192 pid_t ppid;
193 uid_t uid; /* User ID that owns the apps */
aea829b3 194 gid_t gid; /* Group ID that owns the apps */
d0b96690
DG
195
196 /* App ABI */
197 uint32_t bits_per_long;
198 uint32_t uint8_t_alignment;
199 uint32_t uint16_t_alignment;
200 uint32_t uint32_t_alignment;
201 uint32_t uint64_t_alignment;
202 uint32_t long_alignment;
203 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
204
e0c7ec2b
DG
205 int compatible; /* If the lttng-ust tracer version does not match the
206 supported version of the session daemon, this flag is
207 set to 0 (NOT compatible) else 1. */
208 struct lttng_ust_tracer_version version;
d0b96690
DG
209 uint32_t v_major; /* Version major number */
210 uint32_t v_minor; /* Version minor number */
d88aee68
DG
211 /* Extra for the NULL byte. */
212 char name[UST_APP_PROCNAME_LEN + 1];
bec39940 213 struct lttng_ht *sessions;
852d0037
DG
214 struct lttng_ht_node_ulong pid_n;
215 struct lttng_ht_node_ulong sock_n;
d0b96690 216 struct lttng_ht_node_ulong notify_sock_n;
d42f20df
DG
217 /*
218 * This is a list of ust app session that, once the app is going into
219 * teardown mode, in the RCU call, each node in this list is removed and
220 * deleted.
221 *
222 * Element of the list are added when an application unregisters after each
223 * ht_del of ust_app_session associated to this app. This list is NOT used
224 * when a session is destroyed.
225 */
226 struct cds_list_head teardown_head;
d0b96690
DG
227 /*
228 * Hash table containing ust_app_channel indexed by channel objd.
229 */
230 struct lttng_ht *ust_objd;
91d76f53
DG
231};
232
74d0b642 233#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 234
56fff090 235int ust_app_register(struct ust_register_msg *msg, int sock);
f2ca2e25
GF
236static inline
237int ust_app_register_done(int sock)
238{
239 return ustctl_register_done(sock);
240}
d0b96690 241int ust_app_version(struct ust_app *app);
56fff090 242void ust_app_unregister(int sock);
f6a9efaa 243unsigned long ust_app_list_count(void);
421cb601 244int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app);
8be98f9a 245int ust_app_stop_trace(struct ltt_ust_session *usess, struct ust_app *app);
421cb601 246int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a 247int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 248int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063 249int ust_app_list_events(struct lttng_event **events);
f37d259d 250int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d
DG
251int ust_app_create_channel_glb(struct ltt_ust_session *usess,
252 struct ltt_ust_channel *uchan);
253int ust_app_create_event_glb(struct ltt_ust_session *usess,
254 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
7f79d3a1
DG
255int ust_app_disable_event_pid(struct ltt_ust_session *usess,
256 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
257 pid_t pid);
76d45b40
DG
258int ust_app_enable_event_pid(struct ltt_ust_session *usess,
259 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
260 pid_t pid);
35a9059d 261int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 262 struct ltt_ust_channel *uchan);
35a9059d 263int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 264 struct ltt_ust_channel *uchan);
35a9059d 265int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 266 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
35a9059d
DG
267int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
268 struct ltt_ust_channel *uchan);
269int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e 270 struct ltt_ust_channel *uchan);
35a9059d
DG
271int ust_app_disable_event_glb(struct ltt_ust_session *usess,
272 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
55cc08a6
DG
273int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
274 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
487cf67c 275void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53 276
56fff090 277void ust_app_clean_list(void);
f6a9efaa 278void ust_app_ht_alloc(void);
bec39940 279struct lttng_ht *ust_app_get_ht(void);
f6a9efaa 280struct ust_app *ust_app_find_by_pid(pid_t pid);
4466912f 281int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
ffe60014 282struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690
DG
283int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
284int ust_app_recv_notify(int sock);
285void ust_app_add(struct ust_app *app);
286struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
d88aee68 287void ust_app_notify_sock_unregister(int sock);
44d3bd01 288
74d0b642 289#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 290
cc920def
DG
291static inline
292int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
293{
294 return 0;
295}
d974f197 296static inline
421cb601
DG
297int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
298{
299 return 0;
300}
301static inline
302int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197 303{
5cf5d0e7 304 return 0;
d974f197 305}
3bd1e081 306static inline
cc920def
DG
307int ust_app_stop_trace_all(struct ltt_ust_session *usess)
308{
309 return 0;
310}
311static inline
b551a063
DG
312int ust_app_list_events(struct lttng_event **events)
313{
db7c0497 314 return -ENOSYS;
b551a063
DG
315}
316static inline
da0bdb87
MD
317int ust_app_list_event_fields(struct lttng_event_field **fields)
318{
319 return -ENOSYS;
320}
321static inline
3bd1e081
MD
322int ust_app_register(struct ust_register_msg *msg, int sock)
323{
324 return -ENOSYS;
325}
326static inline
f2ca2e25
GF
327int ust_app_register_done(int sock)
328{
329 return -ENOSYS;
330}
331static inline
d0b96690
DG
332int ust_app_version(struct ust_app *app)
333{
334 return -ENOSYS;
335}
336static inline
3bd1e081
MD
337void ust_app_unregister(int sock)
338{
339}
340static inline
341unsigned int ust_app_list_count(void)
342{
343 return 0;
344}
3bd1e081
MD
345static inline
346void ust_app_lock_list(void)
347{
348}
349static inline
350void ust_app_unlock_list(void)
351{
352}
353static inline
354void ust_app_clean_list(void)
355{
356}
357static inline
358struct ust_app_list *ust_app_get_list(void)
359{
360 return NULL;
361}
362static inline
363struct ust_app *ust_app_get_by_pid(pid_t pid)
364{
365 return NULL;
366}
48842b30 367static inline
bec39940 368struct lttng_ht *ust_app_get_ht(void)
d974f197
DG
369{
370 return NULL;
371}
372static inline
373void ust_app_ht_alloc(void)
cc920def
DG
374{}
375static inline
376void ust_app_global_update(struct ltt_ust_session *usess, int sock)
377{}
378static inline
35a9059d 379int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def 380 struct ltt_ust_channel *uchan)
d974f197 381{
cc920def 382 return 0;
d974f197 383}
487cf67c 384static inline
35a9059d 385int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def 386 struct ltt_ust_channel *uchan)
487cf67c 387{
cc920def
DG
388 return 0;
389}
390static inline
35a9059d 391int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def
DG
392 struct ltt_ust_channel *uchan)
393{
394 return 0;
395}
396static inline
35a9059d
DG
397int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
398 struct ltt_ust_channel *uchan)
cc920def
DG
399{
400 return 0;
401}
402static inline
35a9059d 403int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def
DG
404 struct ltt_ust_channel *uchan)
405{
406 return 0;
407}
408static inline
35a9059d
DG
409int ust_app_create_event_glb(struct ltt_ust_session *usess,
410 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
411{
412 return 0;
413}
414static inline
415int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def
DG
416 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
417{
418 return 0;
487cf67c 419}
edb67388 420static inline
35a9059d 421int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388
DG
422 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
423{
424 return 0;
425}
55cc08a6 426static inline
55cc08a6
DG
427int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
428 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
429{
430 return 0;
431}
76d45b40
DG
432static inline
433int ust_app_enable_event_pid(struct ltt_ust_session *usess,
434 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
435 pid_t pid)
436{
437 return 0;
438}
7f79d3a1
DG
439static inline
440int ust_app_disable_event_pid(struct ltt_ust_session *usess,
441 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
442 pid_t pid)
443{
444 return 0;
445}
e0c7ec2b 446static inline
d0b96690 447int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
e0c7ec2b
DG
448{
449 return 0;
450}
4466912f 451static inline
d0b96690
DG
452int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
453{
454 return 0;
455}
456static inline
457int ust_app_recv_notify(int sock)
4466912f
DG
458{
459 return 0;
460}
d0b96690
DG
461static inline
462struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
463{
464 return NULL;
465}
466static inline
467void ust_app_add(struct ust_app *app)
468{
469}
d88aee68
DG
470static inline
471void ust_app_notify_sock_unregister(int sock)
472{
473}
48842b30 474
74d0b642 475#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 476
f6a9efaa 477#endif /* _LTT_UST_APP_H */
This page took 0.062128 seconds and 5 git commands to generate.