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  * Protocols pass data between themselves as chains of mbufs using
  61  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
  62  * the users) and pr_output passes it down (towards the interfaces); control
  63  * information passes up and down on pr_ctlinput and pr_ctloutput.
  64  * The protocol is responsible for the space occupied by any the
  65  * arguments to these entries and must dispose it.
  66  *
  67  * In retrospect, it would be a lot nicer to use an interface
  68  * similar to the vnode VOP interface.
  69  */
  70 /* USE THESE FOR YOUR PROTOTYPES ! */
  71 typedef int     pr_input_t (struct mbuf **, int*, int);
  72 typedef int     pr_output_t (struct mbuf *, struct socket *, ...);
  73 typedef void    pr_ctlinput_t (int, struct sockaddr *, void *);
  74 typedef int     pr_ctloutput_t (struct socket *, struct sockopt *);
  75 typedef void    pr_fasttimo_t (void);
  76 typedef void    pr_slowtimo_t (void);
  77 typedef void    pr_drain_t (void);
  78
  79 struct protosw {
  80         short   pr_type;                /* socket type used for */
  81         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         pr_input_t *pr_input;           /* input to protocol (from below) */
  86         pr_output_t *pr_output;         /* output to protocol (from above) */
  87         pr_ctlinput_t *pr_ctlinput;     /* control input (from below) */
  88         pr_ctloutput_t *pr_ctloutput;   /* control output (from above) */
  89 /* utility hooks */
  90         pr_fasttimo_t *pr_fasttimo;     /* fast timeout (200ms) */
  91         pr_slowtimo_t *pr_slowtimo;     /* slow timeout (500ms) */
  92         pr_drain_t *pr_drain;           /* flush any excess space possible */
  93
  94         struct  pr_usrreqs *pr_usrreqs; /* user-protocol hook */
  95         LIST_ENTRY(protosw)  pr_fasttimos;
  96         LIST_ENTRY(protosw)  pr_slowtimos;
  97 };
  98 /*#endif*/
  99
 100 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
 101 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
 102
 103 /*
 104  * This number should be defined again within each protocol family to avoid
 105  * confusion.
 106  */
 107 #define PROTO_SPACER    32767           /* spacer for loadable protocols */
 108
 109 /*
 110  * Values for pr_flags.
 111  * PR_ADDR requires PR_ATOMIC;
 112  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 113  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 114  *      and the protocol understands the MSG_EOF flag.  The first property is
 115  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 116  *      anyhow).
 117  * PR_SOCKBUF requires protocol to initialize and destroy its socket buffers
 118  * in its pr_attach and pr_detach.
 119  */
 120 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
 121 #define PR_ADDR         0x02            /* addresses given with messages */
 122 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 123 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
 124 #define PR_RIGHTS       0x10            /* passes capabilities */
 125 #define PR_IMPLOPCL     0x20            /* implied open/close */
 126 #define PR_LASTHDR      0x40            /* enforce ipsec policy; last header */
 127 #define PR_CAPATTACH    0x80            /* socket can attach in cap mode */
 128 #define PR_SOCKBUF      0x100           /* private implementation of buffers */
 129
 130 /*
 131  * In earlier BSD network stacks, a single pr_usrreq() function pointer was
 132  * invoked with an operation number indicating what operation was desired.
 133  * We now provide individual function pointers which protocols can implement,
 134  * which offers a number of benefits (such as type checking for arguments).
 135  * These older constants are still present in order to support TCP debugging.
 136  */
 137 #define PRU_ATTACH              0       /* attach protocol to up */
 138 #define PRU_DETACH              1       /* detach protocol from up */
 139 #define PRU_BIND                2       /* bind socket to address */
 140 #define PRU_LISTEN              3       /* listen for connection */
 141 #define PRU_CONNECT             4       /* establish connection to peer */
 142 #define PRU_ACCEPT              5       /* accept connection from peer */
 143 #define PRU_DISCONNECT          6       /* disconnect from peer */
 144 #define PRU_SHUTDOWN            7       /* won't send any more data */
 145 #define PRU_RCVD                8       /* have taken data; more room now */
 146 #define PRU_SEND                9       /* send this data */
 147 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 148 #define PRU_CONTROL             11      /* control operations on protocol */
 149 #define PRU_SENSE               12      /* return status into m */
 150 #define PRU_RCVOOB              13      /* retrieve out of band data */
 151 #define PRU_SENDOOB             14      /* send out of band data */
 152 #define PRU_SOCKADDR            15      /* fetch socket's address */
 153 #define PRU_PEERADDR            16      /* fetch peer's address */
 154 #define PRU_CONNECT2            17      /* connect two sockets */
 155 /* begin for protocols internal use */
 156 #define PRU_FASTTIMO            18      /* 200ms timeout */
 157 #define PRU_SLOWTIMO            19      /* 500ms timeout */
 158 #define PRU_PROTORCV            20      /* receive from below */
 159 #define PRU_PROTOSEND           21      /* send to below */
 160 /* end for protocol's internal use */
 161 #define PRU_SEND_EOF            22      /* send and close */
 162 #define PRU_SOSETLABEL          23      /* MAC label change */
 163 #define PRU_CLOSE               24      /* socket close */
 164 #define PRU_FLUSH               25      /* flush the socket */
 165 #define PRU_NREQ                25
 166
 167 #ifdef PRUREQUESTS
 168 const char *prurequests[] = {
 169         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 170         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 171         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 172         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 173         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
 174         "PROTORCV",     "PROTOSEND",    "SEND_EOF",     "SOSETLABEL",
 175         "CLOSE",        "FLUSH",
 176 };
 177 #endif
 178
 179 #ifdef  _KERNEL                 /* users shouldn't see this decl */
 180
 181 struct ifnet;
 182 struct stat;
 183 struct ucred;
 184 struct uio;
 185
 186 /*
 187  * If the ordering here looks odd, that's because it's alphabetical.  These
 188  * should eventually be merged back into struct protosw.
 189  *
 190  * Some fields initialized to defaults if they are NULL.
 191  */
 192 struct pr_usrreqs {
 193         void    (*pru_abort)(struct socket *so);
 194         int     (*pru_accept)(struct socket *so, struct sockaddr **nam);
 195         int     (*pru_attach)(struct socket *so, int proto, struct thread *td);
 196         int     (*pru_bind)(struct socket *so, struct sockaddr *nam,
 197                     struct thread *td);
 198         int     (*pru_connect)(struct socket *so, struct sockaddr *nam,
 199                     struct thread *td);
 200         int     (*pru_connect2)(struct socket *so1, struct socket *so2);
 201         int     (*pru_control)(struct socket *so, u_long cmd, caddr_t data,
 202                     struct ifnet *ifp, struct thread *td);
 203         void    (*pru_detach)(struct socket *so);
 204         int     (*pru_disconnect)(struct socket *so);
 205         int     (*pru_listen)(struct socket *so, int backlog,
 206                     struct thread *td);
 207         int     (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
 208         int     (*pru_rcvd)(struct socket *so, int flags);
 209         int     (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
 210         int     (*pru_send)(struct socket *so, int flags, struct mbuf *m,
 211                     struct sockaddr *addr, struct mbuf *control,
 212                     struct thread *td);
 213 #define PRUS_OOB        0x1
 214 #define PRUS_EOF        0x2
 215 #define PRUS_MORETOCOME 0x4
 216 #define PRUS_NOTREADY   0x8
 217 #define PRUS_IPV6       0x10
 218         int     (*pru_ready)(struct socket *so, struct mbuf *m, int count);
 219         int     (*pru_sense)(struct socket *so, struct stat *sb);
 220         int     (*pru_shutdown)(struct socket *so);
 221         int     (*pru_flush)(struct socket *so, int direction);
 222         int     (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
 223         int     (*pru_sosend)(struct socket *so, struct sockaddr *addr,
 224                     struct uio *uio, struct mbuf *top, struct mbuf *control,
 225                     int flags, struct thread *td);
 226         int     (*pru_soreceive)(struct socket *so, struct sockaddr **paddr,
 227                     struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
 228                     int *flagsp);
 229         int     (*pru_sopoll)(struct socket *so, int events,
 230                     struct ucred *cred, struct thread *td);
 231         void    (*pru_sosetlabel)(struct socket *so);
 232         void    (*pru_close)(struct socket *so);
 233         int     (*pru_bindat)(int fd, struct socket *so, struct sockaddr *nam,
 234                     struct thread *td);
 235         int     (*pru_connectat)(int fd, struct socket *so,
 236                     struct sockaddr *nam, struct thread *td);
 237         int     (*pru_aio_queue)(struct socket *so, struct kaiocb *job);
 238 };
 239
 240 /*
 241  * All nonvoid pru_*() functions below return EOPNOTSUPP.
 242  */
 243 int     pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
 244 int     pru_aio_queue_notsupp(struct socket *so, struct kaiocb *job);
 245 int     pru_attach_notsupp(struct socket *so, int proto, struct thread *td);
 246 int     pru_bind_notsupp(struct socket *so, struct sockaddr *nam,
 247             struct thread *td);
 248 int     pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
 249             struct thread *td);
 250 int     pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
 251             struct thread *td);
 252 int     pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam,
 253             struct thread *td);
 254 int     pru_connect2_notsupp(struct socket *so1, struct socket *so2);
 255 int     pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
 256             struct ifnet *ifp, struct thread *td);
 257 int     pru_disconnect_notsupp(struct socket *so);
 258 int     pru_listen_notsupp(struct socket *so, int backlog, struct thread *td);
 259 int     pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam);
 260 int     pru_rcvd_notsupp(struct socket *so, int flags);
 261 int     pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags);
 262 int     pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
 263             struct sockaddr *addr, struct mbuf *control, struct thread *td);
 264 int     pru_ready_notsupp(struct socket *so, struct mbuf *m, int count);
 265 int     pru_sense_null(struct socket *so, struct stat *sb);
 266 int     pru_shutdown_notsupp(struct socket *so);
 267 int     pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam);
 268 int     pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
 269             struct uio *uio, struct mbuf *top, struct mbuf *control, int flags,
 270             struct thread *td);
 271 int     pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr,
 272             struct uio *uio, struct mbuf **mp0, struct mbuf **controlp,
 273             int *flagsp);
 274 int     pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred,
 275             struct thread *td);
 276
 277 #endif /* _KERNEL */
 278
 279 /*
 280  * The arguments to the ctlinput routine are
 281  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 282  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 283  * and arg is a `void *' argument used within a protocol family.
 284  */
 285 #define PRC_IFDOWN              0       /* interface transition */
 286 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 287 #define PRC_IFUP                2       /* interface has come back up */
 288 /* was  PRC_QUENCH2             3       DEC congestion bit says slow down */
 289 /* was  PRC_QUENCH              4       Deprecated by RFC 6633 */
 290 #define PRC_MSGSIZE             5       /* message size forced drop */
 291 #define PRC_HOSTDEAD            6       /* host appears to be down */
 292 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 293 #define PRC_UNREACH_NET         8       /* no route to network */
 294 #define PRC_UNREACH_HOST        9       /* no route to host */
 295 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 296 #define PRC_UNREACH_PORT        11      /* bad port # */
 297 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 298 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 299 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 300 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 301 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 302 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 303 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 304 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 305 #define PRC_PARAMPROB           20      /* header incorrect */
 306 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
 307
 308 #define PRC_NCMDS               22
 309
 310 #define PRC_IS_REDIRECT(cmd)    \
 311         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 312
 313 #ifdef PRCREQUESTS
 314 char    *prcrequests[] = {
 315         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
 316         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 317         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 318         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 319         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 320         "PARAMPROB", "ADMIN-UNREACH"
 321 };
 322 #endif
 323
 324 /*
 325  * The arguments to ctloutput are:
 326  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 327  * req is one of the actions listed below, so is a (struct socket *),
 328  * level is an indication of which protocol layer the option is intended.
 329  * optname is a protocol dependent socket option request,
 330  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 331  * The protocol is responsible for disposal of the mbuf chain *optval
 332  * if supplied,
 333  * the caller is responsible for any space held by *optval, when returned.
 334  * A non-zero return from ctloutput gives an
 335  * UNIX error number which should be passed to higher level software.
 336  */
 337 #define PRCO_GETOPT     0
 338 #define PRCO_SETOPT     1
 339
 340 #define PRCO_NCMDS      2
 341
 342 #ifdef PRCOREQUESTS
 343 char    *prcorequests[] = {
 344         "GETOPT", "SETOPT",
 345 };
 346 #endif
 347
 348 #ifdef _KERNEL
 349 void    pfctlinput(int, struct sockaddr *);
 350 struct domain *pffinddomain(int family);
 351 struct protosw *pffindproto(int family, int protocol, int type);
 352 struct protosw *pffindtype(int family, int type);
 353 int     pf_proto_register(int family, struct protosw *npr);
 354 int     pf_proto_unregister(int family, int protocol, int type);
 355 #endif
 356
 357 #endif