xref: /freebsd/sbin/geom/core/geom.h (revision 5ca8e32633c4ffbbcd6762e5888b6a4ba0708c6c)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2004 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 _GEOM_H_
30 #define	_GEOM_H_
31 #define	G_LIB_VERSION	5
32 
33 /*
34  * The G_FLAG_VERBOSE flag on a command specification means that the
35  * command will accept a -v option and the GEOM framework will print
36  * out status information after the command when it is run with -v.
37  * Additionally a GEOM command can explicitly specify a -v option and
38  * handle it as it would any other option. If both a -v option and
39  * G_FLAG_VERBOSE are specified for a command then both types of verbose
40  * information will be output when that command is run with -v.
41  *
42  * When the G_FLAG_LOADKLD is specified for a command, the GEOM kernel
43  * module will be loaded when that command is run if it has not yet been
44  * loaded. This flag is typically specified for the `create' command.
45  */
46 #define	G_FLAG_NONE	0x0000
47 #define	G_FLAG_VERBOSE	0x0001
48 #define	G_FLAG_LOADKLD	0x0002
49 
50 #define	G_TYPE_NONE	0x00
51 #define	G_TYPE_BOOL	0x01
52 #define	G_TYPE_STRING	0x02
53 #define	G_TYPE_NUMBER	0x03
54 #define	G_TYPE_MASK	0x0f
55 #define	G_TYPE_DONE	0x10
56 #define	G_TYPE_MULTI	0x20
57 #define	G_TYPE_NUMMASK	0xff00
58 #define	G_TYPE_NUMSHIFT	8
59 
60 #define	G_OPT_MAX	16
61 #define	G_OPT_DONE(opt)		do { (opt)->go_type |= G_TYPE_DONE; } while (0)
62 #define	G_OPT_ISDONE(opt)	((opt)->go_type & G_TYPE_DONE)
63 #define	G_OPT_ISMULTI(opt)	((opt)->go_type & G_TYPE_MULTI)
64 #define	G_OPT_TYPE(opt)		((opt)->go_type & G_TYPE_MASK)
65 #define	G_OPT_NUM(opt)		(((opt)->go_type & G_TYPE_NUMMASK) >> G_TYPE_NUMSHIFT)
66 #define	G_OPT_NUMINC(opt)	((opt)->go_type += (1 << G_TYPE_NUMSHIFT))
67 
68 #define	G_VAL_OPTIONAL	((void *)-1)
69 
70 #define G_OPT_SENTINEL	{ '\0', NULL, NULL, G_TYPE_NONE }
71 #define G_NULL_OPTS	{ G_OPT_SENTINEL }
72 #define	G_CMD_SENTINEL	{ NULL, 0, NULL, G_NULL_OPTS, NULL }
73 
74 struct g_option {
75 	char		 go_char;
76 	const char	*go_name;
77 	const void	*go_val;
78 	unsigned	 go_type;
79 };
80 
81 struct g_command {
82 	const char	*gc_name;
83 	unsigned	 gc_flags;
84 	void		(*gc_func)(struct gctl_req *, unsigned);
85 	struct g_option	gc_options[G_OPT_MAX];
86 	const char	*gc_usage;
87 };
88 #endif	/* !_GEOM_H_ */
89