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