src/daemon/main.c

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