drivers/md/dm.h

   1 /*
   2  * Internal header file for device mapper
   3  *
   4  * Copyright (C) 2001, 2002 Sistina Software
   5  * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
   6  *
   7  * This file is released under the LGPL.
   8  */
   9
  10 #ifndef DM_INTERNAL_H
  11 #define DM_INTERNAL_H
  12
  13 #include <linux/fs.h>
  14 #include <linux/device-mapper.h>
  15 #include <linux/list.h>
  16 #include <linux/moduleparam.h>
  17 #include <linux/blkdev.h>
  18 #include <linux/backing-dev.h>
  19 #include <linux/hdreg.h>
  20 #include <linux/completion.h>
  21 #include <linux/kobject.h>
  22
  23 #include "dm-stats.h"
  24
  25 /*
  26  * Suspend feature flags
  27  */
  28 #define DM_SUSPEND_LOCKFS_FLAG          (1 << 0)
  29 #define DM_SUSPEND_NOFLUSH_FLAG         (1 << 1)
  30
  31 /*
  32  * Status feature flags
  33  */
  34 #define DM_STATUS_NOFLUSH_FLAG          (1 << 0)
  35
  36 /*
  37  * Type of table and mapped_device's mempool
  38  */
  39 #define DM_TYPE_NONE                    0
  40 #define DM_TYPE_BIO_BASED               1
  41 #define DM_TYPE_REQUEST_BASED           2
  42 #define DM_TYPE_MQ_REQUEST_BASED        3
  43
  44 /*
  45  * List of devices that a metadevice uses and should open/close.
  46  */
  47 struct dm_dev_internal {
  48         struct list_head list;
  49         atomic_t count;
  50         struct dm_dev *dm_dev;
  51 };
  52
  53 struct dm_table;
  54 struct dm_md_mempools;
  55
  56 /*-----------------------------------------------------------------
  57  * Internal table functions.
  58  *---------------------------------------------------------------*/
  59 void dm_table_destroy(struct dm_table *t);
  60 void dm_table_event_callback(struct dm_table *t,
  61                              void (*fn)(void *), void *context);
  62 struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
  63 struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
  64 bool dm_table_has_no_data_devices(struct dm_table *table);
  65 int dm_calculate_queue_limits(struct dm_table *table,
  66                               struct queue_limits *limits);
  67 void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
  68                                struct queue_limits *limits);
  69 struct list_head *dm_table_get_devices(struct dm_table *t);
  70 void dm_table_presuspend_targets(struct dm_table *t);
  71 void dm_table_presuspend_undo_targets(struct dm_table *t);
  72 void dm_table_postsuspend_targets(struct dm_table *t);
  73 int dm_table_resume_targets(struct dm_table *t);
  74 int dm_table_any_congested(struct dm_table *t, int bdi_bits);
  75 unsigned dm_table_get_type(struct dm_table *t);
  76 struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
  77 struct dm_target *dm_table_get_immutable_target(struct dm_table *t);
  78 struct dm_target *dm_table_get_wildcard_target(struct dm_table *t);
  79 bool dm_table_request_based(struct dm_table *t);
  80 bool dm_table_mq_request_based(struct dm_table *t);
  81 void dm_table_free_md_mempools(struct dm_table *t);
  82 struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
  83
  84 void dm_lock_md_type(struct mapped_device *md);
  85 void dm_unlock_md_type(struct mapped_device *md);
  86 void dm_set_md_type(struct mapped_device *md, unsigned type);
  87 unsigned dm_get_md_type(struct mapped_device *md);
  88 struct target_type *dm_get_immutable_target_type(struct mapped_device *md);
  89
  90 int dm_setup_md_queue(struct mapped_device *md, struct dm_table *t);
  91
  92 /*
  93  * To check the return value from dm_table_find_target().
  94  */
  95 #define dm_target_is_valid(t) ((t)->table)
  96
  97 /*
  98  * To check whether the target type is bio-based or not (request-based).
  99  */
 100 #define dm_target_bio_based(t) ((t)->type->map != NULL)
 101
 102 /*
 103  * To check whether the target type is request-based or not (bio-based).
 104  */
 105 #define dm_target_request_based(t) (((t)->type->map_rq != NULL) || \
 106                                     ((t)->type->clone_and_map_rq != NULL))
 107
 108 /*
 109  * To check whether the target type is a hybrid (capable of being
 110  * either request-based or bio-based).
 111  */
 112 #define dm_target_hybrid(t) (dm_target_bio_based(t) && dm_target_request_based(t))
 113
 114 /*-----------------------------------------------------------------
 115  * A registry of target types.
 116  *---------------------------------------------------------------*/
 117 int dm_target_init(void);
 118 void dm_target_exit(void);
 119 struct target_type *dm_get_target_type(const char *name);
 120 void dm_put_target_type(struct target_type *tt);
 121 int dm_target_iterate(void (*iter_func)(struct target_type *tt,
 122                                         void *param), void *param);
 123
 124 int dm_split_args(int *argc, char ***argvp, char *input);
 125
 126 /*
 127  * Is this mapped_device being deleted?
 128  */
 129 int dm_deleting_md(struct mapped_device *md);
 130
 131 /*
 132  * Is this mapped_device suspended?
 133  */
 134 int dm_suspended_md(struct mapped_device *md);
 135
 136 /*
 137  * Internal suspend and resume methods.
 138  */
 139 int dm_suspended_internally_md(struct mapped_device *md);
 140 void dm_internal_suspend_fast(struct mapped_device *md);
 141 void dm_internal_resume_fast(struct mapped_device *md);
 142 void dm_internal_suspend_noflush(struct mapped_device *md);
 143 void dm_internal_resume(struct mapped_device *md);
 144
 145 /*
 146  * Test if the device is scheduled for deferred remove.
 147  */
 148 int dm_test_deferred_remove_flag(struct mapped_device *md);
 149
 150 /*
 151  * Try to remove devices marked for deferred removal.
 152  */
 153 void dm_deferred_remove(void);
 154
 155 /*
 156  * The device-mapper can be driven through one of two interfaces;
 157  * ioctl or filesystem, depending which patch you have applied.
 158  */
 159 int dm_interface_init(void);
 160 void dm_interface_exit(void);
 161
 162 /*
 163  * sysfs interface
 164  */
 165 int dm_sysfs_init(struct mapped_device *md);
 166 void dm_sysfs_exit(struct mapped_device *md);
 167 struct kobject *dm_kobject(struct mapped_device *md);
 168 struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
 169
 170 /*
 171  * The kobject helper
 172  */
 173 void dm_kobject_release(struct kobject *kobj);
 174
 175 /*
 176  * Targets for linear and striped mappings
 177  */
 178 int dm_linear_init(void);
 179 void dm_linear_exit(void);
 180
 181 int dm_stripe_init(void);
 182 void dm_stripe_exit(void);
 183
 184 /*
 185  * mapped_device operations
 186  */
 187 void dm_destroy(struct mapped_device *md);
 188 void dm_destroy_immediate(struct mapped_device *md);
 189 int dm_open_count(struct mapped_device *md);
 190 int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred);
 191 int dm_cancel_deferred_remove(struct mapped_device *md);
 192 int dm_request_based(struct mapped_device *md);
 193 sector_t dm_get_size(struct mapped_device *md);
 194 struct request_queue *dm_get_md_queue(struct mapped_device *md);
 195 int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
 196                         struct dm_dev **result);
 197 void dm_put_table_device(struct mapped_device *md, struct dm_dev *d);
 198 struct dm_stats *dm_get_stats(struct mapped_device *md);
 199
 200 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
 201                       unsigned cookie);
 202
 203 void dm_internal_suspend(struct mapped_device *md);
 204 void dm_internal_resume(struct mapped_device *md);
 205
 206 int dm_io_init(void);
 207 void dm_io_exit(void);
 208
 209 int dm_kcopyd_init(void);
 210 void dm_kcopyd_exit(void);
 211
 212 /*
 213  * Mempool operations
 214  */
 215 struct dm_md_mempools *dm_alloc_md_mempools(struct mapped_device *md, unsigned type,
 216                                             unsigned integrity, unsigned per_bio_data_size);
 217 void dm_free_md_mempools(struct dm_md_mempools *pools);
 218
 219 /*
 220  * Various helpers
 221  */
 222 unsigned dm_get_reserved_bio_based_ios(void);
 223
 224 #endif