Remove empty line from tracepoint.h
[lttng-ust.git] / libust / 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
2691221a
MD
23#include <sys/types.h>
24#include <sys/socket.h>
2629549e 25#include <sys/prctl.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>
1ea11eab 40
edaa1431 41#include <lttng-ust-comm.h>
a93bfc45 42#include <ust/lttng-events.h>
edaa1431
MD
43#include <ust/usterr-signal-safe.h>
44#include <ust/lttng-ust-abi.h>
45#include <ust/tracepoint.h>
d0a1ae63 46#include <ust/tracepoint-internal.h>
e822f505 47#include <ust/ust.h>
b751f722 48#include "ltt-tracer-core.h"
edaa1431
MD
49
50/*
51 * Has lttng ust comm constructor been called ?
52 */
53static int initialized;
54
1ea11eab 55/*
17dfb34b
MD
56 * The ust_lock/ust_unlock lock is used as a communication thread mutex.
57 * Held when handling a command, also held by fork() to deal with
58 * removal of threads, and by exit path.
1ea11eab 59 */
1ea11eab
MD
60
61/* Should the ust comm thread quit ? */
62static int lttng_ust_comm_should_quit;
63
11ff9c7d
MD
64/*
65 * Wait for either of these before continuing to the main
66 * program:
67 * - the register_done message from sessiond daemon
68 * (will let the sessiond daemon enable sessions before main
69 * starts.)
70 * - sessiond daemon is not reachable.
71 * - timeout (ensuring applications are resilient to session
72 * daemon problems).
73 */
74static sem_t constructor_wait;
950aab0c
MD
75/*
76 * Doing this for both the global and local sessiond.
77 */
95259bd0 78static int sem_count = { 2 };
11ff9c7d 79
1ea11eab
MD
80/*
81 * Info about socket and associated listener thread.
82 */
83struct sock_info {
11ff9c7d 84 const char *name;
1ea11eab 85 pthread_t ust_listener; /* listener thread */
46050b1a 86 int root_handle;
8d20bf54
MD
87 int constructor_sem_posted;
88 int allowed;
44e073f5 89 int global;
7fc90dca
MD
90
91 char sock_path[PATH_MAX];
92 int socket;
93
94 char wait_shm_path[PATH_MAX];
95 char *wait_shm_mmap;
1ea11eab 96};
2691221a
MD
97
98/* Socket from app (connect) to session daemon (listen) for communication */
1ea11eab 99struct sock_info global_apps = {
11ff9c7d 100 .name = "global",
44e073f5 101 .global = 1,
7fc90dca 102
46050b1a 103 .root_handle = -1,
8d20bf54 104 .allowed = 1,
7fc90dca
MD
105
106 .sock_path = DEFAULT_GLOBAL_APPS_UNIX_SOCK,
107 .socket = -1,
108
109 .wait_shm_path = DEFAULT_GLOBAL_APPS_WAIT_SHM_PATH,
1ea11eab 110};
2691221a
MD
111
112/* TODO: allow global_apps_sock_path override */
113
1ea11eab 114struct sock_info local_apps = {
11ff9c7d 115 .name = "local",
44e073f5 116 .global = 0,
46050b1a 117 .root_handle = -1,
8d20bf54 118 .allowed = 0, /* Check setuid bit first */
7fc90dca
MD
119
120 .socket = -1,
1ea11eab 121};
2691221a 122
37ed587a
MD
123static int wait_poll_fallback;
124
edaa1431
MD
125extern void ltt_ring_buffer_client_overwrite_init(void);
126extern void ltt_ring_buffer_client_discard_init(void);
127extern void ltt_ring_buffer_metadata_client_init(void);
128extern void ltt_ring_buffer_client_overwrite_exit(void);
129extern void ltt_ring_buffer_client_discard_exit(void);
130extern void ltt_ring_buffer_metadata_client_exit(void);
131
2691221a 132static
8d20bf54 133int setup_local_apps(void)
2691221a
MD
134{
135 const char *home_dir;
7fc90dca 136 uid_t uid;
2691221a 137
7fc90dca 138 uid = getuid();
8d20bf54
MD
139 /*
140 * Disallow per-user tracing for setuid binaries.
141 */
7fc90dca 142 if (uid != geteuid()) {
8d20bf54 143 local_apps.allowed = 0;
d0a1ae63 144 return 0;
8d20bf54
MD
145 } else {
146 local_apps.allowed = 1;
147 }
2691221a
MD
148 home_dir = (const char *) getenv("HOME");
149 if (!home_dir)
150 return -ENOENT;
1ea11eab 151 snprintf(local_apps.sock_path, PATH_MAX,
2691221a 152 DEFAULT_HOME_APPS_UNIX_SOCK, home_dir);
7fc90dca
MD
153 snprintf(local_apps.wait_shm_path, PATH_MAX,
154 DEFAULT_HOME_APPS_WAIT_SHM_PATH, uid);
2691221a
MD
155 return 0;
156}
157
158static
159int register_app_to_sessiond(int socket)
160{
161 ssize_t ret;
2629549e 162 int prctl_ret;
2691221a 163 struct {
e44418f3
MD
164 uint32_t major;
165 uint32_t minor;
2691221a 166 pid_t pid;
5c33bde8 167 pid_t ppid;
2691221a 168 uid_t uid;
83610856 169 gid_t gid;
2629549e 170 char name[16]; /* process name */
2691221a
MD
171 } reg_msg;
172
e44418f3
MD
173 reg_msg.major = LTTNG_UST_COMM_VERSION_MAJOR;
174 reg_msg.minor = LTTNG_UST_COMM_VERSION_MINOR;
2691221a 175 reg_msg.pid = getpid();
5c33bde8 176 reg_msg.ppid = getppid();
2691221a 177 reg_msg.uid = getuid();
83610856 178 reg_msg.gid = getgid();
2629549e
MD
179 prctl_ret = prctl(PR_GET_NAME, (unsigned long) reg_msg.name, 0, 0, 0);
180 if (prctl_ret) {
181 ERR("Error executing prctl");
182 return -errno;
183 }
2691221a
MD
184
185 ret = lttcomm_send_unix_sock(socket, &reg_msg, sizeof(reg_msg));
186 if (ret >= 0 && ret != sizeof(reg_msg))
187 return -EIO;
188 return ret;
189}
190
d9e99d10 191static
d3a492d1 192int send_reply(int sock, struct lttcomm_ust_reply *lur)
d9e99d10 193{
9eb62b9c 194 ssize_t len;
d3a492d1 195
a4be8962 196 len = lttcomm_send_unix_sock(sock, lur, sizeof(*lur));
d3a492d1 197 switch (len) {
a4be8962 198 case sizeof(*lur):
d3a492d1
MD
199 DBG("message successfully sent");
200 return 0;
201 case -1:
202 if (errno == ECONNRESET) {
203 printf("remote end closed connection\n");
204 return 0;
205 }
206 return -1;
207 default:
208 printf("incorrect message size: %zd\n", len);
209 return -1;
210 }
211}
212
213static
edaa1431 214int handle_register_done(struct sock_info *sock_info)
11ff9c7d
MD
215{
216 int ret;
217
edaa1431
MD
218 if (sock_info->constructor_sem_posted)
219 return 0;
220 sock_info->constructor_sem_posted = 1;
56cd7e2f
MD
221 if (uatomic_read(&sem_count) <= 0) {
222 return 0;
223 }
95259bd0
MD
224 ret = uatomic_add_return(&sem_count, -1);
225 if (ret == 0) {
226 ret = sem_post(&constructor_wait);
227 assert(!ret);
228 }
11ff9c7d
MD
229 return 0;
230}
231
232static
233int handle_message(struct sock_info *sock_info,
234 int sock, struct lttcomm_ust_msg *lum)
d3a492d1 235{
1ea11eab 236 int ret = 0;
46050b1a
MD
237 const struct objd_ops *ops;
238 struct lttcomm_ust_reply lur;
193183fb 239 int shm_fd, wait_fd;
1ea11eab 240
17dfb34b 241 ust_lock();
1ea11eab 242
46050b1a
MD
243 memset(&lur, 0, sizeof(lur));
244
1ea11eab 245 if (lttng_ust_comm_should_quit) {
46050b1a 246 ret = -EPERM;
1ea11eab
MD
247 goto end;
248 }
9eb62b9c 249
46050b1a
MD
250 ops = objd_ops(lum->handle);
251 if (!ops) {
252 ret = -ENOENT;
253 goto end;
1ea11eab 254 }
46050b1a
MD
255
256 switch (lum->cmd) {
11ff9c7d
MD
257 case LTTNG_UST_REGISTER_DONE:
258 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
edaa1431 259 ret = handle_register_done(sock_info);
11ff9c7d
MD
260 else
261 ret = -EINVAL;
262 break;
46050b1a
MD
263 case LTTNG_UST_RELEASE:
264 if (lum->handle == LTTNG_UST_ROOT_HANDLE)
265 ret = -EPERM;
266 else
267 ret = objd_unref(lum->handle);
d9e99d10
MD
268 break;
269 default:
46050b1a
MD
270 if (ops->cmd)
271 ret = ops->cmd(lum->handle, lum->cmd,
272 (unsigned long) &lum->u);
273 else
274 ret = -ENOSYS;
275 break;
d9e99d10 276 }
46050b1a 277
1ea11eab 278end:
46050b1a
MD
279 lur.handle = lum->handle;
280 lur.cmd = lum->cmd;
281 lur.ret_val = ret;
282 if (ret >= 0) {
283 lur.ret_code = LTTCOMM_OK;
284 } else {
193183fb
MD
285 //lur.ret_code = LTTCOMM_SESSION_FAIL;
286 lur.ret_code = ret;
46050b1a 287 }
193183fb
MD
288 switch (lum->cmd) {
289 case LTTNG_UST_STREAM:
381c0f1e
MD
290 /*
291 * Special-case reply to send stream info.
292 * Use lum.u output.
293 */
294 lur.u.stream.memory_map_size = lum->u.stream.memory_map_size;
193183fb
MD
295 shm_fd = lum->u.stream.shm_fd;
296 wait_fd = lum->u.stream.wait_fd;
297 break;
824f40b8 298 case LTTNG_UST_METADATA:
193183fb
MD
299 case LTTNG_UST_CHANNEL:
300 lur.u.channel.memory_map_size = lum->u.channel.memory_map_size;
301 shm_fd = lum->u.channel.shm_fd;
302 wait_fd = lum->u.channel.wait_fd;
303 break;
381c0f1e 304 }
46050b1a 305 ret = send_reply(sock, &lur);
193183fb
MD
306 if (ret < 0) {
307 perror("error sending reply");
308 goto error;
309 }
46050b1a 310
824f40b8
MD
311 if ((lum->cmd == LTTNG_UST_STREAM
312 || lum->cmd == LTTNG_UST_CHANNEL
313 || lum->cmd == LTTNG_UST_METADATA)
193183fb 314 && lur.ret_code == LTTCOMM_OK) {
381c0f1e
MD
315 /* we also need to send the file descriptors. */
316 ret = lttcomm_send_fds_unix_sock(sock,
193183fb 317 &shm_fd, &shm_fd,
381c0f1e
MD
318 1, sizeof(int));
319 if (ret < 0) {
320 perror("send shm_fd");
321 goto error;
322 }
323 ret = lttcomm_send_fds_unix_sock(sock,
193183fb 324 &wait_fd, &wait_fd,
381c0f1e
MD
325 1, sizeof(int));
326 if (ret < 0) {
327 perror("send wait_fd");
328 goto error;
329 }
330 }
331error:
17dfb34b 332 ust_unlock();
1ea11eab 333 return ret;
d9e99d10
MD
334}
335
46050b1a
MD
336static
337void cleanup_sock_info(struct sock_info *sock_info)
338{
339 int ret;
340
341 if (sock_info->socket != -1) {
342 ret = close(sock_info->socket);
343 if (ret) {
7fc90dca 344 ERR("Error closing apps socket");
46050b1a
MD
345 }
346 sock_info->socket = -1;
347 }
348 if (sock_info->root_handle != -1) {
349 ret = objd_unref(sock_info->root_handle);
350 if (ret) {
351 ERR("Error unref root handle");
352 }
353 sock_info->root_handle = -1;
354 }
318dfea9 355 sock_info->constructor_sem_posted = 0;
7fc90dca
MD
356 if (sock_info->wait_shm_mmap) {
357 ret = munmap(sock_info->wait_shm_mmap, sysconf(_SC_PAGE_SIZE));
358 if (ret) {
359 ERR("Error unmapping wait shm");
360 }
361 sock_info->wait_shm_mmap = NULL;
362 }
363}
364
58d4b2a2 365/*
33bbeb90
MD
366 * Using fork to set umask in the child process (not multi-thread safe).
367 * We deal with the shm_open vs ftruncate race (happening when the
368 * sessiond owns the shm and does not let everybody modify it, to ensure
369 * safety against shm_unlink) by simply letting the mmap fail and
370 * retrying after a few seconds.
371 * For global shm, everybody has rw access to it until the sessiond
372 * starts.
58d4b2a2 373 */
7fc90dca 374static
58d4b2a2 375int get_wait_shm(struct sock_info *sock_info, size_t mmap_size)
7fc90dca 376{
7fc90dca 377 int wait_shm_fd, ret;
58d4b2a2 378 pid_t pid;
44e073f5 379
58d4b2a2 380 /*
33bbeb90 381 * Try to open read-only.
58d4b2a2 382 */
33bbeb90 383 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
58d4b2a2
MD
384 if (wait_shm_fd >= 0) {
385 goto end;
386 } else if (wait_shm_fd < 0 && errno != ENOENT) {
387 /*
33bbeb90
MD
388 * Real-only open did not work, and it's not because the
389 * entry was not present. It's a failure that prohibits
390 * using shm.
58d4b2a2 391 */
7fc90dca 392 ERR("Error opening shm %s", sock_info->wait_shm_path);
58d4b2a2 393 goto end;
7fc90dca
MD
394 }
395 /*
58d4b2a2
MD
396 * If the open failed because the file did not exist, try
397 * creating it ourself.
7fc90dca 398 */
58d4b2a2
MD
399 pid = fork();
400 if (pid > 0) {
401 int status;
402
403 /*
404 * Parent: wait for child to return, in which case the
405 * shared memory map will have been created.
406 */
407 pid = wait(&status);
408 if (!WIFEXITED(status) || WEXITSTATUS(status) != 0) {
409 wait_shm_fd = -1;
410 goto end;
7fc90dca 411 }
58d4b2a2
MD
412 /*
413 * Try to open read-only again after creation.
414 */
33bbeb90 415 wait_shm_fd = shm_open(sock_info->wait_shm_path, O_RDONLY, 0);
58d4b2a2
MD
416 if (wait_shm_fd < 0) {
417 /*
418 * Real-only open did not work. It's a failure
419 * that prohibits using shm.
420 */
421 ERR("Error opening shm %s", sock_info->wait_shm_path);
422 goto end;
423 }
424 goto end;
425 } else if (pid == 0) {
426 int create_mode;
427
428 /* Child */
33bbeb90 429 create_mode = S_IRUSR | S_IWUSR | S_IRGRP;
58d4b2a2 430 if (sock_info->global)
33bbeb90 431 create_mode |= S_IROTH | S_IWGRP | S_IWOTH;
58d4b2a2
MD
432 /*
433 * We're alone in a child process, so we can modify the
434 * process-wide umask.
435 */
33bbeb90 436 umask(~create_mode);
58d4b2a2 437 /*
33bbeb90
MD
438 * Try creating shm (or get rw access).
439 * We don't do an exclusive open, because we allow other
440 * processes to create+ftruncate it concurrently.
58d4b2a2
MD
441 */
442 wait_shm_fd = shm_open(sock_info->wait_shm_path,
443 O_RDWR | O_CREAT, create_mode);
444 if (wait_shm_fd >= 0) {
445 ret = ftruncate(wait_shm_fd, mmap_size);
446 if (ret) {
447 PERROR("ftruncate");
448 exit(EXIT_FAILURE);
449 }
58d4b2a2
MD
450 exit(EXIT_SUCCESS);
451 }
33bbeb90
MD
452 /*
453 * For local shm, we need to have rw access to accept
454 * opening it: this means the local sessiond will be
455 * able to wake us up. For global shm, we open it even
456 * if rw access is not granted, because the root.root
457 * sessiond will be able to override all rights and wake
458 * us up.
459 */
460 if (!sock_info->global && errno != EACCES) {
58d4b2a2
MD
461 ERR("Error opening shm %s", sock_info->wait_shm_path);
462 exit(EXIT_FAILURE);
463 }
464 /*
33bbeb90
MD
465 * The shm exists, but we cannot open it RW. Report
466 * success.
58d4b2a2
MD
467 */
468 exit(EXIT_SUCCESS);
469 } else {
470 return -1;
7fc90dca 471 }
58d4b2a2 472end:
33bbeb90
MD
473 if (wait_shm_fd >= 0 && !sock_info->global) {
474 struct stat statbuf;
475
476 /*
477 * Ensure that our user is the owner of the shm file for
478 * local shm. If we do not own the file, it means our
479 * sessiond will not have access to wake us up (there is
480 * probably a rogue process trying to fake our
481 * sessiond). Fallback to polling method in this case.
482 */
483 ret = fstat(wait_shm_fd, &statbuf);
484 if (ret) {
485 PERROR("fstat");
486 goto error_close;
487 }
488 if (statbuf.st_uid != getuid())
489 goto error_close;
490 }
58d4b2a2 491 return wait_shm_fd;
33bbeb90
MD
492
493error_close:
494 ret = close(wait_shm_fd);
495 if (ret) {
496 PERROR("Error closing fd");
497 }
498 return -1;
58d4b2a2
MD
499}
500
501static
502char *get_map_shm(struct sock_info *sock_info)
503{
504 size_t mmap_size = sysconf(_SC_PAGE_SIZE);
505 int wait_shm_fd, ret;
506 char *wait_shm_mmap;
507
508 wait_shm_fd = get_wait_shm(sock_info, mmap_size);
509 if (wait_shm_fd < 0) {
510 goto error;
44e073f5 511 }
7fc90dca
MD
512 wait_shm_mmap = mmap(NULL, mmap_size, PROT_READ,
513 MAP_SHARED, wait_shm_fd, 0);
7fc90dca
MD
514 /* close shm fd immediately after taking the mmap reference */
515 ret = close(wait_shm_fd);
516 if (ret) {
33bbeb90
MD
517 PERROR("Error closing fd");
518 }
519 if (wait_shm_mmap == MAP_FAILED) {
520 DBG("mmap error (can be caused by race with sessiond). Fallback to poll mode.");
521 goto error;
7fc90dca
MD
522 }
523 return wait_shm_mmap;
524
525error:
526 return NULL;
527}
528
529static
530void wait_for_sessiond(struct sock_info *sock_info)
531{
80e2814b
MD
532 int ret;
533
7fc90dca
MD
534 ust_lock();
535 if (lttng_ust_comm_should_quit) {
536 goto quit;
537 }
37ed587a
MD
538 if (wait_poll_fallback) {
539 goto error;
540 }
7fc90dca
MD
541 if (!sock_info->wait_shm_mmap) {
542 sock_info->wait_shm_mmap = get_map_shm(sock_info);
543 if (!sock_info->wait_shm_mmap)
544 goto error;
545 }
546 ust_unlock();
547
548 DBG("Waiting for %s apps sessiond", sock_info->name);
80e2814b
MD
549 /* Wait for futex wakeup */
550 if (uatomic_read((int32_t *) sock_info->wait_shm_mmap) == 0) {
551 ret = futex_async((int32_t *) sock_info->wait_shm_mmap,
552 FUTEX_WAIT, 0, NULL, NULL, 0);
80e2814b 553 if (ret < 0) {
37ed587a
MD
554 if (errno == EFAULT) {
555 wait_poll_fallback = 1;
556 ERR(
557"Linux kernels 2.6.33 to 3.0 (with the exception of stable versions) "
558"do not support FUTEX_WAKE on read-only memory mappings correctly. "
559"Please upgrade your kernel "
560"(fix is commit 9ea71503a8ed9184d2d0b8ccc4d269d05f7940ae in Linux kernel "
561"mainline). LTTng-UST will use polling mode fallback.");
562 }
80e2814b 563 PERROR("futex");
80e2814b
MD
564 }
565 }
7fc90dca
MD
566 return;
567
568quit:
569 ust_unlock();
570 return;
571
572error:
573 ust_unlock();
7fc90dca 574 return;
46050b1a
MD
575}
576
1ea11eab
MD
577/*
578 * This thread does not allocate any resource, except within
579 * handle_message, within mutex protection. This mutex protects against
580 * fork and exit.
581 * The other moment it allocates resources is at socket connexion, which
582 * is also protected by the mutex.
583 */
d9e99d10
MD
584static
585void *ust_listener_thread(void *arg)
586{
1ea11eab 587 struct sock_info *sock_info = arg;
c0eedf81 588 int sock, ret, prev_connect_failed = 0, has_waited = 0;
d9e99d10 589
9eb62b9c
MD
590 /* Restart trying to connect to the session daemon */
591restart:
c0eedf81
MD
592 if (prev_connect_failed) {
593 /* Wait for sessiond availability with pipe */
594 wait_for_sessiond(sock_info);
595 if (has_waited) {
596 has_waited = 0;
597 /*
598 * Sleep for 5 seconds before retrying after a
599 * sequence of failure / wait / failure. This
600 * deals with a killed or broken session daemon.
601 */
602 sleep(5);
603 }
604 has_waited = 1;
605 prev_connect_failed = 0;
606 }
17dfb34b 607 ust_lock();
1ea11eab
MD
608
609 if (lttng_ust_comm_should_quit) {
17dfb34b 610 ust_unlock();
1ea11eab
MD
611 goto quit;
612 }
9eb62b9c 613
1ea11eab
MD
614 if (sock_info->socket != -1) {
615 ret = close(sock_info->socket);
616 if (ret) {
11ff9c7d 617 ERR("Error closing %s apps socket", sock_info->name);
1ea11eab
MD
618 }
619 sock_info->socket = -1;
620 }
46050b1a 621
9eb62b9c 622 /* Register */
1ea11eab 623 ret = lttcomm_connect_unix_sock(sock_info->sock_path);
9eb62b9c 624 if (ret < 0) {
11ff9c7d 625 ERR("Error connecting to %s apps socket", sock_info->name);
c0eedf81 626 prev_connect_failed = 1;
11ff9c7d
MD
627 /*
628 * If we cannot find the sessiond daemon, don't delay
629 * constructor execution.
630 */
edaa1431 631 ret = handle_register_done(sock_info);
11ff9c7d 632 assert(!ret);
17dfb34b 633 ust_unlock();
1ea11eab 634 goto restart;
46050b1a
MD
635 }
636
637 sock_info->socket = sock = ret;
638
639 /*
640 * Create only one root handle per listener thread for the whole
641 * process lifetime.
642 */
643 if (sock_info->root_handle == -1) {
644 ret = lttng_abi_create_root_handle();
a51070bb 645 if (ret < 0) {
46050b1a 646 ERR("Error creating root handle");
17dfb34b 647 ust_unlock();
46050b1a
MD
648 goto quit;
649 }
650 sock_info->root_handle = ret;
9eb62b9c 651 }
1ea11eab 652
9eb62b9c
MD
653 ret = register_app_to_sessiond(sock);
654 if (ret < 0) {
11ff9c7d 655 ERR("Error registering to %s apps socket", sock_info->name);
c0eedf81 656 prev_connect_failed = 1;
11ff9c7d
MD
657 /*
658 * If we cannot register to the sessiond daemon, don't
659 * delay constructor execution.
660 */
edaa1431 661 ret = handle_register_done(sock_info);
11ff9c7d 662 assert(!ret);
17dfb34b 663 ust_unlock();
9eb62b9c
MD
664 goto restart;
665 }
17dfb34b 666 ust_unlock();
46050b1a 667
d9e99d10
MD
668 for (;;) {
669 ssize_t len;
e7723462 670 struct lttcomm_ust_msg lum;
d9e99d10 671
e7723462 672 len = lttcomm_recv_unix_sock(sock, &lum, sizeof(lum));
d9e99d10
MD
673 switch (len) {
674 case 0: /* orderly shutdown */
11ff9c7d 675 DBG("%s ltt-sessiond has performed an orderly shutdown\n", sock_info->name);
d9e99d10 676 goto end;
e7723462 677 case sizeof(lum):
d9e99d10 678 DBG("message received\n");
11ff9c7d 679 ret = handle_message(sock_info, sock, &lum);
2a80c9d8 680 if (ret < 0) {
11ff9c7d 681 ERR("Error handling message for %s socket", sock_info->name);
d9e99d10
MD
682 }
683 continue;
684 case -1:
685 if (errno == ECONNRESET) {
11ff9c7d 686 ERR("%s remote end closed connection\n", sock_info->name);
d9e99d10
MD
687 goto end;
688 }
689 goto end;
690 default:
11ff9c7d 691 ERR("incorrect message size (%s socket): %zd\n", sock_info->name, len);
d9e99d10
MD
692 continue;
693 }
694
695 }
696end:
9eb62b9c 697 goto restart; /* try to reconnect */
1ea11eab 698quit:
d9e99d10
MD
699 return NULL;
700}
701
cf12a773
MD
702/*
703 * Return values: -1: don't wait. 0: wait forever. 1: timeout wait.
704 */
11ff9c7d
MD
705static
706int get_timeout(struct timespec *constructor_timeout)
707{
cf12a773
MD
708 long constructor_delay_ms = LTTNG_UST_DEFAULT_CONSTRUCTOR_TIMEOUT_MS;
709 char *str_delay;
11ff9c7d
MD
710 int ret;
711
cf12a773
MD
712 str_delay = getenv("UST_REGISTER_TIMEOUT");
713 if (str_delay) {
714 constructor_delay_ms = strtol(str_delay, NULL, 10);
715 }
716
717 switch (constructor_delay_ms) {
718 case -1:/* fall-through */
719 case 0:
720 return constructor_delay_ms;
721 default:
722 break;
723 }
724
725 /*
726 * If we are unable to find the current time, don't wait.
727 */
728 ret = clock_gettime(CLOCK_REALTIME, constructor_timeout);
729 if (ret) {
730 return -1;
731 }
95259bd0
MD
732 constructor_timeout->tv_sec += constructor_delay_ms / 1000UL;
733 constructor_timeout->tv_nsec +=
734 (constructor_delay_ms % 1000UL) * 1000000UL;
11ff9c7d
MD
735 if (constructor_timeout->tv_nsec >= 1000000000UL) {
736 constructor_timeout->tv_sec++;
737 constructor_timeout->tv_nsec -= 1000000000UL;
738 }
cf12a773 739 return 1;
11ff9c7d 740}
d9e99d10 741
2691221a
MD
742/*
743 * sessiond monitoring thread: monitor presence of global and per-user
744 * sessiond by polling the application common named pipe.
745 */
746/* TODO */
747
edaa1431 748void __attribute__((constructor)) lttng_ust_init(void)
2691221a 749{
11ff9c7d 750 struct timespec constructor_timeout;
cf12a773 751 int timeout_mode;
2691221a
MD
752 int ret;
753
edaa1431
MD
754 if (uatomic_xchg(&initialized, 1) == 1)
755 return;
756
757 /*
758 * We want precise control over the order in which we construct
759 * our sub-libraries vs starting to receive commands from
760 * sessiond (otherwise leading to errors when trying to create
761 * sessiond before the init functions are completed).
762 */
2691221a 763 init_usterr();
edaa1431
MD
764 init_tracepoint();
765 ltt_ring_buffer_metadata_client_init();
766 ltt_ring_buffer_client_overwrite_init();
767 ltt_ring_buffer_client_discard_init();
2691221a 768
cf12a773 769 timeout_mode = get_timeout(&constructor_timeout);
11ff9c7d 770
95259bd0 771 ret = sem_init(&constructor_wait, 0, 0);
11ff9c7d
MD
772 assert(!ret);
773
8d20bf54 774 ret = setup_local_apps();
2691221a 775 if (ret) {
8d20bf54 776 ERR("Error setting up to local apps");
2691221a 777 }
1ea11eab
MD
778 ret = pthread_create(&local_apps.ust_listener, NULL,
779 ust_listener_thread, &local_apps);
11ff9c7d 780
8d20bf54
MD
781 if (local_apps.allowed) {
782 ret = pthread_create(&global_apps.ust_listener, NULL,
783 ust_listener_thread, &global_apps);
784 } else {
785 handle_register_done(&local_apps);
786 }
787
cf12a773
MD
788 switch (timeout_mode) {
789 case 1: /* timeout wait */
95259bd0
MD
790 do {
791 ret = sem_timedwait(&constructor_wait,
792 &constructor_timeout);
793 } while (ret < 0 && errno == EINTR);
cf12a773
MD
794 if (ret < 0 && errno == ETIMEDOUT) {
795 ERR("Timed out waiting for ltt-sessiond");
796 } else {
797 assert(!ret);
798 }
799 break;
7b766b16 800 case -1:/* wait forever */
95259bd0
MD
801 do {
802 ret = sem_wait(&constructor_wait);
803 } while (ret < 0 && errno == EINTR);
11ff9c7d 804 assert(!ret);
cf12a773 805 break;
7b766b16 806 case 0: /* no timeout */
cf12a773 807 break;
11ff9c7d 808 }
2691221a
MD
809}
810
17dfb34b
MD
811static
812void lttng_ust_cleanup(int exiting)
813{
814 cleanup_sock_info(&global_apps);
815 if (local_apps.allowed) {
816 cleanup_sock_info(&local_apps);
817 }
818 lttng_ust_abi_exit();
819 ltt_events_exit();
820 ltt_ring_buffer_client_discard_exit();
821 ltt_ring_buffer_client_overwrite_exit();
822 ltt_ring_buffer_metadata_client_exit();
823 exit_tracepoint();
824 if (!exiting) {
825 /* Reinitialize values for fork */
826 sem_count = 2;
827 lttng_ust_comm_should_quit = 0;
828 initialized = 0;
829 }
830}
831
edaa1431 832void __attribute__((destructor)) lttng_ust_exit(void)
2691221a
MD
833{
834 int ret;
835
9eb62b9c
MD
836 /*
837 * Using pthread_cancel here because:
838 * A) we don't want to hang application teardown.
839 * B) the thread is not allocating any resource.
840 */
1ea11eab
MD
841
842 /*
843 * Require the communication thread to quit. Synchronize with
844 * mutexes to ensure it is not in a mutex critical section when
845 * pthread_cancel is later called.
846 */
17dfb34b 847 ust_lock();
1ea11eab 848 lttng_ust_comm_should_quit = 1;
17dfb34b 849 ust_unlock();
1ea11eab 850
1ea11eab 851 ret = pthread_cancel(global_apps.ust_listener);
9eb62b9c
MD
852 if (ret) {
853 ERR("Error cancelling global ust listener thread");
2691221a 854 }
8d20bf54
MD
855 if (local_apps.allowed) {
856 ret = pthread_cancel(local_apps.ust_listener);
857 if (ret) {
858 ERR("Error cancelling local ust listener thread");
859 }
8d20bf54 860 }
17dfb34b 861 lttng_ust_cleanup(1);
2691221a 862}
e822f505
MD
863
864/*
865 * We exclude the worker threads across fork and clone (except
866 * CLONE_VM), because these system calls only keep the forking thread
867 * running in the child. Therefore, we don't want to call fork or clone
868 * in the middle of an tracepoint or ust tracing state modification.
869 * Holding this mutex protects these structures across fork and clone.
870 */
871void ust_before_fork(ust_fork_info_t *fork_info)
872{
873 /*
874 * Disable signals. This is to avoid that the child intervenes
875 * before it is properly setup for tracing. It is safer to
876 * disable all signals, because then we know we are not breaking
877 * anything by restoring the original mask.
878 */
879 sigset_t all_sigs;
880 int ret;
881
882 /* Disable signals */
883 sigfillset(&all_sigs);
884 ret = sigprocmask(SIG_BLOCK, &all_sigs, &fork_info->orig_sigs);
885 if (ret == -1) {
886 PERROR("sigprocmask");
887 }
17dfb34b 888 ust_lock();
e822f505
MD
889 rcu_bp_before_fork();
890}
891
892static void ust_after_fork_common(ust_fork_info_t *fork_info)
893{
894 int ret;
895
17dfb34b
MD
896 DBG("process %d", getpid());
897 ust_unlock();
e822f505
MD
898 /* Restore signals */
899 ret = sigprocmask(SIG_SETMASK, &fork_info->orig_sigs, NULL);
900 if (ret == -1) {
901 PERROR("sigprocmask");
902 }
903}
904
905void ust_after_fork_parent(ust_fork_info_t *fork_info)
906{
17dfb34b 907 DBG("process %d", getpid());
e822f505
MD
908 rcu_bp_after_fork_parent();
909 /* Release mutexes and reenable signals */
910 ust_after_fork_common(fork_info);
911}
912
17dfb34b
MD
913/*
914 * After fork, in the child, we need to cleanup all the leftover state,
915 * except the worker thread which already magically disappeared thanks
916 * to the weird Linux fork semantics. After tyding up, we call
917 * lttng_ust_init() again to start over as a new PID.
918 *
919 * This is meant for forks() that have tracing in the child between the
920 * fork and following exec call (if there is any).
921 */
e822f505
MD
922void ust_after_fork_child(ust_fork_info_t *fork_info)
923{
17dfb34b 924 DBG("process %d", getpid());
e822f505
MD
925 /* Release urcu mutexes */
926 rcu_bp_after_fork_child();
17dfb34b 927 lttng_ust_cleanup(0);
a93bfc45 928 lttng_context_vtid_reset();
e822f505
MD
929 /* Release mutexes and reenable signals */
930 ust_after_fork_common(fork_info);
318dfea9 931 lttng_ust_init();
e822f505 932}
This page took 0.06789 seconds and 4 git commands to generate.