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