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