xref: /freebsd/sys/geom/virstor/g_virstor.h (revision 3cbb4cc200f8a0ad7ed08233425ea54524a21f1c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2006-2007 Ivan Voras <ivoras@freebsd.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  * $FreeBSD$
29  */
30 
31 #ifndef _G_VIRSTOR_H_
32 #define _G_VIRSTOR_H_
33 
34 #define	G_VIRSTOR_CLASS_NAME "VIRSTOR"
35 
36 #define VIRSTOR_MAP_ALLOCATED 1
37 struct virstor_map_entry {
38 	uint16_t	flags;
39 	uint16_t	provider_no;
40 	uint32_t	provider_chunk;
41 };
42 
43 #define	VIRSTOR_MAP_ENTRY_SIZE (sizeof(struct virstor_map_entry))
44 #define	VIRSTOR_MAP_BLOCK_ENTRIES (MAXPHYS / VIRSTOR_MAP_ENTRY_SIZE)
45 /* Struct size is guarded by CTASSERT in main source */
46 
47 #ifdef _KERNEL
48 
49 #define	LOG_MSG(lvl, ...) \
50     _GEOM_DEBUG("GEOM_VIRSTOR", g_virstor_debug, (lvl), NULL, __VA_ARGS__)
51 #define	LOG_MESSAGE LOG_MSG
52 
53 #define	LOG_REQ(lvl, bp, ...) \
54     _GEOM_DEBUG("GEOM_VIRSTOR", g_virstor_debug, (lvl), (bp), __VA_ARGS__)
55 #define	LOG_REQUEST LOG_REQ
56 
57 /* "critical" system announcements (e.g. "geom is up") */
58 #define	LVL_ANNOUNCE	0
59 /* errors */
60 #define	LVL_ERROR	1
61 /* warnings */
62 #define	LVL_WARNING	2
63 /* info, noncritical for system operation (user doesn't have to see it */
64 #define	LVL_INFO	5
65 /* debug info */
66 #define	LVL_DEBUG	10
67 /* more debug info */
68 #define	LVL_DEBUG2	12
69 /* superfluous debug info (large volumes of data) */
70 #define	LVL_MOREDEBUG	15
71 
72 /* Component data */
73 struct g_virstor_component {
74 	struct g_consumer	*gcons;
75 	struct g_virstor_softc	*sc;
76 	unsigned int		 index;		/* Component index in array */
77 	unsigned int		 chunk_count;
78 	unsigned int		 chunk_next;
79 	unsigned int		 chunk_reserved;
80 	unsigned int		 flags;
81 };
82 
83 /* Internal geom instance data */
84 struct g_virstor_softc {
85 	struct g_geom		*geom;
86 	struct g_provider	*provider;
87 	struct g_virstor_component *components;
88 	u_int			 n_components;
89 	u_int			 curr_component; /* Component currently used */
90 	uint32_t		 id;		/* Unique ID of this geom */
91 	off_t			 virsize;	/* Total size of virstor */
92 	off_t			 sectorsize;
93 	size_t			 chunk_size;
94 	size_t			 chunk_count;	/* governs map_size */
95 	struct virstor_map_entry *map;
96 	size_t			 map_size;	/* (in bytes) */
97 	size_t			 map_sectors;	/* Size of map in sectors */
98 	size_t			 me_per_sector;	/* # map entries in a sector */
99 	STAILQ_HEAD(, g_virstor_bio_q)	 delayed_bio_q;	/* Queue of delayed BIOs */
100 	struct mtx		 delayed_bio_q_mtx;
101 };
102 
103 /* "delayed BIOs" Queue element */
104 struct g_virstor_bio_q {
105 	struct bio		*bio;
106 	STAILQ_ENTRY(g_virstor_bio_q) linkage;
107 };
108 
109 #endif	/* _KERNEL */
110 
111 #endif	/* !_G_VIRSTOR_H_ */
112