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