xref: /titanic_44/usr/src/lib/libdladm/common/libdladm.h (revision 5adf34bd96da7c794241c78b641902875edb690a)
17c478bd9Sstevel@tonic-gate /*
27c478bd9Sstevel@tonic-gate  * CDDL HEADER START
37c478bd9Sstevel@tonic-gate  *
47c478bd9Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5ba2e4443Sseb  * Common Development and Distribution License (the "License").
6ba2e4443Sseb  * You may not use this file except in compliance with the License.
77c478bd9Sstevel@tonic-gate  *
87c478bd9Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
97c478bd9Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
107c478bd9Sstevel@tonic-gate  * See the License for the specific language governing permissions
117c478bd9Sstevel@tonic-gate  * and limitations under the License.
127c478bd9Sstevel@tonic-gate  *
137c478bd9Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
147c478bd9Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
157c478bd9Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
167c478bd9Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
177c478bd9Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
187c478bd9Sstevel@tonic-gate  *
197c478bd9Sstevel@tonic-gate  * CDDL HEADER END
207c478bd9Sstevel@tonic-gate  */
217c478bd9Sstevel@tonic-gate /*
22*5adf34bdSRajagopal Kunhappan  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
237c478bd9Sstevel@tonic-gate  */
247c478bd9Sstevel@tonic-gate 
257c478bd9Sstevel@tonic-gate #ifndef _LIBDLADM_H
267c478bd9Sstevel@tonic-gate #define	_LIBDLADM_H
277c478bd9Sstevel@tonic-gate 
28da14cebeSEric Cheng #include <sys/dls_mgmt.h>
2925ec3e3dSEric Cheng #include <sys/dld.h>
30d62bc4baSyz147064 #include <sys/dlpi.h>
31d62bc4baSyz147064 
32f595a68aSyz147064 /*
33f595a68aSyz147064  * This file includes structures, macros and common routines shared by all
34f595a68aSyz147064  * data-link administration, and routines which do not directly administrate
35f595a68aSyz147064  * links. For example, dladm_status2str().
36f595a68aSyz147064  */
377c478bd9Sstevel@tonic-gate 
387c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
397c478bd9Sstevel@tonic-gate extern "C" {
407c478bd9Sstevel@tonic-gate #endif
417c478bd9Sstevel@tonic-gate 
42d62bc4baSyz147064 #define	LINKID_STR_WIDTH	10
430ba2cbe9Sxc151355 #define	DLADM_STRSIZE		256
44d62bc4baSyz147064 
45d62bc4baSyz147064 /*
46d62bc4baSyz147064  * option flags taken by the libdladm functions
47d62bc4baSyz147064  *
48d62bc4baSyz147064  *  - DLADM_OPT_ACTIVE:
49d62bc4baSyz147064  *    The function requests to bringup some configuration that only take
50d62bc4baSyz147064  *    effect on active system (not persistent).
51d62bc4baSyz147064  *
52d62bc4baSyz147064  *  - DLADM_OPT_PERSIST:
53d62bc4baSyz147064  *    The function requests to persist some configuration.
54d62bc4baSyz147064  *
55d62bc4baSyz147064  *  - DLADM_OPT_CREATE:
56d62bc4baSyz147064  *    Today, only used by dladm_set_secobj() - requests to create a secobj.
57d62bc4baSyz147064  *
58d62bc4baSyz147064  *  - DLADM_OPT_FORCE:
59d62bc4baSyz147064  *    The function requests to execute a specific operation forcefully.
60d62bc4baSyz147064  *
61d62bc4baSyz147064  *  - DLADM_OPT_PREFIX:
62d62bc4baSyz147064  *    The function requests to generate a link name using the specified prefix.
63da14cebeSEric Cheng  *
64da14cebeSEric Cheng  *  - DLADM_OPT_VLAN:
65da14cebeSEric Cheng  *    Signifies VLAN creation code path
66da14cebeSEric Cheng  *
674eaa4710SRishi Srivatsavai  *  - DLADM_OPT_NOREFRESH:
684eaa4710SRishi Srivatsavai  *    Do not refresh the daemon after setting parameter (used by STP mcheck).
690dc2366fSVenugopal Iyer  *
700dc2366fSVenugopal Iyer  *  - DLADM_OPT_BOOT:
710dc2366fSVenugopal Iyer  *    Bypass check functions during boot (used by pool property since pools
720dc2366fSVenugopal Iyer  *    can come up after link properties are set)
73d62bc4baSyz147064  */
74d62bc4baSyz147064 #define	DLADM_OPT_ACTIVE	0x00000001
75d62bc4baSyz147064 #define	DLADM_OPT_PERSIST	0x00000002
76d62bc4baSyz147064 #define	DLADM_OPT_CREATE	0x00000004
77d62bc4baSyz147064 #define	DLADM_OPT_FORCE		0x00000008
78d62bc4baSyz147064 #define	DLADM_OPT_PREFIX	0x00000010
79da14cebeSEric Cheng #define	DLADM_OPT_ANCHOR	0x00000020
80da14cebeSEric Cheng #define	DLADM_OPT_VLAN		0x00000040
810dc2366fSVenugopal Iyer #define	DLADM_OPT_NOREFRESH	0x00000080
820dc2366fSVenugopal Iyer #define	DLADM_OPT_BOOT		0x00000100
83d62bc4baSyz147064 
84d62bc4baSyz147064 #define	DLADM_WALK_TERMINATE	0
85d62bc4baSyz147064 #define	DLADM_WALK_CONTINUE	-1
860ba2cbe9Sxc151355 
87da14cebeSEric Cheng #define	DLADM_MAX_ARG_CNT	32
88*5adf34bdSRajagopal Kunhappan #define	DLADM_MAX_ARG_VALS	64
89da14cebeSEric Cheng 
900ba2cbe9Sxc151355 typedef enum {
910ba2cbe9Sxc151355 	DLADM_STATUS_OK = 0,
920ba2cbe9Sxc151355 	DLADM_STATUS_BADARG,
930ba2cbe9Sxc151355 	DLADM_STATUS_FAILED,
940ba2cbe9Sxc151355 	DLADM_STATUS_TOOSMALL,
950ba2cbe9Sxc151355 	DLADM_STATUS_NOTSUP,
960ba2cbe9Sxc151355 	DLADM_STATUS_NOTFOUND,
970ba2cbe9Sxc151355 	DLADM_STATUS_BADVAL,
980ba2cbe9Sxc151355 	DLADM_STATUS_NOMEM,
990ba2cbe9Sxc151355 	DLADM_STATUS_EXIST,
1000ba2cbe9Sxc151355 	DLADM_STATUS_LINKINVAL,
1010ba2cbe9Sxc151355 	DLADM_STATUS_PROPRDONLY,
1020ba2cbe9Sxc151355 	DLADM_STATUS_BADVALCNT,
1030ba2cbe9Sxc151355 	DLADM_STATUS_DBNOTFOUND,
1040ba2cbe9Sxc151355 	DLADM_STATUS_DENIED,
105f4b3ec61Sdh155122 	DLADM_STATUS_IOERR,
106f595a68aSyz147064 	DLADM_STATUS_TEMPONLY,
107f595a68aSyz147064 	DLADM_STATUS_TIMEDOUT,
108f595a68aSyz147064 	DLADM_STATUS_ISCONN,
109f595a68aSyz147064 	DLADM_STATUS_NOTCONN,
110f595a68aSyz147064 	DLADM_STATUS_REPOSITORYINVAL,
111f595a68aSyz147064 	DLADM_STATUS_MACADDRINVAL,
112843e1988Sjohnlev 	DLADM_STATUS_KEYINVAL,
113843e1988Sjohnlev 	DLADM_STATUS_INVALIDMACADDRLEN,
114843e1988Sjohnlev 	DLADM_STATUS_INVALIDMACADDRTYPE,
115d62bc4baSyz147064 	DLADM_STATUS_LINKBUSY,
116d62bc4baSyz147064 	DLADM_STATUS_VIDINVAL,
117d62bc4baSyz147064 	DLADM_STATUS_NONOTIF,
118149b7eb2SSowmini Varadhan 	DLADM_STATUS_TRYAGAIN,
1192b24ab6bSSebastien Roy 	DLADM_STATUS_IPTUNTYPE,
1202b24ab6bSSebastien Roy 	DLADM_STATUS_IPTUNTYPEREQD,
1212b24ab6bSSebastien Roy 	DLADM_STATUS_BADIPTUNLADDR,
1222b24ab6bSSebastien Roy 	DLADM_STATUS_BADIPTUNRADDR,
1232b24ab6bSSebastien Roy 	DLADM_STATUS_ADDRINUSE,
124da14cebeSEric Cheng 	DLADM_STATUS_BADTIMEVAL,
125da14cebeSEric Cheng 	DLADM_STATUS_INVALIDMACADDR,
126da14cebeSEric Cheng 	DLADM_STATUS_INVALIDMACADDRNIC,
127da14cebeSEric Cheng 	DLADM_STATUS_INVALIDMACADDRINUSE,
128da14cebeSEric Cheng 	DLADM_STATUS_MACFACTORYSLOTINVALID,
129da14cebeSEric Cheng 	DLADM_STATUS_MACFACTORYSLOTUSED,
130da14cebeSEric Cheng 	DLADM_STATUS_MACFACTORYSLOTALLUSED,
131da14cebeSEric Cheng 	DLADM_STATUS_MACFACTORYNOTSUP,
132da14cebeSEric Cheng 	DLADM_STATUS_INVALIDMACPREFIX,
133da14cebeSEric Cheng 	DLADM_STATUS_INVALIDMACPREFIXLEN,
134da14cebeSEric Cheng 	DLADM_STATUS_CPUMAX,
135da14cebeSEric Cheng 	DLADM_STATUS_CPUERR,
136da14cebeSEric Cheng 	DLADM_STATUS_CPUNOTONLINE,
137da14cebeSEric Cheng 	DLADM_STATUS_DB_NOTFOUND,
138da14cebeSEric Cheng 	DLADM_STATUS_DB_PARSE_ERR,
139da14cebeSEric Cheng 	DLADM_STATUS_PROP_PARSE_ERR,
140da14cebeSEric Cheng 	DLADM_STATUS_ATTR_PARSE_ERR,
141da14cebeSEric Cheng 	DLADM_STATUS_FLOW_DB_ERR,
142da14cebeSEric Cheng 	DLADM_STATUS_FLOW_DB_OPEN_ERR,
143da14cebeSEric Cheng 	DLADM_STATUS_FLOW_DB_PARSE_ERR,
144da14cebeSEric Cheng 	DLADM_STATUS_FLOWPROP_DB_PARSE_ERR,
145da14cebeSEric Cheng 	DLADM_STATUS_FLOW_ADD_ERR,
146da14cebeSEric Cheng 	DLADM_STATUS_FLOW_WALK_ERR,
147da14cebeSEric Cheng 	DLADM_STATUS_FLOW_IDENTICAL,
148da14cebeSEric Cheng 	DLADM_STATUS_FLOW_INCOMPATIBLE,
149da14cebeSEric Cheng 	DLADM_STATUS_FLOW_EXISTS,
150da14cebeSEric Cheng 	DLADM_STATUS_PERSIST_FLOW_EXISTS,
151da14cebeSEric Cheng 	DLADM_STATUS_INVALID_IP,
152da14cebeSEric Cheng 	DLADM_STATUS_INVALID_PREFIXLEN,
153da14cebeSEric Cheng 	DLADM_STATUS_INVALID_PROTOCOL,
154da14cebeSEric Cheng 	DLADM_STATUS_INVALID_PORT,
155da14cebeSEric Cheng 	DLADM_STATUS_INVALID_DSF,
156da14cebeSEric Cheng 	DLADM_STATUS_INVALID_DSFMASK,
157da14cebeSEric Cheng 	DLADM_STATUS_INVALID_MACMARGIN,
158da14cebeSEric Cheng 	DLADM_STATUS_NOTDEFINED,
159da14cebeSEric Cheng 	DLADM_STATUS_BADPROP,
160da14cebeSEric Cheng 	DLADM_STATUS_MINMAXBW,
1614eaa4710SRishi Srivatsavai 	DLADM_STATUS_NO_HWRINGS,
1624eaa4710SRishi Srivatsavai 	DLADM_STATUS_PERMONLY,
1630dc2366fSVenugopal Iyer 	DLADM_STATUS_OPTMISSING,
1640dc2366fSVenugopal Iyer 	DLADM_STATUS_POOLCPU
1650ba2cbe9Sxc151355 } dladm_status_t;
1660ba2cbe9Sxc151355 
1670ba2cbe9Sxc151355 typedef enum {
168d62bc4baSyz147064 	DLADM_TYPE_STR,
169d62bc4baSyz147064 	DLADM_TYPE_BOOLEAN,
170d62bc4baSyz147064 	DLADM_TYPE_UINT64
171d62bc4baSyz147064 } dladm_datatype_t;
172d62bc4baSyz147064 
173d62bc4baSyz147064 typedef int dladm_conf_t;
174d62bc4baSyz147064 #define	DLADM_INVALID_CONF	0
1750ba2cbe9Sxc151355 
1764ac67f02SAnurag S. Maskey /* opaque dladm handle to libdladm functions */
1774ac67f02SAnurag S. Maskey struct dladm_handle;
1784ac67f02SAnurag S. Maskey typedef struct dladm_handle *dladm_handle_t;
1794ac67f02SAnurag S. Maskey 
1804ac67f02SAnurag S. Maskey /* open/close handle */
1814ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_open(dladm_handle_t *);
1824ac67f02SAnurag S. Maskey extern void		dladm_close(dladm_handle_t);
1834ac67f02SAnurag S. Maskey 
1844ac67f02SAnurag S. Maskey /*
1854ac67f02SAnurag S. Maskey  * retrieve the dld file descriptor from handle, only libdladm and
1864ac67f02SAnurag S. Maskey  * dlmgmtd are given access to the door file descriptor.
1874ac67f02SAnurag S. Maskey  */
1884ac67f02SAnurag S. Maskey extern int	dladm_dld_fd(dladm_handle_t);
1894ac67f02SAnurag S. Maskey 
190da14cebeSEric Cheng typedef struct dladm_arg_info {
191da14cebeSEric Cheng 	const char	*ai_name;
192da14cebeSEric Cheng 	char		*ai_val[DLADM_MAX_ARG_VALS];
193da14cebeSEric Cheng 	uint_t		ai_count;
194da14cebeSEric Cheng } dladm_arg_info_t;
195da14cebeSEric Cheng 
196da14cebeSEric Cheng typedef struct dladm_arg_list {
197da14cebeSEric Cheng 	dladm_arg_info_t	al_info[DLADM_MAX_ARG_CNT];
198da14cebeSEric Cheng 	uint_t			al_count;
199da14cebeSEric Cheng 	char			*al_buf;
200da14cebeSEric Cheng } dladm_arg_list_t;
201da14cebeSEric Cheng 
202da14cebeSEric Cheng typedef enum {
203da14cebeSEric Cheng 	DLADM_LOGTYPE_LINK = 1,
204da14cebeSEric Cheng 	DLADM_LOGTYPE_FLOW
205da14cebeSEric Cheng } dladm_logtype_t;
206da14cebeSEric Cheng 
207da14cebeSEric Cheng typedef struct dladm_usage {
208da14cebeSEric Cheng 	char		du_name[MAXLINKNAMELEN];
209da14cebeSEric Cheng 	uint64_t	du_duration;
210da14cebeSEric Cheng 	uint64_t	du_stime;
211da14cebeSEric Cheng 	uint64_t	du_etime;
212da14cebeSEric Cheng 	uint64_t	du_ipackets;
213da14cebeSEric Cheng 	uint64_t	du_rbytes;
214da14cebeSEric Cheng 	uint64_t	du_opackets;
215da14cebeSEric Cheng 	uint64_t	du_obytes;
216da14cebeSEric Cheng 	uint64_t	du_bandwidth;
217da14cebeSEric Cheng 	boolean_t	du_last;
218da14cebeSEric Cheng } dladm_usage_t;
219da14cebeSEric Cheng 
2200ba2cbe9Sxc151355 extern const char	*dladm_status2str(dladm_status_t, char *);
221f595a68aSyz147064 extern dladm_status_t	dladm_set_rootdir(const char *);
222d62bc4baSyz147064 extern const char	*dladm_class2str(datalink_class_t, char *);
223d62bc4baSyz147064 extern const char	*dladm_media2str(uint32_t, char *);
224b509e89bSRishi Srivatsavai extern uint32_t		dladm_str2media(const char *);
225d62bc4baSyz147064 extern boolean_t	dladm_valid_linkname(const char *);
22663a6526dSMichael Lim extern boolean_t	dladm_str2interval(char *, uint32_t *);
227da14cebeSEric Cheng extern dladm_status_t	dladm_str2bw(char *, uint64_t *);
228da14cebeSEric Cheng extern const char	*dladm_bw2str(int64_t, char *);
22925ec3e3dSEric Cheng extern dladm_status_t	dladm_str2pri(char *, mac_priority_level_t *);
23025ec3e3dSEric Cheng extern const char	*dladm_pri2str(mac_priority_level_t, char *);
23125ec3e3dSEric Cheng extern dladm_status_t	dladm_str2protect(char *, uint32_t *);
23225ec3e3dSEric Cheng extern const char	*dladm_protect2str(uint32_t, char *);
23325ec3e3dSEric Cheng extern dladm_status_t	dladm_str2ipv4addr(char *, void *);
23425ec3e3dSEric Cheng extern const char	*dladm_ipv4addr2str(void *, char *);
2350dc2366fSVenugopal Iyer extern dladm_status_t	dladm_str2ipv6addr(char *, void *);
2360dc2366fSVenugopal Iyer extern const char	*dladm_ipv6addr2str(void *, char *);
237da14cebeSEric Cheng 
238da14cebeSEric Cheng extern dladm_status_t	dladm_parse_flow_props(char *, dladm_arg_list_t **,
239da14cebeSEric Cheng 			    boolean_t);
240da14cebeSEric Cheng extern dladm_status_t	dladm_parse_link_props(char *, dladm_arg_list_t **,
241da14cebeSEric Cheng 			    boolean_t);
242da14cebeSEric Cheng extern void		dladm_free_props(dladm_arg_list_t *);
243da14cebeSEric Cheng extern dladm_status_t	dladm_parse_flow_attrs(char *, dladm_arg_list_t **,
244da14cebeSEric Cheng 			    boolean_t);
245da14cebeSEric Cheng extern void		dladm_free_attrs(dladm_arg_list_t *);
246da14cebeSEric Cheng 
2474ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_start_usagelog(dladm_handle_t, dladm_logtype_t,
2484ac67f02SAnurag S. Maskey 			    uint_t);
2494ac67f02SAnurag S. Maskey extern dladm_status_t	dladm_stop_usagelog(dladm_handle_t, dladm_logtype_t);
250da14cebeSEric Cheng extern dladm_status_t	dladm_walk_usage_res(int (*)(dladm_usage_t *, void *),
251da14cebeSEric Cheng 			    int, char *, char *, char *, char *, void *);
252da14cebeSEric Cheng extern dladm_status_t	dladm_walk_usage_time(int (*)(dladm_usage_t *, void *),
253da14cebeSEric Cheng 			    int, char *, char *, char *, void *);
254da14cebeSEric Cheng extern dladm_status_t	dladm_usage_summary(int (*)(dladm_usage_t *, void *),
255da14cebeSEric Cheng 			    int, char *, void *);
256da14cebeSEric Cheng extern dladm_status_t	dladm_usage_dates(int (*)(dladm_usage_t *, void *),
257da14cebeSEric Cheng 			    int, char *, char *, void *);
2582b24ab6bSSebastien Roy extern dladm_status_t	dladm_zone_boot(dladm_handle_t, zoneid_t);
2592b24ab6bSSebastien Roy extern dladm_status_t	dladm_zone_halt(dladm_handle_t, zoneid_t);
2600ba2cbe9Sxc151355 
2617c478bd9Sstevel@tonic-gate #ifdef	__cplusplus
2627c478bd9Sstevel@tonic-gate }
2637c478bd9Sstevel@tonic-gate #endif
2647c478bd9Sstevel@tonic-gate 
2657c478bd9Sstevel@tonic-gate #endif	/* _LIBDLADM_H */
266