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