[deliverable/linux.git] / drivers / md / dm.h

/*
 * Internal header file for device mapper
 *
 * Copyright (C) 2001, 2002 Sistina Software
 * Copyright (C) 2004-2006 Red Hat, Inc. All rights reserved.
 *
 * This file is released under the LGPL.
 */

#ifndef DM_INTERNAL_H
#define DM_INTERNAL_H

#include <linux/fs.h>
#include <linux/device-mapper.h>
#include <linux/list.h>
#include <linux/blkdev.h>
#include <linux/hdreg.h>

/*
 * Suspend feature flags
 */
#define DM_SUSPEND_LOCKFS_FLAG		(1 << 0)
#define DM_SUSPEND_NOFLUSH_FLAG		(1 << 1)

/*
 * Status feature flags
 */
#define DM_STATUS_NOFLUSH_FLAG		(1 << 0)

/*
 * Type of table and mapped_device's mempool
 */
#define DM_TYPE_NONE		0
#define DM_TYPE_BIO_BASED	1
#define DM_TYPE_REQUEST_BASED	2

/*
 * List of devices that a metadevice uses and should open/close.
 */
struct dm_dev_internal {
	struct list_head list;
	atomic_t count;
	struct dm_dev dm_dev;
};

struct dm_table;
struct dm_md_mempools;

/*-----------------------------------------------------------------
 * Internal table functions.
 *---------------------------------------------------------------*/
void dm_table_destroy(struct dm_table *t);
void dm_table_event_callback(struct dm_table *t,
			     void (*fn)(void *), void *context);
struct dm_target *dm_table_get_target(struct dm_table *t, unsigned int index);
struct dm_target *dm_table_find_target(struct dm_table *t, sector_t sector);
bool dm_table_has_no_data_devices(struct dm_table *table);
int dm_calculate_queue_limits(struct dm_table *table,
			      struct queue_limits *limits);
void dm_table_set_restrictions(struct dm_table *t, struct request_queue *q,
			       struct queue_limits *limits);
struct list_head *dm_table_get_devices(struct dm_table *t);
void dm_table_presuspend_targets(struct dm_table *t);
void dm_table_postsuspend_targets(struct dm_table *t);
int dm_table_resume_targets(struct dm_table *t);
int dm_table_any_congested(struct dm_table *t, int bdi_bits);
int dm_table_any_busy_target(struct dm_table *t);
unsigned dm_table_get_type(struct dm_table *t);
struct target_type *dm_table_get_immutable_target_type(struct dm_table *t);
bool dm_table_request_based(struct dm_table *t);
bool dm_table_supports_discards(struct dm_table *t);
int dm_table_alloc_md_mempools(struct dm_table *t);
void dm_table_free_md_mempools(struct dm_table *t);
struct dm_md_mempools *dm_table_get_md_mempools(struct dm_table *t);

int dm_queue_merge_is_compulsory(struct request_queue *q);

void dm_lock_md_type(struct mapped_device *md);
void dm_unlock_md_type(struct mapped_device *md);
void dm_set_md_type(struct mapped_device *md, unsigned type);
unsigned dm_get_md_type(struct mapped_device *md);
struct target_type *dm_get_immutable_target_type(struct mapped_device *md);

int dm_setup_md_queue(struct mapped_device *md);

/*
 * To check the return value from dm_table_find_target().
 */
#define dm_target_is_valid(t) ((t)->table)

/*
 * To check whether the target type is request-based or not (bio-based).
 */
#define dm_target_request_based(t) ((t)->type->map_rq != NULL)

/*-----------------------------------------------------------------
 * A registry of target types.
 *---------------------------------------------------------------*/
int dm_target_init(void);
void dm_target_exit(void);
struct target_type *dm_get_target_type(const char *name);
void dm_put_target_type(struct target_type *tt);
int dm_target_iterate(void (*iter_func)(struct target_type *tt,
					void *param), void *param);

int dm_split_args(int *argc, char ***argvp, char *input);

/*
 * Is this mapped_device being deleted?
 */
int dm_deleting_md(struct mapped_device *md);

/*
 * Is this mapped_device suspended?
 */
int dm_suspended_md(struct mapped_device *md);

/*
 * The device-mapper can be driven through one of two interfaces;
 * ioctl or filesystem, depending which patch you have applied.
 */
int dm_interface_init(void);
void dm_interface_exit(void);

/*
 * sysfs interface
 */
int dm_sysfs_init(struct mapped_device *md);
void dm_sysfs_exit(struct mapped_device *md);
struct kobject *dm_kobject(struct mapped_device *md);
struct mapped_device *dm_get_from_kobject(struct kobject *kobj);

/*
 * Targets for linear and striped mappings
 */
int dm_linear_init(void);
void dm_linear_exit(void);

int dm_stripe_init(void);
void dm_stripe_exit(void);

/*
 * mapped_device operations
 */
void dm_destroy(struct mapped_device *md);
void dm_destroy_immediate(struct mapped_device *md);
int dm_open_count(struct mapped_device *md);
int dm_lock_for_deletion(struct mapped_device *md);

int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
		      unsigned cookie);

int dm_io_init(void);
void dm_io_exit(void);

int dm_kcopyd_init(void);
void dm_kcopyd_exit(void);

/*
 * Mempool operations
 */
struct dm_md_mempools *dm_alloc_md_mempools(unsigned type, unsigned integrity, unsigned per_bio_data_size);
void dm_free_md_mempools(struct dm_md_mempools *pools);

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