xref: /illumos-gate/usr/src/uts/common/sys/aggr_impl.h (revision 59066d3c46818a42896f327c78359187de55245b)
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	_SYS_AGGR_IMPL_H
27 #define	_SYS_AGGR_IMPL_H
28 
29 #pragma ident	"%Z%%M%	%I%	%E% SMI"
30 
31 #include <sys/types.h>
32 #include <sys/mac.h>
33 #include <sys/mac_ether.h>
34 #include <sys/aggr_lacp.h>
35 
36 #ifdef	__cplusplus
37 extern "C" {
38 #endif
39 
40 #ifdef _KERNEL
41 
42 #define	AGGR_MINOR_CTL	1		/* control interface minor */
43 
44 /* flags for aggr_grp_modify() */
45 #define	AGGR_MODIFY_POLICY		0x01
46 #define	AGGR_MODIFY_MAC			0x02
47 #define	AGGR_MODIFY_LACP_MODE		0x04
48 #define	AGGR_MODIFY_LACP_TIMER		0x08
49 
50 /*
51  * A link aggregation MAC port.
52  * Note that lp_next is protected by the lg_lock of the group the
53  * port is part of.
54  */
55 typedef struct aggr_port_s {
56 	struct aggr_port_s *lp_next;
57 	struct aggr_grp_s *lp_grp;		/* back ptr to group */
58 	datalink_id_t	lp_linkid;
59 	uint16_t	lp_portid;
60 	uint8_t		lp_addr[ETHERADDRL];	/* port MAC address */
61 	uint32_t	lp_refs;		/* refcount */
62 	aggr_port_state_t lp_state;
63 	uint32_t	lp_started : 1,
64 			lp_tx_enabled : 1,
65 			lp_collector_enabled : 1,
66 			lp_promisc_on : 1,
67 			lp_no_link_update : 1,
68 			lp_pad_bits : 27;
69 	uint32_t	lp_closing;
70 	mac_handle_t	lp_mh;
71 	const mac_info_t *lp_mip;
72 	mac_notify_handle_t lp_mnh;
73 	mac_rx_handle_t	lp_mrh;
74 	krwlock_t	lp_lock;
75 	uint_t		lp_tx_idx;		/* idx in group's tx array */
76 	uint64_t	lp_ifspeed;
77 	link_state_t	lp_link_state;
78 	link_duplex_t	lp_link_duplex;
79 	uint64_t	lp_stat[MAC_NSTAT];
80 	uint64_t	lp_ether_stat[ETHER_NSTAT];
81 	aggr_lacp_port_t lp_lacp;		/* LACP state */
82 	lacp_stats_t	lp_lacp_stats;
83 	const mac_txinfo_t *lp_txinfo;
84 	uint32_t	lp_margin;
85 } aggr_port_t;
86 
87 typedef struct lg_mcst_addr_s	lg_mcst_addr_t;
88 struct lg_mcst_addr_s {
89 	lg_mcst_addr_t	*lg_mcst_nextp;
90 	uint8_t		lg_mcst_addr[MAXMACADDRLEN];
91 };
92 
93 /*
94  * A link aggregation group.
95  *
96  * The following per-group flags are defined:
97  *
98  * - lg_addr_fixed: set when the MAC address has been explicitely set
99  *   when the group was created, or by a m_unicst_set() request.
100  *   If this flag is not set, the MAC address of the group will be
101  *   set to the first port that is added to the group.
102  *
103  * - lg_add_set: used only when lg_addr_fixed is not set. Captures whether
104  *   the MAC address was initialized according to the members of the group.
105  *   When set, the lg_port field points to the port from which the
106  *   MAC address was initialized.
107  *
108  */
109 typedef struct aggr_grp_s {
110 	krwlock_t	lg_lock;
111 	datalink_id_t	lg_linkid;
112 	uint16_t	lg_key;			/* key (group port number) */
113 	uint32_t	lg_refs;		/* refcount */
114 	uint16_t	lg_nports;		/* number of MAC ports */
115 	uint8_t		lg_addr[ETHERADDRL];	/* group MAC address */
116 	uint16_t
117 			lg_closing : 1,
118 			lg_addr_fixed : 1,	/* fixed MAC address? */
119 			lg_started : 1,		/* group started? */
120 			lg_promisc : 1,		/* in promiscuous mode? */
121 			lg_gldv3_polling : 1,
122 			lg_zcopy : 1,
123 			lg_vlan : 1,
124 			lg_force : 1,
125 			lg_pad_bits : 8;
126 	aggr_port_t	*lg_ports;		/* list of configured ports */
127 	aggr_port_t	*lg_mac_addr_port;
128 	mac_handle_t	lg_mh;
129 	uint_t		lg_rx_resources;
130 	uint_t		lg_nattached_ports;
131 	uint_t		lg_ntx_ports;
132 	aggr_port_t	**lg_tx_ports;		/* array of tx ports */
133 	uint_t		lg_tx_ports_size;	/* size of lg_tx_ports */
134 	uint32_t	lg_tx_policy;		/* outbound policy */
135 	uint64_t	lg_ifspeed;
136 	link_state_t	lg_link_state;
137 	link_duplex_t	lg_link_duplex;
138 	uint64_t	lg_stat[MAC_NSTAT];
139 	uint64_t	lg_ether_stat[ETHER_NSTAT];
140 	aggr_lacp_mode_t lg_lacp_mode;		/* off, active, or passive */
141 	Agg_t		aggr;			/* 802.3ad data */
142 	uint32_t	lg_hcksum_txflags;
143 	uint_t		lg_max_sdu;
144 	uint32_t	lg_margin;
145 	lg_mcst_addr_t	*lg_mcst_list; /* A list of multicast addresses */
146 } aggr_grp_t;
147 
148 #define	AGGR_LACP_LOCK(grp)	mutex_enter(&(grp)->aggr.gl_lock);
149 #define	AGGR_LACP_UNLOCK(grp)	mutex_exit(&(grp)->aggr.gl_lock);
150 #define	AGGR_LACP_LOCK_HELD(grp) MUTEX_HELD(&(grp)->aggr.gl_lock)
151 
152 #define	AGGR_GRP_REFHOLD(grp) {			\
153 	atomic_add_32(&(grp)->lg_refs, 1);	\
154 	ASSERT((grp)->lg_refs != 0);		\
155 }
156 
157 #define	AGGR_GRP_REFRELE(grp) {					\
158 	ASSERT((grp)->lg_refs != 0);				\
159 	membar_exit();						\
160 	if (atomic_add_32_nv(&(grp)->lg_refs, -1) == 0)		\
161 		aggr_grp_free(grp);				\
162 }
163 
164 #define	AGGR_PORT_REFHOLD(port) {		\
165 	atomic_add_32(&(port)->lp_refs, 1);	\
166 	ASSERT((port)->lp_refs != 0);		\
167 }
168 
169 #define	AGGR_PORT_REFRELE(port) {				\
170 	ASSERT((port)->lp_refs != 0);				\
171 	membar_exit();						\
172 	if (atomic_add_32_nv(&(port)->lp_refs, -1) == 0)	\
173 		aggr_port_free(port);				\
174 }
175 
176 extern dev_info_t *aggr_dip;
177 extern void aggr_ioctl(queue_t *, mblk_t *);
178 
179 typedef int (*aggr_grp_info_new_grp_fn_t)(void *, datalink_id_t, uint32_t,
180     uchar_t *, boolean_t, boolean_t, uint32_t, uint32_t, aggr_lacp_mode_t,
181     aggr_lacp_timer_t);
182 typedef int (*aggr_grp_info_new_port_fn_t)(void *, datalink_id_t, uchar_t *,
183     aggr_port_state_t, aggr_lacp_state_t *);
184 
185 extern void aggr_grp_init(void);
186 extern void aggr_grp_fini(void);
187 extern int aggr_grp_create(datalink_id_t, uint32_t, uint_t, laioc_port_t *,
188     uint32_t, boolean_t, boolean_t, uchar_t *, aggr_lacp_mode_t,
189     aggr_lacp_timer_t);
190 extern int aggr_grp_delete(datalink_id_t);
191 extern void aggr_grp_free(aggr_grp_t *);
192 
193 extern int aggr_grp_info(datalink_id_t, void *, aggr_grp_info_new_grp_fn_t,
194     aggr_grp_info_new_port_fn_t);
195 extern void aggr_grp_notify(aggr_grp_t *, uint32_t);
196 extern boolean_t aggr_grp_attach_port(aggr_grp_t *, aggr_port_t *);
197 extern boolean_t aggr_grp_detach_port(aggr_grp_t *, aggr_port_t *);
198 extern void aggr_grp_port_mac_changed(aggr_grp_t *, aggr_port_t *,
199     boolean_t *, boolean_t *);
200 extern int aggr_grp_add_ports(datalink_id_t, uint_t, boolean_t,
201     laioc_port_t *);
202 extern int aggr_grp_rem_ports(datalink_id_t, uint_t, laioc_port_t *);
203 extern boolean_t aggr_grp_update_ports_mac(aggr_grp_t *);
204 extern int aggr_grp_modify(datalink_id_t, aggr_grp_t *, uint8_t, uint32_t,
205     boolean_t, const uchar_t *, aggr_lacp_mode_t, aggr_lacp_timer_t);
206 extern void aggr_grp_multicst_port(aggr_port_t *, boolean_t);
207 extern uint_t aggr_grp_count(void);
208 
209 extern void aggr_port_init(void);
210 extern void aggr_port_fini(void);
211 extern int aggr_port_create(const datalink_id_t, boolean_t, aggr_port_t **);
212 extern void aggr_port_delete(aggr_port_t *);
213 extern void aggr_port_free(aggr_port_t *);
214 extern int aggr_port_start(aggr_port_t *);
215 extern void aggr_port_stop(aggr_port_t *);
216 extern int aggr_port_promisc(aggr_port_t *, boolean_t);
217 extern int aggr_port_unicst(aggr_port_t *, uint8_t *);
218 extern int aggr_port_multicst(void *, boolean_t, const uint8_t *);
219 extern uint64_t aggr_port_stat(aggr_port_t *, uint_t);
220 extern boolean_t aggr_port_notify_link(aggr_grp_t *, aggr_port_t *, boolean_t);
221 extern void aggr_port_init_callbacks(aggr_port_t *);
222 
223 extern void aggr_recv_cb(void *, mac_resource_handle_t, mblk_t *);
224 
225 extern mblk_t *aggr_m_tx(void *, mblk_t *);
226 extern void aggr_send_port_enable(aggr_port_t *);
227 extern void aggr_send_port_disable(aggr_port_t *);
228 extern void aggr_send_update_policy(aggr_grp_t *, uint32_t);
229 
230 extern void aggr_lacp_init(void);
231 extern void aggr_lacp_fini(void);
232 extern void aggr_lacp_init_port(aggr_port_t *);
233 extern void aggr_lacp_init_grp(aggr_grp_t *);
234 extern void aggr_lacp_set_mode(aggr_grp_t *, aggr_lacp_mode_t,
235     aggr_lacp_timer_t);
236 extern void aggr_lacp_update_mode(aggr_grp_t *, aggr_lacp_mode_t);
237 extern void aggr_lacp_update_timer(aggr_grp_t *, aggr_lacp_timer_t);
238 extern void aggr_lacp_rx(aggr_port_t *, mblk_t *);
239 extern void aggr_lacp_port_attached(aggr_port_t *);
240 extern void aggr_lacp_port_detached(aggr_port_t *);
241 extern void aggr_lacp_policy_changed(aggr_grp_t *);
242 
243 #endif	/* _KERNEL */
244 
245 #ifdef	__cplusplus
246 }
247 #endif
248 
249 #endif	/* _SYS_AGGR_IMPL_H */
250