xref: /illumos-gate/usr/src/lib/libdladm/common/libdladm_impl.h (revision 5bbb4db2c3f208d12bf0fd11769728f9e5ba66a2)
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 2009 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef _LIBDLADM_IMPL_H
27 #define	_LIBDLADM_IMPL_H
28 
29 #include <sys/types.h>
30 #include <sys/mac.h>
31 #include <sys/mac_flow.h>
32 #include <libdladm.h>
33 #include <stdio.h>
34 
35 #ifdef	__cplusplus
36 extern "C" {
37 #endif
38 
39 #define	MAXLINELEN		1024
40 #define	BUFLEN(lim, ptr)	(((lim) > (ptr)) ? ((lim) - (ptr)) : 0)
41 
42 /*
43  * The handle contains file descriptors to DLD_CONTROL_DEV and
44  * DLMGMT_DOOR.  Rather than opening the file descriptor each time
45  * it is required, the handle is opened by consumers of libdladm
46  * (e.g., dladm) and then passed to libdladm.
47  */
48 struct dladm_handle {
49 	int dld_fd;	/* file descriptor to DLD_CONTROL_DEV */
50 	int door_fd;	/* file descriptor to DLMGMT_DOOR */
51 };
52 
53 /* DLMGMT_DOOR can only be accessed by libdladm and dlmgmtd */
54 extern dladm_status_t	dladm_door_fd(dladm_handle_t, int *);
55 
56 extern dladm_status_t	dladm_errno2status(int);
57 extern dladm_status_t   i_dladm_rw_db(dladm_handle_t, const char *, mode_t,
58 			    dladm_status_t (*)(dladm_handle_t, void *, FILE *,
59 			    FILE *), void *, boolean_t);
60 extern dladm_status_t	i_dladm_get_state(dladm_handle_t, datalink_id_t,
61 			    link_state_t *);
62 extern void		dladm_find_setbits32(uint32_t, uint32_t *, uint32_t *);
63 extern dladm_status_t	dladm_parse_args(char *, dladm_arg_list_t **,
64 			    boolean_t);
65 extern void		dladm_free_args(dladm_arg_list_t *);
66 
67 /*
68  * Link attributes persisted by dlmgmtd.
69  */
70 /*
71  * Set for VLANs only
72  */
73 #define	FVLANID		"vid"		/* uint64_t */
74 #define	FLINKOVER	"linkover"	/* uint64_t */
75 
76 /*
77  * Set for AGGRs only
78  */
79 #define	FKEY		"key"		/* uint64_t */
80 #define	FNPORTS		"nports"	/* uint64_t */
81 #define	FPORTS		"portnames"	/* string */
82 #define	FPOLICY		"policy"	/* uint64_t */
83 #define	FFIXMACADDR	"fix_macaddr"	/* boolean_t */
84 #define	FFORCE		"force"		/* boolean_t */
85 #define	FLACPMODE	"lacp_mode"	/* uint64_t */
86 #define	FLACPTIMER	"lacp_timer"	/* uint64_t */
87 
88 /*
89  * Set for VNICs only
90  */
91 #define	FMADDRTYPE	"maddrtype"	/* uint64_t */
92 #define	FMADDRLEN	"maddrlen"	/* uint64_t */
93 #define	FMADDRSLOT	"maddrslot"	/* uint64_t */
94 #define	FMADDRPREFIXLEN	"maddrpreflen"	/* uint64_t */
95 #define	FHWRINGS	"hwrings"	/* boolean_t */
96 
97 /*
98  * Set for simlinks only
99  */
100 #define	FSIMNETTYPE	"simnettype"	/* uint64_t */
101 #define	FSIMNETPEER	"simnetpeer"	/* uint64_t */
102 
103 /*
104  * Common fields
105  */
106 #define	FMACADDR	"macaddr"	/* string */
107 
108 /*
109  * List of all the above attributes.
110  */
111 #define	DLADM_ATTR_NAMES	FVLANID, FLINKOVER, \
112 				FKEY, FNPORTS, FPORTS, FPOLICY, \
113 				FFIXMACADDR, FFORCE, FLACPMODE, FLACPTIMER, \
114 				FMADDRTYPE, FMADDRLEN, FMADDRSLOT, \
115 				FMADDRPREFIXLEN, FHWRINGS, \
116 				FMACADDR, FSIMNETTYPE, FSIMNETPEER
117 
118 /*
119  * Data structures used for implementing temporary properties
120  */
121 
122 typedef struct val_desc {
123 	char		*vd_name;
124 	uintptr_t	vd_val;
125 } val_desc_t;
126 
127 #define	VALCNT(vals)	(sizeof ((vals)) / sizeof (val_desc_t))
128 
129 extern dladm_status_t	dladm_link_proplist_extract(dladm_handle_t,
130 			    dladm_arg_list_t *, mac_resource_props_t *);
131 
132 extern dladm_status_t	dladm_flow_proplist_extract(dladm_arg_list_t *,
133 			    mac_resource_props_t *);
134 
135 /*
136  * The prop extract() callback.
137  *
138  * rp_extract extracts the kernel structure from the val_desc_t created
139  * by the pd_check function.
140  */
141 typedef	dladm_status_t	rp_extractf_t(val_desc_t *, uint_t, void *);
142 extern rp_extractf_t	do_extract_maxbw, do_extract_priority,
143 			do_extract_cpus, do_extract_protection,
144 			do_extract_allowedips;
145 
146 typedef struct resource_prop_s {
147 	/*
148 	 * resource property name
149 	 */
150 	char		*rp_name;
151 
152 	/*
153 	 * callback to extract kernel structure
154 	 */
155 	rp_extractf_t	*rp_extract;
156 } resource_prop_t;
157 
158 /*
159  * Set for bridged links only
160  */
161 #define	FBRIDGE		"bridge"	/* string */
162 
163 #ifdef	__cplusplus
164 }
165 #endif
166 
167 #endif	/* _LIBDLADM_IMPL_H */
168