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