sys/kern/kern_poll.c

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
   3  *
   4  * Copyright (c) 2001-2002 Luigi Rizzo
   5  *
   6  * Supported by: the Xorp Project (www.xorp.org)
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  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.
  16  *
  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
  27  * SUCH DAMAGE.
  28  */
  29
  30 #include <sys/cdefs.h>
  31 __FBSDID("$FreeBSD$");
  32
  33 #include "opt_device_polling.h"
  34
  35 #include <sys/param.h>
  36 #include <sys/systm.h>
  37 #include <sys/kernel.h>
  38 #include <sys/kthread.h>
  39 #include <sys/proc.h>
  40 #include <sys/epoch.h>
  41 #include <sys/eventhandler.h>
  42 #include <sys/resourcevar.h>
  43 #include <sys/socket.h>                 /* needed by net/if.h           */
  44 #include <sys/sockio.h>
  45 #include <sys/sysctl.h>
  46 #include <sys/syslog.h>
  47
  48 #include <net/if.h>
  49 #include <net/if_var.h>
  50 #include <net/netisr.h>                 /* for NETISR_POLL              */
  51 #include <net/vnet.h>
  52
  53 void hardclock_device_poll(void);       /* hook from hardclock          */
  54
  55 static struct mtx       poll_mtx;
  56
  57 /*
  58  * Polling support for [network] device drivers.
  59  *
  60  * Drivers which support this feature can register with the
  61  * polling code.
  62  *
  63  * If registration is successful, the driver must disable interrupts,
  64  * and further I/O is performed through the handler, which is invoked
  65  * (at least once per clock tick) with 3 arguments: the "arg" passed at
  66  * register time (a struct ifnet pointer), a command, and a "count" limit.
  67  *
  68  * The command can be one of the following:
  69  *  POLL_ONLY: quick move of "count" packets from input/output queues.
  70  *  POLL_AND_CHECK_STATUS: as above, plus check status registers or do
  71  *      other more expensive operations. This command is issued periodically
  72  *      but less frequently than POLL_ONLY.
  73  *
  74  * The count limit specifies how much work the handler can do during the
  75  * call -- typically this is the number of packets to be received, or
  76  * transmitted, etc. (drivers are free to interpret this number, as long
  77  * as the max time spent in the function grows roughly linearly with the
  78  * count).
  79  *
  80  * Polling is enabled and disabled via setting IFCAP_POLLING flag on
  81  * the interface. The driver ioctl handler should register interface
  82  * with polling and disable interrupts, if registration was successful.
  83  *
  84  * A second variable controls the sharing of CPU between polling/kernel
  85  * network processing, and other activities (typically userlevel tasks):
  86  * kern.polling.user_frac (between 0 and 100, default 50) sets the share
  87  * of CPU allocated to user tasks. CPU is allocated proportionally to the
  88  * shares, by dynamically adjusting the "count" (poll_burst).
  89  *
  90  * Other parameters can should be left to their default values.
  91  * The following constraints hold
  92  *
  93  *      1 <= poll_each_burst <= poll_burst <= poll_burst_max
  94  *      MIN_POLL_BURST_MAX <= poll_burst_max <= MAX_POLL_BURST_MAX
  95  */
  96
  97 #define MIN_POLL_BURST_MAX      10
  98 #define MAX_POLL_BURST_MAX      20000
  99
 100 static uint32_t poll_burst = 5;
 101 static uint32_t poll_burst_max = 150;   /* good for 100Mbit net and HZ=1000 */
 102 static uint32_t poll_each_burst = 5;
 103
 104 static SYSCTL_NODE(_kern, OID_AUTO, polling, CTLFLAG_RW, 0,
 105         "Device polling parameters");
 106
 107 SYSCTL_UINT(_kern_polling, OID_AUTO, burst, CTLFLAG_RD,
 108         &poll_burst, 0, "Current polling burst size");
 109
 110 static int      netisr_poll_scheduled;
 111 static int      netisr_pollmore_scheduled;
 112 static int      poll_shutting_down;
 113
 114 static int poll_burst_max_sysctl(SYSCTL_HANDLER_ARGS)
 115 {
 116         uint32_t val = poll_burst_max;
 117         int error;
 118
 119         error = sysctl_handle_int(oidp, &val, 0, req);
 120         if (error || !req->newptr )
 121                 return (error);
 122         if (val < MIN_POLL_BURST_MAX || val > MAX_POLL_BURST_MAX)
 123                 return (EINVAL);
 124
 125         mtx_lock(&poll_mtx);
 126         poll_burst_max = val;
 127         if (poll_burst > poll_burst_max)
 128                 poll_burst = poll_burst_max;
 129         if (poll_each_burst > poll_burst_max)
 130                 poll_each_burst = MIN_POLL_BURST_MAX;
 131         mtx_unlock(&poll_mtx);
 132
 133         return (0);
 134 }
 135 SYSCTL_PROC(_kern_polling, OID_AUTO, burst_max, CTLTYPE_UINT | CTLFLAG_RW,
 136         0, sizeof(uint32_t), poll_burst_max_sysctl, "I", "Max Polling burst size");
 137
 138 static int poll_each_burst_sysctl(SYSCTL_HANDLER_ARGS)
 139 {
 140         uint32_t val = poll_each_burst;
 141         int error;
 142
 143         error = sysctl_handle_int(oidp, &val, 0, req);
 144         if (error || !req->newptr )
 145                 return (error);
 146         if (val < 1)
 147                 return (EINVAL);
 148
 149         mtx_lock(&poll_mtx);
 150         if (val > poll_burst_max) {
 151                 mtx_unlock(&poll_mtx);
 152                 return (EINVAL);
 153         }
 154         poll_each_burst = val;
 155         mtx_unlock(&poll_mtx);
 156
 157         return (0);
 158 }
 159 SYSCTL_PROC(_kern_polling, OID_AUTO, each_burst, CTLTYPE_UINT | CTLFLAG_RW,
 160         0, sizeof(uint32_t), poll_each_burst_sysctl, "I",
 161         "Max size of each burst");
 162
 163 static uint32_t poll_in_idle_loop=0;    /* do we poll in idle loop ? */
 164 SYSCTL_UINT(_kern_polling, OID_AUTO, idle_poll, CTLFLAG_RW,
 165         &poll_in_idle_loop, 0, "Enable device polling in idle loop");
 166
 167 static uint32_t user_frac = 50;
 168 static int user_frac_sysctl(SYSCTL_HANDLER_ARGS)
 169 {
 170         uint32_t val = user_frac;
 171         int error;
 172
 173         error = sysctl_handle_int(oidp, &val, 0, req);
 174         if (error || !req->newptr )
 175                 return (error);
 176         if (val > 99)
 177                 return (EINVAL);
 178
 179         mtx_lock(&poll_mtx);
 180         user_frac = val;
 181         mtx_unlock(&poll_mtx);
 182
 183         return (0);
 184 }
 185 SYSCTL_PROC(_kern_polling, OID_AUTO, user_frac, CTLTYPE_UINT | CTLFLAG_RW,
 186         0, sizeof(uint32_t), user_frac_sysctl, "I",
 187         "Desired user fraction of cpu time");
 188
 189 static uint32_t reg_frac_count = 0;
 190 static uint32_t reg_frac = 20 ;
 191 static int reg_frac_sysctl(SYSCTL_HANDLER_ARGS)
 192 {
 193         uint32_t val = reg_frac;
 194         int error;
 195
 196         error = sysctl_handle_int(oidp, &val, 0, req);
 197         if (error || !req->newptr )
 198                 return (error);
 199         if (val < 1 || val > hz)
 200                 return (EINVAL);
 201
 202         mtx_lock(&poll_mtx);
 203         reg_frac = val;
 204         if (reg_frac_count >= reg_frac)
 205                 reg_frac_count = 0;
 206         mtx_unlock(&poll_mtx);
 207
 208         return (0);
 209 }
 210 SYSCTL_PROC(_kern_polling, OID_AUTO, reg_frac, CTLTYPE_UINT | CTLFLAG_RW,
 211         0, sizeof(uint32_t), reg_frac_sysctl, "I",
 212         "Every this many cycles check registers");
 213
 214 static uint32_t short_ticks;
 215 SYSCTL_UINT(_kern_polling, OID_AUTO, short_ticks, CTLFLAG_RD,
 216         &short_ticks, 0, "Hardclock ticks shorter than they should be");
 217
 218 static uint32_t lost_polls;
 219 SYSCTL_UINT(_kern_polling, OID_AUTO, lost_polls, CTLFLAG_RD,
 220         &lost_polls, 0, "How many times we would have lost a poll tick");
 221
 222 static uint32_t pending_polls;
 223 SYSCTL_UINT(_kern_polling, OID_AUTO, pending_polls, CTLFLAG_RD,
 224         &pending_polls, 0, "Do we need to poll again");
 225
 226 static int residual_burst = 0;
 227 SYSCTL_INT(_kern_polling, OID_AUTO, residual_burst, CTLFLAG_RD,
 228         &residual_burst, 0, "# of residual cycles in burst");
 229
 230 static uint32_t poll_handlers; /* next free entry in pr[]. */
 231 SYSCTL_UINT(_kern_polling, OID_AUTO, handlers, CTLFLAG_RD,
 232         &poll_handlers, 0, "Number of registered poll handlers");
 233
 234 static uint32_t phase;
 235 SYSCTL_UINT(_kern_polling, OID_AUTO, phase, CTLFLAG_RD,
 236         &phase, 0, "Polling phase");
 237
 238 static uint32_t suspect;
 239 SYSCTL_UINT(_kern_polling, OID_AUTO, suspect, CTLFLAG_RD,
 240         &suspect, 0, "suspect event");
 241
 242 static uint32_t stalled;
 243 SYSCTL_UINT(_kern_polling, OID_AUTO, stalled, CTLFLAG_RD,
 244         &stalled, 0, "potential stalls");
 245
 246 static uint32_t idlepoll_sleeping; /* idlepoll is sleeping */
 247 SYSCTL_UINT(_kern_polling, OID_AUTO, idlepoll_sleeping, CTLFLAG_RD,
 248         &idlepoll_sleeping, 0, "idlepoll is sleeping");
 249
 250 #define POLL_LIST_LEN  128
 251 struct pollrec {
 252         poll_handler_t  *handler;
 253         struct ifnet    *ifp;
 254 };
 255
 256 static struct pollrec pr[POLL_LIST_LEN];
 257
 258 static void
 259 poll_shutdown(void *arg, int howto)
 260 {
 261
 262         poll_shutting_down = 1;
 263 }
 264
 265 static void
 266 init_device_poll(void)
 267 {
 268
 269         mtx_init(&poll_mtx, "polling", NULL, MTX_DEF);
 270         EVENTHANDLER_REGISTER(shutdown_post_sync, poll_shutdown, NULL,
 271             SHUTDOWN_PRI_LAST);
 272 }
 273 SYSINIT(device_poll, SI_SUB_SOFTINTR, SI_ORDER_MIDDLE, init_device_poll, NULL);
 274
 275 /*
 276  * Hook from hardclock. Tries to schedule a netisr, but keeps track
 277  * of lost ticks due to the previous handler taking too long.
 278  * Normally, this should not happen, because polling handler should
 279  * run for a short time. However, in some cases (e.g. when there are
 280  * changes in link status etc.) the drivers take a very long time
 281  * (even in the order of milliseconds) to reset and reconfigure the
 282  * device, causing apparent lost polls.
 283  *
 284  * The first part of the code is just for debugging purposes, and tries
 285  * to count how often hardclock ticks are shorter than they should,
 286  * meaning either stray interrupts or delayed events.
 287  */
 288 void
 289 hardclock_device_poll(void)
 290 {
 291         static struct timeval prev_t, t;
 292         int delta;
 293
 294         if (poll_handlers == 0 || poll_shutting_down)
 295                 return;
 296
 297         microuptime(&t);
 298         delta = (t.tv_usec - prev_t.tv_usec) +
 299                 (t.tv_sec - prev_t.tv_sec)*1000000;
 300         if (delta * hz < 500000)
 301                 short_ticks++;
 302         else
 303                 prev_t = t;
 304
 305         if (pending_polls > 100) {
 306                 /*
 307                  * Too much, assume it has stalled (not always true
 308                  * see comment above).
 309                  */
 310                 stalled++;
 311                 pending_polls = 0;
 312                 phase = 0;
 313         }
 314
 315         if (phase <= 2) {
 316                 if (phase != 0)
 317                         suspect++;
 318                 phase = 1;
 319                 netisr_poll_scheduled = 1;
 320                 netisr_pollmore_scheduled = 1;
 321                 netisr_sched_poll();
 322                 phase = 2;
 323         }
 324         if (pending_polls++ > 0)
 325                 lost_polls++;
 326 }
 327
 328 /*
 329  * ether_poll is called from the idle loop.
 330  */
 331 static void
 332 ether_poll(int count)
 333 {
 334         struct epoch_tracker et;
 335         int i;
 336
 337         mtx_lock(&poll_mtx);
 338
 339         if (count > poll_each_burst)
 340                 count = poll_each_burst;
 341
 342         NET_EPOCH_ENTER(et);
 343         for (i = 0 ; i < poll_handlers ; i++)
 344                 pr[i].handler(pr[i].ifp, POLL_ONLY, count);
 345         NET_EPOCH_EXIT(et);
 346
 347         mtx_unlock(&poll_mtx);
 348 }
 349
 350 /*
 351  * netisr_pollmore is called after other netisr's, possibly scheduling
 352  * another NETISR_POLL call, or adapting the burst size for the next cycle.
 353  *
 354  * It is very bad to fetch large bursts of packets from a single card at once,
 355  * because the burst could take a long time to be completely processed, or
 356  * could saturate the intermediate queue (ipintrq or similar) leading to
 357  * losses or unfairness. To reduce the problem, and also to account better for
 358  * time spent in network-related processing, we split the burst in smaller
 359  * chunks of fixed size, giving control to the other netisr's between chunks.
 360  * This helps in improving the fairness, reducing livelock (because we
 361  * emulate more closely the "process to completion" that we have with
 362  * fastforwarding) and accounting for the work performed in low level
 363  * handling and forwarding.
 364  */
 365
 366 static struct timeval poll_start_t;
 367
 368 void
 369 netisr_pollmore()
 370 {
 371         struct timeval t;
 372         int kern_load;
 373
 374         if (poll_handlers == 0)
 375                 return;
 376
 377         mtx_lock(&poll_mtx);
 378         if (!netisr_pollmore_scheduled) {
 379                 mtx_unlock(&poll_mtx);
 380                 return;
 381         }
 382         netisr_pollmore_scheduled = 0;
 383         phase = 5;
 384         if (residual_burst > 0) {
 385                 netisr_poll_scheduled = 1;
 386                 netisr_pollmore_scheduled = 1;
 387                 netisr_sched_poll();
 388                 mtx_unlock(&poll_mtx);
 389                 /* will run immediately on return, followed by netisrs */
 390                 return;
 391         }
 392         /* here we can account time spent in netisr's in this tick */
 393         microuptime(&t);
 394         kern_load = (t.tv_usec - poll_start_t.tv_usec) +
 395                 (t.tv_sec - poll_start_t.tv_sec)*1000000;       /* us */
 396         kern_load = (kern_load * hz) / 10000;                   /* 0..100 */
 397         if (kern_load > (100 - user_frac)) { /* try decrease ticks */
 398                 if (poll_burst > 1)
 399                         poll_burst--;
 400         } else {
 401                 if (poll_burst < poll_burst_max)
 402                         poll_burst++;
 403         }
 404
 405         pending_polls--;
 406         if (pending_polls == 0) /* we are done */
 407                 phase = 0;
 408         else {
 409                 /*
 410                  * Last cycle was long and caused us to miss one or more
 411                  * hardclock ticks. Restart processing again, but slightly
 412                  * reduce the burst size to prevent that this happens again.
 413                  */
 414                 poll_burst -= (poll_burst / 8);
 415                 if (poll_burst < 1)
 416                         poll_burst = 1;
 417                 netisr_poll_scheduled = 1;
 418                 netisr_pollmore_scheduled = 1;
 419                 netisr_sched_poll();
 420                 phase = 6;
 421         }
 422         mtx_unlock(&poll_mtx);
 423 }
 424
 425 /*
 426  * netisr_poll is typically scheduled once per tick.
 427  */
 428 void
 429 netisr_poll(void)
 430 {
 431         int i, cycles;
 432         enum poll_cmd arg = POLL_ONLY;
 433
 434         NET_EPOCH_ASSERT();
 435
 436         if (poll_handlers == 0)
 437                 return;
 438
 439         mtx_lock(&poll_mtx);
 440         if (!netisr_poll_scheduled) {
 441                 mtx_unlock(&poll_mtx);
 442                 return;
 443         }
 444         netisr_poll_scheduled = 0;
 445         phase = 3;
 446         if (residual_burst == 0) { /* first call in this tick */
 447                 microuptime(&poll_start_t);
 448                 if (++reg_frac_count == reg_frac) {
 449                         arg = POLL_AND_CHECK_STATUS;
 450                         reg_frac_count = 0;
 451                 }
 452
 453                 residual_burst = poll_burst;
 454         }
 455         cycles = (residual_burst < poll_each_burst) ?
 456                 residual_burst : poll_each_burst;
 457         residual_burst -= cycles;
 458
 459         for (i = 0 ; i < poll_handlers ; i++)
 460                 pr[i].handler(pr[i].ifp, arg, cycles);
 461
 462         phase = 4;
 463         mtx_unlock(&poll_mtx);
 464 }
 465
 466 /*
 467  * Try to register routine for polling. Returns 0 if successful
 468  * (and polling should be enabled), error code otherwise.
 469  * A device is not supposed to register itself multiple times.
 470  *
 471  * This is called from within the *_ioctl() functions.
 472  */
 473 int
 474 ether_poll_register(poll_handler_t *h, if_t ifp)
 475 {
 476         int i;
 477
 478         KASSERT(h != NULL, ("%s: handler is NULL", __func__));
 479         KASSERT(ifp != NULL, ("%s: ifp is NULL", __func__));
 480
 481         mtx_lock(&poll_mtx);
 482         if (poll_handlers >= POLL_LIST_LEN) {
 483                 /*
 484                  * List full, cannot register more entries.
 485                  * This should never happen; if it does, it is probably a
 486                  * broken driver trying to register multiple times. Checking
 487                  * this at runtime is expensive, and won't solve the problem
 488                  * anyways, so just report a few times and then give up.
 489                  */
 490                 static int verbose = 10 ;
 491                 if (verbose >0) {
 492                         log(LOG_ERR, "poll handlers list full, "
 493                             "maybe a broken driver ?\n");
 494                         verbose--;
 495                 }
 496                 mtx_unlock(&poll_mtx);
 497                 return (ENOMEM); /* no polling for you */
 498         }
 499
 500         for (i = 0 ; i < poll_handlers ; i++)
 501                 if (pr[i].ifp == ifp && pr[i].handler != NULL) {
 502                         mtx_unlock(&poll_mtx);
 503                         log(LOG_DEBUG, "ether_poll_register: %s: handler"
 504                             " already registered\n", ifp->if_xname);
 505                         return (EEXIST);
 506                 }
 507
 508         pr[poll_handlers].handler = h;
 509         pr[poll_handlers].ifp = ifp;
 510         poll_handlers++;
 511         mtx_unlock(&poll_mtx);
 512         if (idlepoll_sleeping)
 513                 wakeup(&idlepoll_sleeping);
 514         return (0);
 515 }
 516
 517 /*
 518  * Remove interface from the polling list. Called from *_ioctl(), too.
 519  */
 520 int
 521 ether_poll_deregister(if_t ifp)
 522 {
 523         int i;
 524
 525         KASSERT(ifp != NULL, ("%s: ifp is NULL", __func__));
 526
 527         mtx_lock(&poll_mtx);
 528
 529         for (i = 0 ; i < poll_handlers ; i++)
 530                 if (pr[i].ifp == ifp) /* found it */
 531                         break;
 532         if (i == poll_handlers) {
 533                 log(LOG_DEBUG, "ether_poll_deregister: %s: not found!\n",
 534                     ifp->if_xname);
 535                 mtx_unlock(&poll_mtx);
 536                 return (ENOENT);
 537         }
 538         poll_handlers--;
 539         if (i < poll_handlers) { /* Last entry replaces this one. */
 540                 pr[i].handler = pr[poll_handlers].handler;
 541                 pr[i].ifp = pr[poll_handlers].ifp;
 542         }
 543         mtx_unlock(&poll_mtx);
 544         return (0);
 545 }
 546
 547 static void
 548 poll_idle(void)
 549 {
 550         struct thread *td = curthread;
 551         struct rtprio rtp;
 552
 553         rtp.prio = RTP_PRIO_MAX;        /* lowest priority */
 554         rtp.type = RTP_PRIO_IDLE;
 555         PROC_SLOCK(td->td_proc);
 556         rtp_to_pri(&rtp, td);
 557         PROC_SUNLOCK(td->td_proc);
 558
 559         for (;;) {
 560                 if (poll_in_idle_loop && poll_handlers > 0) {
 561                         idlepoll_sleeping = 0;
 562                         ether_poll(poll_each_burst);
 563                         thread_lock(td);
 564                         mi_switch(SW_VOL);
 565                 } else {
 566                         idlepoll_sleeping = 1;
 567                         tsleep(&idlepoll_sleeping, 0, "pollid", hz * 3);
 568                 }
 569         }
 570 }
 571
 572 static struct proc *idlepoll;
 573 static struct kproc_desc idlepoll_kp = {
 574          "idlepoll",
 575          poll_idle,
 576          &idlepoll
 577 };
 578 SYSINIT(idlepoll, SI_SUB_KTHREAD_VM, SI_ORDER_ANY, kproc_start,
 579     &idlepoll_kp);