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