[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)

/*
 * 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);
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);
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);

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