xref: /titanic_41/usr/src/cmd/zoneadmd/zoneadmd.h (revision c2623971ed26a21199082ffc082fa6324f1a1c59)
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	_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 typedef struct zlog {
60 	FILE *logfile;	/* file to log to */
61 
62 	/*
63 	 * The following are used if logging to a buffer.
64 	 */
65 	char *log;	/* remaining log */
66 	size_t loglen;	/* size of remaining log */
67 	char *buf;	/* underlying storage */
68 	size_t buflen;	/* total len of 'buf' */
69 	char *locale;	/* locale to use for gettext() */
70 } zlog_t;
71 
72 extern zlog_t logsys;
73 
74 extern mutex_t lock;
75 extern mutex_t msglock;
76 extern boolean_t in_death_throes;
77 extern boolean_t bringup_failure_recovery;
78 extern char *zone_name;
79 extern char boot_args[BOOTARGS_MAX];
80 extern char bad_boot_arg[BOOTARGS_MAX];
81 extern boolean_t zone_isnative;
82 
83 
84 extern void zerror(zlog_t *, boolean_t, const char *, ...);
85 extern char *localize_msg(char *locale, const char *msg);
86 
87 /*
88  * Eventstream interfaces.
89  */
90 typedef enum {
91 	Z_EVT_NULL = 0,
92 	Z_EVT_ZONE_BOOTING,
93 	Z_EVT_ZONE_REBOOTING,
94 	Z_EVT_ZONE_HALTED,
95 	Z_EVT_ZONE_READIED,
96 	Z_EVT_ZONE_UNINSTALLING,
97 	Z_EVT_ZONE_BOOTFAILED,
98 	Z_EVT_ZONE_BADARGS
99 } zone_evt_t;
100 
101 extern int eventstream_init();
102 extern void eventstream_write(zone_evt_t evt);
103 
104 /*
105  * Virtual platform interfaces.
106  */
107 extern zoneid_t vplat_create(zlog_t *, boolean_t);
108 extern int vplat_bringup(zlog_t *, boolean_t, zoneid_t);
109 extern int vplat_teardown(zlog_t *, boolean_t);
110 
111 /*
112  * Console subsystem routines.
113  */
114 extern int init_console_slave(zlog_t *);
115 extern void destroy_console_slave(void);
116 extern void reset_slave_terminal(zlog_t *);
117 extern int init_console(zlog_t *);
118 extern void serve_console(zlog_t *);
119 
120 /*
121  * Contract handling.
122  */
123 extern int init_template(void);
124 
125 /*
126  * Routine to manage child processes.
127  */
128 extern int do_subproc(zlog_t *, char *);
129 
130 #ifdef __cplusplus
131 }
132 #endif
133 
134 #endif /* _ZONEADMD_H */
135