sys/net/netisr.h

   1 /*
   2  * Copyright (c) 2004 Jeffrey M. Hsu.  All rights reserved.
   3  * Copyright (c) 2004 The DragonFly Project.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to The DragonFly Project
   6  * by Jeffrey M. Hsu.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of The DragonFly Project nor the names of its
  17  *    contributors may be used to endorse or promote products derived
  18  *    from this software without specific, prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  */
  33
  34 /*
  35  * Copyright (c) 2004 Jeffrey M. Hsu.  All rights reserved.
  36  *
  37  * License terms: all terms for the DragonFly license above plus the following:
  38  *
  39  * 4. All advertising materials mentioning features or use of this software
  40  *    must display the following acknowledgement:
  41  *
  42  *      This product includes software developed by Jeffrey M. Hsu
  43  *      for the DragonFly Project.
  44  *
  45  *    This requirement may be waived with permission from Jeffrey Hsu.
  46  *    This requirement will sunset and may be removed on July 8 2005,
  47  *    after which the standard DragonFly license (as shown above) will
  48  *    apply.
  49  */
  50
  51 /*
  52  * Copyright (c) 1980, 1986, 1989, 1993
  53  *      The Regents of the University of California.  All rights reserved.
  54  *
  55  * Redistribution and use in source and binary forms, with or without
  56  * modification, are permitted provided that the following conditions
  57  * are met:
  58  * 1. Redistributions of source code must retain the above copyright
  59  *    notice, this list of conditions and the following disclaimer.
  60  * 2. Redistributions in binary form must reproduce the above copyright
  61  *    notice, this list of conditions and the following disclaimer in the
  62  *    documentation and/or other materials provided with the distribution.
  63  * 3. All advertising materials mentioning features or use of this software
  64  *    must display the following acknowledgement:
  65  *      This product includes software developed by the University of
  66  *      California, Berkeley and its contributors.
  67  * 4. Neither the name of the University nor the names of its contributors
  68  *    may be used to endorse or promote products derived from this software
  69  *    without specific prior written permission.
  70  *
  71  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  72  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  73  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  74  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  75  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  76  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  77  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  78  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  79  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  80  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  81  * SUCH DAMAGE.
  82  *
  83  *      @(#)netisr.h    8.1 (Berkeley) 6/10/93
  84  * $FreeBSD: src/sys/net/netisr.h,v 1.21.2.5 2002/02/09 23:02:39 luigi Exp $
  85  * $DragonFly: src/sys/net/netisr.h,v 1.24 2006/06/13 08:12:03 dillon Exp $
  86  */
  87
  88 #ifndef _NET_NETISR_H_
  89 #define _NET_NETISR_H_
  90
  91 /*
  92  * The networking code runs off software interrupts.
  93  *
  94  * You can switch into the network by doing splnet() and return by splx().
  95  * The software interrupt level for the network is higher than the software
  96  * level for the clock (so you can enter the network in routines called
  97  * at timeout time).
  98  */
  99
 100 /*
 101  * Each ``pup-level-1'' input queue has a bit in a ``netisr'' status
 102  * word which is used to de-multiplex a single software
 103  * interrupt used for scheduling the network code to calls
 104  * on the lowest level routine of each protocol.
 105  */
 106 #define NETISR_RESERVED0 0              /* cannot be used */
 107 #define NETISR_POLL     1               /* polling callback */
 108 #define NETISR_IP       2               /* same as AF_INET */
 109 #define NETISR_NS       6               /* same as AF_NS */
 110 #define NETISR_AARP     15              /* Appletalk ARP */
 111 #define NETISR_ATALK2   16              /* Appletalk phase 2 */
 112 #define NETISR_ATALK1   17              /* Appletalk phase 1 */
 113 #define NETISR_ARP      18              /* same as AF_LINK */
 114 #define NETISR_IPX      23              /* same as AF_IPX */
 115 #define NETISR_USB      25              /* USB soft interrupt */
 116 #define NETISR_PPP      27              /* PPP soft interrupt */
 117 #define NETISR_IPV6     28              /* same as AF_INET6 */
 118 #define NETISR_NATM     29              /* same as AF_NATM */
 119 #define NETISR_NETGRAPH 30              /* same as AF_NETGRAPH */
 120 #define NETISR_POLLMORE 31              /* check if we need more polling */
 121
 122 #define NETISR_MAX      32
 123
 124 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 125
 126 #ifndef _SYS_TYPES_H_
 127 #include <sys/types.h>
 128 #endif
 129 #ifndef _SYS_QUEUE_H_
 130 #include <sys/queue.h>
 131 #endif
 132 #ifndef _SYS_PROTOSW_H_
 133 #include <sys/protosw.h>
 134 #endif
 135 #ifndef _SYS_MSGPORT_H_
 136 #include <sys/msgport.h>
 137 #endif
 138
 139 TAILQ_HEAD(notifymsglist, netmsg_so_notify);
 140
 141 struct netmsg;
 142
 143 typedef int (*netisr_fn_t)(struct netmsg *);
 144 typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg *);
 145
 146 /*
 147  * Base class.  All net messages must start with the same fields.
 148  */
 149 struct netmsg {
 150     struct lwkt_msg     nm_lmsg;
 151 };
 152
 153 struct netmsg_packet {
 154     struct lwkt_msg     nm_lmsg;
 155     struct mbuf         *nm_packet;
 156 };
 157
 158 struct netmsg_pr_ctloutput {
 159     struct lwkt_msg     nm_lmsg;
 160     int                 (*nm_prfn) (struct socket *, struct sockopt *);
 161     struct socket       *nm_so;
 162     struct sockopt      *nm_sopt;
 163 };
 164
 165 struct netmsg_pr_timeout {
 166     struct lwkt_msg     nm_lmsg;
 167     int                 (*nm_prfn) (void);
 168 };
 169
 170 struct netmsg_so_notify {
 171     struct lwkt_msg                     nm_lmsg;
 172     msg_predicate_fn_t                  nm_predicate;
 173     struct socket                       *nm_so;
 174     int                                 nm_fflags; /* flags e.g. FNONBLOCK */
 175     int                                 nm_etype;  /* receive or send event */
 176     TAILQ_ENTRY(netmsg_so_notify)       nm_list;
 177 };
 178
 179 #define NM_REVENT       0x1             /* event on receive buffer */
 180 #define NM_SEVENT       0x2             /* event on send buffer */
 181
 182 #endif
 183
 184 #ifdef _KERNEL
 185
 186 /*
 187  * for dispatching pr_ functions,
 188  * until they can be converted to message-passing
 189  */
 190 int netmsg_pru_abort(lwkt_msg_t);
 191 int netmsg_pru_accept(lwkt_msg_t);
 192 int netmsg_pru_attach(lwkt_msg_t);
 193 int netmsg_pru_bind(lwkt_msg_t);
 194 int netmsg_pru_connect(lwkt_msg_t);
 195 int netmsg_pru_connect2(lwkt_msg_t);
 196 int netmsg_pru_control(lwkt_msg_t);
 197 int netmsg_pru_detach(lwkt_msg_t);
 198 int netmsg_pru_disconnect(lwkt_msg_t);
 199 int netmsg_pru_listen(lwkt_msg_t);
 200 int netmsg_pru_peeraddr(lwkt_msg_t);
 201 int netmsg_pru_rcvd(lwkt_msg_t);
 202 int netmsg_pru_rcvoob(lwkt_msg_t);
 203 int netmsg_pru_send(lwkt_msg_t);
 204 int netmsg_pru_sense(lwkt_msg_t);
 205 int netmsg_pru_shutdown(lwkt_msg_t);
 206 int netmsg_pru_sockaddr(lwkt_msg_t);
 207
 208 int netmsg_pru_sopoll(lwkt_msg_t);
 209
 210 int netmsg_pr_ctloutput(lwkt_msg_t);
 211 int netmsg_pr_timeout(lwkt_msg_t);
 212
 213 int netmsg_so_notify(lwkt_msg_t);
 214 int netmsg_so_notify_abort(lwkt_msg_t);
 215
 216 #endif
 217
 218 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 219
 220 typedef lwkt_port_t (*lwkt_portfn_t)(struct mbuf **);
 221
 222 struct netisr {
 223         lwkt_port       ni_port;        /* must be first */
 224         lwkt_portfn_t   ni_mport;
 225         netisr_fn_t     ni_handler;
 226         struct netmsg   ni_netmsg;      /* for sched_netisr() (no-data) */
 227 };
 228
 229 #endif
 230
 231 #ifdef _KERNEL
 232
 233 extern lwkt_port netisr_afree_rport;
 234
 235 lwkt_port_t     cpu0_portfn(struct mbuf **mptr);
 236 lwkt_port_t     cpu_portfn(int cpu);
 237 void            netisr_dispatch(int, struct mbuf *);
 238 int             netisr_queue(int, struct mbuf *);
 239 void            netisr_register(int, lwkt_portfn_t, netisr_fn_t);
 240 int             netisr_unregister(int);
 241 void            netmsg_service_port_init(lwkt_port_t);
 242 void            netmsg_service_loop(void *arg);
 243 void            netmsg_service_sync(void);
 244 void            schednetisr(int);
 245
 246 #endif  /* _KERNEL */
 247
 248 #endif  /* _NET_NETISR_H_ */