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