xref: /illumos-gate/usr/src/uts/common/sys/dls_mgmt.h (revision a724c049b7e0dd8612bc3aaec84e96e80511050d)
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	_DLS_MGMT_H
27 #define	_DLS_MGMT_H
28 
29 #include <sys/types.h>
30 #include <sys/dld.h>
31 
32 /*
33  * Data-Link Services Module
34  */
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 typedef enum {
41 	DATALINK_CLASS_PHYS		= 0x01,
42 	DATALINK_CLASS_VLAN		= 0x02,
43 	DATALINK_CLASS_AGGR		= 0x04,
44 	DATALINK_CLASS_VNIC		= 0x08,
45 	DATALINK_CLASS_ETHERSTUB	= 0x10
46 } datalink_class_t;
47 
48 #define	DATALINK_CLASS_ALL	(DATALINK_CLASS_PHYS |	\
49 	DATALINK_CLASS_VLAN | DATALINK_CLASS_AGGR | DATALINK_CLASS_VNIC | \
50 	DATALINK_CLASS_ETHERSTUB)
51 
52 /*
53  * A combination of flags and media.
54  *   flags is the higher 32 bits, and if it is 0x01, it indicates all media
55  *   types can be accepted; otherwise, only the given media type (specified
56  *   in the lower 32 bits) is accepted.
57  */
58 typedef uint64_t	datalink_media_t;
59 
60 #define	DATALINK_ANY_MEDIATYPE		\
61 	((datalink_media_t)(((datalink_media_t)0x01) << 32))
62 
63 #define	DATALINK_MEDIA_ACCEPTED(dmedia, media)				\
64 	(((uint32_t)(((dmedia) >> 32) & 0xfffffffful) & 0x01) ?		\
65 	B_TRUE : ((uint32_t)((dmedia) & 0xfffffffful) == (media)))
66 
67 #define	MAXLINKATTRLEN		32
68 #define	MAXLINKATTRVALLEN	1024
69 
70 /*
71  * Link attributes used by the kernel.
72  */
73 /*
74  * The major number and instance number of the underlying physical device
75  * are kept as FPHYMAJ and FPHYINST (major, instance + 1).
76  *
77  * Set for physical links only.
78  */
79 #define	FPHYMAJ		"phymaj"	/* uint64_t */
80 #define	FPHYINST	"phyinst"	/* uint64_t */
81 
82 /*
83  * The devname of the physical link. For example, bge0, ce1. Set for physical
84  * links only.
85  */
86 #define	FDEVNAME	"devname"	/* string */
87 
88 /*
89  * The door file for the dlmgmtd (data-link management) daemon.
90  */
91 #define	DLMGMT_DOOR	"/etc/svc/volatile/dladm/dlmgmt_door"
92 
93 /*
94  * Door upcall commands.
95  */
96 #define	DLMGMT_CMD_DLS_CREATE		1
97 #define	DLMGMT_CMD_DLS_GETATTR		2
98 #define	DLMGMT_CMD_DLS_DESTROY		3
99 #define	DLMGMT_CMD_GETNAME		4
100 #define	DLMGMT_CMD_GETLINKID		5
101 #define	DLMGMT_CMD_GETNEXT		6
102 #define	DLMGMT_CMD_DLS_UPDATE		7
103 #define	DLMGMT_CMD_LINKPROP_INIT	8
104 #define	DLMGMT_CMD_BASE			128
105 
106 /*
107  * Indicate the link mapping is active or persistent
108  */
109 #define	DLMGMT_ACTIVE		0x01
110 #define	DLMGMT_PERSIST		0x02
111 
112 /* upcall argument */
113 typedef struct dlmgmt_door_arg {
114 	uint_t			ld_cmd;
115 } dlmgmt_door_arg_t;
116 
117 typedef struct dlmgmt_upcall_arg_create {
118 	int			ld_cmd;
119 	datalink_class_t	ld_class;
120 	uint32_t		ld_media;
121 	boolean_t		ld_persist;
122 	uint64_t		ld_phymaj;
123 	uint64_t		ld_phyinst;
124 	char			ld_devname[MAXNAMELEN];
125 } dlmgmt_upcall_arg_create_t;
126 
127 /*
128  * Note: ld_padding is necessary to keep the size of the structure the
129  * same on amd64 and i386.  The same note applies to other ld_padding
130  * and lr_paddding fields in structures throughout this file.
131  */
132 typedef struct dlmgmt_upcall_arg_destroy {
133 	int			ld_cmd;
134 	datalink_id_t		ld_linkid;
135 	boolean_t		ld_persist;
136 	int			ld_padding;
137 } dlmgmt_upcall_arg_destroy_t;
138 
139 typedef struct dlmgmt_upcall_arg_update {
140 	int			ld_cmd;
141 	boolean_t		ld_novanity;
142 	uint32_t		ld_media;
143 	uint32_t		ld_padding;
144 	char			ld_devname[MAXNAMELEN];
145 } dlmgmt_upcall_arg_update_t;
146 
147 typedef struct dlmgmt_upcall_arg_getattr {
148 	int			ld_cmd;
149 	datalink_id_t		ld_linkid;
150 	char			ld_attr[MAXLINKATTRLEN];
151 } dlmgmt_upcall_arg_getattr_t;
152 
153 typedef struct dlmgmt_door_getname {
154 	int			ld_cmd;
155 	datalink_id_t		ld_linkid;
156 } dlmgmt_door_getname_t;
157 
158 typedef struct dlmgmt_door_getlinkid {
159 	int			ld_cmd;
160 	char			ld_link[MAXLINKNAMELEN];
161 } dlmgmt_door_getlinkid_t;
162 
163 typedef struct dlmgmt_door_getnext_s {
164 	int			ld_cmd;
165 	datalink_id_t		ld_linkid;
166 	datalink_class_t	ld_class;
167 	uint32_t		ld_flags;
168 	datalink_media_t	ld_dmedia;
169 } dlmgmt_door_getnext_t;
170 
171 typedef struct dlmgmt_door_linkprop_init {
172 	int			ld_cmd;
173 	datalink_id_t		ld_linkid;
174 } dlmgmt_door_linkprop_init_t;
175 
176 /* upcall return value */
177 typedef struct dlmgmt_retval_s {
178 	uint_t			lr_err; /* return error code */
179 } dlmgmt_retval_t;
180 
181 typedef dlmgmt_retval_t	dlmgmt_destroy_retval_t,
182 			dlmgmt_linkprop_init_retval_t;
183 
184 struct dlmgmt_linkid_retval_s {
185 	uint_t			lr_err;
186 	datalink_id_t		lr_linkid;
187 	uint32_t		lr_flags;
188 	datalink_class_t	lr_class;
189 	uint32_t		lr_media;
190 	uint32_t		lr_padding;
191 };
192 
193 typedef struct dlmgmt_linkid_retval_s	dlmgmt_create_retval_t,
194 					dlmgmt_update_retval_t,
195 					dlmgmt_getlinkid_retval_t,
196 					dlmgmt_getnext_retval_t;
197 
198 typedef struct dlmgmt_getname_retval_s {
199 	uint_t			lr_err;
200 	char			lr_link[MAXLINKNAMELEN];
201 	datalink_class_t	lr_class;
202 	uint32_t		lr_media;
203 	uint32_t		lr_flags;
204 } dlmgmt_getname_retval_t;
205 
206 typedef struct dlmgmt_getattr_retval_s {
207 	uint_t			lr_err;
208 	uint_t			lr_type;
209 	uint_t			lr_attrsz;
210 	uint_t			lr_padding;
211 	char			lr_attrval[MAXLINKATTRVALLEN];
212 } dlmgmt_getattr_retval_t;
213 
214 #ifdef	__cplusplus
215 }
216 #endif
217 
218 #endif	/* _DLS_MGMT_H */
219