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 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
23 */
24
25 #ifndef _IPADM_IPMGMT_H
26 #define _IPADM_IPMGMT_H
27
28 #ifdef __cplusplus
29 extern "C" {
30 #endif
31 #include <sys/types.h>
32 #include <sys/stat.h>
33 #include <fcntl.h>
34 #include <sys/mman.h>
35 #include <door.h>
36 #include <libipadm.h>
37 #include <inet/tunables.h>
38
39 /*
40 * Function declarations and data structures shared by libipadm.so and
41 * the IP management daemon.
42 */
43
44 /* Authorization required to configure network interfaces */
45 #define NETWORK_INTERFACE_CONFIG_AUTH "solaris.network.interface.config"
46
47 /*
48 * Data store read/write utilities related declarations.
49 */
50 /*
51 * For more information on these definitions please refer to the top of
52 * ipadm_persist.c. These are the name of the nvpairs which hold the
53 * respective values. All nvpairs private to ipadm have names that begin
54 * with "_". Note below that 'prefixlen' is an address property and therefore
55 * not a private nvpair name.
56 */
57 #define IPADM_NVP_PROTONAME "_protocol" /* protocol name */
58 #define IPADM_NVP_IFNAME "_ifname" /* interface name */
59 #define IPADM_NVP_AOBJNAME "_aobjname" /* addrobj name */
60 #define IPADM_NVP_FAMILY "_family" /* address family */
61 #define IPADM_NVP_IPV4ADDR "_ipv4addr" /* name of IPv4 addr nvlist */
62 #define IPADM_NVP_IPNUMADDR "_addr" /* local address */
63 #define IPADM_NVP_IPADDRHNAME "_aname" /* local hostname */
64 #define IPADM_NVP_IPDADDRHNAME "_dname" /* remote hostname */
65 #define IPADM_NVP_PREFIXLEN "prefixlen" /* prefixlen */
66 #define IPADM_NVP_IPV6ADDR "_ipv6addr" /* name of IPv6 addr nvlist */
67 #define IPADM_NVP_DHCP "_dhcp" /* name of DHCP nvlist */
68 #define IPADM_NVP_WAIT "_wait" /* DHCP timeout value */
69 #define IPADM_NVP_PRIMARY "_primary" /* DHCP primary interface */
70 #define IPADM_NVP_LIFNUM "_lifnum" /* logical interface number */
71 #define IPADM_NVP_INTFID "_intfid" /* name of IPv6 intfid nvlist */
72 #define IPADM_NVP_STATELESS "_stateless" /* IPv6 autoconf stateless */
73 #define IPADM_NVP_STATEFUL "_stateful" /* IPv6 autoconf dhcpv6 */
74
75 #define IPADM_PRIV_NVP(s) ((s)[0] == '_' && (s)[1] != '_')
76
77 /*
78 * All protocol properties that are private to ipadm are stored in the
79 * ipadm datastore with "__" as prefix. This is to ensure there
80 * is no collision of namespace between ipadm private nvpair names and
81 * the private protocol property names.
82 */
83 #define IPADM_PERSIST_PRIVPROP_PREFIX "__"
84
85 /* data-store operations */
135 } ipmgmt_arg_t;
136
137 /* IPMGMT_CMD_{SETPROP|GETPROP|RESETPROP} door_call argument */
138 typedef struct ipmgmt_prop_arg_s {
139 ipmgmt_door_cmd_type_t ia_cmd;
140 uint32_t ia_flags;
141 char ia_ifname[LIFNAMSIZ];
142 char ia_aobjname[IPADM_AOBJSIZ];
143 char ia_module[MAXPROTONAMELEN];
144 char ia_pname[MAXPROPNAMELEN];
145 char ia_pval[MAXPROPVALLEN];
146 } ipmgmt_prop_arg_t;
147 /*
148 * ia_flags used in ipmgmt_prop_arg_t.
149 * - APPEND updates the multi-valued property entry with a new value
150 * - REDUCE updates the multi-valued property entry by removing a value
151 */
152 #define IPMGMT_APPEND 0x00000001
153 #define IPMGMT_REMOVE 0x00000002
154
155 /* IPMGMT_CMD_GETIF door_call argument structure */
156 typedef struct ipmgmt_getif_arg_s {
157 ipmgmt_door_cmd_type_t ia_cmd;
158 uint32_t ia_flags;
159 char ia_ifname[LIFNAMSIZ];
160 } ipmgmt_getif_arg_t;
161
162 /* IPMGMT_CMD_RESETIF, IPMGMT_CMD_SETIF door_call argument structure */
163 typedef struct ipmgmt_if_arg_s {
164 ipmgmt_door_cmd_type_t ia_cmd;
165 uint32_t ia_flags;
166 char ia_ifname[LIFNAMSIZ];
167 sa_family_t ia_family;
168 } ipmgmt_if_arg_t;
169
170 /* IPMGMT_CMD_INITIF door_call argument structure */
171 typedef struct ipmgmt_initif_arg_s {
172 ipmgmt_door_cmd_type_t ia_cmd;
173 uint32_t ia_flags;
174 sa_family_t ia_family;
204 /*
205 * IPMGMT_CMD_{ADDROBJ_ADD|ADDROBJ_LOOKUPADD|LIFNUM2ADDROBJ|
206 * ADDROBJ2LIFNUM} door_call argument.
207 */
208 typedef struct ipmgmt_aobjop_arg_s {
209 ipmgmt_door_cmd_type_t ia_cmd;
210 uint32_t ia_flags;
211 char ia_aobjname[IPADM_AOBJSIZ];
212 char ia_ifname[LIFNAMSIZ];
213 int32_t ia_lnum;
214 sa_family_t ia_family;
215 ipadm_addr_type_t ia_atype;
216 } ipmgmt_aobjop_arg_t;
217
218 /*
219 * ia_flags used inside the arguments for interface/address commands
220 * - ACTIVE updates the running configuration
221 * - PERSIST updates the permanent data store
222 * - INIT indicates that operation being performed is under init
223 * context
224 */
225 #define IPMGMT_ACTIVE 0x00000001
226 #define IPMGMT_PERSIST 0x00000002
227 #define IPMGMT_INIT 0x00000004
228
229 /* door call return value */
230 typedef struct ipmgmt_retval_s {
231 int32_t ir_err;
232 } ipmgmt_retval_t;
233
234 /* IPMGMT_CMD_GETADDR door_return value */
235 typedef struct ipmgmt_get_rval_s {
236 int32_t ir_err;
237 size_t ir_nvlsize;
238 /* packed nvl follows */
239 } ipmgmt_get_rval_t;
240
241 /* IPMGMT_CMD_GETPROP door_return value */
242 typedef struct ipmgmt_getprop_rval_s {
243 int32_t ir_err;
244 char ir_pval[MAXPROPVALLEN];
245 } ipmgmt_getprop_rval_t;
246
247 /* IPMGMT_CMD_GETIF door_return value */
248 typedef struct ipmgmt_getif_rval_s {
249 int32_t ir_err;
250 uint32_t ir_ifcnt;
251 ipadm_if_info_t ir_ifinfo[1];
252 } ipmgmt_getif_rval_t;
253
254 /* IPMGMT_CMD_{LOOKUPADD|LIFNUM2ADDROBJ|ADDROBJ2LIFNUM} door_return value */
255 typedef struct ipmgmt_aobjop_rval_s {
256 int32_t ir_err;
257 char ir_aobjname[IPADM_AOBJSIZ];
258 char ir_ifname[LIFNAMSIZ];
259 int32_t ir_lnum;
260 sa_family_t ir_family;
261 uint32_t ir_flags;
262 ipadm_addr_type_t ir_atype;
263 struct sockaddr_storage ir_ifid;
264 } ipmgmt_aobjop_rval_t;
265
266 /* DB walk callback functions */
267 typedef boolean_t db_wfunc_t(void *, nvlist_t *, char *, size_t, int *);
268 extern int ipadm_rw_db(db_wfunc_t *, void *, const char *, mode_t,
269 ipadm_db_op_t);
270
271 /* zone related functions */
272 /*
273 * callback function to persist an interface in ipmgmtd data store
274 */
275 typedef void (*persist_cb_t)(char *, boolean_t, boolean_t);
276 /*
277 * ipmgmtd/libipadm network initialization interface.
278 */
279 extern ipadm_status_t ipadm_init_net_from_gz(ipadm_handle_t, char *,
280 persist_cb_t);
281
282 #ifdef __cplusplus
283 }
284 #endif
285
|
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 * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
23 * Copyright (c) 2016, Chris Fraire <cfraire@me.com>.
24 */
25
26 #ifndef _IPADM_IPMGMT_H
27 #define _IPADM_IPMGMT_H
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
32 #include <sys/types.h>
33 #include <sys/stat.h>
34 #include <fcntl.h>
35 #include <sys/mman.h>
36 #include <door.h>
37 #include <libipadm.h>
38 #include <inet/tunables.h>
39
40 /*
41 * Function declarations and data structures shared by libipadm.so and
42 * the IP management daemon.
43 */
44
45 /* Authorization required to configure network interfaces */
46 #define NETWORK_INTERFACE_CONFIG_AUTH "solaris.network.interface.config"
47
48 /*
49 * Data store read/write utilities related declarations.
50 */
51 /*
52 * For more information on these definitions please refer to the top of
53 * ipadm_persist.c. These are the name of the nvpairs which hold the
54 * respective values. All nvpairs private to ipadm have names that begin
55 * with "_". Note below that 'prefixlen' and 'reqhost' are address
56 * properties and therefore not a private nvpair name.
57 */
58 #define IPADM_NVP_PROTONAME "_protocol" /* protocol name */
59 #define IPADM_NVP_IFNAME "_ifname" /* interface name */
60 #define IPADM_NVP_AOBJNAME "_aobjname" /* addrobj name */
61 #define IPADM_NVP_FAMILY "_family" /* address family */
62 #define IPADM_NVP_IPV4ADDR "_ipv4addr" /* name of IPv4 addr nvlist */
63 #define IPADM_NVP_IPNUMADDR "_addr" /* local address */
64 #define IPADM_NVP_IPADDRHNAME "_aname" /* local hostname */
65 #define IPADM_NVP_IPDADDRHNAME "_dname" /* remote hostname */
66 #define IPADM_NVP_PREFIXLEN "prefixlen" /* prefixlen */
67 #define IPADM_NVP_REQHOST "reqhost" /* requested hostname */
68 #define IPADM_NVP_IPV6ADDR "_ipv6addr" /* name of IPv6 addr nvlist */
69 #define IPADM_NVP_DHCP "_dhcp" /* name of DHCP nvlist */
70 #define IPADM_NVP_WAIT "_wait" /* DHCP timeout value */
71 #define IPADM_NVP_PRIMARY "_primary" /* DHCP primary interface */
72 #define IPADM_NVP_LIFNUM "_lifnum" /* logical interface number */
73 #define IPADM_NVP_INTFID "_intfid" /* name of IPv6 intfid nvlist */
74 #define IPADM_NVP_STATELESS "_stateless" /* IPv6 autoconf stateless */
75 #define IPADM_NVP_STATEFUL "_stateful" /* IPv6 autoconf dhcpv6 */
76
77 #define IPADM_PRIV_NVP(s) ((s)[0] == '_' && (s)[1] != '_')
78
79 /*
80 * All protocol properties that are private to ipadm are stored in the
81 * ipadm datastore with "__" as prefix. This is to ensure there
82 * is no collision of namespace between ipadm private nvpair names and
83 * the private protocol property names.
84 */
85 #define IPADM_PERSIST_PRIVPROP_PREFIX "__"
86
87 /* data-store operations */
137 } ipmgmt_arg_t;
138
139 /* IPMGMT_CMD_{SETPROP|GETPROP|RESETPROP} door_call argument */
140 typedef struct ipmgmt_prop_arg_s {
141 ipmgmt_door_cmd_type_t ia_cmd;
142 uint32_t ia_flags;
143 char ia_ifname[LIFNAMSIZ];
144 char ia_aobjname[IPADM_AOBJSIZ];
145 char ia_module[MAXPROTONAMELEN];
146 char ia_pname[MAXPROPNAMELEN];
147 char ia_pval[MAXPROPVALLEN];
148 } ipmgmt_prop_arg_t;
149 /*
150 * ia_flags used in ipmgmt_prop_arg_t.
151 * - APPEND updates the multi-valued property entry with a new value
152 * - REDUCE updates the multi-valued property entry by removing a value
153 */
154 #define IPMGMT_APPEND 0x00000001
155 #define IPMGMT_REMOVE 0x00000002
156
157 /*
158 * ipadm_addr_type_t-specific values that are cached in ipmgmtd and can
159 * make a round-trip back to client programs
160 */
161 typedef union {
162 struct {
163 boolean_t ipmgmt_linklocal;
164 struct sockaddr_in6 ipmgmt_ifid;
165 } ipmgmt_ipv6_cache_s;
166 struct {
167 boolean_t ipmgmt_primary;
168 char ipmgmt_reqhost[MAXNAMELEN];
169 } ipmgmt_dhcp_cache_s;
170 } ipmgmt_addr_type_cache_u;
171
172 /* IPMGMT_CMD_GETIF door_call argument structure */
173 typedef struct ipmgmt_getif_arg_s {
174 ipmgmt_door_cmd_type_t ia_cmd;
175 uint32_t ia_flags;
176 char ia_ifname[LIFNAMSIZ];
177 } ipmgmt_getif_arg_t;
178
179 /* IPMGMT_CMD_RESETIF, IPMGMT_CMD_SETIF door_call argument structure */
180 typedef struct ipmgmt_if_arg_s {
181 ipmgmt_door_cmd_type_t ia_cmd;
182 uint32_t ia_flags;
183 char ia_ifname[LIFNAMSIZ];
184 sa_family_t ia_family;
185 } ipmgmt_if_arg_t;
186
187 /* IPMGMT_CMD_INITIF door_call argument structure */
188 typedef struct ipmgmt_initif_arg_s {
189 ipmgmt_door_cmd_type_t ia_cmd;
190 uint32_t ia_flags;
191 sa_family_t ia_family;
221 /*
222 * IPMGMT_CMD_{ADDROBJ_ADD|ADDROBJ_LOOKUPADD|LIFNUM2ADDROBJ|
223 * ADDROBJ2LIFNUM} door_call argument.
224 */
225 typedef struct ipmgmt_aobjop_arg_s {
226 ipmgmt_door_cmd_type_t ia_cmd;
227 uint32_t ia_flags;
228 char ia_aobjname[IPADM_AOBJSIZ];
229 char ia_ifname[LIFNAMSIZ];
230 int32_t ia_lnum;
231 sa_family_t ia_family;
232 ipadm_addr_type_t ia_atype;
233 } ipmgmt_aobjop_arg_t;
234
235 /*
236 * ia_flags used inside the arguments for interface/address commands
237 * - ACTIVE updates the running configuration
238 * - PERSIST updates the permanent data store
239 * - INIT indicates that operation being performed is under init
240 * context
241 * - PROPS_ONLY indicates the update changes the running configuration of
242 * "props" data on the interface/address object. The props are
243 * cached there on the parent, so a PROPS_ONLY change does not
244 * affect the ACTIVE/PERSIST state of the parent.
245 */
246 #define IPMGMT_ACTIVE 0x00000001
247 #define IPMGMT_PERSIST 0x00000002
248 #define IPMGMT_INIT 0x00000004
249 #define IPMGMT_PROPS_ONLY 0x00000008
250
251 /* door call return value */
252 typedef struct ipmgmt_retval_s {
253 int32_t ir_err;
254 } ipmgmt_retval_t;
255
256 /* IPMGMT_CMD_GETADDR door_return value */
257 typedef struct ipmgmt_get_rval_s {
258 int32_t ir_err;
259 size_t ir_nvlsize;
260 /* packed nvl follows */
261 } ipmgmt_get_rval_t;
262
263 /* IPMGMT_CMD_GETPROP door_return value */
264 typedef struct ipmgmt_getprop_rval_s {
265 int32_t ir_err;
266 char ir_pval[MAXPROPVALLEN];
267 } ipmgmt_getprop_rval_t;
268
269 /* IPMGMT_CMD_GETIF door_return value */
270 typedef struct ipmgmt_getif_rval_s {
271 int32_t ir_err;
272 uint32_t ir_ifcnt;
273 ipadm_if_info_t ir_ifinfo[1];
274 } ipmgmt_getif_rval_t;
275
276 /* IPMGMT_CMD_{LOOKUPADD|LIFNUM2ADDROBJ|ADDROBJ2LIFNUM} door_return value */
277 typedef struct ipmgmt_aobjop_rval_s {
278 int32_t ir_err;
279 char ir_aobjname[IPADM_AOBJSIZ];
280 char ir_ifname[LIFNAMSIZ];
281 int32_t ir_lnum;
282 sa_family_t ir_family;
283 uint32_t ir_flags;
284 ipadm_addr_type_t ir_atype;
285 ipmgmt_addr_type_cache_u ir_atype_cache;
286 } ipmgmt_aobjop_rval_t;
287
288 #define ipmgmt_ir_intfid ir_atype_cache. \
289 ipmgmt_ipv6_cache_s.ipmgmt_ifid
290 #define ipmgmt_ir_primary ir_atype_cache. \
291 ipmgmt_dhcp_cache_s.ipmgmt_primary
292 #define ipmgmt_ir_reqhost ir_atype_cache. \
293 ipmgmt_dhcp_cache_s.ipmgmt_reqhost
294
295 /* DB walk callback functions */
296 typedef boolean_t db_wfunc_t(void *, nvlist_t *, char *, size_t, int *);
297 extern int ipadm_rw_db(db_wfunc_t *, void *, const char *, mode_t,
298 ipadm_db_op_t);
299
300 /* zone related functions */
301 /*
302 * callback function to persist an interface in ipmgmtd data store
303 */
304 typedef void (*persist_cb_t)(char *, boolean_t, boolean_t);
305 /*
306 * ipmgmtd/libipadm network initialization interface.
307 */
308 extern ipadm_status_t ipadm_init_net_from_gz(ipadm_handle_t, char *,
309 persist_cb_t);
310
311 #ifdef __cplusplus
312 }
313 #endif
314
|