1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/
/*
* Copyright 2005 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*/
#ifndef _LIBZONECFG_H
#define _LIBZONECFG_H
#pragma ident "%Z%%M% %I% %E% SMI"
/*
* Zone configuration header file.
*/
#ifdef __cplusplus
extern "C" {
#endif
/* sys/socket.h is required by net/if.h, which has a constant needed here */
#include <sys/param.h>
#include <sys/fstyp.h>
#include <sys/mount.h>
#include <priv.h>
#include <netinet/in.h>
#include <sys/socket.h>
#include <net/if.h>
#include <stdio.h>
#include <rctl.h>
#include <zone.h>
#include <sys/uuid.h>
#define ZONE_ID_UNDEFINED -1
#define Z_OK 0
#define Z_EMPTY_DOCUMENT 1 /* XML doc root element is null */
#define Z_WRONG_DOC_TYPE 2 /* top-level XML doc element != zone */
#define Z_BAD_PROPERTY 3 /* libxml-level property problem */
#define Z_TEMP_FILE 4 /* problem creating temporary file */
#define Z_SAVING_FILE 5 /* libxml error saving or validating */
#define Z_NO_ENTRY 6 /* no such entry */
#define Z_BOGUS_ZONE_NAME 7 /* illegal zone name */
#define Z_REQD_RESOURCE_MISSING 8 /* required resource missing */
#define Z_REQD_PROPERTY_MISSING 9 /* required property missing */
#define Z_BAD_HANDLE 10 /* bad document handle */
#define Z_NOMEM 11 /* out of memory (like ENOMEM) */
#define Z_INVAL 12 /* invalid argument (like EINVAL) */
#define Z_ACCES 13 /* permission denied (like EACCES) */
#define Z_TOO_BIG 14 /* string won't fit in char array */
#define Z_MISC_FS 15 /* miscellaneous file-system error */
#define Z_NO_ZONE 16 /* no such zone */
#define Z_NO_RESOURCE_TYPE 17 /* no/wrong resource type */
#define Z_NO_RESOURCE_ID 18 /* no/wrong resource id */
#define Z_NO_PROPERTY_TYPE 19 /* no/wrong property type */
#define Z_NO_PROPERTY_ID 20 /* no/wrong property id */
#define Z_BAD_ZONE_STATE 21 /* zone state invalid for given task */
#define Z_INVALID_DOCUMENT 22 /* libxml can't validate against DTD */
#define Z_NAME_IN_USE 23 /* zone name already in use (rename) */
#define Z_NO_SUCH_ID 24 /* delete_index: no old ID */
#define Z_UPDATING_INDEX 25 /* add/modify/delete_index problem */
#define Z_LOCKING_FILE 26 /* problem locking index file */
#define Z_UNLOCKING_FILE 27 /* problem unlocking index file */
#define Z_SYSTEM 28 /* consult errno instead */
#define Z_INSUFFICIENT_SPEC 29 /* resource insufficiently specified */
#define Z_RESOLVED_PATH 34 /* resolved path mismatch */
#define Z_IPV6_ADDR_PREFIX_LEN 35 /* IPv6 address prefix length needed */
#define Z_BOGUS_ADDRESS 36 /* not IPv[4|6] address or host name */
#define ZONE_STATE_CONFIGURED 0
#define ZONE_STATE_INCOMPLETE 1
#define ZONE_STATE_INSTALLED 2
#define ZONE_STATE_READY 3
#define ZONE_STATE_MOUNTED 4
#define ZONE_STATE_RUNNING 5
#define ZONE_STATE_SHUTTING_DOWN 6
#define ZONE_STATE_DOWN 7
#define ZONE_STATE_MAXSTRLEN 14
#define LIBZONECFG_PATH "libzonecfg.so.1"
#define ZONE_CONFIG_ROOT "/etc/zones"
#define ZONE_INDEX_FILE ZONE_CONFIG_ROOT "/index"
/*
* The integer field expresses the current values on a get.
* On a put, it represents the new values if >= 0 or "don't change" if < 0.
*/
struct zoneent {
char zone_name[ZONENAME_MAX]; /* name of the zone */
int zone_state; /* configured | incomplete | installed */
char zone_path[MAXPATHLEN]; /* path to zone storage */
uuid_t zone_uuid; /* unique ID for zone */
char zone_newname[ZONENAME_MAX]; /* for doing renames */
};
typedef struct zone_dochandle *zone_dochandle_t; /* opaque handle */
typedef uint_t zone_state_t;
typedef struct zone_fsopt {
struct zone_fsopt *zone_fsopt_next;
char zone_fsopt_opt[MAX_MNTOPT_STR];
} zone_fsopt_t;
struct zone_fstab {
char zone_fs_special[MAXPATHLEN]; /* special file */
char zone_fs_dir[MAXPATHLEN]; /* mount point */
char zone_fs_type[FSTYPSZ]; /* e.g. ufs */
zone_fsopt_t *zone_fs_options; /* mount options */
char zone_fs_raw[MAXPATHLEN]; /* device to fsck */
};
struct zone_nwiftab {
char zone_nwif_address[INET6_ADDRSTRLEN];
char zone_nwif_physical[LIFNAMSIZ];
};
struct zone_devtab {
char zone_dev_match[MAXPATHLEN];
};
struct zone_rctlvaltab {
char zone_rctlval_priv[MAXNAMELEN];
char zone_rctlval_limit[MAXNAMELEN];
char zone_rctlval_action[MAXNAMELEN];
struct zone_rctlvaltab *zone_rctlval_next;
};
struct zone_rctltab {
char zone_rctl_name[MAXNAMELEN];
struct zone_rctlvaltab *zone_rctl_valptr;
};
struct zone_attrtab {
char zone_attr_name[MAXNAMELEN];
char zone_attr_type[MAXNAMELEN];
char zone_attr_value[2 * BUFSIZ];
};
struct zone_dstab {
char zone_dataset_name[MAXNAMELEN];
};
/*
* Basic configuration management routines.
*/
extern zone_dochandle_t zonecfg_init_handle(void);
extern int zonecfg_get_handle(const char *, zone_dochandle_t);
extern int zonecfg_get_snapshot_handle(const char *, zone_dochandle_t);
extern int zonecfg_get_template_handle(const char *, const char *,
zone_dochandle_t);
extern int zonecfg_check_handle(zone_dochandle_t);
extern void zonecfg_fini_handle(zone_dochandle_t);
extern int zonecfg_destroy(const char *, boolean_t);
extern int zonecfg_destroy_snapshot(const char *);
extern int zonecfg_save(zone_dochandle_t);
extern int zonecfg_create_snapshot(const char *);
extern char *zonecfg_strerror(int);
extern int zonecfg_access(const char *, int);
extern void zonecfg_set_root(const char *);
extern const char *zonecfg_get_root(void);
extern boolean_t zonecfg_in_alt_root(void);
/*
* Zone name, path to zone directory, autoboot setting and pool.
*/
extern int zonecfg_validate_zonename(const char *);
extern int zonecfg_get_name(zone_dochandle_t, char *, size_t);
extern int zonecfg_set_name(zone_dochandle_t, char *);
extern int zonecfg_get_zonepath(zone_dochandle_t, char *, size_t);
extern int zonecfg_set_zonepath(zone_dochandle_t, char *);
extern int zonecfg_get_autoboot(zone_dochandle_t, boolean_t *);
extern int zonecfg_set_autoboot(zone_dochandle_t, boolean_t);
extern int zonecfg_get_pool(zone_dochandle_t, char *, size_t);
extern int zonecfg_set_pool(zone_dochandle_t, char *);
/*
* Filesystem configuration.
*/
extern int zonecfg_add_filesystem(zone_dochandle_t, struct zone_fstab *);
extern int zonecfg_delete_filesystem(zone_dochandle_t,
struct zone_fstab *);
extern int zonecfg_modify_filesystem(zone_dochandle_t,
struct zone_fstab *, struct zone_fstab *);
extern int zonecfg_lookup_filesystem(zone_dochandle_t,
struct zone_fstab *);
extern int zonecfg_add_ipd(zone_dochandle_t, struct zone_fstab *);
extern int zonecfg_delete_ipd(zone_dochandle_t, struct zone_fstab *);
extern int zonecfg_modify_ipd(zone_dochandle_t,
struct zone_fstab *, struct zone_fstab *);
extern int zonecfg_lookup_ipd(zone_dochandle_t, struct zone_fstab *);
extern int zonecfg_add_fs_option(struct zone_fstab *, char *);
extern int zonecfg_remove_fs_option(struct zone_fstab *, char *);
extern void zonecfg_free_fs_option_list(zone_fsopt_t *);
extern int zonecfg_find_mounts(char *, int(*)(const char *, void *),
void *);
/*
* Network interface configuration.
*/
extern int zonecfg_add_nwif(zone_dochandle_t, struct zone_nwiftab *);
extern int zonecfg_delete_nwif(zone_dochandle_t, struct zone_nwiftab *);
extern int zonecfg_modify_nwif(zone_dochandle_t, struct zone_nwiftab *,
struct zone_nwiftab *);
extern int zonecfg_lookup_nwif(zone_dochandle_t, struct zone_nwiftab *);
/*
* Device configuration and rule matching.
*/
extern int zonecfg_add_dev(zone_dochandle_t, struct zone_devtab *);
extern int zonecfg_delete_dev(zone_dochandle_t, struct zone_devtab *);
extern int zonecfg_modify_dev(zone_dochandle_t, struct zone_devtab *,
struct zone_devtab *);
extern int zonecfg_lookup_dev(zone_dochandle_t, struct zone_devtab *);
extern int zonecfg_match_dev(zone_dochandle_t, char *,
struct zone_devtab *);
/*
* Resource control configuration.
*/
extern int zonecfg_add_rctl(zone_dochandle_t, struct zone_rctltab *);
extern int zonecfg_delete_rctl(zone_dochandle_t, struct zone_rctltab *);
extern int zonecfg_modify_rctl(zone_dochandle_t, struct zone_rctltab *,
struct zone_rctltab *);
extern int zonecfg_lookup_rctl(zone_dochandle_t, struct zone_rctltab *);
extern int zonecfg_add_rctl_value(struct zone_rctltab *,
struct zone_rctlvaltab *);
extern int zonecfg_remove_rctl_value(struct zone_rctltab *,
struct zone_rctlvaltab *);
extern void zonecfg_free_rctl_value_list(struct zone_rctlvaltab *);
/*
* Generic attribute configuration and type/value extraction.
*/
extern int zonecfg_add_attr(zone_dochandle_t, struct zone_attrtab *);
extern int zonecfg_delete_attr(zone_dochandle_t, struct zone_attrtab *);
extern int zonecfg_modify_attr(zone_dochandle_t, struct zone_attrtab *,
struct zone_attrtab *);
extern int zonecfg_lookup_attr(zone_dochandle_t, struct zone_attrtab *);
extern int zonecfg_get_attr_boolean(const struct zone_attrtab *,
boolean_t *);
extern int zonecfg_get_attr_int(const struct zone_attrtab *, int64_t *);
extern int zonecfg_get_attr_string(const struct zone_attrtab *, char *,
size_t);
extern int zonecfg_get_attr_uint(const struct zone_attrtab *, uint64_t *);
/*
* ZFS configuration.
*/
extern int zonecfg_add_ds(zone_dochandle_t, struct zone_dstab *);
extern int zonecfg_delete_ds(zone_dochandle_t, struct zone_dstab *);
extern int zonecfg_modify_ds(zone_dochandle_t, struct zone_dstab *,
struct zone_dstab *);
extern int zonecfg_lookup_ds(zone_dochandle_t, struct zone_dstab *);
/*
* '*ent' iterator routines.
*/
extern int zonecfg_setfsent(zone_dochandle_t);
extern int zonecfg_getfsent(zone_dochandle_t, struct zone_fstab *);
extern int zonecfg_endfsent(zone_dochandle_t);
extern int zonecfg_setipdent(zone_dochandle_t);
extern int zonecfg_getipdent(zone_dochandle_t, struct zone_fstab *);
extern int zonecfg_endipdent(zone_dochandle_t);
extern int zonecfg_setnwifent(zone_dochandle_t);
extern int zonecfg_getnwifent(zone_dochandle_t, struct zone_nwiftab *);
extern int zonecfg_endnwifent(zone_dochandle_t);
extern int zonecfg_setdevent(zone_dochandle_t);
extern int zonecfg_getdevent(zone_dochandle_t, struct zone_devtab *);
extern int zonecfg_enddevent(zone_dochandle_t);
extern int zonecfg_setattrent(zone_dochandle_t);
extern int zonecfg_getattrent(zone_dochandle_t, struct zone_attrtab *);
extern int zonecfg_endattrent(zone_dochandle_t);
extern int zonecfg_setrctlent(zone_dochandle_t);
extern int zonecfg_getrctlent(zone_dochandle_t, struct zone_rctltab *);
extern int zonecfg_endrctlent(zone_dochandle_t);
extern int zonecfg_setdsent(zone_dochandle_t);
extern int zonecfg_getdsent(zone_dochandle_t, struct zone_dstab *);
extern int zonecfg_enddsent(zone_dochandle_t);
/*
* Privilege-related functions.
*/
extern int zonecfg_get_privset(priv_set_t *);
/*
* Higher-level routines.
*/
extern int zone_get_rootpath(char *, char *, size_t);
extern int zone_get_zonepath(char *, char *, size_t);
extern int zone_get_state(char *, zone_state_t *);
extern int zone_set_state(char *, zone_state_t);
extern char *zone_state_str(zone_state_t);
extern int zonecfg_get_name_by_uuid(const uuid_t, char *, size_t);
extern int zonecfg_get_uuid(const char *, uuid_t);
/*
* Iterator for configured zones.
*/
extern FILE *setzoneent(void);
extern char *getzoneent(FILE *);
extern struct zoneent *getzoneent_private(FILE *);
extern void endzoneent(FILE *);
/*
* File-system-related convenience functions.
*/
extern boolean_t zonecfg_valid_fs_type(const char *);
/*
* Network-related convenience functions.
*/
extern boolean_t zonecfg_same_net_address(char *, char *);
extern int zonecfg_valid_net_address(char *, struct lifreq *);
/*
* Rctl-related common functions.
*/
extern boolean_t zonecfg_is_rctl(const char *);
extern boolean_t zonecfg_valid_rctlname(const char *);
extern boolean_t zonecfg_valid_rctlblk(const rctlblk_t *);
extern boolean_t zonecfg_valid_rctl(const char *, const rctlblk_t *);
extern int zonecfg_construct_rctlblk(const struct zone_rctlvaltab *,
rctlblk_t *);
/*
* Live Upgrade support functions. Shared between ON and install gate.
*/
extern FILE *zonecfg_open_scratch(const char *, boolean_t);
extern int zonecfg_lock_scratch(FILE *);
extern void zonecfg_close_scratch(FILE *);
extern int zonecfg_get_scratch(FILE *, char *, size_t, char *, size_t, char *,
size_t);
extern int zonecfg_find_scratch(FILE *, const char *, const char *, char *,
size_t);
extern int zonecfg_reverse_scratch(FILE *, const char *, char *, size_t,
char *, size_t);
extern int zonecfg_add_scratch(FILE *, const char *, const char *,
const char *);
extern int zonecfg_delete_scratch(FILE *, const char *);
extern boolean_t zonecfg_is_scratch(const char *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBZONECFG_H */
|
