]> code.delx.au - pulseaudio/blob - src/daemon/main.c
replace a pa_assert() by an pa_assert_se()
[pulseaudio] / src / daemon / main.c
1 /* $Id$ */
2
3 /***
4 This file is part of PulseAudio.
5
6 Copyright 2004-2006 Lennart Poettering
7 Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
8
9 PulseAudio is free software; you can redistribute it and/or modify
10 it under the terms of the GNU Lesser General Public License as published
11 by the Free Software Foundation; either version 2 of the License,
12 or (at your option) any later version.
13
14 PulseAudio is distributed in the hope that it will be useful, but
15 WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 General Public License for more details.
18
19 You should have received a copy of the GNU Lesser General Public License
20 along with PulseAudio; if not, write to the Free Software
21 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
22 USA.
23 ***/
24
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28
29 #include <unistd.h>
30 #include <errno.h>
31 #include <string.h>
32 #include <stdlib.h>
33 #include <stdio.h>
34 #include <signal.h>
35 #include <stddef.h>
36 #include <assert.h>
37 #include <ltdl.h>
38 #include <limits.h>
39 #include <fcntl.h>
40 #include <unistd.h>
41 #include <locale.h>
42 #include <sys/types.h>
43
44 #include <liboil/liboil.h>
45
46 #ifdef HAVE_SYS_IOCTL_H
47 #include <sys/ioctl.h>
48 #endif
49
50 #ifdef HAVE_PWD_H
51 #include <pwd.h>
52 #endif
53 #ifdef HAVE_GRP_H
54 #include <grp.h>
55 #endif
56
57 #ifdef HAVE_LIBWRAP
58 #include <syslog.h>
59 #include <tcpd.h>
60 #endif
61
62 #include "../pulsecore/winsock.h"
63
64 #include <pulse/mainloop.h>
65 #include <pulse/mainloop-signal.h>
66 #include <pulse/timeval.h>
67 #include <pulse/xmalloc.h>
68
69 #include <pulsecore/core-error.h>
70 #include <pulsecore/core.h>
71 #include <pulsecore/memblock.h>
72 #include <pulsecore/module.h>
73 #include <pulsecore/cli-command.h>
74 #include <pulsecore/log.h>
75 #include <pulsecore/core-util.h>
76 #include <pulsecore/sioman.h>
77 #include <pulsecore/cli-text.h>
78 #include <pulsecore/pid.h>
79 #include <pulsecore/namereg.h>
80 #include <pulsecore/random.h>
81 #include <pulsecore/rtsig.h>
82 #include <pulsecore/rtclock.h>
83
84 #include "cmdline.h"
85 #include "cpulimit.h"
86 #include "daemon-conf.h"
87 #include "dumpmodules.h"
88 #include "caps.h"
89
90 #ifdef HAVE_LIBWRAP
91 /* Only one instance of these variables */
92 int allow_severity = LOG_INFO;
93 int deny_severity = LOG_WARNING;
94 #endif
95
96 #ifdef HAVE_OSS
97 /* padsp looks for this symbol in the running process and disables
98 * itself if it finds it and it is set to 7 (which is actually a bit
99 * mask). For details see padsp. */
100 int __padsp_disabled__ = 7;
101 #endif
102
103 #ifdef OS_IS_WIN32
104
105 static void message_cb(pa_mainloop_api*a, pa_time_event*e, PA_GCC_UNUSED const struct timeval *tv, void *userdata) {
106 MSG msg;
107 struct timeval tvnext;
108
109 while(PeekMessage(&msg, NULL, 0, 0, PM_REMOVE)) {
110 if (msg.message == WM_QUIT)
111 raise(SIGTERM);
112 else {
113 TranslateMessage(&msg);
114 DispatchMessage(&msg);
115 }
116 }
117
118 pa_timeval_add(pa_gettimeofday(&tvnext), 100000);
119 a->time_restart(e, &tvnext);
120 }
121
122 #endif
123
124 static void signal_callback(pa_mainloop_api*m, PA_GCC_UNUSED pa_signal_event *e, int sig, void *userdata) {
125 pa_log_info("Got signal %s.", pa_strsignal(sig));
126
127 switch (sig) {
128 #ifdef SIGUSR1
129 case SIGUSR1:
130 pa_module_load(userdata, "module-cli", NULL);
131 break;
132 #endif
133
134 #ifdef SIGUSR2
135 case SIGUSR2:
136 pa_module_load(userdata, "module-cli-protocol-unix", NULL);
137 break;
138 #endif
139
140 #ifdef SIGHUP
141 case SIGHUP: {
142 char *c = pa_full_status_string(userdata);
143 pa_log_notice("%s", c);
144 pa_xfree(c);
145 return;
146 }
147 #endif
148
149 case SIGINT:
150 case SIGTERM:
151 default:
152 pa_log_info("Exiting.");
153 m->quit(m, 1);
154 break;
155 }
156 }
157
158 static void close_pipe(int p[2]) {
159 if (p[0] != -1)
160 close(p[0]);
161 if (p[1] != -1)
162 close(p[1]);
163 p[0] = p[1] = -1;
164 }
165
166 #define set_env(key, value) putenv(pa_sprintf_malloc("%s=%s", (key), (value)))
167
168 #if defined(HAVE_PWD_H) && defined(HAVE_GRP_H)
169
170 static int change_user(void) {
171 struct passwd *pw;
172 struct group * gr;
173 int r;
174
175 /* This function is called only in system-wide mode. It creates a
176 * runtime dir in /var/run/ with proper UID/GID and drops privs
177 * afterwards. */
178
179 if (!(pw = getpwnam(PA_SYSTEM_USER))) {
180 pa_log("Failed to find user '%s'.", PA_SYSTEM_USER);
181 return -1;
182 }
183
184 if (!(gr = getgrnam(PA_SYSTEM_GROUP))) {
185 pa_log("Failed to find group '%s'.", PA_SYSTEM_GROUP);
186 return -1;
187 }
188
189 pa_log_info("Found user '%s' (UID %lu) and group '%s' (GID %lu).",
190 PA_SYSTEM_USER, (unsigned long) pw->pw_uid,
191 PA_SYSTEM_GROUP, (unsigned long) gr->gr_gid);
192
193 if (pw->pw_gid != gr->gr_gid) {
194 pa_log("GID of user '%s' and of group '%s' don't match.", PA_SYSTEM_USER, PA_SYSTEM_GROUP);
195 return -1;
196 }
197
198 if (strcmp(pw->pw_dir, PA_SYSTEM_RUNTIME_PATH) != 0)
199 pa_log_warn("Warning: home directory of user '%s' is not '%s', ignoring.", PA_SYSTEM_USER, PA_SYSTEM_RUNTIME_PATH);
200
201 if (pa_make_secure_dir(PA_SYSTEM_RUNTIME_PATH, 0755, pw->pw_uid, gr->gr_gid) < 0) {
202 pa_log("Failed to create '%s': %s", PA_SYSTEM_RUNTIME_PATH, pa_cstrerror(errno));
203 return -1;
204 }
205
206 if (initgroups(PA_SYSTEM_USER, gr->gr_gid) != 0) {
207 pa_log("Failed to change group list: %s", pa_cstrerror(errno));
208 return -1;
209 }
210
211 #if defined(HAVE_SETRESGID)
212 r = setresgid(gr->gr_gid, gr->gr_gid, gr->gr_gid);
213 #elif defined(HAVE_SETEGID)
214 if ((r = setgid(gr->gr_gid)) >= 0)
215 r = setegid(gr->gr_gid);
216 #elif defined(HAVE_SETREGID)
217 r = setregid(gr->gr_gid, gr->gr_gid);
218 #else
219 #error "No API to drop priviliges"
220 #endif
221
222 if (r < 0) {
223 pa_log("Failed to change GID: %s", pa_cstrerror(errno));
224 return -1;
225 }
226
227 #if defined(HAVE_SETRESUID)
228 r = setresuid(pw->pw_uid, pw->pw_uid, pw->pw_uid);
229 #elif defined(HAVE_SETEUID)
230 if ((r = setuid(pw->pw_uid)) >= 0)
231 r = seteuid(pw->pw_uid);
232 #elif defined(HAVE_SETREUID)
233 r = setreuid(pw->pw_uid, pw->pw_uid);
234 #else
235 #error "No API to drop priviliges"
236 #endif
237
238 if (r < 0) {
239 pa_log("Failed to change UID: %s", pa_cstrerror(errno));
240 return -1;
241 }
242
243 set_env("USER", PA_SYSTEM_USER);
244 set_env("LOGNAME", PA_SYSTEM_GROUP);
245 set_env("HOME", PA_SYSTEM_RUNTIME_PATH);
246
247 /* Relevant for pa_runtime_path() */
248 set_env("PULSE_RUNTIME_PATH", PA_SYSTEM_RUNTIME_PATH);
249 set_env("PULSE_CONFIG_PATH", PA_SYSTEM_RUNTIME_PATH);
250
251 pa_log_info("Successfully dropped root privileges.");
252
253 return 0;
254 }
255
256 #else /* HAVE_PWD_H && HAVE_GRP_H */
257
258 static int change_user(void) {
259 pa_log("System wide mode unsupported on this platform.");
260 return -1;
261 }
262
263 #endif /* HAVE_PWD_H && HAVE_GRP_H */
264
265 static int create_runtime_dir(void) {
266 char fn[PATH_MAX];
267
268 pa_runtime_path(NULL, fn, sizeof(fn));
269
270 /* This function is called only when the daemon is started in
271 * per-user mode. We create the runtime directory somewhere in
272 * /tmp/ with the current UID/GID */
273
274 if (pa_make_secure_dir(fn, 0700, (uid_t)-1, (gid_t)-1) < 0) {
275 pa_log("Failed to create '%s': %s", fn, pa_cstrerror(errno));
276 return -1;
277 }
278
279 return 0;
280 }
281
282 #ifdef HAVE_SYS_RESOURCE_H
283
284 static void set_one_rlimit(const pa_rlimit *r, int resource, const char *name) {
285 struct rlimit rl;
286 assert(r);
287
288 if (!r->is_set)
289 return;
290
291 rl.rlim_cur = rl.rlim_max = r->value;
292
293 if (setrlimit(resource, &rl) < 0)
294 pa_log_warn("setrlimit(%s, (%u, %u)) failed: %s", name, (unsigned) r->value, (unsigned) r->value, pa_cstrerror(errno));
295 }
296
297 static void set_all_rlimits(const pa_daemon_conf *conf) {
298 set_one_rlimit(&conf->rlimit_as, RLIMIT_AS, "RLIMIT_AS");
299 set_one_rlimit(&conf->rlimit_core, RLIMIT_CORE, "RLIMIT_CORE");
300 set_one_rlimit(&conf->rlimit_data, RLIMIT_DATA, "RLIMIT_DATA");
301 set_one_rlimit(&conf->rlimit_fsize, RLIMIT_FSIZE, "RLIMIT_FSIZE");
302 set_one_rlimit(&conf->rlimit_nofile, RLIMIT_NOFILE, "RLIMIT_NOFILE");
303 set_one_rlimit(&conf->rlimit_stack, RLIMIT_STACK, "RLIMIT_STACK");
304 #ifdef RLIMIT_NPROC
305 set_one_rlimit(&conf->rlimit_nproc, RLIMIT_NPROC, "RLIMIT_NPROC");
306 #endif
307 #ifdef RLIMIT_MEMLOCK
308 set_one_rlimit(&conf->rlimit_memlock, RLIMIT_MEMLOCK, "RLIMIT_MEMLOCK");
309 #endif
310 }
311 #endif
312
313 int main(int argc, char *argv[]) {
314 pa_core *c = NULL;
315 pa_strbuf *buf = NULL;
316 pa_daemon_conf *conf = NULL;
317 pa_mainloop *mainloop = NULL;
318
319 char *s;
320 int r, retval = 1, d = 0;
321 int daemon_pipe[2] = { -1, -1 };
322 int suid_root, real_root;
323 int valid_pid_file = 0;
324
325 gid_t gid = (gid_t) -1;
326
327 #ifdef OS_IS_WIN32
328 pa_time_event *timer;
329 struct timeval tv;
330 #endif
331
332 #ifdef HAVE_GETUID
333 real_root = getuid() == 0;
334 suid_root = !real_root && geteuid() == 0;
335 #else
336 real_root = 0;
337 suid_root = 0;
338 #endif
339
340 if (suid_root) {
341 /* Drop all capabilities except CAP_SYS_NICE */
342 pa_limit_caps();
343
344 /* Drop priviliges, but keep CAP_SYS_NICE */
345 pa_drop_root();
346
347 /* After dropping root, the effective set is reset, hence,
348 * let's raise it again */
349 pa_limit_caps();
350
351 /* When capabilities are not supported we will not be able to
352 * aquire RT sched anymore. But yes, that's the way it is. It
353 * is just too risky tun let PA run as root all the time. */
354 }
355
356 setlocale(LC_ALL, "");
357
358 if (suid_root && (pa_own_uid_in_group(PA_REALTIME_GROUP, &gid) <= 0)) {
359 pa_log_warn("WARNING: called SUID root, but not in group '"PA_REALTIME_GROUP"'.");
360 pa_drop_caps();
361 pa_drop_root();
362 suid_root = real_root = 0;
363 }
364
365 LTDL_SET_PRELOADED_SYMBOLS();
366
367 r = lt_dlinit();
368 assert(r == 0);
369
370 #ifdef OS_IS_WIN32
371 {
372 WSADATA data;
373 WSAStartup(MAKEWORD(2, 0), &data);
374 }
375 #endif
376
377 pa_random_seed();
378
379 pa_log_set_ident("pulseaudio");
380
381 conf = pa_daemon_conf_new();
382
383 if (pa_daemon_conf_load(conf, NULL) < 0)
384 goto finish;
385
386 if (pa_daemon_conf_env(conf) < 0)
387 goto finish;
388
389 if (pa_cmdline_parse(conf, argc, argv, &d) < 0) {
390 pa_log("failed to parse command line.");
391 goto finish;
392 }
393
394 pa_log_set_maximal_level(conf->log_level);
395 pa_log_set_target(conf->auto_log_target ? PA_LOG_STDERR : conf->log_target, NULL);
396
397 if (conf->high_priority && conf->cmd == PA_CMD_DAEMON)
398 pa_raise_priority();
399
400 if (suid_root && (conf->cmd != PA_CMD_DAEMON || !conf->high_priority)) {
401 pa_drop_caps();
402 pa_drop_root();
403 }
404
405 if (conf->dl_search_path)
406 lt_dlsetsearchpath(conf->dl_search_path);
407
408 switch (conf->cmd) {
409 case PA_CMD_DUMP_MODULES:
410 pa_dump_modules(conf, argc-d, argv+d);
411 retval = 0;
412 goto finish;
413
414 case PA_CMD_DUMP_CONF: {
415 s = pa_daemon_conf_dump(conf);
416 fputs(s, stdout);
417 pa_xfree(s);
418 retval = 0;
419 goto finish;
420 }
421
422 case PA_CMD_DUMP_RESAMPLE_METHODS: {
423 int i;
424
425 for (i = 0; i < PA_RESAMPLER_MAX; i++)
426 printf("%s\n", pa_resample_method_to_string(i));
427
428 goto finish;
429 }
430
431 case PA_CMD_HELP :
432 pa_cmdline_help(argv[0]);
433 retval = 0;
434 goto finish;
435
436 case PA_CMD_VERSION :
437 printf(PACKAGE_NAME" "PACKAGE_VERSION"\n");
438 retval = 0;
439 goto finish;
440
441 case PA_CMD_CHECK: {
442 pid_t pid;
443
444 if (pa_pid_file_check_running(&pid) < 0) {
445 pa_log_info("daemon not running");
446 } else {
447 pa_log_info("daemon running as PID %u", pid);
448 retval = 0;
449 }
450
451 goto finish;
452
453 }
454 case PA_CMD_KILL:
455
456 if (pa_pid_file_kill(SIGINT, NULL) < 0)
457 pa_log("failed to kill daemon.");
458 else
459 retval = 0;
460
461 goto finish;
462
463 default:
464 assert(conf->cmd == PA_CMD_DAEMON);
465 }
466
467 if (real_root && !conf->system_instance) {
468 pa_log_warn("This program is not intended to be run as root (unless --system is specified).");
469 } else if (!real_root && conf->system_instance) {
470 pa_log("Root priviliges required.");
471 goto finish;
472 }
473
474 if (conf->daemonize) {
475 pid_t child;
476 int tty_fd;
477
478 if (pa_stdio_acquire() < 0) {
479 pa_log("failed to acquire stdio.");
480 goto finish;
481 }
482
483 #ifdef HAVE_FORK
484 if (pipe(daemon_pipe) < 0) {
485 pa_log("failed to create pipe.");
486 goto finish;
487 }
488
489 if ((child = fork()) < 0) {
490 pa_log("fork() failed: %s", pa_cstrerror(errno));
491 goto finish;
492 }
493
494 if (child != 0) {
495 /* Father */
496
497 close(daemon_pipe[1]);
498 daemon_pipe[1] = -1;
499
500 if (pa_loop_read(daemon_pipe[0], &retval, sizeof(retval), NULL) != sizeof(retval)) {
501 pa_log("read() failed: %s", pa_cstrerror(errno));
502 retval = 1;
503 }
504
505 if (retval)
506 pa_log("daemon startup failed.");
507 else
508 pa_log_info("daemon startup successful.");
509
510 goto finish;
511 }
512
513 close(daemon_pipe[0]);
514 daemon_pipe[0] = -1;
515 #endif
516
517 if (conf->auto_log_target)
518 pa_log_set_target(PA_LOG_SYSLOG, NULL);
519
520 #ifdef HAVE_SETSID
521 setsid();
522 #endif
523 #ifdef HAVE_SETPGID
524 setpgid(0,0);
525 #endif
526
527 #ifndef OS_IS_WIN32
528 close(0);
529 close(1);
530 close(2);
531
532 open("/dev/null", O_RDONLY);
533 open("/dev/null", O_WRONLY);
534 open("/dev/null", O_WRONLY);
535 #else
536 FreeConsole();
537 #endif
538
539 #ifdef SIGTTOU
540 signal(SIGTTOU, SIG_IGN);
541 #endif
542 #ifdef SIGTTIN
543 signal(SIGTTIN, SIG_IGN);
544 #endif
545 #ifdef SIGTSTP
546 signal(SIGTSTP, SIG_IGN);
547 #endif
548
549 #ifdef TIOCNOTTY
550 if ((tty_fd = open("/dev/tty", O_RDWR)) >= 0) {
551 ioctl(tty_fd, TIOCNOTTY, (char*) 0);
552 close(tty_fd);
553 }
554 #endif
555 }
556
557 pa_assert_se(chdir("/") == 0);
558 umask(0022);
559
560 if (conf->system_instance) {
561 if (change_user() < 0)
562 goto finish;
563 } else if (create_runtime_dir() < 0)
564 goto finish;
565
566 if (conf->use_pid_file) {
567 if (pa_pid_file_create() < 0) {
568 pa_log("pa_pid_file_create() failed.");
569 #ifdef HAVE_FORK
570 if (conf->daemonize)
571 pa_loop_write(daemon_pipe[1], &retval, sizeof(retval), NULL);
572 #endif
573 goto finish;
574 }
575
576 valid_pid_file = 1;
577 }
578
579 #ifdef HAVE_SYS_RESOURCE_H
580 set_all_rlimits(conf);
581 #endif
582
583 #ifdef SIGPIPE
584 signal(SIGPIPE, SIG_IGN);
585 #endif
586
587 if (pa_rtclock_hrtimer())
588 pa_log_debug("Fresh high-resolution timers available! Bon appetit!");
589 else
590 pa_log_info("Dude, your kernel stinks! The chef's recommendation today is Linux with high-resolution timers enabled!");
591
592 pa_rtsig_configure(SIGRTMIN+10, SIGRTMAX);
593
594 mainloop = pa_mainloop_new();
595 assert(mainloop);
596
597 if (!(c = pa_core_new(pa_mainloop_get_api(mainloop), !conf->disable_shm))) {
598 pa_log("pa_core_new() failed.");
599 goto finish;
600 }
601
602 c->is_system_instance = !!conf->system_instance;
603 c->high_priority = !!conf->high_priority;
604 c->default_sample_spec = conf->default_sample_spec;
605 c->default_n_fragments = conf->default_n_fragments;
606 c->default_fragment_size_msec = conf->default_fragment_size_msec;
607 c->disallow_module_loading = conf->disallow_module_loading;
608 c->exit_idle_time = conf->exit_idle_time;
609 c->module_idle_time = conf->module_idle_time;
610 c->scache_idle_time = conf->scache_idle_time;
611 c->resample_method = conf->resample_method;
612
613 pa_assert_se(pa_signal_init(pa_mainloop_get_api(mainloop)) == 0);
614 pa_signal_new(SIGINT, signal_callback, c);
615 pa_signal_new(SIGTERM, signal_callback, c);
616
617 #ifdef SIGUSR1
618 pa_signal_new(SIGUSR1, signal_callback, c);
619 #endif
620 #ifdef SIGUSR2
621 pa_signal_new(SIGUSR2, signal_callback, c);
622 #endif
623 #ifdef SIGHUP
624 pa_signal_new(SIGHUP, signal_callback, c);
625 #endif
626
627 #ifdef OS_IS_WIN32
628 timer = pa_mainloop_get_api(mainloop)->time_new(
629 pa_mainloop_get_api(mainloop), pa_gettimeofday(&tv), message_cb, NULL);
630 assert(timer);
631 #endif
632
633 if (conf->daemonize)
634 c->running_as_daemon = 1;
635
636 oil_init();
637
638 if (!conf->no_cpu_limit) {
639 r = pa_cpu_limit_init(pa_mainloop_get_api(mainloop));
640 assert(r == 0);
641 }
642
643 buf = pa_strbuf_new();
644 if (conf->default_script_file)
645 r = pa_cli_command_execute_file(c, conf->default_script_file, buf, &conf->fail);
646
647 if (r >= 0)
648 r = pa_cli_command_execute(c, conf->script_commands, buf, &conf->fail);
649 pa_log_error("%s", s = pa_strbuf_tostring_free(buf));
650 pa_xfree(s);
651
652 if (r < 0 && conf->fail) {
653 pa_log("failed to initialize daemon.");
654 #ifdef HAVE_FORK
655 if (conf->daemonize)
656 pa_loop_write(daemon_pipe[1], &retval, sizeof(retval), NULL);
657 #endif
658 } else if (!c->modules || pa_idxset_size(c->modules) == 0) {
659 pa_log("daemon startup without any loaded modules, refusing to work.");
660 #ifdef HAVE_FORK
661 if (conf->daemonize)
662 pa_loop_write(daemon_pipe[1], &retval, sizeof(retval), NULL);
663 #endif
664 } else {
665
666 retval = 0;
667 #ifdef HAVE_FORK
668 if (conf->daemonize)
669 pa_loop_write(daemon_pipe[1], &retval, sizeof(retval), NULL);
670 #endif
671
672 if (c->default_sink_name &&
673 pa_namereg_get(c, c->default_sink_name, PA_NAMEREG_SINK, 1) == NULL) {
674 pa_log_error("%s : Fatal error. Default sink name (%s) does not exist in name register.", __FILE__, c->default_sink_name);
675 retval = 1;
676 } else {
677 pa_log_info("Daemon startup complete.");
678 if (pa_mainloop_run(mainloop, &retval) < 0)
679 retval = 1;
680 pa_log_info("Daemon shutdown initiated.");
681 }
682 }
683
684 #ifdef OS_IS_WIN32
685 pa_mainloop_get_api(mainloop)->time_free(timer);
686 #endif
687
688 pa_core_unref(c);
689
690 if (!conf->no_cpu_limit)
691 pa_cpu_limit_done();
692
693 pa_signal_done();
694
695 pa_log_info("Daemon terminated.");
696
697 finish:
698
699 if (mainloop)
700 pa_mainloop_free(mainloop);
701
702 if (conf)
703 pa_daemon_conf_free(conf);
704
705 if (valid_pid_file)
706 pa_pid_file_remove();
707
708 close_pipe(daemon_pipe);
709
710 #ifdef OS_IS_WIN32
711 WSACleanup();
712 #endif
713
714 lt_dlexit();
715
716 return retval;
717 }