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
  32 #ifndef _SYS_PROTOSW_H_
  33 #define _SYS_PROTOSW_H_
  34
  35 #include <sys/queue.h>
  36
  37 /* Forward declare these structures referenced from prototypes below. */
  38 struct kaiocb;
  39 struct mbuf;
  40 struct thread;
  41 struct sockaddr;
  42 struct socket;
  43 struct sockopt;
  44
  45 /*#ifdef _KERNEL*/
  46 /*
  47  * Protocol switch table.
  48  *
  49  * Each protocol has a handle initializing one of these structures,
  50  * which is used for protocol-protocol and system-protocol communication.
  51  *
  52  * In retrospect, it would be a lot nicer to use an interface
  53  * similar to the vnode VOP interface.
  54  */
  55 struct ifnet;
  56 struct stat;
  57 struct ucred;
  58 struct uio;
  59
  60 /* USE THESE FOR YOUR PROTOTYPES ! */
  61 typedef int     pr_ctloutput_t(struct socket *, struct sockopt *);
  62 typedef int     pr_setsbopt_t(struct socket *, struct sockopt *);
  63 typedef void    pr_abort_t(struct socket *);
  64 typedef int     pr_accept_t(struct socket *, struct sockaddr *);
  65 typedef int     pr_attach_t(struct socket *, int, struct thread *);
  66 typedef int     pr_bind_t(struct socket *, struct sockaddr *, struct thread *);
  67 typedef int     pr_connect_t(struct socket *, struct sockaddr *,
  68                     struct thread *);
  69 typedef int     pr_connect2_t(struct socket *, struct socket *);
  70 typedef int     pr_control_t(struct socket *, unsigned long, void *,
  71                     struct ifnet *, struct thread *);
  72 typedef void    pr_detach_t(struct socket *);
  73 typedef int     pr_disconnect_t(struct socket *);
  74 typedef int     pr_listen_t(struct socket *, int, struct thread *);
  75 typedef int     pr_peeraddr_t(struct socket *, struct sockaddr *);
  76 typedef int     pr_rcvd_t(struct socket *, int);
  77 typedef int     pr_rcvoob_t(struct socket *, struct mbuf *, int);
  78 typedef enum {
  79         PRUS_OOB =              0x1,
  80         PRUS_EOF =              0x2,
  81         PRUS_MORETOCOME =       0x4,
  82         PRUS_NOTREADY =         0x8,
  83         PRUS_IPV6 =             0x10,
  84 } pr_send_flags_t;
  85 typedef int     pr_send_t(struct socket *, int, struct mbuf *,
  86                     struct sockaddr *, struct mbuf *, struct thread *);
  87 typedef int     pr_ready_t(struct socket *, struct mbuf *, int);
  88 typedef int     pr_sense_t(struct socket *, struct stat *);
  89 typedef int     pr_shutdown_t(struct socket *);
  90 typedef int     pr_flush_t(struct socket *, int);
  91 typedef int     pr_sockaddr_t(struct socket *, struct sockaddr *);
  92 typedef int     pr_sosend_t(struct socket *, struct sockaddr *, struct uio *,
  93                     struct mbuf *, struct mbuf *, int, struct thread *);
  94 typedef int     pr_soreceive_t(struct socket *, struct sockaddr **,
  95                     struct uio *, struct mbuf **, struct mbuf **, int *);
  96 typedef int     pr_sopoll_t(struct socket *, int, struct ucred *,
  97                     struct thread *);
  98 typedef void    pr_sosetlabel_t(struct socket *);
  99 typedef void    pr_close_t(struct socket *);
 100 typedef int     pr_bindat_t(int, struct socket *, struct sockaddr *,
 101                     struct thread *);
 102 typedef int     pr_connectat_t(int, struct socket *, struct sockaddr *,
 103                     struct thread *);
 104 typedef int     pr_aio_queue_t(struct socket *, struct kaiocb *);
 105
 106 struct protosw {
 107         short   pr_type;                /* socket type used for */
 108         short   pr_protocol;            /* protocol number */
 109         short   pr_flags;               /* see below */
 110         short   pr_unused;
 111         struct  domain  *pr_domain;     /* domain protocol a member of */
 112
 113         pr_soreceive_t  *pr_soreceive;  /* recv(2) */
 114         pr_rcvd_t       *pr_rcvd;       /* soreceive_generic() if PR_WANTRCVD */
 115         pr_sosend_t     *pr_sosend;     /* send(2) */
 116         pr_send_t       *pr_send;       /* send(2) via sosend_generic() */
 117         pr_ready_t      *pr_ready;      /* sendfile/ktls readyness */
 118         pr_sopoll_t     *pr_sopoll;     /* poll(2) */
 119 /* Cache line #2 */
 120         pr_attach_t     *pr_attach;     /* creation: socreate(), sonewconn() */
 121         pr_detach_t     *pr_detach;     /* destruction: sofree() */
 122         pr_connect_t    *pr_connect;    /* connect(2) */
 123         pr_disconnect_t *pr_disconnect; /* sodisconnect() */
 124         pr_close_t      *pr_close;      /* close(2) */
 125         pr_shutdown_t   *pr_shutdown;   /* shutdown(2) */
 126         pr_abort_t      *pr_abort;      /* abrupt tear down: soabort() */
 127         pr_aio_queue_t  *pr_aio_queue;  /* aio(9) */
 128 /* Cache line #3 */
 129         pr_bind_t       *pr_bind;       /* bind(2) */
 130         pr_bindat_t     *pr_bindat;     /* bindat(2) */
 131         pr_listen_t     *pr_listen;     /* listen(2) */
 132         pr_accept_t     *pr_accept;     /* accept(2) */
 133         pr_connectat_t  *pr_connectat;  /* connectat(2) */
 134         pr_connect2_t   *pr_connect2;   /* socketpair(2) */
 135         pr_control_t    *pr_control;    /* ioctl(2) */
 136         pr_rcvoob_t     *pr_rcvoob;     /* soreceive_rcvoob() */
 137 /* Cache line #4 */
 138         pr_ctloutput_t  *pr_ctloutput;  /* control output (from above) */
 139         pr_peeraddr_t   *pr_peeraddr;   /* getpeername(2) */
 140         pr_sockaddr_t   *pr_sockaddr;   /* getsockname(2) */
 141         pr_sense_t      *pr_sense;      /* stat(2) */
 142         pr_flush_t      *pr_flush;      /* XXXGL: merge with pr_shutdown_t! */
 143         pr_sosetlabel_t *pr_sosetlabel; /* MAC, XXXGL: remove */
 144         pr_setsbopt_t   *pr_setsbopt;   /* Socket buffer ioctls */
 145 };
 146 /*#endif*/
 147
 148 /*
 149  * Values for pr_flags.
 150  * PR_ADDR requires PR_ATOMIC;
 151  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 152  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 153  *      and the protocol understands the MSG_EOF flag.  The first property is
 154  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 155  *      anyhow).
 156  * PR_SOCKBUF requires protocol to initialize and destroy its socket buffers
 157  * in its pr_attach and pr_detach.
 158  */
 159 #define PR_ATOMIC       0x01            /* exchange atomic messages only */
 160 #define PR_ADDR         0x02            /* addresses given with messages */
 161 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 162 #define PR_WANTRCVD     0x08            /* want PRU_RCVD calls */
 163 #define PR_RIGHTS       0x10            /* passes capabilities */
 164 #define PR_IMPLOPCL     0x20            /* implied open/close */
 165 /* was  PR_LASTHDR      0x40               enforce ipsec policy; last header */
 166 #define PR_CAPATTACH    0x80            /* socket can attach in cap mode */
 167 #define PR_SOCKBUF      0x100           /* private implementation of buffers */
 168
 169 /*
 170  * The arguments to ctloutput are:
 171  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 172  * req is one of the actions listed below, so is a (struct socket *),
 173  * level is an indication of which protocol layer the option is intended.
 174  * optname is a protocol dependent socket option request,
 175  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 176  * The protocol is responsible for disposal of the mbuf chain *optval
 177  * if supplied,
 178  * the caller is responsible for any space held by *optval, when returned.
 179  * A non-zero return from ctloutput gives an
 180  * UNIX error number which should be passed to higher level software.
 181  */
 182 #define PRCO_GETOPT     0
 183 #define PRCO_SETOPT     1
 184
 185 #define PRCO_NCMDS      2
 186
 187 #ifdef PRCOREQUESTS
 188 char    *prcorequests[] = {
 189         "GETOPT", "SETOPT",
 190 };
 191 #endif
 192
 193 #ifdef _KERNEL
 194 struct domain *pffinddomain(int family);
 195 struct protosw *pffindproto(int family, int type, int proto);
 196 int protosw_register(struct domain *, struct protosw *);
 197 int protosw_unregister(struct protosw *);
 198
 199 /* Domains that are known to be avaliable for protosw_register(). */
 200 extern struct domain inetdomain;
 201 extern struct domain inet6domain;
 202 #endif
 203
 204 #endif