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 void init_qmp_commands(void) 138 { 139 qmp_init_marshal(&qmp_commands); 140 qmp_register_command(&qmp_commands, "query-qmp-schema", 141 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG); 142 143 QTAILQ_INIT(&qmp_cap_negotiation_commands); 144 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities", 145 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG); 146 } 147 148 static int getopt_set_loc(int argc, char **argv, const char *optstring, 149 const struct option *longopts) 150 { 151 int c, save_index; 152 153 optarg = NULL; 154 save_index = optind; 155 c = getopt_long(argc, argv, optstring, longopts, NULL); 156 if (optarg) { 157 loc_set_cmdline(argv, save_index, MAX(1, optind - save_index)); 158 } 159 return c; 160 } 161 162 static void process_options(int argc, char *argv[]) 163 { 164 int c; 165 166 static const struct option long_options[] = { 167 {"blockdev", required_argument, NULL, OPTION_BLOCKDEV}, 168 {"chardev", required_argument, NULL, OPTION_CHARDEV}, 169 {"export", required_argument, NULL, OPTION_EXPORT}, 170 {"help", no_argument, NULL, 'h'}, 171 {"monitor", required_argument, NULL, OPTION_MONITOR}, 172 {"nbd-server", required_argument, NULL, OPTION_NBD_SERVER}, 173 {"object", required_argument, NULL, OPTION_OBJECT}, 174 {"pidfile", required_argument, NULL, OPTION_PIDFILE}, 175 {"trace", required_argument, NULL, 'T'}, 176 {"version", no_argument, NULL, 'V'}, 177 {0, 0, 0, 0} 178 }; 179 180 /* 181 * In contrast to the system emulator, options are processed in the order 182 * they are given on the command lines. This means that things must be 183 * defined first before they can be referenced in another option. 184 */ 185 while ((c = getopt_set_loc(argc, argv, "-hT:V", long_options)) != -1) { 186 switch (c) { 187 case '?': 188 exit(EXIT_FAILURE); 189 case 'h': 190 help(); 191 exit(EXIT_SUCCESS); 192 case 'T': 193 trace_opt_parse(optarg); 194 trace_init_file(); 195 break; 196 case 'V': 197 printf("qemu-storage-daemon version " 198 QEMU_FULL_VERSION "\n" QEMU_COPYRIGHT "\n"); 199 exit(EXIT_SUCCESS); 200 case OPTION_BLOCKDEV: 201 { 202 Visitor *v; 203 BlockdevOptions *options; 204 205 v = qobject_input_visitor_new_str(optarg, "driver", 206 &error_fatal); 207 208 visit_type_BlockdevOptions(v, NULL, &options, &error_fatal); 209 visit_free(v); 210 211 qmp_blockdev_add(options, &error_fatal); 212 qapi_free_BlockdevOptions(options); 213 break; 214 } 215 case OPTION_CHARDEV: 216 { 217 /* TODO This interface is not stable until we QAPIfy it */ 218 QemuOpts *opts = qemu_opts_parse_noisily(&qemu_chardev_opts, 219 optarg, true); 220 if (opts == NULL) { 221 exit(EXIT_FAILURE); 222 } 223 224 if (!qemu_chr_new_from_opts(opts, NULL, &error_fatal)) { 225 /* No error, but NULL returned means help was printed */ 226 exit(EXIT_SUCCESS); 227 } 228 qemu_opts_del(opts); 229 break; 230 } 231 case OPTION_EXPORT: 232 { 233 Visitor *v; 234 BlockExportOptions *export; 235 236 v = qobject_input_visitor_new_str(optarg, "type", &error_fatal); 237 visit_type_BlockExportOptions(v, NULL, &export, &error_fatal); 238 visit_free(v); 239 240 qmp_block_export_add(export, &error_fatal); 241 qapi_free_BlockExportOptions(export); 242 break; 243 } 244 case OPTION_MONITOR: 245 { 246 Visitor *v; 247 MonitorOptions *monitor; 248 249 v = qobject_input_visitor_new_str(optarg, "chardev", 250 &error_fatal); 251 visit_type_MonitorOptions(v, NULL, &monitor, &error_fatal); 252 visit_free(v); 253 254 /* TODO Catch duplicate monitor IDs */ 255 monitor_init(monitor, false, &error_fatal); 256 qapi_free_MonitorOptions(monitor); 257 break; 258 } 259 case OPTION_NBD_SERVER: 260 { 261 Visitor *v; 262 NbdServerOptions *options; 263 264 v = qobject_input_visitor_new_str(optarg, NULL, &error_fatal); 265 visit_type_NbdServerOptions(v, NULL, &options, &error_fatal); 266 visit_free(v); 267 268 nbd_server_start_options(options, &error_fatal); 269 qapi_free_NbdServerOptions(options); 270 break; 271 } 272 case OPTION_OBJECT: 273 user_creatable_process_cmdline(optarg); 274 break; 275 case OPTION_PIDFILE: 276 pid_file = optarg; 277 break; 278 case 1: 279 error_report("Unexpected argument"); 280 exit(EXIT_FAILURE); 281 default: 282 g_assert_not_reached(); 283 } 284 } 285 loc_set_none(); 286 } 287 288 static void pid_file_cleanup(void) 289 { 290 unlink(pid_file); 291 } 292 293 static void pid_file_init(void) 294 { 295 Error *err = NULL; 296 297 if (!pid_file) { 298 return; 299 } 300 301 if (!qemu_write_pidfile(pid_file, &err)) { 302 error_reportf_err(err, "cannot create PID file: "); 303 exit(EXIT_FAILURE); 304 } 305 306 atexit(pid_file_cleanup); 307 } 308 309 int main(int argc, char *argv[]) 310 { 311 #ifdef CONFIG_POSIX 312 signal(SIGPIPE, SIG_IGN); 313 #endif 314 315 error_init(argv[0]); 316 qemu_init_exec_dir(argv[0]); 317 os_setup_signal_handling(); 318 319 module_call_init(MODULE_INIT_QOM); 320 module_call_init(MODULE_INIT_TRACE); 321 qemu_add_opts(&qemu_trace_opts); 322 qcrypto_init(&error_fatal); 323 bdrv_init(); 324 monitor_init_globals_core(); 325 init_qmp_commands(); 326 327 if (!trace_init_backends()) { 328 return EXIT_FAILURE; 329 } 330 qemu_set_log(LOG_TRACE); 331 332 qemu_init_main_loop(&error_fatal); 333 process_options(argc, argv); 334 335 /* 336 * Write the pid file after creating chardevs, exports, and NBD servers but 337 * before accepting connections. This ordering is documented. Do not change 338 * it. 339 */ 340 pid_file_init(); 341 342 while (!exit_requested) { 343 main_loop_wait(false); 344 } 345 346 blk_exp_close_all(); 347 bdrv_drain_all_begin(); 348 job_cancel_sync_all(); 349 bdrv_close_all(); 350 351 monitor_cleanup(); 352 qemu_chr_cleanup(); 353 user_creatable_cleanup(); 354 355 return EXIT_SUCCESS; 356 } 357