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