/* SPDX-License-Identifier: GPL-2.0-only */ /* * Copyright (C) 2001 Sistina Software (UK) Limited. * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved. * * This file is released under the LGPL. */ #ifndef _LINUX_DEVICE_MAPPER_H #define _LINUX_DEVICE_MAPPER_H #include <linux/bio.h> #include <linux/blkdev.h> #include <linux/dm-ioctl.h> #include <linux/math64.h> #include <linux/ratelimit.h> struct dm_dev; struct dm_target; struct dm_table; struct dm_report_zones_args; struct mapped_device; struct bio_vec; enum dax_access_mode; /* * Type of table, mapped_device's mempool and request_queue */ enum dm_queue_mode { … }; status_type_t; map_info; /* * In the constructor the target parameter will already have the * table, type, begin and len fields filled in. */ dm_ctr_fn; /* * The destructor doesn't need to free the dm_target, just * anything hidden ti->private. */ dm_dtr_fn; /* * The map function must return: * < 0: error * = 0: The target will handle the io by resubmitting it later * = 1: simple remap complete * = 2: The target wants to push back the io */ dm_map_fn; dm_clone_and_map_request_fn; dm_release_clone_request_fn; /* * Returns: * < 0 : error (currently ignored) * 0 : ended successfully * 1 : for some reason the io has still not completed (eg, * multipath target might want to requeue a failed io). * 2 : The target wants to push back the io */ dm_endio_fn; dm_request_endio_fn; dm_presuspend_fn; dm_presuspend_undo_fn; dm_postsuspend_fn; dm_preresume_fn; dm_resume_fn; dm_status_fn; dm_message_fn; dm_prepare_ioctl_fn; #ifdef CONFIG_BLK_DEV_ZONED dm_report_zones_fn; #else /* * Define dm_report_zones_fn so that targets can assign to NULL if * CONFIG_BLK_DEV_ZONED disabled. Otherwise each target needs to do * awkward #ifdefs in their target_type, etc. */ typedef int (*dm_report_zones_fn) (struct dm_target *dummy); #endif /* * These iteration functions are typically used to check (and combine) * properties of underlying devices. * E.g. Does at least one underlying device support flush? * Does any underlying device not support WRITE_SAME? * * The callout function is called once for each contiguous section of * an underlying device. State can be maintained in *data. * Return non-zero to stop iterating through any further devices. */ iterate_devices_callout_fn; /* * This function must iterate through each section of device used by the * target until it encounters a non-zero return code, which it then returns. * Returns zero if no callout returned non-zero. */ dm_iterate_devices_fn; dm_io_hints_fn; /* * Returns: * 0: The target can handle the next I/O immediately. * 1: The target can't handle the next I/O immediately. */ dm_busy_fn; /* * Returns: * < 0 : error * >= 0 : the number of bytes accessible at the address */ dm_dax_direct_access_fn; dm_dax_zero_page_range_fn; /* * Returns: * != 0 : number of bytes transferred * 0 : recovery write failed */ dm_dax_recovery_write_fn; void dm_error(const char *message); struct dm_dev { … }; /* * Constructors should call these functions to ensure destination devices * are opened/closed correctly. */ int dm_get_device(struct dm_target *ti, const char *path, blk_mode_t mode, struct dm_dev **result); void dm_put_device(struct dm_target *ti, struct dm_dev *d); /* * Helper function for getting devices */ int dm_devt_from_path(const char *path, dev_t *dev_p); /* * Information about a target type */ struct target_type { … }; /* * Target features */ /* * Any table that contains an instance of this target must have only one. */ #define DM_TARGET_SINGLETON … #define dm_target_needs_singleton(type) … /* * Indicates that a target does not support read-only devices. */ #define DM_TARGET_ALWAYS_WRITEABLE … #define dm_target_always_writeable(type) … /* * Any device that contains a table with an instance of this target may never * have tables containing any different target type. */ #define DM_TARGET_IMMUTABLE … #define dm_target_is_immutable(type) … /* * Indicates that a target may replace any target; even immutable targets. * .map, .map_rq, .clone_and_map_rq and .release_clone_rq are all defined. */ #define DM_TARGET_WILDCARD … #define dm_target_is_wildcard(type) … /* * A target implements own bio data integrity. */ #define DM_TARGET_INTEGRITY … #define dm_target_has_integrity(type) … /* * A target passes integrity data to the lower device. */ #define DM_TARGET_PASSES_INTEGRITY … #define dm_target_passes_integrity(type) … /* * Indicates support for zoned block devices: * - DM_TARGET_ZONED_HM: the target also supports host-managed zoned * block devices but does not support combining different zoned models. * - DM_TARGET_MIXED_ZONED_MODEL: the target supports combining multiple * devices with different zoned models. */ #ifdef CONFIG_BLK_DEV_ZONED #define DM_TARGET_ZONED_HM … #define dm_target_supports_zoned_hm(type) … #else #define DM_TARGET_ZONED_HM … #define dm_target_supports_zoned_hm … #endif /* * A target handles REQ_NOWAIT */ #define DM_TARGET_NOWAIT … #define dm_target_supports_nowait(type) … /* * A target supports passing through inline crypto support. */ #define DM_TARGET_PASSES_CRYPTO … #define dm_target_passes_crypto(type) … #ifdef CONFIG_BLK_DEV_ZONED #define DM_TARGET_MIXED_ZONED_MODEL … #define dm_target_supports_mixed_zoned_model(type) … #else #define DM_TARGET_MIXED_ZONED_MODEL … #define dm_target_supports_mixed_zoned_model … #endif struct dm_target { … }; void *dm_per_bio_data(struct bio *bio, size_t data_size); struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size); unsigned int dm_bio_get_target_bio_nr(const struct bio *bio); u64 dm_start_time_ns_from_clone(struct bio *bio); int dm_register_target(struct target_type *t); void dm_unregister_target(struct target_type *t); /* * Target argument parsing. */ struct dm_arg_set { … }; /* * The minimum and maximum value of a numeric argument, together with * the error message to use if the number is found to be outside that range. */ struct dm_arg { … }; /* * Validate the next argument, either returning it as *value or, if invalid, * returning -EINVAL and setting *error. */ int dm_read_arg(const struct dm_arg *arg, struct dm_arg_set *arg_set, unsigned int *value, char **error); /* * Process the next argument as the start of a group containing between * arg->min and arg->max further arguments. Either return the size as * *num_args or, if invalid, return -EINVAL and set *error. */ int dm_read_arg_group(const struct dm_arg *arg, struct dm_arg_set *arg_set, unsigned int *num_args, char **error); /* * Return the current argument and shift to the next. */ const char *dm_shift_arg(struct dm_arg_set *as); /* * Move through num_args arguments. */ void dm_consume_args(struct dm_arg_set *as, unsigned int num_args); /* *---------------------------------------------------------------- * Functions for creating and manipulating mapped devices. * Drop the reference with dm_put when you finish with the object. *---------------------------------------------------------------- */ /* * DM_ANY_MINOR chooses the next available minor number. */ #define DM_ANY_MINOR … int dm_create(int minor, struct mapped_device **md); /* * Reference counting for md. */ struct mapped_device *dm_get_md(dev_t dev); void dm_get(struct mapped_device *md); int dm_hold(struct mapped_device *md); void dm_put(struct mapped_device *md); /* * An arbitrary pointer may be stored alongside a mapped device. */ void dm_set_mdptr(struct mapped_device *md, void *ptr); void *dm_get_mdptr(struct mapped_device *md); /* * A device can still be used while suspended, but I/O is deferred. */ int dm_suspend(struct mapped_device *md, unsigned int suspend_flags); int dm_resume(struct mapped_device *md); /* * Event functions. */ uint32_t dm_get_event_nr(struct mapped_device *md); int dm_wait_event(struct mapped_device *md, int event_nr); uint32_t dm_next_uevent_seq(struct mapped_device *md); void dm_uevent_add(struct mapped_device *md, struct list_head *elist); /* * Info functions. */ const char *dm_device_name(struct mapped_device *md); int dm_copy_name_and_uuid(struct mapped_device *md, char *name, char *uuid); struct gendisk *dm_disk(struct mapped_device *md); int dm_suspended(struct dm_target *ti); int dm_post_suspending(struct dm_target *ti); int dm_noflush_suspending(struct dm_target *ti); void dm_accept_partial_bio(struct bio *bio, unsigned int n_sectors); void dm_submit_bio_remap(struct bio *clone, struct bio *tgt_clone); union map_info *dm_get_rq_mapinfo(struct request *rq); #ifdef CONFIG_BLK_DEV_ZONED struct dm_report_zones_args { … }; int dm_report_zones(struct block_device *bdev, sector_t start, sector_t sector, struct dm_report_zones_args *args, unsigned int nr_zones); #endif /* CONFIG_BLK_DEV_ZONED */ /* * Device mapper functions to parse and create devices specified by the * parameter "dm-mod.create=" */ int __init dm_early_create(struct dm_ioctl *dmi, struct dm_target_spec **spec_array, char **target_params_array); /* * Geometry functions. */ int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo); int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo); /* *--------------------------------------------------------------- * Functions for manipulating device-mapper tables. *--------------------------------------------------------------- */ /* * First create an empty table. */ int dm_table_create(struct dm_table **result, blk_mode_t mode, unsigned int num_targets, struct mapped_device *md); /* * Then call this once for each target. */ int dm_table_add_target(struct dm_table *t, const char *type, sector_t start, sector_t len, char *params); /* * Target can use this to set the table's type. * Can only ever be called from a target's ctr. * Useful for "hybrid" target (supports both bio-based * and request-based). */ void dm_table_set_type(struct dm_table *t, enum dm_queue_mode type); /* * Finally call this to make the table ready for use. */ int dm_table_complete(struct dm_table *t); /* * Destroy the table when finished. */ void dm_table_destroy(struct dm_table *t); /* * Target may require that it is never sent I/O larger than len. */ int __must_check dm_set_target_max_io_len(struct dm_target *ti, sector_t len); /* * Table reference counting. */ struct dm_table *dm_get_live_table(struct mapped_device *md, int *srcu_idx); void dm_put_live_table(struct mapped_device *md, int srcu_idx); void dm_sync_table(struct mapped_device *md); /* * Queries */ sector_t dm_table_get_size(struct dm_table *t); blk_mode_t dm_table_get_mode(struct dm_table *t); struct mapped_device *dm_table_get_md(struct dm_table *t); const char *dm_table_device_name(struct dm_table *t); /* * Trigger an event. */ void dm_table_event(struct dm_table *t); /* * Run the queue for request-based targets. */ void dm_table_run_md_queue_async(struct dm_table *t); /* * The device must be suspended before calling this method. * Returns the previous table, which the caller must destroy. */ struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *t); /* * Table blk_crypto_profile functions */ void dm_destroy_crypto_profile(struct blk_crypto_profile *profile); /* *--------------------------------------------------------------- * Macros. *--------------------------------------------------------------- */ #define DM_NAME … #define DM_FMT(fmt) … #define DMCRIT(fmt, ...) … #define DMERR(fmt, ...) … #define DMERR_LIMIT(fmt, ...) … #define DMWARN(fmt, ...) … #define DMWARN_LIMIT(fmt, ...) … #define DMINFO(fmt, ...) … #define DMINFO_LIMIT(fmt, ...) … #define DMDEBUG(fmt, ...) … #define DMDEBUG_LIMIT(fmt, ...) … #define DMEMIT(x...) … #define DMEMIT_TARGET_NAME_VERSION(y) … /** * module_dm() - Helper macro for DM targets that don't do anything * special in their module_init and module_exit. * Each module may only use this macro once, and calling it replaces * module_init() and module_exit(). * * @name: DM target's name */ #define module_dm(name) … /* * Definitions of return values from target end_io function. */ #define DM_ENDIO_DONE … #define DM_ENDIO_INCOMPLETE … #define DM_ENDIO_REQUEUE … #define DM_ENDIO_DELAY_REQUEUE … /* * Definitions of return values from target map function. */ #define DM_MAPIO_SUBMITTED … #define DM_MAPIO_REMAPPED … #define DM_MAPIO_REQUEUE … #define DM_MAPIO_DELAY_REQUEUE … #define DM_MAPIO_KILL … #define dm_sector_div64(x, y) … /* * Ceiling(n / sz) */ #define dm_div_up(n, sz) … #define dm_sector_div_up(n, sz) … /* * ceiling(n / size) * size */ #define dm_round_up(n, sz) … /* * Sector offset taken relative to the start of the target instead of * relative to the start of the device. */ #define dm_target_offset(ti, sector) … static inline sector_t to_sector(unsigned long long n) { … } static inline unsigned long to_bytes(sector_t n) { … } #endif /* _LINUX_DEVICE_MAPPER_H */
Codebase Browser
linux