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) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
  23  * Copyright (c) 2011, Joyent Inc. All rights reserved.
  24  */
  25 
  26 #ifndef _LIBDLLINK_H
  27 #define _LIBDLLINK_H
  28 
  29 /*
  30  * This file includes structures, macros and routines used by general
  31  * link administration (i.e. not limited to one specific type of link).
  32  */
  33 
  34 #include <stdio.h>
  35 #include <sys/types.h>
  36 #include <sys/param.h>
  37 #include <sys/mac.h>
  38 #include <sys/dld.h>
  39 #include <libdladm.h>
  40 
  41 #ifdef  __cplusplus
  42 extern "C" {
  43 #endif
  44 
  45 typedef struct dladm_attr {
  46         uint_t                  da_max_sdu;
  47 } dladm_attr_t;
  48 
  49 typedef struct dladm_phys_attr {
  50         char            dp_dev[MAXLINKNAMELEN];
  51         /*
  52          * Whether this physical link supports vanity naming (links with media
  53          * types not supported by GLDv3 don't have vanity naming support).
  54          */
  55         boolean_t       dp_novanity;
  56 } dladm_phys_attr_t;
  57 
  58 typedef enum {
  59         DLADM_PROP_VAL_CURRENT = 1,
  60         DLADM_PROP_VAL_DEFAULT,
  61         DLADM_PROP_VAL_PERM,
  62         DLADM_PROP_VAL_MODIFIABLE,
  63         DLADM_PROP_VAL_PERSISTENT
  64 } dladm_prop_type_t;
  65 
  66 /*
  67  * Maximum size of secobj value. Note that it should not be greater than
  68  * DLD_SECOBJ_VAL_MAX.
  69  */
  70 #define DLADM_SECOBJ_VAL_MAX    256
  71 
  72 /*
  73  * Maximum size of secobj name. Note that it should not be greater than
  74  * DLD_SECOBJ_NAME_MAX.
  75  */
  76 #define DLADM_SECOBJ_NAME_MAX   32
  77 
  78 #define DLADM_MAX_PROP_VALCNT   32
  79 /*
  80  * Size of prop_val buffer passed to pd_get function must be at
  81  * least DLADM_PROP_VAL_MAX
  82  */
  83 #define DLADM_PROP_VAL_MAX      128
  84 
  85 #define         DLADM_SECOBJ_CLASS_WEP  0
  86 #define         DLADM_SECOBJ_CLASS_WPA  1
  87 typedef int     dladm_secobj_class_t;
  88 
  89 typedef int (dladm_walkcb_t)(const char *, void *);
  90 
  91 /* possible flags for ma_flags below */
  92 #define DLADM_MACADDR_USED      0x1
  93 
  94 typedef enum {
  95         DLADM_HWGRP_TYPE_RX = 0x1,
  96         DLADM_HWGRP_TYPE_TX
  97 } dladm_hwgrp_type_t;
  98 
  99 typedef struct dladm_hwgrp_attr {
 100         char            hg_link_name[MAXLINKNAMELEN];
 101         uint_t          hg_grp_num;
 102         dladm_hwgrp_type_t      hg_grp_type;
 103         uint_t          hg_n_rings;
 104         uint_t          hg_rings[MAX_RINGS_PER_GROUP];
 105         uint_t          hg_n_clnts;
 106         char            hg_client_names[MAXCLIENTNAMELEN];
 107 } dladm_hwgrp_attr_t;
 108 
 109 typedef struct dladm_macaddr_attr {
 110         uint_t          ma_slot;
 111         uint_t          ma_flags;
 112         uchar_t         ma_addr[MAXMACADDRLEN];
 113         uint_t          ma_addrlen;
 114         char            ma_client_name[MAXNAMELEN];
 115         datalink_id_t   ma_client_linkid;
 116 } dladm_macaddr_attr_t;
 117 
 118 extern dladm_status_t   dladm_walk(dladm_walkcb_t *, dladm_handle_t, void *,
 119                             datalink_class_t, datalink_media_t, uint32_t);
 120 extern dladm_status_t   dladm_mac_walk(dladm_walkcb_t *, void *);
 121 extern dladm_status_t   dladm_info(dladm_handle_t, datalink_id_t,
 122                             dladm_attr_t *);
 123 
 124 extern dladm_status_t   dladm_rename_link(dladm_handle_t, const char *,
 125                             const char *, const char *);
 126 
 127 extern dladm_status_t   dladm_set_linkprop(dladm_handle_t, datalink_id_t,
 128                             const char *, char **, uint_t, uint_t);
 129 extern dladm_status_t   dladm_get_linkprop(dladm_handle_t, datalink_id_t,
 130                             dladm_prop_type_t, const char *, char **, uint_t *);
 131 extern dladm_status_t   dladm_get_linkprop_values(dladm_handle_t, datalink_id_t,
 132                             dladm_prop_type_t, const char *, uint_t *,
 133                             uint_t *);
 134 extern dladm_status_t   dladm_walk_linkprop(dladm_handle_t, datalink_id_t,
 135                             void *, int (*)(dladm_handle_t, datalink_id_t,
 136                             const char *, void *));
 137 extern boolean_t        dladm_attr_is_linkprop(const char *name);
 138 extern dladm_status_t   dladm_linkprop_is_set(dladm_handle_t, datalink_id_t,
 139                             dladm_prop_type_t, const char *, boolean_t *);
 140 
 141 extern dladm_status_t   dladm_set_secobj(dladm_handle_t, const char *,
 142                             dladm_secobj_class_t, uint8_t *, uint_t, uint_t);
 143 extern dladm_status_t   dladm_get_secobj(dladm_handle_t, const char *,
 144                             dladm_secobj_class_t *, uint8_t *, uint_t *,
 145                             uint_t);
 146 extern dladm_status_t   dladm_unset_secobj(dladm_handle_t, const char *,
 147                             uint_t);
 148 extern dladm_status_t   dladm_walk_secobj(dladm_handle_t, void *,
 149                             boolean_t (*)(dladm_handle_t, void *, const char *),
 150                             uint_t);
 151 
 152 extern const char       *dladm_linkstate2str(link_state_t, char *);
 153 extern const char       *dladm_linkduplex2str(link_duplex_t, char *);
 154 extern const char       *dladm_secobjclass2str(dladm_secobj_class_t, char *);
 155 extern dladm_status_t   dladm_str2secobjclass(const char *,
 156                             dladm_secobj_class_t *);
 157 
 158 extern dladm_status_t   dladm_init_linkprop(dladm_handle_t, datalink_id_t,
 159                             boolean_t);
 160 extern dladm_status_t   dladm_init_secobj(dladm_handle_t);
 161 extern boolean_t        dladm_valid_secobj_name(const char *);
 162 
 163 extern dladm_status_t   dladm_create_datalink_id(dladm_handle_t, const char *,
 164                             datalink_class_t, uint_t, uint32_t,
 165                             datalink_id_t *);
 166 extern dladm_status_t   dladm_destroy_datalink_id(dladm_handle_t, datalink_id_t,
 167                             uint32_t);
 168 extern dladm_status_t   dladm_remap_datalink_id(dladm_handle_t, datalink_id_t,
 169                             const char *);
 170 extern dladm_status_t   dladm_up_datalink_id(dladm_handle_t, datalink_id_t);
 171 extern dladm_status_t   dladm_name2info(dladm_handle_t, const char *,
 172                             datalink_id_t *, uint32_t *, datalink_class_t *,
 173                             uint32_t *);
 174 extern dladm_status_t   dladm_zname2info(dladm_handle_t, const char *,
 175                             const char *, datalink_id_t *, uint32_t *,
 176                             datalink_class_t *, uint32_t *);
 177 extern dladm_status_t   dladm_datalink_id2info(dladm_handle_t, datalink_id_t,
 178                             uint32_t *, datalink_class_t *, uint32_t *, char *,
 179                             size_t);
 180 extern dladm_status_t   dladm_walk_datalink_id(int (*)(dladm_handle_t,
 181                             datalink_id_t, void *), dladm_handle_t, void *,
 182                             datalink_class_t, datalink_media_t, uint32_t);
 183 extern dladm_status_t   dladm_create_conf(dladm_handle_t, const char *,
 184                             datalink_id_t, datalink_class_t, uint32_t,
 185                             dladm_conf_t *);
 186 extern dladm_status_t   dladm_open_conf(dladm_handle_t, datalink_id_t,
 187                             dladm_conf_t *);
 188 extern dladm_status_t   dladm_getsnap_conf(dladm_handle_t, datalink_id_t,
 189                             dladm_conf_t *);
 190 extern dladm_status_t   dladm_write_conf(dladm_handle_t, dladm_conf_t);
 191 extern dladm_status_t   dladm_remove_conf(dladm_handle_t, datalink_id_t);
 192 extern void             dladm_destroy_conf(dladm_handle_t, dladm_conf_t);
 193 extern dladm_status_t   dladm_get_conf_field(dladm_handle_t, dladm_conf_t,
 194                             const char *, void *, size_t);
 195 extern dladm_status_t   dladm_getnext_conf_linkprop(dladm_handle_t,
 196                             dladm_conf_t, const char *, char *, void *,
 197                             size_t, size_t *);
 198 extern dladm_status_t   dladm_set_conf_field(dladm_handle_t, dladm_conf_t,
 199                             const char *, dladm_datatype_t, const void *);
 200 extern dladm_status_t   dladm_unset_conf_field(dladm_handle_t, dladm_conf_t,
 201                             const char *);
 202 
 203 extern dladm_status_t   dladm_dev2linkid(dladm_handle_t, const char *,
 204                             datalink_id_t *);
 205 extern dladm_status_t   dladm_linkid2legacyname(dladm_handle_t, datalink_id_t,
 206                             char *, size_t);
 207 extern dladm_status_t   dladm_phys_delete(dladm_handle_t, datalink_id_t);
 208 
 209 extern dladm_status_t   dladm_phys_info(dladm_handle_t, datalink_id_t,
 210                             dladm_phys_attr_t *, uint32_t);
 211 extern dladm_status_t   dladm_parselink(const char *, char *, uint_t *);
 212 
 213 extern int              dladm_walk_macaddr(dladm_handle_t, datalink_id_t,
 214                             void *,
 215                             boolean_t (*)(void *, dladm_macaddr_attr_t *));
 216 extern int              dladm_walk_hwgrp(dladm_handle_t, datalink_id_t, void *,
 217                             boolean_t (*)(void *, dladm_hwgrp_attr_t *));
 218 
 219 extern void             dladm_sort_index_list(uint_t [], uint_t);
 220 
 221 extern dladm_status_t   dladm_link_get_proplist(dladm_handle_t, datalink_id_t,
 222                             dladm_arg_list_t **);
 223 
 224 extern dladm_status_t   i_dladm_set_link_proplist_db(char *,
 225                             dladm_arg_list_t *);
 226 
 227 #ifdef  __cplusplus
 228 }
 229 #endif
 230 
 231 #endif  /* _LIBDLLINK_H */