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