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