2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2001-2002 Luigi Rizzo
6 * Supported by: the Xorp Project (www.xorp.org)
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include "opt_device_polling.h"
35 #include <sys/param.h>
36 #include <sys/systm.h>
37 #include <sys/kernel.h>
38 #include <sys/kthread.h>
40 #include <sys/eventhandler.h>
41 #include <sys/resourcevar.h>
42 #include <sys/socket.h> /* needed by net/if.h */
43 #include <sys/sockio.h>
44 #include <sys/sysctl.h>
45 #include <sys/syslog.h>
48 #include <net/if_var.h>
49 #include <net/netisr.h> /* for NETISR_POLL */
52 void hardclock_device_poll(void); /* hook from hardclock */
54 static struct mtx poll_mtx;
57 * Polling support for [network] device drivers.
59 * Drivers which support this feature can register with the
62 * If registration is successful, the driver must disable interrupts,
63 * and further I/O is performed through the handler, which is invoked
64 * (at least once per clock tick) with 3 arguments: the "arg" passed at
65 * register time (a struct ifnet pointer), a command, and a "count" limit.
67 * The command can be one of the following:
68 * POLL_ONLY: quick move of "count" packets from input/output queues.
69 * POLL_AND_CHECK_STATUS: as above, plus check status registers or do
70 * other more expensive operations. This command is issued periodically
71 * but less frequently than POLL_ONLY.
73 * The count limit specifies how much work the handler can do during the
74 * call -- typically this is the number of packets to be received, or
75 * transmitted, etc. (drivers are free to interpret this number, as long
76 * as the max time spent in the function grows roughly linearly with the
79 * Polling is enabled and disabled via setting IFCAP_POLLING flag on
80 * the interface. The driver ioctl handler should register interface
81 * with polling and disable interrupts, if registration was successful.
83 * A second variable controls the sharing of CPU between polling/kernel
84 * network processing, and other activities (typically userlevel tasks):
85 * kern.polling.user_frac (between 0 and 100, default 50) sets the share
86 * of CPU allocated to user tasks. CPU is allocated proportionally to the
87 * shares, by dynamically adjusting the "count" (poll_burst).
89 * Other parameters can should be left to their default values.
90 * The following constraints hold
92 * 1 <= poll_each_burst <= poll_burst <= poll_burst_max
93 * MIN_POLL_BURST_MAX <= poll_burst_max <= MAX_POLL_BURST_MAX
96 #define MIN_POLL_BURST_MAX 10
97 #define MAX_POLL_BURST_MAX 20000
99 static uint32_t poll_burst = 5;
100 static uint32_t poll_burst_max = 150; /* good for 100Mbit net and HZ=1000 */
101 static uint32_t poll_each_burst = 5;
103 static SYSCTL_NODE(_kern, OID_AUTO, polling, CTLFLAG_RW, 0,
104 "Device polling parameters");
106 SYSCTL_UINT(_kern_polling, OID_AUTO, burst, CTLFLAG_RD,
107 &poll_burst, 0, "Current polling burst size");
109 static int netisr_poll_scheduled;
110 static int netisr_pollmore_scheduled;
111 static int poll_shutting_down;
113 static int poll_burst_max_sysctl(SYSCTL_HANDLER_ARGS)
115 uint32_t val = poll_burst_max;
118 error = sysctl_handle_int(oidp, &val, 0, req);
119 if (error || !req->newptr )
121 if (val < MIN_POLL_BURST_MAX || val > MAX_POLL_BURST_MAX)
125 poll_burst_max = val;
126 if (poll_burst > poll_burst_max)
127 poll_burst = poll_burst_max;
128 if (poll_each_burst > poll_burst_max)
129 poll_each_burst = MIN_POLL_BURST_MAX;
130 mtx_unlock(&poll_mtx);
134 SYSCTL_PROC(_kern_polling, OID_AUTO, burst_max, CTLTYPE_UINT | CTLFLAG_RW,
135 0, sizeof(uint32_t), poll_burst_max_sysctl, "I", "Max Polling burst size");
137 static int poll_each_burst_sysctl(SYSCTL_HANDLER_ARGS)
139 uint32_t val = poll_each_burst;
142 error = sysctl_handle_int(oidp, &val, 0, req);
143 if (error || !req->newptr )
149 if (val > poll_burst_max) {
150 mtx_unlock(&poll_mtx);
153 poll_each_burst = val;
154 mtx_unlock(&poll_mtx);
158 SYSCTL_PROC(_kern_polling, OID_AUTO, each_burst, CTLTYPE_UINT | CTLFLAG_RW,
159 0, sizeof(uint32_t), poll_each_burst_sysctl, "I",
160 "Max size of each burst");
162 static uint32_t poll_in_idle_loop=0; /* do we poll in idle loop ? */
163 SYSCTL_UINT(_kern_polling, OID_AUTO, idle_poll, CTLFLAG_RW,
164 &poll_in_idle_loop, 0, "Enable device polling in idle loop");
166 static uint32_t user_frac = 50;
167 static int user_frac_sysctl(SYSCTL_HANDLER_ARGS)
169 uint32_t val = user_frac;
172 error = sysctl_handle_int(oidp, &val, 0, req);
173 if (error || !req->newptr )
180 mtx_unlock(&poll_mtx);
184 SYSCTL_PROC(_kern_polling, OID_AUTO, user_frac, CTLTYPE_UINT | CTLFLAG_RW,
185 0, sizeof(uint32_t), user_frac_sysctl, "I",
186 "Desired user fraction of cpu time");
188 static uint32_t reg_frac_count = 0;
189 static uint32_t reg_frac = 20 ;
190 static int reg_frac_sysctl(SYSCTL_HANDLER_ARGS)
192 uint32_t val = reg_frac;
195 error = sysctl_handle_int(oidp, &val, 0, req);
196 if (error || !req->newptr )
198 if (val < 1 || val > hz)
203 if (reg_frac_count >= reg_frac)
205 mtx_unlock(&poll_mtx);
209 SYSCTL_PROC(_kern_polling, OID_AUTO, reg_frac, CTLTYPE_UINT | CTLFLAG_RW,
210 0, sizeof(uint32_t), reg_frac_sysctl, "I",
211 "Every this many cycles check registers");
213 static uint32_t short_ticks;
214 SYSCTL_UINT(_kern_polling, OID_AUTO, short_ticks, CTLFLAG_RD,
215 &short_ticks, 0, "Hardclock ticks shorter than they should be");
217 static uint32_t lost_polls;
218 SYSCTL_UINT(_kern_polling, OID_AUTO, lost_polls, CTLFLAG_RD,
219 &lost_polls, 0, "How many times we would have lost a poll tick");
221 static uint32_t pending_polls;
222 SYSCTL_UINT(_kern_polling, OID_AUTO, pending_polls, CTLFLAG_RD,
223 &pending_polls, 0, "Do we need to poll again");
225 static int residual_burst = 0;
226 SYSCTL_INT(_kern_polling, OID_AUTO, residual_burst, CTLFLAG_RD,
227 &residual_burst, 0, "# of residual cycles in burst");
229 static uint32_t poll_handlers; /* next free entry in pr[]. */
230 SYSCTL_UINT(_kern_polling, OID_AUTO, handlers, CTLFLAG_RD,
231 &poll_handlers, 0, "Number of registered poll handlers");
233 static uint32_t phase;
234 SYSCTL_UINT(_kern_polling, OID_AUTO, phase, CTLFLAG_RD,
235 &phase, 0, "Polling phase");
237 static uint32_t suspect;
238 SYSCTL_UINT(_kern_polling, OID_AUTO, suspect, CTLFLAG_RD,
239 &suspect, 0, "suspect event");
241 static uint32_t stalled;
242 SYSCTL_UINT(_kern_polling, OID_AUTO, stalled, CTLFLAG_RD,
243 &stalled, 0, "potential stalls");
245 static uint32_t idlepoll_sleeping; /* idlepoll is sleeping */
246 SYSCTL_UINT(_kern_polling, OID_AUTO, idlepoll_sleeping, CTLFLAG_RD,
247 &idlepoll_sleeping, 0, "idlepoll is sleeping");
250 #define POLL_LIST_LEN 128
252 poll_handler_t *handler;
256 static struct pollrec pr[POLL_LIST_LEN];
259 poll_shutdown(void *arg, int howto)
262 poll_shutting_down = 1;
266 init_device_poll(void)
269 mtx_init(&poll_mtx, "polling", NULL, MTX_DEF);
270 EVENTHANDLER_REGISTER(shutdown_post_sync, poll_shutdown, NULL,
273 SYSINIT(device_poll, SI_SUB_SOFTINTR, SI_ORDER_MIDDLE, init_device_poll, NULL);
277 * Hook from hardclock. Tries to schedule a netisr, but keeps track
278 * of lost ticks due to the previous handler taking too long.
279 * Normally, this should not happen, because polling handler should
280 * run for a short time. However, in some cases (e.g. when there are
281 * changes in link status etc.) the drivers take a very long time
282 * (even in the order of milliseconds) to reset and reconfigure the
283 * device, causing apparent lost polls.
285 * The first part of the code is just for debugging purposes, and tries
286 * to count how often hardclock ticks are shorter than they should,
287 * meaning either stray interrupts or delayed events.
290 hardclock_device_poll(void)
292 static struct timeval prev_t, t;
295 if (poll_handlers == 0 || poll_shutting_down)
299 delta = (t.tv_usec - prev_t.tv_usec) +
300 (t.tv_sec - prev_t.tv_sec)*1000000;
301 if (delta * hz < 500000)
306 if (pending_polls > 100) {
308 * Too much, assume it has stalled (not always true
309 * see comment above).
320 netisr_poll_scheduled = 1;
321 netisr_pollmore_scheduled = 1;
325 if (pending_polls++ > 0)
330 * ether_poll is called from the idle loop.
333 ether_poll(int count)
339 if (count > poll_each_burst)
340 count = poll_each_burst;
342 for (i = 0 ; i < poll_handlers ; i++)
343 pr[i].handler(pr[i].ifp, POLL_ONLY, count);
345 mtx_unlock(&poll_mtx);
349 * netisr_pollmore is called after other netisr's, possibly scheduling
350 * another NETISR_POLL call, or adapting the burst size for the next cycle.
352 * It is very bad to fetch large bursts of packets from a single card at once,
353 * because the burst could take a long time to be completely processed, or
354 * could saturate the intermediate queue (ipintrq or similar) leading to
355 * losses or unfairness. To reduce the problem, and also to account better for
356 * time spent in network-related processing, we split the burst in smaller
357 * chunks of fixed size, giving control to the other netisr's between chunks.
358 * This helps in improving the fairness, reducing livelock (because we
359 * emulate more closely the "process to completion" that we have with
360 * fastforwarding) and accounting for the work performed in low level
361 * handling and forwarding.
364 static struct timeval poll_start_t;
372 if (poll_handlers == 0)
376 if (!netisr_pollmore_scheduled) {
377 mtx_unlock(&poll_mtx);
380 netisr_pollmore_scheduled = 0;
382 if (residual_burst > 0) {
383 netisr_poll_scheduled = 1;
384 netisr_pollmore_scheduled = 1;
386 mtx_unlock(&poll_mtx);
387 /* will run immediately on return, followed by netisrs */
390 /* here we can account time spent in netisr's in this tick */
392 kern_load = (t.tv_usec - poll_start_t.tv_usec) +
393 (t.tv_sec - poll_start_t.tv_sec)*1000000; /* us */
394 kern_load = (kern_load * hz) / 10000; /* 0..100 */
395 if (kern_load > (100 - user_frac)) { /* try decrease ticks */
399 if (poll_burst < poll_burst_max)
404 if (pending_polls == 0) /* we are done */
408 * Last cycle was long and caused us to miss one or more
409 * hardclock ticks. Restart processing again, but slightly
410 * reduce the burst size to prevent that this happens again.
412 poll_burst -= (poll_burst / 8);
415 netisr_poll_scheduled = 1;
416 netisr_pollmore_scheduled = 1;
420 mtx_unlock(&poll_mtx);
424 * netisr_poll is typically scheduled once per tick.
430 enum poll_cmd arg = POLL_ONLY;
432 if (poll_handlers == 0)
436 if (!netisr_poll_scheduled) {
437 mtx_unlock(&poll_mtx);
440 netisr_poll_scheduled = 0;
442 if (residual_burst == 0) { /* first call in this tick */
443 microuptime(&poll_start_t);
444 if (++reg_frac_count == reg_frac) {
445 arg = POLL_AND_CHECK_STATUS;
449 residual_burst = poll_burst;
451 cycles = (residual_burst < poll_each_burst) ?
452 residual_burst : poll_each_burst;
453 residual_burst -= cycles;
455 for (i = 0 ; i < poll_handlers ; i++)
456 pr[i].handler(pr[i].ifp, arg, cycles);
459 mtx_unlock(&poll_mtx);
463 * Try to register routine for polling. Returns 0 if successful
464 * (and polling should be enabled), error code otherwise.
465 * A device is not supposed to register itself multiple times.
467 * This is called from within the *_ioctl() functions.
470 ether_poll_register(poll_handler_t *h, if_t ifp)
474 KASSERT(h != NULL, ("%s: handler is NULL", __func__));
475 KASSERT(ifp != NULL, ("%s: ifp is NULL", __func__));
478 if (poll_handlers >= POLL_LIST_LEN) {
480 * List full, cannot register more entries.
481 * This should never happen; if it does, it is probably a
482 * broken driver trying to register multiple times. Checking
483 * this at runtime is expensive, and won't solve the problem
484 * anyways, so just report a few times and then give up.
486 static int verbose = 10 ;
488 log(LOG_ERR, "poll handlers list full, "
489 "maybe a broken driver ?\n");
492 mtx_unlock(&poll_mtx);
493 return (ENOMEM); /* no polling for you */
496 for (i = 0 ; i < poll_handlers ; i++)
497 if (pr[i].ifp == ifp && pr[i].handler != NULL) {
498 mtx_unlock(&poll_mtx);
499 log(LOG_DEBUG, "ether_poll_register: %s: handler"
500 " already registered\n", ifp->if_xname);
504 pr[poll_handlers].handler = h;
505 pr[poll_handlers].ifp = ifp;
507 mtx_unlock(&poll_mtx);
508 if (idlepoll_sleeping)
509 wakeup(&idlepoll_sleeping);
514 * Remove interface from the polling list. Called from *_ioctl(), too.
517 ether_poll_deregister(if_t ifp)
521 KASSERT(ifp != NULL, ("%s: ifp is NULL", __func__));
525 for (i = 0 ; i < poll_handlers ; i++)
526 if (pr[i].ifp == ifp) /* found it */
528 if (i == poll_handlers) {
529 log(LOG_DEBUG, "ether_poll_deregister: %s: not found!\n",
531 mtx_unlock(&poll_mtx);
535 if (i < poll_handlers) { /* Last entry replaces this one. */
536 pr[i].handler = pr[poll_handlers].handler;
537 pr[i].ifp = pr[poll_handlers].ifp;
539 mtx_unlock(&poll_mtx);
546 struct thread *td = curthread;
549 rtp.prio = RTP_PRIO_MAX; /* lowest priority */
550 rtp.type = RTP_PRIO_IDLE;
551 PROC_SLOCK(td->td_proc);
552 rtp_to_pri(&rtp, td);
553 PROC_SUNLOCK(td->td_proc);
556 if (poll_in_idle_loop && poll_handlers > 0) {
557 idlepoll_sleeping = 0;
558 ether_poll(poll_each_burst);
560 mi_switch(SW_VOL, NULL);
563 idlepoll_sleeping = 1;
564 tsleep(&idlepoll_sleeping, 0, "pollid", hz * 3);
569 static struct proc *idlepoll;
570 static struct kproc_desc idlepoll_kp = {
575 SYSINIT(idlepoll, SI_SUB_KTHREAD_VM, SI_ORDER_ANY, kproc_start,