2 * Copyright (c) 2012-2013 The FreeBSD Foundation
3 * Copyright (c) 2015-2017 Mariusz Zaborski <oshogbo@FreeBSD.org>
6 * This software was developed by Pawel Jakub Dawidek under sponsorship from
7 * the FreeBSD Foundation.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40 #include <sys/types.h>
46 #ifndef _NVLIST_T_DECLARED
47 #define _NVLIST_T_DECLARED
50 typedef struct nvlist nvlist_t;
53 #ifndef _CAP_CHANNEL_T_DECLARED
54 #define _CAP_CHANNEL_T_DECLARED
58 typedef struct cap_channel cap_channel_t;
63 typedef struct cap_channel cap_channel_t;
64 #endif /* ! WITH_CASPER */
65 #endif /* ! _CAP_CHANNEL_T_DECLARED */
68 * The functions opens unrestricted communication channel to Casper.
71 cap_channel_t *cap_init(void);
73 static inline cap_channel_t *
78 chan = malloc(sizeof(*chan));
87 * The functions to communicate with service.
90 cap_channel_t *cap_service_open(const cap_channel_t *chan, const char *name);
91 int cap_service_limit(const cap_channel_t *chan,
92 const char * const *names, size_t nnames);
94 #define cap_service_open(chan, name) (cap_init())
95 #define cap_service_limit(chan, names, nnames) (0)
99 * The function creates cap_channel_t based on the given socket.
102 cap_channel_t *cap_wrap(int sock);
104 static inline cap_channel_t *
118 * The function returns communication socket and frees cap_channel_t.
121 int cap_unwrap(cap_channel_t *chan);
123 #define cap_unwrap(chan) (chan->cch_fd)
127 * The function clones the given capability.
130 cap_channel_t *cap_clone(const cap_channel_t *chan);
132 static inline cap_channel_t *
133 cap_clone(const cap_channel_t *chan)
135 cap_channel_t *newchan;
137 newchan = cap_init();
138 if (newchan == NULL) {
142 if (chan->cch_fd == -1) {
143 newchan->cch_fd = -1;
145 newchan->cch_fd = dup(chan->cch_fd);
146 if (newchan->cch_fd < 0) {
157 * The function closes the given capability.
160 void cap_close(cap_channel_t *chan);
163 cap_close(cap_channel_t *chan)
166 if (chan->cch_fd >= 0) {
174 * The function returns socket descriptor associated with the given
175 * cap_channel_t for use with select(2)/kqueue(2)/etc.
178 int cap_sock(const cap_channel_t *chan);
180 #define cap_sock(chan) (chan->cch_fd)
184 * The function limits the given capability.
185 * It always destroys 'limits' on return.
188 int cap_limit_set(const cap_channel_t *chan, nvlist_t *limits);
190 #define cap_limit_set(chan, limits) (0)
194 * The function returns current limits of the given capability.
197 int cap_limit_get(const cap_channel_t *chan, nvlist_t **limitsp);
200 cap_limit_get(const cap_channel_t *chan __unused, nvlist_t **limitsp)
203 *limitsp = nvlist_create(0);
209 * Function sends nvlist over the given capability.
212 int cap_send_nvlist(const cap_channel_t *chan, const nvlist_t *nvl);
214 #define cap_send_nvlist(chan, nvl) (0)
218 * Function receives nvlist over the given capability.
221 nvlist_t *cap_recv_nvlist(const cap_channel_t *chan, int flags);
223 #define cap_recv_nvlist(chan, flags) (0)
227 * Function sends the given nvlist, destroys it and receives new nvlist in
228 * response over the given capability.
231 nvlist_t *cap_xfer_nvlist(const cap_channel_t *chan, nvlist_t *nvl, int flags);
233 static inline nvlist_t *
234 cap_xfer_nvlist(const cap_channel_t *chan __unused, nvlist_t *nvl, int flags)
238 return (nvlist_create(flags));
242 #endif /* !_LIBCASPER_H_ */