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
|
/*
* 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 _LIBRESTART_H
#define _LIBRESTART_H
#pragma ident "%Z%%M% %I% %E% SMI"
#include <libcontract.h>
#include <libscf.h>
#include <limits.h>
#include <priv.h>
#include <pwd.h>
#include <sys/types.h>
#ifdef __cplusplus
extern "C" {
#endif
/*
* There are 3 parts to librestart.
* 1) The event protocol from the master restarter to its delegates.
* 2) A functional interface for updating the repository.
* 3) Convenience functions for common restarter tasks.
*
* Event protocol
* We need a reliable event protocol, as there's no way to define
* restarter events as idempotent.
*
* Currently using sysevent channels as the reliable event implementation.
* This could change if the implementation proves unsuitable, but
* the API defined here should abstract anything but a change in
* the fundamental event model.
*
* We offer functions to tease apart the event rather than generic
* nvpair interfaces. This is because each event type has a well-
* defined set of fields.
*/
typedef struct restarter_event_handle restarter_event_handle_t;
typedef struct restarter_event restarter_event_t;
typedef uint32_t restarter_event_type_t;
/*
* Define an event protocol version. In theory, we could use this in
* the future to support delegated restarters which use an older
* protocol. In practice, increment RESTARTER_EVENT_VERSION whenever the
* protocol might have changed.
*/
#define RESTARTER_EVENT_VERSION 4
#define RESTARTER_FLAG_DEBUG 1
/*
* Event types
* RESTARTER_EVENT_TYPE_ADD_INSTANCE
* responsible for a new (stopped) instance
* RESTARTER_EVENT_TYPE_REMOVE_INSTANCE
* no longer responsible for this instance; stop it and return
* RESTARTER_EVENT_TYPE_ENABLE
* no guarantee that dependencies are met; see
* RESTARTER_EVENT_TYPE_START
* RESTARTER_EVENT_TYPE_DISABLE
* no guarantee that instance was running
* RESTARTER_EVENT_TYPE_ADMIN_DEGRADED
* RESTARTER_EVENT_TYPE_ADMIN_REFRESH
* RESTARTER_EVENT_TYPE_ADMIN_RESTART
* RESTARTER_EVENT_TYPE_ADMIN_MAINT_OFF
* RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON
* RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON_IMMEDIATE
* RESTARTER_EVENT_TYPE_ADMIN_MAINT_OFF
* RESTARTER_EVENT_TYPE_STOP
* dependencies are, or are becoming, unsatisfied
* RESTARTER_EVENT_TYPE_START
* dependencies have become satisfied
* RESTARTER_EVENT_TYPE_DEPENDENCY_CYCLE
* instance caused a dependency cycle
* RESTARTER_EVENT_TYPE_INVALID_DEPENDENCY
* instance has an invalid dependency
*/
#define RESTARTER_EVENT_TYPE_INVALID 0
#define RESTARTER_EVENT_TYPE_ADD_INSTANCE 1
#define RESTARTER_EVENT_TYPE_REMOVE_INSTANCE 2
#define RESTARTER_EVENT_TYPE_ENABLE 3
#define RESTARTER_EVENT_TYPE_DISABLE 4
#define RESTARTER_EVENT_TYPE_ADMIN_DEGRADED 5
#define RESTARTER_EVENT_TYPE_ADMIN_REFRESH 6
#define RESTARTER_EVENT_TYPE_ADMIN_RESTART 7
#define RESTARTER_EVENT_TYPE_ADMIN_MAINT_OFF 8
#define RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON 9
#define RESTARTER_EVENT_TYPE_ADMIN_MAINT_ON_IMMEDIATE 10
#define RESTARTER_EVENT_TYPE_STOP 11
#define RESTARTER_EVENT_TYPE_START 12
#define RESTARTER_EVENT_TYPE_DEPENDENCY_CYCLE 13
#define RESTARTER_EVENT_TYPE_INVALID_DEPENDENCY 14
#define RESTARTER_EVENT_TYPE_ADMIN_DISABLE 15
#define RESTARTER_EVENT_ERROR -1
#define RESTARTER_EVENT_INSTANCE_DISABLED 0
#define RESTARTER_EVENT_INSTANCE_ENABLED 1
typedef enum {
RESTARTER_STATE_NONE,
RESTARTER_STATE_UNINIT,
RESTARTER_STATE_MAINT,
RESTARTER_STATE_OFFLINE,
RESTARTER_STATE_DISABLED,
RESTARTER_STATE_ONLINE,
RESTARTER_STATE_DEGRADED
} restarter_instance_state_t;
/*
* These values are ordered by severity of required restart, as we use
* integer comparisons to determine error flow.
*/
typedef enum {
RERR_UNSUPPORTED = -1,
RERR_NONE = 0, /* no error, restart, refresh */
RERR_FAULT, /* fault occurred */
RERR_RESTART, /* transition due to restart */
RERR_REFRESH /* transition due to refresh */
} restarter_error_t;
/*
* restarter_store_contract() and restarter_remove_contract() types
*/
typedef enum {
RESTARTER_CONTRACT_PRIMARY,
RESTARTER_CONTRACT_TRANSIENT
} restarter_contract_type_t;
/*
* restarter_bind_handle() registers a delegate with svc.startd to
* begin consuming events.
*
* On initial bind, the delgated restarter receives an event for each
* instance it is responsible for, as if that instance was new.
*
* callers must have superuser privileges
*
* The event handler can return 0 for success, or EAGAIN to request
* retry of event delivery. EAGAIN may be returned 3 times before the
* event is discarded.
*/
int restarter_bind_handle(uint32_t, const char *,
int (*event_handler)(restarter_event_t *), int,
restarter_event_handle_t **);
restarter_event_type_t restarter_event_get_type(restarter_event_t *);
uint64_t restarter_event_get_seq(restarter_event_t *);
void restarter_event_get_time(restarter_event_t *, hrtime_t *);
ssize_t restarter_event_get_instance(restarter_event_t *, char *, size_t);
restarter_event_handle_t *restarter_event_get_handle(restarter_event_t *);
/*
* The following functions work only on certain types of events.
* They fail with a return of -1 if they're called on an inappropriate event.
*/
int restarter_event_get_enabled(restarter_event_t *);
int restarter_event_get_current_states(restarter_event_t *,
restarter_instance_state_t *, restarter_instance_state_t *);
/*
* Functions for updating the repository.
*/
int restarter_set_states(restarter_event_handle_t *, const char *,
restarter_instance_state_t, restarter_instance_state_t,
restarter_instance_state_t, restarter_instance_state_t, restarter_error_t,
const char *);
int restarter_store_contract(scf_instance_t *, ctid_t,
restarter_contract_type_t);
int restarter_remove_contract(scf_instance_t *, ctid_t,
restarter_contract_type_t);
ssize_t restarter_state_to_string(restarter_instance_state_t, char *, size_t);
restarter_instance_state_t restarter_string_to_state(char *);
#define RESTARTER_METHOD_CONTEXT_VERSION 6
struct method_context {
/* Stable */
uid_t uid, euid;
gid_t gid, egid;
int ngroups; /* -1 means use initgroups(). */
gid_t groups[NGROUPS_MAX-1];
priv_set_t *lpriv_set, *priv_set;
char *corefile_pattern; /* Optional. */
char *project; /* NULL for no change */
char *resource_pool; /* NULL for project default */
char *working_dir; /* NULL for :default */
char **env; /* NULL for no env */
size_t env_sz; /* size of env array */
/* Private */
char *vbuf;
ssize_t vbuf_sz;
struct passwd pwd;
char *pwbuf;
ssize_t pwbufsz;
};
int restarter_rm_libs_loadable(void);
/* instance, restarter name, method name, command line, structure pointer */
const char *restarter_get_method_context(uint_t, scf_instance_t *,
scf_snapshot_t *, const char *, const char *, struct method_context **);
int restarter_set_method_context(struct method_context *, const char **);
void restarter_free_method_context(struct method_context *);
int restarter_is_null_method(const char *);
int restarter_is_kill_method(const char *);
int restarter_is_kill_proc_method(const char *);
#ifdef __cplusplus
}
#endif
#endif /* _LIBRESTART_H */
|
