Use common functions for module loading and unloading
[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>
f20baf8e
DG
24
25#include "jul.h"
44d3bd01 26#include "trace-ust.h"
d0b96690 27#include "ust-registry.h"
44d3bd01 28
b551a063
DG
29#define UST_APP_EVENT_LIST_SIZE 32
30
d88aee68
DG
31/* Process name (short). */
32#define UST_APP_PROCNAME_LEN 16
d0b96690 33
53a80697
MD
34struct lttng_filter_bytecode;
35struct lttng_ust_filter_bytecode;
36
7753dea8 37extern int ust_consumerd64_fd, ust_consumerd32_fd;
ba5d816e 38
d88aee68
DG
39/*
40 * Object used to close the notify socket in a call_rcu(). Since the
41 * application might not be found, we need an independant object containing the
42 * notify socket fd.
43 */
44struct ust_app_notify_sock_obj {
45 int fd;
46 struct rcu_head head;
47};
48
18eace3b
DG
49struct ust_app_ht_key {
50 const char *name;
51 const struct lttng_ust_filter_bytecode *filter;
52 enum lttng_ust_loglevel_type loglevel;
0c53bbad 53 const struct lttng_ust_event_exclusion *exclusion;
18eace3b
DG
54};
55
099e26bd
DG
56/*
57 * Application registration data structure.
58 */
59struct ust_register_msg {
d0b96690 60 enum ustctl_socket_type type;
099e26bd
DG
61 uint32_t major;
62 uint32_t minor;
d0b96690
DG
63 uint32_t abi_major;
64 uint32_t abi_minor;
099e26bd
DG
65 pid_t pid;
66 pid_t ppid;
67 uid_t uid;
68 gid_t gid;
0df502fd 69 uint32_t bits_per_long;
d0b96690
DG
70 uint32_t uint8_t_alignment;
71 uint32_t uint16_t_alignment;
72 uint32_t uint32_t_alignment;
73 uint32_t uint64_t_alignment;
74 uint32_t long_alignment;
75 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
76 char name[LTTNG_UST_ABI_PROCNAME_LEN];
099e26bd
DG
77};
78
48842b30 79/*
852d0037
DG
80 * Global applications HT used by the session daemon. This table is indexed by
81 * PID using the pid_n node and pid value of an ust_app.
48842b30 82 */
bec39940 83struct lttng_ht *ust_app_ht;
f6a9efaa 84
852d0037
DG
85/*
86 * Global applications HT used by the session daemon. This table is indexed by
87 * socket using the sock_n node and sock value of an ust_app.
88 */
89struct lttng_ht *ust_app_ht_by_sock;
91d76f53 90
d0b96690
DG
91/*
92 * Global applications HT used by the session daemon. This table is indexed by
93 * socket using the notify_sock_n node and notify_sock value of an ust_app.
94 */
95struct lttng_ht *ust_app_ht_by_notify_sock;
96
030a66fa
DG
97/* Stream list containing ust_app_stream. */
98struct ust_app_stream_list {
99 unsigned int count;
100 struct cds_list_head head;
101};
102
55cc08a6
DG
103struct ust_app_ctx {
104 int handle;
105 struct lttng_ust_context ctx;
106 struct lttng_ust_object_data *obj;
bec39940 107 struct lttng_ht_node_ulong node;
31746f93 108 struct cds_list_head list;
55cc08a6
DG
109};
110
48842b30
DG
111struct ust_app_event {
112 int enabled;
113 int handle;
13161846 114 struct lttng_ust_object_data *obj;
284d8f55 115 struct lttng_ust_event attr;
48842b30 116 char name[LTTNG_UST_SYM_NAME_LEN];
bec39940 117 struct lttng_ht_node_str node;
53a80697 118 struct lttng_ust_filter_bytecode *filter;
0c53bbad 119 struct lttng_ust_event_exclusion *exclusion;
48842b30
DG
120};
121
030a66fa
DG
122struct ust_app_stream {
123 int handle;
124 char pathname[PATH_MAX];
125 /* Format is %s_%d respectively channel name and CPU number. */
126 char name[DEFAULT_STREAM_NAME_LEN];
127 struct lttng_ust_object_data *obj;
128 /* Using a list of streams to keep order. */
129 struct cds_list_head list;
130};
131
48842b30
DG
132struct ust_app_channel {
133 int enabled;
134 int handle;
ffe60014
DG
135 /* Channel and streams were sent to the UST tracer. */
136 int is_sent;
137 /* Unique key used to identify the channel on the consumer side. */
d88aee68 138 uint64_t key;
7972aab2
DG
139 /* Id of the tracing channel set on creation. */
140 uint64_t tracing_channel_id;
ffe60014
DG
141 /* Number of stream that this channel is expected to receive. */
142 unsigned int expected_stream_count;
48842b30 143 char name[LTTNG_UST_SYM_NAME_LEN];
13161846 144 struct lttng_ust_object_data *obj;
ffe60014 145 struct ustctl_consumer_channel_attr attr;
030a66fa 146 struct ust_app_stream_list streams;
d0b96690
DG
147 /* Session pointer that owns this object. */
148 struct ust_app_session *session;
31746f93
DG
149 /*
150 * Contexts are kept in a hash table for fast lookup and in an ordered list
151 * so we are able to enable them on the tracer side in the same order the
152 * user added them.
153 */
bec39940 154 struct lttng_ht *ctx;
31746f93
DG
155 struct cds_list_head ctx_list;
156
bec39940 157 struct lttng_ht *events;
1624d5b7
JD
158 uint64_t tracefile_size;
159 uint64_t tracefile_count;
d0b96690
DG
160 /*
161 * Node indexed by channel name in the channels' hash table of a session.
162 */
bec39940 163 struct lttng_ht_node_str node;
d0b96690
DG
164 /*
165 * Node indexed by UST channel object descriptor (handle). Stored in the
166 * ust_objd hash table in the ust_app object.
167 */
168 struct lttng_ht_node_ulong ust_objd_node;
36b588ed
MD
169 /* For delayed reclaim */
170 struct rcu_head rcu_head;
48842b30
DG
171};
172
173struct ust_app_session {
d0b96690
DG
174 /*
175 * Lock protecting this session's ust app interaction. Held
176 * across command send/recv to/from app. Never nests within the
177 * session registry lock.
178 */
179 pthread_mutex_t lock;
180
48842b30 181 int enabled;
8be98f9a
MD
182 /* started: has the session been in started state at any time ? */
183 int started; /* allows detection of start vs restart. */
a991f516 184 int handle; /* used has unique identifier for app session */
7972aab2
DG
185
186 /*
187 * Tracing session ID. Multiple ust app session can have the same tracing
188 * session id making this value NOT unique to the object.
189 */
d9bf3ca4 190 uint64_t tracing_id;
7972aab2 191 uint64_t id; /* Unique session identifier */
bec39940 192 struct lttng_ht *channels; /* Registered channels */
d9bf3ca4 193 struct lttng_ht_node_u64 node;
bec39940 194 char path[PATH_MAX];
7972aab2 195 /* UID/GID of the application owning the session */
6df2e2c9
MD
196 uid_t uid;
197 gid_t gid;
7972aab2
DG
198 /* Effective UID and GID. Same as the tracing session. */
199 uid_t euid;
200 gid_t egid;
d42f20df 201 struct cds_list_head teardown_node;
d88aee68
DG
202 /*
203 * Once at least *one* session is created onto the application, the
204 * corresponding consumer is set so we can use it on unregistration.
205 */
206 struct consumer_output *consumer;
7972aab2
DG
207 enum lttng_buffer_type buffer_type;
208 /* ABI of the session. Same value as the application. */
209 uint32_t bits_per_long;
36b588ed
MD
210 /* For delayed reclaim */
211 struct rcu_head rcu_head;
2bba9e53
DG
212 /* If the channel's streams have to be outputed or not. */
213 unsigned int output_traces;
ecc48a90 214 unsigned int live_timer_interval; /* usec */
ad7a9107
DG
215
216 /* Metadata channel attributes. */
217 struct ustctl_consumer_channel_attr metadata_attr;
48842b30
DG
218};
219
f6a9efaa
DG
220/*
221 * Registered traceable applications. Libust registers to the session daemon
050349bb 222 * and a linked list is kept of all running traceable app.
91d76f53 223 */
56fff090 224struct ust_app {
852d0037 225 int sock;
d0b96690 226 int notify_sock;
852d0037 227 pid_t pid;
099e26bd
DG
228 pid_t ppid;
229 uid_t uid; /* User ID that owns the apps */
aea829b3 230 gid_t gid; /* Group ID that owns the apps */
d0b96690
DG
231
232 /* App ABI */
233 uint32_t bits_per_long;
234 uint32_t uint8_t_alignment;
235 uint32_t uint16_t_alignment;
236 uint32_t uint32_t_alignment;
237 uint32_t uint64_t_alignment;
238 uint32_t long_alignment;
239 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
240
e0c7ec2b
DG
241 int compatible; /* If the lttng-ust tracer version does not match the
242 supported version of the session daemon, this flag is
243 set to 0 (NOT compatible) else 1. */
244 struct lttng_ust_tracer_version version;
d0b96690
DG
245 uint32_t v_major; /* Version major number */
246 uint32_t v_minor; /* Version minor number */
d88aee68
DG
247 /* Extra for the NULL byte. */
248 char name[UST_APP_PROCNAME_LEN + 1];
7972aab2
DG
249 /* Type of buffer this application uses. */
250 enum lttng_buffer_type buffer_type;
bec39940 251 struct lttng_ht *sessions;
852d0037
DG
252 struct lttng_ht_node_ulong pid_n;
253 struct lttng_ht_node_ulong sock_n;
d0b96690 254 struct lttng_ht_node_ulong notify_sock_n;
d42f20df
DG
255 /*
256 * This is a list of ust app session that, once the app is going into
257 * teardown mode, in the RCU call, each node in this list is removed and
258 * deleted.
259 *
260 * Element of the list are added when an application unregisters after each
261 * ht_del of ust_app_session associated to this app. This list is NOT used
262 * when a session is destroyed.
263 */
264 struct cds_list_head teardown_head;
d0b96690
DG
265 /*
266 * Hash table containing ust_app_channel indexed by channel objd.
267 */
268 struct lttng_ht *ust_objd;
f20baf8e
DG
269 /*
270 * If this application is of the JUL domain and this is non negative then a
271 * lookup MUST be done to acquire a read side reference to the
272 * corresponding JUL app object. If the lookup fails, this should be set to
273 * a negative value indicating that the JUL application is gone.
274 */
275 int jul_app_sock;
91d76f53
DG
276};
277
74d0b642 278#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 279
56fff090 280int ust_app_register(struct ust_register_msg *msg, int sock);
f2ca2e25
GF
281static inline
282int ust_app_register_done(int sock)
283{
284 return ustctl_register_done(sock);
285}
d0b96690 286int ust_app_version(struct ust_app *app);
56fff090 287void ust_app_unregister(int sock);
421cb601 288int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a 289int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 290int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063 291int ust_app_list_events(struct lttng_event **events);
f37d259d 292int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d
DG
293int ust_app_create_channel_glb(struct ltt_ust_session *usess,
294 struct ltt_ust_channel *uchan);
295int ust_app_create_event_glb(struct ltt_ust_session *usess,
296 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
76d45b40
DG
297int ust_app_enable_event_pid(struct ltt_ust_session *usess,
298 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
299 pid_t pid);
35a9059d 300int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 301 struct ltt_ust_channel *uchan);
35a9059d 302int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 303 struct ltt_ust_channel *uchan);
35a9059d 304int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 305 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
35a9059d 306int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e 307 struct ltt_ust_channel *uchan);
35a9059d
DG
308int ust_app_disable_event_glb(struct ltt_ust_session *usess,
309 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
55cc08a6
DG
310int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
311 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
487cf67c 312void ust_app_global_update(struct ltt_ust_session *usess, int sock);
91d76f53 313
56fff090 314void ust_app_clean_list(void);
f6a9efaa 315void ust_app_ht_alloc(void);
f6a9efaa 316struct ust_app *ust_app_find_by_pid(pid_t pid);
4466912f 317int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
ffe60014 318struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690
DG
319int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
320int ust_app_recv_notify(int sock);
321void ust_app_add(struct ust_app *app);
322struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
d88aee68 323void ust_app_notify_sock_unregister(int sock);
331744e3
JD
324ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
325 struct consumer_socket *socket, int send_zero_data);
f45e313d 326void ust_app_destroy(struct ust_app *app);
6dc3064a 327int ust_app_snapshot_record(struct ltt_ust_session *usess,
5c786ded
JD
328 struct snapshot_output *output, int wait, unsigned int nb_streams);
329unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess);
f20baf8e 330struct ust_app *ust_app_find_by_sock(int sock);
44d3bd01 331
b51ec5b4
MD
332static inline
333int ust_app_supported(void)
334{
335 return 1;
336}
337
74d0b642 338#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 339
cc920def
DG
340static inline
341int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
342{
343 return 0;
344}
d974f197 345static inline
421cb601
DG
346int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
347{
348 return 0;
349}
350static inline
351int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197 352{
5cf5d0e7 353 return 0;
d974f197 354}
3bd1e081 355static inline
cc920def
DG
356int ust_app_stop_trace_all(struct ltt_ust_session *usess)
357{
358 return 0;
359}
360static inline
b551a063
DG
361int ust_app_list_events(struct lttng_event **events)
362{
db7c0497 363 return -ENOSYS;
b551a063
DG
364}
365static inline
da0bdb87
MD
366int ust_app_list_event_fields(struct lttng_event_field **fields)
367{
368 return -ENOSYS;
369}
370static inline
3bd1e081
MD
371int ust_app_register(struct ust_register_msg *msg, int sock)
372{
373 return -ENOSYS;
374}
375static inline
f2ca2e25
GF
376int ust_app_register_done(int sock)
377{
378 return -ENOSYS;
379}
380static inline
d0b96690
DG
381int ust_app_version(struct ust_app *app)
382{
383 return -ENOSYS;
384}
385static inline
3bd1e081
MD
386void ust_app_unregister(int sock)
387{
388}
389static inline
3bd1e081
MD
390void ust_app_lock_list(void)
391{
392}
393static inline
394void ust_app_unlock_list(void)
395{
396}
397static inline
398void ust_app_clean_list(void)
399{
400}
401static inline
402struct ust_app_list *ust_app_get_list(void)
403{
404 return NULL;
405}
406static inline
407struct ust_app *ust_app_get_by_pid(pid_t pid)
408{
409 return NULL;
410}
48842b30 411static inline
d974f197 412void ust_app_ht_alloc(void)
cc920def
DG
413{}
414static inline
415void ust_app_global_update(struct ltt_ust_session *usess, int sock)
416{}
417static inline
35a9059d 418int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def 419 struct ltt_ust_channel *uchan)
d974f197 420{
cc920def 421 return 0;
d974f197 422}
487cf67c 423static inline
35a9059d 424int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def 425 struct ltt_ust_channel *uchan)
487cf67c 426{
cc920def
DG
427 return 0;
428}
429static inline
35a9059d 430int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def
DG
431 struct ltt_ust_channel *uchan)
432{
433 return 0;
434}
435static inline
35a9059d 436int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def
DG
437 struct ltt_ust_channel *uchan)
438{
439 return 0;
440}
441static inline
35a9059d
DG
442int ust_app_create_event_glb(struct ltt_ust_session *usess,
443 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
444{
445 return 0;
446}
447static inline
448int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def
DG
449 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
450{
451 return 0;
487cf67c 452}
edb67388 453static inline
35a9059d 454int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388
DG
455 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
456{
457 return 0;
458}
55cc08a6 459static inline
55cc08a6
DG
460int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
461 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
462{
463 return 0;
464}
76d45b40
DG
465static inline
466int ust_app_enable_event_pid(struct ltt_ust_session *usess,
467 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
468 pid_t pid)
469{
470 return 0;
471}
7f79d3a1 472static inline
d0b96690 473int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
e0c7ec2b
DG
474{
475 return 0;
476}
4466912f 477static inline
d0b96690
DG
478int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
479{
480 return 0;
481}
482static inline
483int ust_app_recv_notify(int sock)
4466912f
DG
484{
485 return 0;
486}
d0b96690
DG
487static inline
488struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
489{
490 return NULL;
491}
492static inline
493void ust_app_add(struct ust_app *app)
494{
495}
d88aee68
DG
496static inline
497void ust_app_notify_sock_unregister(int sock)
498{
499}
331744e3
JD
500static inline
501ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
502 struct consumer_socket *socket, int send_zero_data)
503{
504 return 0;
505}
f45e313d
DG
506static inline
507void ust_app_destroy(struct ust_app *app)
508{
509 return;
510}
6dc3064a
DG
511static inline
512int ust_app_snapshot_record(struct ltt_ust_session *usess,
5c786ded
JD
513 struct snapshot_output *output, int wait, unsigned int nb_stream)
514{
515 return 0;
516}
517static inline
518unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
6dc3064a
DG
519{
520 return 0;
521}
48842b30 522
b51ec5b4
MD
523static inline
524int ust_app_supported(void)
525{
526 return 0;
527}
f20baf8e
DG
528static inline
529struct ust_app *ust_app_find_by_sock(int sock)
530{
531 return NULL;
532}
95b1d17c
DG
533static inline
534struct ust_app *ust_app_find_by_pid(pid_t pid)
535{
536 return NULL;
537}
b51ec5b4 538
74d0b642 539#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 540
f6a9efaa 541#endif /* _LTT_UST_APP_H */
This page took 0.095261 seconds and 5 git commands to generate.