src/daemon/cmdline.c

   1 /***
   2   This file is part of PulseAudio.
   3
   4   Copyright 2004-2006 Lennart Poettering
   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.1 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 <stdlib.h>
  27 #include <stdio.h>
  28 #include <getopt.h>
  29
  30 #include <pulse/xmalloc.h>
  31 #include <pulse/util.h>
  32
  33 #include <pulsecore/core-util.h>
  34 #include <pulsecore/i18n.h>
  35 #include <pulsecore/strbuf.h>
  36 #include <pulsecore/macro.h>
  37
  38 #include "cmdline.h"
  39
  40 /* Argument codes for getopt_long() */
  41 enum {
  42     ARG_HELP = 256,
  43     ARG_VERSION,
  44     ARG_DUMP_CONF,
  45     ARG_DUMP_MODULES,
  46     ARG_DAEMONIZE,
  47     ARG_FAIL,
  48     ARG_LOG_LEVEL,
  49     ARG_HIGH_PRIORITY,
  50     ARG_REALTIME,
  51     ARG_DISALLOW_MODULE_LOADING,
  52     ARG_DISALLOW_EXIT,
  53     ARG_EXIT_IDLE_TIME,
  54     ARG_SCACHE_IDLE_TIME,
  55     ARG_LOG_TARGET,
  56     ARG_LOG_META,
  57     ARG_LOG_TIME,
  58     ARG_LOG_BACKTRACE,
  59     ARG_LOAD,
  60     ARG_FILE,
  61     ARG_DL_SEARCH_PATH,
  62     ARG_RESAMPLE_METHOD,
  63     ARG_KILL,
  64     ARG_USE_PID_FILE,
  65     ARG_CHECK,
  66     ARG_NO_CPU_LIMIT,
  67     ARG_DISABLE_SHM,
  68     ARG_DUMP_RESAMPLE_METHODS,
  69     ARG_SYSTEM,
  70     ARG_CLEANUP_SHM,
  71     ARG_START
  72 };
  73
  74 /* Table for getopt_long() */
  75 static const struct option long_options[] = {
  76     {"help",                        0, 0, ARG_HELP},
  77     {"version",                     0, 0, ARG_VERSION},
  78     {"dump-conf",                   0, 0, ARG_DUMP_CONF},
  79     {"dump-modules",                0, 0, ARG_DUMP_MODULES},
  80     {"daemonize",                   2, 0, ARG_DAEMONIZE},
  81     {"fail",                        2, 0, ARG_FAIL},
  82     {"verbose",                     2, 0, ARG_LOG_LEVEL},
  83     {"log-level",                   2, 0, ARG_LOG_LEVEL},
  84     {"high-priority",               2, 0, ARG_HIGH_PRIORITY},
  85     {"realtime",                    2, 0, ARG_REALTIME},
  86     {"disallow-module-loading",     2, 0, ARG_DISALLOW_MODULE_LOADING},
  87     {"disallow-exit",               2, 0, ARG_DISALLOW_EXIT},
  88     {"exit-idle-time",              1, 0, ARG_EXIT_IDLE_TIME},
  89     {"scache-idle-time",            1, 0, ARG_SCACHE_IDLE_TIME},
  90     {"log-target",                  1, 0, ARG_LOG_TARGET},
  91     {"log-meta",                    2, 0, ARG_LOG_META},
  92     {"log-time",                    2, 0, ARG_LOG_TIME},
  93     {"log-backtrace",               1, 0, ARG_LOG_BACKTRACE},
  94     {"load",                        1, 0, ARG_LOAD},
  95     {"file",                        1, 0, ARG_FILE},
  96     {"dl-search-path",              1, 0, ARG_DL_SEARCH_PATH},
  97     {"resample-method",             1, 0, ARG_RESAMPLE_METHOD},
  98     {"kill",                        0, 0, ARG_KILL},
  99     {"start",                       0, 0, ARG_START},
 100     {"use-pid-file",                2, 0, ARG_USE_PID_FILE},
 101     {"check",                       0, 0, ARG_CHECK},
 102     {"system",                      2, 0, ARG_SYSTEM},
 103     {"no-cpu-limit",                2, 0, ARG_NO_CPU_LIMIT},
 104     {"disable-shm",                 2, 0, ARG_DISABLE_SHM},
 105     {"dump-resample-methods",       2, 0, ARG_DUMP_RESAMPLE_METHODS},
 106     {"cleanup-shm",                 2, 0, ARG_CLEANUP_SHM},
 107     {NULL, 0, 0, 0}
 108 };
 109
 110 void pa_cmdline_help(const char *argv0) {
 111     pa_assert(argv0);
 112
 113     printf(_("%s [options]\n\n"
 114            "COMMANDS:\n"
 115            "  -h, --help                            Show this help\n"
 116            "      --version                         Show version\n"
 117            "      --dump-conf                       Dump default configuration\n"
 118            "      --dump-modules                    Dump list of available modules\n"
 119            "      --dump-resample-methods           Dump available resample methods\n"
 120            "      --cleanup-shm                     Cleanup stale shared memory segments\n"
 121            "      --start                           Start the daemon if it is not running\n"
 122            "  -k  --kill                            Kill a running daemon\n"
 123            "      --check                           Check for a running daemon (only returns exit code)\n\n"
 124
 125            "OPTIONS:\n"
 126            "      --system[=BOOL]                   Run as system-wide instance\n"
 127            "  -D, --daemonize[=BOOL]                Daemonize after startup\n"
 128            "      --fail[=BOOL]                     Quit when startup fails\n"
 129            "      --high-priority[=BOOL]            Try to set high nice level\n"
 130            "                                        (only available as root, when SUID or\n"
 131            "                                        with elevated RLIMIT_NICE)\n"
 132            "      --realtime[=BOOL]                 Try to enable realtime scheduling\n"
 133            "                                        (only available as root, when SUID or\n"
 134            "                                        with elevated RLIMIT_RTPRIO)\n"
 135            "      --disallow-module-loading[=BOOL]  Disallow module user requested module\n"
 136            "                                        loading/unloading after startup\n"
 137            "      --disallow-exit[=BOOL]            Disallow user requested exit\n"
 138            "      --exit-idle-time=SECS             Terminate the daemon when idle and this\n"
 139            "                                        time passed\n"
 140            "      --scache-idle-time=SECS           Unload autoloaded samples when idle and\n"
 141            "                                        this time passed\n"
 142            "      --log-level[=LEVEL]               Increase or set verbosity level\n"
 143            "  -v                                    Increase the verbosity level\n"
 144            "      --log-target={auto,syslog,stderr,file:PATH}\n"
 145            "                                        Specify the log target\n"
 146            "      --log-meta[=BOOL]                 Include code location in log messages\n"
 147            "      --log-time[=BOOL]                 Include timestamps in log messages\n"
 148            "      --log-backtrace=FRAMES            Include a backtrace in log messages\n"
 149            "  -p, --dl-search-path=PATH             Set the search path for dynamic shared\n"
 150            "                                        objects (plugins)\n"
 151            "      --resample-method=METHOD          Use the specified resampling method\n"
 152            "                                        (See --dump-resample-methods for\n"
 153            "                                        possible values)\n"
 154            "      --use-pid-file[=BOOL]             Create a PID file\n"
 155            "      --no-cpu-limit[=BOOL]             Do not install CPU load limiter on\n"
 156            "                                        platforms that support it.\n"
 157            "      --disable-shm[=BOOL]              Disable shared memory support.\n\n"
 158
 159            "STARTUP SCRIPT:\n"
 160            "  -L, --load=\"MODULE ARGUMENTS\"         Load the specified plugin module with\n"
 161            "                                        the specified argument\n"
 162            "  -F, --file=FILENAME                   Run the specified script\n"
 163            "  -C                                    Open a command line on the running TTY\n"
 164            "                                        after startup\n\n"
 165
 166            "  -n                                    Don't load default script file\n"),
 167            pa_path_get_filename(argv0));
 168 }
 169
 170 int pa_cmdline_parse(pa_daemon_conf *conf, int argc, char *const argv [], int *d) {
 171     pa_strbuf *buf = NULL;
 172     int c;
 173
 174     pa_assert(conf);
 175     pa_assert(argc > 0);
 176     pa_assert(argv);
 177
 178     buf = pa_strbuf_new();
 179
 180     if (conf->script_commands)
 181         pa_strbuf_puts(buf, conf->script_commands);
 182
 183     while ((c = getopt_long(argc, argv, "L:F:ChDnp:kv", long_options, NULL)) != -1) {
 184         switch (c) {
 185             case ARG_HELP:
 186             case 'h':
 187                 conf->cmd = PA_CMD_HELP;
 188                 break;
 189
 190             case ARG_VERSION:
 191                 conf->cmd = PA_CMD_VERSION;
 192                 break;
 193
 194             case ARG_DUMP_CONF:
 195                 conf->cmd = PA_CMD_DUMP_CONF;
 196                 break;
 197
 198             case ARG_DUMP_MODULES:
 199                 conf->cmd = PA_CMD_DUMP_MODULES;
 200                 break;
 201
 202             case ARG_DUMP_RESAMPLE_METHODS:
 203                 conf->cmd = PA_CMD_DUMP_RESAMPLE_METHODS;
 204                 break;
 205
 206             case ARG_CLEANUP_SHM:
 207                 conf->cmd = PA_CMD_CLEANUP_SHM;
 208                 break;
 209
 210             case 'k':
 211             case ARG_KILL:
 212                 conf->cmd = PA_CMD_KILL;
 213                 break;
 214
 215             case ARG_START:
 216                 conf->cmd = PA_CMD_START;
 217                 conf->daemonize = TRUE;
 218                 break;
 219
 220             case ARG_CHECK:
 221                 conf->cmd = PA_CMD_CHECK;
 222                 break;
 223
 224             case ARG_LOAD:
 225             case 'L':
 226                 pa_strbuf_printf(buf, "load-module %s\n", optarg);
 227                 break;
 228
 229             case ARG_FILE:
 230             case 'F': {
 231                 char *p;
 232                 pa_strbuf_printf(buf, ".include %s\n", p = pa_make_path_absolute(optarg));
 233                 pa_xfree(p);
 234                 break;
 235             }
 236
 237             case 'C':
 238                 pa_strbuf_puts(buf, "load-module module-cli exit_on_eof=1\n");
 239                 break;
 240
 241             case ARG_DAEMONIZE:
 242             case 'D':
 243                 if ((conf->daemonize = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 244                     pa_log(_("--daemonize expects boolean argument"));
 245                     goto fail;
 246                 }
 247                 break;
 248
 249             case ARG_FAIL:
 250                 if ((conf->fail = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 251                     pa_log(_("--fail expects boolean argument"));
 252                     goto fail;
 253                 }
 254                 break;
 255
 256             case 'v':
 257             case ARG_LOG_LEVEL:
 258
 259                 if (optarg) {
 260                     if (pa_daemon_conf_set_log_level(conf, optarg) < 0) {
 261                         pa_log(_("--log-level expects log level argument (either numeric in range 0..4 or one of debug, info, notice, warn, error)."));
 262                         goto fail;
 263                     }
 264                 } else {
 265                     if (conf->log_level < PA_LOG_LEVEL_MAX-1)
 266                         conf->log_level++;
 267                 }
 268
 269                 break;
 270
 271             case ARG_HIGH_PRIORITY:
 272                 if ((conf->high_priority = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 273                     pa_log(_("--high-priority expects boolean argument"));
 274                     goto fail;
 275                 }
 276                 break;
 277
 278             case ARG_REALTIME:
 279                 if ((conf->realtime_scheduling = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 280                     pa_log(_("--realtime expects boolean argument"));
 281                     goto fail;
 282                 }
 283                 break;
 284
 285             case ARG_DISALLOW_MODULE_LOADING:
 286                 if ((conf->disallow_module_loading = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 287                     pa_log(_("--disallow-module-loading expects boolean argument"));
 288                     goto fail;
 289                 }
 290                 break;
 291
 292             case ARG_DISALLOW_EXIT:
 293                 if ((conf->disallow_exit = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 294                     pa_log(_("--disallow-exit expects boolean argument"));
 295                     goto fail;
 296                 }
 297                 break;
 298
 299             case ARG_USE_PID_FILE:
 300                 if ((conf->use_pid_file = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 301                     pa_log(_("--use-pid-file expects boolean argument"));
 302                     goto fail;
 303                 }
 304                 break;
 305
 306             case 'p':
 307             case ARG_DL_SEARCH_PATH:
 308                 pa_xfree(conf->dl_search_path);
 309                 conf->dl_search_path = *optarg ? pa_xstrdup(optarg) : NULL;
 310                 break;
 311
 312             case 'n':
 313                 conf->load_default_script_file = FALSE;
 314                 break;
 315
 316             case ARG_LOG_TARGET:
 317                 if (pa_daemon_conf_set_log_target(conf, optarg) < 0) {
 318                     pa_log(_("Invalid log target: use either 'syslog', 'stderr' or 'auto' or a valid file name 'file:<path>'."));
 319                     goto fail;
 320                 }
 321                 break;
 322
 323             case ARG_LOG_TIME:
 324                 if ((conf->log_time = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 325                     pa_log(_("--log-time expects boolean argument"));
 326                     goto fail;
 327                 }
 328                 break;
 329
 330             case ARG_LOG_META:
 331                 if ((conf->log_meta = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 332                     pa_log(_("--log-meta expects boolean argument"));
 333                     goto fail;
 334                 }
 335                 break;
 336
 337             case ARG_LOG_BACKTRACE:
 338                 conf->log_backtrace = (unsigned) atoi(optarg);
 339                 break;
 340
 341             case ARG_EXIT_IDLE_TIME:
 342                 conf->exit_idle_time = atoi(optarg);
 343                 break;
 344
 345             case ARG_SCACHE_IDLE_TIME:
 346                 conf->scache_idle_time = atoi(optarg);
 347                 break;
 348
 349             case ARG_RESAMPLE_METHOD:
 350                 if (pa_daemon_conf_set_resample_method(conf, optarg) < 0) {
 351                     pa_log(_("Invalid resample method '%s'."), optarg);
 352                     goto fail;
 353                 }
 354                 break;
 355
 356             case ARG_SYSTEM:
 357                 if ((conf->system_instance = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 358                     pa_log(_("--system expects boolean argument"));
 359                     goto fail;
 360                 }
 361                 break;
 362
 363             case ARG_NO_CPU_LIMIT:
 364                 if ((conf->no_cpu_limit = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 365                     pa_log(_("--no-cpu-limit expects boolean argument"));
 366                     goto fail;
 367                 }
 368                 break;
 369
 370             case ARG_DISABLE_SHM:
 371                 if ((conf->disable_shm = optarg ? pa_parse_boolean(optarg) : TRUE) < 0) {
 372                     pa_log(_("--disable-shm expects boolean argument"));
 373                     goto fail;
 374                 }
 375                 break;
 376
 377             default:
 378                 goto fail;
 379         }
 380     }
 381
 382     pa_xfree(conf->script_commands);
 383     conf->script_commands = pa_strbuf_tostring_free(buf);
 384
 385     *d = optind;
 386
 387     return 0;
 388
 389 fail:
 390     if (buf)
 391         pa_strbuf_free(buf);
 392
 393     return -1;
 394 }