sys/net/netmsg.h

   1 /*
   2  * Copyright (c) 2003 Jeffrey Hsu
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Jeffrey M. Hsu.
  16  * 4. The name of the author may not be used to endorse or promote products
  17  *    derived from this software without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  20  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  21  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  22  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  23  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  24  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  28  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  29  *
  30  * $DragonFly: src/sys/net/netmsg.h,v 1.10 2008/10/27 02:56:30 sephe Exp $
  31  */
  32
  33 #ifndef _NET_NETMSG_H_
  34 #define _NET_NETMSG_H_
  35
  36 #ifndef _SYS_THREAD_H_
  37 #include <sys/thread.h>
  38 #endif
  39 #ifndef _SYS_PROTOSW_H_
  40 #include <sys/protosw.h>
  41 #endif
  42
  43 struct pktinfo;
  44
  45 typedef void (*netisr_fn_t)(netmsg_t);
  46 typedef void (*netisr_ru_t)(void);
  47 typedef void (*netisr_cpufn_t)(struct mbuf **, int);
  48 typedef void (*netisr_hashck_t)(struct mbuf *, const struct pktinfo *);
  49
  50 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  51
  52 /*
  53  * The base netmsg prefixes all netmsgs and includes an embedded LWKT
  54  * message.
  55  */
  56 struct netmsg_base {
  57         struct lwkt_msg         lmsg;
  58         netisr_fn_t             nm_dispatch;
  59         struct socket           *nm_so;
  60 };
  61
  62 typedef struct netmsg_base *netmsg_base_t;
  63
  64 /*
  65  * NETISR messages
  66  *
  67  * NOTE:
  68  * - netmsg_packet is embedded in mbufs.
  69  * - netmsg_pru_send is embedded in mbufs.
  70  */
  71 TAILQ_HEAD(notifymsglist, netmsg_so_notify);
  72
  73 struct netmsg_packet {
  74         struct netmsg_base      base;
  75         struct mbuf             *nm_packet;
  76         int                     nm_nxt;
  77 };
  78
  79 struct netmsg_pr_timeout {
  80         struct netmsg_base      base;
  81 };
  82
  83 struct netmsg_so_notify;
  84 typedef __boolean_t (*msg_predicate_fn_t)(struct netmsg_so_notify *);
  85
  86 struct netmsg_so_notify {
  87         struct netmsg_base      base;
  88         msg_predicate_fn_t      nm_predicate;
  89         int                     nm_fflags; /* flags e.g. FNONBLOCK */
  90         int                     nm_etype;  /* receive or send event */
  91         TAILQ_ENTRY(netmsg_so_notify) nm_list;
  92 };
  93
  94 struct netmsg_so_notify_abort {
  95         struct netmsg_base      base;
  96         struct netmsg_so_notify *nm_notifymsg;
  97 };
  98
  99 #define NM_REVENT       0x1             /* event on receive buffer */
 100 #define NM_SEVENT       0x2             /* event on send buffer */
 101
 102 /*
 103  * User protocol requests messages.
 104  */
 105 struct netmsg_pru_abort {
 106         struct netmsg_base      base;
 107 };
 108
 109 struct netmsg_pru_accept {
 110         struct netmsg_base      base;
 111         struct sockaddr         **nm_nam;
 112 };
 113
 114 struct netmsg_pru_attach {
 115         struct netmsg_base      base;
 116         int                     nm_proto;
 117         struct pru_attach_info  *nm_ai;
 118 };
 119
 120 struct netmsg_pru_bind {
 121         struct netmsg_base      base;
 122         struct sockaddr         *nm_nam;
 123         struct thread           *nm_td;
 124 };
 125
 126 struct netmsg_pru_connect {
 127         struct netmsg_base      base;
 128         struct sockaddr         *nm_nam;
 129         struct thread           *nm_td;
 130         struct mbuf             *nm_m;          /* connect with send */
 131         int                     nm_flags;       /* connect with send */
 132         int                     nm_reconnect;   /* message control */
 133 };
 134
 135 #define NMSG_RECONNECT_RECONNECT        0x0001  /* thread port change */
 136 #define NMSG_RECONNECT_NAMALLOC         0x0002  /* nm_nam allocated */
 137 #define NMSG_RECONNECT_PUSH             0x0004  /* call tcp_output */
 138 #define NMSG_RECONNECT_FALLBACK         0x0008  /* fallback to ipv4 */
 139
 140 struct netmsg_pru_connect2 {
 141         struct netmsg_base      base;
 142         struct socket           *nm_so1;
 143         struct socket           *nm_so2;
 144 };
 145
 146 struct netmsg_pru_control {
 147         struct netmsg_base      base;
 148         u_long                  nm_cmd;
 149         caddr_t                 nm_data;
 150         struct ifnet            *nm_ifp;
 151         struct thread           *nm_td;
 152 };
 153
 154 struct netmsg_pru_detach {
 155         struct netmsg_base      base;
 156 };
 157
 158 struct netmsg_pru_disconnect {
 159         struct netmsg_base      base;
 160 };
 161
 162 struct netmsg_pru_listen {
 163         struct netmsg_base      base;
 164         struct thread           *nm_td;
 165 };
 166
 167 struct netmsg_pru_peeraddr {
 168         struct netmsg_base      base;
 169         struct sockaddr         **nm_nam;
 170 };
 171
 172 struct netmsg_pru_rcvd {
 173         struct netmsg_base      base;
 174         int                     nm_flags;
 175         int                     nm_pru_flags;   /* PRUR_xxx */
 176 };
 177
 178 #define PRUR_ASYNC              0x1
 179 #define PRUR_DEAD               0x2
 180
 181 struct netmsg_pru_rcvoob {
 182         struct netmsg_base      base;
 183         struct mbuf             *nm_m;
 184         int                     nm_flags;
 185 };
 186
 187 struct netmsg_pru_send {
 188         struct netmsg_base      base;
 189         int                     nm_flags;       /* PRUS_xxx */
 190         struct mbuf             *nm_m;
 191         struct sockaddr         *nm_addr;
 192         struct mbuf             *nm_control;
 193         struct thread           *nm_td;
 194 };
 195
 196 #define PRUS_OOB                0x1
 197 #define PRUS_EOF                0x2
 198 #define PRUS_MORETOCOME         0x4
 199 #define PRUS_NAMALLOC           0x8
 200 #define PRUS_NOREPLY            0x10
 201 #define PRUS_DONTROUTE          0x20
 202 #define PRUS_FREEADDR           0x40
 203
 204 struct netmsg_pru_sense {
 205         struct netmsg_base      base;
 206         struct stat             *nm_stat;
 207 };
 208
 209 struct netmsg_pru_shutdown {
 210         struct netmsg_base      base;
 211 };
 212
 213 struct netmsg_pru_sockaddr {
 214         struct netmsg_base      base;
 215         struct sockaddr         **nm_nam;
 216 };
 217
 218 struct netmsg_pru_sosend {
 219         struct netmsg_base      base;
 220         struct sockaddr         *nm_addr;
 221         struct uio              *nm_uio;
 222         struct mbuf             *nm_top;
 223         struct mbuf             *nm_control;
 224         int                     nm_flags;
 225         struct thread           *nm_td;
 226 };
 227
 228 struct netmsg_pru_soreceive {
 229         struct netmsg_base      base;
 230         struct sockaddr         *nm_addr;
 231         struct sockaddr         **nm_paddr;
 232         struct uio              *nm_uio;
 233         struct sockbuf          *nm_sio;
 234         struct mbuf             **nm_controlp;
 235         int                     *nm_flagsp;
 236 };
 237
 238 struct netmsg_pr_ctloutput {
 239         struct netmsg_base      base;
 240         struct sockopt          *nm_sopt;
 241 };
 242
 243 struct netmsg_pru_ctlinput {
 244         struct netmsg_base      base;
 245         int                     nm_cmd;
 246         struct sockaddr         *nm_arg;
 247         void                    *nm_extra;
 248 };
 249
 250 /*
 251  * Union of all possible netmsgs.  Note that when a netmsg is sent the
 252  * actual allocated storage is likely only the size of the particular
 253  * class of message, and not sizeof(union netmsg).
 254  */
 255 union netmsg {
 256         struct lwkt_msg                 lmsg;           /* base embedded */
 257         struct netmsg_base              base;           /* base embedded */
 258
 259         struct netmsg_packet            packet;         /* mbuf embedded */
 260         struct netmsg_pr_timeout        timeout;
 261         struct netmsg_so_notify         notify;
 262         struct netmsg_so_notify_abort   notify_abort;
 263
 264         struct netmsg_pr_ctloutput      ctloutput;
 265
 266         struct netmsg_pru_abort         abort;
 267         struct netmsg_pru_accept        accept;         /* synchronous */
 268         struct netmsg_pru_attach        attach;
 269         struct netmsg_pru_bind          bind;
 270         struct netmsg_pru_connect       connect;
 271         struct netmsg_pru_connect2      connect2;
 272         struct netmsg_pru_control       control;        /* synchronous */
 273         struct netmsg_pru_detach        detach;
 274         struct netmsg_pru_disconnect    disconnect;
 275         struct netmsg_pru_listen        listen;
 276         struct netmsg_pru_peeraddr      peeraddr;
 277         struct netmsg_pru_rcvd          rcvd;
 278         struct netmsg_pru_rcvoob        rcvoob;
 279         struct netmsg_pru_send          send;
 280         struct netmsg_pru_sense         sense;
 281         struct netmsg_pru_shutdown      shutdown;
 282         struct netmsg_pru_sockaddr      sockaddr;
 283         struct netmsg_pru_sosend        sosend;         /* synchronous */
 284         struct netmsg_pru_soreceive     soreceive;      /* synchronous */
 285         struct netmsg_pru_ctlinput      ctlinput;
 286 };
 287
 288 #endif  /* _KERNEL || _KERNEL_STRUCTURES */
 289
 290 #endif  /* !_NET_NETMSG_H_ */