New NETISR implementation, but same defaults

From: Robert Watson <rwatson_at_FreeBSD.org>
Date: Mon, 1 Jun 2009 11:44:54 +0100 (BST)
As a HEADS up to 8-CURRENT followers: I've replaced the NETISR implementation 
there as part of on-going work to improve network stack parallelism, details 
below.  In practice, most behavior remains identical in the default 
configuration (direct dispatch, single netisr thread that's not bound to a 
CPU, etc), but people will want to watch out for problems.  Some default queue 
limits have been raised.

More functional changes to take advantage of these features, such as deferred 
ethernet dispatch and software flow ID generation, will follow as patches, but 
probably not ship in 8.0 out of the box.

Robert N M Watson
Computer Laboratory
University of Cambridge

---------- Forwarded message ----------
Date: Mon, 1 Jun 2009 10:41:38 +0000 (UTC)
From: Robert Watson <rwatson_at_FreeBSD.org>
To: src-committers_at_freebsd.org, svn-src-all_at_freebsd.org,
     svn-src-head_at_freebsd.org
Subject: svn commit: r193219 - in head/sys: kern net netatalk netinet netinet6
     netipsec netipx netnatm sys

Author: rwatson
Date: Mon Jun  1 10:41:38 2009
New Revision: 193219
URL: http://svn.freebsd.org/changeset/base/193219

Log:
   Reimplement the netisr framework in order to support parallel netisr
   threads:

   - Support up to one netisr thread per CPU, each processings its own
     workstream, or set of per-protocol queues.  Threads may be bound
     to specific CPUs, or allowed to migrate, based on a global policy.

     In the future it would be desirable to support topology-centric
     policies, such as "one netisr per package".

   - Allow each protocol to advertise an ordering policy, which can
     currently be one of:

     NETISR_POLICY_SOURCE: packets must maintain ordering with respect to
       an implicit or explicit source (such as an interface or socket).

     NETISR_POLICY_FLOW: make use of mbuf flow identifiers to place work,
       as well as allowing protocols to provide a flow generation function
       for mbufs without flow identifers (m2flow).  Falls back on
       NETISR_POLICY_SOURCE if now flow ID is available.

     NETISR_POLICY_CPU: allow protocols to inspect and assign a CPU for
       each packet handled by netisr (m2cpuid).

   - Provide utility functions for querying the number of workstreams
     being used, as well as a mapping function from workstream to CPU ID,
     which protocols may use in work placement decisions.

   - Add explicit interfaces to get and set per-protocol queue limits, and
     get and clear drop counters, which query data or apply changes across
     all workstreams.

   - Add a more extensible netisr registration interface, in which
     protocols declare 'struct netisr_handler' structures for each
     registered NETISR_ type.  These include name, handler function,
     optional mbuf to flow ID function, optional mbuf to CPU ID function,
     queue limit, and ordering policy.  Padding is present to allow these
     to be expanded in the future.  If no queue limit is declared, then
     a default is used.

   - Queue limits are now per-workstream, and raised from the previous
     IFQ_MAXLEN default of 50 to 256.

   - All protocols are updated to use the new registration interface, and
     with the exception of netnatm, default queue limits.  Most protocols
     register as NETISR_POLICY_SOURCE, except IPv4 and IPv6, which use
     NETISR_POLICY_FLOW, and will therefore take advantage of driver-
     generated flow IDs if present.

   - Formalize a non-packet based interface between interface polling and
     the netisr, rather than having polling pretend to be two protocols.
     Provide two explicit hooks in the netisr worker for start and end
     events for runs: netisr_poll() and netisr_pollmore(), as well as a
     function, netisr_sched_poll(), to allow the polling code to schedule
     netisr execution.  DEVICE_POLLING still embeds single-netisr
     assumptions in its implementation, so for now if it is compiled into
     the kernel, a single and un-bound netisr thread is enforced
     regardless of tunable configuration.

   In the default configuration, the new netisr implementation maintains
   the same basic assumptions as the previous implementation: a single,
   un-bound worker thread processes all deferred work, and direct dispatch
   is enabled by default wherever possible.

   Performance measurement shows a marginal performance improvement over
   the old implementation due to the use of batched dequeue.

   An rmlock is used to synchronize use and registration/unregistration
   using the framework; currently, synchronized use is disabled
   (replicating current netisr policy) due to a measurable 3%-6% hit in
   ping-pong micro-benchmarking.  It will be enabled once further rmlock
   optimization has taken place.  However, in practice, netisrs are
   rarely registered or unregistered at runtime.

   A new man page for netisr will follow, but since one doesn't currently
   exist, it hasn't been updated.

   This change is not appropriate for MFC, although the polling shutdown
   handler should be merged to 7-STABLE.

   Bump __FreeBSD_version.

   Reviewed by:	bz

Modified:
   head/sys/kern/kern_poll.c
   head/sys/net/netisr.c
   head/sys/net/netisr.h
   head/sys/net/rtsock.c
   head/sys/netatalk/ddp_usrreq.c
   head/sys/netinet/if_ether.c
   head/sys/netinet/igmp.c
   head/sys/netinet/ip_divert.c
   head/sys/netinet/ip_input.c
   head/sys/netinet6/ip6_input.c
   head/sys/netinet6/vinet6.h
   head/sys/netipsec/ipsec_input.c
   head/sys/netipx/ipx_input.c
   head/sys/netnatm/natm_proto.c
   head/sys/sys/param.h
   head/sys/sys/pcpu.h

Modified: head/sys/kern/kern_poll.c
==============================================================================
--- head/sys/kern/kern_poll.c	Mon Jun  1 10:30:52 2009	(r193218)
+++ head/sys/kern/kern_poll.c	Mon Jun  1 10:41:38 2009	(r193219)
_at__at_ -36,6 +36,7 _at__at_ __FBSDID("$FreeBSD$");
  #include <sys/kernel.h>
  #include <sys/kthread.h>
  #include <sys/proc.h>
