xref: /freebsd/sys/geom/nop/g_nop.h (revision 54e9e4e72d711fb41f88f793f6c64df1126112f9)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
3  *
4  * Copyright (c) 2004-2006 Pawel Jakub Dawidek <pjd@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_NOP_H_
32 #define	_G_NOP_H_
33 
34 #define	G_NOP_CLASS_NAME	"NOP"
35 #define	G_NOP_VERSION		4
36 #define	G_NOP_SUFFIX		".nop"
37 /*
38  * Special flag to instruct gnop to passthrough the underlying provider's
39  * physical path
40  */
41 #define G_NOP_PHYSPATH_PASSTHROUGH "\255"
42 
43 #ifdef _KERNEL
44 #define	G_NOP_DEBUG(lvl, ...)	do {					\
45 	if (g_nop_debug >= (lvl)) {					\
46 		printf("GEOM_NOP");					\
47 		if (g_nop_debug > 0)					\
48 			printf("[%u]", lvl);				\
49 		printf(": ");						\
50 		printf(__VA_ARGS__);					\
51 		printf("\n");						\
52 	}								\
53 } while (0)
54 #define	G_NOP_LOGREQ(bp, ...)	G_NOP_LOGREQLVL(2, bp, __VA_ARGS__)
55 #define G_NOP_LOGREQLVL(lvl, bp, ...) do {				\
56 	if (g_nop_debug >= (lvl)) {					\
57 		printf("GEOM_NOP[%d]: ", (lvl));			\
58 		printf(__VA_ARGS__);					\
59 		printf(" ");						\
60 		g_print_bio(bp);					\
61 		printf("\n");						\
62 	}								\
63 } while (0)
64 
65 struct g_nop_delay;
66 
67 TAILQ_HEAD(g_nop_delay_head, g_nop_delay);
68 
69 struct g_nop_softc {
70 	int			 sc_error;
71 	off_t			 sc_offset;
72 	off_t			 sc_explicitsize;
73 	off_t			 sc_stripesize;
74 	off_t			 sc_stripeoffset;
75 	u_int			 sc_rfailprob;
76 	u_int			 sc_wfailprob;
77 	u_int			 sc_delaymsec;
78 	u_int			 sc_rdelayprob;
79 	u_int			 sc_wdelayprob;
80 	uintmax_t		 sc_reads;
81 	uintmax_t		 sc_writes;
82 	uintmax_t		 sc_deletes;
83 	uintmax_t		 sc_getattrs;
84 	uintmax_t		 sc_flushes;
85 	uintmax_t		 sc_cmd0s;
86 	uintmax_t		 sc_cmd1s;
87 	uintmax_t		 sc_cmd2s;
88 	uintmax_t		 sc_readbytes;
89 	uintmax_t		 sc_wrotebytes;
90 	char			*sc_physpath;
91 	struct mtx		 sc_lock;
92 	struct g_nop_delay_head	 sc_head_delay;
93 };
94 #endif	/* _KERNEL */
95 
96 #endif	/* _G_NOP_H_ */
97