xref: /titanic_41/usr/src/lib/libdladm/common/libdladm.h (revision bfed486ad8de8b8ebc6345a8e10accae08bf2f45)
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 2008 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _LIBDLADM_H
27 #define	_LIBDLADM_H
28 
29 #include <sys/dls_mgmt.h>
30 #include <sys/dlpi.h>
31 
32 /*
33  * This file includes structures, macros and common routines shared by all
34  * data-link administration, and routines which do not directly administrate
35  * links. For example, dladm_status2str().
36  */
37 
38 #ifdef	__cplusplus
39 extern "C" {
40 #endif
41 
42 #define	LINKID_STR_WIDTH	10
43 #define	DLADM_STRSIZE		256
44 
45 /*
46  * option flags taken by the libdladm functions
47  *
48  *  - DLADM_OPT_ACTIVE:
49  *    The function requests to bringup some configuration that only take
50  *    effect on active system (not persistent).
51  *
52  *  - DLADM_OPT_PERSIST:
53  *    The function requests to persist some configuration.
54  *
55  *  - DLADM_OPT_CREATE:
56  *    Today, only used by dladm_set_secobj() - requests to create a secobj.
57  *
58  *  - DLADM_OPT_FORCE:
59  *    The function requests to execute a specific operation forcefully.
60  *
61  *  - DLADM_OPT_PREFIX:
62  *    The function requests to generate a link name using the specified prefix.
63  *
64  *  - DLADM_OPT_VLAN:
65  *    Signifies VLAN creation code path
66  *
67  *  - DLADM_OPT_HWRINGS:
68  *    Requires a hardware group of rings when creating a vnic.
69  */
70 #define	DLADM_OPT_ACTIVE	0x00000001
71 #define	DLADM_OPT_PERSIST	0x00000002
72 #define	DLADM_OPT_CREATE	0x00000004
73 #define	DLADM_OPT_FORCE		0x00000008
74 #define	DLADM_OPT_PREFIX	0x00000010
75 #define	DLADM_OPT_ANCHOR	0x00000020
76 #define	DLADM_OPT_VLAN		0x00000040
77 #define	DLADM_OPT_HWRINGS	0x00000080
78 
79 #define	DLADM_WALK_TERMINATE	0
80 #define	DLADM_WALK_CONTINUE	-1
81 
82 #define	DLADM_MAX_ARG_CNT	32
83 #define	DLADM_MAX_ARG_VALS	32
84 
85 typedef enum {
86 	DLADM_STATUS_OK = 0,
87 	DLADM_STATUS_BADARG,
88 	DLADM_STATUS_FAILED,
89 	DLADM_STATUS_TOOSMALL,
90 	DLADM_STATUS_NOTSUP,
91 	DLADM_STATUS_NOTFOUND,
92 	DLADM_STATUS_BADVAL,
93 	DLADM_STATUS_NOMEM,
94 	DLADM_STATUS_EXIST,
95 	DLADM_STATUS_LINKINVAL,
96 	DLADM_STATUS_PROPRDONLY,
97 	DLADM_STATUS_BADVALCNT,
98 	DLADM_STATUS_DBNOTFOUND,
99 	DLADM_STATUS_DENIED,
100 	DLADM_STATUS_IOERR,
101 	DLADM_STATUS_TEMPONLY,
102 	DLADM_STATUS_TIMEDOUT,
103 	DLADM_STATUS_ISCONN,
104 	DLADM_STATUS_NOTCONN,
105 	DLADM_STATUS_REPOSITORYINVAL,
106 	DLADM_STATUS_MACADDRINVAL,
107 	DLADM_STATUS_KEYINVAL,
108 	DLADM_STATUS_INVALIDMACADDRLEN,
109 	DLADM_STATUS_INVALIDMACADDRTYPE,
110 	DLADM_STATUS_LINKBUSY,
111 	DLADM_STATUS_VIDINVAL,
112 	DLADM_STATUS_NONOTIF,
113 	DLADM_STATUS_TRYAGAIN,
114 	DLADM_STATUS_BADTIMEVAL,
115 	DLADM_STATUS_INVALIDMACADDR,
116 	DLADM_STATUS_INVALIDMACADDRNIC,
117 	DLADM_STATUS_INVALIDMACADDRINUSE,
118 	DLADM_STATUS_MACFACTORYSLOTINVALID,
119 	DLADM_STATUS_MACFACTORYSLOTUSED,
120 	DLADM_STATUS_MACFACTORYSLOTALLUSED,
121 	DLADM_STATUS_MACFACTORYNOTSUP,
122 	DLADM_STATUS_INVALIDMACPREFIX,
123 	DLADM_STATUS_INVALIDMACPREFIXLEN,
124 	DLADM_STATUS_CPUMAX,
125 	DLADM_STATUS_CPUERR,
126 	DLADM_STATUS_CPUNOTONLINE,
127 	DLADM_STATUS_DB_NOTFOUND,
128 	DLADM_STATUS_DB_PARSE_ERR,
129 	DLADM_STATUS_PROP_PARSE_ERR,
130 	DLADM_STATUS_ATTR_PARSE_ERR,
131 	DLADM_STATUS_FLOW_DB_ERR,
132 	DLADM_STATUS_FLOW_DB_OPEN_ERR,
133 	DLADM_STATUS_FLOW_DB_PARSE_ERR,
134 	DLADM_STATUS_FLOWPROP_DB_PARSE_ERR,
135 	DLADM_STATUS_FLOW_ADD_ERR,
136 	DLADM_STATUS_FLOW_WALK_ERR,
137 	DLADM_STATUS_FLOW_IDENTICAL,
138 	DLADM_STATUS_FLOW_INCOMPATIBLE,
139 	DLADM_STATUS_FLOW_EXISTS,
140 	DLADM_STATUS_PERSIST_FLOW_EXISTS,
141 	DLADM_STATUS_INVALID_IP,
142 	DLADM_STATUS_INVALID_PREFIXLEN,
143 	DLADM_STATUS_INVALID_PROTOCOL,
144 	DLADM_STATUS_INVALID_PORT,
145 	DLADM_STATUS_INVALID_DSF,
146 	DLADM_STATUS_INVALID_DSFMASK,
147 	DLADM_STATUS_INVALID_MACMARGIN,
148 	DLADM_STATUS_NOTDEFINED,
149 	DLADM_STATUS_BADPROP,
150 	DLADM_STATUS_MINMAXBW,
151 	DLADM_STATUS_NO_HWRINGS
152 } dladm_status_t;
153 
154 typedef enum {
155 	DLADM_TYPE_STR,
156 	DLADM_TYPE_BOOLEAN,
157 	DLADM_TYPE_UINT64
158 } dladm_datatype_t;
159 
160 typedef int dladm_conf_t;
161 #define	DLADM_INVALID_CONF	0
162 
163 /* opaque dladm handle to libdladm functions */
164 struct dladm_handle;
165 typedef struct dladm_handle *dladm_handle_t;
166 
167 /* open/close handle */
168 extern dladm_status_t	dladm_open(dladm_handle_t *);
169 extern void		dladm_close(dladm_handle_t);
170 
171 /*
172  * retrieve the dld file descriptor from handle, only libdladm and
173  * dlmgmtd are given access to the door file descriptor.
174  */
175 extern int	dladm_dld_fd(dladm_handle_t);
176 
177 typedef struct dladm_arg_info {
178 	const char	*ai_name;
179 	char		*ai_val[DLADM_MAX_ARG_VALS];
180 	uint_t		ai_count;
181 } dladm_arg_info_t;
182 
183 typedef struct dladm_arg_list {
184 	dladm_arg_info_t	al_info[DLADM_MAX_ARG_CNT];
185 	uint_t			al_count;
186 	char			*al_buf;
187 } dladm_arg_list_t;
188 
189 typedef enum {
190 	DLADM_LOGTYPE_LINK = 1,
191 	DLADM_LOGTYPE_FLOW
192 } dladm_logtype_t;
193 
194 typedef struct dladm_usage {
195 	char		du_name[MAXLINKNAMELEN];
196 	uint64_t	du_duration;
197 	uint64_t	du_stime;
198 	uint64_t	du_etime;
199 	uint64_t	du_ipackets;
200 	uint64_t	du_rbytes;
201 	uint64_t	du_opackets;
202 	uint64_t	du_obytes;
203 	uint64_t	du_bandwidth;
204 	boolean_t	du_last;
205 } dladm_usage_t;
206 
207 extern const char	*dladm_status2str(dladm_status_t, char *);
208 extern dladm_status_t	dladm_set_rootdir(const char *);
209 extern const char	*dladm_class2str(datalink_class_t, char *);
210 extern const char	*dladm_media2str(uint32_t, char *);
211 extern boolean_t	dladm_valid_linkname(const char *);
212 extern dladm_status_t	dladm_str2bw(char *, uint64_t *);
213 extern const char	*dladm_bw2str(int64_t, char *);
214 
215 extern dladm_status_t	dladm_parse_flow_props(char *, dladm_arg_list_t **,
216 			    boolean_t);
217 extern dladm_status_t	dladm_parse_link_props(char *, dladm_arg_list_t **,
218 			    boolean_t);
219 extern void		dladm_free_props(dladm_arg_list_t *);
220 extern dladm_status_t	dladm_parse_flow_attrs(char *, dladm_arg_list_t **,
221 			    boolean_t);
222 extern void		dladm_free_attrs(dladm_arg_list_t *);
223 
224 extern dladm_status_t	dladm_start_usagelog(dladm_handle_t, dladm_logtype_t,
225 			    uint_t);
226 extern dladm_status_t	dladm_stop_usagelog(dladm_handle_t, dladm_logtype_t);
227 extern dladm_status_t	dladm_walk_usage_res(int (*)(dladm_usage_t *, void *),
228 			    int, char *, char *, char *, char *, void *);
229 extern dladm_status_t	dladm_walk_usage_time(int (*)(dladm_usage_t *, void *),
230 			    int, char *, char *, char *, void *);
231 extern dladm_status_t	dladm_usage_summary(int (*)(dladm_usage_t *, void *),
232 			    int, char *, void *);
233 extern dladm_status_t	dladm_usage_dates(int (*)(dladm_usage_t *, void *),
234 			    int, char *, char *, void *);
235 
236 #ifdef	__cplusplus
237 }
238 #endif
239 
240 #endif	/* _LIBDLADM_H */
241