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