xref: /titanic_51/usr/src/cmd/zoneadmd/zoneadmd.h (revision a778b211500c8b2b47a35aa015cd89d5548a8ad8)
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 2008 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_ZONEADMD_H
28 #define	_ZONEADMD_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 #ifdef	__cplusplus
33 extern "C" {
34 #endif
35 
36 /*
37  * Multi-threaded programs should avoid MT-unsafe library calls (i.e., any-
38  * thing which could try to acquire a user-level lock unprotected by an atfork
39  * handler) between fork(2) and exec(2).  See the pthread_atfork(3THR) man
40  * page for details.  In particular, we want to avoid calls to zerror() in
41  * such situations, as it calls setlocale(3c) which is susceptible to such
42  * problems.  So instead we have the child use one of the special exit codes
43  * below when needed, and the parent look out for such possibilities and call
44  * zerror() there.
45  *
46  * Since 0, 1 and 2 are generally used for success, general error, and usage,
47  * we start with 3.
48  */
49 #define	ZEXIT_FORK		3
50 #define	ZEXIT_EXEC		4
51 #define	ZEXIT_ZONE_ENTER	5
52 
53 #define	DEVFSADM	"devfsadm"
54 #define	DEVFSADM_PATH	"/usr/sbin/devfsadm"
55 
56 #define	EXEC_PREFIX	"exec "
57 #define	EXEC_LEN	(strlen(EXEC_PREFIX))
58 
59 #define	CLUSTER_BRAND_NAME	"cluster"
60 
61 /* 0755 is the default directory mode. */
62 #define	DEFAULT_DIR_MODE \
63 	(S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
64 #define	DEFAULT_DIR_USER -1	/* user ID for chown: -1 means don't change */
65 #define	DEFAULT_DIR_GROUP -1	/* grp ID for chown: -1 means don't change */
66 
67 
68 typedef struct zlog {
69 	FILE *logfile;	/* file to log to */
70 
71 	/*
72 	 * The following are used if logging to a buffer.
73 	 */
74 	char *log;	/* remaining log */
75 	size_t loglen;	/* size of remaining log */
76 	char *buf;	/* underlying storage */
77 	size_t buflen;	/* total len of 'buf' */
78 	char *locale;	/* locale to use for gettext() */
79 } zlog_t;
80 
81 extern zlog_t logsys;
82 
83 extern mutex_t lock;
84 extern mutex_t msglock;
85 extern boolean_t in_death_throes;
86 extern boolean_t bringup_failure_recovery;
87 extern char *zone_name;
88 extern char boot_args[BOOTARGS_MAX];
89 extern char bad_boot_arg[BOOTARGS_MAX];
90 extern boolean_t zone_isnative;
91 extern boolean_t zone_iscluster;
92 
93 extern void zerror(zlog_t *, boolean_t, const char *, ...);
94 extern char *localize_msg(char *locale, const char *msg);
95 
96 /*
97  * Eventstream interfaces.
98  */
99 typedef enum {
100 	Z_EVT_NULL = 0,
101 	Z_EVT_ZONE_BOOTING,
102 	Z_EVT_ZONE_REBOOTING,
103 	Z_EVT_ZONE_HALTED,
104 	Z_EVT_ZONE_READIED,
105 	Z_EVT_ZONE_UNINSTALLING,
106 	Z_EVT_ZONE_BOOTFAILED,
107 	Z_EVT_ZONE_BADARGS
108 } zone_evt_t;
109 
110 extern int eventstream_init();
111 extern void eventstream_write(zone_evt_t evt);
112 
113 /*
114  * Zone mount styles.  Boot is the standard mount we do when booting the zone,
115  * scratch is the standard scratch zone mount for upgrade and update is a
116  * variation on the scratch zone where we don't lofs mount the zone's /etc
117  * and /var back into the scratch zone so that we can then do an
118  * 'update on attach' within the scratch zone.
119  */
120 typedef enum {
121 	Z_MNT_BOOT = 0,
122 	Z_MNT_SCRATCH,
123 	Z_MNT_UPDATE
124 } zone_mnt_t;
125 
126 /*
127  * Virtual platform interfaces.
128  */
129 extern zoneid_t vplat_create(zlog_t *, zone_mnt_t);
130 extern int vplat_bringup(zlog_t *, zone_mnt_t, zoneid_t);
131 extern int vplat_teardown(zlog_t *, boolean_t, boolean_t);
132 
133 /*
134  * Filesystem mounting interfaces.
135  */
136 extern int valid_mount_path(zlog_t *, const char *, const char *,
137     const char *, const char *);
138 extern int make_one_dir(zlog_t *, const char *, const char *,
139     mode_t, uid_t, gid_t);
140 extern void resolve_lofs(zlog_t *zlogp, char *path, size_t pathlen);
141 
142 /*
143  * Console subsystem routines.
144  */
145 extern int init_console_slave(zlog_t *);
146 extern void destroy_console_slave(void);
147 extern void reset_slave_terminal(zlog_t *);
148 extern int init_console(zlog_t *);
149 extern void serve_console(zlog_t *);
150 
151 /*
152  * Contract handling.
153  */
154 extern int init_template(void);
155 
156 /*
157  * Routine to manage child processes.
158  */
159 extern int do_subproc(zlog_t *, char *);
160 
161 #ifdef __cplusplus
162 }
163 #endif
164 
165 #endif /* _ZONEADMD_H */
166