xref: /illumos-gate/usr/src/lib/libdladm/common/libdladm_impl.h (revision e557d412e15c7f384b2ea3bf316a739a0f81cd55)
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 2010 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 #define	V4_PART_OF_V6(v6)	((v6)._S6_un._S6_u32[3])
42 
43 /*
44  * The handle contains file descriptors to DLD_CONTROL_DEV and
45  * DLMGMT_DOOR.  Rather than opening the file descriptor each time
46  * it is required, the handle is opened by consumers of libdladm
47  * (e.g., dladm) and then passed to libdladm.
48  */
49 struct dladm_handle {
50 	int dld_fd;	/* file descriptor to DLD_CONTROL_DEV */
51 	int door_fd;	/* file descriptor to DLMGMT_DOOR */
52 };
53 
54 /* DLMGMT_DOOR can only be accessed by libdladm and dlmgmtd */
55 extern dladm_status_t	dladm_door_fd(dladm_handle_t, int *);
56 
57 extern dladm_status_t	dladm_errno2status(int);
58 extern dladm_status_t   i_dladm_rw_db(dladm_handle_t, const char *, mode_t,
59 			    dladm_status_t (*)(dladm_handle_t, void *, FILE *,
60 			    FILE *), void *, boolean_t);
61 extern dladm_status_t	dladm_get_state(dladm_handle_t, datalink_id_t,
62 			    link_state_t *);
63 extern void		dladm_find_setbits32(uint32_t, uint32_t *, uint32_t *);
64 extern dladm_status_t	dladm_parse_args(char *, dladm_arg_list_t **,
65 			    boolean_t);
66 extern void		dladm_free_args(dladm_arg_list_t *);
67 
68 /*
69  * Link attributes persisted by dlmgmtd.
70  */
71 /*
72  * Set for VLANs only
73  */
74 #define	FVLANID		"vid"		/* uint64_t */
75 #define	FLINKOVER	"linkover"	/* uint64_t */
76 
77 /*
78  * Set for AGGRs only
79  */
80 #define	FKEY		"key"		/* uint64_t */
81 #define	FNPORTS		"nports"	/* uint64_t */
82 #define	FPORTS		"portnames"	/* string */
83 #define	FPOLICY		"policy"	/* uint64_t */
84 #define	FFIXMACADDR	"fix_macaddr"	/* boolean_t */
85 #define	FFORCE		"force"		/* boolean_t */
86 #define	FLACPMODE	"lacp_mode"	/* uint64_t */
87 #define	FLACPTIMER	"lacp_timer"	/* uint64_t */
88 
89 /*
90  * Set for VNICs only
91  */
92 #define	FMADDRTYPE	"maddrtype"	/* uint64_t */
93 #define	FMADDRLEN	"maddrlen"	/* uint64_t */
94 #define	FMADDRSLOT	"maddrslot"	/* uint64_t */
95 #define	FMADDRPREFIXLEN	"maddrpreflen"	/* uint64_t */
96 #define	FVRID		"vrid"		/* uint64_t */
97 #define	FVRAF		"vraf"		/* uint64_t */
98 
99 /*
100  * Set for simlinks only
101  */
102 #define	FSIMNETTYPE	"simnettype"	/* uint64_t */
103 #define	FSIMNETPEER	"simnetpeer"	/* uint64_t */
104 
105 /*
106  * Common fields
107  */
108 #define	FMACADDR	"macaddr"	/* string */
109 
110 /*
111  * List of all the above attributes.
112  */
113 #define	DLADM_ATTR_NAMES	FVLANID, FLINKOVER, \
114 				FKEY, FNPORTS, FPORTS, FPOLICY, \
115 				FFIXMACADDR, FFORCE, FLACPMODE, FLACPTIMER, \
116 				FMADDRTYPE, FMADDRLEN, FMADDRSLOT, \
117 				FMADDRPREFIXLEN, \
118 				FMACADDR, FSIMNETTYPE, FSIMNETPEER
119 
120 /*
121  * Data structures used for implementing temporary properties
122  */
123 
124 typedef struct val_desc {
125 	char		*vd_name;
126 	uintptr_t	vd_val;
127 } val_desc_t;
128 
129 #define	VALCNT(vals)	(sizeof ((vals)) / sizeof (val_desc_t))
130 
131 extern dladm_status_t	dladm_link_proplist_extract(dladm_handle_t,
132 			    dladm_arg_list_t *, mac_resource_props_t *,
133 			    uint_t);
134 
135 extern dladm_status_t	dladm_flow_proplist_extract(dladm_arg_list_t *,
136 			    mac_resource_props_t *);
137 
138 /*
139  * The prop extract() callback.
140  *
141  * rp_extract extracts the kernel structure from the val_desc_t created
142  * by the pd_check function.
143  */
144 typedef	dladm_status_t	rp_extractf_t(val_desc_t *, uint_t, void *);
145 extern rp_extractf_t	extract_maxbw, extract_priority,
146 			extract_cpus, extract_protection,
147 			extract_allowedips, extract_allowedcids,
148 			extract_rxrings, extract_txrings, extract_pool;
149 
150 typedef struct resource_prop_s {
151 	/*
152 	 * resource property name
153 	 */
154 	char		*rp_name;
155 
156 	/*
157 	 * callback to extract kernel structure
158 	 */
159 	rp_extractf_t	*rp_extract;
160 } resource_prop_t;
161 
162 /*
163  * Set for bridged links only
164  */
165 #define	FBRIDGE		"bridge"	/* string */
166 
167 #ifdef	__cplusplus
168 }
169 #endif
170 
171 #endif	/* _LIBDLADM_IMPL_H */
172