shaba/lvm2
1
0
Fork 0
mirror of git://sourceware.org/git/lvm2.git synced 2024-12-22 17:35:59 +03:00
Code Releases Activity
4a657a13b1
lvm2/lib/config/config.h

149 lines
5.7 KiB
C
Raw Normal View History

o Populating with stuff from experimental
2001-08-21 16:56:08 +04:00
/*
Update copyright notices.
2004-03-30 23:35:44 +04:00
* Copyright (C) 2001-2004 Sistina Software, Inc. All rights reserved.
Fix inconsistent licence notices: executables are GPLv2; libraries LGPLv2.1.
2007-08-21 00:55:30 +04:00
* Copyright (C) 2004-2007 Red Hat, Inc. All rights reserved.
o Populating with stuff from experimental
2001-08-21 16:56:08 +04:00
*
Update copyright notices.
2004-03-30 23:35:44 +04:00
* 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
Fix inconsistent licence notices: executables are GPLv2; libraries LGPLv2.1.
2007-08-21 00:55:30 +04:00
* of the GNU Lesser General Public License v.2.1.
Update copyright notices.
2004-03-30 23:35:44 +04:00
*
Fix inconsistent licence notices: executables are GPLv2; libraries LGPLv2.1.
2007-08-21 00:55:30 +04:00
* You should have received a copy of the GNU Lesser General Public License
Update copyright notices.
2004-03-30 23:35:44 +04:00
* along with this program; if not, write to the Free Software Foundation,
* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
o Populating with stuff from experimental
2001-08-21 16:56:08 +04:00
*/
lvactivate checkpoint commit
2001-09-25 16:49:28 +04:00
#ifndef _LVM_CONFIG_H
#define _LVM_CONFIG_H
Use hash, bitset, malloc, pool from libdevmapper.
2005-10-17 03:03:59 +04:00
#include "lvm-types.h"
config: add structs to represent config definition and register config_settings.h content This patch adds basic structures that encapsulate the config_settings.h content - it takes each item and puts it in structures: - cfg_def_type_t to define config item type - cfg_def_value_t to define config item (default) value - flags used to define the nature and use of the config item: - CFG_NAME_VARIABLE for items with variable names (e.g. tags) - CFG_ALLOW_EMPTY for items where empty value is allowed - CFG_ADVANCED for items which are considered as "advanced settings" - CFG_UNSUPPORTED for items which are not officially supported (config options mostly for internal use and testing/debugging) - cfg_def_item_t to encapsulate the whole definition of the config definition itself Each config item is referenced by named ID, e.g. "devices_dir_CFG" instead of directly typing the path "devices/dir" as it was before. This patch also adds cfg_def_get_path helper function to get the config setting path up to the root for given config ID (it returns the path in form of "abc/def/.../xyz" where the "abc" is the topmost element).
2013-03-05 19:49:42 +04:00
#include "defaults.h"
Use hash, bitset, malloc, pool from libdevmapper.
2005-10-17 03:03:59 +04:00
config: add vsn macro The 'vsn' macro encodes the LVM2 version major, minor and patchlevel number in a packed form using 16 bits.
2013-03-05 19:39:36 +04:00
/* 16 bits: 3 bits for major, 4 bits for minor, 9 bits for patchlevel */
/* Max LVM version supported: 7.15.511. Just extend bits if ever needed. */
#define vsn(major, minor, patchlevel) (major << 13 | minor << 9 | patchlevel)
Support tagged config files.
2004-05-04 22:28:15 +04:00
struct device;
struct cmd_context;
Another sync point - numerous fixes & clean ups.
2003-07-05 02:34:56 +04:00
config: add structs to represent config definition and register config_settings.h content This patch adds basic structures that encapsulate the config_settings.h content - it takes each item and puts it in structures: - cfg_def_type_t to define config item type - cfg_def_value_t to define config item (default) value - flags used to define the nature and use of the config item: - CFG_NAME_VARIABLE for items with variable names (e.g. tags) - CFG_ALLOW_EMPTY for items where empty value is allowed - CFG_ADVANCED for items which are considered as "advanced settings" - CFG_UNSUPPORTED for items which are not officially supported (config options mostly for internal use and testing/debugging) - cfg_def_item_t to encapsulate the whole definition of the config definition itself Each config item is referenced by named ID, e.g. "devices_dir_CFG" instead of directly typing the path "devices/dir" as it was before. This patch also adds cfg_def_get_path helper function to get the config setting path up to the root for given config ID (it returns the path in form of "abc/def/.../xyz" where the "abc" is the topmost element).
2013-03-05 19:49:42 +04:00
#define CFG_PATH_MAX_LEN 64
/*
* Structures used for definition of a configuration tree.
*/
/* configuration definition item type (for item's accepted types) */
typedef enum {
config: fix bitfield for section Since the cfg_def_type_t is used as bitfield in some tests, use bitshifting to create valid bit sequence. (in release fix)
2013-04-29 14:38:56 +04:00
CFG_TYPE_SECTION = 1 << 0, /* section */
CFG_TYPE_ARRAY = 1 << 1, /* setting */
CFG_TYPE_BOOL = 1 << 2, /* setting */
CFG_TYPE_INT = 1 << 3, /* setting */
CFG_TYPE_FLOAT = 1 << 4, /* setting */
CFG_TYPE_STRING = 1 << 5, /* setting */
config: add structs to represent config definition and register config_settings.h content This patch adds basic structures that encapsulate the config_settings.h content - it takes each item and puts it in structures: - cfg_def_type_t to define config item type - cfg_def_value_t to define config item (default) value - flags used to define the nature and use of the config item: - CFG_NAME_VARIABLE for items with variable names (e.g. tags) - CFG_ALLOW_EMPTY for items where empty value is allowed - CFG_ADVANCED for items which are considered as "advanced settings" - CFG_UNSUPPORTED for items which are not officially supported (config options mostly for internal use and testing/debugging) - cfg_def_item_t to encapsulate the whole definition of the config definition itself Each config item is referenced by named ID, e.g. "devices_dir_CFG" instead of directly typing the path "devices/dir" as it was before. This patch also adds cfg_def_get_path helper function to get the config setting path up to the root for given config ID (it returns the path in form of "abc/def/.../xyz" where the "abc" is the topmost element).
2013-03-05 19:49:42 +04:00
} cfg_def_type_t;
/* configuration definition item value (for item's default value) */
typedef union {
const int v_CFG_TYPE_BOOL, v_CFG_TYPE_INT;
const float v_CFG_TYPE_FLOAT;
const char *v_CFG_TYPE_STRING, *v_CFG_TYPE_ARRAY;
} cfg_def_value_t;
/* configuration definition item flags: */
/* whether the configuration item name is variable */
#define CFG_NAME_VARIABLE 0x01
/* whether empty value is allowed */
#define CFG_ALLOW_EMPTY 0x02
/* whether the configuration item is for advanced use only */
#define CFG_ADVANCED 0x04
/* whether the configuraton item is not officially supported */
#define CFG_UNSUPPORTED 0x08
config: add support for configuration check (config_def_check fn) Add support for configuration checking - type checking and recognition of registered configuration settings that LVM2 understands and also check the structure of the configuration. Log error on any mismatch found. A hash over all allowed configuration paths is created which helps with matching the exact configuration (lvm.conf/--config tree) with the configuration item definition from config_settings.h in an efficient and one-step way. Two more helper flags are introduced for each configuration definition item: - CFG_USED which marks the item as being used (lvm.conf/--config) This helps with identifying missing configuration options (and for which defaults were used) when traversing the tree later. - CFG_VALID which denotes that the item has already been checked and it was found valid. This improves performance, so if the check is called once again on the same tree which was not reloaded, we can just return the state from previous check (with a possibility to force the check if needed). The new function that config.h exports and which is going to be used to perform the configuration checking is: int config_def_check(struct cmd_context *cmd, int force, int skip, int suppress_messages) ...which is exported internally via config.h.
2013-03-05 20:14:18 +04:00
/* helper flag to mark the item as used in a config tree instance */
#define CFG_USED 0x10
/* helper flag to mark the item as valid in a config tree instance */
#define CFG_VALID 0x20
config: add structs to represent config definition and register config_settings.h content This patch adds basic structures that encapsulate the config_settings.h content - it takes each item and puts it in structures: - cfg_def_type_t to define config item type - cfg_def_value_t to define config item (default) value - flags used to define the nature and use of the config item: - CFG_NAME_VARIABLE for items with variable names (e.g. tags) - CFG_ALLOW_EMPTY for items where empty value is allowed - CFG_ADVANCED for items which are considered as "advanced settings" - CFG_UNSUPPORTED for items which are not officially supported (config options mostly for internal use and testing/debugging) - cfg_def_item_t to encapsulate the whole definition of the config definition itself Each config item is referenced by named ID, e.g. "devices_dir_CFG" instead of directly typing the path "devices/dir" as it was before. This patch also adds cfg_def_get_path helper function to get the config setting path up to the root for given config ID (it returns the path in form of "abc/def/.../xyz" where the "abc" is the topmost element).
2013-03-05 19:49:42 +04:00
/* configuration definition item structure */
typedef struct cfg_def_item {
int id; /* ID of this item */
int parent; /* ID of parent item */
const char *name; /* name of the item in configuration tree */
cfg_def_type_t type; /* configuration item type */
cfg_def_value_t default_value; /* default value (only for settings) */
uint16_t flags; /* configuration item definition flags */
uint16_t since_version; /* version this item appeared in */
const char *comment; /* brief comment */
} cfg_def_item_t;
config: use config checks and add support for creating trees from config definition (config_def_create_tree fn) Configuration checking is initiated during config load/processing (_process_config fn) which is part of the command context creation/refresh. This patch also defines 5 types of trees that could be created from the configuration definition (config_settings.h), the cfg_def_tree_t: - CFG_DEF_TREE_CURRENT that denotes a tree of all the configuration nodes that are explicitly defined in lvm.conf/--config - CFG_DEF_TREE_MISSING that denotes a tree of all missing configuration nodes for which default valus are used since they're not explicitly used in lvm.conf/--config - CFG_DEF_TREE_DEFAULT that denotes a tree of all possible configuration nodes with default values assigned, no matter what the actual lvm.conf/--config is - CFG_DEF_TREE_NEW that denotes a tree of all new configuration nodes that appeared in given version - CFG_DEF_TREE_COMPLETE that denotes a tree of the whole configuration tree that is used in LVM2 (a combination of CFG_DEF_TREE_CURRENT + CFG_DEF_TREE_MISSING). This is not implemented yet, it will be added later... The function that creates the definition tree of given type: struct dm_config_tree *config_def_create_tree(struct config_def_tree_spec *spec); Where the "spec" specifies the tree type to be created: struct config_def_tree_spec { cfg_def_tree_t type; /* tree type */ uint16_t version; /* tree at this LVM2 version */ int ignoreadvanced; /* do not include advanced configs */ int ignoreunsupported; /* do not include unsupported configs */ }; This tree can be passed to already existing functions that write the tree on output (like we already do with cmd->cft). There is a new lvm.conf section called "config" with two new options: - config/checks which enables/disables checking (enabled by default) - config/abort_on_errors which enables/disables aborts on any type of mismatch found in the config (disabled by default)
2013-03-05 20:36:10 +04:00
/* configuration definition tree types */
typedef enum {
CFG_DEF_TREE_CURRENT, /* tree of nodes with values currently set in the config */
CFG_DEF_TREE_MISSING, /* tree of nodes missing in current config using default values */
CFG_DEF_TREE_COMPLETE, /* CURRENT + MISSING, the tree actually used within execution, not implemented yet */
CFG_DEF_TREE_DEFAULT, /* tree of all possible config nodes with default values */
CFG_DEF_TREE_NEW /* tree of all new nodes that appeared in given version */
} cfg_def_tree_t;
/* configuration definition tree specification */
struct config_def_tree_spec {
cfg_def_tree_t type; /* tree type */
uint16_t version; /* tree at this LVM2 version */
int ignoreadvanced; /* do not include advanced configs */
int ignoreunsupported; /* do not include unsupported configs */
};
config: add structs to represent config definition and register config_settings.h content This patch adds basic structures that encapsulate the config_settings.h content - it takes each item and puts it in structures: - cfg_def_type_t to define config item type - cfg_def_value_t to define config item (default) value - flags used to define the nature and use of the config item: - CFG_NAME_VARIABLE for items with variable names (e.g. tags) - CFG_ALLOW_EMPTY for items where empty value is allowed - CFG_ADVANCED for items which are considered as "advanced settings" - CFG_UNSUPPORTED for items which are not officially supported (config options mostly for internal use and testing/debugging) - cfg_def_item_t to encapsulate the whole definition of the config definition itself Each config item is referenced by named ID, e.g. "devices_dir_CFG" instead of directly typing the path "devices/dir" as it was before. This patch also adds cfg_def_get_path helper function to get the config setting path up to the root for given config ID (it returns the path in form of "abc/def/.../xyz" where the "abc" is the topmost element).
2013-03-05 19:49:42 +04:00
/*
* Register ID for each possible item in the configuration tree.
*/
enum {
#define cfg_section(id, name, parent, flags, since_version, comment) id,
#define cfg(id, name, parent, flags, type, default_value, since_version, comment) id,
#define cfg_array(id, name, parent, flags, types, default_value, since_version, comment) id,
#include "config_settings.h"
#undef cfg_section
#undef cfg
#undef cfg_array
};
int config_def_get_path(char *buf, size_t buf_size, int id);
config: add support for configuration check (config_def_check fn) Add support for configuration checking - type checking and recognition of registered configuration settings that LVM2 understands and also check the structure of the configuration. Log error on any mismatch found. A hash over all allowed configuration paths is created which helps with matching the exact configuration (lvm.conf/--config tree) with the configuration item definition from config_settings.h in an efficient and one-step way. Two more helper flags are introduced for each configuration definition item: - CFG_USED which marks the item as being used (lvm.conf/--config) This helps with identifying missing configuration options (and for which defaults were used) when traversing the tree later. - CFG_VALID which denotes that the item has already been checked and it was found valid. This improves performance, so if the check is called once again on the same tree which was not reloaded, we can just return the state from previous check (with a possibility to force the check if needed). The new function that config.h exports and which is going to be used to perform the configuration checking is: int config_def_check(struct cmd_context *cmd, int force, int skip, int suppress_messages) ...which is exported internally via config.h.
2013-03-05 20:14:18 +04:00
int config_def_check(struct cmd_context *cmd, int force, int skip, int suppress_messages);
config: add structs to represent config definition and register config_settings.h content This patch adds basic structures that encapsulate the config_settings.h content - it takes each item and puts it in structures: - cfg_def_type_t to define config item type - cfg_def_value_t to define config item (default) value - flags used to define the nature and use of the config item: - CFG_NAME_VARIABLE for items with variable names (e.g. tags) - CFG_ALLOW_EMPTY for items where empty value is allowed - CFG_ADVANCED for items which are considered as "advanced settings" - CFG_UNSUPPORTED for items which are not officially supported (config options mostly for internal use and testing/debugging) - cfg_def_item_t to encapsulate the whole definition of the config definition itself Each config item is referenced by named ID, e.g. "devices_dir_CFG" instead of directly typing the path "devices/dir" as it was before. This patch also adds cfg_def_get_path helper function to get the config setting path up to the root for given config ID (it returns the path in form of "abc/def/.../xyz" where the "abc" is the topmost element).
2013-03-05 19:49:42 +04:00
Rename _override_settings into override_config_tree_from_string and move. Move _override_settings from tools/lvmcmdline.c into lib/config/config.c and export so we can re-use in liblvm.
2009-07-28 01:01:56 +04:00
int override_config_tree_from_string(struct cmd_context *cmd,
const char *config_settings);
Move cascade inside libdm etc. Makes dumpconfig whole-section output wrong in a different way from before, but we should be able to merge cft_cmdline properly into cmd->cft now and remove cascade.
2011-09-02 05:32:08 +04:00
struct dm_config_tree *remove_overridden_config_tree(struct cmd_context *cmd);
o Populating with stuff from experimental
2001-08-21 16:56:08 +04:00
Speed up CRC32 calculations by using a larger lookup table. Use -DDEBUG_CRC32 to revert to old function and check new one gives same result.
2010-09-27 23:09:34 +04:00
typedef uint32_t (*checksum_fn_t) (uint32_t initial, const uint8_t *buf, uint32_t size);
Refactoring.
2002-11-18 17:01:16 +03:00
Make a cleaner split between config tree and config file functionality. Move the latter out of libdm.
2011-12-19 01:56:03 +04:00
struct dm_config_tree *config_file_open(const char *filename, int keep_open);
int config_file_read_fd(struct dm_config_tree *cft, struct device *dev,
off_t offset, size_t size, off_t offset2, size_t size2,
checksum_fn_t checksum_fn, uint32_t checksum);
cleanup: indent line
2013-01-19 15:04:17 +04:00
int config_file_read(struct dm_config_tree *cft);
dumpconfig: add --withcomments and --withversions switch lvm dumpconfig [--withcomments] [--withversions] The --withcomments causes the comments to appear on output before each config node (if they were defined in config_settings.h). The --withversions causes a one line extra comment to appear on output before each config node with the version information in which the configuration setting first appeared.
2013-03-05 21:21:13 +04:00
int config_write(struct dm_config_tree *cft,
int withcomment, int withversion,
const char *file, int argc, char **argv);
config: use config checks and add support for creating trees from config definition (config_def_create_tree fn) Configuration checking is initiated during config load/processing (_process_config fn) which is part of the command context creation/refresh. This patch also defines 5 types of trees that could be created from the configuration definition (config_settings.h), the cfg_def_tree_t: - CFG_DEF_TREE_CURRENT that denotes a tree of all the configuration nodes that are explicitly defined in lvm.conf/--config - CFG_DEF_TREE_MISSING that denotes a tree of all missing configuration nodes for which default valus are used since they're not explicitly used in lvm.conf/--config - CFG_DEF_TREE_DEFAULT that denotes a tree of all possible configuration nodes with default values assigned, no matter what the actual lvm.conf/--config is - CFG_DEF_TREE_NEW that denotes a tree of all new configuration nodes that appeared in given version - CFG_DEF_TREE_COMPLETE that denotes a tree of the whole configuration tree that is used in LVM2 (a combination of CFG_DEF_TREE_CURRENT + CFG_DEF_TREE_MISSING). This is not implemented yet, it will be added later... The function that creates the definition tree of given type: struct dm_config_tree *config_def_create_tree(struct config_def_tree_spec *spec); Where the "spec" specifies the tree type to be created: struct config_def_tree_spec { cfg_def_tree_t type; /* tree type */ uint16_t version; /* tree at this LVM2 version */ int ignoreadvanced; /* do not include advanced configs */ int ignoreunsupported; /* do not include unsupported configs */ }; This tree can be passed to already existing functions that write the tree on output (like we already do with cmd->cft). There is a new lvm.conf section called "config" with two new options: - config/checks which enables/disables checking (enabled by default) - config/abort_on_errors which enables/disables aborts on any type of mismatch found in the config (disabled by default)
2013-03-05 20:36:10 +04:00
struct dm_config_tree *config_def_create_tree(struct config_def_tree_spec *spec);
Make a cleaner split between config tree and config file functionality. Move the latter out of libdm.
2011-12-19 01:56:03 +04:00
void config_file_destroy(struct dm_config_tree *cft);
time_t config_file_timestamp(struct dm_config_tree *cft);
int config_file_changed(struct dm_config_tree *cft);
int config_file_check(struct dm_config_tree *cft, const char **filename, struct stat *info);
Move dm_config_write out of libdm, back to lib/config, as config_write.
2011-12-12 03:18:20 +04:00
Handle metadata with unknown segment types more gracefully.
2009-10-16 21:41:49 +04:00
Move the core of the lib/config/config.c functionality into libdevmapper, leaving behind the LVM-specific parts of the code (convenience wrappers that handle `struct device` and `struct cmd_context`, basically). A number of functions have been renamed (in addition to getting a dm_ prefix) -- namely, all of the config interface now has a dm_config_ prefix.
2011-08-30 18:55:15 +04:00
int merge_config_tree(struct cmd_context *cmd, struct dm_config_tree *cft,
struct dm_config_tree *newdata);
o Populating with stuff from experimental
2001-08-21 16:56:08 +04:00
Fix lvcreate corelog validation. Add --config for overriding most config file settings from cmdline. Quote arguments when printing command line. Remove linefeed from 'initialising logging' message. Add 'Completed' debug message. Don't attempt library exit after reloading config files. Always compile with libdevmapper, even if device-mapper is disabled.
2006-05-16 20:48:31 +04:00
/*
* These versions check an override tree, if present, first.
*/
config: refer to config nodes using assigned IDs For example, the old call and reference: find_config_tree_str(cmd, "devices/dir", DEFAULT_DEV_DIR) ...now becomes: find_config_tree_str(cmd, devices_dir_CFG) So we're referring to the named configuration ID instead of passing the configuration path and the default value is taken from central config definition in config_settings.h automatically.
2013-03-05 20:00:43 +04:00
const struct dm_config_node *find_config_tree_node(struct cmd_context *cmd, int id);
const char *find_config_tree_str(struct cmd_context *cmd, int id);
const char *find_config_tree_str_allow_empty(struct cmd_context *cmd, int id);
int find_config_tree_int(struct cmd_context *cmd, int id);
int64_t find_config_tree_int64(struct cmd_context *cmd, int id);
float find_config_tree_float(struct cmd_context *cmd, int id);
int find_config_tree_bool(struct cmd_context *cmd, int id);
Add 'get' functions.
2002-01-10 19:47:58 +03:00
o Populating with stuff from experimental
2001-08-21 16:56:08 +04:00
#endif
Copy Permalink