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