sys/net/netisr.c

   1 /*
   2  * Copyright (c) 2003, 2004 Matthew Dillon. All rights reserved.
   3  * Copyright (c) 2003, 2004 Jeffrey M. Hsu.  All rights reserved.
   4  * Copyright (c) 2003 Jonathan Lemon.  All rights reserved.
   5  * Copyright (c) 2003, 2004 The DragonFly Project.  All rights reserved.
   6  *
   7  * This code is derived from software contributed to The DragonFly Project
   8  * by Jonathan Lemon, Jeffrey M. Hsu, and Matthew Dillon.
   9  *
  10  * Jonathan Lemon gave Jeffrey Hsu permission to combine his copyright
  11  * into this one around July 8 2004.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. Neither the name of The DragonFly Project nor the names of its
  22  *    contributors may be used to endorse or promote products derived
  23  *    from this software without specific, prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  26  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  27  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  28  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  29  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  30  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  31  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  33  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  34  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  35  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  36  * SUCH DAMAGE.
  37  *
  38  * $DragonFly: src/sys/net/netisr.c,v 1.46 2008/09/23 11:28:49 sephe Exp $
  39  */
  40
  41 #include <sys/param.h>
  42 #include <sys/systm.h>
  43 #include <sys/kernel.h>
  44 #include <sys/malloc.h>
  45 #include <sys/msgport.h>
  46 #include <sys/proc.h>
  47 #include <sys/interrupt.h>
  48 #include <sys/socket.h>
  49 #include <sys/sysctl.h>
  50 #include <net/if.h>
  51 #include <net/if_var.h>
  52 #include <net/netisr.h>
  53 #include <machine/cpufunc.h>
  54
  55 #include <sys/thread2.h>
  56 #include <sys/msgport2.h>
  57 #include <net/netmsg2.h>
  58
  59 #define NETISR_GET_MPLOCK(ni) \
  60 do { \
  61     if (((ni)->ni_flags & NETISR_FLAG_MPSAFE) == 0) \
  62         get_mplock(); \
  63 } while (0)
  64
  65 #define NETISR_REL_MPLOCK(ni) \
  66 do { \
  67     if (((ni)->ni_flags & NETISR_FLAG_MPSAFE) == 0) \
  68         rel_mplock(); \
  69 } while (0)
  70
  71 static void netmsg_sync_func(struct netmsg *msg);
  72
  73 struct netmsg_port_registration {
  74     TAILQ_ENTRY(netmsg_port_registration) npr_entry;
  75     lwkt_port_t npr_port;
  76 };
  77
  78 static struct netisr netisrs[NETISR_MAX];
  79 static TAILQ_HEAD(,netmsg_port_registration) netreglist;
  80
  81 /* Per-CPU thread to handle any protocol.  */
  82 struct thread netisr_cpu[MAXCPU];
  83 lwkt_port netisr_afree_rport;
  84 lwkt_port netisr_adone_rport;
  85 lwkt_port netisr_apanic_rport;
  86 lwkt_port netisr_sync_port;
  87
  88 static int (*netmsg_fwd_port_fn)(lwkt_port_t, lwkt_msg_t);
  89
  90 static int netisr_mpsafe_thread = 0;
  91 TUNABLE_INT("net.netisr.mpsafe_thread", &netisr_mpsafe_thread);
  92
  93 SYSCTL_NODE(_net, OID_AUTO, netisr, CTLFLAG_RW, 0, "netisr");
  94 SYSCTL_INT(_net_netisr, OID_AUTO, mpsafe_thread, CTLFLAG_RW,
  95            &netisr_mpsafe_thread, 0,
  96            "0:BGL, 1:Adaptive BGL, 2:No BGL(experimental)");
  97
  98 /*
  99  * netisr_afree_rport replymsg function, only used to handle async
 100  * messages which the sender has abandoned to their fate.
 101  */
 102 static void
 103 netisr_autofree_reply(lwkt_port_t port, lwkt_msg_t msg)
 104 {
 105     kfree(msg, M_LWKTMSG);
 106 }
 107
 108 /*
 109  * We need a custom putport function to handle the case where the
 110  * message target is the current thread's message port.  This case
 111  * can occur when the TCP or UDP stack does a direct callback to NFS and NFS
 112  * then turns around and executes a network operation synchronously.
 113  *
 114  * To prevent deadlocking, we must execute these self-referential messages
 115  * synchronously, effectively turning the message into a glorified direct
 116  * procedure call back into the protocol stack.  The operation must be
 117  * complete on return or we will deadlock, so panic if it isn't.
 118  */
 119 static int
 120 netmsg_put_port(lwkt_port_t port, lwkt_msg_t lmsg)
 121 {
 122     netmsg_t netmsg = (void *)lmsg;
 123
 124     if ((lmsg->ms_flags & MSGF_SYNC) && port == &curthread->td_msgport) {
 125         netmsg->nm_dispatch(netmsg);
 126         if ((lmsg->ms_flags & MSGF_DONE) == 0)
 127             panic("netmsg_put_port: self-referential deadlock on netport");
 128         return(EASYNC);
 129     } else {
 130         return(netmsg_fwd_port_fn(port, lmsg));
 131     }
 132 }
 133
 134 /*
 135  * UNIX DOMAIN sockets still have to run their uipc functions synchronously,
 136  * because they depend on the user proc context for a number of things
 137  * (like creds) which we have not yet incorporated into the message structure.
 138  *
 139  * However, we maintain or message/port abstraction.  Having a special
 140  * synchronous port which runs the commands synchronously gives us the
 141  * ability to serialize operations in one place later on when we start
 142  * removing the BGL.
 143  */
 144 static int
 145 netmsg_sync_putport(lwkt_port_t port, lwkt_msg_t lmsg)
 146 {
 147     netmsg_t netmsg = (void *)lmsg;
 148
 149     KKASSERT((lmsg->ms_flags & MSGF_DONE) == 0);
 150
 151     lmsg->ms_target_port = port;        /* required for abort */
 152     netmsg->nm_dispatch(netmsg);
 153     return(EASYNC);
 154 }
 155
 156 static void
 157 netisr_init(void)
 158 {
 159     int i;
 160
 161     TAILQ_INIT(&netreglist);
 162
 163     /*
 164      * Create default per-cpu threads for generic protocol handling.
 165      */
 166     for (i = 0; i < ncpus; ++i) {
 167         lwkt_create(netmsg_service_loop, &netisr_mpsafe_thread, NULL,
 168                     &netisr_cpu[i], TDF_NETWORK | TDF_MPSAFE, i,
 169                     "netisr_cpu %d", i);
 170         netmsg_service_port_init(&netisr_cpu[i].td_msgport);
 171     }
 172
 173     /*
 174      * The netisr_afree_rport is a special reply port which automatically
 175      * frees the replied message.  The netisr_adone_rport simply marks
 176      * the message as being done.  The netisr_apanic_rport panics if
 177      * the message is replied to.
 178      */
 179     lwkt_initport_replyonly(&netisr_afree_rport, netisr_autofree_reply);
 180     lwkt_initport_replyonly_null(&netisr_adone_rport);
 181     lwkt_initport_panic(&netisr_apanic_rport);
 182
 183     /*
 184      * The netisr_syncport is a special port which executes the message
 185      * synchronously and waits for it if EASYNC is returned.
 186      */
 187     lwkt_initport_putonly(&netisr_sync_port, netmsg_sync_putport);
 188 }
 189
 190 SYSINIT(netisr, SI_SUB_PRE_DRIVERS, SI_ORDER_FIRST, netisr_init, NULL);
 191
 192 /*
 193  * Finish initializing the message port for a netmsg service.  This also
 194  * registers the port for synchronous cleanup operations such as when an
 195  * ifnet is being destroyed.  There is no deregistration API yet.
 196  */
 197 void
 198 netmsg_service_port_init(lwkt_port_t port)
 199 {
 200     struct netmsg_port_registration *reg;
 201
 202     /*
 203      * Override the putport function.  Our custom function checks for
 204      * self-references and executes such commands synchronously.
 205      */
 206     if (netmsg_fwd_port_fn == NULL)
 207         netmsg_fwd_port_fn = port->mp_putport;
 208     KKASSERT(netmsg_fwd_port_fn == port->mp_putport);
 209     port->mp_putport = netmsg_put_port;
 210
 211     /*
 212      * Keep track of ports using the netmsg API so we can synchronize
 213      * certain operations (such as freeing an ifnet structure) across all
 214      * consumers.
 215      */
 216     reg = kmalloc(sizeof(*reg), M_TEMP, M_WAITOK|M_ZERO);
 217     reg->npr_port = port;
 218     TAILQ_INSERT_TAIL(&netreglist, reg, npr_entry);
 219 }
 220
 221 /*
 222  * This function synchronizes the caller with all netmsg services.  For
 223  * example, if an interface is being removed we must make sure that all
 224  * packets related to that interface complete processing before the structure
 225  * can actually be freed.  This sort of synchronization is an alternative to
 226  * ref-counting the netif, removing the ref counting overhead in favor of
 227  * placing additional overhead in the netif freeing sequence (where it is
 228  * inconsequential).
 229  */
 230 void
 231 netmsg_service_sync(void)
 232 {
 233     struct netmsg_port_registration *reg;
 234     struct netmsg smsg;
 235
 236     netmsg_init(&smsg, &curthread->td_msgport, 0, netmsg_sync_func);
 237
 238     TAILQ_FOREACH(reg, &netreglist, npr_entry) {
 239         lwkt_domsg(reg->npr_port, &smsg.nm_lmsg, 0);
 240     }
 241 }
 242
 243 /*
 244  * The netmsg function simply replies the message.  API semantics require
 245  * EASYNC to be returned if the netmsg function disposes of the message.
 246  */
 247 static void
 248 netmsg_sync_func(struct netmsg *msg)
 249 {
 250     lwkt_replymsg(&msg->nm_lmsg, 0);
 251 }
 252
 253 /*
 254  * Return current BGL lock state (1:locked, 0: unlocked)
 255  */
 256 int
 257 netmsg_service(struct netmsg *msg, int mpsafe_mode, int mplocked)
 258 {
 259     /*
 260      * Adjust the mplock dynamically.
 261      */
 262     switch (mpsafe_mode) {
 263     case NETMSG_SERVICE_ADAPTIVE: /* Adaptive BGL */
 264         if (msg->nm_lmsg.ms_flags & MSGF_MPSAFE) {
 265             if (mplocked) {
 266                 rel_mplock();
 267                 mplocked = 0;
 268             }
 269             msg->nm_dispatch(msg);
 270             /* Leave mpunlocked */
 271         } else {
 272             if (!mplocked) {
 273                 get_mplock();
 274                 /* mplocked = 1; not needed */
 275             }
 276             msg->nm_dispatch(msg);
 277             rel_mplock();
 278             mplocked = 0;
 279             /* Leave mpunlocked, next msg might be mpsafe */
 280         }
 281         break;
 282
 283     case NETMSG_SERVICE_MPSAFE: /* No BGL */
 284         if (mplocked) {
 285             rel_mplock();
 286             mplocked = 0;
 287         }
 288         msg->nm_dispatch(msg);
 289         /* Leave mpunlocked */
 290         break;
 291
 292     default: /* BGL */
 293         if (!mplocked) {
 294             get_mplock();
 295             mplocked = 1;
 296         }
 297         msg->nm_dispatch(msg);
 298         /* Leave mplocked */
 299         break;
 300     }
 301     return mplocked;
 302 }
 303
 304 /*
 305  * Generic netmsg service loop.  Some protocols may roll their own but all
 306  * must do the basic command dispatch function call done here.
 307  */
 308 void
 309 netmsg_service_loop(void *arg)
 310 {
 311     struct netmsg *msg;
 312     int mplocked, *mpsafe_mode = arg;
 313
 314     /*
 315      * Thread was started with TDF_MPSAFE
 316      */
 317     mplocked = 0;
 318
 319     /*
 320      * Loop on netmsgs
 321      */
 322     while ((msg = lwkt_waitport(&curthread->td_msgport, 0))) {
 323         mplocked = netmsg_service(msg, *mpsafe_mode, mplocked);
 324     }
 325 }
 326
 327 /*
 328  * Call the netisr directly.
 329  * Queueing may be done in the msg port layer at its discretion.
 330  */
 331 void
 332 netisr_dispatch(int num, struct mbuf *m)
 333 {
 334     /* just queue it for now XXX JH */
 335     netisr_queue(num, m);
 336 }
 337
 338 /*
 339  * Same as netisr_dispatch(), but always queue.
 340  * This is either used in places where we are not confident that
 341  * direct dispatch is possible, or where queueing is required.
 342  */
 343 int
 344 netisr_queue(int num, struct mbuf *m)
 345 {
 346     struct netisr *ni;
 347     struct netmsg_packet *pmsg;
 348     lwkt_port_t port;
 349
 350     KASSERT((num > 0 && num <= (sizeof(netisrs)/sizeof(netisrs[0]))),
 351             ("%s: bad isr %d", __func__, num));
 352
 353     ni = &netisrs[num];
 354     if (ni->ni_handler == NULL) {
 355         kprintf("%s: unregistered isr %d\n", __func__, num);
 356         m_freem(m);
 357         return (EIO);
 358     }
 359
 360     if ((port = ni->ni_mport(&m)) == NULL)
 361         return (EIO);
 362
 363     pmsg = &m->m_hdr.mh_netmsg;
 364
 365     netmsg_init(&pmsg->nm_netmsg, &netisr_apanic_rport,
 366                 (ni->ni_flags & NETISR_FLAG_MPSAFE) ? MSGF_MPSAFE : 0,
 367                 ni->ni_handler);
 368     pmsg->nm_packet = m;
 369     pmsg->nm_netmsg.nm_lmsg.u.ms_result = num;
 370     lwkt_sendmsg(port, &pmsg->nm_netmsg.nm_lmsg);
 371     return (0);
 372 }
 373
 374 void
 375 netisr_register(int num, lwkt_portfn_t mportfn, netisr_fn_t handler,
 376                 uint32_t flags)
 377 {
 378     KASSERT((num > 0 && num <= (sizeof(netisrs)/sizeof(netisrs[0]))),
 379         ("netisr_register: bad isr %d", num));
 380     netmsg_init(&netisrs[num].ni_netmsg, &netisr_adone_rport,
 381                 (flags & NETISR_FLAG_MPSAFE) ? MSGF_MPSAFE : 0, NULL);
 382     netisrs[num].ni_mport = mportfn;
 383     netisrs[num].ni_handler = handler;
 384     netisrs[num].ni_flags = flags;
 385 }
 386
 387 int
 388 netisr_unregister(int num)
 389 {
 390     KASSERT((num > 0 && num <= (sizeof(netisrs)/sizeof(netisrs[0]))),
 391         ("unregister_netisr: bad isr number: %d\n", num));
 392
 393     /* XXX JH */
 394     return (0);
 395 }
 396
 397 /*
 398  * Return message port for default handler thread on CPU 0.
 399  */
 400 lwkt_port_t
 401 cpu0_portfn(struct mbuf **mptr)
 402 {
 403     return (&netisr_cpu[0].td_msgport);
 404 }
 405
 406 lwkt_port_t
 407 cpu_portfn(int cpu)
 408 {
 409     return (&netisr_cpu[cpu].td_msgport);
 410 }
 411
 412 /* ARGSUSED */
 413 lwkt_port_t
 414 cpu0_soport(struct socket *so __unused, struct sockaddr *nam __unused,
 415             struct mbuf **dummy __unused, int req __unused)
 416 {
 417     return (&netisr_cpu[0].td_msgport);
 418 }
 419
 420 lwkt_port_t
 421 sync_soport(struct socket *so __unused, struct sockaddr *nam __unused,
 422             struct mbuf **dummy __unused, int req __unused)
 423 {
 424     return (&netisr_sync_port);
 425 }
 426
 427 /*
 428  * schednetisr() is used to call the netisr handler from the appropriate
 429  * netisr thread for polling and other purposes.
 430  *
 431  * This function may be called from a hard interrupt or IPI and must be
 432  * MP SAFE and non-blocking.  We use a fixed per-cpu message instead of
 433  * trying to allocate one.  We must get ourselves onto the target cpu
 434  * to safely check the MSGF_DONE bit on the message but since the message
 435  * will be sent to that cpu anyway this does not add any extra work beyond
 436  * what lwkt_sendmsg() would have already had to do to schedule the target
 437  * thread.
 438  */
 439 static void
 440 schednetisr_remote(void *data)
 441 {
 442     int num = (int)data;
 443     struct netisr *ni = &netisrs[num];
 444     lwkt_port_t port = &netisr_cpu[0].td_msgport;
 445     struct netmsg *pmsg;
 446
 447     pmsg = &netisrs[num].ni_netmsg;
 448     crit_enter();
 449     if (pmsg->nm_lmsg.ms_flags & MSGF_DONE) {
 450         netmsg_init(pmsg, &netisr_adone_rport, 0, ni->ni_handler);
 451         pmsg->nm_lmsg.u.ms_result = num;
 452         lwkt_sendmsg(port, &pmsg->nm_lmsg);
 453     }
 454     crit_exit();
 455 }
 456
 457 void
 458 schednetisr(int num)
 459 {
 460     KASSERT((num > 0 && num <= (sizeof(netisrs)/sizeof(netisrs[0]))),
 461         ("schednetisr: bad isr %d", num));
 462 #ifdef SMP
 463     if (mycpu->gd_cpuid != 0)
 464         lwkt_send_ipiq(globaldata_find(0), schednetisr_remote, (void *)num);
 465     else
 466         schednetisr_remote((void *)num);
 467 #else
 468     schednetisr_remote((void *)num);
 469 #endif
 470 }
 471
 472 lwkt_port_t
 473 netisr_find_port(int num, struct mbuf **m0)
 474 {
 475     struct netisr *ni;
 476     lwkt_port_t port;
 477     struct mbuf *m = *m0;
 478
 479     *m0 = NULL;
 480
 481     KASSERT((num > 0 && num <= (sizeof(netisrs)/sizeof(netisrs[0]))),
 482             ("%s: bad isr %d", __func__, num));
 483
 484     ni = &netisrs[num];
 485     if (ni->ni_mport == NULL) {
 486         kprintf("%s: unregistered isr %d\n", __func__, num);
 487         m_freem(m);
 488         return NULL;
 489     }
 490
 491     if ((port = ni->ni_mport(&m)) == NULL)
 492         return NULL;
 493
 494     *m0 = m;
 495     return port;
 496 }
 497
 498 void
 499 netisr_run(int num, struct mbuf *m)
 500 {
 501     struct netisr *ni;
 502     struct netmsg_packet *pmsg;
 503
 504     KASSERT((num > 0 && num <= (sizeof(netisrs)/sizeof(netisrs[0]))),
 505             ("%s: bad isr %d", __func__, num));
 506
 507     ni = &netisrs[num];
 508     if (ni->ni_handler == NULL) {
 509         kprintf("%s: unregistered isr %d\n", __func__, num);
 510         m_freem(m);
 511         return;
 512     }
 513
 514     pmsg = &m->m_hdr.mh_netmsg;
 515
 516     netmsg_init(&pmsg->nm_netmsg, &netisr_apanic_rport, 0, ni->ni_handler);
 517     pmsg->nm_packet = m;
 518     pmsg->nm_netmsg.nm_lmsg.u.ms_result = num;
 519
 520     NETISR_GET_MPLOCK(ni);
 521     ni->ni_handler(&pmsg->nm_netmsg);
 522     NETISR_REL_MPLOCK(ni);
 523 }