xref: /titanic_41/usr/src/lib/libipadm/common/libipadm_impl.h (revision dab7de2d0395d3b5e8dc742f164561b3840dd8c6)
1 /*
2  * CDDL HEADER START
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 _LIBIPADM_IMPL_H
26 #define	_LIBIPADM_IMPL_H
27 
28 #ifdef	__cplusplus
29 extern "C" {
30 #endif
31 
32 #include <sys/socket.h>
33 #include <net/if.h>
34 #include <libipadm.h>
35 #include <libdladm.h>
36 #include <ipadm_ipmgmt.h>
37 #include <inet/tunables.h>
38 #include <netinet/in.h>
39 #include <pthread.h>
40 #include <libinetutil.h>
41 #include <libsocket_priv.h>
42 
43 #define	IPADM_STRSIZE		256
44 #define	IPADM_ONSTR		"on"
45 #define	IPADM_OFFSTR		"off"
46 #define	ARP_MOD_NAME		"arp"
47 #define	IPADM_LOGICAL_SEP	':'
48 #define	IPV6_MIN_MTU		1280	/* rfc2460 */
49 
50 /* mask for flags accepted by libipadm functions */
51 #define	IPADM_COMMON_OPT_MASK	(IPADM_OPT_ACTIVE | IPADM_OPT_PERSIST)
52 
53 /* Opaque library handle */
54 struct ipadm_handle {
55 	int		iph_sock;	/* socket to interface */
56 	int		iph_sock6;	/* socket to interface */
57 	int		iph_door_fd;	/* door descriptor to ipmgmtd */
58 	int		iph_rtsock;	/* routing socket */
59 	dladm_handle_t	iph_dlh;	/* handle to libdladm library */
60 	uint32_t	iph_flags;	/* internal flags */
61 	pthread_mutex_t	iph_lock;	/* lock to set door_fd */
62 	zoneid_t	iph_zoneid;	/* zoneid where handle was opened */
63 };
64 
65 struct ipadm_addrobj_s {
66 	char 			ipadm_ifname[LIFNAMSIZ];
67 	int32_t			ipadm_lifnum;
68 	char			ipadm_aobjname[IPADM_AOBJSIZ];
69 	ipadm_addr_type_t	ipadm_atype;
70 	uint32_t		ipadm_flags;
71 	sa_family_t		ipadm_af;
72 	union {
73 		struct {
74 			char			ipadm_ahname[MAXNAMELEN];
75 			struct sockaddr_storage	ipadm_addr;
76 			uint32_t		ipadm_prefixlen;
77 			char			ipadm_dhname[MAXNAMELEN];
78 			struct sockaddr_storage ipadm_dstaddr;
79 		} ipadm_static_addr_s;
80 		struct {
81 			struct sockaddr_in6	ipadm_intfid;
82 			uint32_t		ipadm_intfidlen;
83 			boolean_t		ipadm_stateless;
84 			boolean_t		ipadm_stateful;
85 		} ipadm_ipv6_intfid_s;
86 		struct {
87 			boolean_t		ipadm_primary;
88 			int32_t			ipadm_wait;
89 		} ipadm_dhcp_s;
90 	} ipadm_addr_u;
91 };
92 
93 #define	ipadm_static_addr	ipadm_addr_u.ipadm_static_addr_s.ipadm_addr
94 #define	ipadm_static_aname	ipadm_addr_u.ipadm_static_addr_s.ipadm_ahname
95 #define	ipadm_static_prefixlen	ipadm_addr_u.ipadm_static_addr_s.ipadm_prefixlen
96 #define	ipadm_static_dst_addr	ipadm_addr_u.ipadm_static_addr_s.ipadm_dstaddr
97 #define	ipadm_static_dname	ipadm_addr_u.ipadm_static_addr_s.ipadm_dhname
98 #define	ipadm_intfid		ipadm_addr_u.ipadm_ipv6_intfid_s.ipadm_intfid
99 #define	ipadm_intfidlen		ipadm_addr_u.ipadm_ipv6_intfid_s.ipadm_intfidlen
100 #define	ipadm_stateless		ipadm_addr_u.ipadm_ipv6_intfid_s.ipadm_stateless
101 #define	ipadm_stateful		ipadm_addr_u.ipadm_ipv6_intfid_s.ipadm_stateful
102 #define	ipadm_primary		ipadm_addr_u.ipadm_dhcp_s.ipadm_primary
103 #define	ipadm_wait		ipadm_addr_u.ipadm_dhcp_s.ipadm_wait
104 
105 /*
106  * Data structures and callback functions related to property management
107  */
108 struct ipadm_prop_desc;
109 typedef struct ipadm_prop_desc ipadm_prop_desc_t;
110 
111 /* property set() callback */
112 typedef ipadm_status_t	ipadm_pd_setf_t(ipadm_handle_t, const void *,
113     ipadm_prop_desc_t *, const void *, uint_t, uint_t);
114 
115 /* property get() callback */
116 typedef ipadm_status_t	ipadm_pd_getf_t(ipadm_handle_t, const void *,
117     ipadm_prop_desc_t *, char *, uint_t *, uint_t, uint_t);
118 
119 struct ipadm_prop_desc {
120 	char		*ipd_name;	/* property name */
121 	uint_t		ipd_class; 	/* prop. class - global/perif/both */
122 	uint_t		ipd_proto;	/* protocol to which property belongs */
123 	uint_t		ipd_flags;	/* see below */
124 	ipadm_pd_setf_t	*ipd_set;	/* set callback function */
125 	ipadm_pd_getf_t	*ipd_get_range;	/* get range callback function */
126 	ipadm_pd_getf_t	*ipd_get;	/* get value callback function */
127 };
128 
129 /* ipd_flags values */
130 #define	IPADMPROP_MULVAL	0x00000001	/* property multi-valued */
131 
132 extern ipadm_prop_desc_t	ipadm_addrprop_table[];
133 extern ipadm_pd_getf_t		i_ipadm_get_onoff;
134 
135 /* libipadm.c */
136 extern ipadm_status_t	i_ipadm_get_flags(ipadm_handle_t, const char *,
137 			    sa_family_t, uint64_t *);
138 extern ipadm_status_t	i_ipadm_set_flags(ipadm_handle_t, const char *,
139 			    sa_family_t, uint64_t, uint64_t);
140 extern ipadm_status_t	i_ipadm_init_ifs(ipadm_handle_t, const char *,
141 			    nvlist_t **);
142 extern ipadm_status_t	i_ipadm_init_ifobj(ipadm_handle_t, const char *,
143 			    nvlist_t *);
144 extern ipadm_status_t	i_ipadm_init_addrobj(ipadm_handle_t, nvlist_t *);
145 extern ipadm_status_t	i_ipadm_addr_persist(ipadm_handle_t,
146 			    const ipadm_addrobj_t, boolean_t, uint32_t);
147 extern ipadm_status_t	i_ipadm_delete_addr(ipadm_handle_t, ipadm_addrobj_t);
148 extern int		i_ipadm_strioctl(int, int, char *, int);
149 extern boolean_t	i_ipadm_is_loopback(const char *);
150 extern boolean_t	i_ipadm_is_vni(const char *);
151 extern boolean_t	i_ipadm_is_ipmp(ipadm_handle_t, const char *);
152 extern boolean_t	i_ipadm_is_under_ipmp(ipadm_handle_t, const char *);
153 extern boolean_t	i_ipadm_is_6to4(ipadm_handle_t, char *);
154 extern boolean_t	i_ipadm_validate_ifname(ipadm_handle_t, const char *);
155 extern ipadm_status_t	ipadm_errno2status(int);
156 extern int		ipadm_door_call(ipadm_handle_t, void *, size_t, void **,
157 			    size_t, boolean_t);
158 extern boolean_t 	ipadm_if_enabled(ipadm_handle_t, const char *,
159 			    sa_family_t);
160 
161 /* ipadm_ndpd.c */
162 extern	ipadm_status_t	i_ipadm_create_ipv6addrs(ipadm_handle_t,
163 			    ipadm_addrobj_t, uint32_t);
164 extern ipadm_status_t	i_ipadm_delete_ipv6addrs(ipadm_handle_t,
165 			    ipadm_addrobj_t);
166 extern ipadm_status_t	i_ipadm_disable_autoconf(const char *);
167 extern ipadm_status_t	i_ipadm_enable_autoconf(const char *);
168 
169 /* ipadm_persist.c */
170 extern ipadm_status_t	i_ipadm_add_ipaddr2nvl(nvlist_t *, ipadm_addrobj_t);
171 extern ipadm_status_t	i_ipadm_add_ip6addr2nvl(nvlist_t *, ipadm_addrobj_t);
172 extern ipadm_status_t	i_ipadm_add_intfid2nvl(nvlist_t *, ipadm_addrobj_t);
173 extern ipadm_status_t	i_ipadm_add_dhcp2nvl(nvlist_t *, boolean_t, int32_t);
174 
175 /* ipadm_prop.c */
176 extern ipadm_status_t	i_ipadm_persist_propval(ipadm_handle_t,
177 			    ipadm_prop_desc_t *, const char *, const void *,
178 			    uint_t);
179 extern ipadm_status_t	i_ipadm_get_persist_propval(ipadm_handle_t,
180 			    ipadm_prop_desc_t *, char *, uint_t *,
181 			    const void *);
182 
183 /* ipadm_addr.c */
184 extern void		i_ipadm_init_addr(ipadm_addrobj_t, const char *,
185 			    const char *, ipadm_addr_type_t);
186 extern ipadm_status_t	i_ipadm_merge_prefixlen_from_nvl(nvlist_t *, nvlist_t *,
187 			    const char *);
188 extern ipadm_status_t	i_ipadm_get_addrobj(ipadm_handle_t, ipadm_addrobj_t);
189 extern ipadm_status_t	i_ipadm_enable_static(ipadm_handle_t, const char *,
190 			    nvlist_t *, sa_family_t);
191 extern ipadm_status_t	i_ipadm_enable_dhcp(ipadm_handle_t, const char *,
192 			    nvlist_t *);
193 extern ipadm_status_t	i_ipadm_enable_addrconf(ipadm_handle_t, const char *,
194 			    nvlist_t *);
195 extern void		i_ipadm_addrobj2lifname(ipadm_addrobj_t, char *, int);
196 extern ipadm_status_t	i_ipadm_nvl2in6_addr(nvlist_t *, char *,
197 			    in6_addr_t *);
198 extern ipadm_status_t	i_ipadm_get_lif2addrobj(ipadm_handle_t,
199 			    ipadm_addrobj_t);
200 extern ipadm_status_t	i_ipadm_lookupadd_addrobj(ipadm_handle_t,
201 			    ipadm_addrobj_t);
202 extern ipadm_status_t	i_ipadm_setlifnum_addrobj(ipadm_handle_t,
203 			    ipadm_addrobj_t);
204 extern ipadm_status_t	i_ipadm_do_addif(ipadm_handle_t, ipadm_addrobj_t);
205 extern ipadm_status_t	i_ipadm_delete_addrobj(ipadm_handle_t,
206 			    const ipadm_addrobj_t, uint32_t);
207 extern boolean_t	i_ipadm_name2atype(const char *, sa_family_t *,
208 			    ipadm_addr_type_t *);
209 extern ipadm_status_t	i_ipadm_resolve_addr(const char *, sa_family_t,
210 			    struct sockaddr_storage *);
211 
212 /* ipadm_if.c */
213 extern ipadm_status_t	i_ipadm_create_if(ipadm_handle_t, char *,  sa_family_t,
214 			    uint32_t);
215 extern ipadm_status_t	i_ipadm_delete_if(ipadm_handle_t, const char *,
216 			    sa_family_t, uint32_t);
217 extern ipadm_status_t	i_ipadm_plumb_if(ipadm_handle_t, char *, sa_family_t,
218 			    uint32_t);
219 extern ipadm_status_t	i_ipadm_unplumb_if(ipadm_handle_t, const char *,
220 			    sa_family_t);
221 extern ipadm_status_t	i_ipadm_if_pexists(ipadm_handle_t, const char *,
222 			    sa_family_t, boolean_t *);
223 extern ipadm_status_t	i_ipadm_delete_ifobj(ipadm_handle_t, const char *,
224 			    sa_family_t, boolean_t);
225 extern int		i_ipadm_get_lnum(const char *);
226 
227 #ifdef	__cplusplus
228 }
229 #endif
230 
231 #endif	/* _LIBIPADM_IMPL_H */
232