Refactor Python agent
[lttng-ust.git] / liblttng-ust / lttng-ust-comm.c
CommitLineData
2691221a
MD
1/*
2 * lttng-ust-comm.c
3 *
4 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
5 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; only
10 * version 2.1 of the License.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
80e2814b 22#define _LGPL_SOURCE
5e1b7b8b 23#define _GNU_SOURCE
2691221a
MD
24#include <sys/types.h>
25#include <sys/socket.h>
7fc90dca
MD
26#include <sys/mman.h>
27#include <sys/stat.h>
58d4b2a2
MD
28#include <sys/types.h>
29#include <sys/wait.h>
7fc90dca 30#include <fcntl.h>
2691221a
MD
31#include <unistd.h>
32#include <errno.h>
d9e99d10 33#include <pthread.h>
11ff9c7d
MD
34#include <semaphore.h>
35#include <time.h>
1ea11eab 36#include <assert.h>
e822f505 37#include <signal.h>
95259bd0 38#include <urcu/uatomic.h>
80e2814b 39#include <urcu/futex.h>
c117fb1b 40#include <urcu/compiler.h>
1ea11eab 41
4318ae1b 42#include <lttng/ust-events.h>
4318ae1b 43#include <lttng/ust-abi.h>
4318ae1b 44#include <lttng/ust.h>
7bc53e94 45#include <lttng/ust-error.h>
74d81a6c 46#include <lttng/ust-ctl.h>
8c90a710 47#include <urcu/tls-compat.h>
44c72f10
MD
48#include <ust-comm.h>
49#include <usterr-signal-safe.h>
cd54f6d9 50#include <helper.h>
44c72f10 51#include "tracepoint-internal.h"
7dd08bec 52#include "lttng-tracer-core.h"
08114193 53#include "compat.h"
f645cfa7 54#include "../libringbuffer/tlsfixup.h"
394598c1 55#include "lttng-ust-baddr.h"
f9364363 56#include "clock.h"
5e1b7b8b 57#include "../libringbuffer/getcpu.h"
13efba44 58#include "getenv.h"
edaa1431
MD
59
60/*
61 * Has lttng ust comm constructor been called ?
62 */
63static int initialized;
64
1ea11eab 65/*
17dfb34b
MD
66 * The ust_lock/ust_unlock lock is used as a communication thread mutex.
67 * Held when handling a command, also held by fork() to deal with
68 * removal of threads, and by exit path.
3327ac33
MD
69 *
70 * The UST lock is the centralized mutex across UST tracing control and
71 * probe registration.
72 *
73 * ust_exit_mutex must never nest in ust_mutex.
d58d1454 74 *
4770bd47
MD
75 * ust_fork_mutex must never nest in ust_mutex.
76 *
d58d1454
MD
77 * ust_mutex_nest is a per-thread nesting counter, allowing the perf
78 * counter lazy initialization called by events within the statedump,
79 * which traces while the ust_mutex is held.
4770bd47
MD
80 *
81 * ust_lock nests within the dynamic loader lock (within glibc) because
82 * it is taken within the library constructor.
3327ac33
MD
83 */
84static pthread_mutex_t ust_mutex = PTHREAD_MUTEX_INITIALIZER;
85
d58d1454
MD
86/* Allow nesting the ust_mutex within the same thread. */
87static DEFINE_URCU_TLS(int, ust_mutex_nest);
88
3327ac33
MD
89/*
90 * ust_exit_mutex protects thread_active variable wrt thread exit. It
91 * cannot be done by ust_mutex because pthread_cancel(), which takes an
92 * internal libc lock, cannot nest within ust_mutex.
93 *
94 * It never nests within a ust_mutex.
1ea11eab 95 */
3327ac33 96static pthread_mutex_t ust_exit_mutex = PTHREAD_MUTEX_INITIALIZER;
1ea11eab 97
458d678c
PW
98/*
99 * ust_fork_mutex protects base address statedump tracing against forks. It
100 * prevents the dynamic loader lock to be taken (by base address statedump
101 * tracing) while a fork is happening, thus preventing deadlock issues with
102 * the dynamic loader lock.
103 */
104static pthread_mutex_t ust_fork_mutex = PTHREAD_MUTEX_INITIALIZER;
105
1ea11eab
MD
106/* Should the ust comm thread quit ? */
107static int lttng_ust_comm_should_quit;
108
3327ac33 109/*
d58d1454 110 * Return 0 on success, -1 if should quit.
3327ac33 111 * The lock is taken in both cases.
d58d1454 112 * Signal-safe.
3327ac33
MD
113 */
114int ust_lock(void)
115{
d58d1454
MD
116 sigset_t sig_all_blocked, orig_mask;
117 int ret;
118
119 sigfillset(&sig_all_blocked);
120 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
121 if (ret) {
122 ERR("pthread_sigmask: %s", strerror(ret));
123 }
124 if (!URCU_TLS(ust_mutex_nest)++)
125 pthread_mutex_lock(&ust_mutex);
126 ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
127 if (ret) {
128 ERR("pthread_sigmask: %s", strerror(ret));
129 }
3327ac33
MD
130 if (lttng_ust_comm_should_quit) {
131 return -1;
132 } else {
133 return 0;
134 }
135}
136
137/*
138 * ust_lock_nocheck() can be used in constructors/destructors, because
139 * they are already nested within the dynamic loader lock, and therefore
140 * have exclusive access against execution of liblttng-ust destructor.
d58d1454 141 * Signal-safe.
3327ac33
MD
142 */
143void ust_lock_nocheck(void)
144{
d58d1454
MD
145 sigset_t sig_all_blocked, orig_mask;
146 int ret;
147
148 sigfillset(&sig_all_blocked);
149 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
150 if (ret) {
151 ERR("pthread_sigmask: %s", strerror(ret));
152 }
153 if (!URCU_TLS(ust_mutex_nest)++)
154 pthread_mutex_lock(&ust_mutex);
155 ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
156 if (ret) {
157 ERR("pthread_sigmask: %s", strerror(ret));
158 }
3327ac33
MD
159}
160
d58d1454
MD
161/*
162 * Signal-safe.
163 */
3327ac33
MD
164void ust_unlock(void)
165{
d58d1454
MD
166 sigset_t sig_all_blocked, orig_mask;
167 int ret;
168
169 sigfillset(&sig_all_blocked);
170 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_mask);
171 if (ret) {
172 ERR("pthread_sigmask: %s", strerror(ret));
173 }
174 if (!--URCU_TLS(ust_mutex_nest))
175 pthread_mutex_unlock(&ust_mutex);
176 ret = pthread_sigmask(SIG_SETMASK, &orig_mask, NULL);
177 if (ret) {
178 ERR("pthread_sigmask: %s", strerror(ret));
179 }
3327ac33
MD
180}
181
11ff9c7d
MD
182/*
183 * Wait for either of these before continuing to the main
184 * program:
185 * - the register_done message from sessiond daemon
186 * (will let the sessiond daemon enable sessions before main
187 * starts.)
188 * - sessiond daemon is not reachable.
189 * - timeout (ensuring applications are resilient to session
190 * daemon problems).
191 */
192static sem_t constructor_wait;
950aab0c
MD
193/*
194 * Doing this for both the global and local sessiond.
195 */
95259bd0 196static int sem_count = { 2 };
11ff9c7d 197
e8508a49
MD
198/*
199 * Counting nesting within lttng-ust. Used to ensure that calling fork()
200 * from liblttng-ust does not execute the pre/post fork handlers.
201 */
8c90a710 202static DEFINE_URCU_TLS(int, lttng_ust_nest_count);
e8508a49 203
1ea11eab
MD
204/*
205 * Info about socket and associated listener thread.
206 */
207struct sock_info {
11ff9c7d 208 const char *name;
1ea11eab 209 pthread_t ust_listener; /* listener thread */
46050b1a 210 int root_handle;
8d20bf54
MD
211 int constructor_sem_posted;
212 int allowed;
44e073f5 213 int global;
e33f3265 214 int thread_active;
7fc90dca
MD
215
216 char sock_path[PATH_MAX];
217 int socket;
32ce8569 218 int notify_socket;
7fc90dca
MD
219
220 char wait_shm_path[PATH_MAX];
221 char *wait_shm_mmap;
37dddb65
MD
222 /* Keep track of lazy state dump not performed yet. */
223 int statedump_pending;
1ea11eab 224};
2691221a
MD
225
226/* Socket from app (connect) to session daemon (listen) for communication */
1ea11eab 227struct sock_info global_apps = {
11ff9c7d 228 .name = "global",
44e073f5 229 .global = 1,
7fc90dca 230
46050b1a 231 .root_handle = -1,
8d20bf54 232 .allowed = 1,
e33f3265 233 .thread_active = 0,
7fc90dca 234
32ce8569 235 .sock_path = LTTNG_DEFAULT_RUNDIR "/" LTTNG_UST_SOCK_FILENAME,
7fc90dca 236 .socket = -1,
32ce8569 237 .notify_socket = -1,
7fc90dca 238
32ce8569 239 .wait_shm_path = "/" LTTNG_UST_WAIT_FILENAME,
95c25348 240
37dddb65 241 .statedump_pending = 0,
1ea11eab 242};
2691221a
MD
243
244/* TODO: allow global_apps_sock_path override */
245
1ea11eab 246struct sock_info local_apps = {
11ff9c7d 247 .name = "local",
44e073f5 248 .global = 0,
46050b1a 249 .root_handle = -1,
8d20bf54 250 .allowed = 0, /* Check setuid bit first */
e33f3265 251 .thread_active = 0,
7fc90dca
MD
252
253 .socket = -1,
32ce8569 254 .notify_socket = -1,
95c25348 255
37dddb65 256 .statedump_pending = 0,
1ea11eab 257};
2691221a 258
37ed587a
MD
259static int wait_poll_fallback;
260
74d81a6c
MD
261static const char *cmd_name_mapping[] = {
262 [ LTTNG_UST_RELEASE ] = "Release",
263 [ LTTNG_UST_SESSION ] = "Create Session",
264 [ LTTNG_UST_TRACER_VERSION ] = "Get Tracer Version",
265
266 [ LTTNG_UST_TRACEPOINT_LIST ] = "Create Tracepoint List",
267 [ LTTNG_UST_WAIT_QUIESCENT ] = "Wait for Quiescent State",
268 [ LTTNG_UST_REGISTER_DONE ] = "Registration Done",
269 [ LTTNG_UST_TRACEPOINT_FIELD_LIST ] = "Create Tracepoint Field List",
270
271 /* Session FD commands */
272 [ LTTNG_UST_CHANNEL ] = "Create Channel",
273 [ LTTNG_UST_SESSION_START ] = "Start Session",
274 [ LTTNG_UST_SESSION_STOP ] = "Stop Session",
275
276 /* Channel FD commands */
277 [ LTTNG_UST_STREAM ] = "Create Stream",
278 [ LTTNG_UST_EVENT ] = "Create Event",
279
280 /* Event and Channel FD commands */
281 [ LTTNG_UST_CONTEXT ] = "Create Context",
282 [ LTTNG_UST_FLUSH_BUFFER ] = "Flush Buffer",
283
284 /* Event, Channel and Session commands */
285 [ LTTNG_UST_ENABLE ] = "Enable",
286 [ LTTNG_UST_DISABLE ] = "Disable",
287
288 /* Tracepoint list commands */
289 [ LTTNG_UST_TRACEPOINT_LIST_GET ] = "List Next Tracepoint",
290 [ LTTNG_UST_TRACEPOINT_FIELD_LIST_GET ] = "List Next Tracepoint Field",
291
292 /* Event FD commands */
293 [ LTTNG_UST_FILTER ] = "Create Filter",
75582b3a 294 [ LTTNG_UST_EXCLUSION ] = "Add exclusions to event",
74d81a6c
MD
295};
296
ff517991
MD
297static const char *str_timeout;
298static int got_timeout_env;
299
7dd08bec 300extern void lttng_ring_buffer_client_overwrite_init(void);
34a91bdb 301extern void lttng_ring_buffer_client_overwrite_rt_init(void);
7dd08bec 302extern void lttng_ring_buffer_client_discard_init(void);
34a91bdb 303extern void lttng_ring_buffer_client_discard_rt_init(void);
7dd08bec
MD
304extern void lttng_ring_buffer_metadata_client_init(void);
305extern void lttng_ring_buffer_client_overwrite_exit(void);
34a91bdb 306extern void lttng_ring_buffer_client_overwrite_rt_exit(void);
7dd08bec 307extern void lttng_ring_buffer_client_discard_exit(void);
34a91bdb 308extern void lttng_ring_buffer_client_discard_rt_exit(void);
7dd08bec 309extern void lttng_ring_buffer_metadata_client_exit(void);
edaa1431 310
3c6f6263
AM
311/*
312 * Returns the HOME directory path. Caller MUST NOT free(3) the returned
313 * pointer.
314 */
315static
316const char *get_lttng_home_dir(void)
317{
318 const char *val;
319
13efba44 320 val = (const char *) lttng_secure_getenv("LTTNG_HOME");
3c6f6263
AM
321 if (val != NULL) {
322 return val;
323 }
13efba44 324 return (const char *) lttng_secure_getenv("HOME");
3c6f6263
AM
325}
326
a903623f
MD
327/*
328 * Force a read (imply TLS fixup for dlopen) of TLS variables.
329 */
330static
331void lttng_fixup_nest_count_tls(void)
332{
8c90a710 333 asm volatile ("" : : "m" (URCU_TLS(lttng_ust_nest_count)));
a903623f
MD
334}
335
d58d1454
MD
336static
337void lttng_fixup_ust_mutex_nest_tls(void)
338{
339 asm volatile ("" : : "m" (URCU_TLS(ust_mutex_nest)));
340}
341
1556a549
MD
342/*
343 * Fixup urcu bp TLS.
344 */
345static
346void lttng_fixup_urcu_bp_tls(void)
347{
348 rcu_read_lock();
349 rcu_read_unlock();
350}
351
32ce8569
MD
352int lttng_get_notify_socket(void *owner)
353{
354 struct sock_info *info = owner;
355
356 return info->notify_socket;
357}
358
74d81a6c
MD
359static
360void print_cmd(int cmd, int handle)
361{
362 const char *cmd_name = "Unknown";
363
fd67a004
MD
364 if (cmd >= 0 && cmd < LTTNG_ARRAY_SIZE(cmd_name_mapping)
365 && cmd_name_mapping[cmd]) {
74d81a6c
MD
366 cmd_name = cmd_name_mapping[cmd];
367 }
fd67a004
MD
368 DBG("Message Received \"%s\" (%d), Handle \"%s\" (%d)",
369 cmd_name, cmd,
74d81a6c
MD
370 lttng_ust_obj_get_name(handle), handle);
371}
372
2691221a 373static
8d20bf54 374int setup_local_apps(void)
2691221a
MD
375{
376 const char *home_dir;
7fc90dca 377 uid_t uid;
2691221a 378
7fc90dca 379 uid = getuid();
8d20bf54
MD
380 /*
381 * Disallow per-user tracing for setuid binaries.
382 */
7fc90dca 383 if (uid != geteuid()) {
9ec6895c 384 assert(local_apps.allowed == 0);
d0a1ae63 385 return 0;
8d20bf54 386 }
3c6f6263 387 home_dir = get_lttng_home_dir();
9ec6895c
MD
388 if (!home_dir) {
389 WARN("HOME environment variable not set. Disabling LTTng-UST per-user tracing.");
390 assert(local_apps.allowed == 0);
2691221a 391 return -ENOENT;
9ec6895c
MD
392 }
393 local_apps.allowed = 1;
32ce8569
MD
394 snprintf(local_apps.sock_path, PATH_MAX, "%s/%s/%s",
395 home_dir,
396 LTTNG_DEFAULT_HOME_RUNDIR,
397 LTTNG_UST_SOCK_FILENAME);
398 snprintf(local_apps.wait_shm_path, PATH_MAX, "/%s-%u",
399 LTTNG_UST_WAIT_FILENAME,
400 uid);
2691221a
MD
401 return 0;
402}
403
ff517991
MD
404/*
405 * Get notify_sock timeout, in ms.
28515902 406 * -1: wait forever. 0: don't wait. >0: timeout, in ms.
ff517991
MD
407 */
408static
409long get_timeout(void)
410{
411 long constructor_delay_ms = LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS;
412
413 if (!got_timeout_env) {
414 str_timeout = getenv("LTTNG_UST_REGISTER_TIMEOUT");
415 got_timeout_env = 1;
416 }
417 if (str_timeout)
418 constructor_delay_ms = strtol(str_timeout, NULL, 10);
419 return constructor_delay_ms;
420}
421
422static
423long get_notify_sock_timeout(void)
424{
425 return get_timeout();
426}
427
428/*
28515902 429 * Return values: -1: wait forever. 0: don't wait. 1: timeout wait.
ff517991
MD
430 */
431static
432int get_constructor_timeout(struct timespec *constructor_timeout)
433{
434 long constructor_delay_ms;
435 int ret;
436
437 constructor_delay_ms = get_timeout();
438
439 switch (constructor_delay_ms) {
440 case -1:/* fall-through */
441 case 0:
442 return constructor_delay_ms;
443 default:
444 break;
445 }
446
447 /*
448 * If we are unable to find the current time, don't wait.
449 */
450 ret = clock_gettime(CLOCK_REALTIME, constructor_timeout);
451 if (ret) {
28515902
JG
452 /* Don't wait. */
453 return 0;
ff517991
MD
454 }
455 constructor_timeout->tv_sec += constructor_delay_ms / 1000UL;
456 constructor_timeout->tv_nsec +=
457 (constructor_delay_ms % 1000UL) * 1000000UL;
458 if (constructor_timeout->tv_nsec >= 1000000000UL) {
459 constructor_timeout->tv_sec++;
460 constructor_timeout->tv_nsec -= 1000000000UL;
461 }
28515902 462 /* Timeout wait (constructor_delay_ms). */
ff517991
MD
463 return 1;
464}
465
2691221a 466static
32ce8569 467int register_to_sessiond(int socket, enum ustctl_socket_type type)
2691221a 468{
32ce8569
MD
469 return ustcomm_send_reg_msg(socket,
470 type,
471 CAA_BITS_PER_LONG,
472 lttng_alignof(uint8_t) * CHAR_BIT,
473 lttng_alignof(uint16_t) * CHAR_BIT,
474 lttng_alignof(uint32_t) * CHAR_BIT,
475 lttng_alignof(uint64_t) * CHAR_BIT,
476 lttng_alignof(unsigned long) * CHAR_BIT);
2691221a
MD
477}
478
d9e99d10 479static
57773204 480int send_reply(int sock, struct ustcomm_ust_reply *lur)
d9e99d10 481{
9eb62b9c 482 ssize_t len;
d3a492d1 483
57773204 484 len = ustcomm_send_unix_sock(sock, lur, sizeof(*lur));
d3a492d1 485 switch (len) {
a4be8962 486 case sizeof(*lur):
d3a492d1
MD
487 DBG("message successfully sent");
488 return 0;
7bc53e94
MD
489 default:
490 if (len == -ECONNRESET) {
491 DBG("remote end closed connection");
d3a492d1
MD
492 return 0;
493 }
7bc53e94
MD
494 if (len < 0)
495 return len;
496 DBG("incorrect message size: %zd", len);
497 return -EINVAL;
d3a492d1
MD
498 }
499}
500
501static
edaa1431 502int handle_register_done(struct sock_info *sock_info)
11ff9c7d
MD
503{
504 int ret;
505
edaa1431
MD
506 if (sock_info->constructor_sem_posted)
507 return 0;
508 sock_info->constructor_sem_posted = 1;
56cd7e2f
MD
509 if (uatomic_read(&sem_count) <= 0) {
510 return 0;
511 }
95259bd0
MD
512 ret = uatomic_add_return(&sem_count, -1);
513 if (ret == 0) {
514 ret = sem_post(&constructor_wait);
515 assert(!ret);
516 }
11ff9c7d
MD
517 return 0;
518}
519
37dddb65
MD
520/*
521 * Only execute pending statedump after the constructor semaphore has
522 * been posted by each listener thread. This means statedump will only
523 * be performed after the "registration done" command is received from
524 * each session daemon the application is connected to.
525 *
526 * This ensures we don't run into deadlock issues with the dynamic
527 * loader mutex, which is held while the constructor is called and
528 * waiting on the constructor semaphore. All operations requiring this
529 * dynamic loader lock need to be postponed using this mechanism.
530 */
531static
532void handle_pending_statedump(struct sock_info *sock_info)
533{
534 int ctor_passed = sock_info->constructor_sem_posted;
535
536 if (ctor_passed && sock_info->statedump_pending) {
537 sock_info->statedump_pending = 0;
2932a87f 538 pthread_mutex_lock(&ust_fork_mutex);
37dddb65 539 lttng_handle_pending_statedump(sock_info);
458d678c 540 pthread_mutex_unlock(&ust_fork_mutex);
37dddb65
MD
541 }
542}
543
11ff9c7d
MD
544static
545int handle_message(struct sock_info *sock_info,
57773204 546 int sock, struct ustcomm_ust_msg *lum)
d3a492d1 547{
1ea11eab 548 int ret = 0;
b61ce3b2 549 const struct lttng_ust_objd_ops *ops;
57773204 550 struct ustcomm_ust_reply lur;
ef9ff354 551 union ust_args args;
40003310 552 ssize_t len;
1ea11eab 553
46050b1a
MD
554 memset(&lur, 0, sizeof(lur));
555
3327ac33 556 if (ust_lock()) {
74d81a6c 557 ret = -LTTNG_UST_ERR_EXITING;
1ea11eab
MD
558 goto end;
559 }
9eb62b9c 560
46050b1a
MD
561 ops = objd_ops(lum->handle);
562 if (!ops) {
563 ret = -ENOENT;
564 goto end;
1ea11eab 565 }
46050b1a
MD
566
567 switch (lum->cmd) {
11ff9c7d
MD
568 case LTTNG_UST_REGISTER_DONE:
569 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
edaa1431 570 ret = handle_register_done(sock_info);
11ff9c7d
MD
571 else
572 ret = -EINVAL;
573 break;
46050b1a
MD
574 case LTTNG_UST_RELEASE:
575 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
576 ret = -EPERM;
577 else
1849ef7c 578 ret = lttng_ust_objd_unref(lum->handle, 1);
d9e99d10 579 break;
2d78951a
MD
580 case LTTNG_UST_FILTER:
581 {
582 /* Receive filter data */
f488575f 583 struct lttng_ust_filter_bytecode_node *bytecode;
2d78951a 584
cd54f6d9 585 if (lum->u.filter.data_size > FILTER_BYTECODE_MAX_LEN) {
7bc53e94 586 ERR("Filter data size is too large: %u bytes",
2d78951a
MD
587 lum->u.filter.data_size);
588 ret = -EINVAL;
589 goto error;
590 }
2734ca65 591
885b1dfd 592 if (lum->u.filter.reloc_offset > lum->u.filter.data_size) {
7bc53e94 593 ERR("Filter reloc offset %u is not within data",
2734ca65
CB
594 lum->u.filter.reloc_offset);
595 ret = -EINVAL;
596 goto error;
597 }
598
cd54f6d9
MD
599 bytecode = zmalloc(sizeof(*bytecode) + lum->u.filter.data_size);
600 if (!bytecode) {
601 ret = -ENOMEM;
602 goto error;
603 }
f488575f 604 len = ustcomm_recv_unix_sock(sock, bytecode->bc.data,
2d78951a
MD
605 lum->u.filter.data_size);
606 switch (len) {
607 case 0: /* orderly shutdown */
608 ret = 0;
cd54f6d9 609 free(bytecode);
2d78951a 610 goto error;
2d78951a
MD
611 default:
612 if (len == lum->u.filter.data_size) {
7bc53e94 613 DBG("filter data received");
2d78951a 614 break;
7bc53e94
MD
615 } else if (len < 0) {
616 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
617 if (len == -ECONNRESET) {
618 ERR("%s remote end closed connection", sock_info->name);
619 ret = len;
620 free(bytecode);
621 goto error;
622 }
623 ret = len;
eb8bf361 624 free(bytecode);
7bc53e94 625 goto end;
2d78951a 626 } else {
7bc53e94 627 DBG("incorrect filter data message size: %zd", len);
2d78951a 628 ret = -EINVAL;
cd54f6d9 629 free(bytecode);
2d78951a
MD
630 goto end;
631 }
632 }
f488575f
MD
633 bytecode->bc.len = lum->u.filter.data_size;
634 bytecode->bc.reloc_offset = lum->u.filter.reloc_offset;
3f6fd224 635 bytecode->bc.seqnum = lum->u.filter.seqnum;
cd54f6d9 636 if (ops->cmd) {
2d78951a 637 ret = ops->cmd(lum->handle, lum->cmd,
cd54f6d9 638 (unsigned long) bytecode,
f59ed768 639 &args, sock_info);
cd54f6d9
MD
640 if (ret) {
641 free(bytecode);
642 }
643 /* don't free bytecode if everything went fine. */
644 } else {
2d78951a 645 ret = -ENOSYS;
cd54f6d9
MD
646 free(bytecode);
647 }
2d78951a
MD
648 break;
649 }
86e36163
JI
650 case LTTNG_UST_EXCLUSION:
651 {
652 /* Receive exclusion names */
653 struct lttng_ust_excluder_node *node;
654 unsigned int count;
655
656 count = lum->u.exclusion.count;
657 if (count == 0) {
658 /* There are no names to read */
659 ret = 0;
660 goto error;
661 }
662 node = zmalloc(sizeof(*node) +
663 count * LTTNG_UST_SYM_NAME_LEN);
664 if (!node) {
665 ret = -ENOMEM;
666 goto error;
667 }
668 node->excluder.count = count;
669 len = ustcomm_recv_unix_sock(sock, node->excluder.names,
670 count * LTTNG_UST_SYM_NAME_LEN);
671 switch (len) {
672 case 0: /* orderly shutdown */
673 ret = 0;
674 free(node);
675 goto error;
676 default:
677 if (len == count * LTTNG_UST_SYM_NAME_LEN) {
678 DBG("Exclusion data received");
679 break;
680 } else if (len < 0) {
681 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
682 if (len == -ECONNRESET) {
683 ERR("%s remote end closed connection", sock_info->name);
684 ret = len;
685 free(node);
686 goto error;
687 }
688 ret = len;
689 free(node);
690 goto end;
691 } else {
692 DBG("Incorrect exclusion data message size: %zd", len);
693 ret = -EINVAL;
694 free(node);
695 goto end;
696 }
697 }
698 if (ops->cmd) {
699 ret = ops->cmd(lum->handle, lum->cmd,
700 (unsigned long) node,
701 &args, sock_info);
702 if (ret) {
703 free(node);
704 }
705 /* Don't free exclusion data if everything went fine. */
706 } else {
707 ret = -ENOSYS;
708 free(node);
709 }
710 break;
711 }
74d81a6c
MD
712 case LTTNG_UST_CHANNEL:
713 {
714 void *chan_data;
ff0f5728 715 int wakeup_fd;
74d81a6c
MD
716
717 len = ustcomm_recv_channel_from_sessiond(sock,
ff0f5728
MD
718 &chan_data, lum->u.channel.len,
719 &wakeup_fd);
74d81a6c
MD
720 switch (len) {
721 case 0: /* orderly shutdown */
722 ret = 0;
723 goto error;
724 default:
725 if (len == lum->u.channel.len) {
726 DBG("channel data received");
727 break;
728 } else if (len < 0) {
729 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
730 if (len == -ECONNRESET) {
731 ERR("%s remote end closed connection", sock_info->name);
732 ret = len;
733 goto error;
734 }
735 ret = len;
736 goto end;
737 } else {
738 DBG("incorrect channel data message size: %zd", len);
739 ret = -EINVAL;
740 goto end;
741 }
742 }
743 args.channel.chan_data = chan_data;
ff0f5728 744 args.channel.wakeup_fd = wakeup_fd;
74d81a6c
MD
745 if (ops->cmd)
746 ret = ops->cmd(lum->handle, lum->cmd,
747 (unsigned long) &lum->u,
748 &args, sock_info);
749 else
750 ret = -ENOSYS;
751 break;
752 }
753 case LTTNG_UST_STREAM:
754 {
755 /* Receive shm_fd, wakeup_fd */
756 ret = ustcomm_recv_stream_from_sessiond(sock,
757 &lum->u.stream.len,
758 &args.stream.shm_fd,
759 &args.stream.wakeup_fd);
760 if (ret) {
761 goto end;
762 }
763 if (ops->cmd)
764 ret = ops->cmd(lum->handle, lum->cmd,
765 (unsigned long) &lum->u,
766 &args, sock_info);
767 else
768 ret = -ENOSYS;
769 break;
770 }
d9e99d10 771 default:
46050b1a
MD
772 if (ops->cmd)
773 ret = ops->cmd(lum->handle, lum->cmd,
ef9ff354 774 (unsigned long) &lum->u,
f59ed768 775 &args, sock_info);
46050b1a
MD
776 else
777 ret = -ENOSYS;
778 break;
d9e99d10 779 }
46050b1a 780
1ea11eab 781end:
46050b1a
MD
782 lur.handle = lum->handle;
783 lur.cmd = lum->cmd;
784 lur.ret_val = ret;
785 if (ret >= 0) {
7bc53e94 786 lur.ret_code = LTTNG_UST_OK;
46050b1a 787 } else {
7bc53e94
MD
788 /*
789 * Use -LTTNG_UST_ERR as wildcard for UST internal
790 * error that are not caused by the transport, except if
791 * we already have a more precise error message to
792 * report.
793 */
64b2564e
DG
794 if (ret > -LTTNG_UST_ERR) {
795 /* Translate code to UST error. */
796 switch (ret) {
797 case -EEXIST:
798 lur.ret_code = -LTTNG_UST_ERR_EXIST;
799 break;
800 case -EINVAL:
801 lur.ret_code = -LTTNG_UST_ERR_INVAL;
802 break;
803 case -ENOENT:
804 lur.ret_code = -LTTNG_UST_ERR_NOENT;
805 break;
806 case -EPERM:
807 lur.ret_code = -LTTNG_UST_ERR_PERM;
808 break;
809 case -ENOSYS:
810 lur.ret_code = -LTTNG_UST_ERR_NOSYS;
811 break;
812 default:
813 lur.ret_code = -LTTNG_UST_ERR;
814 break;
815 }
816 } else {
7bc53e94 817 lur.ret_code = ret;
64b2564e 818 }
46050b1a 819 }
e6ea14c5
MD
820 if (ret >= 0) {
821 switch (lum->cmd) {
e6ea14c5
MD
822 case LTTNG_UST_TRACER_VERSION:
823 lur.u.version = lum->u.version;
824 break;
825 case LTTNG_UST_TRACEPOINT_LIST_GET:
826 memcpy(&lur.u.tracepoint, &lum->u.tracepoint, sizeof(lur.u.tracepoint));
827 break;
828 }
381c0f1e 829 }
74d81a6c 830 DBG("Return value: %d", lur.ret_val);
46050b1a 831 ret = send_reply(sock, &lur);
193183fb 832 if (ret < 0) {
7bc53e94 833 DBG("error sending reply");
193183fb
MD
834 goto error;
835 }
46050b1a 836
40003310
MD
837 /*
838 * LTTNG_UST_TRACEPOINT_FIELD_LIST_GET needs to send the field
839 * after the reply.
840 */
7bc53e94 841 if (lur.ret_code == LTTNG_UST_OK) {
40003310
MD
842 switch (lum->cmd) {
843 case LTTNG_UST_TRACEPOINT_FIELD_LIST_GET:
844 len = ustcomm_send_unix_sock(sock,
845 &args.field_list.entry,
846 sizeof(args.field_list.entry));
7bc53e94
MD
847 if (len < 0) {
848 ret = len;
849 goto error;
850 }
40003310 851 if (len != sizeof(args.field_list.entry)) {
7bc53e94 852 ret = -EINVAL;
40003310
MD
853 goto error;
854 }
855 }
856 }
ef9ff354 857
381c0f1e 858error:
17dfb34b 859 ust_unlock();
d9e99d10 860
37dddb65
MD
861 /*
862 * Performed delayed statedump operations outside of the UST
863 * lock. We need to take the dynamic loader lock before we take
864 * the UST lock internally within handle_pending_statedump().
865 */
866 handle_pending_statedump(sock_info);
246be17e 867
37dddb65 868 return ret;
246be17e
PW
869}
870
46050b1a 871static
efe0de09 872void cleanup_sock_info(struct sock_info *sock_info, int exiting)
46050b1a
MD
873{
874 int ret;
875
5b14aab3
MD
876 if (sock_info->root_handle != -1) {
877 ret = lttng_ust_objd_unref(sock_info->root_handle, 1);
878 if (ret) {
879 ERR("Error unref root handle");
880 }
881 sock_info->root_handle = -1;
882 }
883 sock_info->constructor_sem_posted = 0;
884
885 /*
886 * wait_shm_mmap, socket and notify socket are used by listener
887 * threads outside of the ust lock, so we cannot tear them down
888 * ourselves, because we cannot join on these threads. Leave
889 * responsibility of cleaning up these resources to the OS
890 * process exit.
891 */
892 if (exiting)
893 return;
894
46050b1a 895 if (sock_info->socket != -1) {
e6973a89 896 ret = ustcomm_close_unix_sock(sock_info->socket);
46050b1a 897 if (ret) {
32ce8569 898 ERR("Error closing ust cmd socket");
46050b1a
MD
899 }
900 sock_info->socket = -1;
901 }
32ce8569
MD
902 if (sock_info->notify_socket != -1) {
903 ret = ustcomm_close_unix_sock(sock_info->notify_socket);
904 if (ret) {
905 ERR("Error closing ust notify socket");
906 }
907 sock_info->notify_socket = -1;
908 }
5b14aab3 909 if (sock_info->wait_shm_mmap) {
172d6b68
MD
910 long page_size;
911
912 page_size = sysconf(_SC_PAGE_SIZE);
913 if (page_size > 0) {
914 ret = munmap(sock_info->wait_shm_mmap, page_size);
915 if (ret) {
916 ERR("Error unmapping wait shm");
917 }
7fc90dca
MD
918 }
919 sock_info->wait_shm_mmap = NULL;
920 }
921}
922
58d4b2a2 923/*
33bbeb90
MD
924 * Using fork to set umask in the child process (not multi-thread safe).
925 * We deal with the shm_open vs ftruncate race (happening when the
926 * sessiond owns the shm and does not let everybody modify it, to ensure
927 * safety against shm_unlink) by simply letting the mmap fail and
928 * retrying after a few seconds.
929 * For global shm, everybody has rw access to it until the sessiond
930 * starts.
58d4b2a2 931 */
7fc90dca 932static
58d4b2a2 933int get_wait_shm(struct sock_info *sock_info, size_t mmap_size)
7fc90dca 934{
7fc90dca 935 int wait_shm_fd, ret;
58d4b2a2 936 pid_t pid;
44e073f5 937
58d4b2a2 938 /*
33bbeb90 939 * Try to open read-only.
58d4b2a2 940 */
33bbeb90 941 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
58d4b2a2 942 if (wait_shm_fd >= 0) {
7aa76730
MD
943 int32_t tmp_read;
944 ssize_t len;
945 size_t bytes_read = 0;
946
947 /*
948 * Try to read the fd. If unable to do so, try opening
949 * it in write mode.
950 */
951 do {
952 len = read(wait_shm_fd,
953 &((char *) &tmp_read)[bytes_read],
954 sizeof(tmp_read) - bytes_read);
955 if (len > 0) {
956 bytes_read += len;
957 }
958 } while ((len < 0 && errno == EINTR)
959 || (len > 0 && bytes_read < sizeof(tmp_read)));
960 if (bytes_read != sizeof(tmp_read)) {
961 ret = close(wait_shm_fd);
962 if (ret) {
963 ERR("close wait_shm_fd");
964 }
965 goto open_write;
966 }
58d4b2a2
MD
967 goto end;
968 } else if (wait_shm_fd < 0 && errno != ENOENT) {
969 /*
33bbeb90
MD
970 * Real-only open did not work, and it's not because the
971 * entry was not present. It's a failure that prohibits
972 * using shm.
58d4b2a2 973 */
7fc90dca 974 ERR("Error opening shm %s", sock_info->wait_shm_path);
58d4b2a2 975 goto end;
7fc90dca 976 }
7aa76730
MD
977
978open_write:
7fc90dca 979 /*
7aa76730
MD
980 * If the open failed because the file did not exist, or because
981 * the file was not truncated yet, try creating it ourself.
7fc90dca 982 */
8c90a710 983 URCU_TLS(lttng_ust_nest_count)++;
58d4b2a2 984 pid = fork();
8c90a710 985 URCU_TLS(lttng_ust_nest_count)--;
58d4b2a2
MD
986 if (pid > 0) {
987 int status;
988
989 /*
990 * Parent: wait for child to return, in which case the
991 * shared memory map will have been created.
992 */
993 pid = wait(&status);
b7d3cb32 994 if (pid < 0 || !WIFEXITED(status) || WEXITSTATUS(status) != 0) {
58d4b2a2
MD
995 wait_shm_fd = -1;
996 goto end;
7fc90dca 997 }
58d4b2a2
MD
998 /*
999 * Try to open read-only again after creation.
1000 */
33bbeb90 1001 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
58d4b2a2
MD
1002 if (wait_shm_fd < 0) {
1003 /*
1004 * Real-only open did not work. It's a failure
1005 * that prohibits using shm.
1006 */
1007 ERR("Error opening shm %s", sock_info->wait_shm_path);
1008 goto end;
1009 }
1010 goto end;
1011 } else if (pid == 0) {
1012 int create_mode;
1013
1014 /* Child */
33bbeb90 1015 create_mode = S_IRUSR | S_IWUSR | S_IRGRP;
58d4b2a2 1016 if (sock_info->global)
33bbeb90 1017 create_mode |= S_IROTH | S_IWGRP | S_IWOTH;
58d4b2a2
MD
1018 /*
1019 * We're alone in a child process, so we can modify the
1020 * process-wide umask.
1021 */
33bbeb90 1022 umask(~create_mode);
58d4b2a2 1023 /*
33bbeb90
MD
1024 * Try creating shm (or get rw access).
1025 * We don't do an exclusive open, because we allow other
1026 * processes to create+ftruncate it concurrently.
58d4b2a2
MD
1027 */
1028 wait_shm_fd = shm_open(sock_info->wait_shm_path,
1029 O_RDWR | O_CREAT, create_mode);
1030 if (wait_shm_fd >= 0) {
1031 ret = ftruncate(wait_shm_fd, mmap_size);
1032 if (ret) {
1033 PERROR("ftruncate");
b0c1425d 1034 _exit(EXIT_FAILURE);
58d4b2a2 1035 }
b0c1425d 1036 _exit(EXIT_SUCCESS);
58d4b2a2 1037 }
33bbeb90
MD
1038 /*
1039 * For local shm, we need to have rw access to accept
1040 * opening it: this means the local sessiond will be
1041 * able to wake us up. For global shm, we open it even
1042 * if rw access is not granted, because the root.root
1043 * sessiond will be able to override all rights and wake
1044 * us up.
1045 */
1046 if (!sock_info->global && errno != EACCES) {
58d4b2a2 1047 ERR("Error opening shm %s", sock_info->wait_shm_path);
5d3bc5ed 1048 _exit(EXIT_FAILURE);
58d4b2a2
MD
1049 }
1050 /*
33bbeb90
MD
1051 * The shm exists, but we cannot open it RW. Report
1052 * success.
58d4b2a2 1053 */
5d3bc5ed 1054 _exit(EXIT_SUCCESS);
58d4b2a2
MD
1055 } else {
1056 return -1;
7fc90dca 1057 }
58d4b2a2 1058end:
33bbeb90
MD
1059 if (wait_shm_fd >= 0 && !sock_info->global) {
1060 struct stat statbuf;
1061
1062 /*
1063 * Ensure that our user is the owner of the shm file for
1064 * local shm. If we do not own the file, it means our
1065 * sessiond will not have access to wake us up (there is
1066 * probably a rogue process trying to fake our
1067 * sessiond). Fallback to polling method in this case.
1068 */
1069 ret = fstat(wait_shm_fd, &statbuf);
1070 if (ret) {
1071 PERROR("fstat");
1072 goto error_close;
1073 }
1074 if (statbuf.st_uid != getuid())
1075 goto error_close;
1076 }
58d4b2a2 1077 return wait_shm_fd;
33bbeb90
MD
1078
1079error_close:
1080 ret = close(wait_shm_fd);
1081 if (ret) {
1082 PERROR("Error closing fd");
1083 }
1084 return -1;
58d4b2a2
MD
1085}
1086
1087static
1088char *get_map_shm(struct sock_info *sock_info)
1089{
172d6b68 1090 long page_size;
58d4b2a2
MD
1091 int wait_shm_fd, ret;
1092 char *wait_shm_mmap;
1093
172d6b68
MD
1094 page_size = sysconf(_SC_PAGE_SIZE);
1095 if (page_size < 0) {
1096 goto error;
1097 }
1098
1099 wait_shm_fd = get_wait_shm(sock_info, page_size);
58d4b2a2
MD
1100 if (wait_shm_fd < 0) {
1101 goto error;
44e073f5 1102 }
172d6b68 1103 wait_shm_mmap = mmap(NULL, page_size, PROT_READ,
7fc90dca 1104 MAP_SHARED, wait_shm_fd, 0);
7fc90dca
MD
1105 /* close shm fd immediately after taking the mmap reference */
1106 ret = close(wait_shm_fd);
1107 if (ret) {
33bbeb90
MD
1108 PERROR("Error closing fd");
1109 }
1110 if (wait_shm_mmap == MAP_FAILED) {
1111 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
1112 goto error;
7fc90dca
MD
1113 }
1114 return wait_shm_mmap;
1115
1116error:
1117 return NULL;
1118}
1119
1120static
1121void wait_for_sessiond(struct sock_info *sock_info)
1122{
efe0de09 1123 int ret;
80e2814b 1124
3327ac33 1125 if (ust_lock()) {
7fc90dca
MD
1126 goto quit;
1127 }
37ed587a
MD
1128 if (wait_poll_fallback) {
1129 goto error;
1130 }
7fc90dca
MD
1131 if (!sock_info->wait_shm_mmap) {
1132 sock_info->wait_shm_mmap = get_map_shm(sock_info);
1133 if (!sock_info->wait_shm_mmap)
1134 goto error;
1135 }
1136 ust_unlock();
1137
1138 DBG("Waiting for %s apps sessiond", sock_info->name);
80e2814b
MD
1139 /* Wait for futex wakeup */
1140 if (uatomic_read((int32_t *) sock_info->wait_shm_mmap) == 0) {
1141 ret = futex_async((int32_t *) sock_info->wait_shm_mmap,
1142 FUTEX_WAIT, 0, NULL, NULL, 0);
80e2814b 1143 if (ret < 0) {
37ed587a
MD
1144 if (errno == EFAULT) {
1145 wait_poll_fallback = 1;
a8b870ad 1146 DBG(
37ed587a
MD
1147"Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
1148"do not support FUTEX_WAKE on read-only memory mappings correctly. "
1149"Please upgrade your kernel "
1150"(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
1151"mainline). LTTng-UST will use polling mode fallback.");
cd27263b
MD
1152 if (ust_debug())
1153 PERROR("futex");
37ed587a 1154 }
80e2814b
MD
1155 }
1156 }
7fc90dca
MD
1157 return;
1158
1159quit:
1160 ust_unlock();
1161 return;
1162
1163error:
1164 ust_unlock();
7fc90dca 1165 return;
46050b1a
MD
1166}
1167
1ea11eab
MD
1168/*
1169 * This thread does not allocate any resource, except within
1170 * handle_message, within mutex protection. This mutex protects against
1171 * fork and exit.
98bf993f 1172 * The other moment it allocates resources is at socket connection, which
1ea11eab
MD
1173 * is also protected by the mutex.
1174 */
d9e99d10
MD
1175static
1176void *ust_listener_thread(void *arg)
1177{
1ea11eab 1178 struct sock_info *sock_info = arg;
c0eedf81 1179 int sock, ret, prev_connect_failed = 0, has_waited = 0;
ff517991 1180 long timeout;
d9e99d10 1181
9eb62b9c
MD
1182 /* Restart trying to connect to the session daemon */
1183restart:
c0eedf81
MD
1184 if (prev_connect_failed) {
1185 /* Wait for sessiond availability with pipe */
1186 wait_for_sessiond(sock_info);
1187 if (has_waited) {
1188 has_waited = 0;
1189 /*
1190 * Sleep for 5 seconds before retrying after a
1191 * sequence of failure / wait / failure. This
1192 * deals with a killed or broken session daemon.
1193 */
1194 sleep(5);
1195 }
1196 has_waited = 1;
1197 prev_connect_failed = 0;
1198 }
9eb62b9c 1199
1ea11eab 1200 if (sock_info->socket != -1) {
e6973a89 1201 ret = ustcomm_close_unix_sock(sock_info->socket);
1ea11eab 1202 if (ret) {
32ce8569
MD
1203 ERR("Error closing %s ust cmd socket",
1204 sock_info->name);
1ea11eab
MD
1205 }
1206 sock_info->socket = -1;
1207 }
32ce8569
MD
1208 if (sock_info->notify_socket != -1) {
1209 ret = ustcomm_close_unix_sock(sock_info->notify_socket);
1210 if (ret) {
1211 ERR("Error closing %s ust notify socket",
1212 sock_info->name);
1213 }
1214 sock_info->notify_socket = -1;
1215 }
46050b1a 1216
321f2351
MD
1217 /*
1218 * Register. We need to perform both connect and sending
1219 * registration message before doing the next connect otherwise
1220 * we may reach unix socket connect queue max limits and block
1221 * on the 2nd connect while the session daemon is awaiting the
1222 * first connect registration message.
1223 */
1224 /* Connect cmd socket */
1225 ret = ustcomm_connect_unix_sock(sock_info->sock_path);
1226 if (ret < 0) {
1227 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
1228 prev_connect_failed = 1;
5b14aab3 1229
3327ac33 1230 if (ust_lock()) {
321f2351 1231 goto quit;
32ce8569 1232 }
46050b1a 1233
e3426ddc 1234 /*
321f2351
MD
1235 * If we cannot find the sessiond daemon, don't delay
1236 * constructor execution.
e3426ddc 1237 */
321f2351
MD
1238 ret = handle_register_done(sock_info);
1239 assert(!ret);
1240 ust_unlock();
1241 goto restart;
27fe9f21 1242 }
321f2351 1243 sock_info->socket = ret;
27fe9f21 1244
3327ac33 1245 if (ust_lock()) {
5b14aab3
MD
1246 goto quit;
1247 }
1248
46050b1a
MD
1249 /*
1250 * Create only one root handle per listener thread for the whole
f59ed768
MD
1251 * process lifetime, so we ensure we get ID which is statically
1252 * assigned to the root handle.
46050b1a
MD
1253 */
1254 if (sock_info->root_handle == -1) {
1255 ret = lttng_abi_create_root_handle();
a51070bb 1256 if (ret < 0) {
46050b1a 1257 ERR("Error creating root handle");
46050b1a
MD
1258 goto quit;
1259 }
1260 sock_info->root_handle = ret;
9eb62b9c 1261 }
1ea11eab 1262
32ce8569 1263 ret = register_to_sessiond(sock_info->socket, USTCTL_SOCKET_CMD);
9eb62b9c 1264 if (ret < 0) {
32ce8569
MD
1265 ERR("Error registering to %s ust cmd socket",
1266 sock_info->name);
c0eedf81 1267 prev_connect_failed = 1;
11ff9c7d
MD
1268 /*
1269 * If we cannot register to the sessiond daemon, don't
1270 * delay constructor execution.
1271 */
edaa1431 1272 ret = handle_register_done(sock_info);
11ff9c7d 1273 assert(!ret);
17dfb34b 1274 ust_unlock();
9eb62b9c
MD
1275 goto restart;
1276 }
321f2351
MD
1277
1278 ust_unlock();
1279
1280 /* Connect notify socket */
1281 ret = ustcomm_connect_unix_sock(sock_info->sock_path);
1282 if (ret < 0) {
1283 DBG("Info: sessiond not accepting connections to %s apps socket", sock_info->name);
1284 prev_connect_failed = 1;
1285
3327ac33 1286 if (ust_lock()) {
321f2351
MD
1287 goto quit;
1288 }
1289
1290 /*
1291 * If we cannot find the sessiond daemon, don't delay
1292 * constructor execution.
1293 */
1294 ret = handle_register_done(sock_info);
1295 assert(!ret);
1296 ust_unlock();
1297 goto restart;
1298 }
1299 sock_info->notify_socket = ret;
1300
1301 timeout = get_notify_sock_timeout();
1302 if (timeout >= 0) {
1303 /*
1304 * Give at least 10ms to sessiond to reply to
1305 * notifications.
1306 */
1307 if (timeout < 10)
1308 timeout = 10;
1309 ret = ustcomm_setsockopt_rcv_timeout(sock_info->notify_socket,
1310 timeout);
1311 if (ret < 0) {
1312 WARN("Error setting socket receive timeout");
1313 }
1314 ret = ustcomm_setsockopt_snd_timeout(sock_info->notify_socket,
1315 timeout);
1316 if (ret < 0) {
1317 WARN("Error setting socket send timeout");
1318 }
1319 } else if (timeout < -1) {
1320 WARN("Unsupported timeout value %ld", timeout);
1321 }
1322
3327ac33 1323 if (ust_lock()) {
321f2351
MD
1324 goto quit;
1325 }
1326
32ce8569
MD
1327 ret = register_to_sessiond(sock_info->notify_socket,
1328 USTCTL_SOCKET_NOTIFY);
1329 if (ret < 0) {
1330 ERR("Error registering to %s ust notify socket",
1331 sock_info->name);
1332 prev_connect_failed = 1;
1333 /*
1334 * If we cannot register to the sessiond daemon, don't
1335 * delay constructor execution.
1336 */
1337 ret = handle_register_done(sock_info);
1338 assert(!ret);
1339 ust_unlock();
1340 goto restart;
1341 }
1342 sock = sock_info->socket;
1343
17dfb34b 1344 ust_unlock();
46050b1a 1345
d9e99d10
MD
1346 for (;;) {
1347 ssize_t len;
57773204 1348 struct ustcomm_ust_msg lum;
d9e99d10 1349
57773204 1350 len = ustcomm_recv_unix_sock(sock, &lum, sizeof(lum));
d9e99d10
MD
1351 switch (len) {
1352 case 0: /* orderly shutdown */
7dd08bec 1353 DBG("%s lttng-sessiond has performed an orderly shutdown", sock_info->name);
3327ac33 1354 if (ust_lock()) {
d5e1fea6
MD
1355 goto quit;
1356 }
8236ba10
MD
1357 /*
1358 * Either sessiond has shutdown or refused us by closing the socket.
1359 * In either case, we don't want to delay construction execution,
1360 * and we need to wait before retry.
1361 */
1362 prev_connect_failed = 1;
1363 /*
1364 * If we cannot register to the sessiond daemon, don't
1365 * delay constructor execution.
1366 */
1367 ret = handle_register_done(sock_info);
1368 assert(!ret);
1369 ust_unlock();
d9e99d10 1370 goto end;
e7723462 1371 case sizeof(lum):
74d81a6c 1372 print_cmd(lum.cmd, lum.handle);
11ff9c7d 1373 ret = handle_message(sock_info, sock, &lum);
7bc53e94 1374 if (ret) {
11ff9c7d 1375 ERR("Error handling message for %s socket", sock_info->name);
d9e99d10
MD
1376 }
1377 continue;
7bc53e94
MD
1378 default:
1379 if (len < 0) {
1380 DBG("Receive failed from lttng-sessiond with errno %d", (int) -len);
1381 } else {
1382 DBG("incorrect message size (%s socket): %zd", sock_info->name, len);
1383 }
1384 if (len == -ECONNRESET) {
1385 DBG("%s remote end closed connection", sock_info->name);
d9e99d10
MD
1386 goto end;
1387 }
1388 goto end;
d9e99d10
MD
1389 }
1390
1391 }
1392end:
3327ac33 1393 if (ust_lock()) {
d5e1fea6
MD
1394 goto quit;
1395 }
f59ed768
MD
1396 /* Cleanup socket handles before trying to reconnect */
1397 lttng_ust_objd_table_owner_cleanup(sock_info);
1398 ust_unlock();
9eb62b9c 1399 goto restart; /* try to reconnect */
e33f3265 1400
1ea11eab 1401quit:
e33f3265 1402 ust_unlock();
3327ac33
MD
1403
1404 pthread_mutex_lock(&ust_exit_mutex);
1405 sock_info->thread_active = 0;
1406 pthread_mutex_unlock(&ust_exit_mutex);
d9e99d10
MD
1407 return NULL;
1408}
1409
2594a5b4
MD
1410/*
1411 * Weak symbol to call when the ust malloc wrapper is not loaded.
1412 */
1413__attribute__((weak))
1414void lttng_ust_malloc_wrapper_init(void)
1415{
1416}
1417
2691221a
MD
1418/*
1419 * sessiond monitoring thread: monitor presence of global and per-user
1420 * sessiond by polling the application common named pipe.
1421 */
edaa1431 1422void __attribute__((constructor)) lttng_ust_init(void)
2691221a 1423{
11ff9c7d 1424 struct timespec constructor_timeout;
ae6a58bf 1425 sigset_t sig_all_blocked, orig_parent_mask;
1879f67f 1426 pthread_attr_t thread_attr;
cf12a773 1427 int timeout_mode;
2691221a
MD
1428 int ret;
1429
edaa1431
MD
1430 if (uatomic_xchg(&initialized, 1) == 1)
1431 return;
1432
eddd8d5d
MD
1433 /*
1434 * Fixup interdependency between TLS fixup mutex (which happens
1435 * to be the dynamic linker mutex) and ust_lock, taken within
1436 * the ust lock.
1437 */
1556a549 1438 lttng_fixup_urcu_bp_tls();
f645cfa7 1439 lttng_fixup_ringbuffer_tls();
4158a15a 1440 lttng_fixup_vtid_tls();
a903623f 1441 lttng_fixup_nest_count_tls();
009745db 1442 lttng_fixup_procname_tls();
d58d1454 1443 lttng_fixup_ust_mutex_nest_tls();
eddd8d5d 1444
edaa1431
MD
1445 /*
1446 * We want precise control over the order in which we construct
1447 * our sub-libraries vs starting to receive commands from
1448 * sessiond (otherwise leading to errors when trying to create
1449 * sessiond before the init functions are completed).
1450 */
2691221a 1451 init_usterr();
edaa1431 1452 init_tracepoint();
f9364363 1453 lttng_ust_clock_init();
5e1b7b8b 1454 lttng_ust_getcpu_init();
bd703713 1455 lttng_ust_baddr_statedump_init();
7dd08bec
MD
1456 lttng_ring_buffer_metadata_client_init();
1457 lttng_ring_buffer_client_overwrite_init();
34a91bdb 1458 lttng_ring_buffer_client_overwrite_rt_init();
7dd08bec 1459 lttng_ring_buffer_client_discard_init();
34a91bdb 1460 lttng_ring_buffer_client_discard_rt_init();
d58d1454 1461 lttng_perf_counter_init();
a0a3bef9 1462 lttng_context_init();
2594a5b4
MD
1463 /*
1464 * Invoke ust malloc wrapper init before starting other threads.
1465 */
1466 lttng_ust_malloc_wrapper_init();
2691221a 1467
ff517991 1468 timeout_mode = get_constructor_timeout(&constructor_timeout);
11ff9c7d 1469
95259bd0 1470 ret = sem_init(&constructor_wait, 0, 0);
11ff9c7d
MD
1471 assert(!ret);
1472
8d20bf54 1473 ret = setup_local_apps();
2691221a 1474 if (ret) {
9ec6895c 1475 DBG("local apps setup returned %d", ret);
2691221a 1476 }
ae6a58bf
WP
1477
1478 /* A new thread created by pthread_create inherits the signal mask
1479 * from the parent. To avoid any signal being received by the
1480 * listener thread, we block all signals temporarily in the parent,
1481 * while we create the listener thread.
1482 */
1483 sigfillset(&sig_all_blocked);
1484 ret = pthread_sigmask(SIG_SETMASK, &sig_all_blocked, &orig_parent_mask);
1485 if (ret) {
d94d802c 1486 ERR("pthread_sigmask: %s", strerror(ret));
ae6a58bf
WP
1487 }
1488
1879f67f
MG
1489 ret = pthread_attr_init(&thread_attr);
1490 if (ret) {
1491 ERR("pthread_attr_init: %s", strerror(ret));
1492 }
1493 ret = pthread_attr_setdetachstate(&thread_attr, PTHREAD_CREATE_DETACHED);
1494 if (ret) {
1495 ERR("pthread_attr_setdetachstate: %s", strerror(ret));
1496 }
1497
c0bbbd5a 1498 pthread_mutex_lock(&ust_exit_mutex);
1879f67f 1499 ret = pthread_create(&global_apps.ust_listener, &thread_attr,
dde70ea0 1500 ust_listener_thread, &global_apps);
d94d802c
MD
1501 if (ret) {
1502 ERR("pthread_create global: %s", strerror(ret));
1503 }
e33f3265 1504 global_apps.thread_active = 1;
c0bbbd5a 1505 pthread_mutex_unlock(&ust_exit_mutex);
e33f3265 1506
8d20bf54 1507 if (local_apps.allowed) {
c0bbbd5a 1508 pthread_mutex_lock(&ust_exit_mutex);
1879f67f 1509 ret = pthread_create(&local_apps.ust_listener, &thread_attr,
dde70ea0 1510 ust_listener_thread, &local_apps);
d94d802c
MD
1511 if (ret) {
1512 ERR("pthread_create local: %s", strerror(ret));
1513 }
e33f3265 1514 local_apps.thread_active = 1;
c0bbbd5a 1515 pthread_mutex_unlock(&ust_exit_mutex);
8d20bf54
MD
1516 } else {
1517 handle_register_done(&local_apps);
1518 }
1879f67f
MG
1519 ret = pthread_attr_destroy(&thread_attr);
1520 if (ret) {
1521 ERR("pthread_attr_destroy: %s", strerror(ret));
1522 }
8d20bf54 1523
ae6a58bf
WP
1524 /* Restore original signal mask in parent */
1525 ret = pthread_sigmask(SIG_SETMASK, &orig_parent_mask, NULL);
1526 if (ret) {
d94d802c 1527 ERR("pthread_sigmask: %s", strerror(ret));
ae6a58bf
WP
1528 }
1529
cf12a773
MD
1530 switch (timeout_mode) {
1531 case 1: /* timeout wait */
95259bd0
MD
1532 do {
1533 ret = sem_timedwait(&constructor_wait,
1534 &constructor_timeout);
1535 } while (ret < 0 && errno == EINTR);
cf12a773 1536 if (ret < 0 && errno == ETIMEDOUT) {
7dd08bec 1537 ERR("Timed out waiting for lttng-sessiond");
cf12a773
MD
1538 } else {
1539 assert(!ret);
1540 }
1541 break;
7b766b16 1542 case -1:/* wait forever */
95259bd0
MD
1543 do {
1544 ret = sem_wait(&constructor_wait);
1545 } while (ret < 0 && errno == EINTR);
11ff9c7d 1546 assert(!ret);
cf12a773 1547 break;
7b766b16 1548 case 0: /* no timeout */
cf12a773 1549 break;
11ff9c7d 1550 }
2691221a
MD
1551}
1552
17dfb34b
MD
1553static
1554void lttng_ust_cleanup(int exiting)
1555{
efe0de09 1556 cleanup_sock_info(&global_apps, exiting);
17dfb34b 1557 if (local_apps.allowed) {
efe0de09 1558 cleanup_sock_info(&local_apps, exiting);
17dfb34b 1559 }
efe0de09
MD
1560 /*
1561 * The teardown in this function all affect data structures
1562 * accessed under the UST lock by the listener thread. This
1563 * lock, along with the lttng_ust_comm_should_quit flag, ensure
1564 * that none of these threads are accessing this data at this
1565 * point.
1566 */
17dfb34b 1567 lttng_ust_abi_exit();
003fedf4 1568 lttng_ust_events_exit();
a0a3bef9 1569 lttng_context_exit();
d58d1454 1570 lttng_perf_counter_exit();
34a91bdb 1571 lttng_ring_buffer_client_discard_rt_exit();
7dd08bec 1572 lttng_ring_buffer_client_discard_exit();
34a91bdb 1573 lttng_ring_buffer_client_overwrite_rt_exit();
7dd08bec
MD
1574 lttng_ring_buffer_client_overwrite_exit();
1575 lttng_ring_buffer_metadata_client_exit();
bd703713 1576 lttng_ust_baddr_statedump_destroy();
17dfb34b
MD
1577 exit_tracepoint();
1578 if (!exiting) {
1579 /* Reinitialize values for fork */
1580 sem_count = 2;
1581 lttng_ust_comm_should_quit = 0;
1582 initialized = 0;
1583 }
1584}
1585
edaa1431 1586void __attribute__((destructor)) lttng_ust_exit(void)
2691221a
MD
1587{
1588 int ret;
1589
9eb62b9c
MD
1590 /*
1591 * Using pthread_cancel here because:
1592 * A) we don't want to hang application teardown.
1593 * B) the thread is not allocating any resource.
1594 */
1ea11eab
MD
1595
1596 /*
1597 * Require the communication thread to quit. Synchronize with
1598 * mutexes to ensure it is not in a mutex critical section when
1599 * pthread_cancel is later called.
1600 */
3327ac33 1601 ust_lock_nocheck();
1ea11eab 1602 lttng_ust_comm_should_quit = 1;
3327ac33 1603 ust_unlock();
1ea11eab 1604
3327ac33 1605 pthread_mutex_lock(&ust_exit_mutex);
f5f94532 1606 /* cancel threads */
e33f3265
MD
1607 if (global_apps.thread_active) {
1608 ret = pthread_cancel(global_apps.ust_listener);
1609 if (ret) {
1610 ERR("Error cancelling global ust listener thread: %s",
1611 strerror(ret));
1612 } else {
1613 global_apps.thread_active = 0;
1614 }
2691221a 1615 }
e33f3265 1616 if (local_apps.thread_active) {
8d20bf54
MD
1617 ret = pthread_cancel(local_apps.ust_listener);
1618 if (ret) {
d94d802c
MD
1619 ERR("Error cancelling local ust listener thread: %s",
1620 strerror(ret));
e33f3265
MD
1621 } else {
1622 local_apps.thread_active = 0;
8d20bf54 1623 }
8d20bf54 1624 }
3327ac33 1625 pthread_mutex_unlock(&ust_exit_mutex);
e33f3265 1626
efe0de09
MD
1627 /*
1628 * Do NOT join threads: use of sys_futex makes it impossible to
1629 * join the threads without using async-cancel, but async-cancel
1630 * is delivered by a signal, which could hit the target thread
1631 * anywhere in its code path, including while the ust_lock() is
1632 * held, causing a deadlock for the other thread. Let the OS
1633 * cleanup the threads if there are stalled in a syscall.
1634 */
17dfb34b 1635 lttng_ust_cleanup(1);
2691221a 1636}
e822f505
MD
1637
1638/*
1639 * We exclude the worker threads across fork and clone (except
1640 * CLONE_VM), because these system calls only keep the forking thread
1641 * running in the child. Therefore, we don't want to call fork or clone
1642 * in the middle of an tracepoint or ust tracing state modification.
1643 * Holding this mutex protects these structures across fork and clone.
1644 */
b728d87e 1645void ust_before_fork(sigset_t *save_sigset)
e822f505
MD
1646{
1647 /*
1648 * Disable signals. This is to avoid that the child intervenes
1649 * before it is properly setup for tracing. It is safer to
1650 * disable all signals, because then we know we are not breaking
1651 * anything by restoring the original mask.
1652 */
1653 sigset_t all_sigs;
1654 int ret;
1655
8c90a710 1656 if (URCU_TLS(lttng_ust_nest_count))
e8508a49 1657 return;
e822f505
MD
1658 /* Disable signals */
1659 sigfillset(&all_sigs);
b728d87e 1660 ret = sigprocmask(SIG_BLOCK, &all_sigs, save_sigset);
e822f505
MD
1661 if (ret == -1) {
1662 PERROR("sigprocmask");
1663 }
458d678c
PW
1664
1665 pthread_mutex_lock(&ust_fork_mutex);
1666
3327ac33 1667 ust_lock_nocheck();
e822f505
MD
1668 rcu_bp_before_fork();
1669}
1670
b728d87e 1671static void ust_after_fork_common(sigset_t *restore_sigset)
e822f505
MD
1672{
1673 int ret;
1674
17dfb34b
MD
1675 DBG("process %d", getpid());
1676 ust_unlock();
458d678c
PW
1677
1678 pthread_mutex_unlock(&ust_fork_mutex);
1679
e822f505 1680 /* Restore signals */
23c8854a 1681 ret = sigprocmask(SIG_SETMASK, restore_sigset, NULL);
e822f505
MD
1682 if (ret == -1) {
1683 PERROR("sigprocmask");
1684 }
1685}
1686
b728d87e 1687void ust_after_fork_parent(sigset_t *restore_sigset)
e822f505 1688{
8c90a710 1689 if (URCU_TLS(lttng_ust_nest_count))
e8508a49 1690 return;
17dfb34b 1691 DBG("process %d", getpid());
e822f505
MD
1692 rcu_bp_after_fork_parent();
1693 /* Release mutexes and reenable signals */
b728d87e 1694 ust_after_fork_common(restore_sigset);
e822f505
MD
1695}
1696
17dfb34b
MD
1697/*
1698 * After fork, in the child, we need to cleanup all the leftover state,
1699 * except the worker thread which already magically disappeared thanks
1700 * to the weird Linux fork semantics. After tyding up, we call
1701 * lttng_ust_init() again to start over as a new PID.
1702 *
1703 * This is meant for forks() that have tracing in the child between the
1704 * fork and following exec call (if there is any).
1705 */
b728d87e 1706void ust_after_fork_child(sigset_t *restore_sigset)
e822f505 1707{
8c90a710 1708 if (URCU_TLS(lttng_ust_nest_count))
e8508a49 1709 return;
17dfb34b 1710 DBG("process %d", getpid());
e822f505
MD
1711 /* Release urcu mutexes */
1712 rcu_bp_after_fork_child();
17dfb34b 1713 lttng_ust_cleanup(0);
a93bfc45 1714 lttng_context_vtid_reset();
e822f505 1715 /* Release mutexes and reenable signals */
b728d87e 1716 ust_after_fork_common(restore_sigset);
318dfea9 1717 lttng_ust_init();
e822f505 1718}
95c25348 1719
246be17e 1720void lttng_ust_sockinfo_session_enabled(void *owner)
95c25348
PW
1721{
1722 struct sock_info *sock_info = owner;
37dddb65 1723 sock_info->statedump_pending = 1;
95c25348 1724}
This page took 0.12045 seconds and 4 git commands to generate.