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