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/help-texts.h" 46 #include "qemu-version.h" 47 #include "qemu/cutils.h" 48 #include "qemu/config-file.h" 49 #include "qemu/error-report.h" 50 #include "qemu/help_option.h" 51 #include "qemu/log.h" 52 #include "qemu/main-loop.h" 53 #include "qemu/module.h" 54 #include "qemu/option.h" 55 #include "qom/object_interfaces.h" 56 57 #include "storage-daemon/qapi/qapi-commands.h" 58 #include "storage-daemon/qapi/qapi-init-commands.h" 59 60 #include "sysemu/runstate.h" 61 #include "trace/control.h" 62 63 static const char *pid_file; 64 static volatile bool exit_requested = false; 65 66 void qemu_system_killed(int signal, pid_t pid) 67 { 68 exit_requested = true; 69 } 70 71 void qmp_quit(Error **errp) 72 { 73 exit_requested = true; 74 } 75 76 static void help(void) 77 { 78 printf( 79 "Usage: %s [options]\n" 80 "QEMU storage daemon\n" 81 "\n" 82 " -h, --help display this help and exit\n" 83 " -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 84 " specify tracing options\n" 85 " -V, --version output version information and exit\n" 86 "\n" 87 " --blockdev [driver=]<driver>[,node-name=<N>][,discard=ignore|unmap]\n" 88 " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 89 " [,read-only=on|off][,auto-read-only=on|off]\n" 90 " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 91 " [,driver specific parameters...]\n" 92 " configure a block backend\n" 93 "\n" 94 " --chardev <options> configure a character device backend\n" 95 " (see the qemu(1) man page for possible options)\n" 96 "\n" 97 " --daemonize daemonize the process, and have the parent exit\n" 98 " once startup is complete\n" 99 "\n" 100 " --export [type=]nbd,id=<id>,node-name=<node-name>[,name=<export-name>]\n" 101 " [,writable=on|off][,bitmap=<name>]\n" 102 " export the specified block node over NBD\n" 103 " (requires --nbd-server)\n" 104 "\n" 105 #ifdef CONFIG_FUSE 106 " --export [type=]fuse,id=<id>,node-name=<node-name>,mountpoint=<file>\n" 107 " [,growable=on|off][,writable=on|off][,allow-other=on|off|auto]\n" 108 " export the specified block node over FUSE\n" 109 "\n" 110 #endif /* CONFIG_FUSE */ 111 #ifdef CONFIG_VHOST_USER_BLK_SERVER 112 " --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,\n" 113 " addr.type=unix,addr.path=<socket-path>[,writable=on|off]\n" 114 " [,logical-block-size=<block-size>][,num-queues=<num-queues>]\n" 115 " export the specified block node as a\n" 116 " vhost-user-blk device over UNIX domain socket\n" 117 " --export [type=]vhost-user-blk,id=<id>,node-name=<node-name>,\n" 118 " addr.type=fd,addr.str=<fd>[,writable=on|off]\n" 119 " [,logical-block-size=<block-size>][,num-queues=<num-queues>]\n" 120 " export the specified block node as a\n" 121 " vhost-user-blk device over file descriptor\n" 122 "\n" 123 #endif /* CONFIG_VHOST_USER_BLK_SERVER */ 124 #ifdef CONFIG_VDUSE_BLK_EXPORT 125 " --export [type=]vduse-blk,id=<id>,node-name=<node-name>\n" 126 " [,writable=on|off][,num-queues=<num-queues>]\n" 127 " [,queue-size=<queue-size>]\n" 128 " [,logical-block-size=<logical-block-size>]\n" 129 " export the specified block node as a vduse-blk\n" 130 " device using the id as the VDUSE device name\n" 131 "\n" 132 #endif /* CONFIG_VDUSE_BLK_EXPORT */ 133 " --monitor [chardev=]name[,mode=control][,pretty[=on|off]]\n" 134 " configure a QMP monitor\n" 135 "\n" 136 " --nbd-server addr.type=inet,addr.host=<host>,addr.port=<port>\n" 137 " [,tls-creds=<id>][,tls-authz=<id>][,max-connections=<n>]\n" 138 " --nbd-server addr.type=unix,addr.path=<path>\n" 139 " [,tls-creds=<id>][,tls-authz=<id>][,max-connections=<n>]\n" 140 " start an NBD server for exporting block nodes\n" 141 "\n" 142 " --object help list object types that can be added\n" 143 " --object <type>,help list properties for the given object type\n" 144 " --object <type>[,<property>=<value>...]\n" 145 " create a new object of type <type>, setting\n" 146 " properties in the order they are specified. Note\n" 147 " that the 'id' property must be set.\n" 148 " See the qemu(1) man page for documentation of the\n" 149 " objects that can be added.\n" 150 "\n" 151 " --pidfile <path> write process ID to a file after startup\n" 152 "\n" 153 QEMU_HELP_BOTTOM "\n", 154 g_get_prgname()); 155 } 156 157 enum { 158 OPTION_BLOCKDEV = 256, 159 OPTION_CHARDEV, 160 OPTION_DAEMONIZE, 161 OPTION_EXPORT, 162 OPTION_MONITOR, 163 OPTION_NBD_SERVER, 164 OPTION_OBJECT, 165 OPTION_PIDFILE, 166 }; 167 168 extern QemuOptsList qemu_chardev_opts; 169 170 static void init_qmp_commands(void) 171 { 172 qmp_init_marshal(&qmp_commands); 173 174 QTAILQ_INIT(&qmp_cap_negotiation_commands); 175 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities", 176 qmp_marshal_qmp_capabilities, 177 QCO_ALLOW_PRECONFIG, 0); 178 } 179 180 static int getopt_set_loc(int argc, char **argv, const char *optstring, 181 const struct option *longopts) 182 { 183 int c, save_index; 184 185 optarg = NULL; 186 save_index = optind; 187 c = getopt_long(argc, argv, optstring, longopts, NULL); 188 if (optarg) { 189 loc_set_cmdline(argv, save_index, MAX(1, optind - save_index)); 190 } 191 return c; 192 } 193 194 /** 195 * Process QSD command-line arguments. 196 * 197 * This is done in two passes: 198 * 199 * First (@pre_init_pass is true), we do a pass where all global 200 * arguments pertaining to the QSD process (like --help or --daemonize) 201 * are processed. This pass is done before most of the QEMU-specific 202 * initialization steps (e.g. initializing the block layer or QMP), and 203 * so must only process arguments that are not really QEMU-specific. 204 * 205 * Second (@pre_init_pass is false), we (sequentially) process all 206 * QEMU/QSD-specific arguments. Many of these arguments are effectively 207 * translated to QMP commands (like --blockdev for blockdev-add, or 208 * --export for block-export-add). 209 */ 210 static void process_options(int argc, char *argv[], bool pre_init_pass) 211 { 212 int c; 213 214 static const struct option long_options[] = { 215 {"blockdev", required_argument, NULL, OPTION_BLOCKDEV}, 216 {"chardev", required_argument, NULL, OPTION_CHARDEV}, 217 {"daemonize", no_argument, NULL, OPTION_DAEMONIZE}, 218 {"export", required_argument, NULL, OPTION_EXPORT}, 219 {"help", no_argument, NULL, 'h'}, 220 {"monitor", required_argument, NULL, OPTION_MONITOR}, 221 {"nbd-server", required_argument, NULL, OPTION_NBD_SERVER}, 222 {"object", required_argument, NULL, OPTION_OBJECT}, 223 {"pidfile", required_argument, NULL, OPTION_PIDFILE}, 224 {"trace", required_argument, NULL, 'T'}, 225 {"version", no_argument, NULL, 'V'}, 226 {0, 0, 0, 0} 227 }; 228 229 /* 230 * In contrast to the system emulator, QEMU-specific options are processed 231 * in the order they are given on the command lines. This means that things 232 * must be defined first before they can be referenced in another option. 233 */ 234 optind = 1; 235 while ((c = getopt_set_loc(argc, argv, "-hT:V", long_options)) != -1) { 236 bool handle_option_pre_init; 237 238 /* Should this argument be processed in the pre-init pass? */ 239 handle_option_pre_init = 240 c == '?' || 241 c == 'h' || 242 c == 'V' || 243 c == OPTION_DAEMONIZE || 244 c == OPTION_PIDFILE; 245 246 /* Process every option only in its respective pass */ 247 if (pre_init_pass != handle_option_pre_init) { 248 continue; 249 } 250 251 switch (c) { 252 case '?': 253 exit(EXIT_FAILURE); 254 case 'h': 255 help(); 256 exit(EXIT_SUCCESS); 257 case 'T': 258 trace_opt_parse(optarg); 259 trace_init_file(); 260 break; 261 case 'V': 262 printf("qemu-storage-daemon version " 263 QEMU_FULL_VERSION "\n" QEMU_COPYRIGHT "\n"); 264 exit(EXIT_SUCCESS); 265 case OPTION_BLOCKDEV: 266 { 267 Visitor *v; 268 BlockdevOptions *options; 269 270 v = qobject_input_visitor_new_str(optarg, "driver", 271 &error_fatal); 272 273 visit_type_BlockdevOptions(v, NULL, &options, &error_fatal); 274 visit_free(v); 275 276 qmp_blockdev_add(options, &error_fatal); 277 qapi_free_BlockdevOptions(options); 278 break; 279 } 280 case OPTION_CHARDEV: 281 { 282 /* TODO This interface is not stable until we QAPIfy it */ 283 QemuOpts *opts = qemu_opts_parse_noisily(&qemu_chardev_opts, 284 optarg, true); 285 if (opts == NULL) { 286 exit(EXIT_FAILURE); 287 } 288 289 if (!qemu_chr_new_from_opts(opts, NULL, &error_fatal)) { 290 /* No error, but NULL returned means help was printed */ 291 exit(EXIT_SUCCESS); 292 } 293 qemu_opts_del(opts); 294 break; 295 } 296 case OPTION_DAEMONIZE: 297 if (os_set_daemonize(true) < 0) { 298 error_report("--daemonize not supported in this build"); 299 exit(EXIT_FAILURE); 300 } 301 break; 302 case OPTION_EXPORT: 303 { 304 Visitor *v; 305 BlockExportOptions *export; 306 307 v = qobject_input_visitor_new_str(optarg, "type", &error_fatal); 308 visit_type_BlockExportOptions(v, NULL, &export, &error_fatal); 309 visit_free(v); 310 311 qmp_block_export_add(export, &error_fatal); 312 qapi_free_BlockExportOptions(export); 313 break; 314 } 315 case OPTION_MONITOR: 316 { 317 Visitor *v; 318 MonitorOptions *monitor; 319 320 v = qobject_input_visitor_new_str(optarg, "chardev", 321 &error_fatal); 322 visit_type_MonitorOptions(v, NULL, &monitor, &error_fatal); 323 visit_free(v); 324 325 /* TODO Catch duplicate monitor IDs */ 326 monitor_init(monitor, false, &error_fatal); 327 qapi_free_MonitorOptions(monitor); 328 break; 329 } 330 case OPTION_NBD_SERVER: 331 { 332 Visitor *v; 333 NbdServerOptions *options; 334 335 v = qobject_input_visitor_new_str(optarg, NULL, &error_fatal); 336 visit_type_NbdServerOptions(v, NULL, &options, &error_fatal); 337 visit_free(v); 338 339 nbd_server_start_options(options, &error_fatal); 340 qapi_free_NbdServerOptions(options); 341 break; 342 } 343 case OPTION_OBJECT: 344 user_creatable_process_cmdline(optarg); 345 break; 346 case OPTION_PIDFILE: 347 pid_file = optarg; 348 break; 349 case 1: 350 error_report("Unexpected argument"); 351 exit(EXIT_FAILURE); 352 default: 353 g_assert_not_reached(); 354 } 355 } 356 loc_set_none(); 357 } 358 359 static void pid_file_cleanup(void) 360 { 361 unlink(pid_file); 362 } 363 364 static void pid_file_init(void) 365 { 366 Error *err = NULL; 367 368 if (!pid_file) { 369 return; 370 } 371 372 if (!qemu_write_pidfile(pid_file, &err)) { 373 error_reportf_err(err, "cannot create PID file: "); 374 exit(EXIT_FAILURE); 375 } 376 377 atexit(pid_file_cleanup); 378 } 379 380 int main(int argc, char *argv[]) 381 { 382 #ifdef CONFIG_POSIX 383 signal(SIGPIPE, SIG_IGN); 384 #endif 385 386 error_init(argv[0]); 387 qemu_init_exec_dir(argv[0]); 388 os_setup_signal_handling(); 389 390 process_options(argc, argv, true); 391 392 os_daemonize(); 393 394 module_call_init(MODULE_INIT_QOM); 395 module_call_init(MODULE_INIT_TRACE); 396 qemu_add_opts(&qemu_trace_opts); 397 qcrypto_init(&error_fatal); 398 bdrv_init(); 399 monitor_init_globals_core(); 400 init_qmp_commands(); 401 402 if (!trace_init_backends()) { 403 return EXIT_FAILURE; 404 } 405 qemu_set_log(LOG_TRACE, &error_fatal); 406 407 qemu_init_main_loop(&error_fatal); 408 process_options(argc, argv, false); 409 410 /* 411 * Write the pid file after creating chardevs, exports, and NBD servers but 412 * before accepting connections. This ordering is documented. Do not change 413 * it. 414 */ 415 pid_file_init(); 416 os_setup_post(); 417 418 while (!exit_requested) { 419 main_loop_wait(false); 420 } 421 422 blk_exp_close_all(); 423 bdrv_drain_all_begin(); 424 job_cancel_sync_all(); 425 bdrv_close_all(); 426 427 monitor_cleanup(); 428 qemu_chr_cleanup(); 429 user_creatable_cleanup(); 430 431 return EXIT_SUCCESS; 432 } 433