1/*-
2 * SPDX-License-Identifier: BSD-2-Clause
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
29#ifndef	_G_NOP_H_
30#define	_G_NOP_H_
31
32#define	G_NOP_CLASS_NAME	"NOP"
33#define	G_NOP_VERSION		4
34#define	G_NOP_SUFFIX		".nop"
35/*
36 * Special flag to instruct gnop to passthrough the underlying provider's
37 * physical path
38 */
39#define G_NOP_PHYSPATH_PASSTHROUGH "\255"
40
41#ifdef _KERNEL
42#define	G_NOP_DEBUG(lvl, ...) \
43    _GEOM_DEBUG("GEOM_NOP", g_nop_debug, (lvl), NULL, __VA_ARGS__)
44#define G_NOP_LOGREQLVL(lvl, bp, ...) \
45    _GEOM_DEBUG("GEOM_NOP", g_nop_debug, (lvl), (bp), __VA_ARGS__)
46#define	G_NOP_LOGREQ(bp, ...)	G_NOP_LOGREQLVL(2, bp, __VA_ARGS__)
47
48struct g_nop_delay;
49
50TAILQ_HEAD(g_nop_delay_head, g_nop_delay);
51
52struct g_nop_softc {
53	int			 sc_error;
54	off_t			 sc_offset;
55	off_t			 sc_explicitsize;
56	off_t			 sc_stripesize;
57	off_t			 sc_stripeoffset;
58	u_int			 sc_rfailprob;
59	u_int			 sc_wfailprob;
60	u_int			 sc_delaymsec;
61	u_int			 sc_rdelayprob;
62	u_int			 sc_wdelayprob;
63	u_int			 sc_count_until_fail;
64	uintmax_t		 sc_reads;
65	uintmax_t		 sc_writes;
66	uintmax_t		 sc_deletes;
67	uintmax_t		 sc_getattrs;
68	uintmax_t		 sc_flushes;
69	uintmax_t		 sc_cmd0s;
70	uintmax_t		 sc_cmd1s;
71	uintmax_t		 sc_cmd2s;
72	uintmax_t		 sc_speedups;
73	uintmax_t		 sc_readbytes;
74	uintmax_t		 sc_wrotebytes;
75	char			*sc_physpath;
76	struct mtx		 sc_lock;
77	struct g_nop_delay_head	 sc_head_delay;
78};
79#endif	/* _KERNEL */
80
81#endif	/* _G_NOP_H_ */
82