xref: /linux-6.15/include/linux/dm-io.h (revision a765e20e)
1*a765e20eSAlasdair G Kergon /*
2*a765e20eSAlasdair G Kergon  * Copyright (C) 2003 Sistina Software
3*a765e20eSAlasdair G Kergon  * Copyright (C) 2004 - 2008 Red Hat, Inc. All rights reserved.
4*a765e20eSAlasdair G Kergon  *
5*a765e20eSAlasdair G Kergon  * Device-Mapper low-level I/O.
6*a765e20eSAlasdair G Kergon  *
7*a765e20eSAlasdair G Kergon  * This file is released under the GPL.
8*a765e20eSAlasdair G Kergon  */
9*a765e20eSAlasdair G Kergon 
10*a765e20eSAlasdair G Kergon #ifndef _LINUX_DM_IO_H
11*a765e20eSAlasdair G Kergon #define _LINUX_DM_IO_H
12*a765e20eSAlasdair G Kergon 
13*a765e20eSAlasdair G Kergon #ifdef __KERNEL__
14*a765e20eSAlasdair G Kergon 
15*a765e20eSAlasdair G Kergon #include <linux/types.h>
16*a765e20eSAlasdair G Kergon 
17*a765e20eSAlasdair G Kergon struct dm_io_region {
18*a765e20eSAlasdair G Kergon 	struct block_device *bdev;
19*a765e20eSAlasdair G Kergon 	sector_t sector;
20*a765e20eSAlasdair G Kergon 	sector_t count;		/* If this is zero the region is ignored. */
21*a765e20eSAlasdair G Kergon };
22*a765e20eSAlasdair G Kergon 
23*a765e20eSAlasdair G Kergon struct page_list {
24*a765e20eSAlasdair G Kergon 	struct page_list *next;
25*a765e20eSAlasdair G Kergon 	struct page *page;
26*a765e20eSAlasdair G Kergon };
27*a765e20eSAlasdair G Kergon 
28*a765e20eSAlasdair G Kergon typedef void (*io_notify_fn)(unsigned long error, void *context);
29*a765e20eSAlasdair G Kergon 
30*a765e20eSAlasdair G Kergon enum dm_io_mem_type {
31*a765e20eSAlasdair G Kergon 	DM_IO_PAGE_LIST,/* Page list */
32*a765e20eSAlasdair G Kergon 	DM_IO_BVEC,	/* Bio vector */
33*a765e20eSAlasdair G Kergon 	DM_IO_VMA,	/* Virtual memory area */
34*a765e20eSAlasdair G Kergon 	DM_IO_KMEM,	/* Kernel memory */
35*a765e20eSAlasdair G Kergon };
36*a765e20eSAlasdair G Kergon 
37*a765e20eSAlasdair G Kergon struct dm_io_memory {
38*a765e20eSAlasdair G Kergon 	enum dm_io_mem_type type;
39*a765e20eSAlasdair G Kergon 
40*a765e20eSAlasdair G Kergon 	union {
41*a765e20eSAlasdair G Kergon 		struct page_list *pl;
42*a765e20eSAlasdair G Kergon 		struct bio_vec *bvec;
43*a765e20eSAlasdair G Kergon 		void *vma;
44*a765e20eSAlasdair G Kergon 		void *addr;
45*a765e20eSAlasdair G Kergon 	} ptr;
46*a765e20eSAlasdair G Kergon 
47*a765e20eSAlasdair G Kergon 	unsigned offset;
48*a765e20eSAlasdair G Kergon };
49*a765e20eSAlasdair G Kergon 
50*a765e20eSAlasdair G Kergon struct dm_io_notify {
51*a765e20eSAlasdair G Kergon 	io_notify_fn fn;	/* Callback for asynchronous requests */
52*a765e20eSAlasdair G Kergon 	void *context;		/* Passed to callback */
53*a765e20eSAlasdair G Kergon };
54*a765e20eSAlasdair G Kergon 
55*a765e20eSAlasdair G Kergon /*
56*a765e20eSAlasdair G Kergon  * IO request structure
57*a765e20eSAlasdair G Kergon  */
58*a765e20eSAlasdair G Kergon struct dm_io_client;
59*a765e20eSAlasdair G Kergon struct dm_io_request {
60*a765e20eSAlasdair G Kergon 	int bi_rw;			/* READ|WRITE - not READA */
61*a765e20eSAlasdair G Kergon 	struct dm_io_memory mem;	/* Memory to use for io */
62*a765e20eSAlasdair G Kergon 	struct dm_io_notify notify;	/* Synchronous if notify.fn is NULL */
63*a765e20eSAlasdair G Kergon 	struct dm_io_client *client;	/* Client memory handler */
64*a765e20eSAlasdair G Kergon };
65*a765e20eSAlasdair G Kergon 
66*a765e20eSAlasdair G Kergon /*
67*a765e20eSAlasdair G Kergon  * For async io calls, users can alternatively use the dm_io() function below
68*a765e20eSAlasdair G Kergon  * and dm_io_client_create() to create private mempools for the client.
69*a765e20eSAlasdair G Kergon  *
70*a765e20eSAlasdair G Kergon  * Create/destroy may block.
71*a765e20eSAlasdair G Kergon  */
72*a765e20eSAlasdair G Kergon struct dm_io_client *dm_io_client_create(unsigned num_pages);
73*a765e20eSAlasdair G Kergon int dm_io_client_resize(unsigned num_pages, struct dm_io_client *client);
74*a765e20eSAlasdair G Kergon void dm_io_client_destroy(struct dm_io_client *client);
75*a765e20eSAlasdair G Kergon 
76*a765e20eSAlasdair G Kergon /*
77*a765e20eSAlasdair G Kergon  * IO interface using private per-client pools.
78*a765e20eSAlasdair G Kergon  * Each bit in the optional 'sync_error_bits' bitset indicates whether an
79*a765e20eSAlasdair G Kergon  * error occurred doing io to the corresponding region.
80*a765e20eSAlasdair G Kergon  */
81*a765e20eSAlasdair G Kergon int dm_io(struct dm_io_request *io_req, unsigned num_regions,
82*a765e20eSAlasdair G Kergon 	  struct dm_io_region *region, unsigned long *sync_error_bits);
83*a765e20eSAlasdair G Kergon 
84*a765e20eSAlasdair G Kergon #endif	/* __KERNEL__ */
85*a765e20eSAlasdair G Kergon #endif	/* _LINUX_DM_IO_H */
86