blob: 3adc5a7d0d3f77073f4a95684fcec58ad015a289 [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 Armbrustera8d25322019-05-23 16:35:08 +020018#include "qemu-common.h"
Markus Armbrusterda34e652016-03-14 09:01:28 +010019#include "qapi/error.h"
Kevin Wolf3d219942013-06-05 14:19:39 +020020#include "qemu-io.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010021#include "qemu/error-report.h"
Paolo Bonzini1de7afc2012-12-17 18:20:00 +010022#include "qemu/main-loop.h"
Markus Armbruster0b8fa322019-05-23 16:35:07 +020023#include "qemu/module.h"
Max Reitzb543c5c2013-10-11 14:02:10 +020024#include "qemu/option.h"
25#include "qemu/config-file.h"
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +010026#include "qemu/readline.h"
Denis V. Luneve9a80852016-06-17 17:44:11 +030027#include "qemu/log.h"
Markus Armbrusterd49b6832015-03-17 18:29:20 +010028#include "qapi/qmp/qstring.h"
Markus Armbruster452fcdb2018-02-01 12:18:39 +010029#include "qapi/qmp/qdict.h"
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +000030#include "qom/object_interfaces.h"
Markus Armbruster26f54e92014-10-07 13:59:04 +020031#include "sysemu/block-backend.h"
Paolo Bonzini737e1502012-12-17 18:19:44 +010032#include "block/block_int.h"
Stefan Hajnoczid7bb72c2012-03-12 16:36:07 +000033#include "trace/control.h"
Daniel P. Berrangec2297082016-04-06 12:12:06 +010034#include "crypto/init.h"
Eric Blake4face322017-08-03 11:33:51 -050035#include "qemu-version.h"
aliguorie3aff4f2009-04-05 19:14:04 +000036
Devin Nakamura43642b32011-07-11 11:22:16 -040037#define CMD_NOFILE_OK 0x01
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"
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000133" -k, -- use kernel AIO implementation (Linux only, prefer use of -i)\n"
134" -i, -- use AIO mode (threads, native or io_uring)\n"
Eric Blakeb8d970f2016-05-07 21:16:41 -0600135" -t, -- use the given cache mode for the image\n"
136" -d, -- use the given discard mode for the image\n"
Max Reitzb543c5c2013-10-11 14:02:10 +0200137" -o, -- options to be given to the block driver"
aliguorie3aff4f2009-04-05 19:14:04 +0000138"\n");
139}
140
Max Reitzb32d7a32018-05-09 21:42:59 +0200141static int open_f(BlockBackend *blk, int argc, char **argv);
Blue Swirl22a2bdc2009-11-21 09:06:46 +0000142
143static const cmdinfo_t open_cmd = {
Devin Nakamura43642b32011-07-11 11:22:16 -0400144 .name = "open",
145 .altname = "o",
146 .cfunc = open_f,
147 .argmin = 1,
148 .argmax = -1,
149 .flags = CMD_NOFILE_OK,
Eric Blake0f404442017-10-05 14:02:43 -0500150 .args = "[-rsCnkU] [-t cache] [-d discard] [-o options] [path]",
Devin Nakamura43642b32011-07-11 11:22:16 -0400151 .oneline = "open the file specified by path",
152 .help = open_help,
Blue Swirl22a2bdc2009-11-21 09:06:46 +0000153};
aliguorie3aff4f2009-04-05 19:14:04 +0000154
Max Reitzb543c5c2013-10-11 14:02:10 +0200155static QemuOptsList empty_opts = {
156 .name = "drive",
Markus Armbruster443422f2014-05-28 11:16:58 +0200157 .merge_lists = true,
Max Reitzb543c5c2013-10-11 14:02:10 +0200158 .head = QTAILQ_HEAD_INITIALIZER(empty_opts.head),
159 .desc = {
160 /* no elements => accept any params */
161 { /* end of list */ }
162 },
163};
164
Max Reitzb32d7a32018-05-09 21:42:59 +0200165static int open_f(BlockBackend *blk, int argc, char **argv)
aliguorie3aff4f2009-04-05 19:14:04 +0000166{
Eric Blakeb8d970f2016-05-07 21:16:41 -0600167 int flags = BDRV_O_UNMAP;
Devin Nakamura43642b32011-07-11 11:22:16 -0400168 int readonly = 0;
Kevin Wolfe151fc12016-03-15 12:52:30 +0100169 bool writethrough = true;
Devin Nakamura43642b32011-07-11 11:22:16 -0400170 int c;
Max Reitzb32d7a32018-05-09 21:42:59 +0200171 int ret;
Max Reitzb543c5c2013-10-11 14:02:10 +0200172 QemuOpts *qopts;
Markus Armbruster443422f2014-05-28 11:16:58 +0200173 QDict *opts;
Fam Zheng459571f2017-05-03 00:35:41 +0800174 bool force_share = false;
aliguorie3aff4f2009-04-05 19:14:04 +0000175
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000176 while ((c = getopt(argc, argv, "snCro:ki:t:d:U")) != -1) {
Devin Nakamura43642b32011-07-11 11:22:16 -0400177 switch (c) {
178 case 's':
179 flags |= BDRV_O_SNAPSHOT;
180 break;
181 case 'n':
Kevin Wolfe151fc12016-03-15 12:52:30 +0100182 flags |= BDRV_O_NOCACHE;
183 writethrough = false;
Devin Nakamura43642b32011-07-11 11:22:16 -0400184 break;
Eric Blake0f404442017-10-05 14:02:43 -0500185 case 'C':
186 flags |= BDRV_O_COPY_ON_READ;
187 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400188 case 'r':
189 readonly = 1;
190 break;
Eric Blakeb8d970f2016-05-07 21:16:41 -0600191 case 'k':
192 flags |= BDRV_O_NATIVE_AIO;
193 break;
194 case 't':
195 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
196 error_report("Invalid cache option: %s", optarg);
197 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200198 return -EINVAL;
Eric Blakeb8d970f2016-05-07 21:16:41 -0600199 }
200 break;
201 case 'd':
202 if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
203 error_report("Invalid discard option: %s", optarg);
204 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200205 return -EINVAL;
Eric Blakeb8d970f2016-05-07 21:16:41 -0600206 }
207 break;
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000208 case 'i':
209 if (bdrv_parse_aio(optarg, &flags) < 0) {
210 error_report("Invalid aio option: %s", optarg);
211 qemu_opts_reset(&empty_opts);
212 return -EINVAL;
213 }
214 break;
Max Reitzb543c5c2013-10-11 14:02:10 +0200215 case 'o':
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000216 if (imageOpts) {
217 printf("--image-opts and 'open -o' are mutually exclusive\n");
Eric Blakeb8d970f2016-05-07 21:16:41 -0600218 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200219 return -EINVAL;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000220 }
Markus Armbruster70b94332015-02-13 12:50:26 +0100221 if (!qemu_opts_parse_noisily(&empty_opts, optarg, false)) {
Markus Armbruster443422f2014-05-28 11:16:58 +0200222 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200223 return -EINVAL;
Max Reitzb543c5c2013-10-11 14:02:10 +0200224 }
Max Reitzb543c5c2013-10-11 14:02:10 +0200225 break;
Fam Zheng459571f2017-05-03 00:35:41 +0800226 case 'U':
227 force_share = true;
228 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400229 default:
Markus Armbruster443422f2014-05-28 11:16:58 +0200230 qemu_opts_reset(&empty_opts);
Max Reitzb444d0e2018-05-09 21:42:58 +0200231 qemuio_command_usage(&open_cmd);
Max Reitzb32d7a32018-05-09 21:42:59 +0200232 return -EINVAL;
Naphtali Spreif5edb012010-01-17 16:48:13 +0200233 }
Devin Nakamura43642b32011-07-11 11:22:16 -0400234 }
aliguorie3aff4f2009-04-05 19:14:04 +0000235
Devin Nakamura43642b32011-07-11 11:22:16 -0400236 if (!readonly) {
237 flags |= BDRV_O_RDWR;
238 }
aliguorie3aff4f2009-04-05 19:14:04 +0000239
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000240 if (imageOpts && (optind == argc - 1)) {
241 if (!qemu_opts_parse_noisily(&empty_opts, argv[optind], false)) {
242 qemu_opts_reset(&empty_opts);
Max Reitzb32d7a32018-05-09 21:42:59 +0200243 return -EINVAL;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000244 }
245 optind++;
246 }
247
Markus Armbruster443422f2014-05-28 11:16:58 +0200248 qopts = qemu_opts_find(&empty_opts, NULL);
249 opts = qopts ? qemu_opts_to_qdict(qopts, NULL) : NULL;
250 qemu_opts_reset(&empty_opts);
251
Max Reitzfd0fee32013-12-20 19:28:20 +0100252 if (optind == argc - 1) {
Max Reitzb32d7a32018-05-09 21:42:59 +0200253 ret = openfile(argv[optind], flags, writethrough, force_share, opts);
Max Reitzfd0fee32013-12-20 19:28:20 +0100254 } else if (optind == argc) {
Max Reitzb32d7a32018-05-09 21:42:59 +0200255 ret = openfile(NULL, flags, writethrough, force_share, opts);
Max Reitzfd0fee32013-12-20 19:28:20 +0100256 } else {
Marc-André Lureaucb3e7f02018-04-19 17:01:43 +0200257 qobject_unref(opts);
Eric Blake64ebf552017-06-05 15:38:42 -0500258 qemuio_command_usage(&open_cmd);
Max Reitzb32d7a32018-05-09 21:42:59 +0200259 return -EINVAL;
Devin Nakamura43642b32011-07-11 11:22:16 -0400260 }
Max Reitzb32d7a32018-05-09 21:42:59 +0200261
262 if (ret) {
263 return -EINVAL;
264 }
265
266 return 0;
aliguorie3aff4f2009-04-05 19:14:04 +0000267}
268
Max Reitzb32d7a32018-05-09 21:42:59 +0200269static int quit_f(BlockBackend *blk, int argc, char **argv)
Kevin Wolfe681be72013-06-05 14:19:34 +0200270{
Max Reitzb444d0e2018-05-09 21:42:58 +0200271 quit_qemu_io = true;
Max Reitzb32d7a32018-05-09 21:42:59 +0200272 return 0;
Kevin Wolfe681be72013-06-05 14:19:34 +0200273}
274
275static const cmdinfo_t quit_cmd = {
276 .name = "quit",
277 .altname = "q",
278 .cfunc = quit_f,
279 .argmin = -1,
280 .argmax = -1,
281 .flags = CMD_FLAG_GLOBAL,
282 .oneline = "exit the program",
283};
284
aliguorie3aff4f2009-04-05 19:14:04 +0000285static void usage(const char *name)
286{
Devin Nakamura43642b32011-07-11 11:22:16 -0400287 printf(
Eric Blakee4e12bb2016-05-07 21:16:40 -0600288"Usage: %s [OPTIONS]... [-c STRING]... [file]\n"
Stefan Weil84844a22009-06-22 15:08:47 +0200289"QEMU Disk exerciser\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000290"\n"
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000291" --object OBJECTDEF define an object such as 'secret' for\n"
292" passwords and/or encryption keys\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600293" --image-opts treat file as option string\n"
Maria Kustovad208cc32014-03-18 09:59:19 +0400294" -c, --cmd STRING execute command with its arguments\n"
295" from the given string\n"
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100296" -f, --format FMT specifies the block driver to use\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000297" -r, --read-only export read-only\n"
298" -s, --snapshot use snapshot file\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600299" -n, --nocache disable host cache, short for -t none\n"
Eric Blake0f404442017-10-05 14:02:43 -0500300" -C, --copy-on-read enable copy-on-read\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000301" -m, --misalign misalign allocations for O_DIRECT\n"
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000302" -k, --native-aio use kernel AIO implementation\n"
303" (Linux only, prefer use of -i)\n"
304" -i, --aio=MODE use AIO mode (threads, native or io_uring)\n"
Kevin Wolf592fa072012-04-18 12:07:39 +0200305" -t, --cache=MODE use the given cache mode for the image\n"
Eric Blakee4e12bb2016-05-07 21:16:40 -0600306" -d, --discard=MODE use the given discard mode for the image\n"
Denis V. Luneve9a80852016-06-17 17:44:11 +0300307" -T, --trace [[enable=]<pattern>][,events=<file>][,file=<file>]\n"
308" specify tracing options\n"
309" see qemu-img(1) man page for full description\n"
Fam Zheng459571f2017-05-03 00:35:41 +0800310" -U, --force-share force shared permissions\n"
aliguorie3aff4f2009-04-05 19:14:04 +0000311" -h, --help display this help and exit\n"
312" -V, --version output version information and exit\n"
Maria Kustovad208cc32014-03-18 09:59:19 +0400313"\n"
Eric Blakef5048cb2017-08-03 11:33:53 -0500314"See '%s -c help' for information on available commands.\n"
315"\n"
316QEMU_HELP_BOTTOM "\n",
Maria Kustovad208cc32014-03-18 09:59:19 +0400317 name, name);
aliguorie3aff4f2009-04-05 19:14:04 +0000318}
319
Kevin Wolfd1174f12013-06-05 14:19:37 +0200320static char *get_prompt(void)
321{
322 static char prompt[FILENAME_MAX + 2 /*"> "*/ + 1 /*"\0"*/ ];
323
324 if (!prompt[0]) {
Christophe Fergeau99e98d72019-01-31 17:46:13 +0100325 snprintf(prompt, sizeof(prompt), "%s> ", error_get_progname());
Kevin Wolfd1174f12013-06-05 14:19:37 +0200326 }
327
328 return prompt;
329}
330
Stefan Weild5d15072014-01-25 18:18:23 +0100331static void GCC_FMT_ATTR(2, 3) readline_printf_func(void *opaque,
332 const char *fmt, ...)
Kevin Wolfd1174f12013-06-05 14:19:37 +0200333{
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100334 va_list ap;
335 va_start(ap, fmt);
336 vprintf(fmt, ap);
337 va_end(ap);
338}
339
340static void readline_flush_func(void *opaque)
341{
342 fflush(stdout);
343}
344
345static void readline_func(void *opaque, const char *str, void *readline_opaque)
346{
347 char **line = readline_opaque;
348 *line = g_strdup(str);
349}
350
Stefan Hajnoczi46940202013-11-14 11:54:18 +0100351static void completion_match(const char *cmd, void *opaque)
352{
353 readline_add_completion(readline_state, cmd);
354}
355
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100356static void readline_completion_func(void *opaque, const char *str)
357{
Stefan Hajnoczi46940202013-11-14 11:54:18 +0100358 readline_set_completion_index(readline_state, strlen(str));
359 qemuio_complete_command(str, completion_match, NULL);
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100360}
361
362static char *fetchline_readline(void)
363{
364 char *line = NULL;
365
366 readline_start(readline_state, get_prompt(), 0, readline_func, &line);
367 while (!line) {
368 int ch = getchar();
Daniel P. Berrange0e448a02018-02-12 18:48:49 +0000369 if (ttyEOF != 0x0 && ch == ttyEOF) {
370 printf("\n");
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100371 break;
372 }
373 readline_handle_byte(readline_state, ch);
Kevin Wolfd1174f12013-06-05 14:19:37 +0200374 }
375 return line;
376}
Kevin Wolfd1174f12013-06-05 14:19:37 +0200377
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100378#define MAXREADLINESZ 1024
379static char *fetchline_fgets(void)
Kevin Wolfd1174f12013-06-05 14:19:37 +0200380{
381 char *p, *line = g_malloc(MAXREADLINESZ);
382
383 if (!fgets(line, MAXREADLINESZ, stdin)) {
384 g_free(line);
385 return NULL;
386 }
387
388 p = line + strlen(line);
389 if (p != line && p[-1] == '\n') {
390 p[-1] = '\0';
391 }
392
393 return line;
394}
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100395
396static char *fetchline(void)
397{
398 if (readline_state) {
399 return fetchline_readline();
400 } else {
401 return fetchline_fgets();
402 }
403}
Kevin Wolfd1174f12013-06-05 14:19:37 +0200404
405static void prep_fetchline(void *opaque)
406{
407 int *fetchable = opaque;
408
409 qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
410 *fetchable= 1;
411}
412
Max Reitz6b3aa842018-05-09 21:43:00 +0200413static int command_loop(void)
Kevin Wolfd1174f12013-06-05 14:19:37 +0200414{
Max Reitzb444d0e2018-05-09 21:42:58 +0200415 int i, fetchable = 0, prompted = 0;
Max Reitz6b3aa842018-05-09 21:43:00 +0200416 int ret, last_error = 0;
Kevin Wolfd1174f12013-06-05 14:19:37 +0200417 char *input;
418
Max Reitzb444d0e2018-05-09 21:42:58 +0200419 for (i = 0; !quit_qemu_io && i < ncmdline; i++) {
Max Reitz6b3aa842018-05-09 21:43:00 +0200420 ret = qemuio_command(qemuio_blk, cmdline[i]);
421 if (ret < 0) {
422 last_error = ret;
423 }
Kevin Wolfd1174f12013-06-05 14:19:37 +0200424 }
425 if (cmdline) {
426 g_free(cmdline);
Max Reitz6b3aa842018-05-09 21:43:00 +0200427 return last_error;
Kevin Wolfd1174f12013-06-05 14:19:37 +0200428 }
429
Max Reitzb444d0e2018-05-09 21:42:58 +0200430 while (!quit_qemu_io) {
Kevin Wolfd1174f12013-06-05 14:19:37 +0200431 if (!prompted) {
432 printf("%s", get_prompt());
433 fflush(stdout);
434 qemu_set_fd_handler(STDIN_FILENO, prep_fetchline, NULL, &fetchable);
435 prompted = 1;
436 }
437
438 main_loop_wait(false);
439
440 if (!fetchable) {
441 continue;
442 }
443
444 input = fetchline();
445 if (input == NULL) {
446 break;
447 }
Max Reitz6b3aa842018-05-09 21:43:00 +0200448 ret = qemuio_command(qemuio_blk, input);
Kevin Wolfd1174f12013-06-05 14:19:37 +0200449 g_free(input);
450
Max Reitz6b3aa842018-05-09 21:43:00 +0200451 if (ret < 0) {
452 last_error = ret;
453 }
454
Kevin Wolfd1174f12013-06-05 14:19:37 +0200455 prompted = 0;
456 fetchable = 0;
457 }
458 qemu_set_fd_handler(STDIN_FILENO, NULL, NULL, NULL);
Max Reitz6b3aa842018-05-09 21:43:00 +0200459
460 return last_error;
Kevin Wolfd1174f12013-06-05 14:19:37 +0200461}
462
463static void add_user_command(char *optarg)
464{
Markus Armbruster5839e532014-08-19 10:31:08 +0200465 cmdline = g_renew(char *, cmdline, ++ncmdline);
Kevin Wolfd1174f12013-06-05 14:19:37 +0200466 cmdline[ncmdline-1] = optarg;
467}
468
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100469static void reenable_tty_echo(void)
470{
471 qemu_set_tty_echo(STDIN_FILENO, true);
472}
473
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000474enum {
475 OPTION_OBJECT = 256,
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000476 OPTION_IMAGE_OPTS = 257,
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000477};
478
479static QemuOptsList qemu_object_opts = {
480 .name = "object",
481 .implied_opt_name = "qom-type",
482 .head = QTAILQ_HEAD_INITIALIZER(qemu_object_opts.head),
483 .desc = {
484 { }
485 },
486};
487
Kevin Wolf4fa1f0d2019-10-11 21:49:17 +0200488static bool qemu_io_object_print_help(const char *type, QemuOpts *opts)
489{
490 if (user_creatable_print_help(type, opts)) {
491 exit(0);
492 }
493 return true;
494}
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000495
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000496static QemuOptsList file_opts = {
497 .name = "file",
498 .implied_opt_name = "file",
499 .head = QTAILQ_HEAD_INITIALIZER(file_opts.head),
500 .desc = {
501 /* no elements => accept any params */
502 { /* end of list */ }
503 },
504};
505
aliguorie3aff4f2009-04-05 19:14:04 +0000506int main(int argc, char **argv)
507{
Devin Nakamura43642b32011-07-11 11:22:16 -0400508 int readonly = 0;
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000509 const char *sopt = "hVc:d:f:rsnCmki:t:T:U";
Devin Nakamura43642b32011-07-11 11:22:16 -0400510 const struct option lopt[] = {
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000511 { "help", no_argument, NULL, 'h' },
512 { "version", no_argument, NULL, 'V' },
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000513 { "cmd", required_argument, NULL, 'c' },
514 { "format", required_argument, NULL, 'f' },
515 { "read-only", no_argument, NULL, 'r' },
516 { "snapshot", no_argument, NULL, 's' },
517 { "nocache", no_argument, NULL, 'n' },
Eric Blake0f404442017-10-05 14:02:43 -0500518 { "copy-on-read", no_argument, NULL, 'C' },
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000519 { "misalign", no_argument, NULL, 'm' },
520 { "native-aio", no_argument, NULL, 'k' },
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000521 { "aio", required_argument, NULL, 'i' },
Daniel P. Berrangea5134162016-02-17 10:10:23 +0000522 { "discard", required_argument, NULL, 'd' },
523 { "cache", required_argument, NULL, 't' },
524 { "trace", required_argument, NULL, 'T' },
525 { "object", required_argument, NULL, OPTION_OBJECT },
526 { "image-opts", no_argument, NULL, OPTION_IMAGE_OPTS },
Fam Zheng459571f2017-05-03 00:35:41 +0800527 { "force-share", no_argument, 0, 'U'},
Devin Nakamura43642b32011-07-11 11:22:16 -0400528 { NULL, 0, NULL, 0 }
529 };
530 int c;
531 int opt_index = 0;
Paolo Bonzini9e8f1832013-02-08 14:06:11 +0100532 int flags = BDRV_O_UNMAP;
Max Reitz6b3aa842018-05-09 21:43:00 +0200533 int ret;
Kevin Wolfe151fc12016-03-15 12:52:30 +0100534 bool writethrough = true;
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300535 Error *local_error = NULL;
Max Reitz1b58b432015-02-05 13:58:20 -0500536 QDict *opts = NULL;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000537 const char *format = NULL;
Denis V. Luneve9a80852016-06-17 17:44:11 +0300538 char *trace_file = NULL;
Fam Zheng459571f2017-05-03 00:35:41 +0800539 bool force_share = false;
aliguorie3aff4f2009-04-05 19:14:04 +0000540
MORITA Kazutaka526eda12013-07-23 17:30:11 +0900541#ifdef CONFIG_POSIX
542 signal(SIGPIPE, SIG_IGN);
543#endif
544
Christophe Fergeauf5852ef2019-01-31 17:46:14 +0100545 error_init(argv[0]);
Daniel P. Berrangefe4db842016-10-04 14:35:52 +0100546 module_call_init(MODULE_INIT_TRACE);
Fam Zheng10f5bff2014-02-10 14:48:51 +0800547 qemu_init_exec_dir(argv[0]);
aliguorie3aff4f2009-04-05 19:14:04 +0000548
Eduardo Habkoste8f2d272016-05-12 11:10:04 -0300549 qcrypto_init(&error_fatal);
Daniel P. Berrangec2297082016-04-06 12:12:06 +0100550
Daniel P. Berrange064097d2016-02-10 18:41:01 +0000551 module_call_init(MODULE_INIT_QOM);
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000552 qemu_add_opts(&qemu_object_opts);
Denis V. Luneve9a80852016-06-17 17:44:11 +0300553 qemu_add_opts(&qemu_trace_opts);
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100554 bdrv_init();
555
Devin Nakamura43642b32011-07-11 11:22:16 -0400556 while ((c = getopt_long(argc, argv, sopt, lopt, &opt_index)) != -1) {
557 switch (c) {
558 case 's':
559 flags |= BDRV_O_SNAPSHOT;
560 break;
561 case 'n':
Kevin Wolfe151fc12016-03-15 12:52:30 +0100562 flags |= BDRV_O_NOCACHE;
563 writethrough = false;
Devin Nakamura43642b32011-07-11 11:22:16 -0400564 break;
Eric Blake0f404442017-10-05 14:02:43 -0500565 case 'C':
566 flags |= BDRV_O_COPY_ON_READ;
567 break;
Paolo Bonzini9e8f1832013-02-08 14:06:11 +0100568 case 'd':
569 if (bdrv_parse_discard_flags(optarg, &flags) < 0) {
570 error_report("Invalid discard option: %s", optarg);
571 exit(1);
572 }
573 break;
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100574 case 'f':
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000575 format = optarg;
Kevin Wolfbe6273d2014-11-20 16:27:06 +0100576 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400577 case 'c':
578 add_user_command(optarg);
579 break;
580 case 'r':
581 readonly = 1;
582 break;
583 case 'm':
Stefan Weilf9883882014-03-05 22:23:00 +0100584 qemuio_misalign = true;
Devin Nakamura43642b32011-07-11 11:22:16 -0400585 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400586 case 'k':
587 flags |= BDRV_O_NATIVE_AIO;
588 break;
Aarushi Mehta1c5a2ae2020-01-20 14:18:54 +0000589 case 'i':
590 if (bdrv_parse_aio(optarg, &flags) < 0) {
591 error_report("Invalid aio option: %s", optarg);
592 exit(1);
593 }
594 break;
Kevin Wolf592fa072012-04-18 12:07:39 +0200595 case 't':
Kevin Wolfe151fc12016-03-15 12:52:30 +0100596 if (bdrv_parse_cache_mode(optarg, &flags, &writethrough) < 0) {
Kevin Wolf592fa072012-04-18 12:07:39 +0200597 error_report("Invalid cache option: %s", optarg);
598 exit(1);
599 }
600 break;
Stefan Hajnoczid7bb72c2012-03-12 16:36:07 +0000601 case 'T':
Denis V. Luneve9a80852016-06-17 17:44:11 +0300602 g_free(trace_file);
603 trace_file = trace_opt_parse(optarg);
Stefan Hajnoczid7bb72c2012-03-12 16:36:07 +0000604 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400605 case 'V':
Thomas Huth7e563bf2018-02-15 12:06:47 +0100606 printf("%s version " QEMU_FULL_VERSION "\n"
Christophe Fergeau99e98d72019-01-31 17:46:13 +0100607 QEMU_COPYRIGHT "\n", error_get_progname());
Devin Nakamura43642b32011-07-11 11:22:16 -0400608 exit(0);
609 case 'h':
Christophe Fergeau99e98d72019-01-31 17:46:13 +0100610 usage(error_get_progname());
Devin Nakamura43642b32011-07-11 11:22:16 -0400611 exit(0);
Fam Zheng459571f2017-05-03 00:35:41 +0800612 case 'U':
613 force_share = true;
614 break;
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000615 case OPTION_OBJECT: {
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000616 QemuOpts *qopts;
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000617 qopts = qemu_opts_parse_noisily(&qemu_object_opts,
618 optarg, true);
619 if (!qopts) {
620 exit(1);
621 }
622 } break;
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000623 case OPTION_IMAGE_OPTS:
624 imageOpts = true;
625 break;
Devin Nakamura43642b32011-07-11 11:22:16 -0400626 default:
Christophe Fergeau99e98d72019-01-31 17:46:13 +0100627 usage(error_get_progname());
Devin Nakamura43642b32011-07-11 11:22:16 -0400628 exit(1);
Naphtali Spreif5edb012010-01-17 16:48:13 +0200629 }
Devin Nakamura43642b32011-07-11 11:22:16 -0400630 }
aliguorie3aff4f2009-04-05 19:14:04 +0000631
Devin Nakamura43642b32011-07-11 11:22:16 -0400632 if ((argc - optind) > 1) {
Christophe Fergeau99e98d72019-01-31 17:46:13 +0100633 usage(error_get_progname());
Devin Nakamura43642b32011-07-11 11:22:16 -0400634 exit(1);
635 }
aliguorie3aff4f2009-04-05 19:14:04 +0000636
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000637 if (format && imageOpts) {
638 error_report("--image-opts and -f are mutually exclusive");
639 exit(1);
640 }
641
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300642 if (qemu_init_main_loop(&local_error)) {
Markus Armbruster565f65d2015-02-12 13:55:05 +0100643 error_report_err(local_error);
Chrysostomos Nanakos2f78e492014-09-18 14:30:49 +0300644 exit(1);
645 }
Zhi Yong Wua57d1142012-02-19 22:24:59 +0800646
Markus Armbruster7e1e0c12018-10-17 10:26:43 +0200647 qemu_opts_foreach(&qemu_object_opts,
648 user_creatable_add_opts_foreach,
Kevin Wolf4fa1f0d2019-10-11 21:49:17 +0200649 qemu_io_object_print_help, &error_fatal);
Daniel P. Berrange9ba371b2016-02-17 10:10:16 +0000650
Denis V. Luneve9a80852016-06-17 17:44:11 +0300651 if (!trace_init_backends()) {
652 exit(1);
653 }
654 trace_init_file(trace_file);
655 qemu_set_log(LOG_TRACE);
656
Devin Nakamura43642b32011-07-11 11:22:16 -0400657 /* initialize commands */
Kevin Wolfc2cdf5c2013-06-05 14:19:36 +0200658 qemuio_add_command(&quit_cmd);
659 qemuio_add_command(&open_cmd);
660 qemuio_add_command(&close_cmd);
Devin Nakamura43642b32011-07-11 11:22:16 -0400661
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100662 if (isatty(STDIN_FILENO)) {
Daniel P. Berrange0e448a02018-02-12 18:48:49 +0000663 ttyEOF = get_eof_char();
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100664 readline_state = readline_init(readline_printf_func,
665 readline_flush_func,
666 NULL,
667 readline_completion_func);
668 qemu_set_tty_echo(STDIN_FILENO, false);
669 atexit(reenable_tty_echo);
670 }
671
Devin Nakamura43642b32011-07-11 11:22:16 -0400672 /* open the device */
673 if (!readonly) {
674 flags |= BDRV_O_RDWR;
675 }
676
677 if ((argc - optind) == 1) {
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000678 if (imageOpts) {
679 QemuOpts *qopts = NULL;
680 qopts = qemu_opts_parse_noisily(&file_opts, argv[optind], false);
681 if (!qopts) {
682 exit(1);
683 }
684 opts = qemu_opts_to_qdict(qopts, NULL);
Fam Zheng459571f2017-05-03 00:35:41 +0800685 if (openfile(NULL, flags, writethrough, force_share, opts)) {
Nir Sofferb7aa1312017-02-01 02:31:18 +0200686 exit(1);
687 }
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000688 } else {
689 if (format) {
690 opts = qdict_new();
Eric Blake46f5ac22017-04-27 16:58:17 -0500691 qdict_put_str(opts, "driver", format);
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000692 }
Fam Zheng459571f2017-05-03 00:35:41 +0800693 if (openfile(argv[optind], flags, writethrough,
694 force_share, opts)) {
Nir Sofferb7aa1312017-02-01 02:31:18 +0200695 exit(1);
696 }
Daniel P. Berrange499afa22016-02-17 10:10:18 +0000697 }
Devin Nakamura43642b32011-07-11 11:22:16 -0400698 }
Max Reitz6b3aa842018-05-09 21:43:00 +0200699 ret = command_loop();
Devin Nakamura43642b32011-07-11 11:22:16 -0400700
701 /*
Stefan Hajnoczi922453b2011-11-30 12:23:43 +0000702 * Make sure all outstanding requests complete before the program exits.
Devin Nakamura43642b32011-07-11 11:22:16 -0400703 */
Stefan Hajnoczi922453b2011-11-30 12:23:43 +0000704 bdrv_drain_all();
Devin Nakamura43642b32011-07-11 11:22:16 -0400705
Markus Armbruster26f54e92014-10-07 13:59:04 +0200706 blk_unref(qemuio_blk);
Stefan Hajnoczi0cf17e12013-11-14 11:54:17 +0100707 g_free(readline_state);
Max Reitz6b3aa842018-05-09 21:43:00 +0200708
709 if (ret < 0) {
710 return 1;
711 } else {
712 return 0;
713 }
aliguorie3aff4f2009-04-05 19:14:04 +0000714}