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