1 /*- 2 * Copyright (c) 1982, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)protosw.h 8.1 (Berkeley) 6/2/93 34 * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $ 35 * $DragonFly: src/sys/sys/protosw.h,v 1.20 2007/12/19 11:00:23 sephe Exp $ 36 */ 37 38 #ifndef _SYS_PROTOSW_H_ 39 #define _SYS_PROTOSW_H_ 40 41 #ifndef _SYS_TYPES_H_ 42 #include <sys/types.h> 43 #endif 44 45 /* Forward declare these structures referenced from prototypes below. */ 46 struct mbuf; 47 struct thread; 48 struct sockaddr; 49 struct socket; 50 struct sockopt; 51 52 struct pr_output_info { 53 pid_t p_pid; 54 }; 55 56 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 57 58 /* 59 * Protocol switch table. 60 * 61 * Each protocol has a handle initializing one of these structures, 62 * which is used for protocol-protocol and system-protocol communication. 63 * 64 * A protocol is called through the pr_init entry before any other. 65 * Thereafter it is called every 200ms through the pr_fasttimo entry and 66 * every 500ms through the pr_slowtimo for timer based actions. 67 * The system will call the pr_drain entry if it is low on space and 68 * this should throw away any non-critical data. 69 * 70 * Protocols pass data between themselves as chains of mbufs using 71 * the pr_input and pr_output hooks. Pr_input passes data up (towards 72 * the users) and pr_output passes it down (towards the interfaces); control 73 * information passes up and down on pr_ctlinput and pr_ctloutput. 74 * The protocol is responsible for the space occupied by any the 75 * arguments to these entries and must dispose it. 76 * 77 * In retrospect, it would be a lot nicer to use an interface 78 * similar to the vnode VOP interface. 79 */ 80 struct protosw { 81 short pr_type; /* socket type used for */ 82 const struct domain *pr_domain; /* domain protocol a member of */ 83 short pr_protocol; /* protocol number */ 84 short pr_flags; /* see below */ 85 /* protocol-protocol hooks */ 86 void (*pr_input) (struct mbuf *, ...); 87 /* input to protocol (from below) */ 88 int (*pr_output) (struct mbuf *, struct socket *, ...); 89 /* output to protocol (from above) */ 90 void (*pr_ctlinput)(int, struct sockaddr *, void *); 91 /* control input (from below) */ 92 int (*pr_ctloutput)(struct socket *, struct sockopt *); 93 /* control output (from above) */ 94 /* user-protocol hook */ 95 struct lwkt_port *(*pr_mport)(struct socket *, struct sockaddr *, 96 struct mbuf **, int); 97 /* utility hooks */ 98 void (*pr_init) (void); /* initialization hook */ 99 void (*pr_fasttimo) (void); 100 /* fast timeout (200ms) */ 101 void (*pr_slowtimo) (void); 102 /* slow timeout (500ms) */ 103 void (*pr_drain) (void); 104 /* flush any excess space possible */ 105 const struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 106 }; 107 108 #endif 109 110 #define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 111 #define PR_FASTHZ 5 /* 5 fast timeouts per second */ 112 113 /* 114 * Values for pr_flags. 115 * PR_ADDR requires PR_ATOMIC; 116 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 117 * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 118 * and the protocol understands the MSG_EOF flag. The first property is 119 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 120 * anyhow). 121 */ 122 #define PR_ATOMIC 0x01 /* exchange atomic messages only */ 123 #define PR_ADDR 0x02 /* addresses given with messages */ 124 #define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 125 #define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 126 #define PR_RIGHTS 0x10 /* passes capabilities */ 127 #define PR_IMPLOPCL 0x20 /* implied open/close */ 128 #define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ 129 #define PR_ADDR_OPT 0x80 /* allow addresses during delivery */ 130 131 /* 132 * The arguments to usrreq are: 133 * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 134 * where up is a (struct socket *), req is one of these requests, 135 * m is a optional mbuf chain containing a message, 136 * nam is an optional mbuf chain containing an address, 137 * and opt is a pointer to a socketopt structure or nil. 138 * The protocol is responsible for disposal of the mbuf chain m, 139 * the caller is responsible for any space held by nam and opt. 140 * A non-zero return from usrreq gives an 141 * UNIX error number which should be passed to higher level software. 142 */ 143 #define PRU_ATTACH 0 /* attach protocol to up */ 144 #define PRU_DETACH 1 /* detach protocol from up */ 145 #define PRU_BIND 2 /* bind socket to address */ 146 #define PRU_LISTEN 3 /* listen for connection */ 147 #define PRU_CONNECT 4 /* establish connection to peer */ 148 #define PRU_ACCEPT 5 /* accept connection from peer */ 149 #define PRU_DISCONNECT 6 /* disconnect from peer */ 150 #define PRU_SHUTDOWN 7 /* won't send any more data */ 151 #define PRU_RCVD 8 /* have taken data; more room now */ 152 #define PRU_SEND 9 /* send this data */ 153 #define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 154 #define PRU_CONTROL 11 /* control operations on protocol */ 155 #define PRU_SENSE 12 /* return status into m */ 156 #define PRU_RCVOOB 13 /* retrieve out of band data */ 157 #define PRU_SENDOOB 14 /* send out of band data */ 158 #define PRU_SOCKADDR 15 /* fetch socket's address */ 159 #define PRU_PEERADDR 16 /* fetch peer's address */ 160 #define PRU_CONNECT2 17 /* connect two sockets */ 161 #define PRU_SOPOLL 18 162 /* begin for protocols internal use */ 163 #define PRU_FASTTIMO 19 /* 200ms timeout */ 164 #define PRU_SLOWTIMO 20 /* 500ms timeout */ 165 #define PRU_PROTORCV 21 /* receive from below */ 166 #define PRU_PROTOSEND 22 /* send to below */ 167 /* end for protocol's internal use */ 168 #define PRU_SEND_EOF 23 /* send and close */ 169 #define PRU_PRED 24 170 #define PRU_NREQ 25 171 172 #ifdef PRUREQUESTS 173 char *prurequests[] = { 174 "ATTACH", "DETACH", "BIND", "LISTEN", 175 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 176 "RCVD", "SEND", "ABORT", "CONTROL", 177 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 178 "PEERADDR", "CONNECT2", "SOPOLL", 179 "FASTTIMO", "SLOWTIMO", "PROTORCV", "PROTOSEND", 180 "SEND_EOF", "PREDICATE" 181 }; 182 #endif 183 184 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 185 186 struct ifnet; 187 struct stat; 188 struct ucred; 189 struct uio; 190 struct sockbuf; 191 192 struct pru_attach_info { 193 struct rlimit *sb_rlimit; 194 struct ucred *p_ucred; 195 struct vnode *fd_rdir; 196 }; 197 198 /* 199 * If the ordering here looks odd, that's because it's alphabetical. 200 * Having this structure separated out from the main protoswitch is allegedly 201 * a big (12 cycles per call) lose on high-end CPUs. We will eventually 202 * migrate this stuff back into the main structure. 203 */ 204 struct pr_usrreqs { 205 int (*pru_abort) (struct socket *so); 206 int (*pru_accept) (struct socket *so, struct sockaddr **nam); 207 int (*pru_attach) (struct socket *so, int proto, 208 struct pru_attach_info *ai); 209 int (*pru_bind) (struct socket *so, struct sockaddr *nam, 210 struct thread *td); 211 int (*pru_connect) (struct socket *so, struct sockaddr *nam, 212 struct thread *td); 213 int (*pru_connect2) (struct socket *so1, struct socket *so2); 214 int (*pru_control) (struct socket *so, u_long cmd, caddr_t data, 215 struct ifnet *ifp, struct thread *td); 216 int (*pru_detach) (struct socket *so); 217 int (*pru_disconnect) (struct socket *so); 218 int (*pru_listen) (struct socket *so, struct thread *td); 219 int (*pru_peeraddr) (struct socket *so, 220 struct sockaddr **nam); 221 int (*pru_rcvd) (struct socket *so, int flags); 222 int (*pru_rcvoob) (struct socket *so, struct mbuf *m, 223 int flags); 224 int (*pru_send) (struct socket *so, int flags, struct mbuf *m, 225 struct sockaddr *addr, struct mbuf *control, 226 struct thread *td); 227 #define PRUS_OOB 0x1 228 #define PRUS_EOF 0x2 229 #define PRUS_MORETOCOME 0x4 230 int (*pru_sense) (struct socket *so, struct stat *sb); 231 int (*pru_shutdown) (struct socket *so); 232 int (*pru_sockaddr) (struct socket *so, 233 struct sockaddr **nam); 234 235 /* 236 * These three added later, so they are out of order. They are used 237 * for shortcutting (fast path input/output) in some protocols. 238 * XXX - that's a lie, they are not implemented yet 239 * Rather than calling sosend() etc. directly, calls are made 240 * through these entry points. For protocols which still use 241 * the generic code, these just point to those routines. 242 */ 243 int (*pru_sosend) (struct socket *so, struct sockaddr *addr, 244 struct uio *uio, struct mbuf *top, 245 struct mbuf *control, int flags, 246 struct thread *td); 247 int (*pru_soreceive) (struct socket *so, 248 struct sockaddr **paddr, 249 struct uio *uio, 250 struct sockbuf *sio, 251 struct mbuf **controlp, int *flagsp); 252 int (*pru_sopoll) (struct socket *so, int events, 253 struct ucred *cred, struct thread *td); 254 }; 255 256 typedef int (*pru_abort_fn_t) (struct socket *so); 257 typedef int (*pru_accept_fn_t) (struct socket *so, struct sockaddr **nam); 258 typedef int (*pru_attach_fn_t) (struct socket *so, int proto, 259 struct pru_attach_info *ai); 260 typedef int (*pru_bind_fn_t) (struct socket *so, struct sockaddr *nam, 261 struct thread *td); 262 typedef int (*pru_connect_fn_t) (struct socket *so, struct sockaddr *nam, 263 struct thread *td); 264 typedef int (*pru_connect2_fn_t) (struct socket *so1, struct socket *so2); 265 typedef int (*pru_control_fn_t) (struct socket *so, u_long cmd, caddr_t data, 266 struct ifnet *ifp, 267 struct thread *td); 268 typedef int (*pru_detach_fn_t) (struct socket *so); 269 typedef int (*pru_disconnect_fn_t) (struct socket *so); 270 typedef int (*pru_listen_fn_t) (struct socket *so, struct thread *td); 271 typedef int (*pru_peeraddr_fn_t) (struct socket *so, struct sockaddr **nam); 272 typedef int (*pru_rcvd_fn_t) (struct socket *so, int flags); 273 typedef int (*pru_rcvoob_fn_t) (struct socket *so, struct mbuf *m, int flags); 274 typedef int (*pru_send_fn_t) (struct socket *so, int flags, struct mbuf *m, 275 struct sockaddr *addr, 276 struct mbuf *control, 277 struct thread *td); 278 typedef int (*pru_sense_fn_t) (struct socket *so, struct stat *sb); 279 typedef int (*pru_shutdown_fn_t) (struct socket *so); 280 typedef int (*pru_sockaddr_fn_t) (struct socket *so, struct sockaddr **nam); 281 typedef int (*pru_sosend_fn_t) (struct socket *so, struct sockaddr *addr, 282 struct uio *uio, struct mbuf *top, 283 struct mbuf *control, int flags, 284 struct thread *td); 285 typedef int (*pru_soreceive_fn_t) (struct socket *so, struct sockaddr **paddr, 286 struct uio *uio, 287 struct sockbuf *sio, 288 struct mbuf **controlp, 289 int *flagsp); 290 typedef int (*pru_sopoll_fn_t) (struct socket *so, int events, 291 struct ucred *cred, 292 struct thread *td); 293 294 int pru_accept_notsupp (struct socket *so, struct sockaddr **nam); 295 int pru_connect_notsupp (struct socket *so, struct sockaddr *nam, 296 struct thread *td); 297 int pru_connect2_notsupp (struct socket *so1, struct socket *so2); 298 int pru_control_notsupp (struct socket *so, u_long cmd, caddr_t data, 299 struct ifnet *ifp, struct thread *td); 300 int pru_listen_notsupp (struct socket *so, struct thread *td); 301 int pru_rcvd_notsupp (struct socket *so, int flags); 302 int pru_rcvoob_notsupp (struct socket *so, struct mbuf *m, int flags); 303 int pru_sense_null (struct socket *so, struct stat *sb); 304 305 struct lwkt_port *cpu0_soport(struct socket *, struct sockaddr *, 306 struct mbuf **, int); 307 struct lwkt_port *sync_soport(struct socket *, struct sockaddr *, 308 struct mbuf **, int); 309 310 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 311 312 /* 313 * The arguments to the ctlinput routine are 314 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 315 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 316 * and arg is a `void *' argument used within a protocol family. 317 */ 318 #define PRC_IFDOWN 0 /* interface transition */ 319 #define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 320 #define PRC_IFUP 2 /* interface has come back up */ 321 #define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 322 #define PRC_QUENCH 4 /* some one said to slow down */ 323 #define PRC_MSGSIZE 5 /* message size forced drop */ 324 #define PRC_HOSTDEAD 6 /* host appears to be down */ 325 #define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 326 #define PRC_UNREACH_NET 8 /* no route to network */ 327 #define PRC_UNREACH_HOST 9 /* no route to host */ 328 #define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 329 #define PRC_UNREACH_PORT 11 /* bad port # */ 330 /* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 331 #define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 332 #define PRC_REDIRECT_NET 14 /* net routing redirect */ 333 #define PRC_REDIRECT_HOST 15 /* host routing redirect */ 334 #define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 335 #define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 336 #define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 337 #define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 338 #define PRC_PARAMPROB 20 /* header incorrect */ 339 #define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ 340 341 #define PRC_NCMDS 22 342 343 #define PRC_IS_REDIRECT(cmd) \ 344 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 345 346 #ifdef PRCREQUESTS 347 char *prcrequests[] = { 348 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 349 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 350 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 351 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 352 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 353 "PARAMPROB", "ADMIN-UNREACH" 354 }; 355 #endif 356 357 /* 358 * The arguments to ctloutput are: 359 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 360 * req is one of the actions listed below, so is a (struct socket *), 361 * level is an indication of which protocol layer the option is intended. 362 * optname is a protocol dependent socket option request, 363 * optval is a pointer to a mbuf-chain pointer, for value-return results. 364 * The protocol is responsible for disposal of the mbuf chain *optval 365 * if supplied, 366 * the caller is responsible for any space held by *optval, when returned. 367 * A non-zero return from usrreq gives an 368 * UNIX error number which should be passed to higher level software. 369 */ 370 #define PRCO_GETOPT 0 371 #define PRCO_SETOPT 1 372 373 #define PRCO_NCMDS 2 374 375 #ifdef PRCOREQUESTS 376 char *prcorequests[] = { 377 "GETOPT", "SETOPT", 378 }; 379 #endif 380 381 /* 382 * Kernel prototypes 383 */ 384 #ifdef _KERNEL 385 386 void pfctlinput (int, struct sockaddr *); 387 void pfctlinput2 (int, struct sockaddr *, void *); 388 struct protosw *pffindproto (int family, int protocol, int type); 389 struct protosw *pffindtype (int family, int type); 390 391 #endif /* _KERNEL */ 392 393 #endif /* _SYS_PROTOSW_H_ */ 394