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