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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2012-2013 The FreeBSD Foundation
* Copyright (c) 2015-2017 Mariusz Zaborski <oshogbo@FreeBSD.org>
* All rights reserved.
*
* This software was developed by Pawel Jakub Dawidek under sponsorship from
* the FreeBSD Foundation.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*
* $FreeBSD$
*/
#ifndef _LIBCASPER_H_
#define _LIBCASPER_H_
#ifdef HAVE_CASPER
#define WITH_CASPER
#endif
#include <sys/types.h>
#include <sys/nv.h>
#include <stdlib.h>
#include <unistd.h>
#define CASPER_NO_UNIQ 0x00000001
#ifndef _NVLIST_T_DECLARED
#define _NVLIST_T_DECLARED
struct nvlist;
typedef struct nvlist nvlist_t;
#endif
#ifndef _CAP_CHANNEL_T_DECLARED
#define _CAP_CHANNEL_T_DECLARED
#ifdef WITH_CASPER
struct cap_channel;
typedef struct cap_channel cap_channel_t;
#define CASPER_SUPPORT (1)
#else
struct cap_channel {
int cch_fd;
int cch_flags;
};
typedef struct cap_channel cap_channel_t;
#define CASPER_SUPPORT (0)
#endif /* ! WITH_CASPER */
#endif /* ! _CAP_CHANNEL_T_DECLARED */
#ifdef WITH_CASPER
int cap_channel_flags(const cap_channel_t *chan);
#else
static inline int
cap_channel_flags(const cap_channel_t *chan)
{
return (chan->cch_flags);
}
#endif
static inline int
channel_nvlist_flags(const cap_channel_t *chan)
{
int flags;
flags = 0;
if ((cap_channel_flags(chan) & CASPER_NO_UNIQ) != 0)
flags |= NV_FLAG_NO_UNIQUE;
return (flags);
}
/*
* The functions opens unrestricted communication channel to Casper.
*/
#ifdef WITH_CASPER
cap_channel_t *cap_init(void);
#else
static inline cap_channel_t *
cap_init(void)
{
cap_channel_t *chan;
chan = malloc(sizeof(*chan));
if (chan != NULL) {
chan->cch_fd = -1;
}
return (chan);
}
#endif
/*
* The functions to communicate with service.
*/
#ifdef WITH_CASPER
cap_channel_t *cap_service_open(const cap_channel_t *chan, const char *name);
int cap_service_limit(const cap_channel_t *chan,
const char * const *names, size_t nnames);
#else
#define cap_service_open(chan, name) (cap_init())
#define cap_service_limit(chan, names, nnames) (0)
#endif
/*
* The function creates cap_channel_t based on the given socket.
*/
#ifdef WITH_CASPER
cap_channel_t *cap_wrap(int sock, int flags);
#else
static inline cap_channel_t *
cap_wrap(int sock, int flags)
{
cap_channel_t *chan;
chan = cap_init();
if (chan != NULL) {
chan->cch_fd = sock;
chan->cch_flags = flags;
}
return (chan);
}
#endif
/*
* The function returns communication socket and frees cap_channel_t.
*/
#ifdef WITH_CASPER
int cap_unwrap(cap_channel_t *chan, int *flags);
#else
static inline int
cap_unwrap(cap_channel_t *chan)
{
int fd;
fd = chan->cch_fd;
free(chan);
return (fd);
}
#endif
/*
* The function clones the given capability.
*/
#ifdef WITH_CASPER
cap_channel_t *cap_clone(const cap_channel_t *chan);
#else
static inline cap_channel_t *
cap_clone(const cap_channel_t *chan)
{
cap_channel_t *newchan;
newchan = cap_init();
if (newchan == NULL) {
return (NULL);
}
if (chan->cch_fd == -1) {
newchan->cch_fd = -1;
} else {
newchan->cch_fd = dup(chan->cch_fd);
if (newchan->cch_fd < 0) {
free(newchan);
newchan = NULL;
}
}
newchan->cch_flags = chan->cch_flags;
return (newchan);
}
#endif
/*
* The function closes the given capability.
*/
#ifdef WITH_CASPER
void cap_close(cap_channel_t *chan);
#else
static inline void
cap_close(cap_channel_t *chan)
{
if (chan->cch_fd >= 0) {
close(chan->cch_fd);
}
free(chan);
}
#endif
/*
* The function returns socket descriptor associated with the given
* cap_channel_t for use with select(2)/kqueue(2)/etc.
*/
#ifdef WITH_CASPER
int cap_sock(const cap_channel_t *chan);
#else
#define cap_sock(chan) (chan->cch_fd)
#endif
/*
* The function limits the given capability.
* It always destroys 'limits' on return.
*/
#ifdef WITH_CASPER
int cap_limit_set(const cap_channel_t *chan, nvlist_t *limits);
#else
#define cap_limit_set(chan, limits) (0)
#endif
/*
* The function returns current limits of the given capability.
*/
#ifdef WITH_CASPER
int cap_limit_get(const cap_channel_t *chan, nvlist_t **limitsp);
#else
static inline int
cap_limit_get(const cap_channel_t *chan __unused, nvlist_t **limitsp)
{
*limitsp = nvlist_create(channel_nvlist_flags(chan));
return (0);
}
#endif
/*
* Function sends nvlist over the given capability.
*/
#ifdef WITH_CASPER
int cap_send_nvlist(const cap_channel_t *chan, const nvlist_t *nvl);
#else
#define cap_send_nvlist(chan, nvl) (0)
#endif
/*
* Function receives nvlist over the given capability.
*/
#ifdef WITH_CASPER
nvlist_t *cap_recv_nvlist(const cap_channel_t *chan);
#else
#define cap_recv_nvlist(chan) (nvlist_create(chan->cch_flags))
#endif
/*
* Function sends the given nvlist, destroys it and receives new nvlist in
* response over the given capability.
*/
#ifdef WITH_CASPER
nvlist_t *cap_xfer_nvlist(const cap_channel_t *chan, nvlist_t *nvl);
#else
static inline nvlist_t *
cap_xfer_nvlist(const cap_channel_t *chan, nvlist_t *nvl)
{
nvlist_destroy(nvl);
return (nvlist_create(channel_nvlist_flags(chan)));
}
#endif
#endif /* !_LIBCASPER_H_ */
|
