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.h" 39 #include "qapi/qapi-visit-block-core.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 volatile bool exit_requested = false; 63 64 void qemu_system_killed(int signal, pid_t pid) 65 { 66 exit_requested = true; 67 } 68 69 void qmp_quit(Error **errp) 70 { 71 exit_requested = true; 72 } 73 74 static void help(void) 75 { 76 printf( 77 "Usage: %s [options]\n" 78 "QEMU storage daemon\n" 79 "\n" 80 " -h, --help display this help and exit\n" 81 " -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n" 82 " specify tracing options\n" 83 " -V, --version output version information and exit\n" 84 "\n" 85 " --blockdev [driver=]<driver>[,node-name=<N>][,discard=ignore|unmap]\n" 86 " [,cache.direct=on|off][,cache.no-flush=on|off]\n" 87 " [,read-only=on|off][,auto-read-only=on|off]\n" 88 " [,force-share=on|off][,detect-zeroes=on|off|unmap]\n" 89 " [,driver specific parameters...]\n" 90 " configure a block backend\n" 91 "\n" 92 " --chardev <options> configure a character device backend\n" 93 " (see the qemu(1) man page for possible options)\n" 94 "\n" 95 " --export [type=]nbd,device=<node-name>[,name=<export-name>]\n" 96 " [,writable=on|off][,bitmap=<name>]\n" 97 " export the specified block node over NBD\n" 98 " (requires --nbd-server)\n" 99 "\n" 100 " --monitor [chardev=]name[,mode=control][,pretty[=on|off]]\n" 101 " configure a QMP monitor\n" 102 "\n" 103 " --nbd-server addr.type=inet,addr.host=<host>,addr.port=<port>\n" 104 " [,tls-creds=<id>][,tls-authz=<id>]\n" 105 " --nbd-server addr.type=unix,addr.path=<path>\n" 106 " [,tls-creds=<id>][,tls-authz=<id>]\n" 107 " start an NBD server for exporting block nodes\n" 108 "\n" 109 " --object help list object types that can be added\n" 110 " --object <type>,help list properties for the given object type\n" 111 " --object <type>[,<property>=<value>...]\n" 112 " create a new object of type <type>, setting\n" 113 " properties in the order they are specified. Note\n" 114 " that the 'id' property must be set.\n" 115 " See the qemu(1) man page for documentation of the\n" 116 " objects that can be added.\n" 117 "\n" 118 QEMU_HELP_BOTTOM "\n", 119 error_get_progname()); 120 } 121 122 enum { 123 OPTION_BLOCKDEV = 256, 124 OPTION_CHARDEV, 125 OPTION_EXPORT, 126 OPTION_MONITOR, 127 OPTION_NBD_SERVER, 128 OPTION_OBJECT, 129 }; 130 131 extern QemuOptsList qemu_chardev_opts; 132 133 static QemuOptsList qemu_object_opts = { 134 .name = "object", 135 .implied_opt_name = "qom-type", 136 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head), 137 .desc = { 138 { } 139 }, 140 }; 141 142 static void init_qmp_commands(void) 143 { 144 qmp_init_marshal(&qmp_commands); 145 qmp_register_command(&qmp_commands, "query-qmp-schema", 146 qmp_query_qmp_schema, QCO_ALLOW_PRECONFIG); 147 148 QTAILQ_INIT(&qmp_cap_negotiation_commands); 149 qmp_register_command(&qmp_cap_negotiation_commands, "qmp_capabilities", 150 qmp_marshal_qmp_capabilities, QCO_ALLOW_PRECONFIG); 151 } 152 153 static void init_export(BlockExport *export, Error **errp) 154 { 155 switch (export->type) { 156 case BLOCK_EXPORT_TYPE_NBD: 157 qmp_nbd_server_add(&export->u.nbd, errp); 158 break; 159 default: 160 g_assert_not_reached(); 161 } 162 } 163 164 static void process_options(int argc, char *argv[]) 165 { 166 int c; 167 168 static const struct option long_options[] = { 169 {"blockdev", required_argument, NULL, OPTION_BLOCKDEV}, 170 {"chardev", required_argument, NULL, OPTION_CHARDEV}, 171 {"export", required_argument, NULL, OPTION_EXPORT}, 172 {"help", no_argument, NULL, 'h'}, 173 {"monitor", required_argument, NULL, OPTION_MONITOR}, 174 {"nbd-server", required_argument, NULL, OPTION_NBD_SERVER}, 175 {"object", required_argument, NULL, OPTION_OBJECT}, 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_long(argc, argv, "hT:V", long_options, NULL)) != -1) { 187 switch (c) { 188 case '?': 189 exit(EXIT_FAILURE); 190 case 'h': 191 help(); 192 exit(EXIT_SUCCESS); 193 case 'T': 194 { 195 char *trace_file = trace_opt_parse(optarg); 196 trace_init_file(trace_file); 197 g_free(trace_file); 198 break; 199 } 200 case 'V': 201 printf("qemu-storage-daemon version " 202 QEMU_FULL_VERSION "\n" QEMU_COPYRIGHT "\n"); 203 exit(EXIT_SUCCESS); 204 case OPTION_BLOCKDEV: 205 { 206 Visitor *v; 207 BlockdevOptions *options; 208 209 v = qobject_input_visitor_new_str(optarg, "driver", 210 &error_fatal); 211 212 visit_type_BlockdevOptions(v, NULL, &options, &error_fatal); 213 visit_free(v); 214 215 qmp_blockdev_add(options, &error_fatal); 216 qapi_free_BlockdevOptions(options); 217 break; 218 } 219 case OPTION_CHARDEV: 220 { 221 /* TODO This interface is not stable until we QAPIfy it */ 222 QemuOpts *opts = qemu_opts_parse_noisily(&qemu_chardev_opts, 223 optarg, true); 224 if (opts == NULL) { 225 exit(EXIT_FAILURE); 226 } 227 228 if (!qemu_chr_new_from_opts(opts, NULL, &error_fatal)) { 229 /* No error, but NULL returned means help was printed */ 230 exit(EXIT_SUCCESS); 231 } 232 qemu_opts_del(opts); 233 break; 234 } 235 case OPTION_EXPORT: 236 { 237 Visitor *v; 238 BlockExport *export; 239 240 v = qobject_input_visitor_new_str(optarg, "type", &error_fatal); 241 visit_type_BlockExport(v, NULL, &export, &error_fatal); 242 visit_free(v); 243 244 init_export(export, &error_fatal); 245 qapi_free_BlockExport(export); 246 break; 247 } 248 case OPTION_MONITOR: 249 { 250 Visitor *v; 251 MonitorOptions *monitor; 252 253 v = qobject_input_visitor_new_str(optarg, "chardev", 254 &error_fatal); 255 visit_type_MonitorOptions(v, NULL, &monitor, &error_fatal); 256 visit_free(v); 257 258 /* TODO Catch duplicate monitor IDs */ 259 monitor_init(monitor, false, &error_fatal); 260 qapi_free_MonitorOptions(monitor); 261 break; 262 } 263 case OPTION_NBD_SERVER: 264 { 265 Visitor *v; 266 NbdServerOptions *options; 267 268 v = qobject_input_visitor_new_str(optarg, NULL, &error_fatal); 269 visit_type_NbdServerOptions(v, NULL, &options, &error_fatal); 270 visit_free(v); 271 272 nbd_server_start_options(options, &error_fatal); 273 qapi_free_NbdServerOptions(options); 274 break; 275 } 276 case OPTION_OBJECT: 277 { 278 QemuOpts *opts; 279 const char *type; 280 QDict *args; 281 282 /* FIXME The keyval parser rejects 'help' arguments, so we must 283 * unconditionall try QemuOpts first. */ 284 opts = qemu_opts_parse(&qemu_object_opts, 285 optarg, true, &error_fatal); 286 type = qemu_opt_get(opts, "qom-type"); 287 if (type && user_creatable_print_help(type, opts)) { 288 exit(EXIT_SUCCESS); 289 } 290 qemu_opts_del(opts); 291 292 args = keyval_parse(optarg, "qom-type", &error_fatal); 293 user_creatable_add_dict(args, true, &error_fatal); 294 qobject_unref(args); 295 break; 296 } 297 default: 298 g_assert_not_reached(); 299 } 300 } 301 if (optind != argc) { 302 error_report("Unexpected argument: %s", argv[optind]); 303 exit(EXIT_FAILURE); 304 } 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_object_opts); 320 qemu_add_opts(&qemu_trace_opts); 321 qcrypto_init(&error_fatal); 322 bdrv_init(); 323 monitor_init_globals_core(); 324 init_qmp_commands(); 325 326 if (!trace_init_backends()) { 327 return EXIT_FAILURE; 328 } 329 qemu_set_log(LOG_TRACE); 330 331 qemu_init_main_loop(&error_fatal); 332 process_options(argc, argv); 333 334 while (!exit_requested) { 335 main_loop_wait(false); 336 } 337 338 monitor_cleanup(); 339 qemu_chr_cleanup(); 340 user_creatable_cleanup(); 341 342 return EXIT_SUCCESS; 343 } 344