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