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 * Copyright (c) 2012, Joyent, Inc. All rights reserved.
25 */
26 /*
27 * Copyright (c) 2013, Joyent, Inc. All rights reserved.
28 */
29
30 #ifndef _SYS_MAC_CLIENT_IMPL_H
31 #define _SYS_MAC_CLIENT_IMPL_H
32
33 #include <sys/modhash.h>
34 #include <sys/mac_client.h>
35 #include <sys/mac_provider.h>
36 #include <sys/mac.h>
37 #include <sys/mac_impl.h>
38 #include <sys/mac_stat.h>
39 #include <net/if.h>
40 #include <sys/mac_flow_impl.h>
41
42 #ifdef __cplusplus
43 extern "C" {
44 #endif
45
46 extern kmem_cache_t *mac_client_impl_cache;
47 extern kmem_cache_t *mac_unicast_impl_cache;
48 extern kmem_cache_t *mac_promisc_impl_cache;
49
50 /*
51 * Need a list to chain all VIDs assigned to a client. Normally, one
52 * MAC client only has one VID. But vsw might need multiple VIDs.
53 */
54 typedef struct mac_unicast_impl_s { /* Protected by */
55 struct mac_unicast_impl_s *mui_next; /* SL */
56 mac_address_t *mui_map; /* SL */
57 uint16_t mui_vid; /* SL */
58 } mac_unicast_impl_t;
59
60 #define MAC_CLIENT_FLAGS_PRIMARY 0X0001
61 #define MAC_CLIENT_FLAGS_VNIC_PRIMARY 0x0002
62 #define MAC_CLIENT_FLAGS_MULTI_PRIMARY 0x0004
63 #define MAC_CLIENT_FLAGS_PASSIVE_PRIMARY 0x0008
64
65 /*
66 * One of these is instantiated per MAC client promiscuous callback.
67 *
68 * Each element of this structure belongs to two linked list. One
69 * for the mac_client_impl_t (mci_promisc_list) which created allocated
70 * the callback, the other for the mac_impl_t (mi_promisc_list) corresponding
71 * to the MAC client.
72 * The former allows us to do bookkeeping, the latter allows us
73 * to more efficiently dispatch packets to the promiscuous callbacks.
74 */
75 typedef struct mac_promisc_impl_s { /* Protected by */
76 mac_cb_t mpi_mci_link; /* mi_promisc_lock */
77 mac_cb_t mpi_mi_link; /* mi_promisc_lock */
78 mac_client_promisc_type_t mpi_type; /* WO */
79 mac_rx_t mpi_fn; /* WO */
80 void *mpi_arg; /* WO */
81 struct mac_client_impl_s *mpi_mcip; /* WO */
82 boolean_t mpi_no_tx_loop; /* WO */
83 boolean_t mpi_no_phys; /* WO */
84 boolean_t mpi_strip_vlan_tag; /* WO */
85 boolean_t mpi_no_copy; /* WO */
86 } mac_promisc_impl_t;
87
88 typedef union mac_tx_percpu_s {
89 struct {
90 kmutex_t _pcpu_tx_lock;
91 uint_t _pcpu_tx_refcnt;
92 } pcpu_lr;
93 uchar_t pcpu_pad[64];
94 } mac_tx_percpu_t;
95
96 #define pcpu_tx_lock pcpu_lr._pcpu_tx_lock
97 #define pcpu_tx_refcnt pcpu_lr._pcpu_tx_refcnt
98
99 /*
100 * One of these is instantiated for each MAC client.
101 */
102 struct mac_client_impl_s { /* Protected by */
103 struct mac_client_impl_s *mci_client_next; /* mi_rw_lock */
104 char mci_name[MAXNAMELEN]; /* mi_rw_lock */
105 /*
106 * This flow entry will contain all the internal constructs
107 * such as SRS etc. for this MAC client. The MAC client may
108 * have more than one flow corresponding to each upper client
109 * sharing this mac_client_impl_t.
110 */
111 flow_entry_t *mci_flent; /* mi_rw_lock */
112 struct mac_impl_s *mci_mip; /* WO */
113 /*
114 * If this is a client that has a pass thru MAC (e.g. a VNIC),
115 * then we also keep the handle for the client's upper MAC.
116 */
117 struct mac_impl_s *mci_upper_mip; /* WO */
118
119 uint32_t mci_state_flags; /* WO */
120 mac_rx_t mci_rx_fn; /* Rx Quiescence */
121 void *mci_rx_arg; /* Rx Quiescence */
122 mac_direct_rx_t mci_direct_rx_fn; /* SL */
123 void *mci_direct_rx_arg; /* SL */
124 mac_rx_t mci_rx_p_fn; /* Rx Quiescence */
125 void *mci_rx_p_arg; /* Rx Quiescence */
126 void *mci_p_unicast_list;
127
128 mac_cb_t *mci_promisc_list; /* mi_promisc_lock */
129
130 mac_address_t *mci_unicast;
131 uint32_t mci_flags; /* SL */
132 krwlock_t mci_rw_lock;
133 mac_unicast_impl_t *mci_unicast_list; /* mci_rw_lock */
134 /*
135 * The mac_client_impl_t may be shared by multiple clients, i.e
136 * multiple VLANs sharing the same MAC client. In this case the
137 * address/vid tubles differ and are each associated with their
138 * own flow entry, but the rest underlying components SRS, etc,
139 * are common.
140 */
141 flow_entry_t *mci_flent_list; /* mci_rw_lock */
142 uint_t mci_nflents; /* mci_rw_lock */
143 uint_t mci_nvids; /* mci_rw_lock */
144 volatile uint32_t mci_vidcache; /* VID cache */
145
146 /* Resource Management Functions */
147 mac_resource_add_t mci_resource_add; /* SL */
148 mac_resource_remove_t mci_resource_remove; /* SL */
149 mac_resource_quiesce_t mci_resource_quiesce; /* SL */
150 mac_resource_restart_t mci_resource_restart; /* SL */
151 mac_resource_bind_t mci_resource_bind; /* SL */
152 void *mci_resource_arg; /* SL */
153
154
155 /* Tx notify callback */
156 kmutex_t mci_tx_cb_lock;
157 mac_cb_info_t mci_tx_notify_cb_info; /* cb list info */
158 mac_cb_t *mci_tx_notify_cb_list; /* The cb list */
159 uintptr_t mci_tx_notify_id;
160
161 /* per MAC client stats */ /* None */
162 mac_misc_stats_t mci_misc_stat;
163
164 flow_tab_t *mci_subflow_tab; /* Rx quiescence */
165
166 /*
167 * Priority range for this MAC client. This the range
168 * corresponding to the priority configured (nr_flow_priority).
169 */
170 pri_t mci_min_pri;
171 pri_t mci_max_pri;
172
173 /*
174 * Hybrid I/O related definitions.
175 */
176 mac_share_handle_t mci_share;
177
178 /* for multicast support */
179 struct mac_mcast_addrs_s *mci_mcast_addrs; /* mi_rw_lock */
180
181 /*
182 * Mac protection related fields
183 */
184 kmutex_t mci_protect_lock;
185 uint32_t mci_protect_flags; /* SL */
186 in6_addr_t mci_v6_mac_token; /* SL */
187 in6_addr_t mci_v6_local_addr; /* SL */
188 avl_tree_t mci_v4_pending_txn; /* mci_protect_lock */
189 avl_tree_t mci_v4_completed_txn; /* mci_protect_lock */
190 avl_tree_t mci_v4_dyn_ip; /* mci_protect_lock */
191 avl_tree_t mci_v6_pending_txn; /* mci_protect_lock */
192 avl_tree_t mci_v6_cid; /* mci_protect_lock */
193 avl_tree_t mci_v6_dyn_ip; /* mci_protect_lock */
194 avl_tree_t mci_v6_slaac_ip; /* mci_protect_lock */
195 timeout_id_t mci_txn_cleanup_tid; /* mci_protect_lock */
196
197 /*
198 * Protected by mci_tx_pcpu[0].pcpu_tx_lock
199 */
200 uint_t mci_tx_flag;
201 kcondvar_t mci_tx_cv;
202
203 /* Must be last in the structure for dynamic sizing */
204 mac_tx_percpu_t mci_tx_pcpu[1]; /* SL */
205 };
206
207 #define MAC_CLIENT_IMPL_SIZE \
208 (sizeof (mac_client_impl_t) + \
209 (mac_tx_percpu_cnt * sizeof (mac_tx_percpu_t)))
210
211 extern int mac_tx_percpu_cnt;
212
213 #define MCIP_TX_SRS(mcip) \
214 ((mcip)->mci_flent == NULL ? NULL : (mcip)->mci_flent->fe_tx_srs)
215
216 /* Defensive coding, non-null mcip_flent could be an assert */
217
218 #define MCIP_DATAPATH_SETUP(mcip) \
219 ((mcip)->mci_flent == NULL ? B_FALSE : \
220 !((mcip)->mci_flent->fe_flags & FE_MC_NO_DATAPATH))
221
222 #define MCIP_RESOURCE_PROPS(mcip) \
223 ((mcip)->mci_flent == NULL ? NULL : \
224 &(mcip)->mci_flent->fe_resource_props)
225
226 #define MCIP_EFFECTIVE_PROPS(mcip) \
227 (mcip->mci_flent == NULL ? NULL : \
228 &(mcip)->mci_flent->fe_effective_props)
229
230 #define MCIP_RESOURCE_PROPS_MASK(mcip) \
231 ((mcip)->mci_flent == NULL ? 0 : \
232 (mcip)->mci_flent->fe_resource_props.mrp_mask)
233
234 #define MCIP_RESOURCE_PROPS_MAXBW(mcip) \
235 ((mcip)->mci_flent == NULL ? 0 : \
236 (mcip)->mci_flent->fe_resource_props.mrp_maxbw)
237
238 #define MCIP_RESOURCE_PROPS_PRIORITY(mcip) \
239 ((mcip)->mci_flent == NULL ? 0 : \
240 (mcip)->mci_flent->fe_resource_props.mrp_priority)
241
242 #define MCIP_RESOURCE_PROPS_CPUS(mcip) \
243 ((mcip)->mci_flent == NULL ? 0 : \
244 &(mcip)->mci_flent->fe_resource_props.mrp_cpus)
245
246 #define MCIP_RESOURCE_PROPS_NCPUS(mcip) \
247 ((mcip)->mci_flent == NULL ? 0 : \
248 (mcip)->mci_flent->fe_resource_props.mrp_ncpus)
249
250 #define MCIP_RESOURCE_PROPS_CPU(mcip) \
251 ((mcip)->mci_flent == NULL ? 0 : \
252 (mcip)->mci_flent->fe_resource_props.mrp_ncpu)
253
254 /*
255 * We validate the VLAN id of the packet w.r.t the client's vid,
256 * if required (i.e. !MCIS_DISABLE_TX_VID_CHECK). DLS clients
257 * will have MCIS_DISABLE_TX_VID_CHECK set.
258 * (In the case of aggr when we get back packets, due to
259 * the underlying driver being flow controlled, we won't
260 * drop the packet even if it is VLAN tagged as we
261 * don't set MCIS_DISABLE_TX_VID_CHECK for an aggr.)
262 */
263 #define MAC_VID_CHECK_NEEDED(mcip) \
264 (((mcip)->mci_state_flags & MCIS_DISABLE_TX_VID_CHECK) == 0 && \
265 (mcip)->mci_mip->mi_info.mi_nativemedia == DL_ETHER)
266
267 #define MAC_VID_CHECK(mcip, mp, err) { \
268 if (ntohs(((struct ether_header *)(mp)->b_rptr)->ether_type) == \
269 ETHERTYPE_VLAN) { \
270 /* \
271 * err is set to EINVAL (so the caller can take the \
272 * appropriate action. e.g. freemsg()) for two cases: \
273 * -client is not responsible for filling in the vid. \
274 * -client is responsible for filling in the vid, but \
275 * the vid doesn't match the vid of the MAC client. \
276 */ \
277 (err) = EINVAL; \
278 if (((mcip)->mci_state_flags & MCIS_TAG_DISABLE) != 0) {\
279 struct ether_vlan_header *evhp; \
280 uint16_t vlanid; \
281 \
282 evhp = (struct ether_vlan_header *)(mp)->b_rptr;\
283 vlanid = VLAN_ID(ntohs(evhp->ether_tci)); \
284 if (mac_client_check_flow_vid((mcip), vlanid)) \
285 (err) = 0; \
286 } \
287 } \
288 }
289
290 /*
291 * To allow the hot path to not grab any additional locks, we keep a single
292 * entry VLAN ID cache that caches whether or not a given VID belongs to a
293 * MAC client.
294 */
295 #define MCIP_VIDCACHE_VALIDSHIFT 31
296 #define MCIP_VIDCACHE_VIDSHIFT 1
297 #define MCIP_VIDCACHE_VIDMASK (UINT16_MAX << MCIP_VIDCACHE_VIDSHIFT)
298 #define MCIP_VIDCACHE_BOOLSHIFT 0
299
300 #define MCIP_VIDCACHE_INVALID 0
301
302 #define MCIP_VIDCACHE_CACHE(vid, bool) \
303 ((1U << MCIP_VIDCACHE_VALIDSHIFT) | \
304 ((vid) << MCIP_VIDCACHE_VIDSHIFT) | \
305 ((bool) ? (1U << MCIP_VIDCACHE_BOOLSHIFT) : 0))
306
307 #define MCIP_VIDCACHE_ISVALID(v) ((v) & (1U << MCIP_VIDCACHE_VALIDSHIFT))
308 #define MCIP_VIDCACHE_VID(v) \
309 (((v) & MCIP_VIDCACHE_VIDMASK) >> MCIP_VIDCACHE_VIDSHIFT)
310 #define MCIP_VIDCACHE_BOOL(v) ((v) & (1U << MCIP_VIDCACHE_BOOLSHIFT))
311
312 #define MAC_TAG_NEEDED(mcip) \
313 (((mcip)->mci_state_flags & MCIS_TAG_DISABLE) == 0 && \
314 (mcip)->mci_nvids == 1) \
315
316 /* MCI state flags */
317 #define MCIS_IS_VNIC 0x0001
318 #define MCIS_EXCLUSIVE 0x0002
319 #define MCIS_TAG_DISABLE 0x0004
320 #define MCIS_STRIP_DISABLE 0x0008
321 #define MCIS_IS_AGGR_PORT 0x0010
322 #define MCIS_CLIENT_POLL_CAPABLE 0x0020
323 #define MCIS_DESC_LOGGED 0x0040
324 #define MCIS_SHARE_BOUND 0x0080
325 #define MCIS_DISABLE_TX_VID_CHECK 0x0100
326 #define MCIS_USE_DATALINK_NAME 0x0200
327 #define MCIS_UNICAST_HW 0x0400
328 #define MCIS_IS_AGGR 0x0800
329 #define MCIS_RX_BYPASS_DISABLE 0x1000
330 #define MCIS_NO_UNICAST_ADDR 0x2000
331
332 /* Mac protection flags */
333 #define MPT_FLAG_V6_LOCAL_ADDR_SET 0x0001
334 #define MPT_FLAG_PROMISC_FILTERED 0x0002
335
336 /* in mac_client.c */
337 extern void mac_promisc_client_dispatch(mac_client_impl_t *, mblk_t *);
338 extern void mac_client_init(void);
339 extern void mac_client_fini(void);
340 extern void mac_promisc_dispatch(mac_impl_t *, mblk_t *,
341 mac_client_impl_t *);
342
343 extern int mac_validate_props(mac_impl_t *, mac_resource_props_t *);
344
345 extern mac_client_impl_t *mac_vnic_lower(mac_impl_t *);
346 extern mac_client_impl_t *mac_primary_client_handle(mac_impl_t *);
347 extern uint16_t i_mac_flow_vid(flow_entry_t *);
348 extern boolean_t i_mac_capab_get(mac_handle_t, mac_capab_t, void *);
349
350 extern void mac_unicast_update_clients(mac_impl_t *, mac_address_t *);
351 extern void mac_update_resources(mac_resource_props_t *,
352 mac_resource_props_t *, boolean_t);
353
354 boolean_t mac_client_check_flow_vid(mac_client_impl_t *, uint16_t);
355
356 extern boolean_t mac_is_primary_client(mac_client_impl_t *);
357
358 extern int mac_client_set_rings_prop(mac_client_impl_t *,
359 mac_resource_props_t *, mac_resource_props_t *);
360 extern void mac_set_prim_vlan_rings(mac_impl_t *, mac_resource_props_t *);
361
362 #ifdef __cplusplus
363 }
364 #endif
365
366 #endif /* _SYS_MAC_CLIENT_IMPL_H */