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