mirror of
git://sourceware.org/git/lvm2.git
synced 2024-12-22 17:35:59 +03:00
e225bf59ff
The -a was being included in the set of "one or more" options instead of an actual required option. Even though the cmd def was not implementing the restrictions correctly, the command internally was. Adjust the cmd def code which did not support a command with some real required options and a set of "one or more" options.
279 lines
8.7 KiB
C
279 lines
8.7 KiB
C
/*
|
|
* Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
|
|
* Copyright (C) 2004-2015 Red Hat, Inc. All rights reserved.
|
|
*
|
|
* This file is part of LVM2.
|
|
*
|
|
* This copyrighted material is made available to anyone wishing to use,
|
|
* modify, copy, or redistribute it subject to the terms and conditions
|
|
* of the GNU Lesser General Public License v.2.1.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with this program; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
|
|
#ifndef _LVM_COMMAND_H
|
|
#define _LVM_COMMAND_H
|
|
|
|
struct cmd_context;
|
|
struct logical_volume;
|
|
|
|
/* old per-command-name function */
|
|
typedef int (*command_fn) (struct cmd_context *cmd, int argc, char **argv);
|
|
|
|
/* new per-command-line-id functions */
|
|
typedef int (*command_id_fn) (struct cmd_context *cmd, int argc, char **argv);
|
|
|
|
struct command_function {
|
|
int command_enum;
|
|
command_id_fn fn;
|
|
};
|
|
|
|
#define MAX_COMMAND_NAMES 64
|
|
|
|
struct command_name {
|
|
const char *name;
|
|
const char *desc; /* general command description from commands.h */
|
|
unsigned int flags;
|
|
command_fn fn; /* old style */
|
|
|
|
/* union of {required,optional}_opt_args for all commands with this name */
|
|
int valid_args[ARG_COUNT]; /* used for getopt */
|
|
int num_args;
|
|
|
|
/* the following are for generating help and man page output */
|
|
int common_options[ARG_COUNT]; /* options common to all defs */
|
|
int all_options[ARG_COUNT]; /* union of options from all defs */
|
|
int variants; /* number of command defs with this command name */
|
|
int variant_has_ro; /* do variants use required_opt_args ? */
|
|
int variant_has_rp; /* do variants use required_pos_args ? */
|
|
int variant_has_oo; /* do variants use optional_opt_args ? */
|
|
int variant_has_op; /* do variants use optional_pos_args ? */
|
|
};
|
|
|
|
/*
|
|
* Command defintion
|
|
*
|
|
* A command is defined in terms of a command name,
|
|
* required options (+args), optional options (+args),
|
|
* required positional args, optional positional args.
|
|
*
|
|
* A positional arg always has non-zero pos_arg.def.types.
|
|
* The first positional arg has pos_arg.pos of 1.
|
|
*/
|
|
|
|
/* arg_def flags */
|
|
#define ARG_DEF_FLAG_NEW_VG 1 << 0
|
|
#define ARG_DEF_FLAG_NEW_LV 1 << 1
|
|
#define ARG_DEF_FLAG_MAY_REPEAT 1 << 2
|
|
|
|
static inline int val_bit_is_set(uint64_t val_bits, int val_enum)
|
|
{
|
|
return (val_bits & (1ULL << val_enum)) ? 1 : 0;
|
|
}
|
|
|
|
static inline uint64_t val_enum_to_bit(int val_enum)
|
|
{
|
|
return (1ULL << val_enum);
|
|
}
|
|
|
|
static inline int lvp_bit_is_set(uint64_t lvp_bits, int lvp_enum)
|
|
{
|
|
return (lvp_bits & (1ULL << lvp_enum)) ? 1 : 0;
|
|
}
|
|
|
|
static inline uint64_t lvp_enum_to_bit(int lvp_enum)
|
|
{
|
|
return (1ULL << lvp_enum);
|
|
}
|
|
|
|
static inline int lvt_bit_is_set(uint64_t lvt_bits, int lvt_enum)
|
|
{
|
|
return (lvt_bits & (1ULL << lvt_enum)) ? 1 : 0;
|
|
}
|
|
|
|
static inline uint64_t lvt_enum_to_bit(int lvt_enum)
|
|
{
|
|
return (1ULL << lvt_enum);
|
|
}
|
|
|
|
/* Description a value that follows an option or exists in a position. */
|
|
|
|
struct arg_def {
|
|
uint64_t val_bits; /* bits of x_VAL, can be multiple for pos_arg */
|
|
uint64_t lvt_bits; /* lvt_enum_to_bit(x_LVT) for lv_VAL, can be multiple */
|
|
uint64_t num; /* a literal number for conststr_VAL */
|
|
const char *str; /* a literal string for constnum_VAL */
|
|
uint32_t flags; /* ARG_DEF_FLAG_ */
|
|
};
|
|
|
|
/* Description of an option and the value that follows it. */
|
|
|
|
struct opt_arg {
|
|
int opt; /* option, e.g. foo_ARG */
|
|
struct arg_def def; /* defines accepted values */
|
|
};
|
|
|
|
/* Description of a position and the value that exists there. */
|
|
|
|
struct pos_arg {
|
|
int pos; /* position, e.g. first is 1 */
|
|
struct arg_def def; /* defines accepted values */
|
|
};
|
|
|
|
/*
|
|
* Commands using a given command definition must follow a set
|
|
* of rules. If a given command+LV matches the conditions in
|
|
* opts/lvt_bits/lvp_bits, then the checks are applied.
|
|
* If one condition is not met, the checks are not applied.
|
|
* If no conditions are set, the checks are always applied.
|
|
*/
|
|
|
|
#define RULE_INVALID 1
|
|
#define RULE_REQUIRE 2
|
|
|
|
struct cmd_rule {
|
|
int *opts; /* if any option in this list is set, the check may apply */
|
|
uint64_t lvt_bits; /* if LV has one of these types (lvt_enum_to_bit), the check may apply */
|
|
uint64_t lvp_bits; /* if LV has all of these properties (lvp_enum_to_bit), the check may apply */
|
|
|
|
int *check_opts; /* used options must [not] be in this list */
|
|
uint64_t check_lvt_bits; /* LV must [not] have one of these type */
|
|
uint64_t check_lvp_bits; /* LV must [not] have all of these properties */
|
|
|
|
uint32_t rule; /* RULE_INVALID, RULE_REQUIRE: check values must [not] be true */
|
|
int opts_count; /* entries in opts[] */
|
|
int check_opts_count; /* entries in check_opts[] */
|
|
};
|
|
|
|
/*
|
|
* Array sizes
|
|
*
|
|
* CMD_RO_ARGS needs to accommodate a list of options,
|
|
* of which one is required after which the rest are
|
|
* optional.
|
|
*/
|
|
#define CMD_RO_ARGS 64 /* required opt args */
|
|
#define CMD_OO_ARGS 150 /* optional opt args */
|
|
#define CMD_RP_ARGS 8 /* required positional args */
|
|
#define CMD_OP_ARGS 8 /* optional positional args */
|
|
#define CMD_IO_ARGS 8 /* ignore opt args */
|
|
#define CMD_MAX_RULES 32 /* max number of rules per command def */
|
|
|
|
/*
|
|
* one or more from required_opt_args is required,
|
|
* then the rest are optional.
|
|
*
|
|
* CMD_FLAG_ANY_REQUIRED_OPT: for lvchange/vgchange special case.
|
|
* The first ro_count entries of required_opt_args must be met
|
|
* (ro_count may be 0.) After this, one or more options must be
|
|
* set from the remaining required_opt_args. So, the first
|
|
* ro_count options in required_opt_args must match, and after
|
|
* that one or more of the remaining options in required_opt_args
|
|
* must match.
|
|
*/
|
|
#define CMD_FLAG_ANY_REQUIRED_OPT 1
|
|
#define CMD_FLAG_SECONDARY_SYNTAX 2 /* allows syntax variants to be suppressed in certain output */
|
|
#define CMD_FLAG_PREVIOUS_SYNTAX 4 /* allows syntax variants to not be advertised in output */
|
|
#define CMD_FLAG_PARSE_ERROR 8 /* error parsing command-lines.in def */
|
|
|
|
/* a register of the lvm commands */
|
|
struct command {
|
|
const char *name;
|
|
const char *desc; /* specific command description from command-lines.in */
|
|
const char *command_id; /* ID string in command-lines.in */
|
|
int command_enum; /* <command_id>_CMD */
|
|
int command_index; /* position in commands[] */
|
|
|
|
const struct command_function *functions; /* new style */
|
|
command_fn fn; /* old style */
|
|
|
|
unsigned int cmd_flags; /* CMD_FLAG_ */
|
|
|
|
/* definitions of opt/pos args */
|
|
|
|
/* required args following an --opt */
|
|
struct opt_arg required_opt_args[CMD_RO_ARGS];
|
|
|
|
/* optional args following an --opt */
|
|
struct opt_arg optional_opt_args[CMD_OO_ARGS];
|
|
|
|
/* required positional args */
|
|
struct pos_arg required_pos_args[CMD_RP_ARGS];
|
|
|
|
/* optional positional args */
|
|
struct pos_arg optional_pos_args[CMD_OP_ARGS];
|
|
|
|
/* unused opt args, are ignored instead of causing an error */
|
|
struct opt_arg ignore_opt_args[CMD_IO_ARGS];
|
|
|
|
struct cmd_rule rules[CMD_MAX_RULES];
|
|
|
|
int any_ro_count;
|
|
|
|
int ro_count;
|
|
int oo_count;
|
|
int rp_count;
|
|
int op_count;
|
|
int io_count;
|
|
int rule_count;
|
|
|
|
int pos_count; /* temp counter used by create-command */
|
|
};
|
|
|
|
/* see global opt_names[] */
|
|
|
|
struct opt_name {
|
|
const char *name; /* "foo_ARG" */
|
|
int opt_enum; /* foo_ARG */
|
|
const char short_opt; /* -f */
|
|
char _padding[7];
|
|
const char *long_opt; /* --foo */
|
|
int val_enum; /* xyz_VAL when --foo takes a val like "--foo xyz" */
|
|
uint32_t flags;
|
|
uint32_t prio;
|
|
const char *desc;
|
|
};
|
|
|
|
/* see global val_names[] */
|
|
|
|
struct val_name {
|
|
const char *enum_name; /* "foo_VAL" */
|
|
int val_enum; /* foo_VAL */
|
|
int (*fn) (struct cmd_context *cmd, struct arg_values *av); /* foo_arg() */
|
|
const char *name; /* FooVal */
|
|
const char *usage;
|
|
};
|
|
|
|
/* see global lv_props[] */
|
|
|
|
struct lv_prop {
|
|
const char *enum_name; /* "is_foo_LVP" */
|
|
int lvp_enum; /* is_foo_LVP */
|
|
const char *name; /* "lv_is_foo" */
|
|
int (*fn) (struct cmd_context *cmd, struct logical_volume *lv); /* lv_is_foo() */
|
|
};
|
|
|
|
/* see global lv_types[] */
|
|
|
|
struct lv_type {
|
|
const char *enum_name; /* "foo_LVT" */
|
|
int lvt_enum; /* foo_LVT */
|
|
const char *name; /* "foo" */
|
|
int (*fn) (struct cmd_context *cmd, struct logical_volume *lv); /* lv_is_foo() */
|
|
};
|
|
|
|
|
|
int define_commands(struct cmd_context *cmdtool, const char *run_name);
|
|
int command_id_to_enum(const char *str);
|
|
void print_usage(struct command *cmd, int longhelp, int desc_first);
|
|
void print_usage_common_cmd(struct command_name *cname, struct command *cmd);
|
|
void print_usage_common_lvm(struct command_name *cname, struct command *cmd);
|
|
void print_usage_notes(struct command_name *cname);
|
|
void factor_common_options(void);
|
|
int command_has_alternate_extents(const char *name);
|
|
void configure_command_option_values(const char *name);
|
|
|
|
#endif
|