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