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