+#include <sys/eventhandler.h>
  #include <sys/resourcevar.h>
  #include <sys/socket.h>			/* needed by net/if.h		*/
  #include <sys/sockio.h>
_at__at_ -48,8 +49,6 _at__at_ __FBSDID("$FreeBSD$");
  #include <net/route.h>
  #include <net/vnet.h>

-static void netisr_poll(void);		/* the two netisr handlers      */
-static void netisr_pollmore(void);
  static int poll_switch(SYSCTL_HANDLER_ARGS);

  void hardclock_device_poll(void);	/* hook from hardclock		*/
_at__at_ -110,6 +109,10 _at__at_ SYSCTL_NODE(_kern, OID_AUTO, polling, CT
  SYSCTL_UINT(_kern_polling, OID_AUTO, burst, CTLFLAG_RD,
  	&poll_burst, 0, "Current polling burst size");

+static int	netisr_poll_scheduled;
+static int	netisr_pollmore_scheduled;
+static int	poll_shutting_down;
+
  static int poll_burst_max_sysctl(SYSCTL_HANDLER_ARGS)
  {
  	uint32_t val = poll_burst_max;
_at__at_ -260,12 +263,19 _at__at_ struct pollrec {
  static struct pollrec pr[POLL_LIST_LEN];

  static void
+poll_shutdown(void *arg, int howto)
+{
+
+	poll_shutting_down = 1;
+}
+
+static void
  init_device_poll(void)
  {

  	mtx_init(&poll_mtx, "polling", NULL, MTX_DEF);
-	netisr_register(NETISR_POLL, (netisr_t *)netisr_poll, NULL, 0);
-	netisr_register(NETISR_POLLMORE, (netisr_t *)netisr_pollmore, NULL, 0);
+	EVENTHANDLER_REGISTER(shutdown_post_sync, poll_shutdown, NULL,
+	    SHUTDOWN_PRI_LAST);
  }
  SYSINIT(device_poll, SI_SUB_CLOCKS, SI_ORDER_MIDDLE, init_device_poll, NULL);

_at__at_ -289,7 +299,7 _at__at_ hardclock_device_poll(void)
  	static struct timeval prev_t, t;
  	int delta;

-	if (poll_handlers == 0)
+	if (poll_handlers == 0 || poll_shutting_down)
  		return;

  	microuptime(&t);
_at__at_ -314,7 +324,9 _at__at_ hardclock_device_poll(void)
  		if (phase != 0)
  			suspect++;
  		phase = 1;
-		schednetisrbits(1 << NETISR_POLL | 1 << NETISR_POLLMORE);
+		netisr_poll_scheduled = 1;
+		netisr_pollmore_scheduled = 1;
+		netisr_sched_poll();
  		phase = 2;
  	}
  	if (pending_polls++ > 0)
_at__at_ -365,9 +377,16 _at__at_ netisr_pollmore()
  	int kern_load;

  	mtx_lock(&poll_mtx);
+	if (!netisr_pollmore_scheduled) {
+		mtx_unlock(&poll_mtx);
+		return;
+	}
+	netisr_pollmore_scheduled = 0;
  	phase = 5;
  	if (residual_burst > 0) {
-		schednetisrbits(1 << NETISR_POLL | 1 << NETISR_POLLMORE);
+		netisr_poll_scheduled = 1;
+		netisr_pollmore_scheduled = 1;
+		netisr_sched_poll();
  		mtx_unlock(&poll_mtx);
  		/* will run immediately on return, followed by netisrs */
  		return;
_at__at_ -397,23 +416,29 _at__at_ netisr_pollmore()
  		poll_burst -= (poll_burst / 8);
  		if (poll_burst < 1)
  			poll_burst = 1;
-		schednetisrbits(1 << NETISR_POLL | 1 << NETISR_POLLMORE);
+		netisr_poll_scheduled = 1;
+		netisr_pollmore_scheduled = 1;
+		netisr_sched_poll();
  		phase = 6;
  	}
  	mtx_unlock(&poll_mtx);
  }

  /*
- * netisr_poll is scheduled by schednetisr when appropriate, typically once
- * per tick.
+ * netisr_poll is typically scheduled once per tick.
   */
-static void
+void
  netisr_poll(void)
  {
  	int i, cycles;
  	enum poll_cmd arg = POLL_ONLY;

  	mtx_lock(&poll_mtx);
+	if (!netisr_poll_scheduled) {
+		mtx_unlock(&poll_mtx);
+		return;
+	}
+	netisr_poll_scheduled = 0;
  	phase = 3;
  	if (residual_burst == 0) { /* first call in this tick */
  		microuptime(&poll_start_t);

Modified: head/sys/net/netisr.c
==============================================================================
--- head/sys/net/netisr.c	Mon Jun  1 10:30:52 2009	(r193218)
+++ head/sys/net/netisr.c	Mon Jun  1 10:41:38 2009	(r193219)
_at__at_ -1,6 +1,5 _at__at_
  /*-
- * Copyright (c) 2001,2002,2003 Jonathan Lemon <jlemon_at_FreeBSD.org>
- * Copyright (c) 1997, Stefan Esser <se_at_freebsd.org>
+ * Copyright (c) 2007-2009 Robert N. M. Watson
   * All rights reserved.
   *
   * Redistribution and use in source and binary forms, with or without
_at__at_ -23,230 +22,1103 _at__at_
   * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
   * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
   * SUCH DAMAGE.
+ */
+
+#include <sys/cdefs.h>
+__FBSDID("$FreeBSD$");
+
+/*
+ * netisr is a packet dispatch service, allowing synchronous (directly
+ * dispatched) and asynchronous (deferred dispatch) processing of packets by
+ * registered protocol handlers.  Callers pass a protocol identifier and
+ * packet to netisr, along with a direct dispatch hint, and work will either
+ * be immediately processed with the registered handler, or passed to a
+ * kernel software interrupt (SWI) thread for deferred dispatch.  Callers
+ * will generally select one or the other based on:
+ *
+ * - Might directly dispatching a netisr handler lead to code reentrance or
+ *   lock recursion, such as entering the socket code from the socket code.
+ * - Might directly dispatching a netisr handler lead to recursive
+ *   processing, such as when decapsulating several wrapped layers of tunnel
+ *   information (IPSEC within IPSEC within ...).
   *
- * $FreeBSD$
+ * Maintaining ordering for protocol streams is a critical design concern.
+ * Enforcing ordering limits the opportunity for concurrency, but maintains
+ * the strong ordering requirements found in some protocols, such as TCP.  Of
+ * related concern is CPU affinity--it is desirable to process all data
+ * associated with a particular stream on the same CPU over time in order to
+ * avoid acquiring locks associated with the connection on different CPUs,
+ * keep connection data in one cache, and to generally encourage associated
+ * user threads to live on the same CPU as the stream.  It's also desirable
+ * to avoid lock migration and contention where locks are associated with
+ * more than one flow.
+ *
+ * netisr supports several policy variations, represented by the
+ * NETISR_POLICY_* constants, allowing protocols to play a varying role in
+ * identifying flows, assigning work to CPUs, etc.  These are described in
+ * detail in netisr.h.
   */

+#include "opt_ddb.h"
  #include "opt_device_polling.h"

  #include <sys/param.h>
  #include <sys/bus.h>
-#include <sys/rtprio.h>
-#include <sys/systm.h>
-#include <sys/interrupt.h>
  #include <sys/kernel.h>
  #include <sys/kthread.h>
+#include <sys/interrupt.h>
  #include <sys/lock.h>
-#include <sys/malloc.h>
+#include <sys/mbuf.h>
+#include <sys/mutex.h>
  #include <sys/proc.h>
-#include <sys/random.h>
-#include <sys/resourcevar.h>
+#include <sys/rmlock.h>
+#include <sys/sched.h>
+#include <sys/smp.h>
+#include <sys/socket.h>
  #include <sys/sysctl.h>
-#include <sys/unistd.h>
+#include <sys/systm.h>
  #include <sys/vimage.h>
-#include <machine/atomic.h>
-#include <machine/cpu.h>
-#include <machine/stdarg.h>

-#include <sys/mbuf.h>
-#include <sys/socket.h>
+#ifdef DDB
+#include <ddb/ddb.h>
+#endif

  #include <net/if.h>
-#include <net/if_types.h>
  #include <net/if_var.h>
  #include <net/netisr.h>

-volatile unsigned int	netisr;	/* scheduling bits for network */
+/*-
+ * Synchronize use and modification of the registered netisr data structures;
+ * acquire a read lock while modifying the set of registered protocols to
+ * prevent partially registered or unregistered protocols from being run.
+ *
+ * The following data structures and fields are protected by this lock:
+ *
+ * - The np array, including all fields of struct netisr_proto.
+ * - The nws array, including all fields of struct netisr_worker.
+ * - The nws_array array.
+ *
+ * Note: the NETISR_LOCKING define controls whether read locks are acquired
+ * in packet processing paths requiring netisr registration stability.  This
+ * is disabled by default as it can lead to a measurable performance
+ * degradation even with rmlocks (3%-6% for loopback ping-pong traffic), and
+ * because netisr registration and unregistration is extremely rare at
+ * runtime.  If it becomes more common, this decision should be revisited.
+ *
+ * XXXRW: rmlocks don't support assertions.
+ */
+static struct rmlock	netisr_rmlock;
+#define	NETISR_LOCK_INIT()	rm_init_flags(&netisr_rmlock, "netisr", \
+				    RM_NOWITNESS)
+#define	NETISR_LOCK_ASSERT()
+#define	NETISR_RLOCK(tracker)	rm_rlock(&netisr_rmlock, (tracker))
+#define	NETISR_RUNLOCK(tracker)	rm_runlock(&netisr_rmlock, (tracker))
+#define	NETISR_WLOCK()		rm_wlock(&netisr_rmlock)
+#define	NETISR_WUNLOCK()	rm_wunlock(&netisr_rmlock)
+/* #define	NETISR_LOCKING */
+
+SYSCTL_NODE(_net, OID_AUTO, isr, CTLFLAG_RW, 0, "netisr");
+
+/*-
+ * Three direct dispatch policies are supported:
+ *
+ * - Always defer: all work is scheduled for a netisr, regardless of context.
+ *   (!direct)
+ *
+ * - Hybrid: if the executing context allows direct dispatch, and we're
+ *   running on the CPU the work would be done on, then direct dispatch if it
+ *   wouldn't violate ordering constraints on the workstream.
+ *   (direct && !direct_force)
+ *
+ * - Always direct: if the executing context allows direct dispatch, always
+ *   direct dispatch.  (direct && direct_force)
+ *
+ * Notice that changing the global policy could lead to short periods of
+ * misordered processing, but this is considered acceptable as compared to
+ * the complexity of enforcing ordering during policy changes.
+ */
+static int	netisr_direct_force = 1;	/* Always direct dispatch. */
+TUNABLE_INT("net.isr.direct_force", &netisr_direct_force);
+SYSCTL_INT(_net_isr, OID_AUTO, direct_force, CTLFLAG_RW,
+    &netisr_direct_force, 0, "Force direct dispatch");
+
+static int	netisr_direct = 1;	/* Enable direct dispatch. */
+TUNABLE_INT("net.isr.direct", &netisr_direct);
+SYSCTL_INT(_net_isr, OID_AUTO, direct, CTLFLAG_RW,
+    &netisr_direct, 0, "Enable direct dispatch");
+
+/*
+ * Allow the administrator to limit the number of threads (CPUs) to use for
+ * netisr.  We don't check netisr_maxthreads before creating the thread for
+ * CPU 0, so in practice we ignore values <= 1.  This must be set at boot.
+ * We will create at most one thread per CPU.
+ */
+static int	netisr_maxthreads = 1;		/* Max number of threads. */
+TUNABLE_INT("net.isr.maxthreads", &netisr_maxthreads);
+SYSCTL_INT(_net_isr, OID_AUTO, maxthreads, CTLFLAG_RD,
+    &netisr_maxthreads, 0,
+    "Use at most this many CPUs for netisr processing");
+
+static int	netisr_bindthreads = 0;		/* Bind threads to CPUs. */
+TUNABLE_INT("net.isr.bindthreads", &netisr_bindthreads);
+SYSCTL_INT(_net_isr, OID_AUTO, bindthreads, CTLFLAG_RD,
+    &netisr_bindthreads, 0, "Bind netisr threads to CPUs.");
+
+/*
+ * Limit per-workstream queues to at most net.isr.maxqlimit, both for initial
+ * configuration and later modification using netisr_setqlimit().
+ */
+#define	NETISR_DEFAULT_MAXQLIMIT	10240
+static u_int	netisr_maxqlimit = NETISR_DEFAULT_MAXQLIMIT;
+TUNABLE_INT("net.isr.maxqlimit", &netisr_maxqlimit);
+SYSCTL_INT(_net_isr, OID_AUTO, maxqlimit, CTLFLAG_RD,
+    &netisr_maxqlimit, 0,
+    "Maximum netisr per-protocol, per-CPU queue depth.");
+
+/*
+ * The default per-workstream queue limit for protocols that don't initialize
+ * the nh_qlimit field of their struct netisr_handler.  If this is set above
+ * netisr_maxqlimit, we truncate it to the maximum during boot.
+ */
+#define	NETISR_DEFAULT_DEFAULTQLIMIT	256
+static u_int	netisr_defaultqlimit = NETISR_DEFAULT_DEFAULTQLIMIT;
+TUNABLE_INT("net.isr.defaultqlimit", &netisr_defaultqlimit);
+SYSCTL_INT(_net_isr, OID_AUTO, defaultqlimit, CTLFLAG_RD,
+    &netisr_defaultqlimit, 0,
+    "Default netisr per-protocol, per-CPU queue limit if not set by protocol");
+
+/*
+ * Each protocol is described by a struct netisr_proto, which holds all
+ * global per-protocol information.  This data structure is set up by
+ * netisr_register(), and derived from the public struct netisr_handler.
+ */
+struct netisr_proto {
+	const char	*np_name;	/* Character string protocol name. */
+	netisr_handler_t *np_handler;	/* Protocol handler. */
+	netisr_m2flow_t	*np_m2flow;	/* Query flow for untagged packet. */
+	netisr_m2cpuid_t *np_m2cpuid;	/* Query CPU to process packet on. */
+	u_int		 np_qlimit;	/* Maximum per-CPU queue depth. */
+	u_int		 np_policy;	/* Work placement policy. */
+};
+
+#define	NETISR_MAXPROT		32		/* Compile-time limit. */
+
+/*
+ * The np array describes all registered protocols, indexed by protocol
+ * number.
+ */
+static struct netisr_proto	np[NETISR_MAXPROT];
+
+/*
+ * Protocol-specific work for each workstream is described by struct
+ * netisr_work.  Each work descriptor consists of an mbuf queue and
+ * statistics.
+ */
+struct netisr_work {
+	/*
+	 * Packet queue, linked by m_nextpkt.
+	 */
+	struct mbuf	*nw_head;
+	struct mbuf	*nw_tail;
+	u_int		 nw_len;
+	u_int		 nw_qlimit;
+	u_int		 nw_watermark;
+
+	/*
+	 * Statistics -- written unlocked, but mostly from curcpu.
+	 */
+	u_int64_t	 nw_dispatched; /* Number of direct dispatches. */
+	u_int64_t	 nw_hybrid_dispatched; /* "" hybrid dispatches. */
+	u_int64_t	 nw_qdrops;	/* "" drops. */
+	u_int64_t	 nw_queued;	/* "" enqueues. */
+	u_int64_t	 nw_handled;	/* "" handled in worker. */
+};
+
+/*
+ * Workstreams hold a set of ordered work across each protocol, and are
+ * described by netisr_workstream.  Each workstream is associated with a
+ * worker thread, which in turn is pinned to a CPU.  Work associated with a
+ * workstream can be processd in other threads during direct dispatch;
+ * concurrent processing is prevented by the NWS_RUNNING flag, which
+ * indicates that a thread is already processing the work queue.
+ */
+struct netisr_workstream {
+	struct intr_event *nws_intr_event;	/* Handler for stream. */
+	void		*nws_swi_cookie;	/* swi(9) cookie for stream. */
+	struct mtx	 nws_mtx;		/* Synchronize work. */
+	u_int		 nws_cpu;		/* CPU pinning. */
+	u_int		 nws_flags;		/* Wakeup flags. */
+	u_int		 nws_pendingbits;	/* Scheduled protocols. */
+
+	/*
+	 * Each protocol has per-workstream data.
+	 */
+	struct netisr_work	nws_work[NETISR_MAXPROT];
+} __aligned(CACHE_LINE_SIZE);
+
+/*
+ * Per-CPU workstream data, indexed by CPU ID.
+ */
+static struct netisr_workstream		 nws[MAXCPU];
+
+/*
+ * Map contiguous values between 0 and nws_count into CPU IDs appropriate for
+ * indexing the nws[] array.  This allows constructions of the form
+ * nws[nws_array(arbitraryvalue % nws_count)].
+ */
+static u_int				 nws_array[MAXCPU];
+
+/*
+ * Number of registered workstreams.  Will be at most the number of running
+ * CPUs once fully started.
+ */
+static u_int				 nws_count;
+SYSCTL_INT(_net_isr, OID_AUTO, numthreads, CTLFLAG_RD,
+    &nws_count, 0, "Number of extant netisr threads.");
+
+/*
+ * Per-workstream flags.
+ */
+#define	NWS_RUNNING	0x00000001	/* Currently running in a thread. */
+#define	NWS_DISPATCHING	0x00000002	/* Currently being direct-dispatched. */
+#define	NWS_SCHEDULED	0x00000004	/* Signal issued. */
+
+/*
+ * Synchronization for each workstream: a mutex protects all mutable fields
+ * in each stream, including per-protocol state (mbuf queues).  The SWI is
+ * woken up if asynchronous dispatch is required.
+ */
+#define	NWS_LOCK(s)		mtx_lock(&(s)->nws_mtx)
+#define	NWS_LOCK_ASSERT(s)	mtx_assert(&(s)->nws_mtx, MA_OWNED)
+#define	NWS_UNLOCK(s)		mtx_unlock(&(s)->nws_mtx)
+#define	NWS_SIGNAL(s)		swi_sched((s)->nws_swi_cookie, 0)

-struct netisr {
-	netisr_t	*ni_handler;
-	struct ifqueue	*ni_queue;
-	int		ni_flags;
-} netisrs[32];
+/*
+ * Utility routines for protocols that implement their own mapping of flows
+ * to CPUs.
+ */
+u_int
+netisr_get_cpucount(void)
+{
+
+	return (nws_count);
+}

-static void *net_ih;
+u_int
+netisr_get_cpuid(u_int cpunumber)
+{
+
+	KASSERT(cpunumber < nws_count, ("%s: %u > %u", __func__, cpunumber,
+	    nws_count));
+
+	return (nws_array[cpunumber]);
+}
+
+/*
+ * The default implementation of -> CPU ID mapping.
+ *
+ * Non-static so that protocols can use it to map their own work to specific
+ * CPUs in a manner consistent to netisr for affinity purposes.
+ */
+u_int
+netisr_default_flow2cpu(u_int flowid)
+{

+	return (nws_array[flowid % nws_count]);
+}
+
+/*
+ * Register a new netisr handler, which requires initializing per-protocol
+ * fields for each workstream.  All netisr work is briefly suspended while
+ * the protocol is installed.
+ */
  void
-legacy_setsoftnet(void)
+netisr_register(const struct netisr_handler *nhp)
  {
-	swi_sched(net_ih, 0);
+	struct netisr_work *npwp;
+	const char *name;
+	u_int i, proto;
+
+	proto = nhp->nh_proto;
+	name = nhp->nh_name;
+
+	/*
+	 * Test that the requested registration is valid.
+	 */
+	KASSERT(nhp->nh_name != NULL,
+	    ("%s: nh_name NULL for %u", __func__, proto));
+	KASSERT(nhp->nh_handler != NULL,
+	    ("%s: nh_handler NULL for %s", __func__, name));
+	KASSERT(nhp->nh_policy == NETISR_POLICY_SOURCE ||
+	    nhp->nh_policy == NETISR_POLICY_FLOW ||
+	    nhp->nh_policy == NETISR_POLICY_CPU,
+	    ("%s: unsupported nh_policy %u for %s", __func__,
+	    nhp->nh_policy, name));
+	KASSERT(nhp->nh_policy == NETISR_POLICY_FLOW ||
+	    nhp->nh_m2flow == NULL,
+	    ("%s: nh_policy != FLOW but m2flow defined for %s", __func__,
+	    name));
+	KASSERT(nhp->nh_policy == NETISR_POLICY_CPU || nhp->nh_m2cpuid == NULL,
+	    ("%s: nh_policy != CPU but m2cpuid defined for %s", __func__,
+	    name));
+	KASSERT(nhp->nh_policy != NETISR_POLICY_CPU || nhp->nh_m2cpuid != NULL,
+	    ("%s: nh_policy == CPU but m2cpuid not defined for %s", __func__,
+	    name));
+	KASSERT(proto < NETISR_MAXPROT,
+	    ("%s(%u, %s): protocol too big", __func__, proto, name));
+
+	/*
+	 * Test that no existing registration exists for this protocol.
+	 */
+	NETISR_WLOCK();
+	KASSERT(np[proto].np_name == NULL,
+	    ("%s(%u, %s): name present", __func__, proto, name));
+	KASSERT(np[proto].np_handler == NULL,
+	    ("%s(%u, %s): handler present", __func__, proto, name));
+
+	np[proto].np_name = name;
+	np[proto].np_handler = nhp->nh_handler;
+	np[proto].np_m2flow = nhp->nh_m2flow;
+	np[proto].np_m2cpuid = nhp->nh_m2cpuid;
+	if (nhp->nh_qlimit == 0)
+		np[proto].np_qlimit = netisr_defaultqlimit;
+	else if (nhp->nh_qlimit > netisr_maxqlimit) {
+		printf("%s: %s requested queue limit %u capped to "
+		    "net.isr.maxqlimit %u\n", __func__, name, nhp->nh_qlimit,
+		    netisr_maxqlimit);
+		np[proto].np_qlimit = netisr_maxqlimit;
+	} else
+		np[proto].np_qlimit = nhp->nh_qlimit;
+	np[proto].np_policy = nhp->nh_policy;
+	for (i = 0; i < MAXCPU; i++) {
+		npwp = &nws[i].nws_work[proto];
+		bzero(npwp, sizeof(*npwp));
+		npwp->nw_qlimit = np[proto].np_qlimit;
+	}
+	NETISR_WUNLOCK();
  }

+/*
+ * Clear drop counters across all workstreams for a protocol.
+ */
  void
-netisr_register(int num, netisr_t *handler, struct ifqueue *inq, int flags)
+netisr_clearqdrops(const struct netisr_handler *nhp)
  {
-
-	KASSERT(!(num < 0 || num >= (sizeof(netisrs)/sizeof(*netisrs))),
-	    ("bad isr %d", num));
-	KASSERT(flags == 0, ("netisr_register: bad flags 0x%x\n", flags));
-	netisrs[num].ni_handler = handler;
-	netisrs[num].ni_queue = inq;
-	netisrs[num].ni_flags = flags;
+	struct netisr_work *npwp;
+#ifdef INVARIANTS
+	const char *name;
+#endif
+	u_int i, proto;
+
+	proto = nhp->nh_proto;
+#ifdef INVARIANTS
+	name = nhp->nh_name;
+#endif
+	KASSERT(proto < NETISR_MAXPROT,
+	    ("%s(%u): protocol too big for %s", __func__, proto, name));
+
+	NETISR_WLOCK();
+	KASSERT(np[proto].np_handler != NULL,
+	    ("%s(%u): protocol not registered for %s", __func__, proto,
+	    name));
+
+	for (i = 0; i < MAXCPU; i++) {
+		npwp = &nws[i].nws_work[proto];
+		npwp->nw_qdrops = 0;
+	}
+	NETISR_WUNLOCK();
  }

+/*
+ * Query the current drop counters across all workstreams for a protocol.
+ */
  void
-netisr_unregister(int num)
+netisr_getqdrops(const struct netisr_handler *nhp, u_int64_t *qdropp)
  {
-	struct netisr *ni;
-
-	KASSERT(!(num < 0 || num >= (sizeof(netisrs)/sizeof(*netisrs))),
-	    ("bad isr %d", num));
-	ni = &netisrs[num];
-	ni->ni_handler = NULL;
-	if (ni->ni_queue != NULL)
-		IF_DRAIN(ni->ni_queue);
-	ni->ni_queue = NULL;
+	struct netisr_work *npwp;
+	struct rm_priotracker tracker;
+#ifdef INVARIANTS
+	const char *name;
+#endif
+	u_int i, proto;
+
+	*qdropp = 0;
+	proto = nhp->nh_proto;
+#ifdef INVARIANTS
+	name = nhp->nh_name;
+#endif
+	KASSERT(proto < NETISR_MAXPROT,
+	    ("%s(%u): protocol too big for %s", __func__, proto, name));
+
+	NETISR_RLOCK(&tracker);
+	KASSERT(np[proto].np_handler != NULL,
+	    ("%s(%u): protocol not registered for %s", __func__, proto,
+	    name));
+
+	for (i = 0; i < MAXCPU; i++) {
+		npwp = &nws[i].nws_work[proto];
+		*qdropp += npwp->nw_qdrops;
+	}
+	NETISR_RUNLOCK(&tracker);
  }

-struct isrstat {
-	int	isrs_count;			/* dispatch count */
-	int	isrs_directed;			/* ...directly dispatched */
-	int	isrs_deferred;			/* ...queued instead */
-	int	isrs_queued;			/* intentionally queueued */
-	int	isrs_drop;			/* dropped 'cuz no handler */
-	int	isrs_swi_count;			/* swi_net handlers called */
-};
-static struct isrstat isrstat;
+/*
+ * Query the current queue limit for per-workstream queues for a protocol.
+ */
+void
+netisr_getqlimit(const struct netisr_handler *nhp, u_int *qlimitp)
+{
+	struct rm_priotracker tracker;
+#ifdef INVARIANTS
+	const char *name;
+#endif
+	u_int proto;

-SYSCTL_NODE(_net, OID_AUTO, isr, CTLFLAG_RW, 0, "netisr counters");
+	proto = nhp->nh_proto;
+#ifdef INVARIANTS
+	name = nhp->nh_name;
+#endif
+	KASSERT(proto < NETISR_MAXPROT,
+	    ("%s(%u): protocol too big for %s", __func__, proto, name));

-static int	netisr_direct = 1;
-SYSCTL_INT(_net_isr, OID_AUTO, direct, CTLFLAG_RW,
-    &netisr_direct, 0, "enable direct dispatch");
-TUNABLE_INT("net.isr.direct", &netisr_direct);
+	NETISR_RLOCK(&tracker);
+	KASSERT(np[proto].np_handler != NULL,
+	    ("%s(%u): protocol not registered for %s", __func__, proto,
+	    name));
+	*qlimitp = np[proto].np_qlimit;
+	NETISR_RUNLOCK(&tracker);
+}
+
+/*
+ * Update the queue limit across per-workstream queues for a protocol.  We
+ * simply change the limits, and don't drain overflowed packets as they will
+ * (hopefully) take care of themselves shortly.
+ */
+int
+netisr_setqlimit(const struct netisr_handler *nhp, u_int qlimit)
+{
+	struct netisr_work *npwp;
+#ifdef INVARIANTS
+	const char *name;
+#endif
+	u_int i, proto;
+
+	if (qlimit > netisr_maxqlimit)
+		return (EINVAL);
+
+	proto = nhp->nh_proto;
+#ifdef INVARIANTS
+	name = nhp->nh_name;
+#endif
+	KASSERT(proto < NETISR_MAXPROT,
+	    ("%s(%u): protocol too big for %s", __func__, proto, name));
+
+	NETISR_WLOCK();
+	KASSERT(np[proto].np_handler != NULL,
+	    ("%s(%u): protocol not registered for %s", __func__, proto,
+	    name));
+
+	np[proto].np_qlimit = qlimit;
+	for (i = 0; i < MAXCPU; i++) {
+		npwp = &nws[i].nws_work[proto];
+		npwp->nw_qlimit = qlimit;
+	}
+	NETISR_WUNLOCK();
+	return (0);
+}

-SYSCTL_INT(_net_isr, OID_AUTO, count, CTLFLAG_RD,
-    &isrstat.isrs_count, 0, "");
-SYSCTL_INT(_net_isr, OID_AUTO, directed, CTLFLAG_RD,
-    &isrstat.isrs_directed, 0, "");
-SYSCTL_INT(_net_isr, OID_AUTO, deferred, CTLFLAG_RD,
-    &isrstat.isrs_deferred, 0, "");
-SYSCTL_INT(_net_isr, OID_AUTO, queued, CTLFLAG_RD,
-    &isrstat.isrs_queued, 0, "");
-SYSCTL_INT(_net_isr, OID_AUTO, drop, CTLFLAG_RD,
-    &isrstat.isrs_drop, 0, "");
-SYSCTL_INT(_net_isr, OID_AUTO, swi_count, CTLFLAG_RD,
-    &isrstat.isrs_swi_count, 0, "");
-
-/*
- * Process all packets currently present in a netisr queue.  Used to
- * drain an existing set of packets waiting for processing when we
- * begin direct dispatch, to avoid processing packets out of order.
+/*
+ * Drain all packets currently held in a particular protocol work queue.
   */
  static void
-netisr_processqueue(struct netisr *ni)
+netisr_drain_proto(struct netisr_work *npwp)
  {
  	struct mbuf *m;

-	for (;;) {
-		IF_DEQUEUE(ni->ni_queue, m);
-		if (m == NULL)
-			break;
-		VNET_ASSERT(m->m_pkthdr.rcvif != NULL);
-		CURVNET_SET(m->m_pkthdr.rcvif->if_vnet);
-		ni->ni_handler(m);
-		CURVNET_RESTORE();
+	/*
+	 * We would assert the lock on the workstream but it's not passed in.
+	 */
+	while ((m = npwp->nw_head) != NULL) {
+		npwp->nw_head = m->m_nextpkt;
+		m->m_nextpkt = NULL;
+		if (npwp->nw_head == NULL)
+			npwp->nw_tail = NULL;
+		npwp->nw_len--;
+		m_freem(m);
  	}
+	KASSERT(npwp->nw_tail == NULL, ("%s: tail", __func__));
+	KASSERT(npwp->nw_len == 0, ("%s: len", __func__));
  }

  /*
- * Call the netisr directly instead of queueing the packet, if possible.
+ * Remove the registration of a network protocol, which requires clearing
+ * per-protocol fields across all workstreams, including freeing all mbufs in
+ * the queues at time of unregister.  All work in netisr is briefly suspended
+ * while this takes place.
   */
  void
-netisr_dispatch(int num, struct mbuf *m)
+netisr_unregister(const struct netisr_handler *nhp)
  {
-	struct netisr *ni;
-
-	isrstat.isrs_count++;		/* XXX redundant */
-	KASSERT(!(num < 0 || num >= (sizeof(netisrs)/sizeof(*netisrs))),
-	    ("bad isr %d", num));
-	ni = &netisrs[num];
-	if (ni->ni_queue == NULL) {
-		isrstat.isrs_drop++;
-		m_freem(m);
-		return;
+	struct netisr_work *npwp;
+#ifdef INVARIANTS
+	const char *name;
+#endif
+	u_int i, proto;
+
+	proto = nhp->nh_proto;
+#ifdef INVARIANTS
+	name = nhp->nh_name;
+#endif
+	KASSERT(proto < NETISR_MAXPROT,
+	    ("%s(%u): protocol too big for %s", __func__, proto, name));
+
+	NETISR_WLOCK();
+	KASSERT(np[proto].np_handler != NULL,
+	    ("%s(%u): protocol not registered for %s", __func__, proto,
+	    name));
+
+	np[proto].np_name = NULL;
+	np[proto].np_handler = NULL;
+	np[proto].np_m2flow = NULL;
+	np[proto].np_m2cpuid = NULL;
+	np[proto].np_qlimit = 0;
+	np[proto].np_policy = 0;
+	for (i = 0; i < MAXCPU; i++) {
+		npwp = &nws[i].nws_work[proto];
+		netisr_drain_proto(npwp);
+		bzero(npwp, sizeof(*npwp));
  	}
+	NETISR_WUNLOCK();
+}
+
+/*
+ * Look up the workstream given a packet and source identifier.  Do this by
+ * checking the protocol's policy, and optionally call out to the protocol
+ * for assistance if required.
+ */
+static struct mbuf *
+netisr_select_cpuid(struct netisr_proto *npp, uintptr_t source,
+    struct mbuf *m, u_int *cpuidp)
+{
+	struct ifnet *ifp;
+
+	NETISR_LOCK_ASSERT();

  	/*
-	 * Directly dispatch handling of this packet, if permitted by global
-	 * policy.  Source ordering is maintained by virtue of callers
-	 * consistently calling one of queued or direct dispatch.
+	 * In the event we have only one worker, shortcut and deliver to it
+	 * without further ado.
  	 */
-	if (netisr_direct) {
-		isrstat.isrs_directed++;
-		ni->ni_handler(m);
+	if (nws_count == 1) {
+		*cpuidp = nws_array[0];
+		return (m);
+	}
+
+	/*
+	 * What happens next depends on the policy selected by the protocol.
+	 * If we want to support per-interface policies, we should do that
+	 * here first.
+	 */
+	switch (npp->np_policy) {
+	case NETISR_POLICY_CPU:
+		return (npp->np_m2cpuid(m, source, cpuidp));
+
+	case NETISR_POLICY_FLOW:
+		if (!(m->m_flags & M_FLOWID) && npp->np_m2flow != NULL) {
+			m = npp->np_m2flow(m, source);
+			if (m == NULL)
+				return (NULL);
+		}
+		if (m->m_flags & M_FLOWID) {
+			*cpuidp =
+			    netisr_default_flow2cpu(m->m_pkthdr.flowid);
+			return (m);
+		}
+		/* FALLTHROUGH */
+
+	case NETISR_POLICY_SOURCE:
+		ifp = m->m_pkthdr.rcvif;
+		if (ifp != NULL)
+			*cpuidp = nws_array[(ifp->if_index + source) %
+			    nws_count];
+		else
+			*cpuidp = nws_array[source % nws_count];
+		return (m);
+
+	default:
+		panic("%s: invalid policy %u for %s", __func__,
+		    npp->np_policy, npp->np_name);
+	}
+}
+
+/*
+ * Process packets associated with a workstream and protocol.  For reasons of
+ * fairness, we process up to one complete netisr queue at a time, moving the
+ * queue to a stack-local queue for processing, but do not loop refreshing
+ * from the global queue.  The caller is responsible for deciding whether to
+ * loop, and for setting the NWS_RUNNING flag.  The passed workstream will be
+ * locked on entry and relocked before return, but will be released while
+ * processing.  The number of packets processed is returned.
+ */
+static u_int
+netisr_process_workstream_proto(struct netisr_workstream *nwsp, u_int proto)
+{
+	struct netisr_work local_npw, *npwp;
+	u_int handled;
+	struct mbuf *m;
+
+	NETISR_LOCK_ASSERT();
+	NWS_LOCK_ASSERT(nwsp);
+
+	KASSERT(nwsp->nws_flags & NWS_RUNNING,
+	    ("%s(%u): not running", __func__, proto));
+	KASSERT(proto >= 0 && proto < NETISR_MAXPROT,
+	    ("%s(%u): invalid proto\n", __func__, proto));
+
+	npwp = &nwsp->nws_work[proto];
+	if (npwp->nw_len == 0)
+		return (0);
+
+	/*
+	 * Move the global work queue to a thread-local work queue.
+	 *
+	 * Notice that this means the effective maximum length of the queue
+	 * is actually twice that of the maximum queue length specified in
+	 * the protocol registration call.
+	 */
+	handled = npwp->nw_len;
+	local_npw = *npwp;
+	npwp->nw_head = NULL;
+	npwp->nw_tail = NULL;
+	npwp->nw_len = 0;
+	nwsp->nws_pendingbits &= ~(1 << proto);
+	NWS_UNLOCK(nwsp);
+	while ((m = local_npw.nw_head) != NULL) {
+		local_npw.nw_head = m->m_nextpkt;
+		m->m_nextpkt = NULL;
+		if (local_npw.nw_head == NULL)
+			local_npw.nw_tail = NULL;
+		local_npw.nw_len--;
+		VNET_ASSERT(m->m_pkthdr.rcvif != NULL);
+		CURVNET_SET(m->m_pkthdr.rcvif->if_vnet);
+		np[proto].np_handler(m);
+		CURVNET_RESTORE();
+	}
+	KASSERT(local_npw.nw_len == 0,
+	    ("%s(%u): len %u", __func__, proto, local_npw.nw_len));
+	NWS_LOCK(nwsp);
+	npwp->nw_handled += handled;
+	return (handled);
+}
+
+/*
+ * SWI handler for netisr -- processes prackets in a set of workstreams that
+ * it owns, woken up by calls to NWS_SIGNAL().  If this workstream is already
+ * being direct dispatched, go back to sleep and wait for the dispatching
+ * thread to wake us up again.
+ */
+static void
+swi_net(void *arg)
+{
+#ifdef NETISR_LOCKING
+	struct rm_priotracker tracker;
+#endif
+	struct netisr_workstream *nwsp;
+	u_int bits, prot;
+
+	nwsp = arg;
+
+#ifdef DEVICE_POLLING
+	KASSERT(nws_count == 1,
+	    ("%s: device_polling but nws_count != 1", __func__));
+	netisr_poll();
+#endif
+#ifdef NETISR_LOCKING
+	NETISR_RLOCK(&tracker);
+#endif
+	NWS_LOCK(nwsp);
+	KASSERT(!(nwsp->nws_flags & NWS_RUNNING), ("swi_net: running"));
+	if (nwsp->nws_flags & NWS_DISPATCHING)
+		goto out;
+	nwsp->nws_flags |= NWS_RUNNING;
+	nwsp->nws_flags &= ~NWS_SCHEDULED;
+	while ((bits = nwsp->nws_pendingbits) != 0) {
+		while ((prot = ffs(bits)) != 0) {
+			prot--;
+			bits &= ~(1 << prot);
+			(void)netisr_process_workstream_proto(nwsp, prot);
+		}
+	}
+	nwsp->nws_flags &= ~NWS_RUNNING;
+out:
+	NWS_UNLOCK(nwsp);
+#ifdef NETISR_LOCKING
+	NETISR_RUNLOCK(&tracker);
+#endif
+#ifdef DEVICE_POLLING
+	netisr_pollmore();
+#endif
+}
+
+static int
+netisr_queue_workstream(struct netisr_workstream *nwsp, u_int proto,
+    struct netisr_work *npwp, struct mbuf *m, int *dosignalp)
+{
+
+	NWS_LOCK_ASSERT(nwsp);
+
+	*dosignalp = 0;
+	if (npwp->nw_len < npwp->nw_qlimit) {
+		m->m_nextpkt = NULL;
+		if (npwp->nw_head == NULL) {
+			npwp->nw_head = m;
+			npwp->nw_tail = m;
+		} else {
+			npwp->nw_tail->m_nextpkt = m;
+			npwp->nw_tail = m;
+		}
+		npwp->nw_len++;
+		if (npwp->nw_len > npwp->nw_watermark)
+			npwp->nw_watermark = npwp->nw_len;
+		nwsp->nws_pendingbits |= (1 << proto);
+		if (!(nwsp->nws_flags &
+		    (NWS_RUNNING | NWS_DISPATCHING | NWS_SCHEDULED))) {
+			nwsp->nws_flags |= NWS_SCHEDULED;
+			*dosignalp = 1;	/* Defer until unlocked. */
+		}

*** DIFF OUTPUT TRUNCATED AT 1000 LINES ***
Received on Mon Jun 01 2009 - 08:44:55 UTC

This archive was generated by hypermail 2.4.0 : Wed May 19 2021 - 11:39:49 UTC