xref: /titanic_41/usr/src/uts/common/sys/mac_soft_ring.h (revision b1352070d318187b41b088da3533692976f3f225)
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 /*
23  * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_SYS_MAC_SOFT_RING_H
28 #define	_SYS_MAC_SOFT_RING_H
29 
30 #ifdef	__cplusplus
31 extern "C" {
32 #endif
33 
34 #include <sys/types.h>
35 #include <sys/cpuvar.h>
36 #include <sys/processor.h>
37 #include <sys/stream.h>
38 #include <sys/squeue.h>
39 #include <sys/dlpi.h>
40 #include <sys/mac_impl.h>
41 
42 #define	S_RING_NAMELEN 64
43 
44 #define	MAX_SR_FANOUT	32
45 
46 extern boolean_t mac_soft_ring_enable;
47 extern boolean_t mac_latency_optimize;
48 
49 typedef struct mac_soft_ring_s mac_soft_ring_t;
50 typedef struct mac_soft_ring_set_s mac_soft_ring_set_t;
51 
52 typedef void (*mac_soft_ring_drain_func_t)(mac_soft_ring_t *);
53 typedef mac_tx_cookie_t (*mac_tx_func_t)(mac_soft_ring_set_t *, mblk_t *,
54     uintptr_t, uint16_t, mblk_t **);
55 
56 
57 /* Tx notify callback */
58 typedef struct mac_tx_notify_cb_s {
59 	mac_cb_t		mtnf_link;	/* Linked list of callbacks */
60 	mac_tx_notify_t		mtnf_fn;	/* The callback function */
61 	void			*mtnf_arg;	/* Callback function argument */
62 } mac_tx_notify_cb_t;
63 
64 struct mac_soft_ring_s {
65 	/* Keep the most used members 64bytes cache aligned */
66 	kmutex_t	s_ring_lock;	/* lock before using any member */
67 	uint16_t	s_ring_type;	/* processing model of the sq */
68 	uint16_t	s_ring_state;	/* state flags and message count */
69 	int		s_ring_count;	/* # of mblocks in mac_soft_ring */
70 	size_t		s_ring_size;	/* Size of data queued */
71 	mblk_t		*s_ring_first;	/* first mblk chain or NULL */
72 	mblk_t		*s_ring_last;	/* last mblk chain or NULL */
73 
74 	mac_direct_rx_t	s_ring_rx_func;
75 	void		*s_ring_rx_arg1;
76 	mac_resource_handle_t  s_ring_rx_arg2;
77 
78 	/*
79 	 * Threshold after which packets get dropped.
80 	 * Is always greater than s_ring_tx_hiwat
81 	 */
82 	int		s_ring_tx_max_q_cnt;
83 	/* # of mblocks after which to apply flow control */
84 	int		s_ring_tx_hiwat;
85 	/* # of mblocks after which to relieve flow control */
86 	int		s_ring_tx_lowat;
87 	boolean_t	s_ring_tx_woken_up;
88 	uint32_t	s_ring_blocked_cnt;	/* times blocked for Tx descs */
89 	uint32_t	s_ring_unblocked_cnt;	/* unblock calls from driver */
90 	uint32_t	s_ring_hiwat_cnt;	/* times blocked for Tx descs */
91 
92 	void		*s_ring_tx_arg1;
93 	void		*s_ring_tx_arg2;
94 
95 	/* Tx notify callback */
96 	mac_cb_info_t	s_ring_notify_cb_info;		/* cb list info */
97 	mac_cb_t	*s_ring_notify_cb_list;		/* The cb list */
98 
99 	clock_t		s_ring_awaken;	/* time async thread was awakened */
100 
101 	kthread_t	*s_ring_run;	/* Current thread processing sq */
102 	processorid_t	s_ring_cpuid;	/* processor to bind to */
103 	processorid_t	s_ring_cpuid_save;	/* saved cpuid during offline */
104 	kcondvar_t	s_ring_async;	/* async thread blocks on */
105 	clock_t		s_ring_wait;	/* lbolts to wait after a fill() */
106 	timeout_id_t	s_ring_tid;	/* timer id of pending timeout() */
107 	kthread_t	*s_ring_worker;	/* kernel thread id */
108 	char		s_ring_name[S_RING_NAMELEN + 1];
109 	uint32_t	s_ring_total_inpkt;
110 	uint32_t	s_ring_drops;
111 	struct mac_client_impl_s *s_ring_mcip;
112 	void		*s_ring_flent;
113 	kstat_t		*s_ring_ksp;
114 
115 	/* Teardown, poll disable control ops */
116 	kcondvar_t	s_ring_client_cv; /* Client wait for control op */
117 
118 	mac_soft_ring_set_t *s_ring_set;   /* The SRS this ring belongs to */
119 	mac_soft_ring_t	*s_ring_next;
120 	mac_soft_ring_t	*s_ring_prev;
121 	mac_soft_ring_drain_func_t s_ring_drain_func;
122 };
123 
124 typedef void (*mac_srs_drain_proc_t)(mac_soft_ring_set_t *, uint_t);
125 
126 /* Transmit side Soft Ring Set */
127 typedef struct mac_srs_tx_s {
128 	/* Members for Tx size processing */
129 	uint32_t	st_mode;
130 	mac_tx_func_t	st_func;
131 	void		*st_arg1;
132 	void		*st_arg2;
133 	mac_group_t	*st_group;	/* TX group for share */
134 	boolean_t	st_woken_up;
135 
136 	/*
137 	 * st_max_q_cnt is the queue depth threshold to limit
138 	 * outstanding packets on the Tx SRS. Once the limit
139 	 * is reached, Tx SRS will drop packets until the
140 	 * limit goes below the threshold.
141 	 */
142 	uint32_t	st_max_q_cnt;	/* max. outstanding packets */
143 	/*
144 	 * st_hiwat is used Tx serializer and bandwidth mode.
145 	 * This is the queue depth threshold upto which
146 	 * packets will get buffered with no flow-control
147 	 * back pressure applied to the caller. Once this
148 	 * threshold is reached, back pressure will be
149 	 * applied to the caller of mac_tx() (mac_tx() starts
150 	 * returning a cookie to indicate a blocked SRS).
151 	 * st_hiwat should always be lesser than or equal to
152 	 * st_max_q_cnt.
153 	 */
154 	uint32_t	st_hiwat;	/* mblk cnt to apply flow control */
155 	uint32_t	st_lowat;	/* mblk cnt to relieve flow control */
156 	uint32_t	st_drop_count;
157 	/*
158 	 * Number of times the srs gets blocked due to lack of Tx
159 	 * desc is noted down. Corresponding wakeup from driver
160 	 * to unblock is also noted down. They should match in a
161 	 * correctly working setup. If there is less unblocks
162 	 * than blocks, then Tx side waits forever for a wakeup
163 	 * from below. The following protected by srs_lock.
164 	 */
165 	uint32_t	st_blocked_cnt; /* times blocked for Tx descs */
166 	uint32_t	st_unblocked_cnt; /* unblock calls from driver */
167 	uint32_t	st_hiwat_cnt; /* times blocked for Tx descs */
168 } mac_srs_tx_t;
169 
170 /* Receive side Soft Ring Set */
171 typedef struct mac_srs_rx_s {
172 	/*
173 	 * Upcall Function for fanout, Rx processing etc. Perhaps
174 	 * the same 3 members below can be used for Tx
175 	 * processing, but looking around, mac_rx_func_t has
176 	 * proliferated too much into various files at different
177 	 * places. I am leaving the consolidation battle for
178 	 * another day.
179 	 */
180 	mac_direct_rx_t		sr_func;	/* srs_lock */
181 	void			*sr_arg1;	/* srs_lock */
182 	mac_resource_handle_t 	sr_arg2;	/* srs_lock */
183 	mac_rx_func_t		sr_lower_proc;	/* Atomically changed */
184 	uint32_t		sr_poll_pkt_cnt;
185 	uint32_t		sr_poll_thres;
186 
187 	/* mblk cnt to apply flow control */
188 	uint32_t		sr_hiwat;
189 	/* mblk cnt to relieve flow control */
190 	uint32_t		sr_lowat;
191 	uint32_t		sr_poll_count;
192 	uint32_t		sr_intr_count;
193 	uint32_t		sr_drop_count;
194 
195 	/* Times polling was enabled */
196 	uint32_t		sr_poll_on;
197 	/* Times polling was enabled by worker thread */
198 	uint32_t		sr_worker_poll_on;
199 	/* Times polling was disabled */
200 	uint32_t		sr_poll_off;
201 	/* Poll thread signalled count */
202 	uint32_t		sr_poll_thr_sig;
203 	/* Poll thread busy */
204 	uint32_t		sr_poll_thr_busy;
205 	/* SRS drains, stays in poll mode but doesn't poll */
206 	uint32_t		sr_poll_drain_no_poll;
207 	/*
208 	 * SRS has nothing to do and no packets in H/W but
209 	 * there is a backlog in softrings. SRS stays in
210 	 * poll mode but doesn't do polling.
211 	 */
212 	uint32_t		sr_poll_no_poll;
213 	/* Active polling restarted */
214 	uint32_t		sr_below_hiwat;
215 	/* Found packets in last poll so try and poll again */
216 	uint32_t		sr_poll_again;
217 	/*
218 	 * Packets in queue but poll thread not allowed to process so
219 	 * signal the worker thread.
220 	 */
221 	uint32_t		sr_poll_sig_worker;
222 	/*
223 	 * Poll thread has nothing to do and H/W has nothing so
224 	 * reenable the interrupts.
225 	 */
226 	uint32_t		sr_poll_intr_enable;
227 	/*
228 	 * Poll thread has nothing to do and worker thread was already
229 	 * running so it can decide to reenable interrupt or poll again.
230 	 */
231 	uint32_t		sr_poll_goto_sleep;
232 	/* Worker thread goes back to draining the queue */
233 	uint32_t		sr_drain_again;
234 	/* More Packets in queue so signal the poll thread to drain */
235 	uint32_t		sr_drain_poll_sig;
236 	/* More Packets in queue so signal the worker thread to drain */
237 	uint32_t		sr_drain_worker_sig;
238 	/* Poll thread is already running so worker has nothing to do */
239 	uint32_t		sr_drain_poll_running;
240 	/* We have packets already queued so keep polling */
241 	uint32_t		sr_drain_keep_polling;
242 	/* Drain is done and interrupts are reenabled */
243 	uint32_t		sr_drain_finish_intr;
244 	/* Polling thread needs to schedule worker wakeup */
245 	uint32_t		sr_poll_worker_wakeup;
246 
247 	/* Chains less than 10 pkts */
248 	uint32_t		sr_chain_cnt_undr10;
249 	/* Chains between 10 & 50 pkts */
250 	uint32_t		sr_chain_cnt_10to50;
251 	/* Chains over 50 pkts */
252 	uint32_t		sr_chain_cnt_over50;
253 } mac_srs_rx_t;
254 
255 /*
256  * mac_soft_ring_set_s:
257  * This is used both for Tx and Rx side. The srs_type identifies Rx or
258  * Tx type.
259  *
260  * Note that the structure is carefully crafted, with Rx elements coming
261  * first followed by Tx specific members. Future additions to this
262  * structure should follow the same guidelines.
263  *
264  * Rx-side notes:
265  * mac_rx_classify_flow_add() always creates a mac_soft_ring_set_t and fn_flow
266  * points to info from it (func = srs_lower_proc, arg = soft_ring_set). On
267  * interrupt path, srs_lower_proc does B/W adjustment and switch to polling mode
268  * (if poll capable) and feeds the packets to soft_ring_list via choosen
269  * fanout type (specified by srs_type). In poll mode, the poll thread which is
270  * also a pointer can pick up the packets and feed them to various
271  * soft_ring_list.
272  *
273  * The srs_type can either be protocol based or fanout based where fanout itelf
274  * can be various types
275  *
276  * The polling works by turning off interrupts as soon as a packets
277  * are queued on the soft ring set. Once the backlog is clear and poll
278  * thread return empty handed i.e. Rx ring doesn't have anything, the
279  * interrupt is turned back on. For this purpose we keep a separate
280  * srs_poll_pkt_cnt counter which tracks the packets queued between SRS
281  * and the soft rings as well. The counter is incremented when packets
282  * are queued and decremented when SRS processes them (in case it has
283  * no soft rings) or the soft ring process them. Its important that
284  * in case SRS has softrings, the decrement doesn't happen till the
285  * packet is processed by the soft rings since it takes very little time
286  * for SRS to queue packet from SRS to soft rings and it will keep
287  * bringing more packets in the system faster than soft rings can
288  * process them.
289  *
290  * Tx side notes:
291  * The srs structure acts as a serializer with a worker thread. The
292  * default behavior of srs though is to act as a pass-thru. The queues
293  * (srs_first, srs_last, srs_count) get used when Tx ring runs out of Tx
294  * descriptors or to enforce bandwidth limits.
295  *
296  * When multiple Tx rings are present, the SRS state will be set to
297  * SRS_FANOUT_OTH. Outgoing packets coming into mac_tx_srs_process()
298  * function will be fanned out to one of the Tx side soft rings based on
299  * a hint passed in mac_tx_srs_process(). Each soft ring, in turn, will
300  * be associated with a distinct h/w Tx ring.
301  */
302 
303 struct mac_soft_ring_set_s {
304 	/*
305 	 * Common elements, common to both Rx and Tx SRS type.
306 	 * The following block of fields are protected by srs_lock
307 	 */
308 	kmutex_t	srs_lock;
309 	uint32_t	srs_type;
310 	uint32_t	srs_state;	/* state flags */
311 	uint32_t	srs_count;
312 	mblk_t		*srs_first;	/* first mblk chain or NULL */
313 	mblk_t		*srs_last;	/* last mblk chain or NULL */
314 	kcondvar_t	srs_async;	/* cv for worker thread */
315 	kcondvar_t	srs_cv;		/* cv for poll thread */
316 	kcondvar_t	srs_quiesce_done_cv;	/* cv for removal */
317 	timeout_id_t	srs_tid;	/* timeout id for pending timeout */
318 
319 	/*
320 	 * List of soft rings & processing function.
321 	 * The following block is protected by Rx quiescence.
322 	 * i.e. they can be changed only after quiescing the SRS
323 	 * Protected by srs_lock.
324 	 */
325 	mac_soft_ring_t	*srs_soft_ring_head;
326 	mac_soft_ring_t	*srs_soft_ring_tail;
327 	int		srs_soft_ring_count;
328 	int		srs_soft_ring_quiesced_count;
329 	int		srs_soft_ring_condemned_count;
330 	mac_soft_ring_t	**srs_tcp_soft_rings;
331 	int		srs_tcp_ring_count;
332 	mac_soft_ring_t	**srs_udp_soft_rings;
333 	int		srs_udp_ring_count;
334 	/*
335 	 * srs_oth_soft_rings is also used by tx_srs in
336 	 * when operating in multi tx ring mode.
337 	 */
338 	mac_soft_ring_t	**srs_oth_soft_rings;
339 	int		srs_oth_ring_count;
340 
341 	/*
342 	 * Bandwidth control related members.
343 	 * They are common to both Rx- and Tx-side.
344 	 * Following protected by srs_lock
345 	 */
346 	mac_bw_ctl_t	*srs_bw;
347 	size_t		srs_size;	/* Size of packets queued in bytes */
348 	pri_t		srs_pri;
349 
350 	mac_soft_ring_set_t	*srs_next;	/* mac_srs_g_lock */
351 	mac_soft_ring_set_t	*srs_prev;	/* mac_srs_g_lock */
352 
353 	/* Attribute specific drain func (BW ctl vs non-BW ctl)	*/
354 	mac_srs_drain_proc_t	srs_drain_func;	/* Write once (WO) */
355 
356 	/*
357 	 * If the associated ring is exclusively used by a mac client, e.g.,
358 	 * an aggregation, this fields is used to keep a reference to the
359 	 * MAC client's pseudo ring.
360 	 */
361 	mac_resource_handle_t	srs_mrh;
362 	/*
363 	 * The following blocks are write once (WO) and valid for the life
364 	 * of the SRS
365 	 */
366 	struct mac_client_impl_s *srs_mcip;	/* back ptr to mac client */
367 	void			*srs_flent;	/* back ptr to flent */
368 	mac_ring_t		*srs_ring;	/*  Ring Descriptor */
369 
370 	/* Teardown, disable control ops */
371 	kcondvar_t	srs_client_cv;	/* Client wait for the control op */
372 
373 	kthread_t	*srs_worker;	/* WO, worker thread */
374 	kthread_t	*srs_poll_thr;	/* WO, poll thread */
375 
376 	uint_t		srs_ind;	/* Round Robin indx for picking up SR */
377 	processorid_t	srs_worker_cpuid;	/* processor to bind to */
378 	processorid_t	srs_worker_cpuid_save;	/* saved cpuid during offline */
379 	processorid_t	srs_poll_cpuid;		/* processor to bind to */
380 	processorid_t	srs_poll_cpuid_save;	/* saved cpuid during offline */
381 	uint_t		srs_fanout_state;
382 	mac_cpus_t	srs_cpu;
383 
384 	mac_srs_rx_t	srs_rx;
385 	mac_srs_tx_t	srs_tx;
386 };
387 
388 /*
389  * type flags - combination allowed to process and drain the queue
390  */
391 #define	ST_RING_WORKER_ONLY  	0x0001	/* Worker thread only */
392 #define	ST_RING_ANY		0x0002	/* Any thread can process the queue */
393 #define	ST_RING_TCP		0x0004
394 #define	ST_RING_UDP		0x0008
395 #define	ST_RING_OTH		0x0010
396 
397 #define	ST_RING_BW_CTL		0x0020
398 #define	ST_RING_TX		0x0040
399 
400 /*
401  * State flags.
402  */
403 #define	S_RING_PROC		0x0001	/* being processed */
404 #define	S_RING_BOUND		0x0002	/* Worker thread is bound to a cpu */
405 #define	S_RING_BLOCK		0x0004	/* No Tx descs */
406 #define	S_RING_TX_HIWAT		0x0008	/* Tx high watermark reached */
407 
408 #define	S_RING_WAKEUP_CLIENT	0x0010	/* flow ctrl, client wakeup needed */
409 #define	S_RING_BLANK		0x0020	/* Has been put into polling mode */
410 #define	S_RING_CLIENT_WAIT	0x0040	/* Client waiting for control op */
411 
412 #define	S_RING_CONDEMNED	0x0100	/* Being torn down */
413 #define	S_RING_CONDEMNED_DONE	0x0200	/* Being torn down */
414 #define	S_RING_QUIESCE		0x0400	/* No traffic flow, transient flag */
415 #define	S_RING_QUIESCE_DONE	0x0800	/* No traffic flow, transient flag */
416 
417 #define	S_RING_RESTART		0x1000	/* Go back to normal traffic flow */
418 #define	S_RING_ENQUEUED		0x2000	/* Pkts enqueued in Tx soft ring */
419 
420 /*
421  * arguments for processors to bind to
422  */
423 #define	S_RING_BIND_NONE	-1
424 
425 /*
426  * defines for srs_type - identifies a link or a sub-flow
427  * and other static characteristics of a SRS like a tx
428  * srs, tcp only srs, etc.
429  */
430 #define	SRST_LINK		0x00000001
431 #define	SRST_FLOW		0x00000002
432 #define	SRST_NO_SOFT_RINGS	0x00000004
433 #define	SRST_TCP_ONLY		0x00000008
434 
435 #define	SRST_FANOUT_PROTO	0x00000010
436 #define	SRST_FANOUT_SRC_IP	0x00000020
437 #define	SRST_FANOUT_OTH		0x00000040
438 #define	SRST_DEFAULT_GRP	0x00000080
439 
440 #define	SRST_TX			0x00000100
441 #define	SRST_BW_CONTROL		0x00000200
442 #define	SRST_DIRECT_POLL	0x00000400
443 
444 #define	SRST_DLS_BYPASS		0x00001000
445 #define	SRST_CLIENT_POLL_ENABLED 0x00002000
446 
447 /*
448  * soft ring set flags. These bits are dynamic in nature and get
449  * applied to srs_state. They reflect the state of SRS at any
450  * point of time
451  */
452 #define	SRS_BLANK		0x00000001
453 #define	SRS_WORKER_BOUND	0x00000002
454 #define	SRS_POLL_BOUND		0x00000004
455 #define	SRS_POLLING_CAPAB	0x00000008
456 
457 #define	SRS_PROC		0x00000010
458 #define	SRS_GET_PKTS		0x00000020
459 #define	SRS_POLLING		0x00000040
460 #define	SRS_BW_ENFORCED		0x00000080
461 
462 #define	SRS_WORKER		0x00000100
463 #define	SRS_ENQUEUED		0x00000200
464 #define	SRS_ANY_PROCESS		0x00000400
465 #define	SRS_PROC_FAST		0x00000800
466 
467 #define	SRS_POLL_PROC		0x00001000
468 #define	SRS_TX_BLOCKED		0x00002000	/* out of Tx descs */
469 #define	SRS_TX_HIWAT		0x00004000	/* Tx count exceeds hiwat */
470 #define	SRS_TX_WAKEUP_CLIENT	0x00008000	/* Flow-ctl: wakeup client */
471 
472 #define	SRS_CLIENT_PROC		0x00010000
473 #define	SRS_CLIENT_WAIT		0x00020000
474 #define	SRS_QUIESCE		0x00040000
475 #define	SRS_QUIESCE_DONE	0x00080000
476 
477 #define	SRS_CONDEMNED		0x00100000
478 #define	SRS_CONDEMNED_DONE	0x00200000
479 #define	SRS_POLL_THR_QUIESCED	0x00400000
480 #define	SRS_RESTART		0x00800000
481 
482 #define	SRS_RESTART_DONE	0x01000000
483 #define	SRS_POLL_THR_RESTART	0x02000000
484 #define	SRS_IN_GLIST		0x04000000
485 #define	SRS_POLL_THR_EXITED	0x08000000
486 
487 #define	SRS_QUIESCE_PERM	0x10000000
488 #define	SRS_LATENCY_OPT		0x20000000
489 #define	SRS_SOFTRING_QUEUE	0x40000000
490 
491 #define	SRS_QUIESCED(srs)	(srs->srs_state & SRS_QUIESCE_DONE)
492 
493 /*
494  * If the SRS_QUIESCE_PERM flag is set, the SRS worker thread will not be
495  * able to be restarted.
496  */
497 #define	SRS_QUIESCED_PERMANENT(srs)	(srs->srs_state & SRS_QUIESCE_PERM)
498 
499 /*
500  * soft ring set (SRS) Tx modes
501  */
502 typedef enum {
503 	SRS_TX_DEFAULT = 0,
504 	SRS_TX_SERIALIZE,
505 	SRS_TX_FANOUT,
506 	SRS_TX_BW,
507 	SRS_TX_BW_FANOUT
508 } mac_tx_srs_mode_t;
509 
510 /*
511  * SRS fanout states
512  */
513 typedef enum {
514 	SRS_FANOUT_UNINIT = 0,
515 	SRS_FANOUT_INIT,
516 	SRS_FANOUT_REINIT
517 } mac_srs_fanout_state_t;
518 
519 /*
520  * Structure for dls statistics
521  */
522 struct dls_kstats {
523 	kstat_named_t	dlss_soft_ring_pkt_drop;
524 };
525 
526 extern struct dls_kstats dls_kstat;
527 
528 #define	DLS_BUMP_STAT(x, y)	(dls_kstat.x.value.ui32 += y)
529 
530 /* Turn dynamic polling off */
531 #define	MAC_SRS_POLLING_OFF(mac_srs) {					\
532 	ASSERT(MUTEX_HELD(&(mac_srs)->srs_lock));			\
533 	if (((mac_srs)->srs_state & (SRS_POLLING_CAPAB|SRS_POLLING)) == \
534 	    (SRS_POLLING_CAPAB|SRS_POLLING)) {				\
535 		(mac_srs)->srs_state &= ~SRS_POLLING;			\
536 		(void) mac_hwring_enable_intr((mac_ring_handle_t)	\
537 		    (mac_srs)->srs_ring);				\
538 		(mac_srs)->srs_rx.sr_poll_off++;			\
539 	}								\
540 }
541 
542 #define	MAC_COUNT_CHAIN(mac_srs, head, tail, cnt, sz)	{	\
543 	mblk_t 		*tmp;		       			\
544 	boolean_t	bw_ctl = B_FALSE;			\
545 								\
546 	ASSERT((head) != NULL);					\
547 	cnt = 0;						\
548 	sz = 0;							\
549 	if ((mac_srs)->srs_type & SRST_BW_CONTROL)		\
550 		bw_ctl = B_TRUE;				\
551 	tmp = tail = (head);					\
552 	if ((head)->b_next == NULL) {				\
553 		cnt = 1;					\
554 		if (bw_ctl)					\
555 			sz += msgdsize(head);			\
556 	} else {						\
557 		while (tmp != NULL) {				\
558 			tail = tmp;				\
559 			cnt++;					\
560 			if (bw_ctl)				\
561 				sz += msgdsize(tmp);		\
562 			tmp = tmp->b_next;			\
563 		}						\
564 	}							\
565 }
566 
567 /*
568  * Decrement the cumulative packet count in SRS and its
569  * soft rings. If the srs_poll_pkt_cnt goes below lowat, then check
570  * if if the interface was left in a polling mode and no one
571  * is really processing the queue (to get the interface out
572  * of poll mode). If no one is processing the queue, then
573  * acquire the PROC and signal the poll thread to check the
574  * interface for packets and get the interface back to interrupt
575  * mode if nothing is found.
576  */
577 #define	MAC_UPDATE_SRS_COUNT_LOCKED(mac_srs, cnt) {		        \
578 	mac_srs_rx_t	*srs_rx = &(mac_srs)->srs_rx;			\
579 	ASSERT(MUTEX_HELD(&(mac_srs)->srs_lock));			\
580 									\
581 	srs_rx->sr_poll_pkt_cnt -= cnt;					\
582 	if ((srs_rx->sr_poll_pkt_cnt <= srs_rx->sr_poll_thres) && 	\
583 		(((mac_srs)->srs_state &				\
584 		(SRS_POLLING|SRS_PROC|SRS_GET_PKTS)) == SRS_POLLING))	\
585 	{								\
586 		(mac_srs)->srs_state |= (SRS_PROC|SRS_GET_PKTS);	\
587 		cv_signal(&(mac_srs)->srs_cv); 				\
588 		srs_rx->sr_below_hiwat++;				\
589 	}								\
590 }
591 
592 /*
593  * The following two macros are used to update the inbound packet and byte.
594  * count. The packet and byte count reflect the packets and bytes that are
595  * taken out of the SRS's queue, i.e. indicating they are being delivered.
596  * The srs_count and srs_size are updated in different locations as the
597  * srs_size is also used to take into account any bandwidth limits. The
598  * srs_size is updated only when a soft ring, if any, sends a packet up,
599  * as opposed to updating it when the SRS sends a packet to the SR, i.e.
600  * the srs_size reflects the packets in the SRS and SRs. These
601  * macros decrement the srs_size and srs_count and also increment the
602  * ipackets and ibytes stats resp.
603  *
604  * xxx-venu These are done under srs_lock, for now we still update
605  * mci_stat_ibytes/mci_stat_ipackets atomically, need to check if
606  * just updating them would be accurate enough.
607  *
608  * If we are updating these for a sub-flow SRS, then we need to also
609  * updated it's MAC client bandwidth info, if the MAC client is also
610  * bandwidth regulated.
611  */
612 #define	MAC_UPDATE_SRS_SIZE_LOCKED(srs, sz) {				\
613 	if ((srs)->srs_type & SRST_BW_CONTROL) {			\
614 		mutex_enter(&(srs)->srs_bw->mac_bw_lock);		\
615 		(srs)->srs_bw->mac_bw_sz -= (sz);			\
616 		(srs)->srs_bw->mac_bw_used += (sz);			\
617 		mutex_exit(&(srs)->srs_bw->mac_bw_lock);		\
618 	}								\
619 }
620 
621 #define	MAC_TX_UPDATE_BW_INFO(srs, sz) {				\
622 	(srs)->srs_bw->mac_bw_sz -= (sz);				\
623 	(srs)->srs_bw->mac_bw_used += (sz);				\
624 }
625 
626 #define	TX_MULTI_RING_MODE(mac_srs)				\
627 	((mac_srs)->srs_tx.st_mode == SRS_TX_FANOUT || 		\
628 	    (mac_srs)->srs_tx.st_mode == SRS_TX_BW_FANOUT)
629 
630 /* Soft ring flags for teardown */
631 #define	SRS_POLL_THR_OWNER	(SRS_PROC | SRS_POLLING | SRS_GET_PKTS)
632 #define	SRS_PAUSE		(SRS_CONDEMNED | SRS_QUIESCE)
633 #define	S_RING_PAUSE		(S_RING_CONDEMNED | S_RING_QUIESCE)
634 
635 /* Soft rings */
636 extern void mac_soft_ring_init(void);
637 extern void mac_soft_ring_finish(void);
638 extern void mac_fanout_setup(mac_client_impl_t *, flow_entry_t *,
639     mac_resource_props_t *, mac_direct_rx_t, void *, mac_resource_handle_t);
640 
641 extern void mac_soft_ring_worker_wakeup(mac_soft_ring_t *);
642 extern void mac_soft_ring_blank(void *, time_t, uint_t, int);
643 extern mblk_t *mac_soft_ring_poll(mac_soft_ring_t *, int);
644 extern void mac_soft_ring_destroy(mac_soft_ring_t *);
645 extern void mac_soft_ring_dls_bypass(void *, mac_direct_rx_t, void *);
646 
647 /* Rx SRS */
648 extern mac_soft_ring_set_t *mac_srs_create(struct mac_client_impl_s *,
649     flow_entry_t *, uint32_t, mac_direct_rx_t, void *, mac_resource_handle_t,
650     mac_ring_t *);
651 extern void mac_srs_free(mac_soft_ring_set_t *);
652 extern void mac_srs_signal(mac_soft_ring_set_t *, uint_t);
653 extern cpu_t *mac_srs_bind(mac_soft_ring_set_t *, processorid_t);
654 
655 extern void mac_srs_change_upcall(void *, mac_direct_rx_t, void *);
656 extern void mac_srs_quiesce_initiate(mac_soft_ring_set_t *);
657 extern void mac_srs_client_poll_enable(struct mac_client_impl_s *,
658     mac_soft_ring_set_t *);
659 extern void mac_srs_client_poll_disable(struct mac_client_impl_s *,
660     mac_soft_ring_set_t *);
661 extern void mac_srs_client_poll_quiesce(struct mac_client_impl_s *,
662     mac_soft_ring_set_t *);
663 extern void mac_srs_client_poll_restart(struct mac_client_impl_s *,
664     mac_soft_ring_set_t *);
665 extern void mac_rx_srs_quiesce(mac_soft_ring_set_t *, uint_t);
666 extern void mac_rx_srs_restart(mac_soft_ring_set_t *);
667 extern void mac_rx_srs_subflow_process(void *, mac_resource_handle_t, mblk_t *,
668     boolean_t);
669 extern void mac_tx_srs_quiesce(mac_soft_ring_set_t *, uint_t);
670 
671 /* Tx SRS, Tx softring */
672 extern void mac_tx_srs_wakeup(mac_soft_ring_set_t *, mac_ring_handle_t);
673 extern void mac_tx_srs_setup(struct mac_client_impl_s *,
674     flow_entry_t *, uint32_t);
675 extern mac_tx_func_t mac_tx_get_func(uint32_t);
676 extern mblk_t *mac_tx_send(mac_client_handle_t, mac_ring_handle_t, mblk_t *,
677     mac_tx_stats_t *);
678 extern boolean_t mac_tx_srs_ring_present(mac_soft_ring_set_t *, mac_ring_t *);
679 extern void mac_tx_srs_add_ring(mac_soft_ring_set_t *, mac_ring_t *);
680 extern void mac_tx_srs_del_ring(mac_soft_ring_set_t *, mac_ring_t *);
681 extern mac_tx_cookie_t mac_tx_srs_no_desc(mac_soft_ring_set_t *, mblk_t *,
682     uint16_t, mblk_t **);
683 
684 /* Subflow specific stuff */
685 extern int mac_srs_flow_create(struct mac_client_impl_s *, flow_entry_t *,
686     mac_resource_props_t *, int, int, mac_direct_rx_t);
687 extern void mac_srs_update_bwlimit(flow_entry_t *, mac_resource_props_t *);
688 extern void mac_srs_adjust_subflow_bwlimit(struct mac_client_impl_s *);
689 extern void mac_srs_update_drv(struct mac_client_impl_s *);
690 extern void mac_update_srs_priority(mac_soft_ring_set_t *, pri_t);
691 extern void mac_client_update_classifier(mac_client_impl_t *, boolean_t);
692 
693 extern void mac_soft_ring_intr_enable(void *);
694 extern boolean_t mac_soft_ring_intr_disable(void *);
695 extern mac_soft_ring_t *mac_soft_ring_create(int, clock_t, void *, uint16_t,
696     pri_t, mac_client_impl_t *, mac_soft_ring_set_t *,
697     processorid_t, mac_direct_rx_t, void *, mac_resource_handle_t);
698 extern cpu_t *mac_soft_ring_bind(mac_soft_ring_t *, processorid_t);
699 	extern void mac_soft_ring_unbind(mac_soft_ring_t *);
700 extern void mac_soft_ring_free(mac_soft_ring_t *, boolean_t);
701 extern void mac_soft_ring_signal(mac_soft_ring_t *, uint_t);
702 extern void mac_rx_soft_ring_process(mac_client_impl_t *, mac_soft_ring_t *,
703     mblk_t *, mblk_t *, int, size_t);
704 extern mac_tx_cookie_t mac_tx_soft_ring_process(mac_soft_ring_t *,
705     mblk_t *, uint16_t, mblk_t **);
706 extern void mac_srs_worker_quiesce(mac_soft_ring_set_t *);
707 extern void mac_srs_worker_restart(mac_soft_ring_set_t *);
708 extern void mac_rx_attach_flow_srs(mac_impl_t *, flow_entry_t *,
709     mac_soft_ring_set_t *, mac_ring_t *, mac_classify_type_t);
710 
711 extern void mac_rx_srs_drain_bw(mac_soft_ring_set_t *, uint_t);
712 extern void mac_rx_srs_drain(mac_soft_ring_set_t *, uint_t);
713 extern void mac_rx_srs_process(void *, mac_resource_handle_t, mblk_t *,
714     boolean_t);
715 extern void mac_srs_worker(mac_soft_ring_set_t *);
716 extern void mac_rx_srs_poll_ring(mac_soft_ring_set_t *);
717 extern void mac_tx_srs_drain(mac_soft_ring_set_t *, uint_t);
718 
719 extern void mac_tx_srs_restart(mac_soft_ring_set_t *);
720 extern void mac_rx_srs_remove(mac_soft_ring_set_t *);
721 
722 #ifdef	__cplusplus
723 }
724 #endif
725 
726 #endif	/* _SYS_MAC_SOFT_RING_H */
727