v3.14.2
[btrfs-progs-unstable/devel.git] / commands.h
blobdb700438677e9b229189ecf824f30b76fc7a5dbc
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.
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.
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.
17 #define ARGV0_BUF_SIZE 64
19 struct cmd_struct {
20 const char *token;
21 int (*fn)(int, char **);
24 * Usage strings
26 * A NULL-terminated array of the following format:
28 * usagestr[0] - one-line synopsis (required)
29 * usagestr[1] - one-line short description (required)
30 * usagestr[2..m] - a long (possibly multi-line) description
31 * (optional)
32 * usagestr[m + 1] - an empty line separator (required if at least one
33 * option string is given, not needed otherwise)
34 * usagestr[m + 2..n] - option strings, one option per line
35 * (optional)
36 * usagestr[n + 1] - NULL terminator
38 * Options (if present) should always (even if there is no long
39 * description) be prepended with an empty line. Supplied strings are
40 * indented but otherwise printed as-is, no automatic wrapping is done.
42 * Grep for cmd_*_usage[] for examples.
44 const char * const *usagestr;
46 /* should be NULL if token is not a subgroup */
47 const struct cmd_group *next;
49 /* if true don't list this token in help listings */
50 int hidden;
53 #define NULL_CMD_STRUCT {NULL, NULL, NULL, NULL, 0}
55 struct cmd_group {
56 const char * const *usagestr;
57 const char *infostr;
59 const struct cmd_struct commands[];
62 /* btrfs.c */
63 int prefixcmp(const char *str, const char *prefix);
65 int check_argc_exact(int nargs, int expected);
66 int check_argc_min(int nargs, int expected);
67 int check_argc_max(int nargs, int expected);
69 int handle_command_group(const struct cmd_group *grp, int argc,
70 char **argv);
72 /* help.c */
73 extern const char * const generic_cmd_help_usage[];
75 void usage(const char * const *usagestr) __attribute__((noreturn));
76 void usage_command(const struct cmd_struct *cmd, int full, int err);
77 void usage_command_group(const struct cmd_group *grp, int all, int err);
79 void help_unknown_token(const char *arg, const struct cmd_group *grp) __attribute__((noreturn));
80 void help_ambiguous_token(const char *arg, const struct cmd_group *grp) __attribute__((noreturn));
82 void help_command_group(const struct cmd_group *grp, int argc, char **argv);
84 extern const struct cmd_group subvolume_cmd_group;
85 extern const struct cmd_group filesystem_cmd_group;
86 extern const struct cmd_group balance_cmd_group;
87 extern const struct cmd_group device_cmd_group;
88 extern const struct cmd_group scrub_cmd_group;
89 extern const struct cmd_group inspect_cmd_group;
90 extern const struct cmd_group property_cmd_group;
91 extern const struct cmd_group quota_cmd_group;
92 extern const struct cmd_group qgroup_cmd_group;
93 extern const struct cmd_group replace_cmd_group;
94 extern const struct cmd_group rescue_cmd_group;
96 extern const char * const cmd_send_usage[];
97 extern const char * const cmd_receive_usage[];
98 extern const char * const cmd_check_usage[];
99 extern const char * const cmd_chunk_recover_usage[];
100 extern const char * const cmd_super_recover_usage[];
101 extern const char * const cmd_restore_usage[];
102 extern const char * const cmd_rescue_usage[];
104 int cmd_subvolume(int argc, char **argv);
105 int cmd_filesystem(int argc, char **argv);
106 int cmd_balance(int argc, char **argv);
107 int cmd_device(int argc, char **argv);
108 int cmd_scrub(int argc, char **argv);
109 int cmd_check(int argc, char **argv);
110 int cmd_chunk_recover(int argc, char **argv);
111 int cmd_super_recover(int argc, char **argv);
112 int cmd_inspect(int argc, char **argv);
113 int cmd_property(int argc, char **argv);
114 int cmd_send(int argc, char **argv);
115 int cmd_receive(int argc, char **argv);
116 int cmd_quota(int argc, char **argv);
117 int cmd_qgroup(int argc, char **argv);
118 int cmd_replace(int argc, char **argv);
119 int cmd_restore(int argc, char **argv);
120 int cmd_select_super(int argc, char **argv);
121 int cmd_dump_super(int argc, char **argv);
122 int cmd_debug_tree(int argc, char **argv);
123 int cmd_rescue(int argc, char **argv);
125 /* subvolume exported functions */
126 int test_issubvolume(char *path);
128 /* send.c */
129 char *get_subvol_name(char *mnt, char *full_path);