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
|
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (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 (c) 2003, 2010, Oracle and/or its affiliates. All rights reserved.
* Copyright 2014 Nexenta Systems, Inc. All rights reserved.
* Copyright 2019 Joyent, Inc.
*/
#ifndef _ZONEADMD_H
#define _ZONEADMD_H
#ifdef __cplusplus
extern "C" {
#endif
#include <libdladm.h>
#include <libzonecfg.h>
#include <thread.h>
#include <synch.h>
/*
* Multi-threaded programs should avoid MT-unsafe library calls (i.e., any-
* thing which could try to acquire a user-level lock unprotected by an atfork
* handler) between fork(2) and exec(2). See the pthread_atfork(3THR) man
* page for details. In particular, we want to avoid calls to zerror() in
* such situations, as it calls setlocale(3c) which is susceptible to such
* problems. So instead we have the child use one of the special exit codes
* below when needed, and the parent look out for such possibilities and call
* zerror() there.
*
* Since 0, 1 and 2 are generally used for success, general error, and usage,
* we start with 3.
*/
#define ZEXIT_FORK 3
#define ZEXIT_EXEC 4
#define ZEXIT_ZONE_ENTER 5
#define DEVFSADM "devfsadm"
#define DEVFSADM_PATH "/usr/sbin/devfsadm"
#define EXEC_PREFIX "exec "
#define EXEC_LEN (strlen(EXEC_PREFIX))
#define CLUSTER_BRAND_NAME "cluster"
#define LABELED_BRAND_NAME "labeled"
#define SHUTDOWN_WAIT 60
#define SHUTDOWN_DEFAULT "/sbin/init 0"
#define SHUTDOWN_FMRI "svc:/system/zones:default"
/* 0755 is the default directory mode. */
#define DEFAULT_DIR_MODE \
(S_IRWXU | S_IRGRP | S_IXGRP | S_IROTH | S_IXOTH)
#define DEFAULT_DIR_USER -1 /* user ID for chown: -1 means don't change */
#define DEFAULT_DIR_GROUP -1 /* grp ID for chown: -1 means don't change */
#define ALT_MOUNT(mount_cmd) ((mount_cmd) != Z_MNT_BOOT)
typedef struct zlog {
FILE *logfile; /* file to log to */
/*
* The following are used if logging to a buffer.
*/
char *log; /* remaining log */
size_t loglen; /* size of remaining log */
char *buf; /* underlying storage */
size_t buflen; /* total len of 'buf' */
char *locale; /* locale to use for gettext() */
} zlog_t;
extern zlog_t logsys; /* syslog */
extern zlog_t logplat; /* platform.log */
extern mutex_t lock;
extern mutex_t msglock;
extern boolean_t in_death_throes;
extern boolean_t bringup_failure_recovery;
extern char *zone_name;
extern char zonepath[MAXNAMELEN];
extern zone_dochandle_t snap_hndl;
extern char pool_name[MAXNAMELEN];
extern char brand_name[MAXNAMELEN];
extern char default_brand[MAXNAMELEN];
extern char boot_args[BOOTARGS_MAX];
extern boolean_t zone_isnative;
extern boolean_t zone_iscluster;
extern dladm_handle_t dld_handle;
extern void zerror(zlog_t *, boolean_t, const char *, ...);
extern char *localize_msg(char *locale, const char *msg);
extern void nwifent_free_attrs(struct zone_nwiftab *);
/*
* Eventstream interfaces.
*/
typedef enum {
Z_EVT_NULL = 0,
Z_EVT_ZONE_BOOTING,
Z_EVT_ZONE_REBOOTING,
Z_EVT_ZONE_HALTED,
Z_EVT_ZONE_READIED,
Z_EVT_ZONE_UNINSTALLING,
Z_EVT_ZONE_BOOTFAILED
} zone_evt_t;
extern int eventstream_init();
extern void eventstream_write(zone_evt_t evt);
/*
* Zone mount styles. Boot is the standard mount we do when booting the zone,
* scratch is the standard scratch zone mount for upgrade and update is a
* variation on the scratch zone where we don't lofs mount the zone's /etc
* and /var back into the scratch zone so that we can then do an
* 'update on attach' within the scratch zone.
*/
typedef enum {
Z_MNT_BOOT = 0,
Z_MNT_SCRATCH,
Z_MNT_UPDATE
} zone_mnt_t;
/*
* Virtual platform interfaces.
*/
extern zoneid_t vplat_create(zlog_t *, zone_mnt_t, zoneid_t);
extern int vplat_bringup(zlog_t *, zone_mnt_t, zoneid_t);
extern int vplat_teardown(zlog_t *, boolean_t, boolean_t, boolean_t);
extern int vplat_get_iptype(zlog_t *, zone_iptype_t *);
/*
* Filesystem mounting interfaces.
*/
extern int valid_mount_path(zlog_t *, const char *, const char *,
const char *, const char *);
extern int make_one_dir(zlog_t *, const char *, const char *,
mode_t, uid_t, gid_t);
extern void resolve_lofs(zlog_t *zlogp, char *path, size_t pathlen);
/*
* Console subsystem routines.
*/
extern int init_console(zlog_t *);
extern void serve_console(zlog_t *);
extern void zcons_statechanged();
/*
* Logging routines
*/
typedef enum {
LS_LINE_BUFFERED = 0x1 /* Write when \n found or full buffer */
} logstream_flags_t;
extern boolean_t logging_poisoned;
extern void create_log_thread(zlog_t *);
extern void destroy_log_thread(zlog_t *);
extern void logstream_init(zlog_t *);
extern int logstream_open(const char *, const char *, logstream_flags_t);
extern void logstream_write(int, char *, int);
extern void logstream_close(int, boolean_t);
/*
* Contract handling.
*/
extern int init_template(void);
/*
* Routine to manage child processes.
*/
extern int do_subproc(zlog_t *, char *, char **, boolean_t);
/*
* Resource handling.
*/
extern int resolve_device_match(zlog_t *, struct zone_devtab *,
char *, size_t);
#ifdef __cplusplus
}
#endif
#endif /* _ZONEADMD_H */
|
