storage-daemon/qemu-storage-daemon.c

   1 /*
   2  * QEMU storage daemon
   3  *
   4  * Copyright (c) 2003-2008 Fabrice Bellard
   5  * Copyright (c) 2019 Kevin Wolf <kwolf@redhat.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  23  * THE SOFTWARE.
  24  */
  25
  26 #include "qemu/osdep.h"
  27
  28 #include <getopt.h>
  29
  30 #include "block/block.h"
  31 #include "block/nbd.h"
  32 #include "chardev/char.h"
  33 #include "crypto/init.h"
  34 #include "monitor/monitor.h"
  35 #include "monitor/monitor-internal.h"
  36
  37 #include "qapi/error.h"
  38 #include "qapi/qapi-visit-block-core.h"
  39 #include "qapi/qapi-visit-block-export.h"
  40 #include "qapi/qapi-visit-control.h"
  41 #include "qapi/qmp/qdict.h"
  42 #include "qapi/qmp/qstring.h"
  43 #include "qapi/qobject-input-visitor.h"
  44
  45 #include "qemu-common.h"
  46 #include "qemu-version.h"
  47 #include "qemu/config-file.h"
  48 #include "qemu/error-report.h"
  49 #include "qemu/help_option.h"
  50 #include "qemu/log.h"
  51 #include "qemu/main-loop.h"
  52 #include "qemu/module.h"
  53 #include "qemu/option.h"
  54 #include "qom/object_interfaces.h"
  55
  56 #include "storage-daemon/qapi/qapi-commands.h"
  57 #include "storage-daemon/qapi/qapi-init-commands.h"
  58
  59 #include "sysemu/runstate.h"
  60 #include "trace/control.h"
  61
  62 static const char *pid_file;
  63 static volatile bool exit_requested = false;
  64
  65 void qemu_system_killed(int signal, pid_t pid)
  66 {
  67     exit_requested = true;
  68 }
  69
  70 void qmp_quit(Error **errp)
  71 {
  72     exit_requested = true;
  73 }
  74
  75 static void help(void)
  76 {
  77     printf(
  78 "Usage: %s [options]\n"
  79 "QEMU storage daemon\n"
  80 "\n"
  81 "  -h, --help             display this help and exit\n"
  82 "  -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
  83 "                         specify tracing options\n"
  84 "  -V, --version          output version information and exit\n"
  85 "\n"
  86 "  --blockdev [driver=]<driver>[,node-name=<N>][,discard=ignore|unmap]\n"
  87 "             [,cache.direct=on|off][,cache.no-flush=on|off]\n"
  88 "             [,read-only=on|off][,auto-read-only=on|off]\n"
  89 "             [,force-share=on|off][,detect-zeroes=on|off|unmap]\n"
  90 "             [,driver specific parameters...]\n"
  91 "                         configure a block backend\n"
  92 "\n"
  93 "  --chardev <options>    configure a character device backend\n"
  94 "                         (see the qemu(1) man page for possible options)\n"
  95 "\n"
  96 "  --export [type=]nbd,id=<id>,node-name=<node-name>[,name=<export-name>]\n"
  97 "           [,writable=on|off][,bitmap=<name>]\n"
  98 "                         export the specified block node over NBD\n"
  99 "                         (requires --nbd-server)\n"
 100 "\n"
 101 "  --monitor [chardev=]name[,mode=control][,pretty[=on|off]]\n"
 102 "                         configure a QMP monitor\n"
 103 "\n"
 104 "  --nbd-server addr.type=inet,addr.host=<host>,addr.port=<port>\n"
 105 "               [,tls-creds=<id>][,tls-authz=<id>][,max-connections=<n>]\n"
 106 "  --nbd-server addr.type=unix,addr.path=<path>\n"
 107 "               [,tls-creds=<id>][,tls-authz=<id>][,max-connections=<n>]\n"
 108 "                         start an NBD server for exporting block nodes\n"
 109 "\n"
 110 "  --object help          list object types that can be added\n"
 111 "  --object <type>,help   list properties for the given object type\n"
 112 "  --object <type>[,<property>=<value>...]\n"
 113 "                         create a new object of type <type>, setting\n"
 114 "                         properties in the order they are specified. Note\n"
 115 "                         that the 'id' property must be set.\n"
 116 "                         See the qemu(1) man page for documentation of the\n"
 117 "                         objects that can be added.\n"
 118 "\n"
 119 "  --pidfile <path>       write process ID to a file after startup\n"
 120 "\n"
 121 QEMU_HELP_BOTTOM "\n",
 122     error_get_progname());
 123 }
 124
 125 enum {
 126     OPTION_BLOCKDEV = 256,
 127     OPTION_CHARDEV,
 128     OPTION_EXPORT,
 129     OPTION_MONITOR,
 130     OPTION_NBD_SERVER,
 131     OPTION_OBJECT,
 132     OPTION_PIDFILE,
 133 };
 134
 135 extern QemuOptsList qemu_chardev_opts;
 136
 137 static QemuOptsList qemu_object_opts = {
 138     .name = "object",
 139     .implied_opt_name = "qom-type",
 140     .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
 141     .desc = {
 142         { }
 143     },
 144 };
 145
 146 static void init_qmp_commands(void)
 147 {
 148     qmp_init_marshal(&qmp_commands);
 149     qmp_register_command(&qmp_commands, "query-qmp-schema",
 150                          qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG);
 151     qmp_register_command(&qmp_commands, "object-add", qmp_object_add,
 152                          QCO_NO_OPTIONS);
 153
 154     QTAILQ_INIT(&qmp_cap_negotiation_commands);
 155     qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities",
 156                          qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG);
 157 }
 158
 159 static int getopt_set_loc(int argc, char **argv, const char *optstring,
 160                           const struct option *longopts)
 161 {
 162     int c, save_index;
 163
 164     optarg = NULL;
 165     save_index = optind;
 166     c = getopt_long(argc, argv, optstring, longopts, NULL);
 167     if (optarg) {
 168         loc_set_cmdline(argv, save_index, MAX(1, optind - save_index));
 169     }
 170     return c;
 171 }
 172
 173 static void process_options(int argc, char *argv[])
 174 {
 175     int c;
 176
 177     static const struct option long_options[] = {
 178         {"blockdev", required_argument, NULL, OPTION_BLOCKDEV},
 179         {"chardev", required_argument, NULL, OPTION_CHARDEV},
 180         {"export", required_argument, NULL, OPTION_EXPORT},
 181         {"help", no_argument, NULL, 'h'},
 182         {"monitor", required_argument, NULL, OPTION_MONITOR},
 183         {"nbd-server", required_argument, NULL, OPTION_NBD_SERVER},
 184         {"object", required_argument, NULL, OPTION_OBJECT},
 185         {"pidfile", required_argument, NULL, OPTION_PIDFILE},
 186         {"trace", required_argument, NULL, 'T'},
 187         {"version", no_argument, NULL, 'V'},
 188         {0, 0, 0, 0}
 189     };
 190
 191     /*
 192      * In contrast to the system emulator, options are processed in the order
 193      * they are given on the command lines. This means that things must be
 194      * defined first before they can be referenced in another option.
 195      */
 196     while ((c = getopt_set_loc(argc, argv, "-hT:V", long_options)) != -1) {
 197         switch (c) {
 198         case '?':
 199             exit(EXIT_FAILURE);
 200         case 'h':
 201             help();
 202             exit(EXIT_SUCCESS);
 203         case 'T':
 204             trace_opt_parse(optarg);
 205             trace_init_file();
 206             break;
 207         case 'V':
 208             printf("qemu-storage-daemon version "
 209                    QEMU_FULL_VERSION "\n" QEMU_COPYRIGHT "\n");
 210             exit(EXIT_SUCCESS);
 211         case OPTION_BLOCKDEV:
 212             {
 213                 Visitor *v;
 214                 BlockdevOptions *options;
 215
 216                 v = qobject_input_visitor_new_str(optarg, "driver",
 217                                                   &error_fatal);
 218
 219                 visit_type_BlockdevOptions(v, NULL, &options, &error_fatal);
 220                 visit_free(v);
 221
 222                 qmp_blockdev_add(options, &error_fatal);
 223                 qapi_free_BlockdevOptions(options);
 224                 break;
 225             }
 226         case OPTION_CHARDEV:
 227             {
 228                 /* TODO This interface is not stable until we QAPIfy it */
 229                 QemuOpts *opts = qemu_opts_parse_noisily(&qemu_chardev_opts,
 230                                                          optarg, true);
 231                 if (opts == NULL) {
 232                     exit(EXIT_FAILURE);
 233                 }
 234
 235                 if (!qemu_chr_new_from_opts(opts, NULL, &error_fatal)) {
 236                     /* No error, but NULL returned means help was printed */
 237                     exit(EXIT_SUCCESS);
 238                 }
 239                 qemu_opts_del(opts);
 240                 break;
 241             }
 242         case OPTION_EXPORT:
 243             {
 244                 Visitor *v;
 245                 BlockExportOptions *export;
 246
 247                 v = qobject_input_visitor_new_str(optarg, "type", &error_fatal);
 248                 visit_type_BlockExportOptions(v, NULL, &export, &error_fatal);
 249                 visit_free(v);
 250
 251                 qmp_block_export_add(export, &error_fatal);
 252                 qapi_free_BlockExportOptions(export);
 253                 break;
 254             }
 255         case OPTION_MONITOR:
 256             {
 257                 Visitor *v;
 258                 MonitorOptions *monitor;
 259
 260                 v = qobject_input_visitor_new_str(optarg, "chardev",
 261                                                   &error_fatal);
 262                 visit_type_MonitorOptions(v, NULL, &monitor, &error_fatal);
 263                 visit_free(v);
 264
 265                 /* TODO Catch duplicate monitor IDs */
 266                 monitor_init(monitor, false, &error_fatal);
 267                 qapi_free_MonitorOptions(monitor);
 268                 break;
 269             }
 270         case OPTION_NBD_SERVER:
 271             {
 272                 Visitor *v;
 273                 NbdServerOptions *options;
 274
 275                 v = qobject_input_visitor_new_str(optarg, NULL, &error_fatal);
 276                 visit_type_NbdServerOptions(v, NULL, &options, &error_fatal);
 277                 visit_free(v);
 278
 279                 nbd_server_start_options(options, &error_fatal);
 280                 qapi_free_NbdServerOptions(options);
 281                 break;
 282             }
 283         case OPTION_OBJECT:
 284             {
 285                 QDict *args;
 286                 bool help;
 287
 288                 args = keyval_parse(optarg, "qom-type", &help, &error_fatal);
 289                 if (help) {
 290                     user_creatable_print_help_from_qdict(args);
 291                     exit(EXIT_SUCCESS);
 292                 }
 293                 user_creatable_add_dict(args, true, &error_fatal);
 294                 qobject_unref(args);
 295                 break;
 296             }
 297         case OPTION_PIDFILE:
 298             pid_file = optarg;
 299             break;
 300         case 1:
 301             error_report("Unexpected argument");
 302             exit(EXIT_FAILURE);
 303         default:
 304             g_assert_not_reached();
 305         }
 306     }
 307     loc_set_none();
 308 }
 309
 310 static void pid_file_cleanup(void)
 311 {
 312     unlink(pid_file);
 313 }
 314
 315 static void pid_file_init(void)
 316 {
 317     Error *err = NULL;
 318
 319     if (!pid_file) {
 320         return;
 321     }
 322
 323     if (!qemu_write_pidfile(pid_file, &err)) {
 324         error_reportf_err(err, "cannot create PID file: ");
 325         exit(EXIT_FAILURE);
 326     }
 327
 328     atexit(pid_file_cleanup);
 329 }
 330
 331 int main(int argc, char *argv[])
 332 {
 333 #ifdef CONFIG_POSIX
 334     signal(SIGPIPE, SIG_IGN);
 335 #endif
 336
 337     error_init(argv[0]);
 338     qemu_init_exec_dir(argv[0]);
 339     os_setup_signal_handling();
 340
 341     module_call_init(MODULE_INIT_QOM);
 342     module_call_init(MODULE_INIT_TRACE);
 343     qemu_add_opts(&qemu_object_opts);
 344     qemu_add_opts(&qemu_trace_opts);
 345     qcrypto_init(&error_fatal);
 346     bdrv_init();
 347     monitor_init_globals_core();
 348     init_qmp_commands();
 349
 350     if (!trace_init_backends()) {
 351         return EXIT_FAILURE;
 352     }
 353     qemu_set_log(LOG_TRACE);
 354
 355     qemu_init_main_loop(&error_fatal);
 356     process_options(argc, argv);
 357
 358     /*
 359      * Write the pid file after creating chardevs, exports, and NBD servers but
 360      * before accepting connections. This ordering is documented. Do not change
 361      * it.
 362      */
 363     pid_file_init();
 364
 365     while (!exit_requested) {
 366         main_loop_wait(false);
 367     }
 368
 369     blk_exp_close_all();
 370     bdrv_drain_all_begin();
 371     bdrv_close_all();
 372
 373     monitor_cleanup();
 374     qemu_chr_cleanup();
 375     user_creatable_cleanup();
 376
 377     return EXIT_SUCCESS;
 378 }