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/blkdev.h>
  17 #include <linux/hdreg.h>
  18 #include <linux/completion.h>
  19
  20 /*
  21  * Suspend feature flags
  22  */
  23 #define DM_SUSPEND_LOCKFS_FLAG          (1 << 0)
  24 #define DM_SUSPEND_NOFLUSH_FLAG         (1 << 1)
  25
  26 /*
  27  * Status feature flags
  28  */
  29 #define DM_STATUS_NOFLUSH_FLAG          (1 << 0)
  30
  31 /*
  32  * Type of table and mapped_device's mempool
  33  */
  34 #define DM_TYPE_NONE            0
  35 #define DM_TYPE_BIO_BASED       1
  36 #define DM_TYPE_REQUEST_BASED   2
  37
  38 /*
  39  * List of devices that a metadevice uses and should open/close.
  40  */
  41 struct dm_dev_internal {
  42         struct list_head list;
  43         atomic_t count;
  44         struct dm_dev dm_dev;
  45 };
  46
  47 struct dm_table;
  48 struct dm_md_mempools;
  49
  50 /*-----------------------------------------------------------------
  51  * Internal table functions.
  52  *---------------------------------------------------------------*/
  53 void dm_table_destroy(struct dm_table *t);
  54 void dm_table_event_callback(struct dm_table *t,
  55                              void (*fn)(void *), void *context);
  56 struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
  57 struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
  58 bool dm_table_has_no_data_devices(struct dm_table *table);
  59 int dm_calculate_queue_limits(struct dm_table *table,
  60                               struct queue_limits *limits);
  61 void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
  62                                struct queue_limits *limits);
  63 struct list_head *dm_table_get_devices(struct dm_table *t);
  64 void dm_table_presuspend_targets(struct dm_table *t);
  65 void dm_table_postsuspend_targets(struct dm_table *t);
  66 int dm_table_resume_targets(struct dm_table *t);
  67 int dm_table_any_congested(struct dm_table *t, int bdi_bits);
  68 int dm_table_any_busy_target(struct dm_table *t);
  69 unsigned dm_table_get_type(struct dm_table *t);
  70 struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
  71 bool dm_table_request_based(struct dm_table *t);
  72 bool dm_table_supports_discards(struct dm_table *t);
  73 int dm_table_alloc_md_mempools(struct dm_table *t);
  74 void dm_table_free_md_mempools(struct dm_table *t);
  75 struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);
  76
  77 int dm_queue_merge_is_compulsory(struct request_queue *q);
  78
  79 void dm_lock_md_type(struct mapped_device *md);
  80 void dm_unlock_md_type(struct mapped_device *md);
  81 void dm_set_md_type(struct mapped_device *md, unsigned type);
  82 unsigned dm_get_md_type(struct mapped_device *md);
  83 struct target_type *dm_get_immutable_target_type(struct mapped_device *md);
  84
  85 int dm_setup_md_queue(struct mapped_device *md);
  86
  87 /*
  88  * To check the return value from dm_table_find_target().
  89  */
  90 #define dm_target_is_valid(t) ((t)->table)
  91
  92 /*
  93  * To check whether the target type is request-based or not (bio-based).
  94  */
  95 #define dm_target_request_based(t) ((t)->type->map_rq != NULL)
  96
  97 /*-----------------------------------------------------------------
  98  * A registry of target types.
  99  *---------------------------------------------------------------*/
 100 int dm_target_init(void);
 101 void dm_target_exit(void);
 102 struct target_type *dm_get_target_type(const char *name);
 103 void dm_put_target_type(struct target_type *tt);
 104 int dm_target_iterate(void (*iter_func)(struct target_type *tt,
 105                                         void *param), void *param);
 106
 107 int dm_split_args(int *argc, char ***argvp, char *input);
 108
 109 /*
 110  * Is this mapped_device being deleted?
 111  */
 112 int dm_deleting_md(struct mapped_device *md);
 113
 114 /*
 115  * Is this mapped_device suspended?
 116  */
 117 int dm_suspended_md(struct mapped_device *md);
 118
 119 /*
 120  * The device-mapper can be driven through one of two interfaces;
 121  * ioctl or filesystem, depending which patch you have applied.
 122  */
 123 int dm_interface_init(void);
 124 void dm_interface_exit(void);
 125
 126 /*
 127  * sysfs interface
 128  */
 129 int dm_sysfs_init(struct mapped_device *md);
 130 void dm_sysfs_exit(struct mapped_device *md);
 131 struct kobject *dm_kobject(struct mapped_device *md);
 132 struct mapped_device *dm_get_from_kobject(struct kobject *kobj);
 133 struct completion *dm_get_completion_from_kobject(struct kobject *kobj);
 134
 135 /*
 136  * Targets for linear and striped mappings
 137  */
 138 int dm_linear_init(void);
 139 void dm_linear_exit(void);
 140
 141 int dm_stripe_init(void);
 142 void dm_stripe_exit(void);
 143
 144 /*
 145  * mapped_device operations
 146  */
 147 void dm_destroy(struct mapped_device *md);
 148 void dm_destroy_immediate(struct mapped_device *md);
 149 int dm_open_count(struct mapped_device *md);
 150 int dm_lock_for_deletion(struct mapped_device *md);
 151
 152 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
 153                       unsigned cookie);
 154
 155 int dm_io_init(void);
 156 void dm_io_exit(void);
 157
 158 int dm_kcopyd_init(void);
 159 void dm_kcopyd_exit(void);
 160
 161 /*
 162  * Mempool operations
 163  */
 164 struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity, unsigned per_bio_data_size);
 165 void dm_free_md_mempools(struct dm_md_mempools *pools);
 166
 167 #endif