sys/sys/protosw.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-3-Clause
   3  *
   4  * Copyright (c) 1982, 1986, 1993
   5  *      The Regents of the University of California.  All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  * 3. Neither the name of the University nor the names of its contributors
  16  *    may be used to endorse or promote products derived from this software
  17  *    without specific prior written permission.
  18  *
  19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29  * SUCH DAMAGE.
  30  *
  31  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
  32  * $FreeBSD$
  33  */
  34
  35 #ifndef _SYS_PROTOSW_H_
  36 #define _SYS_PROTOSW_H_
  37
  38 #include <sys/queue.h>
  39
  40 /* Forward declare these structures referenced from prototypes below. */
  41 struct kaiocb;
  42 struct mbuf;
  43 struct thread;
  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  * Thereafter it is called every 200ms through the pr_fasttimo entry and
  56  * every 500ms through the pr_slowtimo for timer based actions.
  57  * The system will call the pr_drain entry if it is low on space and
  58  * this should throw away any non-critical data.
  59  *
  60  * In retrospect, it would be a lot nicer to use an interface
  61  * similar to the vnode VOP interface.
  62  */
  63 struct ifnet;
  64 struct stat;
  65 struct ucred;
  66 struct uio;
  67
  68 /* USE THESE FOR YOUR PROTOTYPES ! */
  69 typedef int     pr_ctloutput_t(struct socket *, struct sockopt *);
  70 typedef void    pr_fasttimo_t(void);
  71 typedef void    pr_slowtimo_t(void);
  72 typedef void    pr_drain_t(void);
  73 typedef void    pr_abort_t(struct socket *);
  74 typedef int     pr_accept_t(struct socket *, struct sockaddr **);
  75 typedef int     pr_attach_t(struct socket *, int, struct thread *);
  76 typedef int     pr_bind_t(struct socket *, struct sockaddr *, struct thread *);
  77 typedef int     pr_connect_t(struct socket *, struct sockaddr *,
  78                     struct thread *);
  79 typedef int     pr_connect2_t(struct socket *, struct socket *);
  80 typedef int     pr_control_t(struct socket *, unsigned long, void *,
  81                     struct ifnet *, struct thread *);
  82 typedef void    pr_detach_t(struct socket *);
  83 typedef int     pr_disconnect_t(struct socket *);
  84 typedef int     pr_listen_t(struct socket *, int, struct thread *);
  85 typedef int     pr_peeraddr_t(struct socket *, struct sockaddr **);
  86 typedef int     pr_rcvd_t(struct socket *, int);
  87 typedef int     pr_rcvoob_t(struct socket *, struct mbuf *, int);
  88 typedef enum {
  89         PRUS_OOB =              0x1,
  90         PRUS_EOF =              0x2,
  91         PRUS_MORETOCOME =       0x4,
  92         PRUS_NOTREADY =         0x8,
  93         PRUS_IPV6 =             0x10,
  94 } pr_send_flags_t;
  95 typedef int     pr_send_t(struct socket *, int, struct mbuf *,
  96                     struct sockaddr *, struct mbuf *, struct thread *);
  97 typedef int     pr_ready_t(struct socket *, struct mbuf *, int);
  98 typedef int     pr_sense_t(struct socket *, struct stat *);
  99 typedef int     pr_shutdown_t(struct socket *);
 100 typedef int     pr_flush_t(struct socket *, int);
 101 typedef int     pr_sockaddr_t(struct socket *, struct sockaddr **);
 102 typedef int     pr_sosend_t(struct socket *, struct sockaddr *, struct uio *,
 103                     struct mbuf *, struct mbuf *, int, struct thread *);
 104 typedef int     pr_soreceive_t(struct socket *, struct sockaddr **,
 105                     struct uio *, struct mbuf **, struct mbuf **, int *);
 106 typedef int     pr_sopoll_t(struct socket *, int, struct ucred *,
 107                     struct thread *);
 108 typedef void    pr_sosetlabel_t(struct socket *);
 109 typedef void    pr_close_t(struct socket *);
 110 typedef int     pr_bindat_t(int, struct socket *, struct sockaddr *,
 111                     struct thread *);
 112 typedef int     pr_connectat_t(int, struct socket *, struct sockaddr *,
 113                     struct thread *);
 114 typedef int     pr_aio_queue_t(struct socket *, struct kaiocb *);
 115
 116 struct protosw {
 117         short   pr_type;                /* socket type used for */
 118         struct  domain *pr_domain;      /* domain protocol a member of */
 119         short   pr_protocol;            /* protocol number */
 120         short   pr_flags;               /* see below */
 121 /* protocol-protocol hooks */
 122         pr_ctloutput_t *pr_ctloutput;   /* control output (from above) */
 123 /* utility hooks */
 124         pr_fasttimo_t *pr_fasttimo;     /* fast timeout (200ms) */
 125         pr_slowtimo_t *pr_slowtimo;     /* slow timeout (500ms) */
 126         pr_drain_t *pr_drain;           /* flush any excess space possible */
 127
 128         struct  pr_usrreqs *pr_usrreqs; /* user-protocol hook */
 129         LIST_ENTRY(protosw)  pr_fasttimos;
 130         LIST_ENTRY(protosw)  pr_slowtimos;
 131 };
 132 /*#endif*/
 133
 134 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
 135 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
 136
 137 /*
 138  * This number should be defined again within each protocol family to avoid
 139  * confusion.
 140  */
 141 #define PROTO_SPACER    32767           /* spacer for loadable protocols */
 142
 143 /*
 144  * Values for pr_flags.
 145  * PR_ADDR requires PR_ATOMIC;
 146  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 147  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 148  *      and the protocol understands the MSG_EOF flag.  The first property is
 149  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 150  *      anyhow).
 151  * PR_SOCKBUF requires protocol to initialize and destroy its socket buffers
 152  * in its pr_attach and pr_detach.
 153  */
 154 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
 155 #define PR_ADDR         0x02            /* addresses given with messages */
 156 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 157 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
 158 #define PR_RIGHTS       0x10            /* passes capabilities */
 159 #define PR_IMPLOPCL     0x20            /* implied open/close */
 160 /* was  PR_LASTHDR      0x40               enforce ipsec policy; last header */
 161 #define PR_CAPATTACH    0x80            /* socket can attach in cap mode */
 162 #define PR_SOCKBUF      0x100           /* private implementation of buffers */
 163
 164 /*
 165  * In earlier BSD network stacks, a single pr_usrreq() function pointer was
 166  * invoked with an operation number indicating what operation was desired.
 167  * We now provide individual function pointers which protocols can implement,
 168  * which offers a number of benefits (such as type checking for arguments).
 169  * These older constants are still present in order to support TCP debugging.
 170  */
 171 #define PRU_ATTACH              0       /* attach protocol to up */
 172 #define PRU_DETACH              1       /* detach protocol from up */
 173 #define PRU_BIND                2       /* bind socket to address */
 174 #define PRU_LISTEN              3       /* listen for connection */
 175 #define PRU_CONNECT             4       /* establish connection to peer */
 176 #define PRU_ACCEPT              5       /* accept connection from peer */
 177 #define PRU_DISCONNECT          6       /* disconnect from peer */
 178 #define PRU_SHUTDOWN            7       /* won't send any more data */
 179 #define PRU_RCVD                8       /* have taken data; more room now */
 180 #define PRU_SEND                9       /* send this data */
 181 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 182 #define PRU_CONTROL             11      /* control operations on protocol */
 183 #define PRU_SENSE               12      /* return status into m */
 184 #define PRU_RCVOOB              13      /* retrieve out of band data */
 185 #define PRU_SENDOOB             14      /* send out of band data */
 186 #define PRU_SOCKADDR            15      /* fetch socket's address */
 187 #define PRU_PEERADDR            16      /* fetch peer's address */
 188 #define PRU_CONNECT2            17      /* connect two sockets */
 189 /* begin for protocols internal use */
 190 #define PRU_FASTTIMO            18      /* 200ms timeout */
 191 #define PRU_SLOWTIMO            19      /* 500ms timeout */
 192 #define PRU_PROTORCV            20      /* receive from below */
 193 #define PRU_PROTOSEND           21      /* send to below */
 194 /* end for protocol's internal use */
 195 #define PRU_SEND_EOF            22      /* send and close */
 196 #define PRU_SOSETLABEL          23      /* MAC label change */
 197 #define PRU_CLOSE               24      /* socket close */
 198 #define PRU_FLUSH               25      /* flush the socket */
 199 #define PRU_NREQ                25
 200
 201 #ifdef PRUREQUESTS
 202 const char *prurequests[] = {
 203         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 204         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 205         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 206         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 207         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
 208         "PROTORCV",     "PROTOSEND",    "SEND_EOF",     "SOSETLABEL",
 209         "CLOSE",        "FLUSH",
 210 };
 211 #endif
 212
 213 #ifdef  _KERNEL                 /* users shouldn't see this decl */
 214
 215 struct ifnet;
 216 struct stat;
 217 struct ucred;
 218 struct uio;
 219
 220 /*
 221  * If the ordering here looks odd, that's because it's alphabetical.  These
 222  * should eventually be merged back into struct protosw.
 223  *
 224  * Some fields initialized to defaults if they are NULL.
 225  */
 226 struct pr_usrreqs {
 227         pr_abort_t      *pru_abort;
 228         pr_accept_t     *pru_accept;
 229         pr_attach_t     *pru_attach;
 230         pr_bind_t       *pru_bind;
 231         pr_connect_t    *pru_connect;
 232         pr_connect2_t   *pru_connect2;
 233         pr_control_t    *pru_control;
 234         pr_detach_t     *pru_detach;
 235         pr_disconnect_t *pru_disconnect;
 236         pr_listen_t     *pru_listen;
 237         pr_peeraddr_t   *pru_peeraddr;
 238         pr_rcvd_t       *pru_rcvd;
 239         pr_rcvoob_t     *pru_rcvoob;
 240         pr_send_t       *pru_send;
 241         pr_ready_t      *pru_ready;
 242         pr_sense_t      *pru_sense;
 243         pr_shutdown_t   *pru_shutdown;
 244         pr_flush_t      *pru_flush;
 245         pr_sockaddr_t   *pru_sockaddr;
 246         pr_sosend_t     *pru_sosend;
 247         pr_soreceive_t  *pru_soreceive;
 248         pr_sopoll_t     *pru_sopoll;
 249         pr_sosetlabel_t *pru_sosetlabel;
 250         pr_close_t      *pru_close;
 251         pr_bindat_t     *pru_bindat;
 252         pr_connectat_t  *pru_connectat;
 253         pr_aio_queue_t  *pru_aio_queue;
 254 };
 255
 256 /*
 257  * All nonvoid pru_*() functions below return EOPNOTSUPP.
 258  */
 259 int     pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
 260 int     pru_aio_queue_notsupp(struct socket *so, struct kaiocb *job);
 261 int     pru_attach_notsupp(struct socket *so, int proto, struct thread *td);
 262 int     pru_bind_notsupp(struct socket *so, struct sockaddr *nam,
 263             struct thread *td);
 264 int     pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
 265             struct thread *td);
 266 int     pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
 267             struct thread *td);
 268 int     pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
 269             struct thread *td);
 270 int     pru_connect2_notsupp(struct socket *so1, struct socket *so2);
 271 int     pru_control_notsupp(struct socket *so, u_long cmd, void *data,
 272             struct ifnet *ifp, struct thread *td);
 273 int     pru_disconnect_notsupp(struct socket *so);
 274 int     pru_listen_notsupp(struct socket *so, int backlog, struct thread *td);
 275 int     pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam);
 276 int     pru_rcvd_notsupp(struct socket *so, int flags);
 277 int     pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags);
 278 int     pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
 279             struct sockaddr *addr, struct mbuf *control, struct thread *td);
 280 int     pru_ready_notsupp(struct socket *so, struct mbuf *m, int count);
 281 int     pru_sense_null(struct socket *so, struct stat *sb);
 282 int     pru_shutdown_notsupp(struct socket *so);
 283 int     pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam);
 284 int     pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
 285             struct uio *uio, struct mbuf *top, struct mbuf *control, int flags,
 286             struct thread *td);
 287 int     pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
 288             struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
 289             int *flagsp);
 290 int     pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
 291             struct thread *td);
 292
 293 #endif /* _KERNEL */
 294
 295 /*
 296  * The arguments to the ctlinput routine are
 297  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 298  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 299  * and arg is a `void *' argument used within a protocol family.
 300  */
 301 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 302 /* was  PRC_QUENCH2             3       DEC congestion bit says slow down */
 303 /* was  PRC_QUENCH              4       Deprecated by RFC 6633 */
 304 #define PRC_MSGSIZE             5       /* message size forced drop */
 305 #define PRC_HOSTDEAD            6       /* host appears to be down */
 306 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 307 #define PRC_UNREACH_NET         8       /* no route to network */
 308 #define PRC_UNREACH_HOST        9       /* no route to host */
 309 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 310 #define PRC_UNREACH_PORT        11      /* bad port # */
 311 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 312 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 313 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 314 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 315 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 316 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 317 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 318 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 319 #define PRC_PARAMPROB           20      /* header incorrect */
 320 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
 321
 322 #define PRC_NCMDS               22
 323
 324 #define PRC_IS_REDIRECT(cmd)    \
 325         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 326
 327 #ifdef PRCREQUESTS
 328 char    *prcrequests[] = {
 329         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
 330         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 331         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 332         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 333         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 334         "PARAMPROB", "ADMIN-UNREACH"
 335 };
 336 #endif
 337
 338 /*
 339  * The arguments to ctloutput are:
 340  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 341  * req is one of the actions listed below, so is a (struct socket *),
 342  * level is an indication of which protocol layer the option is intended.
 343  * optname is a protocol dependent socket option request,
 344  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 345  * The protocol is responsible for disposal of the mbuf chain *optval
 346  * if supplied,
 347  * the caller is responsible for any space held by *optval, when returned.
 348  * A non-zero return from ctloutput gives an
 349  * UNIX error number which should be passed to higher level software.
 350  */
 351 #define PRCO_GETOPT     0
 352 #define PRCO_SETOPT     1
 353
 354 #define PRCO_NCMDS      2
 355
 356 #ifdef PRCOREQUESTS
 357 char    *prcorequests[] = {
 358         "GETOPT", "SETOPT",
 359 };
 360 #endif
 361
 362 #ifdef _KERNEL
 363 struct domain *pffinddomain(int family);
 364 struct protosw *pffindproto(int family, int protocol, int type);
 365 struct protosw *pffindtype(int family, int type);
 366 int     pf_proto_register(int family, struct protosw *npr);
 367 int     pf_proto_unregister(int family, int protocol, int type);
 368 #endif
 369
 370 #endif