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 */ 24 25 /* 26 * Copyright 2015, Joyent, Inc. 27 * Copyright 2022 OmniOS Community Edition (OmniOSce) Association 28 */ 29 30 #ifndef _LIBDLADM_H 31 #define _LIBDLADM_H 32 33 #include <sys/dls_mgmt.h> 34 #include <sys/dld.h> 35 #include <sys/dlpi.h> 36 #include <libnvpair.h> 37 #include <kstat.h> 38 39 /* 40 * This file includes structures, macros and common routines shared by all 41 * data-link administration, and routines which do not directly administrate 42 * links. For example, dladm_status2str(). 43 */ 44 45 #ifdef __cplusplus 46 extern "C" { 47 #endif 48 49 #define LINKID_STR_WIDTH 10 50 #define DLADM_STRSIZE 256 51 52 /* 53 * option flags taken by the libdladm functions 54 * 55 * - DLADM_OPT_ACTIVE: 56 * The function requests to bringup some configuration that only take 57 * effect on active system (not persistent). 58 * 59 * - DLADM_OPT_PERSIST: 60 * The function requests to persist some configuration. 61 * 62 * - DLADM_OPT_CREATE: 63 * Today, only used by dladm_set_secobj() - requests to create a secobj. 64 * 65 * - DLADM_OPT_FORCE: 66 * The function requests to execute a specific operation forcefully. 67 * 68 * - DLADM_OPT_PREFIX: 69 * The function requests to generate a link name using the specified prefix. 70 * 71 * - DLADM_OPT_VLAN: 72 * Signifies VLAN creation code path 73 * 74 * - DLADM_OPT_NOREFRESH: 75 * Do not refresh the daemon after setting parameter (used by STP mcheck). 76 * 77 * - DLADM_OPT_BOOT: 78 * Bypass check functions during boot (used by pool property since pools 79 * can come up after link properties are set) 80 */ 81 #define DLADM_OPT_ACTIVE 0x00000001 82 #define DLADM_OPT_PERSIST 0x00000002 83 #define DLADM_OPT_CREATE 0x00000004 84 #define DLADM_OPT_FORCE 0x00000008 85 #define DLADM_OPT_PREFIX 0x00000010 86 #define DLADM_OPT_ANCHOR 0x00000020 87 #define DLADM_OPT_VLAN 0x00000040 88 #define DLADM_OPT_NOREFRESH 0x00000080 89 #define DLADM_OPT_BOOT 0x00000100 90 91 #define DLADM_WALK_TERMINATE 0 92 #define DLADM_WALK_CONTINUE -1 93 94 #define DLADM_MAX_ARG_CNT 32 95 #define DLADM_MAX_ARG_VALS 64 96 97 typedef enum { 98 DLADM_STATUS_OK = 0, 99 DLADM_STATUS_BADARG, 100 DLADM_STATUS_FAILED, 101 DLADM_STATUS_TOOSMALL, 102 DLADM_STATUS_NOTSUP, 103 DLADM_STATUS_NOTFOUND, 104 DLADM_STATUS_BADVAL, 105 DLADM_STATUS_NOMEM, 106 DLADM_STATUS_EXIST, 107 DLADM_STATUS_LINKINVAL, 108 DLADM_STATUS_PROPRDONLY, 109 DLADM_STATUS_BADVALCNT, 110 DLADM_STATUS_DBNOTFOUND, 111 DLADM_STATUS_DENIED, 112 DLADM_STATUS_IOERR, 113 DLADM_STATUS_TEMPONLY, 114 DLADM_STATUS_TIMEDOUT, 115 DLADM_STATUS_ISCONN, 116 DLADM_STATUS_NOTCONN, 117 DLADM_STATUS_REPOSITORYINVAL, 118 DLADM_STATUS_MACADDRINVAL, 119 DLADM_STATUS_KEYINVAL, 120 DLADM_STATUS_INVALIDMACADDRLEN, 121 DLADM_STATUS_INVALIDMACADDRTYPE, 122 DLADM_STATUS_LINKBUSY, 123 DLADM_STATUS_VIDINVAL, 124 DLADM_STATUS_NONOTIF, 125 DLADM_STATUS_TRYAGAIN, 126 DLADM_STATUS_IPTUNTYPE, 127 DLADM_STATUS_IPTUNTYPEREQD, 128 DLADM_STATUS_BADIPTUNLADDR, 129 DLADM_STATUS_BADIPTUNRADDR, 130 DLADM_STATUS_ADDRINUSE, 131 DLADM_STATUS_BADTIMEVAL, 132 DLADM_STATUS_INVALIDMACADDR, 133 DLADM_STATUS_INVALIDMACADDRNIC, 134 DLADM_STATUS_INVALIDMACADDRINUSE, 135 DLADM_STATUS_MACFACTORYSLOTINVALID, 136 DLADM_STATUS_MACFACTORYSLOTUSED, 137 DLADM_STATUS_MACFACTORYSLOTALLUSED, 138 DLADM_STATUS_MACFACTORYNOTSUP, 139 DLADM_STATUS_INVALIDMACPREFIX, 140 DLADM_STATUS_INVALIDMACPREFIXLEN, 141 DLADM_STATUS_BADCPUID, 142 DLADM_STATUS_CPUERR, 143 DLADM_STATUS_CPUNOTONLINE, 144 DLADM_STATUS_BADRANGE, 145 DLADM_STATUS_TOOMANYELEMENTS, 146 DLADM_STATUS_DB_NOTFOUND, 147 DLADM_STATUS_DB_PARSE_ERR, 148 DLADM_STATUS_PROP_PARSE_ERR, 149 DLADM_STATUS_ATTR_PARSE_ERR, 150 DLADM_STATUS_FLOW_DB_ERR, 151 DLADM_STATUS_FLOW_DB_OPEN_ERR, 152 DLADM_STATUS_FLOW_DB_PARSE_ERR, 153 DLADM_STATUS_FLOWPROP_DB_PARSE_ERR, 154 DLADM_STATUS_FLOW_ADD_ERR, 155 DLADM_STATUS_FLOW_WALK_ERR, 156 DLADM_STATUS_FLOW_IDENTICAL, 157 DLADM_STATUS_FLOW_INCOMPATIBLE, 158 DLADM_STATUS_FLOW_EXISTS, 159 DLADM_STATUS_PERSIST_FLOW_EXISTS, 160 DLADM_STATUS_INVALID_IP, 161 DLADM_STATUS_INVALID_PREFIXLEN, 162 DLADM_STATUS_INVALID_PROTOCOL, 163 DLADM_STATUS_INVALID_PORT, 164 DLADM_STATUS_INVALID_DSF, 165 DLADM_STATUS_INVALID_DSFMASK, 166 DLADM_STATUS_INVALID_MACMARGIN, 167 DLADM_STATUS_NOTDEFINED, 168 DLADM_STATUS_BADPROP, 169 DLADM_STATUS_MINMAXBW, 170 DLADM_STATUS_NO_HWRINGS, 171 DLADM_STATUS_PERMONLY, 172 DLADM_STATUS_OPTMISSING, 173 DLADM_STATUS_POOLCPU, 174 DLADM_STATUS_INVALID_PORT_INSTANCE, 175 DLADM_STATUS_PORT_IS_DOWN, 176 DLADM_STATUS_PKEY_NOT_PRESENT, 177 DLADM_STATUS_PARTITION_EXISTS, 178 DLADM_STATUS_INVALID_PKEY, 179 DLADM_STATUS_NO_IB_HW_RESOURCE, 180 DLADM_STATUS_INVALID_PKEY_TBL_SIZE, 181 DLADM_STATUS_PORT_NOPROTO, 182 DLADM_STATUS_INVALID_MTU, 183 DLADM_STATUS_PERSIST_ON_TEMP, 184 DLADM_STATUS_BAD_ENCAP, 185 DLADM_STATUS_ADDRNOTAVAIL 186 } dladm_status_t; 187 188 typedef enum { 189 DLADM_TYPE_STR, 190 DLADM_TYPE_BOOLEAN, 191 DLADM_TYPE_UINT64 192 } dladm_datatype_t; 193 194 typedef struct { 195 boolean_t ds_readonly; 196 union { 197 int dsu_confid; 198 nvlist_t *dsu_nvl; 199 } ds_u; 200 } dladm_conf_t; 201 202 #define ds_confid ds_u.dsu_confid 203 #define ds_nvl ds_u.dsu_nvl 204 205 #define DLADM_INVALID_CONF 0 206 207 /* opaque dladm handle to libdladm functions */ 208 struct dladm_handle; 209 typedef struct dladm_handle *dladm_handle_t; 210 211 /* open/close handle */ 212 extern dladm_status_t dladm_open(dladm_handle_t *); 213 extern void dladm_close(dladm_handle_t); 214 215 /* 216 * retrieve the dld file descriptor from handle, only libdladm and 217 * dlmgmtd are given access to the door file descriptor. 218 */ 219 extern int dladm_dld_fd(dladm_handle_t); 220 /* 221 * Retrieve kstat_ctl_t* from handle.The libkstat handle is opened 222 * when the first caller needs it.This allows the library to share 223 * the kstat handle. 224 */ 225 extern kstat_ctl_t *dladm_dld_kcp(dladm_handle_t); 226 227 typedef struct dladm_arg_info { 228 const char *ai_name; 229 char *ai_val[DLADM_MAX_ARG_VALS]; 230 uint_t ai_count; 231 } dladm_arg_info_t; 232 233 typedef struct dladm_arg_list { 234 dladm_arg_info_t al_info[DLADM_MAX_ARG_CNT]; 235 uint_t al_count; 236 char *al_buf; 237 } dladm_arg_list_t; 238 239 typedef struct dladm_errlist { 240 uint_t el_count; 241 uint_t el_alloc; 242 char **el_errs; 243 } dladm_errlist_t; 244 245 typedef enum { 246 DLADM_LOGTYPE_LINK = 1, 247 DLADM_LOGTYPE_FLOW 248 } dladm_logtype_t; 249 250 typedef struct dladm_usage { 251 char du_name[MAXLINKNAMELEN]; 252 uint64_t du_duration; 253 uint64_t du_stime; 254 uint64_t du_etime; 255 uint64_t du_ipackets; 256 uint64_t du_rbytes; 257 uint64_t du_opackets; 258 uint64_t du_obytes; 259 uint64_t du_bandwidth; 260 boolean_t du_last; 261 } dladm_usage_t; 262 263 extern const char *dladm_status2str(dladm_status_t, char *); 264 extern dladm_status_t dladm_set_rootdir(const char *); 265 extern const char *dladm_class2str(datalink_class_t, char *); 266 extern const char *dladm_media2str(uint32_t, char *); 267 extern uint32_t dladm_str2media(const char *); 268 extern boolean_t dladm_valid_linkname(const char *); 269 extern boolean_t dladm_str2interval(char *, uint32_t *); 270 extern dladm_status_t dladm_str2bw(char *, uint64_t *); 271 extern const char *dladm_bw2str(int64_t, char *); 272 extern dladm_status_t dladm_str2pri(char *, mac_priority_level_t *); 273 extern const char *dladm_pri2str(mac_priority_level_t, char *); 274 extern dladm_status_t dladm_str2protect(char *, uint32_t *); 275 extern const char *dladm_protect2str(uint32_t, char *); 276 extern dladm_status_t dladm_str2ipv4addr(char *, void *); 277 extern const char *dladm_ipv4addr2str(void *, char *); 278 extern dladm_status_t dladm_str2ipv6addr(char *, void *); 279 extern const char *dladm_ipv6addr2str(void *, char *); 280 281 extern dladm_status_t dladm_parse_flow_props(char *, dladm_arg_list_t **, 282 boolean_t); 283 extern dladm_status_t dladm_parse_link_props(char *, dladm_arg_list_t **, 284 boolean_t); 285 extern void dladm_free_props(dladm_arg_list_t *); 286 extern dladm_status_t dladm_parse_flow_attrs(char *, dladm_arg_list_t **, 287 boolean_t); 288 extern void dladm_free_attrs(dladm_arg_list_t *); 289 290 extern dladm_status_t dladm_start_usagelog(dladm_handle_t, dladm_logtype_t, 291 uint_t); 292 extern dladm_status_t dladm_stop_usagelog(dladm_handle_t, dladm_logtype_t); 293 extern dladm_status_t dladm_walk_usage_res(int (*)(dladm_usage_t *, void *), 294 int, char *, char *, char *, char *, void *); 295 extern dladm_status_t dladm_walk_usage_time(int (*)(dladm_usage_t *, void *), 296 int, char *, char *, char *, void *); 297 extern dladm_status_t dladm_usage_summary(int (*)(dladm_usage_t *, void *), 298 int, char *, void *); 299 extern dladm_status_t dladm_usage_dates(int (*)(dladm_usage_t *, void *), 300 int, char *, char *, void *); 301 extern dladm_status_t dladm_zone_boot(dladm_handle_t, zoneid_t); 302 extern dladm_status_t dladm_zone_halt(dladm_handle_t, zoneid_t); 303 304 extern dladm_status_t dladm_strs2range(char **, uint_t, mac_propval_type_t, 305 mac_propval_range_t **); 306 extern dladm_status_t dladm_range2list(const mac_propval_range_t *, void *, 307 uint_t *); 308 extern int dladm_range2strs(const mac_propval_range_t *, char **); 309 extern dladm_status_t dladm_list2range(void *, uint_t, mac_propval_type_t, 310 mac_propval_range_t **); 311 312 extern uint_t dladm_errlist_count(dladm_errlist_t *); 313 extern void dladm_errlist_init(dladm_errlist_t *); 314 extern void dladm_errlist_reset(dladm_errlist_t *); 315 316 #ifdef __cplusplus 317 } 318 #endif 319 320 #endif /* _LIBDLADM_H */ 321