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 _LIBDLADM_H
27 #define _LIBDLADM_H
28
29 #include <sys/dls_mgmt.h>
30 #include <sys/dld.h>
31 #include <sys/dlpi.h>
32 #include <libnvpair.h>
33
34 /*
35 * This file includes structures, macros and common routines shared by all
36 * data-link administration, and routines which do not directly administrate
37 * links. For example, dladm_status2str().
38 */
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #define LINKID_STR_WIDTH 10
45 #define DLADM_STRSIZE 256
46
47 /*
48 * option flags taken by the libdladm functions
49 *
50 * - DLADM_OPT_ACTIVE:
51 * The function requests to bringup some configuration that only take
52 * effect on active system (not persistent).
53 *
54 * - DLADM_OPT_PERSIST:
55 * The function requests to persist some configuration.
56 *
57 * - DLADM_OPT_CREATE:
58 * Today, only used by dladm_set_secobj() - requests to create a secobj.
59 *
60 * - DLADM_OPT_FORCE:
61 * The function requests to execute a specific operation forcefully.
62 *
63 * - DLADM_OPT_PREFIX:
64 * The function requests to generate a link name using the specified prefix.
65 *
66 * - DLADM_OPT_VLAN:
67 * Signifies VLAN creation code path
68 *
69 * - DLADM_OPT_NOREFRESH:
70 * Do not refresh the daemon after setting parameter (used by STP mcheck).
71 *
72 * - DLADM_OPT_BOOT:
73 * Bypass check functions during boot (used by pool property since pools
74 * can come up after link properties are set)
75 *
76 * - DLADM_OPT_TRANSIENT:
77 * Indicates that the link assigned to a zone is transient and will be
78 * removed when the zone shuts down.
79 */
80 #define DLADM_OPT_ACTIVE 0x00000001
81 #define DLADM_OPT_PERSIST 0x00000002
82 #define DLADM_OPT_CREATE 0x00000004
83 #define DLADM_OPT_FORCE 0x00000008
84 #define DLADM_OPT_PREFIX 0x00000010
85 #define DLADM_OPT_ANCHOR 0x00000020
86 #define DLADM_OPT_VLAN 0x00000040
87 #define DLADM_OPT_NOREFRESH 0x00000080
88 #define DLADM_OPT_BOOT 0x00000100
89 #define DLADM_OPT_TRANSIENT 0x00000200
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_t;
184
185 typedef enum {
186 DLADM_TYPE_STR,
187 DLADM_TYPE_BOOLEAN,
188 DLADM_TYPE_UINT64
189 } dladm_datatype_t;
190
191 typedef struct {
192 boolean_t ds_readonly;
193 union {
194 int dsu_confid;
195 nvlist_t *dsu_nvl;
196 } ds_u;
197 } dladm_conf_t;
198
199 #define ds_confid ds_u.dsu_confid
200 #define ds_nvl ds_u.dsu_nvl
201
202 #define DLADM_INVALID_CONF 0
203
204 /* opaque dladm handle to libdladm functions */
205 struct dladm_handle;
206 typedef struct dladm_handle *dladm_handle_t;
207
208 /* open/close handle */
209 extern dladm_status_t dladm_open(dladm_handle_t *);
210 extern void dladm_close(dladm_handle_t);
211
212 /*
213 * retrieve the dld file descriptor from handle, only libdladm and
214 * dlmgmtd are given access to the door file descriptor.
215 */
216 extern int dladm_dld_fd(dladm_handle_t);
217
218 typedef struct dladm_arg_info {
219 const char *ai_name;
220 char *ai_val[DLADM_MAX_ARG_VALS];
221 uint_t ai_count;
222 } dladm_arg_info_t;
223
224 typedef struct dladm_arg_list {
225 dladm_arg_info_t al_info[DLADM_MAX_ARG_CNT];
226 uint_t al_count;
227 char *al_buf;
228 } dladm_arg_list_t;
229
230 typedef enum {
231 DLADM_LOGTYPE_LINK = 1,
232 DLADM_LOGTYPE_FLOW
233 } dladm_logtype_t;
234
235 typedef struct dladm_usage {
236 char du_name[MAXLINKNAMELEN];
237 uint64_t du_duration;
238 uint64_t du_stime;
239 uint64_t du_etime;
240 uint64_t du_ipackets;
241 uint64_t du_rbytes;
242 uint64_t du_opackets;
243 uint64_t du_obytes;
244 uint64_t du_bandwidth;
245 boolean_t du_last;
246 } dladm_usage_t;
247
248 extern const char *dladm_status2str(dladm_status_t, char *);
249 extern dladm_status_t dladm_set_rootdir(const char *);
250 extern const char *dladm_class2str(datalink_class_t, char *);
251 extern const char *dladm_media2str(uint32_t, char *);
252 extern uint32_t dladm_str2media(const char *);
253 extern boolean_t dladm_valid_linkname(const char *);
254 extern boolean_t dladm_str2interval(char *, uint32_t *);
255 extern dladm_status_t dladm_str2bw(char *, uint64_t *);
256 extern const char *dladm_bw2str(int64_t, char *);
257 extern dladm_status_t dladm_str2pri(char *, mac_priority_level_t *);
258 extern const char *dladm_pri2str(mac_priority_level_t, char *);
259 extern dladm_status_t dladm_str2protect(char *, uint32_t *);
260 extern const char *dladm_protect2str(uint32_t, char *);
261 extern dladm_status_t dladm_str2ipv4addr(char *, void *);
262 extern const char *dladm_ipv4addr2str(void *, char *);
263 extern dladm_status_t dladm_str2ipv6addr(char *, void *);
264 extern const char *dladm_ipv6addr2str(void *, char *);
265
266 extern dladm_status_t dladm_parse_flow_props(char *, dladm_arg_list_t **,
267 boolean_t);
268 extern dladm_status_t dladm_parse_link_props(char *, dladm_arg_list_t **,
269 boolean_t);
270 extern void dladm_free_props(dladm_arg_list_t *);
271 extern dladm_status_t dladm_parse_flow_attrs(char *, dladm_arg_list_t **,
272 boolean_t);
273 extern void dladm_free_attrs(dladm_arg_list_t *);
274
275 extern dladm_status_t dladm_start_usagelog(dladm_handle_t, dladm_logtype_t,
276 uint_t);
277 extern dladm_status_t dladm_stop_usagelog(dladm_handle_t, dladm_logtype_t);
278 extern dladm_status_t dladm_walk_usage_res(int (*)(dladm_usage_t *, void *),
279 int, char *, char *, char *, char *, void *);
280 extern dladm_status_t dladm_walk_usage_time(int (*)(dladm_usage_t *, void *),
281 int, char *, char *, char *, void *);
282 extern dladm_status_t dladm_usage_summary(int (*)(dladm_usage_t *, void *),
283 int, char *, void *);
284 extern dladm_status_t dladm_usage_dates(int (*)(dladm_usage_t *, void *),
285 int, char *, char *, void *);
286 extern dladm_status_t dladm_zone_boot(dladm_handle_t, zoneid_t);
287 extern dladm_status_t dladm_zone_halt(dladm_handle_t, zoneid_t);
288
289 extern dladm_status_t dladm_strs2range(char **, uint_t, mac_propval_type_t,
290 mac_propval_range_t **);
291 extern dladm_status_t dladm_range2list(mac_propval_range_t *, void*,
292 uint_t *);
293 extern int dladm_range2strs(mac_propval_range_t *, char **);
294 extern dladm_status_t dladm_list2range(void *, uint_t, mac_propval_type_t,
295 mac_propval_range_t **);
296
297 #ifdef __cplusplus
298 }
299 #endif
300
301 #endif /* _LIBDLADM_H */