2001-10-03 16:41:29 +04:00
/*
2004-03-30 23:35:44 +04:00
* Copyright ( C ) 2001 - 2004 Sistina Software , Inc . All rights reserved .
2007-08-21 00:55:30 +04:00
* Copyright ( C ) 2004 - 2007 Red Hat , Inc . All rights reserved .
2001-10-03 16:41:29 +04:00
*
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
2007-08-21 00:55:30 +04:00
* of the GNU Lesser General Public License v .2 .1 .
2004-03-30 23:35:44 +04:00
*
2007-08-21 00:55:30 +04:00
* You should have received a copy of the GNU Lesser General Public License
2004-03-30 23:35:44 +04:00
* along with this program ; if not , write to the Free Software Foundation ,
2016-01-21 13:49:46 +03:00
* Inc . , 51 Franklin Street , Fifth Floor , Boston , MA 02110 - 1301 USA
2001-10-03 16:41:29 +04:00
*/
# ifndef _LVM_DEV_CACHE_H
# define _LVM_DEV_CACHE_H
2018-05-14 12:30:20 +03:00
# include "lib/device/device.h"
2019-07-09 22:48:31 +03:00
# include "lib/device/dev-type.h"
2018-05-14 12:30:20 +03:00
# include "lib/misc/lvm-wrappers.h"
2001-10-03 16:41:29 +04:00
2018-06-15 19:03:55 +03:00
struct cmd_context ;
2001-10-03 16:41:29 +04:00
/*
* predicate for devices .
*/
struct dev_filter {
2018-12-07 23:35:22 +03:00
int ( * passes_filter ) ( struct cmd_context * cmd , struct dev_filter * f , struct device * dev , const char * use_filter_name ) ;
2018-06-15 19:03:55 +03:00
void ( * destroy ) ( struct dev_filter * f ) ;
2020-10-20 23:17:56 +03:00
void ( * wipe ) ( struct cmd_context * cmd , struct dev_filter * f , struct device * dev , const char * use_filter_name ) ;
2001-10-03 16:41:29 +04:00
void * private ;
2012-03-12 18:40:41 +04:00
unsigned use_count ;
2018-12-07 23:35:22 +03:00
const char * name ;
2001-10-03 16:41:29 +04:00
} ;
2016-03-16 16:01:26 +03:00
struct dm_list * dev_cache_get_dev_list_for_vgid ( const char * vgid ) ;
struct dm_list * dev_cache_get_dev_list_for_lvid ( const char * lvid ) ;
2001-10-03 16:41:29 +04:00
/*
* The global device cache .
*/
2007-04-26 20:44:59 +04:00
int dev_cache_init ( struct cmd_context * cmd ) ;
2014-03-25 13:53:42 +04:00
int dev_cache_exit ( void ) ;
2018-06-15 19:03:55 +03:00
2014-04-04 04:39:42 +04:00
/*
* Returns number of open devices .
*/
int dev_cache_check_for_open_devices ( void ) ;
2001-10-03 16:41:29 +04:00
2021-07-02 01:25:43 +03:00
void dev_cache_scan ( struct cmd_context * cmd ) ;
2002-11-18 17:01:16 +03:00
int dev_cache_has_scanned ( void ) ;
2001-10-03 16:41:29 +04:00
int dev_cache_add_dir ( const char * path ) ;
2018-06-15 19:03:55 +03:00
struct device * dev_cache_get ( struct cmd_context * cmd , const char * name , struct dev_filter * f ) ;
2001-10-03 16:41:29 +04:00
2019-04-05 22:03:38 +03:00
struct device * dev_cache_get_by_devt ( struct cmd_context * cmd , dev_t device , struct dev_filter * f , int * filtered ) ;
2012-02-23 17:11:07 +04:00
2020-07-20 20:48:36 +03:00
struct device * dev_hash_get ( const char * name ) ;
2014-05-29 11:41:03 +04:00
void dev_set_preferred_name ( struct dm_str_list * sl , struct device * dev ) ;
2007-04-26 20:44:59 +04:00
2001-10-03 16:41:29 +04:00
/*
* Object for iterating through the cache .
*/
struct dev_iter ;
2018-04-09 19:13:43 +03:00
struct dev_iter * dev_iter_create ( struct dev_filter * f , int unused ) ;
2001-10-03 16:41:29 +04:00
void dev_iter_destroy ( struct dev_iter * iter ) ;
2018-06-15 19:03:55 +03:00
struct device * dev_iter_get ( struct cmd_context * cmd , struct dev_iter * iter ) ;
2001-10-03 16:41:29 +04:00
2018-05-30 01:02:27 +03:00
void dev_cache_failed_path ( struct device * dev , const char * path ) ;
2019-07-09 22:48:31 +03:00
bool dev_cache_has_md_with_end_superblock ( struct dev_types * dt ) ;
device usage based on devices file
The LVM devices file lists devices that lvm can use. The default
file is /etc/lvm/devices/system.devices, and the lvmdevices(8)
command is used to add or remove device entries. If the file
does not exist, or if lvm.conf includes use_devicesfile=0, then
lvm will not use a devices file. When the devices file is in use,
the regex filter is not used, and the filter settings in lvm.conf
or on the command line are ignored.
LVM records devices in the devices file using hardware-specific
IDs, such as the WWID, and attempts to use subsystem-specific
IDs for virtual device types. These device IDs are also written
in the VG metadata. When no hardware or virtual ID is available,
lvm falls back using the unstable device name as the device ID.
When devnames are used, lvm performs extra scanning to find
devices if their devname changes, e.g. after reboot.
When proper device IDs are used, an lvm command will not look
at devices outside the devices file, but when devnames are used
as a fallback, lvm will scan devices outside the devices file
to locate PVs on renamed devices. A config setting
search_for_devnames can be used to control the scanning for
renamed devname entries.
Related to the devices file, the new command option
--devices <devnames> allows a list of devices to be specified for
the command to use, overriding the devices file. The listed
devices act as a sort of devices file in terms of limiting which
devices lvm will see and use. Devices that are not listed will
appear to be missing to the lvm command.
Multiple devices files can be kept in /etc/lvm/devices, which
allows lvm to be used with different sets of devices, e.g.
system devices do not need to be exposed to a specific application,
and the application can use lvm on its own set of devices that are
not exposed to the system. The option --devicesfile <filename> is
used to select the devices file to use with the command. Without
the option set, the default system devices file is used.
Setting --devicesfile "" causes lvm to not use a devices file.
An existing, empty devices file means lvm will see no devices.
The new command vgimportdevices adds PVs from a VG to the devices
file and updates the VG metadata to include the device IDs.
vgimportdevices -a will import all VGs into the system devices file.
LVM commands run by dmeventd not use a devices file by default,
and will look at all devices on the system. A devices file can
be created for dmeventd (/etc/lvm/devices/dmeventd.devices) If
this file exists, lvm commands run by dmeventd will use it.
Internal implementaion:
- device_ids_read - read the devices file
. add struct dev_use (du) to cmd->use_devices for each devices file entry
- dev_cache_scan - get /dev entries
. add struct device (dev) to dev_cache for each device on the system
- device_ids_match - match devices file entries to /dev entries
. match each du on cmd->use_devices to a dev in dev_cache, using device ID
. on match, set du->dev, dev->id, dev->flags MATCHED_USE_ID
- label_scan - read lvm headers and metadata from devices
. filters are applied, those that do not need data from the device
. filter-deviceid skips devs without MATCHED_USE_ID, i.e.
skips /dev entries that are not listed in the devices file
. read lvm label from dev
. filters are applied, those that use data from the device
. read lvm metadata from dev
. add info/vginfo structs for PVs/VGs (info is "lvmcache")
- device_ids_find_renamed_devs - handle devices with unstable devname ID
where devname changed
. this step only needed when devs do not have proper device IDs,
and their dev names change, e.g. after reboot sdb becomes sdc.
. detect incorrect match because PVID in the devices file entry
does not match the PVID found when the device was read above
. undo incorrect match between du and dev above
. search system devices for new location of PVID
. update devices file with new devnames for PVIDs on renamed devices
. label_scan the renamed devs
- continue with command processing
2020-06-23 21:25:41 +03:00
int get_sysfs_value ( const char * path , char * buf , size_t buf_size , int error_if_no_value ) ;
skip indexing devices used by LVs in more commands
expands commit d5a06f9a7df5a43b2e2311db62ff8d3011217d74
"pvscan: skip indexing devices used by LVs"
The dev cache index is expensive and slow, so limit it
to commands that are used to observe the state of lvm.
The index is only used to print warnings about incorrect
device use by active LVs, e.g. if an LV is using a
multipath component device instead of the multipath
device. Commands that continue to use the index and
print the warnings:
fullreport, lvmdiskscan, vgs, lvs, pvs,
vgdisplay, lvdisplay, pvdisplay,
vgscan, lvscan, pvscan (excluding --cache)
A couple other commands were borrowing the DEV_USED_FOR_LV
flag to just check if a device was actively in use by LVs.
These are converted to the new dev_is_used_by_active_lv().
2021-07-08 00:59:56 +03:00
int get_dm_uuid_from_sysfs ( char * buf , size_t buf_size , int major , int minor ) ;
device usage based on devices file
The LVM devices file lists devices that lvm can use. The default
file is /etc/lvm/devices/system.devices, and the lvmdevices(8)
command is used to add or remove device entries. If the file
does not exist, or if lvm.conf includes use_devicesfile=0, then
lvm will not use a devices file. When the devices file is in use,
the regex filter is not used, and the filter settings in lvm.conf
or on the command line are ignored.
LVM records devices in the devices file using hardware-specific
IDs, such as the WWID, and attempts to use subsystem-specific
IDs for virtual device types. These device IDs are also written
in the VG metadata. When no hardware or virtual ID is available,
lvm falls back using the unstable device name as the device ID.
When devnames are used, lvm performs extra scanning to find
devices if their devname changes, e.g. after reboot.
When proper device IDs are used, an lvm command will not look
at devices outside the devices file, but when devnames are used
as a fallback, lvm will scan devices outside the devices file
to locate PVs on renamed devices. A config setting
search_for_devnames can be used to control the scanning for
renamed devname entries.
Related to the devices file, the new command option
--devices <devnames> allows a list of devices to be specified for
the command to use, overriding the devices file. The listed
devices act as a sort of devices file in terms of limiting which
devices lvm will see and use. Devices that are not listed will
appear to be missing to the lvm command.
Multiple devices files can be kept in /etc/lvm/devices, which
allows lvm to be used with different sets of devices, e.g.
system devices do not need to be exposed to a specific application,
and the application can use lvm on its own set of devices that are
not exposed to the system. The option --devicesfile <filename> is
used to select the devices file to use with the command. Without
the option set, the default system devices file is used.
Setting --devicesfile "" causes lvm to not use a devices file.
An existing, empty devices file means lvm will see no devices.
The new command vgimportdevices adds PVs from a VG to the devices
file and updates the VG metadata to include the device IDs.
vgimportdevices -a will import all VGs into the system devices file.
LVM commands run by dmeventd not use a devices file by default,
and will look at all devices on the system. A devices file can
be created for dmeventd (/etc/lvm/devices/dmeventd.devices) If
this file exists, lvm commands run by dmeventd will use it.
Internal implementaion:
- device_ids_read - read the devices file
. add struct dev_use (du) to cmd->use_devices for each devices file entry
- dev_cache_scan - get /dev entries
. add struct device (dev) to dev_cache for each device on the system
- device_ids_match - match devices file entries to /dev entries
. match each du on cmd->use_devices to a dev in dev_cache, using device ID
. on match, set du->dev, dev->id, dev->flags MATCHED_USE_ID
- label_scan - read lvm headers and metadata from devices
. filters are applied, those that do not need data from the device
. filter-deviceid skips devs without MATCHED_USE_ID, i.e.
skips /dev entries that are not listed in the devices file
. read lvm label from dev
. filters are applied, those that use data from the device
. read lvm metadata from dev
. add info/vginfo structs for PVs/VGs (info is "lvmcache")
- device_ids_find_renamed_devs - handle devices with unstable devname ID
where devname changed
. this step only needed when devs do not have proper device IDs,
and their dev names change, e.g. after reboot sdb becomes sdc.
. detect incorrect match because PVID in the devices file entry
does not match the PVID found when the device was read above
. undo incorrect match between du and dev above
. search system devices for new location of PVID
. update devices file with new devnames for PVIDs on renamed devices
. label_scan the renamed devs
- continue with command processing
2020-06-23 21:25:41 +03:00
int setup_devices_file ( struct cmd_context * cmd ) ;
int setup_devices ( struct cmd_context * cmd ) ;
int setup_device ( struct cmd_context * cmd , const char * devname ) ;
2021-10-19 00:24:24 +03:00
/* Normal device setup functions are split up for pvscan optimization. */
int setup_devices_for_pvscan_cache ( struct cmd_context * cmd ) ;
int setup_devname_in_dev_cache ( struct cmd_context * cmd , const char * devname ) ;
int setup_devno_in_dev_cache ( struct cmd_context * cmd , dev_t devno ) ;
2001-10-03 16:41:29 +04:00
# endif
