2 * Copyright (c) 2007-2009 Robert N. M. Watson
3 * Copyright (c) 2010 Juniper Networks, Inc.
6 * This software was developed by Robert N. M. Watson under contract
7 * to Juniper Networks, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
18 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #ifndef _NET_NETISR_INTERNAL_H_
34 #define _NET_NETISR_INTERNAL_H_
36 #ifndef _WANT_NETISR_INTERNAL
37 #error "no user-serviceable parts inside"
41 * These definitions are private to the netisr implementation, but provided
42 * here for use by post-mortem crashdump analysis tools. They should not be
43 * used in any other context as they can and will change. Public definitions
44 * may be found in netisr.h.
48 typedef void *netisr_handler_t;
49 typedef void *netisr_m2flow_t;
50 typedef void *netisr_m2cpuid_t;
51 typedef void *netisr_drainedcpu_t;
55 * Each protocol is described by a struct netisr_proto, which holds all
56 * global per-protocol information. This data structure is set up by
57 * netisr_register(), and derived from the public struct netisr_handler.
60 const char *np_name; /* Character string protocol name. */
61 netisr_handler_t *np_handler; /* Protocol handler. */
62 netisr_m2flow_t *np_m2flow; /* Query flow for untagged packet. */
63 netisr_m2cpuid_t *np_m2cpuid; /* Query CPU to process packet on. */
64 netisr_drainedcpu_t *np_drainedcpu; /* Callback when drained a queue. */
65 u_int np_qlimit; /* Maximum per-CPU queue depth. */
66 u_int np_policy; /* Work placement policy. */
69 #define NETISR_MAXPROT 16 /* Compile-time limit. */
72 * Protocol-specific work for each workstream is described by struct
73 * netisr_work. Each work descriptor consists of an mbuf queue and
78 * Packet queue, linked by m_nextpkt.
87 * Statistics -- written unlocked, but mostly from curcpu.
89 u_int64_t nw_dispatched; /* Number of direct dispatches. */
90 u_int64_t nw_hybrid_dispatched; /* "" hybrid dispatches. */
91 u_int64_t nw_qdrops; /* "" drops. */
92 u_int64_t nw_queued; /* "" enqueues. */
93 u_int64_t nw_handled; /* "" handled in worker. */
97 * Workstreams hold a queue of ordered work across each protocol, and are
98 * described by netisr_workstream. Each workstream is associated with a
99 * worker thread, which in turn is pinned to a CPU. Work associated with a
100 * workstream can be processd in other threads during direct dispatch;
101 * concurrent processing is prevented by the NWS_RUNNING flag, which
102 * indicates that a thread is already processing the work queue. It is
103 * important to prevent a directly dispatched packet from "skipping ahead" of
104 * work already in the workstream queue.
106 struct netisr_workstream {
107 struct intr_event *nws_intr_event; /* Handler for stream. */
108 void *nws_swi_cookie; /* swi(9) cookie for stream. */
109 struct mtx nws_mtx; /* Synchronize work. */
110 u_int nws_cpu; /* CPU pinning. */
111 u_int nws_flags; /* Wakeup flags. */
112 u_int nws_pendingbits; /* Scheduled protocols. */
115 * Each protocol has per-workstream data.
117 struct netisr_work nws_work[NETISR_MAXPROT];
118 } __aligned(CACHE_LINE_SIZE);
121 * Per-workstream flags.
123 #define NWS_RUNNING 0x00000001 /* Currently running in a thread. */
124 #define NWS_DISPATCHING 0x00000002 /* Currently being direct-dispatched. */
125 #define NWS_SCHEDULED 0x00000004 /* Signal issued. */
127 #endif /* !_NET_NETISR_INTERNAL_H_ */