Implement consumer ring buffer position sampling
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
CommitLineData
91d76f53
DG
1/*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
bdf64013 3 * Copyright (C) 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
91d76f53 4 *
d14d33bf
AM
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
91d76f53
DG
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
d14d33bf
AM
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
91d76f53
DG
17 */
18
2106efa0 19#ifndef _LTT_UST_APP_H
f6a9efaa 20#define _LTT_UST_APP_H
91d76f53 21
099e26bd 22#include <stdint.h>
1e307fab 23
ffe60014 24#include <common/compat/uuid.h>
f20baf8e 25
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;
51755dc8 51 const struct lttng_filter_bytecode *filter;
2106efa0 52 enum lttng_ust_loglevel_type loglevel_type;
51755dc8 53 const struct lttng_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;
bdf64013 105 struct lttng_ust_context_attr ctx;
55cc08a6 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;
51755dc8
JG
118 struct lttng_filter_bytecode *filter;
119 struct lttng_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;
e9404c27 160 uint64_t monitor_timer_interval;
d0b96690
DG
161 /*
162 * Node indexed by channel name in the channels' hash table of a session.
163 */
bec39940 164 struct lttng_ht_node_str node;
d0b96690
DG
165 /*
166 * Node indexed by UST channel object descriptor (handle). Stored in the
167 * ust_objd hash table in the ust_app object.
168 */
169 struct lttng_ht_node_ulong ust_objd_node;
36b588ed
MD
170 /* For delayed reclaim */
171 struct rcu_head rcu_head;
48842b30
DG
172};
173
174struct ust_app_session {
d0b96690
DG
175 /*
176 * Lock protecting this session's ust app interaction. Held
177 * across command send/recv to/from app. Never nests within the
178 * session registry lock.
179 */
180 pthread_mutex_t lock;
181
48842b30 182 int enabled;
8be98f9a
MD
183 /* started: has the session been in started state at any time ? */
184 int started; /* allows detection of start vs restart. */
a991f516 185 int handle; /* used has unique identifier for app session */
7972aab2 186
b161602a
MD
187 bool deleted; /* Session deleted flag. Check with lock held. */
188
7972aab2
DG
189 /*
190 * Tracing session ID. Multiple ust app session can have the same tracing
191 * session id making this value NOT unique to the object.
192 */
d9bf3ca4 193 uint64_t tracing_id;
7972aab2 194 uint64_t id; /* Unique session identifier */
bec39940 195 struct lttng_ht *channels; /* Registered channels */
d9bf3ca4 196 struct lttng_ht_node_u64 node;
10b56aef
MD
197 /*
198 * Node indexed by UST session object descriptor (handle). Stored in the
199 * ust_sessions_objd hash table in the ust_app object.
200 */
201 struct lttng_ht_node_ulong ust_objd_node;
bec39940 202 char path[PATH_MAX];
7972aab2 203 /* UID/GID of the application owning the session */
6df2e2c9
MD
204 uid_t uid;
205 gid_t gid;
7972aab2
DG
206 /* Effective UID and GID. Same as the tracing session. */
207 uid_t euid;
208 gid_t egid;
d42f20df 209 struct cds_list_head teardown_node;
d88aee68
DG
210 /*
211 * Once at least *one* session is created onto the application, the
212 * corresponding consumer is set so we can use it on unregistration.
213 */
214 struct consumer_output *consumer;
7972aab2
DG
215 enum lttng_buffer_type buffer_type;
216 /* ABI of the session. Same value as the application. */
217 uint32_t bits_per_long;
36b588ed
MD
218 /* For delayed reclaim */
219 struct rcu_head rcu_head;
2bba9e53
DG
220 /* If the channel's streams have to be outputed or not. */
221 unsigned int output_traces;
ecc48a90 222 unsigned int live_timer_interval; /* usec */
ad7a9107
DG
223
224 /* Metadata channel attributes. */
225 struct ustctl_consumer_channel_attr metadata_attr;
d7ba1388 226
3d071855 227 char root_shm_path[PATH_MAX];
d7ba1388 228 char shm_path[PATH_MAX];
48842b30
DG
229};
230
f6a9efaa
DG
231/*
232 * Registered traceable applications. Libust registers to the session daemon
050349bb 233 * and a linked list is kept of all running traceable app.
91d76f53 234 */
56fff090 235struct ust_app {
852d0037 236 int sock;
fb45065e
MD
237 pthread_mutex_t sock_lock; /* Protects sock protocol. */
238
d0b96690 239 int notify_sock;
852d0037 240 pid_t pid;
099e26bd
DG
241 pid_t ppid;
242 uid_t uid; /* User ID that owns the apps */
aea829b3 243 gid_t gid; /* Group ID that owns the apps */
d0b96690
DG
244
245 /* App ABI */
246 uint32_t bits_per_long;
247 uint32_t uint8_t_alignment;
248 uint32_t uint16_t_alignment;
249 uint32_t uint32_t_alignment;
250 uint32_t uint64_t_alignment;
251 uint32_t long_alignment;
252 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
253
e0c7ec2b
DG
254 int compatible; /* If the lttng-ust tracer version does not match the
255 supported version of the session daemon, this flag is
256 set to 0 (NOT compatible) else 1. */
257 struct lttng_ust_tracer_version version;
d0b96690
DG
258 uint32_t v_major; /* Version major number */
259 uint32_t v_minor; /* Version minor number */
d88aee68
DG
260 /* Extra for the NULL byte. */
261 char name[UST_APP_PROCNAME_LEN + 1];
7972aab2
DG
262 /* Type of buffer this application uses. */
263 enum lttng_buffer_type buffer_type;
bec39940 264 struct lttng_ht *sessions;
852d0037
DG
265 struct lttng_ht_node_ulong pid_n;
266 struct lttng_ht_node_ulong sock_n;
d0b96690 267 struct lttng_ht_node_ulong notify_sock_n;
d42f20df
DG
268 /*
269 * This is a list of ust app session that, once the app is going into
270 * teardown mode, in the RCU call, each node in this list is removed and
271 * deleted.
272 *
273 * Element of the list are added when an application unregisters after each
274 * ht_del of ust_app_session associated to this app. This list is NOT used
275 * when a session is destroyed.
276 */
277 struct cds_list_head teardown_head;
d0b96690
DG
278 /*
279 * Hash table containing ust_app_channel indexed by channel objd.
280 */
281 struct lttng_ht *ust_objd;
10b56aef
MD
282 /*
283 * Hash table containing ust_app_session indexed by objd.
284 */
285 struct lttng_ht *ust_sessions_objd;
022d91ba 286
f20baf8e 287 /*
022d91ba
DG
288 * If this application is of the agent domain and this is non negative then
289 * a lookup MUST be done to acquire a read side reference to the
290 * corresponding agent app object. If the lookup fails, this should be set
291 * to a negative value indicating that the agent application is gone.
f20baf8e 292 */
022d91ba 293 int agent_app_sock;
91d76f53
DG
294};
295
74d0b642 296#ifdef HAVE_LIBLTTNG_UST_CTL
3bd1e081 297
56fff090 298int ust_app_register(struct ust_register_msg *msg, int sock);
fb45065e 299int ust_app_register_done(struct ust_app *app);
d0b96690 300int ust_app_version(struct ust_app *app);
56fff090 301void ust_app_unregister(int sock);
421cb601 302int ust_app_start_trace_all(struct ltt_ust_session *usess);
8be98f9a 303int ust_app_stop_trace_all(struct ltt_ust_session *usess);
84cd17c6 304int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
b551a063 305int ust_app_list_events(struct lttng_event **events);
f37d259d 306int ust_app_list_event_fields(struct lttng_event_field **fields);
35a9059d
DG
307int ust_app_create_channel_glb(struct ltt_ust_session *usess,
308 struct ltt_ust_channel *uchan);
309int ust_app_create_event_glb(struct ltt_ust_session *usess,
310 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
76d45b40
DG
311int ust_app_enable_event_pid(struct ltt_ust_session *usess,
312 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
313 pid_t pid);
35a9059d 314int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 315 struct ltt_ust_channel *uchan);
35a9059d 316int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
78f0bacd 317 struct ltt_ust_channel *uchan);
35a9059d 318int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388 319 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
35a9059d 320int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
9730260e 321 struct ltt_ust_channel *uchan);
35a9059d
DG
322int ust_app_disable_event_glb(struct ltt_ust_session *usess,
323 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
55cc08a6
DG
324int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
325 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
a9ad0c8f
MD
326void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app);
327void ust_app_global_update_all(struct ltt_ust_session *usess);
91d76f53 328
56fff090 329void ust_app_clean_list(void);
57703f6e 330int ust_app_ht_alloc(void);
f6a9efaa 331struct ust_app *ust_app_find_by_pid(pid_t pid);
ffe60014 332struct ust_app_stream *ust_app_alloc_stream(void);
d0b96690
DG
333int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
334int ust_app_recv_notify(int sock);
335void ust_app_add(struct ust_app *app);
336struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
d88aee68 337void ust_app_notify_sock_unregister(int sock);
331744e3
JD
338ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
339 struct consumer_socket *socket, int send_zero_data);
f45e313d 340void ust_app_destroy(struct ust_app *app);
6dc3064a 341int ust_app_snapshot_record(struct ltt_ust_session *usess,
d07ceecd
MD
342 struct snapshot_output *output, int wait,
343 uint64_t nb_packets_per_stream);
16f35901
JG
344uint64_t ust_app_get_size_one_more_packet_per_stream(
345 struct ltt_ust_session *usess, uint64_t cur_nr_packets);
f20baf8e 346struct ust_app *ust_app_find_by_sock(int sock);
fb83fe64
JD
347int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
348 struct cds_list_head *buffer_reg_uid_list,
349 struct consumer_output *consumer, uint64_t uchan_id,
350 int overwrite, uint64_t *discarded, uint64_t *lost);
351int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
352 struct ltt_ust_channel *uchan,
353 struct consumer_output *consumer,
354 int overwrite, uint64_t *discarded, uint64_t *lost);
c2561365 355int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess);
44d3bd01 356
b51ec5b4
MD
357static inline
358int ust_app_supported(void)
359{
360 return 1;
361}
362
74d0b642 363#else /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 364
cc920def
DG
365static inline
366int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
367{
368 return 0;
369}
d974f197 370static inline
421cb601
DG
371int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
372{
373 return 0;
374}
375static inline
376int ust_app_start_trace_all(struct ltt_ust_session *usess)
d974f197 377{
5cf5d0e7 378 return 0;
d974f197 379}
3bd1e081 380static inline
cc920def
DG
381int ust_app_stop_trace_all(struct ltt_ust_session *usess)
382{
383 return 0;
384}
385static inline
b551a063
DG
386int ust_app_list_events(struct lttng_event **events)
387{
db7c0497 388 return -ENOSYS;
b551a063
DG
389}
390static inline
da0bdb87
MD
391int ust_app_list_event_fields(struct lttng_event_field **fields)
392{
393 return -ENOSYS;
394}
395static inline
3bd1e081
MD
396int ust_app_register(struct ust_register_msg *msg, int sock)
397{
398 return -ENOSYS;
399}
400static inline
fb45065e 401int ust_app_register_done(struct ust_app *app)
f2ca2e25
GF
402{
403 return -ENOSYS;
404}
405static inline
d0b96690
DG
406int ust_app_version(struct ust_app *app)
407{
408 return -ENOSYS;
409}
410static inline
3bd1e081
MD
411void ust_app_unregister(int sock)
412{
413}
414static inline
3bd1e081
MD
415void ust_app_lock_list(void)
416{
417}
418static inline
419void ust_app_unlock_list(void)
420{
421}
422static inline
423void ust_app_clean_list(void)
424{
425}
426static inline
427struct ust_app_list *ust_app_get_list(void)
428{
429 return NULL;
430}
431static inline
432struct ust_app *ust_app_get_by_pid(pid_t pid)
433{
434 return NULL;
435}
48842b30 436static inline
12a84043
JG
437int ust_app_ht_alloc(void)
438{
439 return 0;
440}
cc920def 441static inline
3646a051 442void ust_app_global_update(struct ltt_ust_session *usess, struct ust_app *app)
cc920def
DG
443{}
444static inline
35a9059d 445int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
cc920def 446 struct ltt_ust_channel *uchan)
d974f197 447{
cc920def 448 return 0;
d974f197 449}
487cf67c 450static inline
35a9059d 451int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
cc920def 452 struct ltt_ust_channel *uchan)
487cf67c 453{
cc920def
DG
454 return 0;
455}
456static inline
35a9059d 457int ust_app_create_channel_glb(struct ltt_ust_session *usess,
cc920def
DG
458 struct ltt_ust_channel *uchan)
459{
460 return 0;
461}
462static inline
35a9059d 463int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
cc920def
DG
464 struct ltt_ust_channel *uchan)
465{
466 return 0;
467}
468static inline
35a9059d
DG
469int ust_app_create_event_glb(struct ltt_ust_session *usess,
470 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
471{
472 return 0;
473}
474static inline
475int ust_app_disable_event_glb(struct ltt_ust_session *usess,
cc920def
DG
476 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
477{
478 return 0;
487cf67c 479}
edb67388 480static inline
35a9059d 481int ust_app_enable_event_glb(struct ltt_ust_session *usess,
edb67388
DG
482 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
483{
484 return 0;
485}
55cc08a6 486static inline
55cc08a6
DG
487int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
488 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
489{
490 return 0;
491}
76d45b40
DG
492static inline
493int ust_app_enable_event_pid(struct ltt_ust_session *usess,
494 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
495 pid_t pid)
496{
497 return 0;
498}
7f79d3a1 499static inline
d0b96690
DG
500int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
501{
502 return 0;
503}
504static inline
505int ust_app_recv_notify(int sock)
4466912f
DG
506{
507 return 0;
508}
d0b96690
DG
509static inline
510struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
511{
512 return NULL;
513}
514static inline
515void ust_app_add(struct ust_app *app)
516{
517}
d88aee68
DG
518static inline
519void ust_app_notify_sock_unregister(int sock)
520{
521}
331744e3
JD
522static inline
523ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
524 struct consumer_socket *socket, int send_zero_data)
525{
526 return 0;
527}
f45e313d
DG
528static inline
529void ust_app_destroy(struct ust_app *app)
530{
531 return;
532}
6dc3064a
DG
533static inline
534int ust_app_snapshot_record(struct ltt_ust_session *usess,
68808f4e 535 struct snapshot_output *output, int wait, uint64_t max_stream_size)
5c786ded
JD
536{
537 return 0;
538}
539static inline
540unsigned int ust_app_get_nb_stream(struct ltt_ust_session *usess)
6dc3064a
DG
541{
542 return 0;
543}
48842b30 544
b51ec5b4
MD
545static inline
546int ust_app_supported(void)
547{
548 return 0;
549}
f20baf8e
DG
550static inline
551struct ust_app *ust_app_find_by_sock(int sock)
552{
553 return NULL;
554}
95b1d17c
DG
555static inline
556struct ust_app *ust_app_find_by_pid(pid_t pid)
557{
558 return NULL;
559}
16f35901
JG
560static inline
561uint64_t ust_app_get_size_one_more_packet_per_stream(
562 struct ltt_ust_session *usess, uint64_t cur_nr_packets) {
563 return 0;
564}
fb83fe64
JD
565static inline
566int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id,
567 struct cds_list_head *buffer_reg_uid_list,
568 struct consumer_output *consumer, int overwrite,
569 uint64_t uchan_id, uint64_t *discarded, uint64_t *lost)
570{
571 return 0;
572}
573
574static inline
575int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session *usess,
576 struct ltt_ust_channel *uchan,
577 struct consumer_output *consumer,
578 int overwrite, uint64_t *discarded, uint64_t *lost)
579{
580 return 0;
581}
b51ec5b4 582
6f698634
JG
583static inline
584int ust_app_regenerate_statedump_all(struct ltt_ust_session *usess)
585{
586 return 0;
587}
588
74d0b642 589#endif /* HAVE_LIBLTTNG_UST_CTL */
3bd1e081 590
f6a9efaa 591#endif /* _LTT_UST_APP_H */
This page took 0.138381 seconds and 4 git commands to generate.