mirror of
git://sourceware.org/git/lvm2.git
synced 2024-12-21 13:34:40 +03:00
322 lines
11 KiB
C
322 lines
11 KiB
C
/*
|
|
* Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
|
|
* Copyright (C) 2004-2009 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_TOOLCONTEXT_H
|
|
#define _LVM_TOOLCONTEXT_H
|
|
|
|
#include "lib/device/dev-cache.h"
|
|
#include "lib/device/dev-type.h"
|
|
#include "lib/commands/cmd_enum.h"
|
|
|
|
#include <limits.h>
|
|
|
|
/*
|
|
* Config options that can be changed while commands are processed
|
|
*/
|
|
struct config_info {
|
|
int debug;
|
|
int debug_classes;
|
|
int verbose;
|
|
int silent;
|
|
int suppress;
|
|
int test;
|
|
int yes;
|
|
int syslog;
|
|
int activation;
|
|
int suffix;
|
|
int archive; /* should we archive ? */
|
|
int backup; /* should we backup ? */
|
|
int read_ahead; /* DM_READ_AHEAD_NONE or _AUTO */
|
|
int udev_rules;
|
|
int udev_sync;
|
|
int udev_fallback;
|
|
int issue_discards;
|
|
uint32_t journal;
|
|
const char *msg_prefix;
|
|
const char *fmt_name;
|
|
const char *dmeventd_executable;
|
|
uint64_t unit_factor;
|
|
mode_t umask;
|
|
char unit_type;
|
|
char _padding[1];
|
|
};
|
|
|
|
struct dm_config_tree;
|
|
struct profile_params;
|
|
struct archive_params;
|
|
struct backup_params;
|
|
struct arg_values;
|
|
|
|
struct config_tree_list {
|
|
struct dm_list list;
|
|
struct dm_config_tree *cft;
|
|
};
|
|
|
|
struct cmd_context_initialized_parts {
|
|
unsigned config:1; /* used to reinitialize config if previous init was not successful */
|
|
unsigned filters:1;
|
|
unsigned connections:1;
|
|
};
|
|
|
|
struct cmd_report {
|
|
int log_only;
|
|
dm_report_group_type_t report_group_type;
|
|
struct dm_report_group *report_group;
|
|
struct dm_report *log_rh;
|
|
const char *log_name;
|
|
log_report_t saved_log_report_state;
|
|
};
|
|
|
|
/* FIXME Split into tool & library contexts */
|
|
/* command-instance-related variables needed by library */
|
|
struct cmd_context {
|
|
/*
|
|
* Memory handlers.
|
|
*/
|
|
struct dm_pool *libmem; /* for permanent config data */
|
|
struct dm_pool *mem; /* transient: cleared between each command */
|
|
|
|
/*
|
|
* Command line and arguments.
|
|
*/
|
|
const char *cmd_line;
|
|
const char *name; /* needed before cmd->command is set */
|
|
const struct command_name *cname;
|
|
struct command *command;
|
|
int command_enum; /* duplicate from command->command_enum for lib code */
|
|
char **argv;
|
|
struct arg_values *opt_arg_values;
|
|
struct dm_list arg_value_groups;
|
|
int opt_count; /* total number of options (beginning with - or --) */
|
|
|
|
/*
|
|
* Position args remaining after command name
|
|
* and --options are removed from original argc/argv.
|
|
*/
|
|
int position_argc;
|
|
char **position_argv;
|
|
|
|
/*
|
|
* Format handlers.
|
|
*/
|
|
const struct format_type *fmt; /* current format to use by default */
|
|
struct format_type *fmt_backup; /* format to use for backups */
|
|
struct dm_list formats; /* available formats */
|
|
struct dm_list segtypes; /* available segment types */
|
|
|
|
/*
|
|
* Machine and system identification.
|
|
*/
|
|
const char *system_id;
|
|
const char *product_uuid;
|
|
const char *hostname;
|
|
const char *kernel_vsn;
|
|
|
|
/*
|
|
* Device identification.
|
|
*/
|
|
struct dev_types *dev_types; /* recognized extra device types. */
|
|
|
|
/*
|
|
* Initialization state.
|
|
*/
|
|
struct cmd_context_initialized_parts initialized;
|
|
|
|
/*
|
|
* Switches.
|
|
*/
|
|
unsigned is_long_lived:1; /* optimises persistent_filter handling */
|
|
unsigned is_interactive:1;
|
|
unsigned running_on_valgrind:1;
|
|
unsigned check_pv_dev_sizes:1;
|
|
unsigned handles_missing_pvs:1;
|
|
unsigned handles_unknown_segments:1;
|
|
unsigned use_linear_target:1;
|
|
unsigned partial_activation:1;
|
|
unsigned degraded_activation:1;
|
|
unsigned auto_set_activation_skip:1;
|
|
unsigned si_unit_consistency:1;
|
|
unsigned report_strict_type_mode:1;
|
|
unsigned report_binary_values_as_numeric:1;
|
|
unsigned report_mark_hidden_devices:1;
|
|
unsigned metadata_read_only:1;
|
|
unsigned threaded:1; /* set if running within a thread e.g. clvmd */
|
|
unsigned unknown_system_id:1;
|
|
unsigned include_historical_lvs:1; /* also process/report/display historical LVs */
|
|
unsigned record_historical_lvs:1; /* record historical LVs */
|
|
unsigned include_exported_vgs:1;
|
|
unsigned include_foreign_vgs:1; /* report/display cmds can reveal foreign VGs */
|
|
unsigned include_shared_vgs:1; /* report/display cmds can reveal lockd VGs */
|
|
unsigned include_active_foreign_vgs:1; /* cmd should process foreign VGs with active LVs */
|
|
unsigned vg_read_print_access_error:1; /* print access errors from vg_read */
|
|
unsigned allow_mixed_block_sizes:1;
|
|
unsigned force_access_clustered:1;
|
|
unsigned lockd_gl_disable:1;
|
|
unsigned lockd_vg_disable:1;
|
|
unsigned lockd_lv_disable:1;
|
|
unsigned lockd_gl_removed:1;
|
|
unsigned lockd_vg_default_sh:1;
|
|
unsigned lockd_vg_enforce_sh:1;
|
|
unsigned lockd_lv_sh_for_ex:1;
|
|
unsigned lockd_global_ex:1; /* set while global lock held ex (lockd) */
|
|
unsigned lockf_global_ex:1; /* set while global lock held ex (flock) */
|
|
unsigned nolocking:1;
|
|
unsigned vg_notify:1;
|
|
unsigned lv_notify:1;
|
|
unsigned pv_notify:1;
|
|
unsigned activate_component:1; /* command activates component LV */
|
|
unsigned process_component_lvs:1; /* command processes also component LVs */
|
|
unsigned mirror_warn_printed:1; /* command already printed warning about non-monitored mirrors */
|
|
unsigned expect_missing_vg_device:1; /* when reading a vg it's expected that a dev for a pv isn't found */
|
|
unsigned can_use_one_scan:1;
|
|
unsigned is_clvmd:1;
|
|
unsigned md_component_detection:1;
|
|
unsigned use_full_md_check:1;
|
|
unsigned is_activating:1;
|
|
unsigned enable_hints:1; /* hints are enabled for cmds in general */
|
|
unsigned use_hints:1; /* if hints are enabled this cmd can use them */
|
|
unsigned pvscan_recreate_hints:1; /* enable special case hint handling for pvscan --cache */
|
|
unsigned scan_lvs:1;
|
|
unsigned wipe_outdated_pvs:1;
|
|
unsigned devices_file_hash_mismatch:1;
|
|
unsigned devices_file_hash_ignore:1;
|
|
unsigned enable_devices_list:1; /* command is using --devices option */
|
|
unsigned enable_devices_file:1; /* command is using devices file */
|
|
unsigned pending_devices_file:1; /* command may create and enable devices file */
|
|
unsigned create_edit_devices_file:1; /* command expects to create and/or edit devices file */
|
|
unsigned edit_devices_file:1; /* command expects to edit devices file */
|
|
unsigned filter_deviceid_skip:1; /* don't use filter-deviceid */
|
|
unsigned filter_regex_skip:1; /* don't use filter-regex */
|
|
unsigned filter_regex_with_devices_file:1; /* use filter-regex even when devices file is enabled */
|
|
unsigned filter_nodata_only:1; /* only use filters that do not require data from the dev */
|
|
unsigned run_by_dmeventd:1; /* command is being run by dmeventd */
|
|
unsigned sysinit:1; /* --sysinit is used */
|
|
unsigned ignorelockingfailure:1; /* --ignorelockingfailure is used */
|
|
unsigned check_devs_used:1; /* check devs used by LVs */
|
|
unsigned print_device_id_not_found:1; /* print devices file entries not found */
|
|
unsigned ignore_device_name_mismatch:1; /* skip updating devices file names */
|
|
unsigned backup_disabled:1; /* skip repeated debug message */
|
|
unsigned event_activation:1; /* whether event_activation is set */
|
|
unsigned udevoutput:1;
|
|
unsigned online_vg_file_removed:1;
|
|
unsigned filter_regex_set_preferred_name_disable:1; /* prevent dev_set_preferred_name */
|
|
unsigned device_ids_check_product_uuid:1;
|
|
unsigned device_ids_check_hostname:1;
|
|
unsigned device_ids_refresh_trigger:1;
|
|
unsigned device_ids_invalid:1;
|
|
unsigned device_ids_auto_import:1;
|
|
unsigned get_vgname_from_options:1; /* used by lvconvert */
|
|
|
|
/*
|
|
* Devices and filtering.
|
|
*/
|
|
struct dev_filter *filter;
|
|
struct dm_list use_devices; /* struct dev_use for each entry in devices file */
|
|
const char *md_component_checks;
|
|
const char *search_for_devnames; /* config file setting */
|
|
struct dm_list device_ids_check_serial;
|
|
const char *devicesfile; /* from --devicesfile option */
|
|
struct dm_list deviceslist; /* from --devices option, struct dm_str_list */
|
|
|
|
/*
|
|
* Configuration.
|
|
*/
|
|
struct dm_list config_files; /* master lvm config + any existing tag configs */
|
|
struct profile_params *profile_params; /* profile handling params including loaded profile configs */
|
|
struct dm_config_tree *cft; /* the whole cascade: CONFIG_STRING -> CONFIG_PROFILE -> CONFIG_FILE/CONFIG_MERGED_FILES */
|
|
struct dm_hash_table *cft_def_hash; /* config definition hash used for validity check (item type + item recognized) */
|
|
struct config_info default_settings; /* selected settings with original default/configured value which can be changed during cmd processing */
|
|
struct config_info current_settings; /* may contain changed values compared to default_settings */
|
|
|
|
/*
|
|
* Archives and backups.
|
|
*/
|
|
struct archive_params *archive_params;
|
|
struct backup_params *backup_params;
|
|
const char *stripe_filler;
|
|
|
|
/*
|
|
* Host tags.
|
|
*/
|
|
struct dm_list tags; /* list of defined tags */
|
|
int hosttags;
|
|
|
|
/*
|
|
* Paths.
|
|
*/
|
|
const char *lib_dir; /* cache value global/library_dir */
|
|
const char *device_id_sysfs_dir;
|
|
char system_dir[PATH_MAX];
|
|
char dev_dir[PATH_MAX];
|
|
char proc_dir[PATH_MAX];
|
|
char devices_file_path[PATH_MAX];
|
|
|
|
/*
|
|
* Reporting.
|
|
*/
|
|
struct cmd_report cmd_report;
|
|
|
|
/*
|
|
* Buffers.
|
|
*/
|
|
char display_buffer[NAME_LEN * 10]; /* ring buffer for upto 10 longest vg/lv names */
|
|
unsigned display_lvname_idx; /* index to ring buffer */
|
|
char *linebuffer;
|
|
|
|
/*
|
|
* Others - unsorted.
|
|
*/
|
|
const char *report_list_item_separator;
|
|
const char *time_format;
|
|
unsigned rand_seed;
|
|
struct dm_list pending_delete; /* list of LVs for removal */
|
|
struct dm_pool *pending_delete_mem; /* memory pool for pending deletes */
|
|
struct vdo_convert_params *lvcreate_vcp;/* params for LV to VDO conversion */
|
|
uint32_t lockopt; /* LOCKOPT_* from --lockopt string */
|
|
};
|
|
|
|
/*
|
|
* system_dir may be NULL to use the default value.
|
|
* The environment variable LVM_SYSTEM_DIR always takes precedence.
|
|
*/
|
|
struct cmd_context *create_toolcontext(unsigned is_clvmd,
|
|
const char *system_dir,
|
|
unsigned set_buffering,
|
|
unsigned threaded,
|
|
unsigned set_connections,
|
|
unsigned set_filters);
|
|
void destroy_toolcontext(struct cmd_context *cmd);
|
|
int refresh_toolcontext(struct cmd_context *cmd);
|
|
int refresh_filters(struct cmd_context *cmd);
|
|
int process_profilable_config(struct cmd_context *cmd);
|
|
int config_files_changed(struct cmd_context *cmd);
|
|
int init_lvmcache_orphans(struct cmd_context *cmd);
|
|
int init_filters(struct cmd_context *cmd, unsigned load_persistent_cache);
|
|
int init_connections(struct cmd_context *cmd);
|
|
int init_run_by_dmeventd(struct cmd_context *cmd);
|
|
|
|
/*
|
|
* A config context is a very light weight cmd struct that
|
|
* is only used for reading config settings from lvm.conf,
|
|
* which are at cmd->cft.
|
|
*/
|
|
void destroy_config_context(struct cmd_context *cmd);
|
|
|
|
struct format_type *get_format_by_name(struct cmd_context *cmd, const char *format);
|
|
|
|
const char *system_id_from_string(struct cmd_context *cmd, const char *str);
|
|
|
|
#endif
|