xref: /openbmc/qemu/include/qemu-io.h (revision 709395f8)
1 /*
2  * Copyright (c) 2000-2005 Silicon Graphics, Inc.
3  * All Rights Reserved.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it would be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #ifndef QEMU_IO_H
19 #define QEMU_IO_H
20 
21 #include "qemu-common.h"
22 
23 #define CMD_FLAG_GLOBAL ((int)0x80000000) /* don't iterate "args" */
24 
25 /* Implement a qemu-io command.
26  * Operate on @blk using @argc/@argv as the command's arguments, and
27  * return 0 on success or negative errno on failure.
28  */
29 typedef int (*cfunc_t)(BlockBackend *blk, int argc, char **argv);
30 
31 typedef void (*helpfunc_t)(void);
32 
33 typedef struct cmdinfo {
34     const char* name;
35     const char* altname;
36     cfunc_t     cfunc;
37     int         argmin;
38     int         argmax;
39     int         canpush;
40     int         flags;
41     const char  *args;
42     const char  *oneline;
43     helpfunc_t  help;
44     uint64_t    perm;
45 } cmdinfo_t;
46 
47 extern bool qemuio_misalign;
48 
49 int qemuio_command(BlockBackend *blk, const char *cmd);
50 
51 void qemuio_add_command(const cmdinfo_t *ci);
52 void qemuio_command_usage(const cmdinfo_t *ci);
53 void qemuio_complete_command(const char *input,
54                              void (*fn)(const char *cmd, void *opaque),
55                              void *opaque);
56 
57 #endif /* QEMU_IO_H */
58