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.31 2007/09/09 05:11:28 sephe 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 void netisr_poll(struct netmsg *);
  49 static void 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, IFF_RUNNING and IFF_POLLING', the last one only if IFF_RUNNING
  75  * is set.
  76  *
  77  * The count limit specifies how much work the handler can do during the
  78  * call -- typically this is the number of packets to be received, or
  79  * transmitted, etc. (drivers are free to interpret this number, as long
  80  * as the max time spent in the function grows roughly linearly with the
  81  * count).
  82  *
  83  * Deregistration can be requested by the driver itself (typically in the
  84  * *_stop() routine), or by the polling code, by invoking the handler.
  85  *
  86  * Polling can be globally enabled or disabled with the sysctl variable
  87  * kern.polling.enable (default is 0, disabled)
  88  *
  89  * A second variable controls the sharing of CPU between polling/kernel
  90  * network processing, and other activities (typically userlevel tasks):
  91  * kern.polling.user_frac (between 0 and 100, default 50) sets the share
  92  * of CPU allocated to user tasks. CPU is allocated proportionally to the
  93  * shares, by dynamically adjusting the "count" (poll_burst).
  94  *
  95  * Other parameters can should be left to their default values.
  96  * The following constraints hold
  97  *
  98  *      1 <= poll_each_burst <= poll_burst <= poll_burst_max
  99  *      MIN_POLL_BURST_MAX <= poll_burst_max <= MAX_POLL_BURST_MAX
 100  */
 101
 102 #define MIN_POLL_BURST_MAX      10
 103 #define MAX_POLL_BURST_MAX      1000
 104
 105 #ifndef DEVICE_POLLING_FREQ_MAX
 106 #define DEVICE_POLLING_FREQ_MAX         30000
 107 #endif
 108 #define DEVICE_POLLING_FREQ_DEFAULT     2000
 109
 110 SYSCTL_NODE(_kern, OID_AUTO, polling, CTLFLAG_RW, 0,
 111         "Device polling parameters");
 112
 113 static u_int32_t poll_burst = 5;
 114 SYSCTL_UINT(_kern_polling, OID_AUTO, burst, CTLFLAG_RW,
 115         &poll_burst, 0, "Current polling burst size");
 116
 117 static u_int32_t poll_each_burst = 5;
 118 SYSCTL_UINT(_kern_polling, OID_AUTO, each_burst, CTLFLAG_RW,
 119         &poll_each_burst, 0, "Max size of each burst");
 120
 121 static u_int32_t poll_burst_max = 150;  /* good for 100Mbit net and HZ=1000 */
 122 SYSCTL_UINT(_kern_polling, OID_AUTO, burst_max, CTLFLAG_RW,
 123         &poll_burst_max, 0, "Max Polling burst size");
 124
 125 static u_int32_t user_frac = 50;
 126 SYSCTL_UINT(_kern_polling, OID_AUTO, user_frac, CTLFLAG_RW,
 127         &user_frac, 0, "Desired user fraction of cpu time");
 128
 129 static u_int32_t reg_frac = 20 ;
 130 SYSCTL_UINT(_kern_polling, OID_AUTO, reg_frac, CTLFLAG_RW,
 131         &reg_frac, 0, "Every this many cycles poll register");
 132
 133 static u_int32_t short_ticks;
 134 SYSCTL_UINT(_kern_polling, OID_AUTO, short_ticks, CTLFLAG_RW,
 135         &short_ticks, 0, "Hardclock ticks shorter than they should be");
 136
 137 static u_int32_t lost_polls;
 138 SYSCTL_UINT(_kern_polling, OID_AUTO, lost_polls, CTLFLAG_RW,
 139         &lost_polls, 0, "How many times we would have lost a poll tick");
 140
 141 static u_int32_t pending_polls;
 142 SYSCTL_UINT(_kern_polling, OID_AUTO, pending_polls, CTLFLAG_RD,
 143         &pending_polls, 0, "Do we need to poll again");
 144
 145 static int residual_burst = 0;
 146 SYSCTL_INT(_kern_polling, OID_AUTO, residual_burst, CTLFLAG_RW,
 147         &residual_burst, 0, "# of residual cycles in burst");
 148
 149 static u_int32_t poll_handlers; /* next free entry in pr[]. */
 150 SYSCTL_UINT(_kern_polling, OID_AUTO, handlers, CTLFLAG_RD,
 151         &poll_handlers, 0, "Number of registered poll handlers");
 152
 153 static int polling_enabled = 0;         /* global polling enable */
 154 TUNABLE_INT("kern.polling.enable", &polling_enabled);
 155 SYSCTL_PROC(_kern_polling, OID_AUTO, enable, CTLTYPE_INT | CTLFLAG_RW,
 156         0, 0, sysctl_polling, "I", "Polling enabled");
 157
 158 static u_int32_t phase;
 159 SYSCTL_UINT(_kern_polling, OID_AUTO, phase, CTLFLAG_RD,
 160         &phase, 0, "Polling phase");
 161
 162 static u_int32_t suspect;
 163 SYSCTL_UINT(_kern_polling, OID_AUTO, suspect, CTLFLAG_RW,
 164         &suspect, 0, "suspect event");
 165
 166 static u_int32_t stalled;
 167 SYSCTL_UINT(_kern_polling, OID_AUTO, stalled, CTLFLAG_RW,
 168         &stalled, 0, "potential stalls");
 169
 170 static int pollhz = DEVICE_POLLING_FREQ_DEFAULT;
 171 TUNABLE_INT("kern.polling.pollhz", &pollhz);
 172 SYSCTL_PROC(_kern_polling, OID_AUTO, pollhz, CTLTYPE_INT | CTLFLAG_RW,
 173             0, 0, sysctl_pollhz, "I", "Device polling frequency");
 174
 175 #define POLL_LIST_LEN  128
 176 struct pollrec {
 177         struct ifnet    *ifp;
 178 };
 179
 180 static struct pollrec pr[POLL_LIST_LEN];
 181 static struct systimer gd0_pollclock;
 182
 183 /*
 184  * register relevant netisr. Called from kern_clock.c:
 185  */
 186 void
 187 init_device_poll(void)
 188 {
 189         netisr_register(NETISR_POLL, cpu0_portfn, netisr_poll);
 190         netisr_register(NETISR_POLLMORE, cpu0_portfn, netisr_pollmore);
 191         systimer_init_periodic_nq(&gd0_pollclock, pollclock, NULL,
 192                                   polling_enabled ? pollhz : 1);
 193 }
 194
 195 /*
 196  * Set the polling frequency
 197  */
 198 static int
 199 sysctl_pollhz(SYSCTL_HANDLER_ARGS)
 200 {
 201         int error, phz;
 202
 203         phz = pollhz;
 204         error = sysctl_handle_int(oidp, &phz, 0, req);
 205         if (error || req->newptr == NULL)
 206                 return error;
 207         if (phz <= 0)
 208                 return EINVAL;
 209         else if (phz > DEVICE_POLLING_FREQ_MAX)
 210                 phz = DEVICE_POLLING_FREQ_MAX;
 211
 212         crit_enter();
 213         pollhz = phz;
 214         if (polling_enabled)
 215                 systimer_adjust_periodic(&gd0_pollclock, phz);
 216         crit_exit();
 217         return 0;
 218 }
 219
 220 /*
 221  * Master enable.  If polling is disabled, cut the polling systimer
 222  * frequency to 1hz.
 223  */
 224 static int
 225 sysctl_polling(SYSCTL_HANDLER_ARGS)
 226 {
 227         int error, enabled;
 228
 229         enabled = polling_enabled;
 230         error = sysctl_handle_int(oidp, &enabled, 0, req);
 231         if (error || req->newptr == NULL)
 232                 return error;
 233         polling_enabled = enabled;
 234         if (polling_enabled)
 235                 systimer_adjust_periodic(&gd0_pollclock, pollhz);
 236         else
 237                 systimer_adjust_periodic(&gd0_pollclock, 1);
 238         return 0;
 239 }
 240
 241 /*
 242  * Hook from hardclock. Tries to schedule a netisr, but keeps track
 243  * of lost ticks due to the previous handler taking too long.
 244  * Normally, this should not happen, because polling handler should
 245  * run for a short time. However, in some cases (e.g. when there are
 246  * changes in link status etc.) the drivers take a very long time
 247  * (even in the order of milliseconds) to reset and reconfigure the
 248  * device, causing apparent lost polls.
 249  *
 250  * The first part of the code is just for debugging purposes, and tries
 251  * to count how often hardclock ticks are shorter than they should,
 252  * meaning either stray interrupts or delayed events.
 253  *
 254  * WARNING! called from fastint or IPI, the MP lock might not be held.
 255  */
 256 static void
 257 pollclock(systimer_t info __unused, struct intrframe *frame __unused)
 258 {
 259         static struct timeval prev_t, t;
 260         int delta;
 261
 262         if (poll_handlers == 0)
 263                 return;
 264
 265         microuptime(&t);
 266         delta = (t.tv_usec - prev_t.tv_usec) +
 267                 (t.tv_sec - prev_t.tv_sec)*1000000;
 268         if (delta * hz < 500000)
 269                 short_ticks++;
 270         else
 271                 prev_t = t;
 272
 273         if (pending_polls > 100) {
 274                 /*
 275                  * Too much, assume it has stalled (not always true
 276                  * see comment above).
 277                  */
 278                 stalled++;
 279                 pending_polls = 0;
 280                 phase = 0;
 281         }
 282
 283         if (phase <= 2) {
 284                 if (phase != 0)
 285                         suspect++;
 286                 phase = 1;
 287                 schednetisr(NETISR_POLL);
 288                 phase = 2;
 289         }
 290         if (pending_polls++ > 0)
 291                 lost_polls++;
 292 }
 293
 294 /*
 295  * netisr_pollmore is called after other netisr's, possibly scheduling
 296  * another NETISR_POLL call, or adapting the burst size for the next cycle.
 297  *
 298  * It is very bad to fetch large bursts of packets from a single card at once,
 299  * because the burst could take a long time to be completely processed, or
 300  * could saturate the intermediate queue (ipintrq or similar) leading to
 301  * losses or unfairness. To reduce the problem, and also to account better for
 302  * time spent in network-related processing, we split the burst in smaller
 303  * chunks of fixed size, giving control to the other netisr's between chunks.
 304  * This helps in improving the fairness, reducing livelock (because we
 305  * emulate more closely the "process to completion" that we have with
 306  * fastforwarding) and accounting for the work performed in low level
 307  * handling and forwarding.
 308  */
 309
 310 static struct timeval poll_start_t;
 311
 312 /* ARGSUSED */
 313 static void
 314 netisr_pollmore(struct netmsg *msg)
 315 {
 316         struct timeval t;
 317         int kern_load;
 318
 319         crit_enter();
 320         lwkt_replymsg(&msg->nm_lmsg, 0);
 321         phase = 5;
 322         if (residual_burst > 0) {
 323                 schednetisr(NETISR_POLL);
 324                 /* will run immediately on return, followed by netisrs */
 325                 goto out;
 326         }
 327         /* here we can account time spent in netisr's in this tick */
 328         microuptime(&t);
 329         kern_load = (t.tv_usec - poll_start_t.tv_usec) +
 330                 (t.tv_sec - poll_start_t.tv_sec)*1000000;       /* us */
 331         kern_load = (kern_load * hz) / 10000;                   /* 0..100 */
 332         if (kern_load > (100 - user_frac)) { /* try decrease ticks */
 333                 if (poll_burst > 1)
 334                         poll_burst--;
 335         } else {
 336                 if (poll_burst < poll_burst_max)
 337                         poll_burst++;
 338         }
 339
 340         pending_polls--;
 341         if (pending_polls == 0) {       /* we are done */
 342                 phase = 0;
 343         } else {
 344                 /*
 345                  * Last cycle was long and caused us to miss one or more
 346                  * hardclock ticks. Restart processing again, but slightly
 347                  * reduce the burst size to prevent that this happens again.
 348                  */
 349                 poll_burst -= (poll_burst / 8);
 350                 if (poll_burst < 1)
 351                         poll_burst = 1;
 352                 schednetisr(NETISR_POLL);
 353                 phase = 6;
 354         }
 355 out:
 356         crit_exit();
 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 void
 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 ifnet *ifp = pr[i].ifp;
 420
 421                         if ((ifp->if_flags & (IFF_UP|IFF_RUNNING|IFF_POLLING))
 422                             == (IFF_UP|IFF_RUNNING|IFF_POLLING)) {
 423                                 if (lwkt_serialize_try(ifp->if_serializer)) {
 424                                         ifp->if_poll(ifp, arg, cycles);
 425                                         lwkt_serialize_exit(ifp->if_serializer);
 426                                 }
 427                         }
 428                 }
 429         } else {        /* unregister */
 430                 for (i = 0 ; i < poll_handlers ; i++) {
 431                         struct ifnet *ifp = pr[i].ifp;
 432
 433                         if ((ifp->if_flags & IFF_POLLING) == 0)
 434                                 continue;
 435                         /*
 436                          * Only call the interface deregistration
 437                          * function if the interface is still
 438                          * running.
 439                          */
 440                         lwkt_serialize_enter(ifp->if_serializer);
 441                         ifp->if_flags &= ~IFF_POLLING;
 442                         if (ifp->if_flags & IFF_RUNNING)
 443                                 ifp->if_poll(ifp, POLL_DEREGISTER, 1);
 444                         lwkt_serialize_exit(ifp->if_serializer);
 445                 }
 446                 residual_burst = 0;
 447                 poll_handlers = 0;
 448         }
 449         schednetisr(NETISR_POLLMORE);
 450         phase = 4;
 451         crit_exit();
 452 }
 453
 454 /*
 455  * Try to register routine for polling. Returns 1 if successful
 456  * (and polling should be enabled), 0 otherwise.
 457  *
 458  * Called from mainline code only, not called from an interrupt.
 459  */
 460 int
 461 ether_poll_register(struct ifnet *ifp)
 462 {
 463         int rc;
 464
 465         if (polling_enabled == 0) /* polling disabled, cannot register */
 466                 return 0;
 467         if ((ifp->if_flags & IFF_UP) == 0)      /* must be up           */
 468                 return 0;
 469         if (ifp->if_flags & IFF_POLLING)        /* already polling      */
 470                 return 0;
 471         if (ifp->if_poll == NULL)               /* no polling support   */
 472                 return 0;
 473
 474         /*
 475          * Attempt to register.  Interlock with IFF_POLLING.
 476          */
 477         crit_enter();   /* XXX MP - not mp safe */
 478         lwkt_serialize_enter(ifp->if_serializer);
 479         ifp->if_flags |= IFF_POLLING;
 480         ifp->if_poll(ifp, POLL_REGISTER, 0);
 481         lwkt_serialize_exit(ifp->if_serializer);
 482         if ((ifp->if_flags & IFF_POLLING) == 0) {
 483                 crit_exit();
 484                 return 0;
 485         }
 486
 487         /*
 488          * Check if there is room.  If there isn't, deregister.
 489          */
 490         if (poll_handlers >= POLL_LIST_LEN) {
 491                 /*
 492                  * List full, cannot register more entries.
 493                  * This should never happen; if it does, it is probably a
 494                  * broken driver trying to register multiple times. Checking
 495                  * this at runtime is expensive, and won't solve the problem
 496                  * anyways, so just report a few times and then give up.
 497                  */
 498                 static int verbose = 10 ;
 499                 if (verbose >0) {
 500                         kprintf("poll handlers list full, "
 501                                 "maybe a broken driver ?\n");
 502                         verbose--;
 503                 }
 504                 ifp->if_flags &= ~IFF_POLLING;
 505                 lwkt_serialize_enter(ifp->if_serializer);
 506                 ifp->if_poll(ifp, POLL_DEREGISTER, 0);
 507                 lwkt_serialize_exit(ifp->if_serializer);
 508                 rc = 0;
 509         } else {
 510                 pr[poll_handlers].ifp = ifp;
 511                 poll_handlers++;
 512                 rc = 1;
 513         }
 514         crit_exit();
 515         return (rc);
 516 }
 517
 518 /*
 519  * Remove interface from the polling list.  Occurs when polling is turned
 520  * off.  Called from mainline code only, not called from an interrupt.
 521  */
 522 int
 523 ether_poll_deregister(struct ifnet *ifp)
 524 {
 525         int i;
 526
 527         KKASSERT(ifp != NULL);
 528
 529         crit_enter();
 530         if ((ifp->if_flags & IFF_POLLING) == 0) {
 531                 crit_exit();
 532                 return 0;
 533         }
 534         for (i = 0 ; i < poll_handlers ; i++) {
 535                 if (pr[i].ifp == ifp) /* found it */
 536                         break;
 537         }
 538         ifp->if_flags &= ~IFF_POLLING; /* found or not... */
 539         if (i == poll_handlers) {
 540                 crit_exit();
 541                 kprintf("ether_poll_deregister: ifp not found!!!\n");
 542                 return 0;
 543         }
 544         poll_handlers--;
 545         if (i < poll_handlers) { /* Last entry replaces this one. */
 546                 pr[i].ifp = pr[poll_handlers].ifp;
 547         }
 548         crit_exit();
 549
 550         /*
 551          * Only call the deregistration function if the interface is still
 552          * in a run state.
 553          */
 554         if (ifp->if_flags & IFF_RUNNING) {
 555                 lwkt_serialize_enter(ifp->if_serializer);
 556                 ifp->if_poll(ifp, POLL_DEREGISTER, 1);
 557                 lwkt_serialize_exit(ifp->if_serializer);
 558         }
 559         return (1);
 560 }