include/qemu-io.h

   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
  22 #define CMD_FLAG_GLOBAL ((int)0x80000000) /* don't iterate "args" */
  23
  24 /* Implement a qemu-io command.
  25  * Operate on @blk using @argc/@argv as the command's arguments, and
  26  * return 0 on success or negative errno on failure.
  27  */
  28 typedef int (*cfunc_t)(BlockBackend *blk, int argc, char **argv);
  29
  30 typedef void (*helpfunc_t)(void);
  31
  32 typedef struct cmdinfo {
  33     const char* name;
  34     const char* altname;
  35     cfunc_t     cfunc;
  36     int         argmin;
  37     int         argmax;
  38     int         canpush;
  39     int         flags;
  40     const char  *args;
  41     const char  *oneline;
  42     helpfunc_t  help;
  43     uint64_t    perm;
  44 } cmdinfo_t;
  45
  46 extern bool qemuio_misalign;
  47
  48 int qemuio_command(BlockBackend *blk, const char *cmd);
  49
  50 void qemuio_add_command(const cmdinfo_t *ci);
  51 void qemuio_command_usage(const cmdinfo_t *ci);
  52 void qemuio_complete_command(const char *input,
  53                              void (*fn)(const char *cmd, void *opaque),
  54                              void *opaque);
  55
  56 #endif /* QEMU_IO_H */