rculfhash: check for callers from RCU read-side C.S.
[lttng-tools.git] / src / bin / lttng-sessiond / ust-app.h
1 /*
2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
3 *
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.
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 *
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.
16 */
17
18 #ifndef _LTT_UST_APP_H
19 #define _LTT_UST_APP_H
20
21 #include <stdint.h>
22
23 #include <common/compat/uuid.h>
24 #include "trace-ust.h"
25 #include "ust-registry.h"
26
27 #define UST_APP_EVENT_LIST_SIZE 32
28
29 /* Process name (short). */
30 #define UST_APP_PROCNAME_LEN 16
31
32 struct lttng_filter_bytecode;
33 struct lttng_ust_filter_bytecode;
34
35 extern int ust_consumerd64_fd, ust_consumerd32_fd;
36
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 */
42 struct ust_app_notify_sock_obj {
43 int fd;
44 struct rcu_head head;
45 };
46
47 struct 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
53 /*
54 * Application registration data structure.
55 */
56 struct ust_register_msg {
57 enum ustctl_socket_type type;
58 uint32_t major;
59 uint32_t minor;
60 uint32_t abi_major;
61 uint32_t abi_minor;
62 pid_t pid;
63 pid_t ppid;
64 uid_t uid;
65 gid_t gid;
66 uint32_t bits_per_long;
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];
74 };
75
76 /*
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.
79 */
80 struct lttng_ht *ust_app_ht;
81
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 */
86 struct lttng_ht *ust_app_ht_by_sock;
87
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 */
92 struct lttng_ht *ust_app_ht_by_notify_sock;
93
94 /* Stream list containing ust_app_stream. */
95 struct ust_app_stream_list {
96 unsigned int count;
97 struct cds_list_head head;
98 };
99
100 struct ust_app_ctx {
101 int handle;
102 struct lttng_ust_context ctx;
103 struct lttng_ust_object_data *obj;
104 struct lttng_ht_node_ulong node;
105 };
106
107 struct ust_app_event {
108 int enabled;
109 int handle;
110 struct lttng_ust_object_data *obj;
111 struct lttng_ust_event attr;
112 char name[LTTNG_UST_SYM_NAME_LEN];
113 struct lttng_ht_node_str node;
114 struct lttng_ust_filter_bytecode *filter;
115 };
116
117 struct 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
127 struct ust_app_channel {
128 int enabled;
129 int handle;
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. */
133 uint64_t key;
134 /* Id of the tracing channel set on creation. */
135 uint64_t tracing_channel_id;
136 /* Number of stream that this channel is expected to receive. */
137 unsigned int expected_stream_count;
138 char name[LTTNG_UST_SYM_NAME_LEN];
139 struct lttng_ust_object_data *obj;
140 struct ustctl_consumer_channel_attr attr;
141 struct ust_app_stream_list streams;
142 /* Session pointer that owns this object. */
143 struct ust_app_session *session;
144 struct lttng_ht *ctx;
145 struct lttng_ht *events;
146 uint64_t tracefile_size;
147 uint64_t tracefile_count;
148 /*
149 * Node indexed by channel name in the channels' hash table of a session.
150 */
151 struct lttng_ht_node_str node;
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;
157 };
158
159 struct ust_app_session {
160 /*
161 * Lock protecting this session's ust app interaction. Held
162 * across command send/recv to/from app. Never nests within the
163 * session registry lock.
164 */
165 pthread_mutex_t lock;
166
167 int enabled;
168 /* started: has the session been in started state at any time ? */
169 int started; /* allows detection of start vs restart. */
170 int handle; /* used has unique identifier for app session */
171
172 /*
173 * Tracing session ID. Multiple ust app session can have the same tracing
174 * session id making this value NOT unique to the object.
175 */
176 int tracing_id;
177 uint64_t id; /* Unique session identifier */
178 struct lttng_ht *channels; /* Registered channels */
179 struct lttng_ht_node_ulong node;
180 char path[PATH_MAX];
181 /* UID/GID of the application owning the session */
182 uid_t uid;
183 gid_t gid;
184 /* Effective UID and GID. Same as the tracing session. */
185 uid_t euid;
186 gid_t egid;
187 struct cds_list_head teardown_node;
188 /*
189 * Once at least *one* session is created onto the application, the
190 * corresponding consumer is set so we can use it on unregistration.
191 */
192 struct consumer_output *consumer;
193 enum lttng_buffer_type buffer_type;
194 /* ABI of the session. Same value as the application. */
195 uint32_t bits_per_long;
196 };
197
198 /*
199 * Registered traceable applications. Libust registers to the session daemon
200 * and a linked list is kept of all running traceable app.
201 */
202 struct ust_app {
203 int sock;
204 int notify_sock;
205 pid_t pid;
206 pid_t ppid;
207 uid_t uid; /* User ID that owns the apps */
208 gid_t gid; /* Group ID that owns the apps */
209
210 /* App ABI */
211 uint32_t bits_per_long;
212 uint32_t uint8_t_alignment;
213 uint32_t uint16_t_alignment;
214 uint32_t uint32_t_alignment;
215 uint32_t uint64_t_alignment;
216 uint32_t long_alignment;
217 int byte_order; /* BIG_ENDIAN or LITTLE_ENDIAN */
218
219 int compatible; /* If the lttng-ust tracer version does not match the
220 supported version of the session daemon, this flag is
221 set to 0 (NOT compatible) else 1. */
222 struct lttng_ust_tracer_version version;
223 uint32_t v_major; /* Version major number */
224 uint32_t v_minor; /* Version minor number */
225 /* Extra for the NULL byte. */
226 char name[UST_APP_PROCNAME_LEN + 1];
227 /* Type of buffer this application uses. */
228 enum lttng_buffer_type buffer_type;
229 struct lttng_ht *sessions;
230 struct lttng_ht_node_ulong pid_n;
231 struct lttng_ht_node_ulong sock_n;
232 struct lttng_ht_node_ulong notify_sock_n;
233 /*
234 * This is a list of ust app session that, once the app is going into
235 * teardown mode, in the RCU call, each node in this list is removed and
236 * deleted.
237 *
238 * Element of the list are added when an application unregisters after each
239 * ht_del of ust_app_session associated to this app. This list is NOT used
240 * when a session is destroyed.
241 */
242 struct cds_list_head teardown_head;
243 /*
244 * Hash table containing ust_app_channel indexed by channel objd.
245 */
246 struct lttng_ht *ust_objd;
247 };
248
249 #ifdef HAVE_LIBLTTNG_UST_CTL
250
251 int ust_app_register(struct ust_register_msg *msg, int sock);
252 static inline
253 int ust_app_register_done(int sock)
254 {
255 return ustctl_register_done(sock);
256 }
257 int ust_app_version(struct ust_app *app);
258 void ust_app_unregister(int sock);
259 unsigned long ust_app_list_count(void);
260 int ust_app_start_trace_all(struct ltt_ust_session *usess);
261 int ust_app_stop_trace_all(struct ltt_ust_session *usess);
262 int ust_app_destroy_trace_all(struct ltt_ust_session *usess);
263 int ust_app_list_events(struct lttng_event **events);
264 int ust_app_list_event_fields(struct lttng_event_field **fields);
265 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
266 struct ltt_ust_channel *uchan);
267 int ust_app_create_event_glb(struct ltt_ust_session *usess,
268 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
269 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
270 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
271 pid_t pid);
272 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
273 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
274 pid_t pid);
275 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
276 struct ltt_ust_channel *uchan);
277 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
278 struct ltt_ust_channel *uchan);
279 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
280 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
281 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
282 struct ltt_ust_channel *uchan);
283 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
284 struct ltt_ust_channel *uchan);
285 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
286 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent);
287 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
288 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx);
289 void ust_app_global_update(struct ltt_ust_session *usess, int sock);
290
291 void ust_app_clean_list(void);
292 void ust_app_ht_alloc(void);
293 struct lttng_ht *ust_app_get_ht(void);
294 struct ust_app *ust_app_find_by_pid(pid_t pid);
295 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate);
296 struct ust_app_stream *ust_app_alloc_stream(void);
297 int ust_app_recv_registration(int sock, struct ust_register_msg *msg);
298 int ust_app_recv_notify(int sock);
299 void ust_app_add(struct ust_app *app);
300 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock);
301 void ust_app_notify_sock_unregister(int sock);
302 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
303 struct consumer_socket *socket, int send_zero_data);
304
305 #else /* HAVE_LIBLTTNG_UST_CTL */
306
307 static inline
308 int ust_app_destroy_trace_all(struct ltt_ust_session *usess)
309 {
310 return 0;
311 }
312 static inline
313 int ust_app_start_trace(struct ltt_ust_session *usess, struct ust_app *app)
314 {
315 return 0;
316 }
317 static inline
318 int ust_app_start_trace_all(struct ltt_ust_session *usess)
319 {
320 return 0;
321 }
322 static inline
323 int ust_app_stop_trace_all(struct ltt_ust_session *usess)
324 {
325 return 0;
326 }
327 static inline
328 int ust_app_list_events(struct lttng_event **events)
329 {
330 return -ENOSYS;
331 }
332 static inline
333 int ust_app_list_event_fields(struct lttng_event_field **fields)
334 {
335 return -ENOSYS;
336 }
337 static inline
338 int ust_app_register(struct ust_register_msg *msg, int sock)
339 {
340 return -ENOSYS;
341 }
342 static inline
343 int ust_app_register_done(int sock)
344 {
345 return -ENOSYS;
346 }
347 static inline
348 int ust_app_version(struct ust_app *app)
349 {
350 return -ENOSYS;
351 }
352 static inline
353 void ust_app_unregister(int sock)
354 {
355 }
356 static inline
357 unsigned int ust_app_list_count(void)
358 {
359 return 0;
360 }
361 static inline
362 void ust_app_lock_list(void)
363 {
364 }
365 static inline
366 void ust_app_unlock_list(void)
367 {
368 }
369 static inline
370 void ust_app_clean_list(void)
371 {
372 }
373 static inline
374 struct ust_app_list *ust_app_get_list(void)
375 {
376 return NULL;
377 }
378 static inline
379 struct ust_app *ust_app_get_by_pid(pid_t pid)
380 {
381 return NULL;
382 }
383 static inline
384 struct lttng_ht *ust_app_get_ht(void)
385 {
386 return NULL;
387 }
388 static inline
389 void ust_app_ht_alloc(void)
390 {}
391 static inline
392 void ust_app_global_update(struct ltt_ust_session *usess, int sock)
393 {}
394 static inline
395 int ust_app_disable_channel_glb(struct ltt_ust_session *usess,
396 struct ltt_ust_channel *uchan)
397 {
398 return 0;
399 }
400 static inline
401 int ust_app_enable_channel_glb(struct ltt_ust_session *usess,
402 struct ltt_ust_channel *uchan)
403 {
404 return 0;
405 }
406 static inline
407 int ust_app_create_channel_glb(struct ltt_ust_session *usess,
408 struct ltt_ust_channel *uchan)
409 {
410 return 0;
411 }
412 static inline
413 int ust_app_disable_all_event_glb(struct ltt_ust_session *usess,
414 struct ltt_ust_channel *uchan)
415 {
416 return 0;
417 }
418 static inline
419 int ust_app_enable_all_event_glb(struct ltt_ust_session *usess,
420 struct ltt_ust_channel *uchan)
421 {
422 return 0;
423 }
424 static inline
425 int ust_app_create_event_glb(struct ltt_ust_session *usess,
426 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
427 {
428 return 0;
429 }
430 static inline
431 int ust_app_disable_event_glb(struct ltt_ust_session *usess,
432 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
433 {
434 return 0;
435 }
436 static inline
437 int ust_app_enable_event_glb(struct ltt_ust_session *usess,
438 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent)
439 {
440 return 0;
441 }
442 static inline
443 int ust_app_add_ctx_channel_glb(struct ltt_ust_session *usess,
444 struct ltt_ust_channel *uchan, struct ltt_ust_context *uctx)
445 {
446 return 0;
447 }
448 static inline
449 int ust_app_enable_event_pid(struct ltt_ust_session *usess,
450 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
451 pid_t pid)
452 {
453 return 0;
454 }
455 static inline
456 int ust_app_disable_event_pid(struct ltt_ust_session *usess,
457 struct ltt_ust_channel *uchan, struct ltt_ust_event *uevent,
458 pid_t pid)
459 {
460 return 0;
461 }
462 static inline
463 int ust_app_calibrate_glb(struct lttng_ust_calibrate *calibrate)
464 {
465 return 0;
466 }
467 static inline
468 int ust_app_recv_registration(int sock, struct ust_register_msg *msg)
469 {
470 return 0;
471 }
472 static inline
473 int ust_app_recv_notify(int sock)
474 {
475 return 0;
476 }
477 static inline
478 struct ust_app *ust_app_create(struct ust_register_msg *msg, int sock)
479 {
480 return NULL;
481 }
482 static inline
483 void ust_app_add(struct ust_app *app)
484 {
485 }
486 static inline
487 void ust_app_notify_sock_unregister(int sock)
488 {
489 }
490 static inline
491 ssize_t ust_app_push_metadata(struct ust_registry_session *registry,
492 struct consumer_socket *socket, int send_zero_data)
493 {
494 return 0;
495 }
496
497 #endif /* HAVE_LIBLTTNG_UST_CTL */
498
499 #endif /* _LTT_UST_APP_H */
This page took 0.045253 seconds and 4 git commands to generate.