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.43 2007/11/16 05:07:36 sephe Exp $
  29  */
  30
  31 #include "opt_polling.h"
  32
  33 #include <sys/param.h>
  34 #include <sys/kernel.h>
  35 #include <sys/socket.h>                 /* needed by net/if.h           */
  36 #include <sys/sysctl.h>
  37
  38 #include <sys/thread2.h>
  39 #include <sys/msgport2.h>
  40
  41 #include <net/if.h>                     /* for IFF_* flags              */
  42 #include <net/netmsg2.h>
  43
  44 /*
  45  * Polling support for [network] device drivers.
  46  *
  47  * Drivers which support this feature try to register with the
  48  * polling code.
  49  *
  50  * If registration is successful, the driver must disable interrupts,
  51  * and further I/O is performed through the handler, which is invoked
  52  * (at least once per clock tick) with 3 arguments: the "arg" passed at
  53  * register time (a struct ifnet pointer), a command, and a "count" limit.
  54  *
  55  * The command can be one of the following:
  56  *  POLL_ONLY: quick move of "count" packets from input/output queues.
  57  *  POLL_AND_CHECK_STATUS: as above, plus check status registers or do
  58  *      other more expensive operations. This command is issued periodically
  59  *      but less frequently than POLL_ONLY.
  60  *  POLL_DEREGISTER: deregister and return to interrupt mode.
  61  *  POLL_REGISTER: register and disable interrupts
  62  *
  63  * The first two commands are only issued if the interface is marked as
  64  * 'IFF_UP, IFF_RUNNING and IFF_POLLING', the last two only if IFF_RUNNING
  65  * is set.
  66  *
  67  * The count limit specifies how much work the handler can do during the
  68  * call -- typically this is the number of packets to be received, or
  69  * transmitted, etc. (drivers are free to interpret this number, as long
  70  * as the max time spent in the function grows roughly linearly with the
  71  * count).
  72  *
  73  * Deregistration can be requested by the driver itself (typically in the
  74  * *_stop() routine), or by the polling code, by invoking the handler.
  75  *
  76  * Polling can be enabled or disabled on particular CPU_X with the sysctl
  77  * variable kern.polling.X.enable (default is 1, enabled)
  78  *
  79  * A second variable controls the sharing of CPU between polling/kernel
  80  * network processing, and other activities (typically userlevel tasks):
  81  * kern.polling.X.user_frac (between 0 and 100, default 50) sets the share
  82  * of CPU allocated to user tasks. CPU is allocated proportionally to the
  83  * shares, by dynamically adjusting the "count" (poll_burst).
  84  *
  85  * Other parameters can should be left to their default values.
  86  * The following constraints hold
  87  *
  88  *      1 <= poll_burst <= poll_burst_max
  89  *      1 <= poll_each_burst <= poll_burst_max
  90  *      MIN_POLL_BURST_MAX <= poll_burst_max <= MAX_POLL_BURST_MAX
  91  */
  92
  93 #define MIN_POLL_BURST_MAX      10
  94 #define MAX_POLL_BURST_MAX      1000
  95
  96 #ifndef DEVICE_POLLING_FREQ_MAX
  97 #define DEVICE_POLLING_FREQ_MAX         30000
  98 #endif
  99 #define DEVICE_POLLING_FREQ_DEFAULT     2000
 100
 101 #define POLL_LIST_LEN  128
 102 struct pollrec {
 103         struct ifnet    *ifp;
 104 };
 105
 106 #define POLLCTX_MAX     32
 107
 108 struct pollctx {
 109         struct sysctl_ctx_list  poll_sysctl_ctx;
 110         struct sysctl_oid       *poll_sysctl_tree;
 111
 112         uint32_t                poll_burst;             /* state */
 113         uint32_t                poll_each_burst;        /* tunable */
 114         uint32_t                poll_burst_max;         /* tunable */
 115         uint32_t                user_frac;              /* tunable */
 116         int                     reg_frac_count;         /* state */
 117         uint32_t                reg_frac;               /* tunable */
 118         uint32_t                short_ticks;            /* statistics */
 119         uint32_t                lost_polls;             /* statistics */
 120         uint32_t                pending_polls;          /* state */
 121         int                     residual_burst;         /* state */
 122         uint32_t                phase;                  /* state */
 123         uint32_t                suspect;                /* statistics */
 124         uint32_t                stalled;                /* statistics */
 125         struct timeval          poll_start_t;           /* state */
 126         struct timeval          prev_t;                 /* state */
 127
 128         uint32_t                poll_handlers; /* next free entry in pr[]. */
 129         struct pollrec          pr[POLL_LIST_LEN];
 130
 131         int                     poll_cpuid;
 132         struct systimer         pollclock;
 133         int                     polling_enabled;        /* tunable */
 134         int                     pollhz;                 /* tunable */
 135
 136         struct netmsg           poll_netmsg;
 137         struct netmsg           poll_more_netmsg;
 138 };
 139
 140 static struct pollctx   *poll_context[POLLCTX_MAX];
 141
 142 SYSCTL_NODE(_kern, OID_AUTO, polling, CTLFLAG_RW, 0,
 143         "Device polling parameters");
 144
 145 static int      poll_defcpu = -1;
 146 SYSCTL_INT(_kern_polling, OID_AUTO, defcpu, CTLFLAG_RD,
 147         &poll_defcpu, 0, "default CPU to run device polling");
 148
 149 static uint32_t poll_cpumask0 = 0xffffffff;
 150 TUNABLE_INT("kern.polling.cpumask", (int *)&poll_cpumask0);
 151
 152 static uint32_t poll_cpumask;
 153 SYSCTL_INT(_kern_polling, OID_AUTO, cpumask, CTLFLAG_RD,
 154         &poll_cpumask, 0, "CPUs that can run device polling");
 155
 156 static int      polling_enabled = 1;    /* global polling enable */
 157 TUNABLE_INT("kern.polling.enable", &polling_enabled);
 158
 159 static int      pollhz = DEVICE_POLLING_FREQ_DEFAULT;
 160 TUNABLE_INT("kern.polling.pollhz", &pollhz);
 161
 162 /* Netisr handlers */
 163 static void     netisr_poll(struct netmsg *);
 164 static void     netisr_pollmore(struct netmsg *);
 165 static void     poll_register(struct netmsg *);
 166 static void     poll_deregister(struct netmsg *);
 167 static void     poll_sysctl_pollhz(struct netmsg *);
 168 static void     poll_sysctl_polling(struct netmsg *);
 169 static void     poll_sysctl_regfrac(struct netmsg *);
 170 static void     poll_sysctl_burstmax(struct netmsg *);
 171 static void     poll_sysctl_eachburst(struct netmsg *);
 172
 173 /* Systimer handler */
 174 static void     pollclock(systimer_t, struct intrframe *);
 175
 176 /* Sysctl handlers */
 177 static int      sysctl_pollhz(SYSCTL_HANDLER_ARGS);
 178 static int      sysctl_polling(SYSCTL_HANDLER_ARGS);
 179 static int      sysctl_regfrac(SYSCTL_HANDLER_ARGS);
 180 static int      sysctl_burstmax(SYSCTL_HANDLER_ARGS);
 181 static int      sysctl_eachburst(SYSCTL_HANDLER_ARGS);
 182 static void     poll_add_sysctl(struct sysctl_ctx_list *,
 183                                 struct sysctl_oid_list *, struct pollctx *);
 184
 185 static void     schedpoll_oncpu(struct pollctx *, struct netmsg *, netisr_fn_t);
 186
 187 void            init_device_poll_pcpu(int);     /* per-cpu init routine */
 188
 189 static __inline void
 190 poll_reset_state(struct pollctx *pctx)
 191 {
 192         crit_enter();
 193         pctx->poll_burst = 5;
 194         pctx->reg_frac_count = 0;
 195         pctx->pending_polls = 0;
 196         pctx->residual_burst = 0;
 197         pctx->phase = 0;
 198         bzero(&pctx->poll_start_t, sizeof(pctx->poll_start_t));
 199         bzero(&pctx->prev_t, sizeof(pctx->prev_t));
 200         crit_exit();
 201 }
 202
 203 /*
 204  * Initialize per-cpu polling(4) context.  Called from kern_clock.c:
 205  */
 206 void
 207 init_device_poll_pcpu(int cpuid)
 208 {
 209         struct pollctx *pctx;
 210         char cpuid_str[3];
 211
 212         if (cpuid >= POLLCTX_MAX)
 213                 return;
 214
 215         if (((1 << cpuid) & poll_cpumask0) == 0)
 216                 return;
 217
 218         poll_cpumask |= (1 << cpuid);
 219
 220         pctx = kmalloc(sizeof(*pctx), M_DEVBUF, M_WAITOK | M_ZERO);
 221
 222         pctx->poll_each_burst = 5;
 223         pctx->poll_burst_max = 150; /* good for 100Mbit net and HZ=1000 */
 224         pctx->user_frac = 50;
 225         pctx->reg_frac = 20;
 226         pctx->polling_enabled = polling_enabled;
 227         pctx->pollhz = pollhz;
 228         pctx->poll_cpuid = cpuid;
 229         netmsg_init(&pctx->poll_netmsg, &netisr_adone_rport, 0, NULL);
 230         netmsg_init(&pctx->poll_more_netmsg, &netisr_adone_rport, 0, NULL);
 231         poll_reset_state(pctx);
 232
 233         KASSERT(cpuid < POLLCTX_MAX, ("cpu id must < %d", cpuid));
 234         poll_context[cpuid] = pctx;
 235
 236         if (poll_defcpu < 0) {
 237                 poll_defcpu = cpuid;
 238
 239                 /*
 240                  * Initialize global sysctl nodes, for compat
 241                  */
 242                 poll_add_sysctl(NULL, SYSCTL_STATIC_CHILDREN(_kern_polling),
 243                                 pctx);
 244         }
 245
 246         /*
 247          * Initialize per-cpu sysctl nodes
 248          */
 249         ksnprintf(cpuid_str, sizeof(cpuid_str), "%d", pctx->poll_cpuid);
 250
 251         sysctl_ctx_init(&pctx->poll_sysctl_ctx);
 252         pctx->poll_sysctl_tree = SYSCTL_ADD_NODE(&pctx->poll_sysctl_ctx,
 253                                  SYSCTL_STATIC_CHILDREN(_kern_polling),
 254                                  OID_AUTO, cpuid_str, CTLFLAG_RD, 0, "");
 255         poll_add_sysctl(&pctx->poll_sysctl_ctx,
 256                         SYSCTL_CHILDREN(pctx->poll_sysctl_tree), pctx);
 257
 258         /*
 259          * Initialize systimer
 260          */
 261         systimer_init_periodic_nq(&pctx->pollclock, pollclock, pctx, 1);
 262 }
 263
 264 static __inline void
 265 schedpoll(struct pollctx *pctx)
 266 {
 267         crit_enter();
 268         schedpoll_oncpu(pctx, &pctx->poll_netmsg, netisr_poll);
 269         crit_exit();
 270 }
 271
 272 static __inline void
 273 schedpollmore(struct pollctx *pctx)
 274 {
 275         schedpoll_oncpu(pctx, &pctx->poll_more_netmsg, netisr_pollmore);
 276 }
 277
 278 /*
 279  * Set the polling frequency
 280  */
 281 static int
 282 sysctl_pollhz(SYSCTL_HANDLER_ARGS)
 283 {
 284         struct pollctx *pctx = arg1;
 285         struct netmsg msg;
 286         lwkt_port_t port;
 287         int error, phz;
 288
 289         phz = pctx->pollhz;
 290         error = sysctl_handle_int(oidp, &phz, 0, req);
 291         if (error || req->newptr == NULL)
 292                 return error;
 293         if (phz <= 0)
 294                 return EINVAL;
 295         else if (phz > DEVICE_POLLING_FREQ_MAX)
 296                 phz = DEVICE_POLLING_FREQ_MAX;
 297
 298         netmsg_init(&msg, &curthread->td_msgport, 0, poll_sysctl_pollhz);
 299         msg.nm_lmsg.u.ms_result = phz;
 300
 301         port = cpu_portfn(pctx->poll_cpuid);
 302         lwkt_domsg(port, &msg.nm_lmsg, 0);
 303         return 0;
 304 }
 305
 306 /*
 307  * Master enable.
 308  */
 309 static int
 310 sysctl_polling(SYSCTL_HANDLER_ARGS)
 311 {
 312         struct pollctx *pctx = arg1;
 313         struct netmsg msg;
 314         lwkt_port_t port;
 315         int error, enabled;
 316
 317         enabled = pctx->polling_enabled;
 318         error = sysctl_handle_int(oidp, &enabled, 0, req);
 319         if (error || req->newptr == NULL)
 320                 return error;
 321
 322         netmsg_init(&msg, &curthread->td_msgport, 0, poll_sysctl_polling);
 323         msg.nm_lmsg.u.ms_result = enabled;
 324
 325         port = cpu_portfn(pctx->poll_cpuid);
 326         lwkt_domsg(port, &msg.nm_lmsg, 0);
 327         return 0;
 328 }
 329
 330 static int
 331 sysctl_regfrac(SYSCTL_HANDLER_ARGS)
 332 {
 333         struct pollctx *pctx = arg1;
 334         struct netmsg msg;
 335         lwkt_port_t port;
 336         uint32_t reg_frac;
 337         int error;
 338
 339         reg_frac = pctx->reg_frac;
 340         error = sysctl_handle_int(oidp, &reg_frac, 0, req);
 341         if (error || req->newptr == NULL)
 342                 return error;
 343
 344         netmsg_init(&msg, &curthread->td_msgport, 0, poll_sysctl_regfrac);
 345         msg.nm_lmsg.u.ms_result = reg_frac;
 346
 347         port = cpu_portfn(pctx->poll_cpuid);
 348         lwkt_domsg(port, &msg.nm_lmsg, 0);
 349         return 0;
 350 }
 351
 352 static int
 353 sysctl_burstmax(SYSCTL_HANDLER_ARGS)
 354 {
 355         struct pollctx *pctx = arg1;
 356         struct netmsg msg;
 357         lwkt_port_t port;
 358         uint32_t burst_max;
 359         int error;
 360
 361         burst_max = pctx->poll_burst_max;
 362         error = sysctl_handle_int(oidp, &burst_max, 0, req);
 363         if (error || req->newptr == NULL)
 364                 return error;
 365         if (burst_max < MIN_POLL_BURST_MAX)
 366                 burst_max = MIN_POLL_BURST_MAX;
 367         else if (burst_max > MAX_POLL_BURST_MAX)
 368                 burst_max = MAX_POLL_BURST_MAX;
 369
 370         netmsg_init(&msg, &curthread->td_msgport, 0, poll_sysctl_burstmax);
 371         msg.nm_lmsg.u.ms_result = burst_max;
 372
 373         port = cpu_portfn(pctx->poll_cpuid);
 374         lwkt_domsg(port, &msg.nm_lmsg, 0);
 375         return 0;
 376 }
 377
 378 static int
 379 sysctl_eachburst(SYSCTL_HANDLER_ARGS)
 380 {
 381         struct pollctx *pctx = arg1;
 382         struct netmsg msg;
 383         lwkt_port_t port;
 384         uint32_t each_burst;
 385         int error;
 386
 387         each_burst = pctx->poll_each_burst;
 388         error = sysctl_handle_int(oidp, &each_burst, 0, req);
 389         if (error || req->newptr == NULL)
 390                 return error;
 391
 392         netmsg_init(&msg, &curthread->td_msgport, 0, poll_sysctl_eachburst);
 393         msg.nm_lmsg.u.ms_result = each_burst;
 394
 395         port = cpu_portfn(pctx->poll_cpuid);
 396         lwkt_domsg(port, &msg.nm_lmsg, 0);
 397         return 0;
 398 }
 399
 400 /*
 401  * Hook from polling systimer. Tries to schedule a netisr, but keeps
 402  * track of lost ticks due to the previous handler taking too long.
 403  * Normally, this should not happen, because polling handler should
 404  * run for a short time. However, in some cases (e.g. when there are
 405  * changes in link status etc.) the drivers take a very long time
 406  * (even in the order of milliseconds) to reset and reconfigure the
 407  * device, causing apparent lost polls.
 408  *
 409  * The first part of the code is just for debugging purposes, and tries
 410  * to count how often hardclock ticks are shorter than they should,
 411  * meaning either stray interrupts or delayed events.
 412  *
 413  * WARNING! called from fastint or IPI, the MP lock might not be held.
 414  */
 415 static void
 416 pollclock(systimer_t info, struct intrframe *frame __unused)
 417 {
 418         struct pollctx *pctx = info->data;
 419         struct timeval t;
 420         int delta;
 421
 422         if (pctx->poll_handlers == 0)
 423                 return;
 424
 425         microuptime(&t);
 426         delta = (t.tv_usec - pctx->prev_t.tv_usec) +
 427                 (t.tv_sec - pctx->prev_t.tv_sec)*1000000;
 428         if (delta * pctx->pollhz < 500000)
 429                 pctx->short_ticks++;
 430         else
 431                 pctx->prev_t = t;
 432
 433         if (pctx->pending_polls > 100) {
 434                 /*
 435                  * Too much, assume it has stalled (not always true
 436                  * see comment above).
 437                  */
 438                 pctx->stalled++;
 439                 pctx->pending_polls = 0;
 440                 pctx->phase = 0;
 441         }
 442
 443         if (pctx->phase <= 2) {
 444                 if (pctx->phase != 0)
 445                         pctx->suspect++;
 446                 pctx->phase = 1;
 447                 schedpoll(pctx);
 448                 pctx->phase = 2;
 449         }
 450         if (pctx->pending_polls++ > 0)
 451                 pctx->lost_polls++;
 452 }
 453
 454 /*
 455  * netisr_pollmore is called after other netisr's, possibly scheduling
 456  * another NETISR_POLL call, or adapting the burst size for the next cycle.
 457  *
 458  * It is very bad to fetch large bursts of packets from a single card at once,
 459  * because the burst could take a long time to be completely processed leading
 460  * to unfairness. To reduce the problem, and also to account better for time
 461  * spent in network-related processing, we split the burst in smaller chunks
 462  * of fixed size, giving control to the other netisr's between chunks.  This
 463  * helps in improving the fairness, reducing livelock (because we emulate more
 464  * closely the "process to completion" that we have with fastforwarding) and
 465  * accounting for the work performed in low level handling and forwarding.
 466  */
 467
 468 /* ARGSUSED */
 469 static void
 470 netisr_pollmore(struct netmsg *msg)
 471 {
 472         struct pollctx *pctx;
 473         struct timeval t;
 474         int kern_load, cpuid;
 475         uint32_t pending_polls;
 476
 477         cpuid = mycpu->gd_cpuid;
 478         KKASSERT(cpuid < POLLCTX_MAX);
 479
 480         pctx = poll_context[cpuid];
 481         KKASSERT(pctx != NULL);
 482         KKASSERT(pctx->poll_cpuid == cpuid);
 483         KKASSERT(pctx == msg->nm_lmsg.u.ms_resultp);
 484
 485         lwkt_replymsg(&msg->nm_lmsg, 0);
 486
 487         if (pctx->poll_handlers == 0)
 488                 return;
 489
 490         KASSERT(pctx->polling_enabled,
 491                 ("# of registered poll handlers are not zero, "
 492                  "but polling is not enabled\n"));
 493
 494         pctx->phase = 5;
 495         if (pctx->residual_burst > 0) {
 496                 schedpoll(pctx);
 497                 /* will run immediately on return, followed by netisrs */
 498                 return;
 499         }
 500         /* here we can account time spent in netisr's in this tick */
 501         microuptime(&t);
 502         kern_load = (t.tv_usec - pctx->poll_start_t.tv_usec) +
 503                 (t.tv_sec - pctx->poll_start_t.tv_sec)*1000000; /* us */
 504         kern_load = (kern_load * pctx->pollhz) / 10000;         /* 0..100 */
 505         if (kern_load > (100 - pctx->user_frac)) { /* try decrease ticks */
 506                 if (pctx->poll_burst > 1)
 507                         pctx->poll_burst--;
 508         } else {
 509                 if (pctx->poll_burst < pctx->poll_burst_max)
 510                         pctx->poll_burst++;
 511         }
 512
 513         crit_enter();
 514         pctx->pending_polls--;
 515         pending_polls = pctx->pending_polls;
 516         crit_exit();
 517
 518         if (pending_polls == 0) {       /* we are done */
 519                 pctx->phase = 0;
 520         } else {
 521                 /*
 522                  * Last cycle was long and caused us to miss one or more
 523                  * hardclock ticks. Restart processing again, but slightly
 524                  * reduce the burst size to prevent that this happens again.
 525                  */
 526                 pctx->poll_burst -= (pctx->poll_burst / 8);
 527                 if (pctx->poll_burst < 1)
 528                         pctx->poll_burst = 1;
 529                 schedpoll(pctx);
 530                 pctx->phase = 6;
 531         }
 532 }
 533
 534 /*
 535  * netisr_poll is scheduled by schedpoll when appropriate, typically once
 536  * per polling systimer tick.
 537  *
 538  * Note that the message is replied immediately in order to allow a new
 539  * ISR to be scheduled in the handler.
 540  *
 541  * XXX each registration should indicate whether it needs a critical
 542  * section to operate.
 543  */
 544 /* ARGSUSED */
 545 static void
 546 netisr_poll(struct netmsg *msg)
 547 {
 548         struct pollctx *pctx;
 549         int i, cycles, cpuid;
 550         enum poll_cmd arg = POLL_ONLY;
 551
 552         cpuid = mycpu->gd_cpuid;
 553         KKASSERT(cpuid < POLLCTX_MAX);
 554
 555         pctx = poll_context[cpuid];
 556         KKASSERT(pctx != NULL);
 557         KKASSERT(pctx->poll_cpuid == cpuid);
 558         KKASSERT(pctx == msg->nm_lmsg.u.ms_resultp);
 559
 560         crit_enter();
 561         lwkt_replymsg(&msg->nm_lmsg, 0);
 562         crit_exit();
 563
 564         if (pctx->poll_handlers == 0)
 565                 return;
 566
 567         KASSERT(pctx->polling_enabled,
 568                 ("# of registered poll handlers are not zero, "
 569                  "but polling is not enabled\n"));
 570
 571         pctx->phase = 3;
 572         if (pctx->residual_burst == 0) { /* first call in this tick */
 573                 microuptime(&pctx->poll_start_t);
 574
 575                 if (pctx->reg_frac_count-- == 0) {
 576                         arg = POLL_AND_CHECK_STATUS;
 577                         pctx->reg_frac_count = pctx->reg_frac - 1;
 578                 }
 579
 580                 pctx->residual_burst = pctx->poll_burst;
 581         }
 582         cycles = (pctx->residual_burst < pctx->poll_each_burst) ?
 583                 pctx->residual_burst : pctx->poll_each_burst;
 584         pctx->residual_burst -= cycles;
 585
 586         for (i = 0 ; i < pctx->poll_handlers ; i++) {
 587                 struct ifnet *ifp = pctx->pr[i].ifp;
 588
 589                 if (!lwkt_serialize_try(ifp->if_serializer))
 590                         continue;
 591
 592                 if ((ifp->if_flags & (IFF_UP|IFF_RUNNING|IFF_POLLING))
 593                     == (IFF_UP|IFF_RUNNING|IFF_POLLING))
 594                         ifp->if_poll(ifp, arg, cycles);
 595
 596                 lwkt_serialize_exit(ifp->if_serializer);
 597         }
 598
 599         schedpollmore(pctx);
 600         pctx->phase = 4;
 601 }
 602
 603 static void
 604 poll_register(struct netmsg *msg)
 605 {
 606         struct ifnet *ifp = msg->nm_lmsg.u.ms_resultp;
 607         struct pollctx *pctx;
 608         int rc, cpuid;
 609
 610         cpuid = mycpu->gd_cpuid;
 611         KKASSERT(cpuid < POLLCTX_MAX);
 612
 613         pctx = poll_context[cpuid];
 614         KKASSERT(pctx != NULL);
 615         KKASSERT(pctx->poll_cpuid == cpuid);
 616
 617         if (pctx->polling_enabled == 0) {
 618                 /* Polling disabled, cannot register */
 619                 rc = EOPNOTSUPP;
 620                 goto back;
 621         }
 622
 623         /*
 624          * Check if there is room.
 625          */
 626         if (pctx->poll_handlers >= POLL_LIST_LEN) {
 627                 /*
 628                  * List full, cannot register more entries.
 629                  * This should never happen; if it does, it is probably a
 630                  * broken driver trying to register multiple times. Checking
 631                  * this at runtime is expensive, and won't solve the problem
 632                  * anyways, so just report a few times and then give up.
 633                  */
 634                 static int verbose = 10;        /* XXX */
 635                 if (verbose >0) {
 636                         kprintf("poll handlers list full, "
 637                                 "maybe a broken driver ?\n");
 638                         verbose--;
 639                 }
 640                 rc = ENOMEM;
 641         } else {
 642                 pctx->pr[pctx->poll_handlers].ifp = ifp;
 643                 pctx->poll_handlers++;
 644                 rc = 0;
 645
 646                 if (pctx->poll_handlers == 1) {
 647                         KKASSERT(pctx->polling_enabled);
 648                         systimer_adjust_periodic(&pctx->pollclock,
 649                                                  pctx->pollhz);
 650                 }
 651         }
 652 back:
 653         lwkt_replymsg(&msg->nm_lmsg, rc);
 654 }
 655
 656 /*
 657  * Try to register routine for polling. Returns 1 if successful
 658  * (and polling should be enabled), 0 otherwise.
 659  *
 660  * Called from mainline code only, not called from an interrupt.
 661  */
 662 int
 663 ether_poll_register(struct ifnet *ifp)
 664 {
 665         if (poll_defcpu < 0)
 666                 return 0;
 667         KKASSERT(poll_defcpu < POLLCTX_MAX);
 668
 669         return ether_pollcpu_register(ifp, poll_defcpu);
 670 }
 671
 672 int
 673 ether_pollcpu_register(struct ifnet *ifp, int cpuid)
 674 {
 675         struct netmsg msg;
 676         lwkt_port_t port;
 677         int rc;
 678
 679         if (ifp->if_poll == NULL) {
 680                 /* Device does not support polling */
 681                 return 0;
 682         }
 683
 684         if (cpuid < 0 || cpuid >= POLLCTX_MAX)
 685                 return 0;
 686
 687         if (((1 << cpuid) & poll_cpumask) == 0) {
 688                 /* Polling is not supported on 'cpuid' */
 689                 return 0;
 690         }
 691         KKASSERT(poll_context[cpuid] != NULL);
 692
 693         /*
 694          * Attempt to register.  Interlock with IFF_POLLING.
 695          */
 696         crit_enter();   /* XXX MP - not mp safe */
 697
 698         lwkt_serialize_enter(ifp->if_serializer);
 699         if (ifp->if_flags & IFF_POLLING) {
 700                 /* Already polling */
 701                 KKASSERT(ifp->if_poll_cpuid >= 0);
 702                 lwkt_serialize_exit(ifp->if_serializer);
 703                 crit_exit();
 704                 return 0;
 705         }
 706         KKASSERT(ifp->if_poll_cpuid < 0);
 707         ifp->if_flags |= IFF_POLLING;
 708         ifp->if_poll_cpuid = cpuid;
 709         if (ifp->if_flags & IFF_RUNNING)
 710                 ifp->if_poll(ifp, POLL_REGISTER, 0);
 711         lwkt_serialize_exit(ifp->if_serializer);
 712
 713         netmsg_init(&msg, &curthread->td_msgport, 0, poll_register);
 714         msg.nm_lmsg.u.ms_resultp = ifp;
 715
 716         port = cpu_portfn(cpuid);
 717         lwkt_domsg(port, &msg.nm_lmsg, 0);
 718
 719         if (msg.nm_lmsg.ms_error) {
 720                 lwkt_serialize_enter(ifp->if_serializer);
 721                 ifp->if_flags &= ~IFF_POLLING;
 722                 ifp->if_poll_cpuid = -1;
 723                 if (ifp->if_flags & IFF_RUNNING)
 724                         ifp->if_poll(ifp, POLL_DEREGISTER, 0);
 725                 lwkt_serialize_exit(ifp->if_serializer);
 726                 rc = 0;
 727         } else {
 728                 rc = 1;
 729         }
 730
 731         crit_exit();
 732         return rc;
 733 }
 734
 735 static void
 736 poll_deregister(struct netmsg *msg)
 737 {
 738         struct ifnet *ifp = msg->nm_lmsg.u.ms_resultp;
 739         struct pollctx *pctx;
 740         int rc, i, cpuid;
 741
 742         cpuid = mycpu->gd_cpuid;
 743         KKASSERT(cpuid < POLLCTX_MAX);
 744
 745         pctx = poll_context[cpuid];
 746         KKASSERT(pctx != NULL);
 747         KKASSERT(pctx->poll_cpuid == cpuid);
 748
 749         for (i = 0 ; i < pctx->poll_handlers ; i++) {
 750                 if (pctx->pr[i].ifp == ifp) /* Found it */
 751                         break;
 752         }
 753         if (i == pctx->poll_handlers) {
 754                 kprintf("ether_poll_deregister: ifp not found!!!\n");
 755                 rc = ENOENT;
 756         } else {
 757                 pctx->poll_handlers--;
 758                 if (i < pctx->poll_handlers) {
 759                         /* Last entry replaces this one. */
 760                         pctx->pr[i].ifp = pctx->pr[pctx->poll_handlers].ifp;
 761                 }
 762
 763                 if (pctx->poll_handlers == 0) {
 764                         systimer_adjust_periodic(&pctx->pollclock, 1);
 765                         poll_reset_state(pctx);
 766                 }
 767                 rc = 0;
 768         }
 769         lwkt_replymsg(&msg->nm_lmsg, rc);
 770 }
 771
 772 /*
 773  * Remove interface from the polling list.  Occurs when polling is turned
 774  * off.  Called from mainline code only, not called from an interrupt.
 775  */
 776 int
 777 ether_poll_deregister(struct ifnet *ifp)
 778 {
 779         struct netmsg msg;
 780         lwkt_port_t port;
 781         int rc, cpuid;
 782
 783         KKASSERT(ifp != NULL);
 784
 785         if (ifp->if_poll == NULL)
 786                 return 0;
 787
 788         crit_enter();
 789
 790         lwkt_serialize_enter(ifp->if_serializer);
 791         if ((ifp->if_flags & IFF_POLLING) == 0) {
 792                 KKASSERT(ifp->if_poll_cpuid < 0);
 793                 lwkt_serialize_exit(ifp->if_serializer);
 794                 crit_exit();
 795                 return 0;
 796         }
 797
 798         cpuid = ifp->if_poll_cpuid;
 799         KKASSERT(cpuid >= 0);
 800         KKASSERT(poll_context[cpuid] != NULL);
 801
 802         ifp->if_flags &= ~IFF_POLLING;
 803         ifp->if_poll_cpuid = -1;
 804         lwkt_serialize_exit(ifp->if_serializer);
 805
 806         netmsg_init(&msg, &curthread->td_msgport, 0, poll_deregister);
 807         msg.nm_lmsg.u.ms_resultp = ifp;
 808
 809         port = cpu_portfn(cpuid);
 810         lwkt_domsg(port, &msg.nm_lmsg, 0);
 811
 812         if (!msg.nm_lmsg.ms_error) {
 813                 lwkt_serialize_enter(ifp->if_serializer);
 814                 if (ifp->if_flags & IFF_RUNNING)
 815                         ifp->if_poll(ifp, POLL_DEREGISTER, 1);
 816                 lwkt_serialize_exit(ifp->if_serializer);
 817                 rc = 1;
 818         } else {
 819                 rc = 0;
 820         }
 821
 822         crit_exit();
 823         return rc;
 824 }
 825
 826 static void
 827 poll_add_sysctl(struct sysctl_ctx_list *ctx, struct sysctl_oid_list *parent,
 828                 struct pollctx *pctx)
 829 {
 830         SYSCTL_ADD_PROC(ctx, parent, OID_AUTO, "enable",
 831                         CTLTYPE_INT | CTLFLAG_RW, pctx, 0, sysctl_polling,
 832                         "I", "Polling enabled");
 833
 834         SYSCTL_ADD_PROC(ctx, parent, OID_AUTO, "pollhz",
 835                         CTLTYPE_INT | CTLFLAG_RW, pctx, 0, sysctl_pollhz,
 836                         "I", "Device polling frequency");
 837
 838         SYSCTL_ADD_PROC(ctx, parent, OID_AUTO, "reg_frac",
 839                         CTLTYPE_UINT | CTLFLAG_RW, pctx, 0, sysctl_regfrac,
 840                         "IU", "Every this many cycles poll register");
 841
 842         SYSCTL_ADD_PROC(ctx, parent, OID_AUTO, "burst_max",
 843                         CTLTYPE_UINT | CTLFLAG_RW, pctx, 0, sysctl_burstmax,
 844                         "IU", "Max Polling burst size");
 845
 846         SYSCTL_ADD_PROC(ctx, parent, OID_AUTO, "each_burst",
 847                         CTLTYPE_UINT | CTLFLAG_RW, pctx, 0, sysctl_eachburst,
 848                         "IU", "Max size of each burst");
 849
 850         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "phase", CTLFLAG_RD,
 851                         &pctx->phase, 0, "Polling phase");
 852
 853         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "suspect", CTLFLAG_RW,
 854                         &pctx->suspect, 0, "suspect event");
 855
 856         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "stalled", CTLFLAG_RW,
 857                         &pctx->stalled, 0, "potential stalls");
 858
 859         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "burst", CTLFLAG_RD,
 860                         &pctx->poll_burst, 0, "Current polling burst size");
 861
 862         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "user_frac", CTLFLAG_RW,
 863                         &pctx->user_frac, 0,
 864                         "Desired user fraction of cpu time");
 865
 866         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "short_ticks", CTLFLAG_RW,
 867                         &pctx->short_ticks, 0,
 868                         "Hardclock ticks shorter than they should be");
 869
 870         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "lost_polls", CTLFLAG_RW,
 871                         &pctx->lost_polls, 0,
 872                         "How many times we would have lost a poll tick");
 873
 874         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "pending_polls", CTLFLAG_RD,
 875                         &pctx->pending_polls, 0, "Do we need to poll again");
 876
 877         SYSCTL_ADD_INT(ctx, parent, OID_AUTO, "residual_burst", CTLFLAG_RD,
 878                        &pctx->residual_burst, 0,
 879                        "# of residual cycles in burst");
 880
 881         SYSCTL_ADD_UINT(ctx, parent, OID_AUTO, "handlers", CTLFLAG_RD,
 882                         &pctx->poll_handlers, 0,
 883                         "Number of registered poll handlers");
 884 }
 885
 886 static void
 887 schedpoll_oncpu(struct pollctx *pctx, struct netmsg *msg, netisr_fn_t handler)
 888 {
 889         if (msg->nm_lmsg.ms_flags & MSGF_DONE) {
 890                 lwkt_port_t port;
 891
 892                 netmsg_init(msg, &netisr_adone_rport, 0, handler);
 893 #ifdef INVARIANTS
 894                 msg->nm_lmsg.u.ms_resultp = pctx;
 895 #endif
 896                 port = cpu_portfn(mycpu->gd_cpuid);
 897                 lwkt_sendmsg(port, &msg->nm_lmsg);
 898         }
 899 }
 900
 901 static void
 902 poll_sysctl_pollhz(struct netmsg *msg)
 903 {
 904         struct pollctx *pctx;
 905         int cpuid;
 906
 907         cpuid = mycpu->gd_cpuid;
 908         KKASSERT(cpuid < POLLCTX_MAX);
 909
 910         pctx = poll_context[cpuid];
 911         KKASSERT(pctx != NULL);
 912         KKASSERT(pctx->poll_cpuid == cpuid);
 913
 914         /*
 915          * If polling is disabled or there is no device registered,
 916          * don't adjust polling systimer frequency.
 917          * Polling systimer frequency will be adjusted once polling
 918          * is enabled and there are registered devices.
 919          */
 920         pctx->pollhz = msg->nm_lmsg.u.ms_result;
 921         if (pctx->polling_enabled && pctx->poll_handlers)
 922                 systimer_adjust_periodic(&pctx->pollclock, pctx->pollhz);
 923
 924         /*
 925          * Make sure that reg_frac and reg_frac_count are within valid range.
 926          */
 927         if (pctx->reg_frac > pctx->pollhz) {
 928                 pctx->reg_frac = pctx->pollhz;
 929                 if (pctx->reg_frac_count > pctx->reg_frac)
 930                         pctx->reg_frac_count = pctx->reg_frac - 1;
 931         }
 932
 933         lwkt_replymsg(&msg->nm_lmsg, 0);
 934 }
 935
 936 static void
 937 poll_sysctl_polling(struct netmsg *msg)
 938 {
 939         struct pollctx *pctx;
 940         int cpuid;
 941
 942         cpuid = mycpu->gd_cpuid;
 943         KKASSERT(cpuid < POLLCTX_MAX);
 944
 945         pctx = poll_context[cpuid];
 946         KKASSERT(pctx != NULL);
 947         KKASSERT(pctx->poll_cpuid == cpuid);
 948
 949         /*
 950          * If polling is disabled or there is no device registered,
 951          * cut the polling systimer frequency to 1hz.
 952          */
 953         pctx->polling_enabled = msg->nm_lmsg.u.ms_result;
 954         if (pctx->polling_enabled && pctx->poll_handlers) {
 955                 systimer_adjust_periodic(&pctx->pollclock, pctx->pollhz);
 956         } else {
 957                 systimer_adjust_periodic(&pctx->pollclock, 1);
 958                 poll_reset_state(pctx);
 959         }
 960
 961         if (!pctx->polling_enabled && pctx->poll_handlers != 0) {
 962                 int i;
 963
 964                 for (i = 0 ; i < pctx->poll_handlers ; i++) {
 965                         struct ifnet *ifp = pctx->pr[i].ifp;
 966
 967                         lwkt_serialize_enter(ifp->if_serializer);
 968
 969                         if ((ifp->if_flags & IFF_POLLING) == 0) {
 970                                 KKASSERT(ifp->if_poll_cpuid < 0);
 971                                 lwkt_serialize_exit(ifp->if_serializer);
 972                                 continue;
 973                         }
 974                         ifp->if_flags &= ~IFF_POLLING;
 975                         ifp->if_poll_cpuid = -1;
 976
 977                         /*
 978                          * Only call the interface deregistration
 979                          * function if the interface is still
 980                          * running.
 981                          */
 982                         if (ifp->if_flags & IFF_RUNNING)
 983                                 ifp->if_poll(ifp, POLL_DEREGISTER, 1);
 984
 985                         lwkt_serialize_exit(ifp->if_serializer);
 986                 }
 987                 pctx->poll_handlers = 0;
 988         }
 989
 990         lwkt_replymsg(&msg->nm_lmsg, 0);
 991 }
 992
 993 static void
 994 poll_sysctl_regfrac(struct netmsg *msg)
 995 {
 996         struct pollctx *pctx;
 997         uint32_t reg_frac;
 998         int cpuid;
 999
1000         cpuid = mycpu->gd_cpuid;
1001         KKASSERT(cpuid < POLLCTX_MAX);
1002
1003         pctx = poll_context[cpuid];
1004         KKASSERT(pctx != NULL);
1005         KKASSERT(pctx->poll_cpuid == cpuid);
1006
1007         reg_frac = msg->nm_lmsg.u.ms_result;
1008         if (reg_frac > pctx->pollhz)
1009                 reg_frac = pctx->pollhz;
1010         else if (reg_frac < 1)
1011                 reg_frac = 1;
1012
1013         pctx->reg_frac = reg_frac;
1014         if (pctx->reg_frac_count > pctx->reg_frac)
1015                 pctx->reg_frac_count = pctx->reg_frac - 1;
1016
1017         lwkt_replymsg(&msg->nm_lmsg, 0);
1018 }
1019
1020 static void
1021 poll_sysctl_burstmax(struct netmsg *msg)
1022 {
1023         struct pollctx *pctx;
1024         int cpuid;
1025
1026         cpuid = mycpu->gd_cpuid;
1027         KKASSERT(cpuid < POLLCTX_MAX);
1028
1029         pctx = poll_context[cpuid];
1030         KKASSERT(pctx != NULL);
1031         KKASSERT(pctx->poll_cpuid == cpuid);
1032
1033         pctx->poll_burst_max = msg->nm_lmsg.u.ms_result;
1034         if (pctx->poll_each_burst > pctx->poll_burst_max)
1035                 pctx->poll_each_burst = pctx->poll_burst_max;
1036         if (pctx->poll_burst > pctx->poll_burst_max)
1037                 pctx->poll_burst = pctx->poll_burst_max;
1038         if (pctx->residual_burst > pctx->poll_burst_max)
1039                 pctx->residual_burst = pctx->poll_burst_max;
1040
1041         lwkt_replymsg(&msg->nm_lmsg, 0);
1042 }
1043
1044 static void
1045 poll_sysctl_eachburst(struct netmsg *msg)
1046 {
1047         struct pollctx *pctx;
1048         uint32_t each_burst;
1049         int cpuid;
1050
1051         cpuid = mycpu->gd_cpuid;
1052         KKASSERT(cpuid < POLLCTX_MAX);
1053
1054         pctx = poll_context[cpuid];
1055         KKASSERT(pctx != NULL);
1056         KKASSERT(pctx->poll_cpuid == cpuid);
1057
1058         each_burst = msg->nm_lmsg.u.ms_result;
1059         if (each_burst > pctx->poll_burst_max)
1060                 each_burst = pctx->poll_burst_max;
1061         else if (each_burst < 1)
1062                 each_burst = 1;
1063         pctx->poll_each_burst = each_burst;
1064
1065         lwkt_replymsg(&msg->nm_lmsg, 0);
1066 }