blob: 13829f5e21ba84e5cce5c39d2228377456eeb9db [file] [log] [blame]
aliguorie3aff4f2009-04-05 19:14:04 +00001/*
2 * Command line utility to exercise the QEMU I/O path.
3 *
4 * Copyright (C) 2009 Red Hat, Inc.
5 * Copyright (c) 2003-2005 Silicon Graphics, Inc.
6 *
7 * This work is licensed under the terms of the GNU GPL, version 2 or later.
8 * See the COPYING file in the top-level directory.
9 */
Markus Armbruster452fcdb2018-02-01 12:18:39 +010010
Peter Maydell80c71a22016-01-18 18:01:42 +000011#include "qemu/osdep.h"
aliguorie3aff4f2009-04-05 19:14:04 +000012#include <getopt.h>
Stefan Weilc32d7662009-08-31 22:16:16 +020013#include <libgen.h>
Daniel P. Berrange0e448a02018-02-12 18:48:49 +000014#ifndef _WIN32
15#include <termios.h>
16#endif
aliguorie3aff4f2009-04-05 19:14:04 +000017
Markus Armbrusterda34e652016-03-14 09:01:28 +010018#include "qapi/error.h"
Kevin Wolf3d219942013-06-05 14:19:39 +020019#include "qemu-io.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010020#include "qemu/error-report.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010021#include "qemu/main-loop.h"
Max Reitzb543c5c2013-10-11 14:02:10 +020022#include "qemu/option.h"
23#include "qemu/config-file.h"
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +010024#include "qemu/readline.h"
Denis V. Luneve9a80852016-06-17 17:44:11 +030025#include "qemu/log.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010026#include "qapi/qmp/qstring.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010027#include "qapi/qmp/qdict.h"
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +000028#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020029#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010030#include "block/block_int.h"
Stefan Hajnoczid7bb72c2012-03-12 16:36:07 +000031#include "trace/control.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010032#include "crypto/init.h"
Eric Blake4face322017-08-03 11:33:51 -050033#include "qemu-version.h"
aliguorie3aff4f2009-04-05 19:14:04 +000034
Devin Nakamura43642b32011-07-11 11:22:16 -040035#define CMD_NOFILE_OK 0x01
aliguorie3aff4f2009-04-05 19:14:04 +000036
Stefan Weilf9883882014-03-05 22:23:00 +010037static char *progname;
aliguorie3aff4f2009-04-05 19:14:04 +000038
Markus Armbruster26f54e92014-10-07 13:59:04 +020039static BlockBackend *qemuio_blk;
Max Reitzb444d0e2018-05-09 21:42:58 +020040static bool quit_qemu_io;
Kevin Wolf191c2892010-09-16 13:18:08 +020041
Kevin Wolfd1174f12013-06-05 14:19:37 +020042/* qemu-io commands passed using -c */
43static int ncmdline;
44static char **cmdline;
Daniel P. Berrange499afa22016-02-17 10:10:18 +000045static bool imageOpts;
Kevin Wolfd1174f12013-06-05 14:19:37 +020046
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +010047static ReadLineState *readline_state;
48
Daniel P. Berrange0e448a02018-02-12 18:48:49 +000049static int ttyEOF;
50
51static int get_eof_char(void)
52{
53#ifdef _WIN32
54 return 0x4; /* Ctrl-D */
55#else
56 struct termios tty;
57 if (tcgetattr(STDIN_FILENO, &tty) != 0) {
58 if (errno == ENOTTY) {
59 return 0x0; /* just expect read() == 0 */
60 } else {
61 return 0x4; /* Ctrl-D */
62 }
63 }
64
65 return tty.c_cc[VEOF];
66#endif
67}
68
Max Reitzb32d7a32018-05-09 21:42:59 +020069static int close_f(BlockBackend *blk, int argc, char **argv)
aliguorie3aff4f2009-04-05 19:14:04 +000070{
Markus Armbruster26f54e92014-10-07 13:59:04 +020071 blk_unref(qemuio_blk);
Markus Armbruster26f54e92014-10-07 13:59:04 +020072 qemuio_blk = NULL;
Max Reitzb32d7a32018-05-09 21:42:59 +020073 return 0;
aliguorie3aff4f2009-04-05 19:14:04 +000074}
75
76static const cmdinfo_t close_cmd = {
Devin Nakamura43642b32011-07-11 11:22:16 -040077 .name = "close",
78 .altname = "c",
79 .cfunc = close_f,
80 .oneline = "close the current open file",
aliguorie3aff4f2009-04-05 19:14:04 +000081};
82
Fam Zheng459571f2017-05-03 00:35:41 +080083static int openfile(char *name, int flags, bool writethrough, bool force_share,
84 QDict *opts)
aliguorie3aff4f2009-04-05 19:14:04 +000085{
Max Reitz34b5d2c2013-09-05 14:45:29 +020086 Error *local_err = NULL;
87
Max Reitz1b58b432015-02-05 13:58:20 -050088 if (qemuio_blk) {
Markus Armbrusterb9884682015-12-18 16:35:18 +010089 error_report("file open already, try 'help close'");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +020090 qobject_unref(opts);
Devin Nakamura43642b32011-07-11 11:22:16 -040091 return 1;
92 }
aliguorie3aff4f2009-04-05 19:14:04 +000093
Fam Zheng459571f2017-05-03 00:35:41 +080094 if (force_share) {
95 if (!opts) {
96 opts = qdict_new();
97 }
98 if (qdict_haskey(opts, BDRV_OPT_FORCE_SHARE)
Max Reitz2a01c012018-05-02 22:20:49 +020099 && strcmp(qdict_get_str(opts, BDRV_OPT_FORCE_SHARE), "on")) {
Fam Zheng459571f2017-05-03 00:35:41 +0800100 error_report("-U conflicts with image options");
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200101 qobject_unref(opts);
Fam Zheng459571f2017-05-03 00:35:41 +0800102 return 1;
103 }
Max Reitz2a01c012018-05-02 22:20:49 +0200104 qdict_put_str(opts, BDRV_OPT_FORCE_SHARE, "on");
Fam Zheng459571f2017-05-03 00:35:41 +0800105 }
Max Reitzefaa7c42016-03-16 19:54:38 +0100106 qemuio_blk = blk_new_open(name, NULL, opts, flags, &local_err);
Max Reitz1b58b432015-02-05 13:58:20 -0500107 if (!qemuio_blk) {
Markus Armbrusterb9884682015-12-18 16:35:18 +0100108 error_reportf_err(local_err, "can't open%s%s: ",
109 name ? " device " : "", name ?: "");
Markus Armbrusterdbb651c2014-09-08 18:50:58 +0200110 return 1;
Devin Nakamura43642b32011-07-11 11:22:16 -0400111 }
Christoph Hellwig1db69472009-07-15 23:11:21 +0200112
Kevin Wolfe151fc12016-03-15 12:52:30 +0100113 blk_set_enable_write_cache(qemuio_blk, !writethrough);
Daniel P. Berrange8caf0212015-05-12 17:09:21 +0100114
Devin Nakamura43642b32011-07-11 11:22:16 -0400115 return 0;
aliguorie3aff4f2009-04-05 19:14:04 +0000116}
117
Devin Nakamura43642b32011-07-11 11:22:16 -0400118static void open_help(void)
aliguorie3aff4f2009-04-05 19:14:04 +0000119{
Devin Nakamura43642b32011-07-11 11:22:16 -0400120 printf(
aliguorie3aff4f2009-04-05 19:14:04 +0000121"\n"
122" opens a new file in the requested mode\n"
123"\n"
124" Example:\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600125" 'open -n -o driver=raw /tmp/data' - opens raw data file read-write, uncached\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000126"\n"
127" Opens a file for subsequent use by all of the other qemu-io commands.\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000128" -r, -- open file read-only\n"
129" -s, -- use snapshot file\n"
Eric Blake0f404442017-10-05 14:02:43 -0500130" -C, -- use copy-on-read\n"
Eric Blakeb8d970f2016-05-07 21:16:41 -0600131" -n, -- disable host cache, short for -t none\n"
Fam Zheng459571f2017-05-03 00:35:41 +0800132" -U, -- force shared permissions\n"
Eric Blakeb8d970f2016-05-07 21:16:41 -0600133" -k, -- use kernel AIO implementation (on Linux only)\n"
134" -t, -- use the given cache mode for the image\n"
135" -d, -- use the given discard mode for the image\n"
Max Reitzb543c5c2013-10-11 14:02:10 +0200136" -o, -- options to be given to the block driver"
aliguorie3aff4f2009-04-05 19:14:04 +0000137"\n");
138}
139
Max Reitzb32d7a32018-05-09 21:42:59 +0200140static int open_f(BlockBackend *blk, int argc, char **argv);
Blue Swirl22a2bdc2009-11-21 09:06:46 +0000141
142static const cmdinfo_t open_cmd = {
Devin Nakamura43642b32011-07-11 11:22:16 -0400143 .name = "open",
144 .altname = "o",
145 .cfunc = open_f,
146 .argmin = 1,
147 .argmax = -1,
148 .flags = CMD_NOFILE_OK,
Eric Blake0f404442017-10-05 14:02:43 -0500149 .args = "[-rsCnkU] [-t cache] [-d discard] [-o options] [path]",
Devin Nakamura43642b32011-07-11 11:22:16 -0400150 .oneline = "open the file specified by path",
151 .help = open_help,
Blue Swirl22a2bdc2009-11-21 09:06:46 +0000152};
aliguorie3aff4f2009-04-05 19:14:04 +0000153
Max Reitzb543c5c2013-10-11 14:02:10 +0200154static QemuOptsList empty_opts = {
155 .name = "drive",
Markus Armbruster443422f2014-05-28 11:16:58 +0200156 .merge_lists = true,
Max Reitzb543c5c2013-10-11 14:02:10 +0200157 .head = QTAILQ_HEAD_INITIALIZER(empty_opts.head),
158 .desc = {
159 /* no elements => accept any params */
160 { /* end of list */ }
161 },
162};
163
Max Reitzb32d7a32018-05-09 21:42:59 +0200164static int open_f(BlockBackend *blk, int argc, char **argv)
aliguorie3aff4f2009-04-05 19:14:04 +0000165{
Eric Blakeb8d970f2016-05-07 21:16:41 -0600166 int flags = BDRV_O_UNMAP;
Devin Nakamura43642b32011-07-11 11:22:16 -0400167 int readonly = 0;
Kevin Wolfe151fc12016-03-15 12:52:30 +0100168 bool writethrough = true;
Devin Nakamura43642b32011-07-11 11:22:16 -0400169 int c;
Max Reitzb32d7a32018-05-09 21:42:59 +0200170 int ret;
Max Reitzb543c5c2013-10-11 14:02:10 +0200171 QemuOpts *qopts;
Markus Armbruster443422f2014-05-28 11:16:58 +0200172 QDict *opts;
Fam Zheng459571f2017-05-03 00:35:41 +0800173 bool force_share = false;
aliguorie3aff4f2009-04-05 19:14:04 +0000174
Eric Blake0f404442017-10-05 14:02:43 -0500175 while ((c = getopt(argc, argv, "snCro:kt:d:U")) != -1) {
Devin Nakamura43642b32011-07-11 11:22:16 -0400176 switch (c) {
177 case 's':
178 flags |= BDRV_O_SNAPSHOT;
179 break;
180 case 'n':
Kevin Wolfe151fc12016-03-15 12:52:30 +0100181 flags |= BDRV_O_NOCACHE;
182 writethrough = false;
Devin Nakamura43642b32011-07-11 11:22:16 -0400183 break;
Eric Blake0f404442017-10-05 14:02:43 -0500184 case 'C':
185 flags |= BDRV_O_COPY_ON_READ;
186 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400187 case 'r':
188 readonly = 1;
189 break;
Eric Blakeb8d970f2016-05-07 21:16:41 -0600190 case 'k':
191 flags |= BDRV_O_NATIVE_AIO;
192 break;
193 case 't':
194 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
195 error_report("Invalid cache option: %s", optarg);
196 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200197 return -EINVAL;
Eric Blakeb8d970f2016-05-07 21:16:41 -0600198 }
199 break;
200 case 'd':
201 if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
202 error_report("Invalid discard option: %s", optarg);
203 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200204 return -EINVAL;
Eric Blakeb8d970f2016-05-07 21:16:41 -0600205 }
206 break;
Max Reitzb543c5c2013-10-11 14:02:10 +0200207 case 'o':
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000208 if (imageOpts) {
209 printf("--image-opts and 'open -o' are mutually exclusive\n");
Eric Blakeb8d970f2016-05-07 21:16:41 -0600210 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200211 return -EINVAL;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000212 }
Markus Armbruster70b94332015-02-13 12:50:26 +0100213 if (!qemu_opts_parse_noisily(&empty_opts, optarg, false)) {
Markus Armbruster443422f2014-05-28 11:16:58 +0200214 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200215 return -EINVAL;
Max Reitzb543c5c2013-10-11 14:02:10 +0200216 }
Max Reitzb543c5c2013-10-11 14:02:10 +0200217 break;
Fam Zheng459571f2017-05-03 00:35:41 +0800218 case 'U':
219 force_share = true;
220 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400221 default:
Markus Armbruster443422f2014-05-28 11:16:58 +0200222 qemu_opts_reset(&empty_opts);
Max Reitzb444d0e2018-05-09 21:42:58 +0200223 qemuio_command_usage(&open_cmd);
Max Reitzb32d7a32018-05-09 21:42:59 +0200224 return -EINVAL;
Naphtali Spreif5edb012010-01-17 16:48:13 +0200225 }
Devin Nakamura43642b32011-07-11 11:22:16 -0400226 }
aliguorie3aff4f2009-04-05 19:14:04 +0000227
Devin Nakamura43642b32011-07-11 11:22:16 -0400228 if (!readonly) {
229 flags |= BDRV_O_RDWR;
230 }
aliguorie3aff4f2009-04-05 19:14:04 +0000231
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000232 if (imageOpts && (optind == argc - 1)) {
233 if (!qemu_opts_parse_noisily(&empty_opts, argv[optind], false)) {
234 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200235 return -EINVAL;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000236 }
237 optind++;
238 }
239
Markus Armbruster443422f2014-05-28 11:16:58 +0200240 qopts = qemu_opts_find(&empty_opts, NULL);
241 opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
242 qemu_opts_reset(&empty_opts);
243
Max Reitzfd0fee32013-12-20 19:28:20 +0100244 if (optind == argc - 1) {
Max Reitzb32d7a32018-05-09 21:42:59 +0200245 ret = openfile(argv[optind], flags, writethrough, force_share, opts);
Max Reitzfd0fee32013-12-20 19:28:20 +0100246 } else if (optind == argc) {
Max Reitzb32d7a32018-05-09 21:42:59 +0200247 ret = openfile(NULL, flags, writethrough, force_share, opts);
Max Reitzfd0fee32013-12-20 19:28:20 +0100248 } else {
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200249 qobject_unref(opts);
Eric Blake64ebf552017-06-05 15:38:42 -0500250 qemuio_command_usage(&open_cmd);
Max Reitzb32d7a32018-05-09 21:42:59 +0200251 return -EINVAL;
Devin Nakamura43642b32011-07-11 11:22:16 -0400252 }
Max Reitzb32d7a32018-05-09 21:42:59 +0200253
254 if (ret) {
255 return -EINVAL;
256 }
257
258 return 0;
aliguorie3aff4f2009-04-05 19:14:04 +0000259}
260
Max Reitzb32d7a32018-05-09 21:42:59 +0200261static int quit_f(BlockBackend *blk, int argc, char **argv)
Kevin Wolfe681be72013-06-05 14:19:34 +0200262{
Max Reitzb444d0e2018-05-09 21:42:58 +0200263 quit_qemu_io = true;
Max Reitzb32d7a32018-05-09 21:42:59 +0200264 return 0;
Kevin Wolfe681be72013-06-05 14:19:34 +0200265}
266
267static const cmdinfo_t quit_cmd = {
268 .name = "quit",
269 .altname = "q",
270 .cfunc = quit_f,
271 .argmin = -1,
272 .argmax = -1,
273 .flags = CMD_FLAG_GLOBAL,
274 .oneline = "exit the program",
275};
276
aliguorie3aff4f2009-04-05 19:14:04 +0000277static void usage(const char *name)
278{
Devin Nakamura43642b32011-07-11 11:22:16 -0400279 printf(
Eric Blakee4e12bb2016-05-07 21:16:40 -0600280"Usage: %s [OPTIONS]... [-c STRING]... [file]\n"
Stefan Weil84844a22009-06-22 15:08:47 +0200281"QEMU Disk exerciser\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000282"\n"
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000283" --object OBJECTDEF define an object such as 'secret' for\n"
284" passwords and/or encryption keys\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600285" --image-opts treat file as option string\n"
Maria Kustovad208cc32014-03-18 09:59:19 +0400286" -c, --cmd STRING execute command with its arguments\n"
287" from the given string\n"
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100288" -f, --format FMT specifies the block driver to use\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000289" -r, --read-only export read-only\n"
290" -s, --snapshot use snapshot file\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600291" -n, --nocache disable host cache, short for -t none\n"
Eric Blake0f404442017-10-05 14:02:43 -0500292" -C, --copy-on-read enable copy-on-read\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000293" -m, --misalign misalign allocations for O_DIRECT\n"
Christoph Hellwig5c6c3a62009-08-20 16:58:35 +0200294" -k, --native-aio use kernel AIO implementation (on Linux only)\n"
Kevin Wolf592fa072012-04-18 12:07:39 +0200295" -t, --cache=MODE use the given cache mode for the image\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600296" -d, --discard=MODE use the given discard mode for the image\n"
Denis V. Luneve9a80852016-06-17 17:44:11 +0300297" -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
298" specify tracing options\n"
299" see qemu-img(1) man page for full description\n"
Fam Zheng459571f2017-05-03 00:35:41 +0800300" -U, --force-share force shared permissions\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000301" -h, --help display this help and exit\n"
302" -V, --version output version information and exit\n"
Maria Kustovad208cc32014-03-18 09:59:19 +0400303"\n"
Eric Blakef5048cb2017-08-03 11:33:53 -0500304"See '%s -c help' for information on available commands.\n"
305"\n"
306QEMU_HELP_BOTTOM "\n",
Maria Kustovad208cc32014-03-18 09:59:19 +0400307 name, name);
aliguorie3aff4f2009-04-05 19:14:04 +0000308}
309
Kevin Wolfd1174f12013-06-05 14:19:37 +0200310static char *get_prompt(void)
311{
312 static char prompt[FILENAME_MAX + 2 /*"> "*/ + 1 /*"\0"*/ ];
313
314 if (!prompt[0]) {
315 snprintf(prompt, sizeof(prompt), "%s> ", progname);
316 }
317
318 return prompt;
319}
320
Stefan Weild5d15072014-01-25 18:18:23 +0100321static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque,
322 const char *fmt, ...)
Kevin Wolfd1174f12013-06-05 14:19:37 +0200323{
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100324 va_list ap;
325 va_start(ap, fmt);
326 vprintf(fmt, ap);
327 va_end(ap);
328}
329
330static void readline_flush_func(void *opaque)
331{
332 fflush(stdout);
333}
334
335static void readline_func(void *opaque, const char *str, void *readline_opaque)
336{
337 char **line = readline_opaque;
338 *line = g_strdup(str);
339}
340
Stefan Hajnoczi46940202013-11-14 11:54:18 +0100341static void completion_match(const char *cmd, void *opaque)
342{
343 readline_add_completion(readline_state, cmd);
344}
345
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100346static void readline_completion_func(void *opaque, const char *str)
347{
Stefan Hajnoczi46940202013-11-14 11:54:18 +0100348 readline_set_completion_index(readline_state, strlen(str));
349 qemuio_complete_command(str, completion_match, NULL);
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100350}
351
352static char *fetchline_readline(void)
353{
354 char *line = NULL;
355
356 readline_start(readline_state, get_prompt(), 0, readline_func, &line);
357 while (!line) {
358 int ch = getchar();
Daniel P. Berrange0e448a02018-02-12 18:48:49 +0000359 if (ttyEOF != 0x0 && ch == ttyEOF) {
360 printf("\n");
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100361 break;
362 }
363 readline_handle_byte(readline_state, ch);
Kevin Wolfd1174f12013-06-05 14:19:37 +0200364 }
365 return line;
366}
Kevin Wolfd1174f12013-06-05 14:19:37 +0200367
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100368#define MAXREADLINESZ 1024
369static char *fetchline_fgets(void)
Kevin Wolfd1174f12013-06-05 14:19:37 +0200370{
371 char *p, *line = g_malloc(MAXREADLINESZ);
372
373 if (!fgets(line, MAXREADLINESZ, stdin)) {
374 g_free(line);
375 return NULL;
376 }
377
378 p = line + strlen(line);
379 if (p != line && p[-1] == '\n') {
380 p[-1] = '\0';
381 }
382
383 return line;
384}
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100385
386static char *fetchline(void)
387{
388 if (readline_state) {
389 return fetchline_readline();
390 } else {
391 return fetchline_fgets();
392 }
393}
Kevin Wolfd1174f12013-06-05 14:19:37 +0200394
395static void prep_fetchline(void *opaque)
396{
397 int *fetchable = opaque;
398
399 qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
400 *fetchable= 1;
401}
402
Max Reitz6b3aa842018-05-09 21:43:00 +0200403static int command_loop(void)
Kevin Wolfd1174f12013-06-05 14:19:37 +0200404{
Max Reitzb444d0e2018-05-09 21:42:58 +0200405 int i, fetchable = 0, prompted = 0;
Max Reitz6b3aa842018-05-09 21:43:00 +0200406 int ret, last_error = 0;
Kevin Wolfd1174f12013-06-05 14:19:37 +0200407 char *input;
408
Max Reitzb444d0e2018-05-09 21:42:58 +0200409 for (i = 0; !quit_qemu_io && i < ncmdline; i++) {
Max Reitz6b3aa842018-05-09 21:43:00 +0200410 ret = qemuio_command(qemuio_blk, cmdline[i]);
411 if (ret < 0) {
412 last_error = ret;
413 }
Kevin Wolfd1174f12013-06-05 14:19:37 +0200414 }
415 if (cmdline) {
416 g_free(cmdline);
Max Reitz6b3aa842018-05-09 21:43:00 +0200417 return last_error;
Kevin Wolfd1174f12013-06-05 14:19:37 +0200418 }
419
Max Reitzb444d0e2018-05-09 21:42:58 +0200420 while (!quit_qemu_io) {
Kevin Wolfd1174f12013-06-05 14:19:37 +0200421 if (!prompted) {
422 printf("%s", get_prompt());
423 fflush(stdout);
424 qemu_set_fd_handler(STDIN_FILENO, prep_fetchline, NULL, &fetchable);
425 prompted = 1;
426 }
427
428 main_loop_wait(false);
429
430 if (!fetchable) {
431 continue;
432 }
433
434 input = fetchline();
435 if (input == NULL) {
436 break;
437 }
Max Reitz6b3aa842018-05-09 21:43:00 +0200438 ret = qemuio_command(qemuio_blk, input);
Kevin Wolfd1174f12013-06-05 14:19:37 +0200439 g_free(input);
440
Max Reitz6b3aa842018-05-09 21:43:00 +0200441 if (ret < 0) {
442 last_error = ret;
443 }
444
Kevin Wolfd1174f12013-06-05 14:19:37 +0200445 prompted = 0;
446 fetchable = 0;
447 }
448 qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
Max Reitz6b3aa842018-05-09 21:43:00 +0200449
450 return last_error;
Kevin Wolfd1174f12013-06-05 14:19:37 +0200451}
452
453static void add_user_command(char *optarg)
454{
Markus Armbruster5839e532014-08-19 10:31:08 +0200455 cmdline = g_renew(char *, cmdline, ++ncmdline);
Kevin Wolfd1174f12013-06-05 14:19:37 +0200456 cmdline[ncmdline-1] = optarg;
457}
458
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100459static void reenable_tty_echo(void)
460{
461 qemu_set_tty_echo(STDIN_FILENO, true);
462}
463
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000464enum {
465 OPTION_OBJECT = 256,
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000466 OPTION_IMAGE_OPTS = 257,
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000467};
468
469static QemuOptsList qemu_object_opts = {
470 .name = "object",
471 .implied_opt_name = "qom-type",
472 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
473 .desc = {
474 { }
475 },
476};
477
478
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000479static QemuOptsList file_opts = {
480 .name = "file",
481 .implied_opt_name = "file",
482 .head = QTAILQ_HEAD_INITIALIZER(file_opts.head),
483 .desc = {
484 /* no elements => accept any params */
485 { /* end of list */ }
486 },
487};
488
aliguorie3aff4f2009-04-05 19:14:04 +0000489int main(int argc, char **argv)
490{
Devin Nakamura43642b32011-07-11 11:22:16 -0400491 int readonly = 0;
Eric Blake0f404442017-10-05 14:02:43 -0500492 const char *sopt = "hVc:d:f:rsnCmkt:T:U";
Devin Nakamura43642b32011-07-11 11:22:16 -0400493 const struct option lopt[] = {
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000494 { "help", no_argument, NULL, 'h' },
495 { "version", no_argument, NULL, 'V' },
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000496 { "cmd", required_argument, NULL, 'c' },
497 { "format", required_argument, NULL, 'f' },
498 { "read-only", no_argument, NULL, 'r' },
499 { "snapshot", no_argument, NULL, 's' },
500 { "nocache", no_argument, NULL, 'n' },
Eric Blake0f404442017-10-05 14:02:43 -0500501 { "copy-on-read", no_argument, NULL, 'C' },
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000502 { "misalign", no_argument, NULL, 'm' },
503 { "native-aio", no_argument, NULL, 'k' },
504 { "discard", required_argument, NULL, 'd' },
505 { "cache", required_argument, NULL, 't' },
506 { "trace", required_argument, NULL, 'T' },
507 { "object", required_argument, NULL, OPTION_OBJECT },
508 { "image-opts", no_argument, NULL, OPTION_IMAGE_OPTS },
Fam Zheng459571f2017-05-03 00:35:41 +0800509 { "force-share", no_argument, 0, 'U'},
Devin Nakamura43642b32011-07-11 11:22:16 -0400510 { NULL, 0, NULL, 0 }
511 };
512 int c;
513 int opt_index = 0;
Paolo Bonzini9e8f1832013-02-08 14:06:11 +0100514 int flags = BDRV_O_UNMAP;
Max Reitz6b3aa842018-05-09 21:43:00 +0200515 int ret;
Kevin Wolfe151fc12016-03-15 12:52:30 +0100516 bool writethrough = true;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300517 Error *local_error = NULL;
Max Reitz1b58b432015-02-05 13:58:20 -0500518 QDict *opts = NULL;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000519 const char *format = NULL;
Denis V. Luneve9a80852016-06-17 17:44:11 +0300520 char *trace_file = NULL;
Fam Zheng459571f2017-05-03 00:35:41 +0800521 bool force_share = false;
aliguorie3aff4f2009-04-05 19:14:04 +0000522
MORITA Kazutaka526eda12013-07-23 17:30:11 +0900523#ifdef CONFIG_POSIX
524 signal(SIGPIPE, SIG_IGN);
525#endif
526
Daniel P. Berrangefe4db842016-10-04 14:35:52 +0100527 module_call_init(MODULE_INIT_TRACE);
Julia Suvorova3e015d82018-03-01 10:08:06 +0300528 progname = g_path_get_basename(argv[0]);
Fam Zheng10f5bff2014-02-10 14:48:51 +0800529 qemu_init_exec_dir(argv[0]);
aliguorie3aff4f2009-04-05 19:14:04 +0000530
Eduardo Habkoste8f2d272016-05-12 11:10:04 -0300531 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +0100532
Daniel P. Berrange064097d2016-02-10 18:41:01 +0000533 module_call_init(MODULE_INIT_QOM);
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000534 qemu_add_opts(&qemu_object_opts);
Denis V. Luneve9a80852016-06-17 17:44:11 +0300535 qemu_add_opts(&qemu_trace_opts);
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100536 bdrv_init();
537
Devin Nakamura43642b32011-07-11 11:22:16 -0400538 while ((c = getopt_long(argc, argv, sopt, lopt, &opt_index)) != -1) {
539 switch (c) {
540 case 's':
541 flags |= BDRV_O_SNAPSHOT;
542 break;
543 case 'n':
Kevin Wolfe151fc12016-03-15 12:52:30 +0100544 flags |= BDRV_O_NOCACHE;
545 writethrough = false;
Devin Nakamura43642b32011-07-11 11:22:16 -0400546 break;
Eric Blake0f404442017-10-05 14:02:43 -0500547 case 'C':
548 flags |= BDRV_O_COPY_ON_READ;
549 break;
Paolo Bonzini9e8f1832013-02-08 14:06:11 +0100550 case 'd':
551 if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
552 error_report("Invalid discard option: %s", optarg);
553 exit(1);
554 }
555 break;
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100556 case 'f':
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000557 format = optarg;
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100558 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400559 case 'c':
560 add_user_command(optarg);
561 break;
562 case 'r':
563 readonly = 1;
564 break;
565 case 'm':
Stefan Weilf9883882014-03-05 22:23:00 +0100566 qemuio_misalign = true;
Devin Nakamura43642b32011-07-11 11:22:16 -0400567 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400568 case 'k':
569 flags |= BDRV_O_NATIVE_AIO;
570 break;
Kevin Wolf592fa072012-04-18 12:07:39 +0200571 case 't':
Kevin Wolfe151fc12016-03-15 12:52:30 +0100572 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
Kevin Wolf592fa072012-04-18 12:07:39 +0200573 error_report("Invalid cache option: %s", optarg);
574 exit(1);
575 }
576 break;
Stefan Hajnoczid7bb72c2012-03-12 16:36:07 +0000577 case 'T':
Denis V. Luneve9a80852016-06-17 17:44:11 +0300578 g_free(trace_file);
579 trace_file = trace_opt_parse(optarg);
Stefan Hajnoczid7bb72c2012-03-12 16:36:07 +0000580 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400581 case 'V':
Thomas Huth7e563bf2018-02-15 12:06:47 +0100582 printf("%s version " QEMU_FULL_VERSION "\n"
Eric Blake4face322017-08-03 11:33:51 -0500583 QEMU_COPYRIGHT "\n", progname);
Devin Nakamura43642b32011-07-11 11:22:16 -0400584 exit(0);
585 case 'h':
586 usage(progname);
587 exit(0);
Fam Zheng459571f2017-05-03 00:35:41 +0800588 case 'U':
589 force_share = true;
590 break;
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000591 case OPTION_OBJECT: {
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000592 QemuOpts *qopts;
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000593 qopts = qemu_opts_parse_noisily(&qemu_object_opts,
594 optarg, true);
595 if (!qopts) {
596 exit(1);
597 }
598 } break;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000599 case OPTION_IMAGE_OPTS:
600 imageOpts = true;
601 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400602 default:
603 usage(progname);
604 exit(1);
Naphtali Spreif5edb012010-01-17 16:48:13 +0200605 }
Devin Nakamura43642b32011-07-11 11:22:16 -0400606 }
aliguorie3aff4f2009-04-05 19:14:04 +0000607
Devin Nakamura43642b32011-07-11 11:22:16 -0400608 if ((argc - optind) > 1) {
609 usage(progname);
610 exit(1);
611 }
aliguorie3aff4f2009-04-05 19:14:04 +0000612
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000613 if (format && imageOpts) {
614 error_report("--image-opts and -f are mutually exclusive");
615 exit(1);
616 }
617
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300618 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +0100619 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300620 exit(1);
621 }
Zhi Yong Wua57d1142012-02-19 22:24:59 +0800622
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000623 if (qemu_opts_foreach(&qemu_object_opts,
624 user_creatable_add_opts_foreach,
Markus Armbruster51b9b472016-04-27 16:29:09 +0200625 NULL, NULL)) {
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000626 exit(1);
627 }
628
Denis V. Luneve9a80852016-06-17 17:44:11 +0300629 if (!trace_init_backends()) {
630 exit(1);
631 }
632 trace_init_file(trace_file);
633 qemu_set_log(LOG_TRACE);
634
Devin Nakamura43642b32011-07-11 11:22:16 -0400635 /* initialize commands */
Kevin Wolfc2cdf5c2013-06-05 14:19:36 +0200636 qemuio_add_command(&quit_cmd);
637 qemuio_add_command(&open_cmd);
638 qemuio_add_command(&close_cmd);
Devin Nakamura43642b32011-07-11 11:22:16 -0400639
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100640 if (isatty(STDIN_FILENO)) {
Daniel P. Berrange0e448a02018-02-12 18:48:49 +0000641 ttyEOF = get_eof_char();
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100642 readline_state = readline_init(readline_printf_func,
643 readline_flush_func,
644 NULL,
645 readline_completion_func);
646 qemu_set_tty_echo(STDIN_FILENO, false);
647 atexit(reenable_tty_echo);
648 }
649
Devin Nakamura43642b32011-07-11 11:22:16 -0400650 /* open the device */
651 if (!readonly) {
652 flags |= BDRV_O_RDWR;
653 }
654
655 if ((argc - optind) == 1) {
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000656 if (imageOpts) {
657 QemuOpts *qopts = NULL;
658 qopts = qemu_opts_parse_noisily(&file_opts, argv[optind], false);
659 if (!qopts) {
660 exit(1);
661 }
662 opts = qemu_opts_to_qdict(qopts, NULL);
Fam Zheng459571f2017-05-03 00:35:41 +0800663 if (openfile(NULL, flags, writethrough, force_share, opts)) {
Nir Sofferb7aa1312017-02-01 02:31:18 +0200664 exit(1);
665 }
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000666 } else {
667 if (format) {
668 opts = qdict_new();
Eric Blake46f5ac22017-04-27 16:58:17 -0500669 qdict_put_str(opts, "driver", format);
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000670 }
Fam Zheng459571f2017-05-03 00:35:41 +0800671 if (openfile(argv[optind], flags, writethrough,
672 force_share, opts)) {
Nir Sofferb7aa1312017-02-01 02:31:18 +0200673 exit(1);
674 }
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000675 }
Devin Nakamura43642b32011-07-11 11:22:16 -0400676 }
Max Reitz6b3aa842018-05-09 21:43:00 +0200677 ret = command_loop();
Devin Nakamura43642b32011-07-11 11:22:16 -0400678
679 /*
Stefan Hajnoczi922453b2011-11-30 12:23:43 +0000680 * Make sure all outstanding requests complete before the program exits.
Devin Nakamura43642b32011-07-11 11:22:16 -0400681 */
Stefan Hajnoczi922453b2011-11-30 12:23:43 +0000682 bdrv_drain_all();
Devin Nakamura43642b32011-07-11 11:22:16 -0400683
Markus Armbruster26f54e92014-10-07 13:59:04 +0200684 blk_unref(qemuio_blk);
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100685 g_free(readline_state);
Max Reitz6b3aa842018-05-09 21:43:00 +0200686
687 if (ret < 0) {
688 return 1;
689 } else {
690 return 0;
691 }
aliguorie3aff4f2009-04-05 19:14:04 +0000692}