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