commands.h

   1 /*
   2  * This program is free software; you can redistribute it and/or
   3  * modify it under the terms of the GNU General Public
   4  * License v2 as published by the Free Software Foundation.
   5  *
   6  * This program is distributed in the hope that it will be useful,
   7  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   8  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   9  * General Public License for more details.
  10  *
  11  * You should have received a copy of the GNU General Public
  12  * License along with this program; if not, write to the
  13  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  14  * Boston, MA 021110-1307, USA.
  15  */
  16
  17 struct cmd_struct {
  18         const char *token;
  19         int (*fn)(int, char **);
  20
  21         /*
  22          * Usage strings
  23          *
  24          * A NULL-terminated array of the following format:
  25          *
  26          *   usagestr[0] - one-line synopsis (required)
  27          *   usagestr[1] - one-line short description (required)
  28          *   usagestr[2..m] - a long (possibly multi-line) description
  29          *                    (optional)
  30          *   usagestr[m + 1] - an empty line separator (required if at least one
  31          *                     option string is given, not needed otherwise)
  32          *   usagestr[m + 2..n] - option strings, one option per line
  33          *                        (optional)
  34          *   usagestr[n + 1] - NULL terminator
  35          *
  36          * Options (if present) should always (even if there is no long
  37          * description) be prepended with an empty line.  Supplied strings are
  38          * indented but otherwise printed as-is, no automatic wrapping is done.
  39          *
  40          * Grep for cmd_*_usage[] for examples.
  41          */
  42         const char * const *usagestr;
  43
  44         /* should be NULL if token is not a subgroup */
  45         const struct cmd_group *next;
  46
  47         /* if true don't list this token in help listings */
  48         int hidden;
  49 };
  50
  51 #define NULL_CMD_STRUCT {NULL, NULL, NULL, NULL, 0}
  52
  53 struct cmd_group {
  54         const char * const *usagestr;
  55         const char *infostr;
  56
  57         const struct cmd_struct commands[];
  58 };
  59
  60 /* btrfs.c */
  61 int prefixcmp(const char *str, const char *prefix);
  62
  63 int handle_command_group(const struct cmd_group *grp, int argc,
  64                          char **argv);
  65
  66 /* help.c */
  67 extern const char * const generic_cmd_help_usage[];
  68
  69 void usage(const char * const *usagestr) __attribute__((noreturn));
  70 void usage_command(const struct cmd_struct *cmd, int full, int err);
  71 void usage_command_group(const struct cmd_group *grp, int all, int err);
  72
  73 void help_unknown_token(const char *arg, const struct cmd_group *grp) __attribute__((noreturn));
  74 void help_ambiguous_token(const char *arg, const struct cmd_group *grp) __attribute__((noreturn));
  75
  76 void help_command_group(const struct cmd_group *grp, int argc, char **argv);
  77
  78 extern const struct cmd_group subvolume_cmd_group;
  79 extern const struct cmd_group filesystem_cmd_group;
  80 extern const struct cmd_group balance_cmd_group;
  81 extern const struct cmd_group device_cmd_group;
  82 extern const struct cmd_group scrub_cmd_group;
  83 extern const struct cmd_group inspect_cmd_group;
  84 extern const struct cmd_group property_cmd_group;
  85 extern const struct cmd_group quota_cmd_group;
  86 extern const struct cmd_group qgroup_cmd_group;
  87 extern const struct cmd_group replace_cmd_group;
  88 extern const struct cmd_group rescue_cmd_group;
  89
  90 extern const char * const cmd_send_usage[];
  91 extern const char * const cmd_receive_usage[];
  92 extern const char * const cmd_check_usage[];
  93 extern const char * const cmd_chunk_recover_usage[];
  94 extern const char * const cmd_super_recover_usage[];
  95 extern const char * const cmd_restore_usage[];
  96 extern const char * const cmd_rescue_usage[];
  97
  98 int cmd_subvolume(int argc, char **argv);
  99 int cmd_filesystem(int argc, char **argv);
 100 int cmd_balance(int argc, char **argv);
 101 int cmd_device(int argc, char **argv);
 102 int cmd_scrub(int argc, char **argv);
 103 int cmd_check(int argc, char **argv);
 104 int cmd_chunk_recover(int argc, char **argv);
 105 int cmd_super_recover(int argc, char **argv);
 106 int cmd_inspect(int argc, char **argv);
 107 int cmd_property(int argc, char **argv);
 108 int cmd_send(int argc, char **argv);
 109 int cmd_receive(int argc, char **argv);
 110 int cmd_quota(int argc, char **argv);
 111 int cmd_qgroup(int argc, char **argv);
 112 int cmd_replace(int argc, char **argv);
 113 int cmd_restore(int argc, char **argv);
 114 int cmd_select_super(int argc, char **argv);
 115 int cmd_dump_super(int argc, char **argv);
 116 int cmd_debug_tree(int argc, char **argv);
 117 int cmd_rescue(int argc, char **argv);
 118
 119 /* subvolume exported functions */
 120 int test_issubvolume(char *path);
 121
 122 /* send.c */
 123 char *get_subvol_name(char *mnt, char *full_path);