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