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