geom.h revision 212547
1/*-
2 * Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 *    notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 *    notice, this list of conditions and the following disclaimer in the
12 *    documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
26 * $FreeBSD: head/sbin/geom/core/geom.h 212547 2010-09-13 08:56:07Z pjd $
27 */
28
29#ifndef _GEOM_H_
30#define	_GEOM_H_
31#define	G_LIB_VERSION	4
32
33#define	G_FLAG_NONE	0x0000
34#define	G_FLAG_VERBOSE	0x0001
35#define	G_FLAG_LOADKLD	0x0002
36
37#define	G_TYPE_NONE	0x00
38#define	G_TYPE_BOOL	0x01
39#define	G_TYPE_STRING	0x02
40#define	G_TYPE_NUMBER	0x03
41#define	G_TYPE_ASCNUM	0x04
42#define	G_TYPE_MASK	0x0f
43#define	G_TYPE_DONE	0x10
44
45#define	G_OPT_MAX	16
46#define	G_OPT_DONE(opt)		do { (opt)->go_type |= G_TYPE_DONE; } while (0)
47#define	G_OPT_ISDONE(opt)	((opt)->go_type & G_TYPE_DONE)
48#define	G_OPT_TYPE(opt)		((opt)->go_type & G_TYPE_MASK)
49
50#define G_OPT_SENTINEL	{ '\0', NULL, NULL, G_TYPE_NONE }
51#define G_NULL_OPTS	{ G_OPT_SENTINEL }
52#define	G_CMD_SENTINEL	{ NULL, 0, NULL, G_NULL_OPTS, NULL, NULL }
53
54struct g_option {
55	char		 go_char;
56	const char	*go_name;
57	const void	*go_val;
58	unsigned	 go_type;
59};
60
61struct g_command {
62	const char	*gc_name;
63	unsigned	 gc_flags;
64	void		(*gc_func)(struct gctl_req *, unsigned);
65	struct g_option	gc_options[G_OPT_MAX];
66	const char	*gc_argname;
67	const char	*gc_usage;
68};
69#endif	/* !_GEOM_H_ */
70