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. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  *
  29  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
  30  * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $
  31  */
  32
  33 #ifndef _SYS_PROTOSW_H_
  34 #define _SYS_PROTOSW_H_
  35
  36 #ifndef _SYS_TYPES_H_
  37 #include <sys/types.h>
  38 #endif
  39
  40 /* Forward declare these structures referenced from prototypes below. */
  41 struct mbuf;
  42 struct thread;
  43 struct sockaddr;
  44 struct socket;
  45 struct sockopt;
  46
  47 struct pr_output_info {
  48         pid_t   p_pid;
  49 };
  50
  51 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
  52
  53 /*
  54  * netmsg_t union of possible netmsgs typically sent to protocol threads.
  55  */
  56 typedef union netmsg *netmsg_t;
  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
  86         struct lwkt_port *(*pr_initport)(void);
  87                                         /* initial msgport */
  88
  89         /*
  90          * Protocol hooks.  These are typically called directly within the
  91          * context of a protocol thread based on the toeplitz hash.
  92          *
  93          * pr_input() is called using the port supplied by the toeplitz
  94          *            hash via the netisr port function.
  95          *
  96          * pr_ctlinput() is called using the port supplied by pr_ctlport
  97          *
  98          * pr_ctloutput() and pr_output() are typically called
  99          */
 100         int     (*pr_input)(struct mbuf **, int *, int);
 101                                         /* input to protocol (from below) */
 102         int     (*pr_output)(struct mbuf *, struct socket *, ...);
 103                                         /* output to protocol (from above) */
 104         void    (*pr_ctlinput)(netmsg_t);
 105                                         /* control input (from below) */
 106         struct netmsg_pr_ctloutput *(*pr_ctloutmsg)(struct sockopt *);
 107                                         /* allocate netmsg for ctloutput */
 108         void    (*pr_ctloutput)(netmsg_t);
 109                                         /* control output (from above) */
 110         struct lwkt_port *(*pr_ctlport)(int, struct sockaddr *, void *, int *);
 111
 112         /*
 113          * Utility hooks, not called with any particular context.
 114          */
 115         void    (*pr_init) (void);      /* initialization hook */
 116         void    (*pr_fasttimo) (void);  /* fast timeout (200ms) */
 117         void    (*pr_slowtimo) (void);  /* slow timeout (500ms) */
 118         void    (*pr_drain) (void);     /* flush any excess space possible */
 119
 120         struct  pr_usrreqs *pr_usrreqs; /* messaged requests to proto thread */
 121 };
 122
 123 #endif
 124
 125 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
 126 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
 127
 128 /*
 129  * Values for pr_flags.
 130  * PR_ADDR requires PR_ATOMIC;
 131  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 132  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 133  *      and the protocol understands the MSG_EOF flag.  The first property is
 134  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 135  *      anyhow).
 136  */
 137 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
 138 #define PR_ADDR         0x02            /* addresses given with messages */
 139 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 140 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
 141 #define PR_RIGHTS       0x10            /* passes capabilities */
 142 #define PR_IMPLOPCL     0x20            /* implied open/close */
 143 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
 144 #define PR_UNUSED07     0x80            /* was: allow addresses during delivery (SCTP) */
 145 #define PR_MPSAFE       0x0100          /* protocal is MPSAFE */
 146 #define PR_SYNC_PORT    0x0200          /* synchronous port (no proto thrds) */
 147 #define PR_ASYNC_SEND   0x0400          /* async pru_send */
 148 #define PR_ASYNC_RCVD   0x0800          /* async pru_rcvd */
 149 #define PR_ASEND_HOLDTD 0x1000          /* async pru_send hold orig thread */
 150 #define PR_ACONN_HOLDTD 0x2000          /* async pru_connect hold orig thread */
 151
 152 /*
 153  * The arguments to usrreq are:
 154  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
 155  * where up is a (struct socket *), req is one of these requests,
 156  * m is a optional mbuf chain containing a message,
 157  * nam is an optional mbuf chain containing an address,
 158  * and opt is a pointer to a socketopt structure or nil.
 159  * The protocol is responsible for disposal of the mbuf chain m,
 160  * the caller is responsible for any space held by nam and opt.
 161  * A non-zero return from usrreq gives an
 162  * UNIX error number which should be passed to higher level software.
 163  */
 164 #define PRU_ATTACH              0       /* attach protocol to up */
 165 #define PRU_DETACH              1       /* detach protocol from up */
 166 #define PRU_BIND                2       /* bind socket to address */
 167 #define PRU_LISTEN              3       /* listen for connection */
 168 #define PRU_CONNECT             4       /* establish connection to peer */
 169 #define PRU_ACCEPT              5       /* accept connection from peer */
 170 #define PRU_DISCONNECT          6       /* disconnect from peer */
 171 #define PRU_SHUTDOWN            7       /* won't send any more data */
 172 #define PRU_RCVD                8       /* have taken data; more room now */
 173 #define PRU_SEND                9       /* send this data */
 174 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 175 #define PRU_CONTROL             11      /* control operations on protocol */
 176 #define PRU_SENSE               12      /* return status into m */
 177 #define PRU_RCVOOB              13      /* retrieve out of band data */
 178 #define PRU_SENDOOB             14      /* send out of band data */
 179 #define PRU_SOCKADDR            15      /* fetch socket's address */
 180 #define PRU_PEERADDR            16      /* fetch peer's address */
 181 #define PRU_CONNECT2            17      /* connect two sockets */
 182 #define PRU_RESERVED1           18      /* formerly PRU_SOPOLL */
 183 /* begin for protocols internal use */
 184 #define PRU_FASTTIMO            19      /* 200ms timeout */
 185 #define PRU_SLOWTIMO            20      /* 500ms timeout */
 186 #define PRU_PROTORCV            21      /* receive from below */
 187 #define PRU_PROTOSEND           22      /* send to below */
 188 /* end for protocol's internal use */
 189 #define PRU_SEND_EOF            23      /* send and close */
 190 #define PRU_PRED                24
 191 #define PRU_CTLOUTPUT           25      /* get/set opts */
 192 #define PRU_NREQ                26
 193
 194 #ifdef PRUREQUESTS
 195 const char *prurequests[] = {
 196         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 197         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 198         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 199         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 200         "PEERADDR",     "CONNECT2",     "",
 201         "FASTTIMO",     "SLOWTIMO",     "PROTORCV",     "PROTOSEND",
 202         "SEND_EOF",     "PREDICATE"
 203 };
 204 #endif
 205
 206 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES)
 207
 208 struct ifnet;
 209 struct stat;
 210 struct ucred;
 211 struct uio;
 212 struct sockbuf;
 213
 214 struct pru_attach_info {
 215         struct rlimit *sb_rlimit;
 216         struct ucred *p_ucred;
 217         struct vnode *fd_rdir;
 218 };
 219
 220 /*
 221  * These are netmsg'd requests almost universally in the context of the
 222  * appropriate protocol thread.  Exceptions:
 223  *
 224  *      pru_sosend() - called synchronously from user context, typically
 225  *                     runs generic kernel code and then messages via
 226  *                     pru_send().
 227  *
 228  *      pru_soreceive() - called synchronously from user context.  Typically
 229  *                        runs generic kernel code and remains synchronous.
 230  *
 231  *      pru_preconnect() - called synchronously from user context.  Typically
 232  *                         prepares for later asynchronous pru_connect, e.g.
 233  *                         sets ISCONNECTING.  Non-NULL means asynchronous
 234  *                         pru_connect is supported.
 235  */
 236 struct pr_usrreqs {
 237         void    (*pru_abort) (netmsg_t msg);
 238         void    (*pru_accept) (netmsg_t msg);
 239         void    (*pru_attach) (netmsg_t msg);
 240         void    (*pru_bind) (netmsg_t msg);
 241         void    (*pru_connect) (netmsg_t msg);
 242         void    (*pru_connect2) (netmsg_t msg);
 243         void    (*pru_control) (netmsg_t msg);
 244         /*
 245          * If pru_detach() returns EJUSTRETURN, then protocol will
 246          * call sodiscard() and sofree() for soclose().
 247          */
 248         void    (*pru_detach) (netmsg_t msg);
 249         void    (*pru_disconnect) (netmsg_t msg);
 250         void    (*pru_listen) (netmsg_t msg);
 251         void    (*pru_peeraddr) (netmsg_t msg);
 252         void    (*pru_rcvd) (netmsg_t msg);
 253         void    (*pru_rcvoob) (netmsg_t msg);
 254         void    (*pru_send) (netmsg_t msg);
 255         void    (*pru_sense) (netmsg_t msg);
 256         void    (*pru_shutdown) (netmsg_t msg);
 257         void    (*pru_sockaddr) (netmsg_t msg);
 258
 259         /*
 260          * These are direct calls.  Note that sosend() will sometimes
 261          * be converted into an implied connect (pru_connect) with the
 262          * mbufs and flags forwarded in pru_connect's netmsg.  It is
 263          * otherwise typically converted to a send (pru_send).
 264          *
 265          * soreceive() typically remains synchronous in the user's context.
 266          *
 267          * Any converted calls are netmsg's to the socket's protocol thread.
 268          */
 269         int     (*pru_sosend) (struct socket *so, struct sockaddr *addr,
 270                                    struct uio *uio, struct mbuf *top,
 271                                    struct mbuf *control, int flags,
 272                                    struct thread *td);
 273         int     (*pru_soreceive) (struct socket *so,
 274                                       struct sockaddr **paddr,
 275                                       struct uio *uio,
 276                                       struct sockbuf *sio,
 277                                       struct mbuf **controlp, int *flagsp);
 278
 279         /*
 280          * Synchronously called by protocol thread.  Typically save the
 281          * foreign address into socket.so_faddr.
 282          */
 283         void    (*pru_savefaddr) (struct socket *so,
 284                                       const struct sockaddr *addr);
 285
 286         /* synchronously called by user thread. */
 287         int     (*pru_preconnect) (struct socket *so,
 288                                       const struct sockaddr *addr,
 289                                       struct thread *td);
 290         int     (*pru_preattach) (struct socket *so,
 291                                       int, struct pru_attach_info *);
 292 };
 293
 294 typedef int (*pru_sosend_fn_t) (struct socket *so, struct sockaddr *addr,
 295                                         struct uio *uio, struct mbuf *top,
 296                                         struct mbuf *control, int flags,
 297                                         struct thread *td);
 298 typedef int (*pru_soreceive_fn_t) (struct socket *so, struct sockaddr **paddr,
 299                                         struct uio *uio,
 300                                         struct sockbuf *sio,
 301                                         struct mbuf **controlp,
 302                                         int *flagsp);
 303
 304 void    pr_generic_notsupp(netmsg_t msg);
 305 void    pru_sense_null(netmsg_t msg);
 306
 307 int     pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
 308                                 struct uio *uio, struct mbuf *top,
 309                                 struct mbuf *control, int flags,
 310                                 struct thread *td);
 311 int     pru_soreceive_notsupp(struct socket *so,
 312                                 struct sockaddr **paddr,
 313                                 struct uio *uio,
 314                                 struct sockbuf *sio,
 315                                 struct mbuf **controlp, int *flagsp);
 316
 317 struct lwkt_port *cpu0_soport(struct socket *, struct sockaddr *,
 318                               struct mbuf **);
 319 struct lwkt_port *cpu0_ctlport(int, struct sockaddr *, void *, int *);
 320
 321 #endif /* _KERNEL || _KERNEL_STRUCTURES */
 322
 323 /*
 324  * The arguments to the ctlinput routine are
 325  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 326  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 327  * and arg is a `void *' argument used within a protocol family.
 328  */
 329 #define PRC_IFDOWN              0       /* interface transition */
 330 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 331 #define PRC_IFUP                2       /* interface has come back up */
 332 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
 333 #define PRC_QUENCH              4       /* some one said to slow down */
 334 #define PRC_MSGSIZE             5       /* message size forced drop */
 335 #define PRC_HOSTDEAD            6       /* host appears to be down */
 336 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 337 #define PRC_UNREACH_NET         8       /* no route to network */
 338 #define PRC_UNREACH_HOST        9       /* no route to host */
 339 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 340 #define PRC_UNREACH_PORT        11      /* bad port # */
 341 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 342 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 343 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 344 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 345 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 346 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 347 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 348 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 349 #define PRC_PARAMPROB           20      /* header incorrect */
 350 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
 351
 352 #define PRC_NCMDS               22
 353
 354 #define PRC_IS_REDIRECT(cmd)    \
 355         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 356
 357 #ifdef PRCREQUESTS
 358 const char *prcrequests[] = {
 359         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
 360         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 361         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 362         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 363         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 364         "PARAMPROB", "ADMIN-UNREACH"
 365 };
 366 #endif
 367
 368 /*
 369  * The arguments to ctloutput are:
 370  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 371  * req is one of the actions listed below, so is a (struct socket *),
 372  * level is an indication of which protocol layer the option is intended.
 373  * optname is a protocol dependent socket option request,
 374  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 375  * The protocol is responsible for disposal of the mbuf chain *optval
 376  * if supplied,
 377  * the caller is responsible for any space held by *optval, when returned.
 378  * A non-zero return from usrreq gives an
 379  * UNIX error number which should be passed to higher level software.
 380  */
 381 #define PRCO_GETOPT     0
 382 #define PRCO_SETOPT     1
 383
 384 #define PRCO_NCMDS      2
 385
 386 #ifdef PRCOREQUESTS
 387 const char *prcorequests[] = {
 388         "GETOPT", "SETOPT",
 389 };
 390 #endif
 391
 392 /*
 393  * Kernel prototypes
 394  */
 395 #ifdef _KERNEL
 396
 397 void    kpfctlinput (int, struct sockaddr *);
 398 void    kpfctlinput_direct (int, struct sockaddr *);
 399 void    kpfctlinput2 (int, struct sockaddr *, void *);
 400 struct protosw *pffindproto (int family, int protocol, int type);
 401 struct protosw *pffindtype (int family, int type);
 402
 403 #define PR_GET_MPLOCK(_pr) \
 404 do { \
 405         if (((_pr)->pr_flags & PR_MPSAFE) == 0) \
 406                 get_mplock(); \
 407 } while (0)
 408
 409 #define PR_REL_MPLOCK(_pr) \
 410 do { \
 411         if (((_pr)->pr_flags & PR_MPSAFE) == 0) \
 412                 rel_mplock(); \
 413 } while (0)
 414
 415 #endif  /* _KERNEL */
 416
 417 #endif  /* _SYS_PROTOSW_H_ */