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