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.15 2005/07/15 17:54:48 eirikn 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 thread;
  44 struct sockaddr;
  45 struct socket;
  46 struct sockopt;
  47
  48 struct pr_output_info {
  49         pid_t   p_pid;
  50 };
  51
  52 /*#ifdef _KERNEL*/
  53 /*
  54  * Protocol switch table.
  55  *
  56  * Each protocol has a handle initializing one of these structures,
  57  * which is used for protocol-protocol and system-protocol communication.
  58  *
  59  * A protocol is called through the pr_init entry before any other.
  60  * Thereafter it is called every 200ms through the pr_fasttimo entry and
  61  * every 500ms through the pr_slowtimo for timer based actions.
  62  * The system will call the pr_drain entry if it is low on space and
  63  * this should throw away any non-critical data.
  64  *
  65  * Protocols pass data between themselves as chains of mbufs using
  66  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
  67  * the users) and pr_output passes it down (towards the interfaces); control
  68  * information passes up and down on pr_ctlinput and pr_ctloutput.
  69  * The protocol is responsible for the space occupied by any the
  70  * arguments to these entries and must dispose it.
  71  *
  72  * In retrospect, it would be a lot nicer to use an interface
  73  * similar to the vnode VOP interface.
  74  */
  75 struct protosw {
  76         short   pr_type;                /* socket type used for */
  77         const struct domain *pr_domain; /* domain protocol a member of */
  78         short   pr_protocol;            /* protocol number */
  79         short   pr_flags;               /* see below */
  80 /* protocol-protocol hooks */
  81         void    (*pr_input) (struct mbuf *, ...);
  82                                         /* input to protocol (from below) */
  83         int     (*pr_output)    (struct mbuf *, struct socket *, ...);
  84                                         /* output to protocol (from above) */
  85         void    (*pr_ctlinput)(int, struct sockaddr *, void *);
  86                                         /* control input (from below) */
  87         int     (*pr_ctloutput)(struct socket *, struct sockopt *);
  88                                         /* control output (from above) */
  89 /* user-protocol hook */
  90         struct lwkt_port *(*pr_mport)(struct socket *, struct sockaddr *, int);
  91 /* utility hooks */
  92         void    (*pr_init) (void);      /* initialization hook */
  93         void    (*pr_fasttimo) (void);
  94                                         /* fast timeout (200ms) */
  95         void    (*pr_slowtimo) (void);
  96                                         /* slow timeout (500ms) */
  97         void    (*pr_drain) (void);
  98                                         /* flush any excess space possible */
  99         const struct    pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
 100 };
 101 /*#endif*/
 102
 103 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
 104 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
 105
 106 /*
 107  * Values for pr_flags.
 108  * PR_ADDR requires PR_ATOMIC;
 109  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 110  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 111  *      and the protocol understands the MSG_EOF flag.  The first property is
 112  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 113  *      anyhow).
 114  */
 115 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
 116 #define PR_ADDR         0x02            /* addresses given with messages */
 117 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 118 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
 119 #define PR_RIGHTS       0x10            /* passes capabilities */
 120 #define PR_IMPLOPCL     0x20            /* implied open/close */
 121 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
 122 #define PR_ADDR_OPT     0x80            /* allow addresses during delivery */
 123
 124 /*
 125  * The arguments to usrreq are:
 126  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
 127  * where up is a (struct socket *), req is one of these requests,
 128  * m is a optional mbuf chain containing a message,
 129  * nam is an optional mbuf chain containing an address,
 130  * and opt is a pointer to a socketopt structure or nil.
 131  * The protocol is responsible for disposal of the mbuf chain m,
 132  * the caller is responsible for any space held by nam and opt.
 133  * A non-zero return from usrreq gives an
 134  * UNIX error number which should be passed to higher level software.
 135  */
 136 #define PRU_ATTACH              0       /* attach protocol to up */
 137 #define PRU_DETACH              1       /* detach protocol from up */
 138 #define PRU_BIND                2       /* bind socket to address */
 139 #define PRU_LISTEN              3       /* listen for connection */
 140 #define PRU_CONNECT             4       /* establish connection to peer */
 141 #define PRU_ACCEPT              5       /* accept connection from peer */
 142 #define PRU_DISCONNECT          6       /* disconnect from peer */
 143 #define PRU_SHUTDOWN            7       /* won't send any more data */
 144 #define PRU_RCVD                8       /* have taken data; more room now */
 145 #define PRU_SEND                9       /* send this data */
 146 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 147 #define PRU_CONTROL             11      /* control operations on protocol */
 148 #define PRU_SENSE               12      /* return status into m */
 149 #define PRU_RCVOOB              13      /* retrieve out of band data */
 150 #define PRU_SENDOOB             14      /* send out of band data */
 151 #define PRU_SOCKADDR            15      /* fetch socket's address */
 152 #define PRU_PEERADDR            16      /* fetch peer's address */
 153 #define PRU_CONNECT2            17      /* connect two sockets */
 154 #define PRU_SOPOLL              18
 155 /* begin for protocols internal use */
 156 #define PRU_FASTTIMO            19      /* 200ms timeout */
 157 #define PRU_SLOWTIMO            20      /* 500ms timeout */
 158 #define PRU_PROTORCV            21      /* receive from below */
 159 #define PRU_PROTOSEND           22      /* send to below */
 160 /* end for protocol's internal use */
 161 #define PRU_SEND_EOF            23      /* send and close */
 162 #define PRU_PRED                24
 163 #define PRU_NREQ                25
 164
 165 #ifdef PRUREQUESTS
 166 char *prurequests[] = {
 167         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 168         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 169         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 170         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 171         "PEERADDR",     "CONNECT2",     "SOPOLL",
 172         "FASTTIMO",     "SLOWTIMO",     "PROTORCV",     "PROTOSEND",
 173         "SEND_EOF",     "PREDICATE"
 174 };
 175 #endif
 176
 177 #ifdef  _KERNEL                 /* users shouldn't see this decl */
 178
 179 struct ifnet;
 180 struct stat;
 181 struct ucred;
 182 struct uio;
 183
 184 struct pru_attach_info {
 185         struct rlimit *sb_rlimit;
 186         struct ucred *p_ucred;
 187         struct vnode *fd_rdir;
 188 };
 189
 190 /*
 191  * If the ordering here looks odd, that's because it's alphabetical.
 192  * Having this structure separated out from the main protoswitch is allegedly
 193  * a big (12 cycles per call) lose on high-end CPUs.  We will eventually
 194  * migrate this stuff back into the main structure.
 195  */
 196 struct pr_usrreqs {
 197         int     (*pru_abort) (struct socket *so);
 198         int     (*pru_accept) (struct socket *so, struct sockaddr **nam);
 199         int     (*pru_attach) (struct socket *so, int proto,
 200                                struct pru_attach_info *ai);
 201         int     (*pru_bind) (struct socket *so, struct sockaddr *nam,
 202                                  struct thread *td);
 203         int     (*pru_connect) (struct socket *so, struct sockaddr *nam,
 204                                     struct thread *td);
 205         int     (*pru_connect2) (struct socket *so1, struct socket *so2);
 206         int     (*pru_control) (struct socket *so, u_long cmd, caddr_t data,
 207                                     struct ifnet *ifp, struct thread *td);
 208         int     (*pru_detach) (struct socket *so);
 209         int     (*pru_disconnect) (struct socket *so);
 210         int     (*pru_listen) (struct socket *so, struct thread *td);
 211         int     (*pru_peeraddr) (struct socket *so,
 212                                      struct sockaddr **nam);
 213         int     (*pru_rcvd) (struct socket *so, int flags);
 214         int     (*pru_rcvoob) (struct socket *so, struct mbuf *m,
 215                                    int flags);
 216         int     (*pru_send) (struct socket *so, int flags, struct mbuf *m,
 217                                  struct sockaddr *addr, struct mbuf *control,
 218                                  struct thread *td);
 219 #define PRUS_OOB        0x1
 220 #define PRUS_EOF        0x2
 221 #define PRUS_MORETOCOME 0x4
 222         int     (*pru_sense) (struct socket *so, struct stat *sb);
 223         int     (*pru_shutdown) (struct socket *so);
 224         int     (*pru_sockaddr) (struct socket *so,
 225                                      struct sockaddr **nam);
 226
 227         /*
 228          * These three added later, so they are out of order.  They are used
 229          * for shortcutting (fast path input/output) in some protocols.
 230          * XXX - that's a lie, they are not implemented yet
 231          * Rather than calling sosend() etc. directly, calls are made
 232          * through these entry points.  For protocols which still use
 233          * the generic code, these just point to those routines.
 234          */
 235         int     (*pru_sosend) (struct socket *so, struct sockaddr *addr,
 236                                    struct uio *uio, struct mbuf *top,
 237                                    struct mbuf *control, int flags,
 238                                    struct thread *td);
 239         int     (*pru_soreceive) (struct socket *so,
 240                                       struct sockaddr **paddr,
 241                                       struct uio *uio, struct mbuf **mp0,
 242                                       struct mbuf **controlp, int *flagsp);
 243         int     (*pru_sopoll) (struct socket *so, int events,
 244                                      struct ucred *cred, struct thread *td);
 245 };
 246
 247 typedef int (*pru_abort_fn_t) (struct socket *so);
 248 typedef int (*pru_accept_fn_t) (struct socket *so, struct sockaddr **nam);
 249 typedef int (*pru_attach_fn_t) (struct socket *so, int proto,
 250                                         struct pru_attach_info *ai);
 251 typedef int (*pru_bind_fn_t) (struct socket *so, struct sockaddr *nam,
 252                                         struct thread *td);
 253 typedef int (*pru_connect_fn_t) (struct socket *so, struct sockaddr *nam,
 254                                         struct thread *td);
 255 typedef int (*pru_connect2_fn_t) (struct socket *so1, struct socket *so2);
 256 typedef int (*pru_control_fn_t) (struct socket *so, u_long cmd, caddr_t data,
 257                                         struct ifnet *ifp,
 258                                         struct thread *td);
 259 typedef int (*pru_detach_fn_t) (struct socket *so);
 260 typedef int (*pru_disconnect_fn_t) (struct socket *so);
 261 typedef int (*pru_listen_fn_t) (struct socket *so, struct thread *td);
 262 typedef int (*pru_peeraddr_fn_t) (struct socket *so, struct sockaddr **nam);
 263 typedef int (*pru_rcvd_fn_t) (struct socket *so, int flags);
 264 typedef int (*pru_rcvoob_fn_t) (struct socket *so, struct mbuf *m, int flags);
 265 typedef int (*pru_send_fn_t) (struct socket *so, int flags, struct mbuf *m,
 266                                         struct sockaddr *addr,
 267                                         struct mbuf *control,
 268                                         struct thread *td);
 269 typedef int (*pru_sense_fn_t) (struct socket *so, struct stat *sb);
 270 typedef int (*pru_shutdown_fn_t) (struct socket *so);
 271 typedef int (*pru_sockaddr_fn_t) (struct socket *so, struct sockaddr **nam);
 272 typedef int (*pru_sosend_fn_t) (struct socket *so, struct sockaddr *addr,
 273                                         struct uio *uio, struct mbuf *top,
 274                                         struct mbuf *control, int flags,
 275                                         struct thread *td);
 276 typedef int (*pru_soreceive_fn_t) (struct socket *so, struct sockaddr **paddr,
 277                                         struct uio *uio, struct mbuf **mp0,
 278                                         struct mbuf **controlp,
 279                                         int *flagsp);
 280 typedef int (*pru_sopoll_fn_t) (struct socket *so, int events,
 281                                         struct ucred *cred,
 282                                         struct thread *td);
 283
 284 int     pru_accept_notsupp (struct socket *so, struct sockaddr **nam);
 285 int     pru_connect_notsupp (struct socket *so, struct sockaddr *nam,
 286                                 struct thread *td);
 287 int     pru_connect2_notsupp (struct socket *so1, struct socket *so2);
 288 int     pru_control_notsupp (struct socket *so, u_long cmd, caddr_t data,
 289                                 struct ifnet *ifp, struct thread *td);
 290 int     pru_listen_notsupp (struct socket *so, struct thread *td);
 291 int     pru_rcvd_notsupp (struct socket *so, int flags);
 292 int     pru_rcvoob_notsupp (struct socket *so, struct mbuf *m, int flags);
 293 int     pru_sense_null (struct socket *so, struct stat *sb);
 294
 295 struct lwkt_port *cpu0_soport(struct socket *, struct sockaddr *, int);
 296 struct lwkt_port *sync_soport(struct socket *, struct sockaddr *, int);
 297
 298 #endif /* _KERNEL */
 299
 300 /*
 301  * The arguments to the ctlinput routine are
 302  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 303  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 304  * and arg is a `void *' argument used within a protocol family.
 305  */
 306 #define PRC_IFDOWN              0       /* interface transition */
 307 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 308 #define PRC_IFUP                2       /* interface has come back up */
 309 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
 310 #define PRC_QUENCH              4       /* some one said to slow down */
 311 #define PRC_MSGSIZE             5       /* message size forced drop */
 312 #define PRC_HOSTDEAD            6       /* host appears to be down */
 313 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 314 #define PRC_UNREACH_NET         8       /* no route to network */
 315 #define PRC_UNREACH_HOST        9       /* no route to host */
 316 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 317 #define PRC_UNREACH_PORT        11      /* bad port # */
 318 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 319 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 320 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 321 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 322 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 323 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 324 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 325 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 326 #define PRC_PARAMPROB           20      /* header incorrect */
 327 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
 328
 329 #define PRC_NCMDS               22
 330
 331 #define PRC_IS_REDIRECT(cmd)    \
 332         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 333
 334 #ifdef PRCREQUESTS
 335 char    *prcrequests[] = {
 336         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
 337         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 338         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 339         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 340         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 341         "PARAMPROB", "ADMIN-UNREACH"
 342 };
 343 #endif
 344
 345 /*
 346  * The arguments to ctloutput are:
 347  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 348  * req is one of the actions listed below, so is a (struct socket *),
 349  * level is an indication of which protocol layer the option is intended.
 350  * optname is a protocol dependent socket option request,
 351  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 352  * The protocol is responsible for disposal of the mbuf chain *optval
 353  * if supplied,
 354  * the caller is responsible for any space held by *optval, when returned.
 355  * A non-zero return from usrreq gives an
 356  * UNIX error number which should be passed to higher level software.
 357  */
 358 #define PRCO_GETOPT     0
 359 #define PRCO_SETOPT     1
 360
 361 #define PRCO_NCMDS      2
 362
 363 #ifdef PRCOREQUESTS
 364 char    *prcorequests[] = {
 365         "GETOPT", "SETOPT",
 366 };
 367 #endif
 368
 369 #ifdef _KERNEL
 370 void    pfctlinput (int, struct sockaddr *);
 371 void    pfctlinput2 (int, struct sockaddr *, void *);
 372 struct protosw *pffindproto (int family, int protocol, int type);
 373 struct protosw *pffindtype (int family, int type);
 374 #endif  /* _KERNEL */
 375
 376 #endif  /* _SYS_PROTOSW_H_ */