sys/kern/kern_poll.c

   1 /*-
   2  * Copyright (c) 2001-2002 Luigi Rizzo
   3  *
   4  * Supported by: the Xorp Project (www.xorp.org)
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD: src/sys/kern/kern_poll.c,v 1.2.2.4 2002/06/27 23:26:33 luigi Exp $
  28  * $DragonFly: src/sys/kern/kern_poll.c,v 1.25 2007/01/05 22:16:28 dillon Exp $
  29  */
  30
  31 #include "opt_polling.h"
  32
  33 #include <sys/param.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/socket.h>                 /* needed by net/if.h           */
  37 #include <sys/sysctl.h>
  38
  39 #include <sys/thread2.h>
  40 #include <sys/msgport2.h>
  41
  42 #include <net/if.h>                     /* for IFF_* flags              */
  43 #include <net/netisr.h>                 /* for NETISR_POLL              */
  44
  45 /* the two netisr handlers */
  46 static int sysctl_pollhz(SYSCTL_HANDLER_ARGS);
  47 static int sysctl_polling(SYSCTL_HANDLER_ARGS);
  48 static int netisr_poll(struct netmsg *);
  49 static int netisr_pollmore(struct netmsg *);
  50 static void pollclock(systimer_t, struct intrframe *);
  51
  52 void init_device_poll(void);            /* init routine                 */
  53
  54 /*
  55  * Polling support for [network] device drivers.
  56  *
  57  * Drivers which support this feature try to register with the
  58  * polling code.
  59  *
  60  * If registration is successful, the driver must disable interrupts,
  61  * and further I/O is performed through the handler, which is invoked
  62  * (at least once per clock tick) with 3 arguments: the "arg" passed at
  63  * register time (a struct ifnet pointer), a command, and a "count" limit.
  64  *
  65  * The command can be one of the following:
  66  *  POLL_ONLY: quick move of "count" packets from input/output queues.
  67  *  POLL_AND_CHECK_STATUS: as above, plus check status registers or do
  68  *      other more expensive operations. This command is issued periodically
  69  *      but less frequently than POLL_ONLY.
  70  *  POLL_DEREGISTER: deregister and return to interrupt mode.
  71  *  POLL_REGISTER: register and disable interrupts
  72  *
  73  * The first two commands are only issued if the interface is marked as
  74  * 'IFF_UP and IFF_RUNNING', the last one only if IFF_RUNNING is set.
  75  *
  76  * The count limit specifies how much work the handler can do during the
  77  * call -- typically this is the number of packets to be received, or
  78  * transmitted, etc. (drivers are free to interpret this number, as long
  79  * as the max time spent in the function grows roughly linearly with the
  80  * count).
  81  *
  82  * Deregistration can be requested by the driver itself (typically in the
  83  * *_stop() routine), or by the polling code, by invoking the handler.
  84  *
  85  * Polling can be globally enabled or disabled with the sysctl variable
  86  * kern.polling.enable (default is 0, disabled)
  87  *
  88  * A second variable controls the sharing of CPU between polling/kernel
  89  * network processing, and other activities (typically userlevel tasks):
  90  * kern.polling.user_frac (between 0 and 100, default 50) sets the share
  91  * of CPU allocated to user tasks. CPU is allocated proportionally to the
  92  * shares, by dynamically adjusting the "count" (poll_burst).
  93  *
  94  * Other parameters can should be left to their default values.
  95  * The following constraints hold
  96  *
  97  *      1 <= poll_each_burst <= poll_burst <= poll_burst_max
  98  *      MIN_POLL_BURST_MAX <= poll_burst_max <= MAX_POLL_BURST_MAX
  99  */
 100
 101 #define MIN_POLL_BURST_MAX      10
 102 #define MAX_POLL_BURST_MAX      1000
 103
 104 #ifndef DEVICE_POLLING_FREQ_MAX
 105 #define DEVICE_POLLING_FREQ_MAX         30000
 106 #endif
 107 #define DEVICE_POLLING_FREQ_DEFAULT     2000
 108
 109 SYSCTL_NODE(_kern, OID_AUTO, polling, CTLFLAG_RW, 0,
 110         "Device polling parameters");
 111
 112 static u_int32_t poll_burst = 5;
 113 SYSCTL_UINT(_kern_polling, OID_AUTO, burst, CTLFLAG_RW,
 114         &poll_burst, 0, "Current polling burst size");
 115
 116 static u_int32_t poll_each_burst = 5;
 117 SYSCTL_UINT(_kern_polling, OID_AUTO, each_burst, CTLFLAG_RW,
 118         &poll_each_burst, 0, "Max size of each burst");
 119
 120 static u_int32_t poll_burst_max = 150;  /* good for 100Mbit net and HZ=1000 */
 121 SYSCTL_UINT(_kern_polling, OID_AUTO, burst_max, CTLFLAG_RW,
 122         &poll_burst_max, 0, "Max Polling burst size");
 123
 124 static u_int32_t user_frac = 50;
 125 SYSCTL_UINT(_kern_polling, OID_AUTO, user_frac, CTLFLAG_RW,
 126         &user_frac, 0, "Desired user fraction of cpu time");
 127
 128 static u_int32_t reg_frac = 20 ;
 129 SYSCTL_UINT(_kern_polling, OID_AUTO, reg_frac, CTLFLAG_RW,
 130         &reg_frac, 0, "Every this many cycles poll register");
 131
 132 static u_int32_t short_ticks;
 133 SYSCTL_UINT(_kern_polling, OID_AUTO, short_ticks, CTLFLAG_RW,
 134         &short_ticks, 0, "Hardclock ticks shorter than they should be");
 135
 136 static u_int32_t lost_polls;
 137 SYSCTL_UINT(_kern_polling, OID_AUTO, lost_polls, CTLFLAG_RW,
 138         &lost_polls, 0, "How many times we would have lost a poll tick");
 139
 140 static u_int32_t pending_polls;
 141 SYSCTL_UINT(_kern_polling, OID_AUTO, pending_polls, CTLFLAG_RW,
 142         &pending_polls, 0, "Do we need to poll again");
 143
 144 static int residual_burst = 0;
 145 SYSCTL_INT(_kern_polling, OID_AUTO, residual_burst, CTLFLAG_RW,
 146         &residual_burst, 0, "# of residual cycles in burst");
 147
 148 static u_int32_t poll_handlers; /* next free entry in pr[]. */
 149 SYSCTL_UINT(_kern_polling, OID_AUTO, handlers, CTLFLAG_RD,
 150         &poll_handlers, 0, "Number of registered poll handlers");
 151
 152 static int polling_enabled = 0;         /* global polling enable */
 153 TUNABLE_INT("kern.polling.enable", &polling_enabled);
 154 SYSCTL_PROC(_kern_polling, OID_AUTO, enable, CTLTYPE_INT | CTLFLAG_RW,
 155         0, 0, sysctl_polling, "I", "Polling enabled");
 156
 157 static u_int32_t phase;
 158 SYSCTL_UINT(_kern_polling, OID_AUTO, phase, CTLFLAG_RW,
 159         &phase, 0, "Polling phase");
 160
 161 static u_int32_t suspect;
 162 SYSCTL_UINT(_kern_polling, OID_AUTO, suspect, CTLFLAG_RW,
 163         &suspect, 0, "suspect event");
 164
 165 static u_int32_t stalled;
 166 SYSCTL_UINT(_kern_polling, OID_AUTO, stalled, CTLFLAG_RW,
 167         &stalled, 0, "potential stalls");
 168
 169 static int pollhz = DEVICE_POLLING_FREQ_DEFAULT;
 170 TUNABLE_INT("kern.polling.pollhz", &pollhz);
 171 SYSCTL_PROC(_kern_polling, OID_AUTO, pollhz, CTLTYPE_INT | CTLFLAG_RW,
 172             0, 0, sysctl_pollhz, "I", "Device polling frequency");
 173
 174 #define POLL_LIST_LEN  128
 175 struct pollrec {
 176         struct ifnet    *ifp;
 177 };
 178
 179 static struct pollrec pr[POLL_LIST_LEN];
 180 static struct systimer gd0_pollclock;
 181
 182 /*
 183  * register relevant netisr. Called from kern_clock.c:
 184  */
 185 void
 186 init_device_poll(void)
 187 {
 188         netisr_register(NETISR_POLL, cpu0_portfn, netisr_poll);
 189         netisr_register(NETISR_POLLMORE, cpu0_portfn, netisr_pollmore);
 190         systimer_init_periodic_nq(&gd0_pollclock, pollclock, NULL,
 191                                   polling_enabled ? pollhz : 1);
 192 }
 193
 194 /*
 195  * Set the polling frequency
 196  */
 197 static int
 198 sysctl_pollhz(SYSCTL_HANDLER_ARGS)
 199 {
 200         int error, phz;
 201
 202         phz = pollhz;
 203         error = sysctl_handle_int(oidp, &phz, 0, req);
 204         if (error || req->newptr == NULL)
 205                 return error;
 206         if (phz <= 0)
 207                 return EINVAL;
 208         else if (phz > DEVICE_POLLING_FREQ_MAX)
 209                 phz = DEVICE_POLLING_FREQ_MAX;
 210
 211         crit_enter();
 212         pollhz = phz;
 213         if (polling_enabled)
 214                 gd0_pollclock.periodic = sys_cputimer->fromhz(phz);
 215         crit_exit();
 216         return 0;
 217 }
 218
 219 /*
 220  * Master enable.  If polling is disabled, cut the polling systimer
 221  * frequency to 1hz.
 222  */
 223 static int
 224 sysctl_polling(SYSCTL_HANDLER_ARGS)
 225 {
 226         int error, enabled;
 227
 228         enabled = polling_enabled;
 229         error = sysctl_handle_int(oidp, &enabled, 0, req);
 230         if (error || req->newptr == NULL)
 231                 return error;
 232         polling_enabled = enabled;
 233         if (polling_enabled)
 234                 gd0_pollclock.periodic = sys_cputimer->fromhz(pollhz);
 235         else
 236                 gd0_pollclock.periodic = sys_cputimer->fromhz(1);
 237         return 0;
 238 }
 239
 240 /*
 241  * Hook from hardclock. Tries to schedule a netisr, but keeps track
 242  * of lost ticks due to the previous handler taking too long.
 243  * Normally, this should not happen, because polling handler should
 244  * run for a short time. However, in some cases (e.g. when there are
 245  * changes in link status etc.) the drivers take a very long time
 246  * (even in the order of milliseconds) to reset and reconfigure the
 247  * device, causing apparent lost polls.
 248  *
 249  * The first part of the code is just for debugging purposes, and tries
 250  * to count how often hardclock ticks are shorter than they should,
 251  * meaning either stray interrupts or delayed events.
 252  *
 253  * WARNING! called from fastint or IPI, the MP lock might not be held.
 254  */
 255 static void
 256 pollclock(systimer_t info __unused, struct intrframe *frame __unused)
 257 {
 258         static struct timeval prev_t, t;
 259         int delta;
 260
 261         if (poll_handlers == 0)
 262                 return;
 263
 264         microuptime(&t);
 265         delta = (t.tv_usec - prev_t.tv_usec) +
 266                 (t.tv_sec - prev_t.tv_sec)*1000000;
 267         if (delta * hz < 500000)
 268                 short_ticks++;
 269         else
 270                 prev_t = t;
 271
 272         if (pending_polls > 100) {
 273                 /*
 274                  * Too much, assume it has stalled (not always true
 275                  * see comment above).
 276                  */
 277                 stalled++;
 278                 pending_polls = 0;
 279                 phase = 0;
 280         }
 281
 282         if (phase <= 2) {
 283                 if (phase != 0)
 284                         suspect++;
 285                 phase = 1;
 286                 schednetisr(NETISR_POLL);
 287                 phase = 2;
 288         }
 289         if (pending_polls++ > 0)
 290                 lost_polls++;
 291 }
 292
 293 /*
 294  * netisr_pollmore is called after other netisr's, possibly scheduling
 295  * another NETISR_POLL call, or adapting the burst size for the next cycle.
 296  *
 297  * It is very bad to fetch large bursts of packets from a single card at once,
 298  * because the burst could take a long time to be completely processed, or
 299  * could saturate the intermediate queue (ipintrq or similar) leading to
 300  * losses or unfairness. To reduce the problem, and also to account better for
 301  * time spent in network-related processing, we split the burst in smaller
 302  * chunks of fixed size, giving control to the other netisr's between chunks.
 303  * This helps in improving the fairness, reducing livelock (because we
 304  * emulate more closely the "process to completion" that we have with
 305  * fastforwarding) and accounting for the work performed in low level
 306  * handling and forwarding.
 307  */
 308
 309 static struct timeval poll_start_t;
 310
 311 /* ARGSUSED */
 312 static int
 313 netisr_pollmore(struct netmsg *msg)
 314 {
 315         struct timeval t;
 316         int kern_load;
 317
 318         crit_enter();
 319         lwkt_replymsg(&msg->nm_lmsg, 0);
 320         phase = 5;
 321         if (residual_burst > 0) {
 322                 schednetisr(NETISR_POLL);
 323                 /* will run immediately on return, followed by netisrs */
 324                 goto out;
 325         }
 326         /* here we can account time spent in netisr's in this tick */
 327         microuptime(&t);
 328         kern_load = (t.tv_usec - poll_start_t.tv_usec) +
 329                 (t.tv_sec - poll_start_t.tv_sec)*1000000;       /* us */
 330         kern_load = (kern_load * hz) / 10000;                   /* 0..100 */
 331         if (kern_load > (100 - user_frac)) { /* try decrease ticks */
 332                 if (poll_burst > 1)
 333                         poll_burst--;
 334         } else {
 335                 if (poll_burst < poll_burst_max)
 336                         poll_burst++;
 337         }
 338
 339         pending_polls--;
 340         if (pending_polls == 0) {       /* we are done */
 341                 phase = 0;
 342         } else {
 343                 /*
 344                  * Last cycle was long and caused us to miss one or more
 345                  * hardclock ticks. Restart processing again, but slightly
 346                  * reduce the burst size to prevent that this happens again.
 347                  */
 348                 poll_burst -= (poll_burst / 8);
 349                 if (poll_burst < 1)
 350                         poll_burst = 1;
 351                 schednetisr(NETISR_POLL);
 352                 phase = 6;
 353         }
 354 out:
 355         crit_exit();
 356         return(EASYNC);
 357 }
 358
 359 /*
 360  * netisr_poll is scheduled by schednetisr when appropriate, typically once
 361  * per tick.
 362  *
 363  * Note that the message is replied immediately in order to allow a new
 364  * ISR to be scheduled in the handler.
 365  *
 366  * XXX each registration should indicate whether it needs a critical
 367  * section to operate.
 368  */
 369 /* ARGSUSED */
 370 static int
 371 netisr_poll(struct netmsg *msg)
 372 {
 373         static int reg_frac_count;
 374         int i, cycles;
 375         enum poll_cmd arg = POLL_ONLY;
 376
 377         lwkt_replymsg(&msg->nm_lmsg, 0);
 378         crit_enter();
 379         phase = 3;
 380         if (residual_burst == 0) { /* first call in this tick */
 381                 microuptime(&poll_start_t);
 382                 /*
 383                  * Check that paremeters are consistent with runtime
 384                  * variables. Some of these tests could be done at sysctl
 385                  * time, but the savings would be very limited because we
 386                  * still have to check against reg_frac_count and
 387                  * poll_each_burst. So, instead of writing separate sysctl
 388                  * handlers, we do all here.
 389                  */
 390
 391                 if (reg_frac > hz)
 392                         reg_frac = hz;
 393                 else if (reg_frac < 1)
 394                         reg_frac = 1;
 395                 if (reg_frac_count > reg_frac)
 396                         reg_frac_count = reg_frac - 1;
 397                 if (reg_frac_count-- == 0) {
 398                         arg = POLL_AND_CHECK_STATUS;
 399                         reg_frac_count = reg_frac - 1;
 400                 }
 401                 if (poll_burst_max < MIN_POLL_BURST_MAX)
 402                         poll_burst_max = MIN_POLL_BURST_MAX;
 403                 else if (poll_burst_max > MAX_POLL_BURST_MAX)
 404                         poll_burst_max = MAX_POLL_BURST_MAX;
 405
 406                 if (poll_each_burst < 1)
 407                         poll_each_burst = 1;
 408                 else if (poll_each_burst > poll_burst_max)
 409                         poll_each_burst = poll_burst_max;
 410
 411                 residual_burst = poll_burst;
 412         }
 413         cycles = (residual_burst < poll_each_burst) ?
 414                 residual_burst : poll_each_burst;
 415         residual_burst -= cycles;
 416
 417         if (polling_enabled) {
 418                 for (i = 0 ; i < poll_handlers ; i++) {
 419                         struct pollrec *p = &pr[i];
 420                         if ((p->ifp->if_flags & (IFF_UP|IFF_RUNNING|IFF_POLLING)) == (IFF_UP|IFF_RUNNING|IFF_POLLING)) {
 421                                 if (lwkt_serialize_try(p->ifp->if_serializer)) {
 422                                         p->ifp->if_poll(p->ifp, arg, cycles);
 423                                         lwkt_serialize_exit(p->ifp->if_serializer);
 424                                 }
 425                         }
 426                 }
 427         } else {        /* unregister */
 428                 for (i = 0 ; i < poll_handlers ; i++) {
 429                         struct pollrec *p = &pr[i];
 430                         if ((p->ifp->if_flags & IFF_POLLING) == 0)
 431                                 continue;
 432                         /*
 433                          * Only call the interface deregistration
 434                          * function if the interface is still
 435                          * running.
 436                          */
 437                         lwkt_serialize_enter(p->ifp->if_serializer);
 438                         p->ifp->if_flags &= ~IFF_POLLING;
 439                         if (p->ifp->if_flags & IFF_RUNNING)
 440                                 p->ifp->if_poll(p->ifp, POLL_DEREGISTER, 1);
 441                         lwkt_serialize_exit(p->ifp->if_serializer);
 442                 }
 443                 residual_burst = 0;
 444                 poll_handlers = 0;
 445         }
 446         schednetisr(NETISR_POLLMORE);
 447         phase = 4;
 448         crit_exit();
 449         return(EASYNC);
 450 }
 451
 452 /*
 453  * Try to register routine for polling. Returns 1 if successful
 454  * (and polling should be enabled), 0 otherwise.
 455  *
 456  * Called from mainline code only, not called from an interrupt.
 457  */
 458 int
 459 ether_poll_register(struct ifnet *ifp)
 460 {
 461         int rc;
 462
 463         if (polling_enabled == 0) /* polling disabled, cannot register */
 464                 return 0;
 465         if ((ifp->if_flags & IFF_UP) == 0)      /* must be up           */
 466                 return 0;
 467         if (ifp->if_flags & IFF_POLLING)        /* already polling      */
 468                 return 0;
 469         if (ifp->if_poll == NULL)               /* no polling support   */
 470                 return 0;
 471
 472         /*
 473          * Attempt to register.  Interlock with IFF_POLLING.
 474          */
 475         crit_enter();   /* XXX MP - not mp safe */
 476         lwkt_serialize_enter(ifp->if_serializer);
 477         ifp->if_flags |= IFF_POLLING;
 478         ifp->if_poll(ifp, POLL_REGISTER, 0);
 479         lwkt_serialize_exit(ifp->if_serializer);
 480         if ((ifp->if_flags & IFF_POLLING) == 0) {
 481                 crit_exit();
 482                 return 0;
 483         }
 484
 485         /*
 486          * Check if there is room.  If there isn't, deregister.
 487          */
 488         if (poll_handlers >= POLL_LIST_LEN) {
 489                 /*
 490                  * List full, cannot register more entries.
 491                  * This should never happen; if it does, it is probably a
 492                  * broken driver trying to register multiple times. Checking
 493                  * this at runtime is expensive, and won't solve the problem
 494                  * anyways, so just report a few times and then give up.
 495                  */
 496                 static int verbose = 10 ;
 497                 if (verbose >0) {
 498                         kprintf("poll handlers list full, "
 499                                 "maybe a broken driver ?\n");
 500                         verbose--;
 501                 }
 502                 ifp->if_flags &= ~IFF_POLLING;
 503                 lwkt_serialize_enter(ifp->if_serializer);
 504                 ifp->if_poll(ifp, POLL_DEREGISTER, 0);
 505                 lwkt_serialize_exit(ifp->if_serializer);
 506                 rc = 0;
 507         } else {
 508                 pr[poll_handlers].ifp = ifp;
 509                 poll_handlers++;
 510                 rc = 1;
 511         }
 512         crit_exit();
 513         return (rc);
 514 }
 515
 516 /*
 517  * Remove interface from the polling list.  Occurs when polling is turned
 518  * off.  Called from mainline code only, not called from an interrupt.
 519  */
 520 int
 521 ether_poll_deregister(struct ifnet *ifp)
 522 {
 523         int i;
 524
 525         crit_enter();
 526         if (ifp == NULL || (ifp->if_flags & IFF_POLLING) == 0) {
 527                 crit_exit();
 528                 return 0;
 529         }
 530         for (i = 0 ; i < poll_handlers ; i++) {
 531                 if (pr[i].ifp == ifp) /* found it */
 532                         break;
 533         }
 534         ifp->if_flags &= ~IFF_POLLING; /* found or not... */
 535         if (i == poll_handlers) {
 536                 crit_exit();
 537                 kprintf("ether_poll_deregister: ifp not found!!!\n");
 538                 return 0;
 539         }
 540         poll_handlers--;
 541         if (i < poll_handlers) { /* Last entry replaces this one. */
 542                 pr[i].ifp = pr[poll_handlers].ifp;
 543         }
 544         crit_exit();
 545
 546         /*
 547          * Only call the deregistration function if the interface is still
 548          * in a run state.
 549          */
 550         if (ifp->if_flags & IFF_RUNNING) {
 551                 lwkt_serialize_enter(ifp->if_serializer);
 552                 ifp->if_poll(ifp, POLL_DEREGISTER, 1);
 553                 lwkt_serialize_exit(ifp->if_serializer);
 554         }
 555         return (1);
 556 }
 557
 558 void
 559 emergency_poll_enable(const char *name)
 560 {
 561         if (polling_enabled == 0) {
 562                 polling_enabled = 1;
 563                 kprintf("%s forced polling on\n", name);
 564         }
 565 }