xref: /illumos-gate/usr/src/uts/common/sys/mac_impl.h (revision 36589d6bb0cdae89e166b57b0d64ae56d53247d9)
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 (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
23  * Copyright 2019 Joyent, Inc.
24  */
25 
26 #ifndef	_SYS_MAC_IMPL_H
27 #define	_SYS_MAC_IMPL_H
28 
29 #include <sys/cpupart.h>
30 #include <sys/modhash.h>
31 #include <sys/mac_client.h>
32 #include <sys/mac_provider.h>
33 #include <sys/note.h>
34 #include <sys/avl.h>
35 #include <net/if.h>
36 #include <sys/mac_flow_impl.h>
37 #include <netinet/ip6.h>
38 #include <sys/pattr.h>
39 
40 #ifdef	__cplusplus
41 extern "C" {
42 #endif
43 
44 /*
45  * This is the first minor number available for MAC provider private
46  * use.  This makes it possible to deliver a driver that is both a MAC
47  * provider and a regular character/block device.  See PSARC 2009/380
48  * for more detail about the construction of such devices.  The value
49  * chosen leaves half of the 32-bit minor numbers (which are really
50  * only 18 bits wide) available for driver private use.  Drivers can
51  * easily identify their private number by the presence of this value
52  * in the bits that make up the minor number, since its just the
53  * highest bit available for such minor numbers.
54  */
55 #define	MAC_PRIVATE_MINOR		((MAXMIN32 + 1) / 2)
56 
57 /*
58  * The maximum minor number that corresponds to a real instance.  This
59  * limits the number of physical ports that a mac provider can offer.
60  * Note that this macro must be synchronized with DLS_MAX_MINOR in
61  * <sys/dls.h>
62  */
63 #define	MAC_MAX_MINOR			1000
64 
65 typedef struct mac_margin_req_s	mac_margin_req_t;
66 
67 struct mac_margin_req_s {
68 	mac_margin_req_t	*mmr_nextp;
69 	uint_t			mmr_ref;
70 	uint32_t		mmr_margin;
71 };
72 
73 typedef struct mac_mtu_req_s mac_mtu_req_t;
74 struct mac_mtu_req_s {
75 	mac_mtu_req_t		*mtr_nextp;
76 	uint_t			mtr_ref;
77 	uint32_t		mtr_mtu;
78 };
79 
80 /* Generic linked chain type */
81 typedef	struct mac_chain_s {
82 	struct mac_chain_s	*next;
83 	void			*item;
84 } mac_chain_t;
85 
86 /*
87  * Generic mac callback list manipulation structures and macros. The mac_cb_t
88  * represents a general callback list element embedded in a particular
89  * data structure such as a mac_notify_cb_t or a mac_promisc_impl_t.
90  * The mac_cb_info_t represents general information about list walkers.
91  * Please see the comments above mac_callback_add for more information.
92  */
93 /* mcb_flags */
94 #define	MCB_CONDEMNED		0x1		/* Logically deleted */
95 #define	MCB_NOTIFY_CB_T		0x2
96 #define	MCB_TX_NOTIFY_CB_T	0x4
97 
98 extern boolean_t	mac_tx_serialize;
99 
100 typedef struct mac_cb_s {
101 	struct mac_cb_s		*mcb_nextp;	/* Linked list of callbacks */
102 	void			*mcb_objp;	/* Ptr to enclosing object  */
103 	size_t			mcb_objsize;	/* Sizeof the enclosing obj */
104 	uint_t			mcb_flags;
105 } mac_cb_t;
106 
107 typedef struct mac_cb_info_s {
108 	kmutex_t	*mcbi_lockp;
109 	kcondvar_t	mcbi_cv;
110 	uint_t		mcbi_del_cnt;		/* Deleted callback cnt */
111 	uint_t		mcbi_walker_cnt;	/* List walker count */
112 	uint_t		mcbi_barrier_cnt;	/* Barrier waiter count */
113 } mac_cb_info_t;
114 
115 typedef struct mac_notify_cb_s {
116 	mac_cb_t	mncb_link;		/* Linked list of callbacks */
117 	mac_notify_t	mncb_fn;		/* callback function */
118 	void		*mncb_arg;		/* callback argument */
119 	struct mac_impl_s *mncb_mip;
120 } mac_notify_cb_t;
121 
122 /*
123  * mac_callback_add(listinfo, listhead, listelement)
124  * mac_callback_remove(listinfo, listhead, listelement)
125  */
126 typedef boolean_t (*mcb_func_t)(mac_cb_info_t *, mac_cb_t **, mac_cb_t *);
127 
128 #define	MAC_CALLBACK_WALKER_INC(mcbi) \
129 	mac_callback_walker_enter(mcbi)
130 
131 #define	MAC_CALLBACK_WALKER_DCR(mcbi, headp) \
132 	mac_callback_walker_exit(mcbi, headp, B_FALSE)
133 
134 #define	MAC_PROMISC_WALKER_INC(mip) \
135 	mac_callback_walker_enter(&(mip)->mi_promisc_cb_info)
136 
137 #define	MAC_PROMISC_WALKER_DCR(mip) \
138 	mac_callback_walker_exit(&(mip)->mi_promisc_cb_info, \
139 	    &(mip)->mi_promisc_list, B_TRUE)
140 
141 typedef struct mactype_s {
142 	const char	*mt_ident;
143 	uint32_t	mt_ref;
144 	uint_t		mt_type;
145 	uint_t		mt_nativetype;
146 	size_t		mt_addr_length;
147 	uint8_t		*mt_brdcst_addr;
148 	mactype_ops_t	mt_ops;
149 	mac_stat_info_t	*mt_stats;	/* array of mac_stat_info_t elements */
150 	size_t		mt_statcount;	/* number of elements in mt_stats */
151 	mac_ndd_mapping_t *mt_mapping;
152 	size_t		mt_mappingcount;
153 } mactype_t;
154 
155 /*
156  * Multiple rings implementation.
157  */
158 typedef	enum {
159 	MAC_GROUP_STATE_UNINIT	= 0,	/* initial state of data structure */
160 	MAC_GROUP_STATE_REGISTERED,	/* hooked with h/w group */
161 	MAC_GROUP_STATE_RESERVED,	/* group is reserved and opened */
162 	MAC_GROUP_STATE_SHARED		/* default group shared among */
163 					/* multiple mac clients */
164 } mac_group_state_t;
165 
166 typedef	struct mac_ring_s mac_ring_t;
167 typedef	struct mac_group_s mac_group_t;
168 
169 /*
170  * Ring data structure for ring control and management.
171  */
172 typedef enum {
173 	MR_FREE,		/* Available for assignment to flows */
174 	MR_NEWLY_ADDED,		/* Just assigned to another group */
175 	MR_INUSE		/* Assigned to an SRS */
176 } mac_ring_state_t;
177 
178 /* mr_flag values */
179 #define	MR_INCIPIENT	0x1
180 #define	MR_CONDEMNED	0x2
181 #define	MR_QUIESCE	0x4
182 
183 typedef struct mac_impl_s mac_impl_t;
184 
185 struct mac_ring_s {
186 	int			mr_index;	/* index in the original list */
187 	mac_ring_type_t		mr_type;	/* ring type */
188 	mac_ring_t		*mr_next;	/* next ring in the chain */
189 	mac_group_handle_t	mr_gh;		/* reference to group */
190 
191 	mac_classify_type_t	mr_classify_type;
192 	struct mac_soft_ring_set_s *mr_srs;	/* associated SRS */
193 	mac_ring_handle_t	mr_prh;	/* associated pseudo ring hdl */
194 
195 	/*
196 	 * Ring passthru callback and arguments. See the
197 	 * MAC_PASSTHRU_CLASSIFIER comment in mac_provider.h.
198 	 */
199 	mac_rx_t		mr_pt_fn;
200 	void			*mr_pt_arg1;
201 	mac_resource_handle_t	mr_pt_arg2;
202 
203 	uint_t			mr_refcnt;	/* Ring references */
204 	/* ring generation no. to guard against drivers using stale rings */
205 	uint64_t		mr_gen_num;
206 
207 	kstat_t			*mr_ksp;	/* ring kstats */
208 	mac_impl_t		*mr_mip;	/* pointer to primary's mip */
209 
210 	kmutex_t		mr_lock;
211 	kcondvar_t		mr_cv;			/* mr_lock */
212 	mac_ring_state_t	mr_state;		/* mr_lock */
213 	uint_t			mr_flag;		/* mr_lock */
214 
215 	mac_ring_info_t		mr_info;	/* driver supplied info */
216 };
217 #define	mr_driver		mr_info.mri_driver
218 #define	mr_start		mr_info.mri_start
219 #define	mr_stop			mr_info.mri_stop
220 #define	mr_stat			mr_info.mri_stat
221 
222 #define	MAC_RING_MARK(mr, flag)		\
223 	(mr)->mr_flag |= flag;
224 
225 #define	MAC_RING_UNMARK(mr, flag)	\
226 	(mr)->mr_flag &= ~flag;
227 
228 /*
229  * Reference hold and release on mac_ring_t 'mr'
230  */
231 #define	MR_REFHOLD_LOCKED(mr)		{		\
232 	ASSERT(MUTEX_HELD(&mr->mr_lock));		\
233 	(mr)->mr_refcnt++;				\
234 }
235 
236 #define	MR_REFRELE(mr)		{			\
237 	mutex_enter(&(mr)->mr_lock);			\
238 	ASSERT((mr)->mr_refcnt != 0);			\
239 	(mr)->mr_refcnt--;				\
240 	if ((mr)->mr_refcnt == 0 &&			\
241 	    ((mr)->mr_flag & (MR_CONDEMNED | MR_QUIESCE))) \
242 		cv_signal(&(mr)->mr_cv);		\
243 	mutex_exit(&(mr)->mr_lock);			\
244 }
245 
246 /*
247  * Used to attach MAC clients to an Rx group. The members are SL
248  * protected.
249  */
250 typedef struct mac_grp_client {
251 	struct mac_grp_client		*mgc_next;
252 	struct mac_client_impl_s	*mgc_client;
253 } mac_grp_client_t;
254 
255 #define	MAC_GROUP_NO_CLIENT(g)	((g)->mrg_clients == NULL)
256 
257 #define	MAC_GROUP_ONLY_CLIENT(g)			\
258 	((((g)->mrg_clients != NULL) &&			\
259 	((g)->mrg_clients->mgc_next == NULL)) ?		\
260 	(g)->mrg_clients->mgc_client : NULL)
261 
262 #define	MAC_GROUP_HW_VLAN(g)				\
263 	(((g) != NULL) &&				\
264 	((g)->mrg_info.mgi_addvlan != NULL) &&		\
265 	((g)->mrg_info.mgi_remvlan != NULL))
266 
267 /*
268  * Common ring group data structure for ring control and management.
269  * The entire structure is SL protected.
270  */
271 struct mac_group_s {
272 	int			mrg_index;	/* index in the list */
273 	mac_ring_type_t		mrg_type;	/* ring type */
274 	mac_group_state_t	mrg_state;	/* state of the group */
275 	mac_group_t		*mrg_next;	/* next group in the chain */
276 	mac_handle_t		mrg_mh;		/* reference to MAC */
277 	mac_ring_t		*mrg_rings;	/* grouped rings */
278 	uint_t			mrg_cur_count;	/* actual size of group */
279 
280 	mac_grp_client_t	*mrg_clients;	/* clients list */
281 
282 	mac_group_info_t	mrg_info;	/* driver supplied info */
283 };
284 
285 #define	mrg_driver		mrg_info.mgi_driver
286 #define	mrg_start		mrg_info.mgi_start
287 #define	mrg_stop		mrg_info.mgi_stop
288 
289 #define	GROUP_INTR_HANDLE(g)		(g)->mrg_info.mgi_intr.mi_handle
290 #define	GROUP_INTR_ENABLE_FUNC(g)	(g)->mrg_info.mgi_intr.mi_enable
291 #define	GROUP_INTR_DISABLE_FUNC(g)	(g)->mrg_info.mgi_intr.mi_disable
292 
293 /* mci_tx_flag */
294 #define	MCI_TX_QUIESCE	0x1
295 
296 typedef struct mac_factory_addr_s {
297 	boolean_t		mfa_in_use;
298 	uint8_t			mfa_addr[MAXMACADDRLEN];
299 	struct mac_client_impl_s	*mfa_client;
300 } mac_factory_addr_t;
301 
302 typedef struct mac_mcast_addrs_s {
303 	struct mac_mcast_addrs_s	*mma_next;
304 	uint8_t				mma_addr[MAXMACADDRLEN];
305 	int				mma_ref;
306 } mac_mcast_addrs_t;
307 
308 typedef enum {
309 	MAC_ADDRESS_TYPE_UNICAST_CLASSIFIED = 1,	/* HW classification */
310 	MAC_ADDRESS_TYPE_UNICAST_PROMISC		/* promiscuous mode */
311 } mac_address_type_t;
312 
313 typedef struct mac_vlan_s {
314 	struct mac_vlan_s	*mv_next;
315 	uint16_t		mv_vid;
316 } mac_vlan_t;
317 
318 typedef struct mac_address_s {
319 	mac_address_type_t	ma_type;		/* address type */
320 	int			ma_nusers;		/* num users of addr */
321 	struct mac_address_s	*ma_next;		/* next address */
322 	uint8_t			ma_addr[MAXMACADDRLEN];	/* address value */
323 	size_t			ma_len;			/* address length */
324 	mac_vlan_t		*ma_vlans;		/* VLANs on this addr */
325 	boolean_t		ma_untagged;		/* accept untagged? */
326 	mac_group_t		*ma_group;		/* asscociated group */
327 	mac_impl_t		*ma_mip;		/* MAC handle */
328 } mac_address_t;
329 
330 extern krwlock_t i_mac_impl_lock;
331 extern mod_hash_t *i_mac_impl_hash;
332 extern kmem_cache_t *i_mac_impl_cachep;
333 extern uint_t i_mac_impl_count;
334 
335 /*
336  * Each registered MAC is associated with a mac_impl_t structure. The
337  * structure represents the undelying hardware, in terms of definition,
338  * resources (transmit, receive rings etc.), callback functions etc. It
339  * also holds the table of MAC clients that are configured on the device.
340  * The table is used for classifying incoming packets in software.
341  *
342  * The protection scheme uses 2 elements, a coarse serialization mechanism
343  * called perimeter and a finer traditional lock based scheme. More details
344  * can be found in the big block comment in mac.c.
345  *
346  * The protection scheme for each member of the mac_impl_t is described below.
347  *
348  * Write Once Only (WO): Typically these don't change for the lifetime of the
349  * data structure. For example something in mac_impl_t that stays the same
350  * from mac_register to mac_unregister, or something in a mac_client_impl_t
351  * that stays the same from mac_client_open to mac_client_close.
352  *
353  * Serializer (SL): Protected by the Serializer. All SLOP operations on a
354  * mac endpoint go through the serializer. MTOPs don't care about reading
355  * these fields atomically.
356  *
357  * Lock: Traditional mutex/rw lock. Modify operations still go through the
358  * mac serializer, the lock helps synchronize readers with writers.
359  */
360 struct mac_impl_s {
361 	krwlock_t		mi_rw_lock;
362 	list_node_t		mi_node;
363 	char			mi_name[LIFNAMSIZ];	/* WO */
364 	uint32_t		mi_state_flags;
365 	void			*mi_driver;		/* Driver private, WO */
366 	mac_info_t		mi_info;		/* WO */
367 	mactype_t		*mi_type;		/* WO */
368 	void			*mi_pdata;		/* WO */
369 	size_t			mi_pdata_size;		/* WO */
370 	mac_callbacks_t		*mi_callbacks;		/* WO */
371 	dev_info_t		*mi_dip;		/* WO */
372 	uint32_t		mi_ref;			/* i_mac_impl_lock */
373 	uint_t			mi_active;		/* SL */
374 	link_state_t		mi_linkstate;		/* none */
375 	link_state_t		mi_lowlinkstate;	/* none */
376 	link_state_t		mi_lastlowlinkstate;	/* none */
377 	uint_t			mi_devpromisc;		/* SL */
378 	uint8_t			mi_addr[MAXMACADDRLEN];	/* mi_rw_lock */
379 	uint8_t			mi_dstaddr[MAXMACADDRLEN]; /* mi_rw_lock */
380 	boolean_t		mi_dstaddr_set;
381 
382 	/*
383 	 * The mac perimeter. All client initiated create/modify operations
384 	 * on a mac end point go through this.
385 	 */
386 	kmutex_t		mi_perim_lock;
387 	kthread_t		*mi_perim_owner;	/* mi_perim_lock */
388 	uint_t			mi_perim_ocnt;		/* mi_perim_lock */
389 	kcondvar_t		mi_perim_cv;		/* mi_perim_lock */
390 
391 	/* mac notification callbacks */
392 	kmutex_t		mi_notify_lock;
393 	mac_cb_info_t		mi_notify_cb_info;	/* mi_notify_lock */
394 	mac_cb_t		*mi_notify_cb_list;	/* mi_notify_lock */
395 	kthread_t		*mi_notify_thread;	/* mi_notify_lock */
396 	uint_t			mi_notify_bits;		/* mi_notify_lock */
397 
398 	uint32_t		mi_v12n_level;		/* Virt'ion readiness */
399 
400 	/*
401 	 * RX groups, ring capability
402 	 * Fields of this block are SL protected.
403 	 */
404 	mac_group_type_t	mi_rx_group_type;	/* grouping type */
405 	uint_t			mi_rx_group_count;
406 	mac_group_t		*mi_rx_groups;
407 	mac_group_t		*mi_rx_donor_grp;
408 	uint_t			mi_rxrings_rsvd;
409 	uint_t			mi_rxrings_avail;
410 	uint_t			mi_rxhwclnt_avail;
411 	uint_t			mi_rxhwclnt_used;
412 
413 	mac_capab_rings_t	mi_rx_rings_cap;
414 
415 	/*
416 	 * TX groups and ring capability, SL Protected.
417 	 */
418 	mac_group_type_t	mi_tx_group_type;	/* grouping type */
419 	uint_t			mi_tx_group_count;
420 	uint_t			mi_tx_group_free;
421 	mac_group_t		*mi_tx_groups;
422 	mac_capab_rings_t	mi_tx_rings_cap;
423 	uint_t			mi_txrings_rsvd;
424 	uint_t			mi_txrings_avail;
425 	uint_t			mi_txhwclnt_avail;
426 	uint_t			mi_txhwclnt_used;
427 
428 	mac_ring_handle_t	mi_default_tx_ring;
429 
430 	/*
431 	 * Transceiver capabilities. SL protected.
432 	 */
433 	mac_capab_transceiver_t	mi_transceiver;
434 
435 	/*
436 	 * LED Capability information. SL protected.
437 	 */
438 	mac_led_mode_t		mi_led_modes;
439 	mac_capab_led_t		mi_led;
440 
441 	/* Cache of the Tx DB_CKSUMFLAGS that this MAC supports. */
442 	uint16_t		mi_tx_cksum_flags; /* SL */
443 
444 	/*
445 	 * MAC address and VLAN lists. SL protected.
446 	 */
447 	mac_address_t		*mi_addresses;
448 
449 	/*
450 	 * This MAC's table of sub-flows
451 	 */
452 	flow_tab_t		*mi_flow_tab;		/* WO */
453 
454 	kstat_t			*mi_ksp;		/* WO */
455 	uint_t			mi_kstat_count;		/* WO */
456 	uint_t			mi_nactiveclients;	/* SL */
457 
458 	/* for broadcast and multicast support */
459 	struct mac_mcast_addrs_s *mi_mcast_addrs;	/* mi_rw_lock */
460 	struct mac_bcast_grp_s *mi_bcast_grp;		/* mi_rw_lock */
461 	uint_t			mi_bcast_ngrps;		/* mi_rw_lock */
462 
463 	/* list of MAC clients which opened this MAC */
464 	struct mac_client_impl_s *mi_clients_list;	/* mi_rw_lock */
465 	uint_t			mi_nclients;		/* mi_rw_lock */
466 	struct mac_client_impl_s *mi_single_active_client; /* mi_rw_lock */
467 
468 	uint32_t		mi_margin;		/* mi_rw_lock */
469 	uint_t			mi_sdu_min;		/* mi_rw_lock */
470 	uint_t			mi_sdu_max;		/* mi_rw_lock */
471 	uint_t			mi_sdu_multicast;	/* mi_rw_lock */
472 
473 	/*
474 	 * Cache of factory MAC addresses provided by the driver. If
475 	 * the driver doesn't provide multiple factory MAC addresses,
476 	 * the mi_factory_addr is set to NULL, and mi_factory_addr_num
477 	 * is set to zero.
478 	 */
479 	mac_factory_addr_t	*mi_factory_addr;	/* mi_rw_lock */
480 	uint_t			mi_factory_addr_num;	/* mi_rw_lock */
481 
482 	/* for promiscuous mode support */
483 	kmutex_t		mi_promisc_lock;
484 	mac_cb_t		*mi_promisc_list;	/* mi_promisc_lock */
485 	mac_cb_info_t		mi_promisc_cb_info;	/* mi_promisc_lock */
486 
487 	/* cache of rings over this mac_impl */
488 	kmutex_t		mi_ring_lock;
489 	mac_ring_t		*mi_ring_freelist;	/* mi_ring_lock */
490 
491 	/*
492 	 * These are used for caching the properties, if any, for the
493 	 * primary MAC client. If the MAC client is not yet in place
494 	 * when the properties are set then we cache them here to be
495 	 * applied to the MAC client when it is created.
496 	 */
497 	mac_resource_props_t	mi_resource_props;	/* SL */
498 	uint16_t		mi_pvid;		/* SL */
499 
500 	minor_t			mi_minor;		/* WO */
501 	uint32_t		mi_oref;		/* SL */
502 	mac_capab_legacy_t	mi_capab_legacy;	/* WO */
503 	dev_t			mi_phy_dev;		/* WO */
504 
505 	/*
506 	 * List of margin value requests added by mac clients. This list is
507 	 * sorted: the first one has the greatest value.
508 	 */
509 	mac_margin_req_t	*mi_mmrp;
510 	mac_mtu_req_t		*mi_mtrp;
511 	char			**mi_priv_prop;
512 	uint_t			mi_priv_prop_count;
513 
514 	/*
515 	 * Hybrid I/O related definitions.
516 	 */
517 	mac_capab_share_t	mi_share_capab;
518 
519 	/*
520 	 * Bridging hooks and limit values.  Uses mutex and reference counts
521 	 * (bridging only) for data path.  Limits need no synchronization.
522 	 */
523 	mac_handle_t		mi_bridge_link;
524 	kmutex_t		mi_bridge_lock;
525 	uint32_t		mi_llimit;
526 	uint32_t		mi_ldecay;
527 
528 /* This should be the last block in this structure */
529 #ifdef DEBUG
530 #define	MAC_PERIM_STACK_DEPTH	15
531 	int			mi_perim_stack_depth;
532 	pc_t			mi_perim_stack[MAC_PERIM_STACK_DEPTH];
533 #endif
534 };
535 
536 /*
537  * The default TX group is the last one in the list.
538  */
539 #define	MAC_DEFAULT_TX_GROUP(mip)	\
540 	(mip)->mi_tx_groups + (mip)->mi_tx_group_count
541 
542 /*
543  * The default RX group is the first one in the list
544  */
545 #define	MAC_DEFAULT_RX_GROUP(mip)	(mip)->mi_rx_groups
546 
547 /* Reserved RX rings */
548 #define	MAC_RX_RING_RESERVED(m, cnt)	{	\
549 	ASSERT((m)->mi_rxrings_avail >= (cnt));	\
550 	(m)->mi_rxrings_rsvd += (cnt);		\
551 	(m)->mi_rxrings_avail -= (cnt);		\
552 }
553 
554 /* Released RX rings */
555 #define	MAC_RX_RING_RELEASED(m, cnt)	{	\
556 	ASSERT((m)->mi_rxrings_rsvd >= (cnt));	\
557 	(m)->mi_rxrings_rsvd -= (cnt);		\
558 	(m)->mi_rxrings_avail += (cnt);		\
559 }
560 
561 /* Reserved a RX group */
562 #define	MAC_RX_GRP_RESERVED(m)	{		\
563 	ASSERT((m)->mi_rxhwclnt_avail > 0);	\
564 	(m)->mi_rxhwclnt_avail--;		\
565 	(m)->mi_rxhwclnt_used++;		\
566 }
567 
568 /* Released a RX group */
569 #define	MAC_RX_GRP_RELEASED(m)	{		\
570 	ASSERT((m)->mi_rxhwclnt_used > 0);	\
571 	(m)->mi_rxhwclnt_avail++;		\
572 	(m)->mi_rxhwclnt_used--;		\
573 }
574 
575 /* Reserved TX rings */
576 #define	MAC_TX_RING_RESERVED(m, cnt)	{	\
577 	ASSERT((m)->mi_txrings_avail >= (cnt));	\
578 	(m)->mi_txrings_rsvd += (cnt);		\
579 	(m)->mi_txrings_avail -= (cnt);		\
580 }
581 /* Released TX rings */
582 #define	MAC_TX_RING_RELEASED(m, cnt)	{	\
583 	ASSERT((m)->mi_txrings_rsvd >= (cnt));	\
584 	(m)->mi_txrings_rsvd -= (cnt);		\
585 	(m)->mi_txrings_avail += (cnt);		\
586 }
587 
588 /* Reserved a TX group */
589 #define	MAC_TX_GRP_RESERVED(m)	{		\
590 	ASSERT((m)->mi_txhwclnt_avail > 0);	\
591 	(m)->mi_txhwclnt_avail--;		\
592 	(m)->mi_txhwclnt_used++;		\
593 }
594 
595 /* Released a TX group */
596 #define	MAC_TX_GRP_RELEASED(m)	{		\
597 	ASSERT((m)->mi_txhwclnt_used > 0);	\
598 	(m)->mi_txhwclnt_avail++;		\
599 	(m)->mi_txhwclnt_used--;		\
600 }
601 
602 /* for mi_state_flags */
603 #define	MIS_DISABLED		0x0001
604 #define	MIS_IS_VNIC		0x0002
605 #define	MIS_IS_AGGR		0x0004
606 #define	MIS_NOTIFY_DONE		0x0008
607 #define	MIS_EXCLUSIVE		0x0010
608 #define	MIS_EXCLUSIVE_HELD	0x0020
609 #define	MIS_LEGACY		0x0040
610 #define	MIS_NO_ACTIVE		0x0080
611 #define	MIS_POLL_DISABLE	0x0100
612 #define	MIS_IS_OVERLAY		0x0200
613 
614 #define	mi_getstat	mi_callbacks->mc_getstat
615 #define	mi_start	mi_callbacks->mc_start
616 #define	mi_stop		mi_callbacks->mc_stop
617 #define	mi_open		mi_callbacks->mc_open
618 #define	mi_close	mi_callbacks->mc_close
619 #define	mi_setpromisc	mi_callbacks->mc_setpromisc
620 #define	mi_multicst	mi_callbacks->mc_multicst
621 #define	mi_unicst	mi_callbacks->mc_unicst
622 #define	mi_tx		mi_callbacks->mc_tx
623 #define	mi_ioctl	mi_callbacks->mc_ioctl
624 #define	mi_getcapab	mi_callbacks->mc_getcapab
625 
626 typedef struct mac_notify_task_arg {
627 	mac_impl_t		*mnt_mip;
628 	mac_notify_type_t	mnt_type;
629 	mac_ring_t		*mnt_ring;
630 } mac_notify_task_arg_t;
631 
632 /*
633  * The mac_perim_handle_t is an opaque type that encodes the 'mip' pointer
634  * and whether internally a mac_open was done when acquiring the perimeter.
635  */
636 #define	MAC_ENCODE_MPH(mph, mh, need_close)		\
637 	(mph) = (mac_perim_handle_t)((uintptr_t)(mh) | need_close)
638 
639 #define	MAC_DECODE_MPH(mph, mip, need_close) {		\
640 	mip = (mac_impl_t *)(((uintptr_t)mph) & ~0x1);	\
641 	(need_close) = ((uintptr_t)mph & 0x1);		\
642 }
643 
644 /*
645  * Type of property information that can be returned by a driver.
646  * Valid flags of the pr_flags of the mac_prop_info_t data structure.
647  */
648 #define	MAC_PROP_INFO_DEFAULT	0x0001
649 #define	MAC_PROP_INFO_RANGE	0x0002
650 #define	MAC_PROP_INFO_PERM	0x0004
651 
652 /*
653  * Property information. pr_flags is a combination of one of the
654  * MAC_PROP_INFO_* flags, it is reset by the framework before invoking
655  * the driver's prefix_propinfo() entry point.
656  *
657  * Drivers should use MAC_PROP_INFO_SET_*() macros to provide
658  * information about a property.
659  */
660 typedef struct mac_prop_info_state_s {
661 	uint8_t			pr_flags;
662 	uint8_t			pr_perm;
663 	uint8_t			pr_errno;
664 	void			*pr_default;
665 	size_t			pr_default_size;
666 	mac_propval_range_t	*pr_range;
667 	uint_t			pr_range_cur_count;
668 } mac_prop_info_state_t;
669 
670 #define	MAC_PROTECT_ENABLED(mcip, type) \
671 	(((mcip)->mci_flent-> \
672 	fe_resource_props.mrp_mask & MRP_PROTECT) != 0 && \
673 	((mcip)->mci_flent-> \
674 	fe_resource_props.mrp_protect.mp_types & (type)) != 0)
675 
676 typedef struct mac_client_impl_s mac_client_impl_t;
677 
678 extern void	mac_init(void);
679 extern int	mac_fini(void);
680 
681 /*
682  * MAC packet/chain drop functions to aggregate all dropped-packet
683  * debugging to a single surface.
684  */
685 /*PRINTFLIKE2*/
686 extern void	mac_drop_pkt(mblk_t *, const char *, ...)
687     __KPRINTFLIKE(2);
688 
689 /*PRINTFLIKE2*/
690 extern void	mac_drop_chain(mblk_t *, const char *, ...)
691     __KPRINTFLIKE(2);
692 
693 extern void	mac_ndd_ioctl(mac_impl_t *, queue_t *, mblk_t *);
694 extern boolean_t mac_ip_hdr_length_v6(ip6_t *, uint8_t *, uint16_t *,
695     uint8_t *, ip6_frag_t **);
696 
697 extern mblk_t *mac_copymsgchain_cksum(mblk_t *);
698 extern void mac_packet_print(mac_handle_t, mblk_t *);
699 extern void mac_rx_deliver(void *, mac_resource_handle_t, mblk_t *,
700     mac_header_info_t *);
701 extern void mac_tx_notify(mac_impl_t *);
702 extern mblk_t *mac_ring_tx(mac_handle_t, mac_ring_handle_t, mblk_t *);
703 extern mblk_t *mac_provider_tx(mac_impl_t *, mac_ring_handle_t, mblk_t *,
704     mac_client_impl_t *);
705 
706 extern void mac_callback_add(mac_cb_info_t *, mac_cb_t **, mac_cb_t *);
707 extern boolean_t mac_callback_remove(mac_cb_info_t *, mac_cb_t **, mac_cb_t *);
708 extern void mac_callback_remove_wait(mac_cb_info_t *);
709 extern void mac_callback_barrier(mac_cb_info_t *);
710 extern void mac_callback_free(mac_cb_t *);
711 extern void mac_callback_walker_enter(mac_cb_info_t *);
712 extern void mac_callback_walker_exit(mac_cb_info_t *, mac_cb_t **, boolean_t);
713 
714 /* in mac_bcast.c */
715 extern void mac_bcast_init(void);
716 extern void mac_bcast_fini(void);
717 extern mac_impl_t *mac_bcast_grp_mip(void *);
718 extern int mac_bcast_add(mac_client_impl_t *, const uint8_t *, uint16_t,
719     mac_addrtype_t);
720 extern void mac_bcast_delete(mac_client_impl_t *, const uint8_t *, uint16_t);
721 extern void mac_bcast_send(void *, void *, mblk_t *, boolean_t);
722 extern void mac_bcast_grp_free(void *);
723 extern void mac_bcast_refresh(mac_impl_t *, mac_multicst_t, void *,
724     boolean_t);
725 extern void mac_client_bcast_refresh(mac_client_impl_t *, mac_multicst_t,
726     void *, boolean_t);
727 
728 /*
729  * Grouping functions are used internally by MAC layer.
730  */
731 extern int mac_group_addmac(mac_group_t *, const uint8_t *);
732 extern int mac_group_remmac(mac_group_t *, const uint8_t *);
733 extern int mac_group_addvlan(mac_group_t *, uint16_t);
734 extern int mac_group_remvlan(mac_group_t *, uint16_t);
735 extern int mac_rx_group_add_flow(mac_client_impl_t *, flow_entry_t *,
736     mac_group_t *);
737 extern mblk_t *mac_hwring_tx(mac_ring_handle_t, mblk_t *);
738 extern mblk_t *mac_bridge_tx(mac_impl_t *, mac_ring_handle_t, mblk_t *);
739 extern mac_group_t *mac_reserve_rx_group(mac_client_impl_t *, uint8_t *,
740     boolean_t);
741 extern void mac_release_rx_group(mac_client_impl_t *, mac_group_t *);
742 extern int mac_rx_switch_group(mac_client_impl_t *, mac_group_t *,
743     mac_group_t *);
744 extern mac_ring_t *mac_reserve_tx_ring(mac_impl_t *, mac_ring_t *);
745 extern mac_group_t *mac_reserve_tx_group(mac_client_impl_t *, boolean_t);
746 extern void mac_release_tx_group(mac_client_impl_t *, mac_group_t *);
747 extern void mac_tx_switch_group(mac_client_impl_t *, mac_group_t *,
748     mac_group_t *);
749 extern void mac_rx_switch_grp_to_sw(mac_group_t *);
750 
751 /*
752  * MAC address functions are used internally by MAC layer.
753  */
754 extern mac_address_t *mac_find_macaddr(mac_impl_t *, uint8_t *);
755 extern mac_address_t *mac_find_macaddr_vlan(mac_impl_t *, uint8_t *, uint16_t);
756 extern boolean_t mac_check_macaddr_shared(mac_address_t *);
757 extern int mac_update_macaddr(mac_address_t *, uint8_t *);
758 extern void mac_freshen_macaddr(mac_address_t *, uint8_t *);
759 extern void mac_retrieve_macaddr(mac_address_t *, uint8_t *);
760 extern void mac_init_macaddr(mac_impl_t *);
761 extern void mac_fini_macaddr(mac_impl_t *);
762 
763 /*
764  * Flow construction/destruction routines.
765  * Not meant to be used by mac clients.
766  */
767 extern int mac_link_flow_init(mac_client_handle_t, flow_entry_t *);
768 extern void mac_link_flow_clean(mac_client_handle_t, flow_entry_t *);
769 
770 /*
771  * Fanout update routines called when the link speed of the NIC changes
772  * or when a MAC client's share is unbound.
773  */
774 extern void mac_fanout_recompute_client(mac_client_impl_t *, cpupart_t *);
775 extern void mac_fanout_recompute(mac_impl_t *);
776 
777 /*
778  * The following functions are used internally by the MAC layer to
779  * add/remove/update flows associated with a mac_impl_t. They should
780  * never be used directly by MAC clients.
781  */
782 extern int mac_datapath_setup(mac_client_impl_t *, flow_entry_t *, uint32_t);
783 extern void mac_datapath_teardown(mac_client_impl_t *, flow_entry_t *,
784     uint32_t);
785 extern void mac_rx_srs_group_setup(mac_client_impl_t *, flow_entry_t *,
786     uint32_t);
787 extern void mac_tx_srs_group_setup(mac_client_impl_t *, flow_entry_t *,
788     uint32_t);
789 extern void mac_rx_srs_group_teardown(flow_entry_t *, boolean_t);
790 extern void mac_tx_srs_group_teardown(mac_client_impl_t *, flow_entry_t *,
791 	    uint32_t);
792 extern int mac_rx_classify_flow_quiesce(flow_entry_t *, void *);
793 extern int mac_rx_classify_flow_restart(flow_entry_t *, void *);
794 extern void mac_client_quiesce(mac_client_impl_t *);
795 extern void mac_client_restart(mac_client_impl_t *);
796 
797 extern void mac_flow_update_priority(mac_client_impl_t *, flow_entry_t *);
798 
799 extern void mac_flow_rem_subflow(flow_entry_t *);
800 extern void mac_rename_flow(flow_entry_t *, const char *);
801 extern void mac_flow_set_name(flow_entry_t *, const char *);
802 
803 extern mblk_t *mac_add_vlan_tag(mblk_t *, uint_t, uint16_t);
804 extern mblk_t *mac_add_vlan_tag_chain(mblk_t *, uint_t, uint16_t);
805 extern mblk_t *mac_strip_vlan_tag_chain(mblk_t *);
806 extern void mac_rx_def(void *, mac_resource_handle_t, mblk_t *, boolean_t);
807 extern mblk_t *mac_rx_flow(mac_handle_t, mac_resource_handle_t, mblk_t *);
808 
809 extern void i_mac_share_alloc(mac_client_impl_t *);
810 extern void i_mac_share_free(mac_client_impl_t *);
811 extern void i_mac_perim_enter(mac_impl_t *);
812 extern void i_mac_perim_exit(mac_impl_t *);
813 extern int i_mac_perim_enter_nowait(mac_impl_t *);
814 extern void i_mac_tx_srs_notify(mac_impl_t *, mac_ring_handle_t);
815 extern int mac_hold(const char *, mac_impl_t **);
816 extern void mac_rele(mac_impl_t *);
817 extern int i_mac_disable(mac_impl_t *);
818 extern void i_mac_notify(mac_impl_t *, mac_notify_type_t);
819 extern void i_mac_notify_exit(mac_impl_t *);
820 extern void mac_rx_group_unmark(mac_group_t *, uint_t);
821 extern void mac_tx_client_flush(mac_client_impl_t *);
822 extern void mac_tx_client_block(mac_client_impl_t *);
823 extern void mac_tx_client_unblock(mac_client_impl_t *);
824 extern void mac_tx_invoke_callbacks(mac_client_impl_t *, mac_tx_cookie_t);
825 extern int i_mac_promisc_set(mac_impl_t *, boolean_t);
826 extern mactype_t *mactype_getplugin(const char *);
827 extern void mac_addr_factory_init(mac_impl_t *);
828 extern void mac_addr_factory_fini(mac_impl_t *);
829 extern void mac_register_priv_prop(mac_impl_t *, char **);
830 extern void mac_unregister_priv_prop(mac_impl_t *);
831 extern int mac_init_rings(mac_impl_t *, mac_ring_type_t);
832 extern void mac_free_rings(mac_impl_t *, mac_ring_type_t);
833 extern void mac_compare_ddi_handle(mac_group_t *, uint_t, mac_ring_t *);
834 
835 extern int mac_start_group(mac_group_t *);
836 extern void mac_stop_group(mac_group_t *);
837 extern int mac_start_ring(mac_ring_t *);
838 extern void mac_stop_ring(mac_ring_t *);
839 extern int mac_add_macaddr_vlan(mac_impl_t *, mac_group_t *, uint8_t *,
840     uint16_t, boolean_t);
841 extern int mac_remove_macaddr_vlan(mac_address_t *, uint16_t);
842 
843 extern void mac_set_group_state(mac_group_t *, mac_group_state_t);
844 extern void mac_group_add_client(mac_group_t *, mac_client_impl_t *);
845 extern void mac_group_remove_client(mac_group_t *, mac_client_impl_t *);
846 
847 extern int i_mac_group_add_ring(mac_group_t *, mac_ring_t *, int);
848 extern void i_mac_group_rem_ring(mac_group_t *, mac_ring_t *, boolean_t);
849 extern int mac_group_ring_modify(mac_client_impl_t *, mac_group_t *,
850     mac_group_t *);
851 extern void mac_poll_state_change(mac_handle_t, boolean_t);
852 
853 extern mac_group_state_t mac_group_next_state(mac_group_t *,
854     mac_client_impl_t **, mac_group_t *, boolean_t);
855 
856 extern mblk_t *mac_protect_check(mac_client_handle_t, mblk_t *);
857 extern int mac_protect_set(mac_client_handle_t, mac_resource_props_t *);
858 extern boolean_t mac_protect_enabled(mac_client_handle_t, uint32_t);
859 extern int mac_protect_validate(mac_resource_props_t *);
860 extern void mac_protect_update(mac_resource_props_t *, mac_resource_props_t *);
861 extern void mac_protect_update_mac_token(mac_client_impl_t *);
862 extern void mac_protect_intercept_dynamic(mac_client_impl_t *, mblk_t *);
863 extern void mac_protect_flush_dynamic(mac_client_impl_t *);
864 extern void mac_protect_cancel_timer(mac_client_impl_t *);
865 extern void mac_protect_init(mac_client_impl_t *);
866 extern void mac_protect_fini(mac_client_impl_t *);
867 
868 extern int mac_set_resources(mac_handle_t, mac_resource_props_t *);
869 extern void mac_get_resources(mac_handle_t, mac_resource_props_t *);
870 extern void mac_get_effective_resources(mac_handle_t, mac_resource_props_t *);
871 extern void mac_set_promisc_filtered(mac_client_handle_t, boolean_t);
872 extern boolean_t mac_get_promisc_filtered(mac_client_handle_t);
873 
874 extern cpupart_t *mac_pset_find(mac_resource_props_t *, boolean_t *);
875 extern void mac_set_pool_effective(boolean_t, cpupart_t *,
876     mac_resource_props_t *, mac_resource_props_t *);
877 extern void mac_set_rings_effective(mac_client_impl_t *);
878 extern mac_client_impl_t *mac_check_primary_relocation(mac_client_impl_t *,
879     boolean_t);
880 
881 /* Global callbacks into the bridging module (when loaded) */
882 extern mac_bridge_tx_t mac_bridge_tx_cb;
883 extern mac_bridge_rx_t mac_bridge_rx_cb;
884 extern mac_bridge_ref_t mac_bridge_ref_cb;
885 extern mac_bridge_ls_t mac_bridge_ls_cb;
886 
887 /*
888  * MAC Transceiver related functions
889  */
890 struct mac_transceiver_info {
891 	boolean_t		mti_present;
892 	boolean_t		mti_usable;
893 };
894 
895 extern void mac_transceiver_init(mac_impl_t *);
896 extern int mac_transceiver_count(mac_handle_t, uint_t *);
897 extern int mac_transceiver_info(mac_handle_t, uint_t, boolean_t *, boolean_t *);
898 extern int mac_transceiver_read(mac_handle_t, uint_t, uint_t, void *, size_t,
899     off_t, size_t *);
900 
901 /*
902  * MAC LED related functions
903  */
904 #define	MAC_LED_ALL	(MAC_LED_DEFAULT | MAC_LED_OFF | MAC_LED_IDENT | \
905 			    MAC_LED_ON)
906 extern void mac_led_init(mac_impl_t *);
907 extern int mac_led_get(mac_handle_t, mac_led_mode_t *, mac_led_mode_t *);
908 extern int mac_led_set(mac_handle_t, mac_led_mode_t);
909 
910 #ifdef	__cplusplus
911 }
912 #endif
913 
914 #endif	/* _SYS_MAC_IMPL_H */
915