xref: /illumos-gate/usr/src/cmd/zonecfg/zonecfg.h (revision 09295472)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 
22 /*
23  * Copyright 2006 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef _ZONECFG_H
28 #define	_ZONECFG_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 /*
33  * header file for zonecfg command
34  */
35 
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39 
40 #include <unistd.h>
41 
42 #define	FALSE	0
43 #define	TRUE	1
44 
45 typedef int bool;
46 
47 #define	Z_ERR		1
48 #define	Z_USAGE		2
49 #define	Z_REPEAT	3
50 
51 #define	CMD_ADD		0
52 #define	CMD_CANCEL	1
53 #define	CMD_COMMIT	2
54 #define	CMD_CREATE	3
55 #define	CMD_DELETE	4
56 #define	CMD_END		5
57 #define	CMD_EXIT	6
58 #define	CMD_EXPORT	7
59 #define	CMD_HELP	8
60 #define	CMD_INFO	9
61 #define	CMD_REMOVE	10
62 #define	CMD_REVERT	11
63 #define	CMD_SELECT	12
64 #define	CMD_SET		13
65 #define	CMD_VERIFY	14
66 
67 #define	CMD_MIN		CMD_ADD
68 #define	CMD_MAX		CMD_VERIFY
69 
70 /* resource types: increment RT_MAX when expanding this list */
71 #define	RT_UNKNOWN	0
72 #define	RT_ZONENAME	1	/* really a property, but for info ... */
73 #define	RT_ZONEPATH	2	/* really a property, but for info ... */
74 #define	RT_AUTOBOOT	3	/* really a property, but for info ... */
75 #define	RT_POOL		4	/* really a property, but for info ... */
76 #define	RT_FS		5
77 #define	RT_IPD		6
78 #define	RT_NET		7
79 #define	RT_DEVICE	8
80 #define	RT_RCTL		9
81 #define	RT_ATTR		10
82 #define	RT_DATASET	11
83 #define	RT_LIMITPRIV	12	/* really a property, but for info ... */
84 
85 #define	RT_MIN		RT_UNKNOWN
86 #define	RT_MAX		RT_LIMITPRIV
87 
88 /* property types: increment PT_MAX when expanding this list */
89 #define	PT_UNKNOWN	0
90 #define	PT_ZONENAME	1
91 #define	PT_ZONEPATH	2
92 #define	PT_AUTOBOOT	3
93 #define	PT_POOL		4
94 #define	PT_DIR		5
95 #define	PT_SPECIAL	6
96 #define	PT_TYPE		7
97 #define	PT_OPTIONS	8
98 #define	PT_ADDRESS	9
99 #define	PT_PHYSICAL	10
100 #define	PT_NAME		11
101 #define	PT_VALUE	12
102 #define	PT_MATCH	13
103 #define	PT_PRIV		14
104 #define	PT_LIMIT	15
105 #define	PT_ACTION	16
106 #define	PT_RAW		17
107 #define	PT_LIMITPRIV	18
108 
109 #define	PT_MIN		PT_UNKNOWN
110 #define	PT_MAX		PT_LIMITPRIV
111 
112 #define	MAX_EQ_PROP_PAIRS	3
113 
114 #define	PROP_VAL_SIMPLE		0
115 #define	PROP_VAL_COMPLEX	1
116 #define	PROP_VAL_LIST		2
117 
118 #define	PROP_VAL_MIN		PROP_VAL_SIMPLE
119 #define	PROP_VAL_MAX		PROP_VAL_LIST
120 
121 /*
122  * If any subcommand is ever modified to take more than three arguments,
123  * this will need to be incremented.
124  */
125 #define	MAX_SUBCMD_ARGS		3
126 
127 typedef struct complex_property {
128 	int	cp_type;	/* from the PT_* list above */
129 	char	*cp_value;
130 	struct complex_property *cp_next;
131 } complex_property_t, *complex_property_ptr_t;
132 
133 typedef struct list_property {
134 	char	*lp_simple;
135 	complex_property_ptr_t	lp_complex;
136 	struct list_property	*lp_next;
137 } list_property_t, *list_property_ptr_t;
138 
139 typedef struct property_value {
140 	int	pv_type;	/* from the PROP_VAL_* list above */
141 	char	*pv_simple;
142 	complex_property_ptr_t	pv_complex;
143 	list_property_ptr_t	pv_list;
144 } property_value_t, *property_value_ptr_t;
145 
146 typedef struct cmd {
147 	char	*cmd_name;
148 	void	(*cmd_handler)(struct cmd *);
149 	int	cmd_res_type;
150 	int	cmd_prop_nv_pairs;
151 	int	cmd_prop_name[MAX_EQ_PROP_PAIRS];
152 	property_value_ptr_t	cmd_property_ptr[MAX_EQ_PROP_PAIRS];
153 	int	cmd_argc;
154 	char	*cmd_argv[MAX_SUBCMD_ARGS + 1];
155 } cmd_t;
156 
157 #define	HELP_USAGE	0x01
158 #define	HELP_SUBCMDS	0x02
159 #define	HELP_SYNTAX	0x04
160 #define	HELP_RESOURCES	0x08
161 #define	HELP_PROPS	0x10
162 #define	HELP_META	0x20
163 #define	HELP_NETADDR	0x40
164 #define	HELP_RES_SCOPE	0x80
165 
166 #define	HELP_RES_PROPS	(HELP_RESOURCES | HELP_PROPS)
167 
168 extern void add_func(cmd_t *);
169 extern void cancel_func(cmd_t *);
170 extern void commit_func(cmd_t *);
171 extern void create_func(cmd_t *);
172 extern void delete_func(cmd_t *);
173 extern void end_func(cmd_t *);
174 extern void exit_func(cmd_t *);
175 extern void export_func(cmd_t *);
176 extern void help_func(cmd_t *);
177 extern void info_func(cmd_t *);
178 extern void remove_func(cmd_t *);
179 extern void revert_func(cmd_t *);
180 extern void select_func(cmd_t *);
181 extern void set_func(cmd_t *);
182 extern void verify_func(cmd_t *);
183 
184 extern cmd_t *alloc_cmd(void);
185 extern complex_property_ptr_t alloc_complex(void);
186 extern list_property_ptr_t alloc_list(void);
187 extern void free_cmd(cmd_t *cmd);
188 extern void free_complex(complex_property_ptr_t complex);
189 extern void free_list(list_property_ptr_t list);
190 extern void free_outer_list(list_property_ptr_t list);
191 
192 extern void usage(bool verbose, uint_t flags);
193 
194 extern FILE *yyin;
195 
196 #ifdef __cplusplus
197 }
198 #endif
199 
200 #endif	/* _ZONECFG_H */
201