Fix: lttng: uninitialized pointer free'd when no sessiond is present
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
CommitLineData
91d76f53 1/*
ab5be9fa
MJ
2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
91d76f53 4 *
ab5be9fa 5 * SPDX-License-Identifier: GPL-2.0-only
91d76f53 6 *
91d76f53
DG
7 */
8
2106efa0 9#ifndef _LTT_UST_APP_H
f6a9efaa 10#define _LTT_UST_APP_H
91d76f53 11
099e26bd 12#include <stdint.h>
1e307fab 13
c70636a7 14#include <common/uuid.h>
f20baf8e 15
44d3bd01 16#include "trace-ust.h"
d0b96690 17#include "ust-registry.h"
5c408ad8 18#include "session.h"
44d3bd01 19
b551a063
DG
20#define UST_APP_EVENT_LIST_SIZE 32
21
d88aee68
DG
22/* Process name (short). */
23#define UST_APP_PROCNAME_LEN 16
d0b96690 24
53a80697
MD
25struct lttng_filter_bytecode;
26struct lttng_ust_filter_bytecode;
27
7753dea8 28extern int ust_consumerd64_fd, ust_consumerd32_fd;
ba5d816e 29
d88aee68
DG
30/*
31 * Object used to close the notify socket in a call_rcu(). Since the
32 * application might not be found, we need an independant object containing the
33 * notify socket fd.
34 */
35struct ust_app_notify_sock_obj {
36 int fd;
37 struct rcu_head head;
38};
39
18eace3b
DG
40struct ust_app_ht_key {
41 const char *name;
51755dc8 42 const struct lttng_filter_bytecode *filter;
2106efa0 43 enum lttng_ust_loglevel_type loglevel_type;
51755dc8 44 const struct lttng_event_exclusion *exclusion;
18eace3b
DG
45};
46
099e26bd
DG
47/*
48 * Application registration data structure.
49 */
50struct ust_register_msg {
d0b96690 51 enum ustctl_socket_type type;
099e26bd
DG
52 uint32_t major;
53 uint32_t minor;
d0b96690
DG
54 uint32_t abi_major;
55 uint32_t abi_minor;
099e26bd
DG
56 pid_t pid;
57 pid_t ppid;
58 uid_t uid;
59 gid_t gid;
0df502fd 60 uint32_t bits_per_long;
d0b96690
DG
61 uint32_t uint8_t_alignment;
62 uint32_t uint16_t_alignment;
63 uint32_t uint32_t_alignment;
64 uint32_t uint64_t_alignment;
65 uint32_t long_alignment;
66 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
67 char name[LTTNG_UST_ABI_PROCNAME_LEN];
099e26bd
DG
68};
69
48842b30 70/*
852d0037
DG
71 * Global applications HT used by the session daemon. This table is indexed by
72 * PID using the pid_n node and pid value of an ust_app.
48842b30 73 */
44cdb3a2 74extern struct lttng_ht *ust_app_ht;
f6a9efaa 75
852d0037
DG
76/*
77 * Global applications HT used by the session daemon. This table is indexed by
78 * socket using the sock_n node and sock value of an ust_app.
12e22e8d
JG
79 *
80 * The 'sock' in question here is the 'command' socket.
852d0037 81 */
44cdb3a2 82extern struct lttng_ht *ust_app_ht_by_sock;
91d76f53 83
d0b96690
DG
84/*
85 * Global applications HT used by the session daemon. This table is indexed by
86 * socket using the notify_sock_n node and notify_sock value of an ust_app.
87 */
44cdb3a2 88extern struct lttng_ht *ust_app_ht_by_notify_sock;
d0b96690 89
030a66fa
DG
90/* Stream list containing ust_app_stream. */
91struct ust_app_stream_list {
92 unsigned int count;
93 struct cds_list_head head;
94};
95
55cc08a6
DG
96struct ust_app_ctx {
97 int handle;
bdf64013 98 struct lttng_ust_context_attr ctx;
55cc08a6 99 struct lttng_ust_object_data *obj;
bec39940 100 struct lttng_ht_node_ulong node;
31746f93 101 struct cds_list_head list;
55cc08a6
DG
102};
103
48842b30
DG
104struct ust_app_event {
105 int enabled;
106 int handle;
13161846 107 struct lttng_ust_object_data *obj;
284d8f55 108 struct lttng_ust_event attr;
48842b30 109 char name[LTTNG_UST_SYM_NAME_LEN];
bec39940 110 struct lttng_ht_node_str node;
51755dc8
JG
111 struct lttng_filter_bytecode *filter;
112 struct lttng_event_exclusion *exclusion;
48842b30
DG
113};
114
030a66fa
DG
115struct ust_app_stream {
116 int handle;
117 char pathname[PATH_MAX];
118 /* Format is %s_%d respectively channel name and CPU number. */
119 char name[DEFAULT_STREAM_NAME_LEN];
120 struct lttng_ust_object_data *obj;
121 /* Using a list of streams to keep order. */
122 struct cds_list_head list;
123};
124
48842b30
DG
125struct ust_app_channel {
126 int enabled;
127 int handle;
ffe60014
DG
128 /* Channel and streams were sent to the UST tracer. */
129 int is_sent;
dda154b8
JG
130 /*
131 * Unique key used to identify the channel on the consumer side.
132 * 0 is a reserved 'invalid' value used to indicate that the consumer
a9577b76 133 * does not know about this channel (i.e. an error occurred).
dda154b8 134 */
d88aee68 135 uint64_t key;
7972aab2
DG
136 /* Id of the tracing channel set on creation. */
137 uint64_t tracing_channel_id;
ffe60014
DG
138 /* Number of stream that this channel is expected to receive. */
139 unsigned int expected_stream_count;
48842b30 140 char name[LTTNG_UST_SYM_NAME_LEN];
13161846 141 struct lttng_ust_object_data *obj;
ffe60014 142 struct ustctl_consumer_channel_attr attr;
030a66fa 143 struct ust_app_stream_list streams;
d0b96690
DG
144 /* Session pointer that owns this object. */
145 struct ust_app_session *session;
31746f93
DG
146 /*
147 * Contexts are kept in a hash table for fast lookup and in an ordered list
148 * so we are able to enable them on the tracer side in the same order the
149 * user added them.
150 */
bec39940 151 struct lttng_ht *ctx;
31746f93
DG
152 struct cds_list_head ctx_list;
153
bec39940 154 struct lttng_ht *events;
1624d5b7
JD
155 uint64_t tracefile_size;
156 uint64_t tracefile_count;
e9404c27 157 uint64_t monitor_timer_interval;
d0b96690
DG
158 /*
159 * Node indexed by channel name in the channels' hash table of a session.
160 */
bec39940 161 struct lttng_ht_node_str node;
d0b96690
DG
162 /*
163 * Node indexed by UST channel object descriptor (handle). Stored in the
164 * ust_objd hash table in the ust_app object.
165 */
166 struct lttng_ht_node_ulong ust_objd_node;
36b588ed
MD
167 /* For delayed reclaim */
168 struct rcu_head rcu_head;
48842b30
DG
169};
170
171struct ust_app_session {
d0b96690
DG
172 /*
173 * Lock protecting this session's ust app interaction. Held
174 * across command send/recv to/from app. Never nests within the
175 * session registry lock.
176 */
177 pthread_mutex_t lock;
178
48842b30 179 int enabled;
8be98f9a
MD
180 /* started: has the session been in started state at any time ? */
181 int started; /* allows detection of start vs restart. */
a991f516 182 int handle; /* used has unique identifier for app session */
7972aab2 183
b161602a
MD
184 bool deleted; /* Session deleted flag. Check with lock held. */
185
7972aab2
DG
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;
10b56aef
MD
194 /*
195 * Node indexed by UST session object descriptor (handle). Stored in the
196 * ust_sessions_objd hash table in the ust_app object.
197 */
198 struct lttng_ht_node_ulong ust_objd_node;
d2956687 199 /* Starts with 'ust'; no leading slash. */
bec39940 200 char path[PATH_MAX];
7972aab2 201 /* UID/GID of the application owning the session */
470cc211 202 struct lttng_credentials real_credentials;
7972aab2 203 /* Effective UID and GID. Same as the tracing session. */
470cc211 204 struct lttng_credentials effective_credentials;
d42f20df 205 struct cds_list_head teardown_node;
d88aee68
DG
206 /*
207 * Once at least *one* session is created onto the application, the
208 * corresponding consumer is set so we can use it on unregistration.
209 */
210 struct consumer_output *consumer;
7972aab2
DG
211 enum lttng_buffer_type buffer_type;
212 /* ABI of the session. Same value as the application. */
213 uint32_t bits_per_long;
36b588ed
MD
214 /* For delayed reclaim */
215 struct rcu_head rcu_head;
2bba9e53
DG
216 /* If the channel's streams have to be outputed or not. */
217 unsigned int output_traces;
ecc48a90 218 unsigned int live_timer_interval; /* usec */
ad7a9107
DG
219
220 /* Metadata channel attributes. */
221 struct ustctl_consumer_channel_attr metadata_attr;
d7ba1388 222
3d071855 223 char root_shm_path[PATH_MAX];
d7ba1388 224 char shm_path[PATH_MAX];
48842b30
DG
225};
226
f6a9efaa
DG
227/*
228 * Registered traceable applications. Libust registers to the session daemon
050349bb 229 * and a linked list is kept of all running traceable app.
91d76f53 230 */
56fff090 231struct ust_app {
852d0037 232 int sock;
fb45065e
MD
233 pthread_mutex_t sock_lock; /* Protects sock protocol. */
234
d0b96690 235 int notify_sock;
852d0037 236 pid_t pid;
099e26bd
DG
237 pid_t ppid;
238 uid_t uid; /* User ID that owns the apps */
aea829b3 239 gid_t gid; /* Group ID that owns the apps */
d0b96690
DG
240
241 /* App ABI */
242 uint32_t bits_per_long;
243 uint32_t uint8_t_alignment;
244 uint32_t uint16_t_alignment;
245 uint32_t uint32_t_alignment;
246 uint32_t uint64_t_alignment;
247 uint32_t long_alignment;
248 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
249
e0c7ec2b
DG
250 int compatible; /* If the lttng-ust tracer version does not match the
251 supported version of the session daemon, this flag is
252 set to 0 (NOT compatible) else 1. */
253 struct lttng_ust_tracer_version version;
d0b96690
DG
254 uint32_t v_major; /* Version major number */
255 uint32_t v_minor; /* Version minor number */
d88aee68
DG
256 /* Extra for the NULL byte. */
257 char name[UST_APP_PROCNAME_LEN + 1];
7972aab2
DG
258 /* Type of buffer this application uses. */
259 enum lttng_buffer_type buffer_type;
bec39940 260 struct lttng_ht *sessions;
852d0037
DG
261 struct lttng_ht_node_ulong pid_n;
262 struct lttng_ht_node_ulong sock_n;
d0b96690 263 struct lttng_ht_node_ulong notify_sock_n;
d42f20df
DG
264 /*
265 * This is a list of ust app session that, once the app is going into
266 * teardown mode, in the RCU call, each node in this list is removed and
267 * deleted.
268 *
269 * Element of the list are added when an application unregisters after each
270 * ht_del of ust_app_session associated to this app. This list is NOT used
271 * when a session is destroyed.
272 */
273 struct cds_list_head teardown_head;
d0b96690
DG
274 /*
275 * Hash table containing ust_app_channel indexed by channel objd.
276 */
277 struct lttng_ht *ust_objd;
10b56aef
MD
278 /*
279 * Hash table containing ust_app_session indexed by objd.
280 */
281 struct lttng_ht *ust_sessions_objd;
022d91ba 282
f20baf8e 283 /*
022d91ba
DG
284 * If this application is of the agent domain and this is non negative then
285 * a lookup MUST be done to acquire a read side reference to the
286 * corresponding agent app object. If the lookup fails, this should be set
287 * to a negative value indicating that the agent application is gone.
f20baf8e 288 */
022d91ba 289 int agent_app_sock;
940c4592
JR
290 /*
291 * Time at which the app is registred.
292 * Used for path creation
293 */
294 time_t registration_time;
91d76f53
DG
295};
296
74d0b642 297#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 298
56fff090 299int ust_app_register(struct ust_register_msg *msg, int sock);
fb45065e 300int ust_app_register_done(struct ust_app *app);
d0b96690 301int ust_app_version(struct ust_app *app);
56fff090 302void ust_app_unregister(int sock);
421cb601 303int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a 304int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 305int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063 306int ust_app_list_events(struct lttng_event **events);
f37d259d 307int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d
DG
308int ust_app_create_event_glb(struct ltt_ust_session *usess,
309 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
310int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 311 struct ltt_ust_channel *uchan);
35a9059d 312int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 313 struct ltt_ust_channel *uchan);
35a9059d 314int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 315 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
35a9059d
DG
316int ust_app_disable_event_glb(struct ltt_ust_session *usess,
317 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
55cc08a6
DG
318int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
319 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
a9ad0c8f
MD
320void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
321void ust_app_global_update_all(struct ltt_ust_session *usess);
91d76f53 322
56fff090 323void ust_app_clean_list(void);
57703f6e 324int ust_app_ht_alloc(void);
f6a9efaa 325struct ust_app *ust_app_find_by_pid(pid_t pid);
ffe60014 326struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690
DG
327int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
328int ust_app_recv_notify(int sock);
329void ust_app_add(struct ust_app *app);
330struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
d88aee68 331void ust_app_notify_sock_unregister(int sock);
331744e3
JD
332ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
333 struct consumer_socket *socket, int send_zero_data);
f45e313d 334void ust_app_destroy(struct ust_app *app);
fb9a95c4
JG
335enum lttng_error_code ust_app_snapshot_record(
336 const struct ltt_ust_session *usess,
348a81dc 337 const struct consumer_output *output, int wait,
d07ceecd 338 uint64_t nb_packets_per_stream);
16f35901 339uint64_t ust_app_get_size_one_more_packet_per_stream(
fb9a95c4 340 const struct ltt_ust_session *usess, uint64_t cur_nr_packets);
f20baf8e 341struct ust_app *ust_app_find_by_sock(int sock);
fb83fe64
JD
342int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
343 struct cds_list_head *buffer_reg_uid_list,
344 struct consumer_output *consumer, uint64_t uchan_id,
345 int overwrite, uint64_t *discarded, uint64_t *lost);
346int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
347 struct ltt_ust_channel *uchan,
348 struct consumer_output *consumer,
349 int overwrite, uint64_t *discarded, uint64_t *lost);
c2561365 350int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
6f6d3b69 351enum lttng_error_code ust_app_rotate_session(struct ltt_session *session);
d2956687
JG
352enum lttng_error_code ust_app_create_channel_subdirectories(
353 const struct ltt_ust_session *session);
75018ab6
JG
354int ust_app_release_object(struct ust_app *app,
355 struct lttng_ust_object_data *data);
4a9b9759 356enum lttng_error_code ust_app_clear_session(struct ltt_session *session);
44d3bd01 357
b51ec5b4
MD
358static inline
359int ust_app_supported(void)
360{
361 return 1;
362}
363
74d0b642 364#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 365
cc920def
DG
366static inline
367int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
368{
369 return 0;
370}
d974f197 371static inline
421cb601
DG
372int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
373{
374 return 0;
375}
376static inline
377int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197 378{
5cf5d0e7 379 return 0;
d974f197 380}
3bd1e081 381static inline
cc920def
DG
382int ust_app_stop_trace_all(struct ltt_ust_session *usess)
383{
384 return 0;
385}
386static inline
b551a063
DG
387int ust_app_list_events(struct lttng_event **events)
388{
db7c0497 389 return -ENOSYS;
b551a063
DG
390}
391static inline
da0bdb87
MD
392int ust_app_list_event_fields(struct lttng_event_field **fields)
393{
394 return -ENOSYS;
395}
396static inline
3bd1e081
MD
397int ust_app_register(struct ust_register_msg *msg, int sock)
398{
399 return -ENOSYS;
400}
401static inline
fb45065e 402int ust_app_register_done(struct ust_app *app)
f2ca2e25
GF
403{
404 return -ENOSYS;
405}
406static inline
d0b96690
DG
407int ust_app_version(struct ust_app *app)
408{
409 return -ENOSYS;
410}
411static inline
3bd1e081
MD
412void ust_app_unregister(int sock)
413{
414}
415static inline
3bd1e081
MD
416void ust_app_lock_list(void)
417{
418}
419static inline
420void ust_app_unlock_list(void)
421{
422}
423static inline
424void ust_app_clean_list(void)
425{
426}
427static inline
428struct ust_app_list *ust_app_get_list(void)
429{
430 return NULL;
431}
432static inline
433struct ust_app *ust_app_get_by_pid(pid_t pid)
434{
435 return NULL;
436}
48842b30 437static inline
12a84043
JG
438int ust_app_ht_alloc(void)
439{
440 return 0;
441}
cc920def 442static inline
3646a051 443void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
cc920def
DG
444{}
445static inline
35a9059d 446int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def 447 struct ltt_ust_channel *uchan)
d974f197 448{
cc920def 449 return 0;
d974f197 450}
487cf67c 451static inline
35a9059d 452int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def 453 struct ltt_ust_channel *uchan)
487cf67c 454{
cc920def
DG
455 return 0;
456}
457static inline
35a9059d
DG
458int ust_app_create_event_glb(struct ltt_ust_session *usess,
459 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
460{
461 return 0;
462}
463static inline
464int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def
DG
465 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
466{
467 return 0;
487cf67c 468}
edb67388 469static inline
35a9059d 470int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388
DG
471 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
472{
473 return 0;
474}
55cc08a6 475static inline
55cc08a6
DG
476int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
477 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
478{
479 return 0;
480}
76d45b40
DG
481static inline
482int ust_app_enable_event_pid(struct ltt_ust_session *usess,
483 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
484 pid_t pid)
485{
486 return 0;
487}
7f79d3a1 488static inline
d0b96690
DG
489int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
490{
491 return 0;
492}
493static inline
494int ust_app_recv_notify(int sock)
4466912f
DG
495{
496 return 0;
497}
d0b96690
DG
498static inline
499struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
500{
501 return NULL;
502}
503static inline
504void ust_app_add(struct ust_app *app)
505{
506}
d88aee68
DG
507static inline
508void ust_app_notify_sock_unregister(int sock)
509{
510}
331744e3
JD
511static inline
512ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
513 struct consumer_socket *socket, int send_zero_data)
514{
515 return 0;
516}
f45e313d
DG
517static inline
518void ust_app_destroy(struct ust_app *app)
519{
520 return;
521}
6dc3064a 522static inline
9a654598 523enum lttng_error_code ust_app_snapshot_record(struct ltt_ust_session *usess,
3637639a 524 const struct consumer_output *output, int wait, uint64_t max_stream_size)
5c786ded
JD
525{
526 return 0;
527}
528static inline
529unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
6dc3064a
DG
530{
531 return 0;
532}
48842b30 533
b51ec5b4
MD
534static inline
535int ust_app_supported(void)
536{
537 return 0;
538}
f20baf8e
DG
539static inline
540struct ust_app *ust_app_find_by_sock(int sock)
541{
542 return NULL;
543}
95b1d17c
DG
544static inline
545struct ust_app *ust_app_find_by_pid(pid_t pid)
546{
547 return NULL;
548}
16f35901
JG
549static inline
550uint64_t ust_app_get_size_one_more_packet_per_stream(
1f4fc770 551 const struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
16f35901
JG
552 return 0;
553}
fb83fe64
JD
554static inline
555int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
556 struct cds_list_head *buffer_reg_uid_list,
557 struct consumer_output *consumer, int overwrite,
558 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
559{
560 return 0;
561}
562
563static inline
564int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
565 struct ltt_ust_channel *uchan,
566 struct consumer_output *consumer,
567 int overwrite, uint64_t *discarded, uint64_t *lost)
568{
569 return 0;
570}
b51ec5b4 571
6f698634
JG
572static inline
573int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
574{
575 return 0;
576}
577
5c408ad8 578static inline
d5a1b7aa 579enum lttng_error_code ust_app_rotate_session(struct ltt_session *session)
5c408ad8
JD
580{
581 return 0;
582}
583
d2956687
JG
584static inline
585enum lttng_error_code ust_app_create_channel_subdirectories(
586 const struct ltt_ust_session *session)
587{
588 return 0;
589}
590
75018ab6
JG
591static inline
592int ust_app_release_object(struct ust_app *app, struct lttng_ust_object_data *data)
593{
594 return 0;
595}
596
4a9b9759
MD
597static inline
598enum lttng_error_code ust_app_clear_session(struct ltt_session *session)
599{
600 return 0;
601}
602
74d0b642 603#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 604
f6a9efaa 605#endif /* _LTT_UST_APP_H */
This page took 0.225997 seconds and 5 git commands to generate.