sys/sys/protosw.h

   1 /*-
   2  * Copyright (c) 1982, 1986, 1993
   3  *      The Regents of the University of California.  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 the University of
  16  *      California, Berkeley and its contributors.
  17  * 4. Neither the name of the University nor the names of its contributors
  18  *    may be used to endorse or promote products derived from this software
  19  *    without specific prior written permission.
  20  *
  21  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  22  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  25  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  26  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  27  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  28  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  30  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31  * SUCH DAMAGE.
  32  *
  33  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
  34  * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $
  35  * $DragonFly: src/sys/sys/protosw.h,v 1.2 2003/06/17 04:28:58 dillon Exp $
  36  */
  37
  38 #ifndef _SYS_PROTOSW_H_
  39 #define _SYS_PROTOSW_H_
  40
  41 /* Forward declare these structures referenced from prototypes below. */
  42 struct mbuf;
  43 struct proc;
  44 struct sockaddr;
  45 struct socket;
  46 struct sockopt;
  47
  48 /*#ifdef _KERNEL*/
  49 /*
  50  * Protocol switch table.
  51  *
  52  * Each protocol has a handle initializing one of these structures,
  53  * which is used for protocol-protocol and system-protocol communication.
  54  *
  55  * A protocol is called through the pr_init entry before any other.
  56  * Thereafter it is called every 200ms through the pr_fasttimo entry and
  57  * every 500ms through the pr_slowtimo for timer based actions.
  58  * The system will call the pr_drain entry if it is low on space and
  59  * this should throw away any non-critical data.
  60  *
  61  * Protocols pass data between themselves as chains of mbufs using
  62  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
  63  * the users) and pr_output passes it down (towards the interfaces); control
  64  * information passes up and down on pr_ctlinput and pr_ctloutput.
  65  * The protocol is responsible for the space occupied by any the
  66  * arguments to these entries and must dispose it.
  67  *
  68  * In retrospect, it would be a lot nicer to use an interface
  69  * similar to the vnode VOP interface.
  70  */
  71 struct protosw {
  72         short   pr_type;                /* socket type used for */
  73         struct  domain *pr_domain;      /* domain protocol a member of */
  74         short   pr_protocol;            /* protocol number */
  75         short   pr_flags;               /* see below */
  76 /* protocol-protocol hooks */
  77         void    (*pr_input) __P((struct mbuf *, int len));
  78                                         /* input to protocol (from below) */
  79         int     (*pr_output)    __P((struct mbuf *m, struct socket *so));
  80                                         /* output to protocol (from above) */
  81         void    (*pr_ctlinput)__P((int, struct sockaddr *, void *));
  82                                         /* control input (from below) */
  83         int     (*pr_ctloutput)__P((struct socket *, struct sockopt *));
  84                                         /* control output (from above) */
  85 /* user-protocol hook */
  86         void    *pr_ousrreq;
  87 /* utility hooks */
  88         void    (*pr_init) __P((void)); /* initialization hook */
  89         void    (*pr_fasttimo) __P((void));
  90                                         /* fast timeout (200ms) */
  91         void    (*pr_slowtimo) __P((void));
  92                                         /* slow timeout (500ms) */
  93         void    (*pr_drain) __P((void));
  94                                         /* flush any excess space possible */
  95         struct  pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
  96 };
  97 /*#endif*/
  98
  99 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
 100 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
 101
 102 /*
 103  * Values for pr_flags.
 104  * PR_ADDR requires PR_ATOMIC;
 105  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 106  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 107  *      and the protocol understands the MSG_EOF flag.  The first property is
 108  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 109  *      anyhow).
 110  */
 111 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
 112 #define PR_ADDR         0x02            /* addresses given with messages */
 113 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 114 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
 115 #define PR_RIGHTS       0x10            /* passes capabilities */
 116 #define PR_IMPLOPCL     0x20            /* implied open/close */
 117 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
 118
 119 /*
 120  * The arguments to usrreq are:
 121  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
 122  * where up is a (struct socket *), req is one of these requests,
 123  * m is a optional mbuf chain containing a message,
 124  * nam is an optional mbuf chain containing an address,
 125  * and opt is a pointer to a socketopt structure or nil.
 126  * The protocol is responsible for disposal of the mbuf chain m,
 127  * the caller is responsible for any space held by nam and opt.
 128  * A non-zero return from usrreq gives an
 129  * UNIX error number which should be passed to higher level software.
 130  */
 131 #define PRU_ATTACH              0       /* attach protocol to up */
 132 #define PRU_DETACH              1       /* detach protocol from up */
 133 #define PRU_BIND                2       /* bind socket to address */
 134 #define PRU_LISTEN              3       /* listen for connection */
 135 #define PRU_CONNECT             4       /* establish connection to peer */
 136 #define PRU_ACCEPT              5       /* accept connection from peer */
 137 #define PRU_DISCONNECT          6       /* disconnect from peer */
 138 #define PRU_SHUTDOWN            7       /* won't send any more data */
 139 #define PRU_RCVD                8       /* have taken data; more room now */
 140 #define PRU_SEND                9       /* send this data */
 141 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 142 #define PRU_CONTROL             11      /* control operations on protocol */
 143 #define PRU_SENSE               12      /* return status into m */
 144 #define PRU_RCVOOB              13      /* retrieve out of band data */
 145 #define PRU_SENDOOB             14      /* send out of band data */
 146 #define PRU_SOCKADDR            15      /* fetch socket's address */
 147 #define PRU_PEERADDR            16      /* fetch peer's address */
 148 #define PRU_CONNECT2            17      /* connect two sockets */
 149 /* begin for protocols internal use */
 150 #define PRU_FASTTIMO            18      /* 200ms timeout */
 151 #define PRU_SLOWTIMO            19      /* 500ms timeout */
 152 #define PRU_PROTORCV            20      /* receive from below */
 153 #define PRU_PROTOSEND           21      /* send to below */
 154 /* end for protocol's internal use */
 155 #define PRU_SEND_EOF            22      /* send and close */
 156 #define PRU_NREQ                22
 157
 158 #ifdef PRUREQUESTS
 159 char *prurequests[] = {
 160         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 161         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 162         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 163         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 164         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
 165         "PROTORCV",     "PROTOSEND",
 166         "SEND_EOF",
 167 };
 168 #endif
 169
 170 #ifdef  _KERNEL                 /* users shouldn't see this decl */
 171
 172 struct ifnet;
 173 struct stat;
 174 struct ucred;
 175 struct uio;
 176
 177 /*
 178  * If the ordering here looks odd, that's because it's alphabetical.
 179  * Having this structure separated out from the main protoswitch is allegedly
 180  * a big (12 cycles per call) lose on high-end CPUs.  We will eventually
 181  * migrate this stuff back into the main structure.
 182  */
 183 struct pr_usrreqs {
 184         int     (*pru_abort) __P((struct socket *so));
 185         int     (*pru_accept) __P((struct socket *so, struct sockaddr **nam));
 186         int     (*pru_attach) __P((struct socket *so, int proto,
 187                                    struct proc *p));
 188         int     (*pru_bind) __P((struct socket *so, struct sockaddr *nam,
 189                                  struct proc *p));
 190         int     (*pru_connect) __P((struct socket *so, struct sockaddr *nam,
 191                                     struct proc *p));
 192         int     (*pru_connect2) __P((struct socket *so1, struct socket *so2));
 193         int     (*pru_control) __P((struct socket *so, u_long cmd, caddr_t data,
 194                                     struct ifnet *ifp, struct proc *p));
 195         int     (*pru_detach) __P((struct socket *so));
 196         int     (*pru_disconnect) __P((struct socket *so));
 197         int     (*pru_listen) __P((struct socket *so, struct proc *p));
 198         int     (*pru_peeraddr) __P((struct socket *so,
 199                                      struct sockaddr **nam));
 200         int     (*pru_rcvd) __P((struct socket *so, int flags));
 201         int     (*pru_rcvoob) __P((struct socket *so, struct mbuf *m,
 202                                    int flags));
 203         int     (*pru_send) __P((struct socket *so, int flags, struct mbuf *m,
 204                                  struct sockaddr *addr, struct mbuf *control,
 205                                  struct proc *p));
 206 #define PRUS_OOB        0x1
 207 #define PRUS_EOF        0x2
 208 #define PRUS_MORETOCOME 0x4
 209         int     (*pru_sense) __P((struct socket *so, struct stat *sb));
 210         int     (*pru_shutdown) __P((struct socket *so));
 211         int     (*pru_sockaddr) __P((struct socket *so,
 212                                      struct sockaddr **nam));
 213
 214         /*
 215          * These three added later, so they are out of order.  They are used
 216          * for shortcutting (fast path input/output) in some protocols.
 217          * XXX - that's a lie, they are not implemented yet
 218          * Rather than calling sosend() etc. directly, calls are made
 219          * through these entry points.  For protocols which still use
 220          * the generic code, these just point to those routines.
 221          */
 222         int     (*pru_sosend) __P((struct socket *so, struct sockaddr *addr,
 223                                    struct uio *uio, struct mbuf *top,
 224                                    struct mbuf *control, int flags,
 225                                    struct proc *p));
 226         int     (*pru_soreceive) __P((struct socket *so,
 227                                       struct sockaddr **paddr,
 228                                       struct uio *uio, struct mbuf **mp0,
 229                                       struct mbuf **controlp, int *flagsp));
 230         int     (*pru_sopoll) __P((struct socket *so, int events,
 231                                      struct ucred *cred, struct proc *p));
 232 };
 233
 234 int     pru_accept_notsupp __P((struct socket *so, struct sockaddr **nam));
 235 int     pru_connect_notsupp __P((struct socket *so, struct sockaddr *nam,
 236                                  struct proc *p));
 237 int     pru_connect2_notsupp __P((struct socket *so1, struct socket *so2));
 238 int     pru_control_notsupp __P((struct socket *so, u_long cmd, caddr_t data,
 239                                  struct ifnet *ifp, struct proc *p));
 240 int     pru_listen_notsupp __P((struct socket *so, struct proc *p));
 241 int     pru_rcvd_notsupp __P((struct socket *so, int flags));
 242 int     pru_rcvoob_notsupp __P((struct socket *so, struct mbuf *m, int flags));
 243 int     pru_sense_null __P((struct socket *so, struct stat *sb));
 244
 245 #endif /* _KERNEL */
 246
 247 /*
 248  * The arguments to the ctlinput routine are
 249  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 250  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 251  * and arg is a `void *' argument used within a protocol family.
 252  */
 253 #define PRC_IFDOWN              0       /* interface transition */
 254 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 255 #define PRC_IFUP                2       /* interface has come back up */
 256 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
 257 #define PRC_QUENCH              4       /* some one said to slow down */
 258 #define PRC_MSGSIZE             5       /* message size forced drop */
 259 #define PRC_HOSTDEAD            6       /* host appears to be down */
 260 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 261 #define PRC_UNREACH_NET         8       /* no route to network */
 262 #define PRC_UNREACH_HOST        9       /* no route to host */
 263 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 264 #define PRC_UNREACH_PORT        11      /* bad port # */
 265 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 266 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 267 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 268 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 269 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 270 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 271 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 272 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 273 #define PRC_PARAMPROB           20      /* header incorrect */
 274 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
 275
 276 #define PRC_NCMDS               22
 277
 278 #define PRC_IS_REDIRECT(cmd)    \
 279         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 280
 281 #ifdef PRCREQUESTS
 282 char    *prcrequests[] = {
 283         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
 284         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 285         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 286         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 287         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 288         "PARAMPROB", "ADMIN-UNREACH"
 289 };
 290 #endif
 291
 292 /*
 293  * The arguments to ctloutput are:
 294  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 295  * req is one of the actions listed below, so is a (struct socket *),
 296  * level is an indication of which protocol layer the option is intended.
 297  * optname is a protocol dependent socket option request,
 298  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 299  * The protocol is responsible for disposal of the mbuf chain *optval
 300  * if supplied,
 301  * the caller is responsible for any space held by *optval, when returned.
 302  * A non-zero return from usrreq gives an
 303  * UNIX error number which should be passed to higher level software.
 304  */
 305 #define PRCO_GETOPT     0
 306 #define PRCO_SETOPT     1
 307
 308 #define PRCO_NCMDS      2
 309
 310 #ifdef PRCOREQUESTS
 311 char    *prcorequests[] = {
 312         "GETOPT", "SETOPT",
 313 };
 314 #endif
 315
 316 #ifdef _KERNEL
 317 void    pfctlinput __P((int, struct sockaddr *));
 318 void    pfctlinput2 __P((int, struct sockaddr *, void *));
 319 struct protosw *pffindproto __P((int family, int protocol, int type));
 320 struct protosw *pffindtype __P((int family, int type));
 321 #endif
 322
 323 #endif