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.24 2008/10/27 02:56:30 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 * netmsg_t union of possible netmsgs typically sent to protocol threads. 60 */ 61 typedef union netmsg *netmsg_t; 62 63 /* 64 * Protocol switch table. 65 * 66 * Each protocol has a handle initializing one of these structures, 67 * which is used for protocol-protocol and system-protocol communication. 68 * 69 * A protocol is called through the pr_init entry before any other. 70 * Thereafter it is called every 200ms through the pr_fasttimo entry and 71 * every 500ms through the pr_slowtimo for timer based actions. 72 * The system will call the pr_drain entry if it is low on space and 73 * this should throw away any non-critical data. 74 * 75 * Protocols pass data between themselves as chains of mbufs using 76 * the pr_input and pr_output hooks. Pr_input passes data up (towards 77 * the users) and pr_output passes it down (towards the interfaces); control 78 * information passes up and down on pr_ctlinput and pr_ctloutput. 79 * The protocol is responsible for the space occupied by any the 80 * arguments to these entries and must dispose it. 81 * 82 * In retrospect, it would be a lot nicer to use an interface 83 * similar to the vnode VOP interface. 84 */ 85 struct protosw { 86 short pr_type; /* socket type used for */ 87 const struct domain *pr_domain; /* domain protocol a member of */ 88 short pr_protocol; /* protocol number */ 89 short pr_flags; /* see below */ 90 91 /* 92 * Protocol hooks. These are typically called directly within the 93 * context of a protocol thread based on the toeplitz hash. 94 * 95 * pr_input() is called using the port supplied by the toeplitz 96 * hash via the netisr port function. 97 * 98 * pr_ctlinput() is called using the port supplied by pr_ctlport 99 * 100 * pr_ctloutput() and pr_output() are typically called 101 */ 102 int (*pr_input)(struct mbuf **, int *, int); 103 /* input to protocol (from below) */ 104 int (*pr_output)(struct mbuf *, struct socket *, ...); 105 /* output to protocol (from above) */ 106 void (*pr_ctlinput)(union netmsg *); 107 /* control input (from below) */ 108 void (*pr_ctloutput)(union netmsg *); 109 /* control output (from above) */ 110 struct lwkt_port *(*pr_ctlport)(int, struct sockaddr *, void *); 111 112 /* 113 * Utility hooks, not called with any particular context. 114 */ 115 void (*pr_init) (void); /* initialization hook */ 116 void (*pr_fasttimo) (void); /* fast timeout (200ms) */ 117 void (*pr_slowtimo) (void); /* slow timeout (500ms) */ 118 void (*pr_drain) (void); /* flush any excess space possible */ 119 120 struct pr_usrreqs *pr_usrreqs; /* messaged requests to proto thread */ 121 }; 122 123 #endif 124 125 #define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 126 #define PR_FASTHZ 5 /* 5 fast timeouts per second */ 127 128 /* 129 * Values for pr_flags. 130 * PR_ADDR requires PR_ATOMIC; 131 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 132 * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 133 * and the protocol understands the MSG_EOF flag. The first property is 134 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 135 * anyhow). 136 */ 137 #define PR_ATOMIC 0x01 /* exchange atomic messages only */ 138 #define PR_ADDR 0x02 /* addresses given with messages */ 139 #define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 140 #define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 141 #define PR_RIGHTS 0x10 /* passes capabilities */ 142 #define PR_IMPLOPCL 0x20 /* implied open/close */ 143 #define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ 144 #define PR_ADDR_OPT 0x80 /* allow addresses during delivery */ 145 #define PR_MPSAFE 0x0100 /* protocal is MPSAFE */ 146 #define PR_SYNC_PORT 0x0200 /* synchronous port (no proto thrds) */ 147 #define PR_ASYNC_SEND 0x0400 /* async pru_send */ 148 #define PR_ASYNC_RCVD 0x0800 /* async pru_rcvd */ 149 #define PR_ASEND_HOLDTD 0x1000 /* async pru_send hold orig thread */ 150 #define PR_ACONN_HOLDTD 0x2000 /* async pru_connect hold orig thread */ 151 #define PR_RAND_INITPORT 0x4000 /* random init msgport */ 152 153 /* 154 * The arguments to usrreq are: 155 * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 156 * where up is a (struct socket *), req is one of these requests, 157 * m is a optional mbuf chain containing a message, 158 * nam is an optional mbuf chain containing an address, 159 * and opt is a pointer to a socketopt structure or nil. 160 * The protocol is responsible for disposal of the mbuf chain m, 161 * the caller is responsible for any space held by nam and opt. 162 * A non-zero return from usrreq gives an 163 * UNIX error number which should be passed to higher level software. 164 */ 165 #define PRU_ATTACH 0 /* attach protocol to up */ 166 #define PRU_DETACH 1 /* detach protocol from up */ 167 #define PRU_BIND 2 /* bind socket to address */ 168 #define PRU_LISTEN 3 /* listen for connection */ 169 #define PRU_CONNECT 4 /* establish connection to peer */ 170 #define PRU_ACCEPT 5 /* accept connection from peer */ 171 #define PRU_DISCONNECT 6 /* disconnect from peer */ 172 #define PRU_SHUTDOWN 7 /* won't send any more data */ 173 #define PRU_RCVD 8 /* have taken data; more room now */ 174 #define PRU_SEND 9 /* send this data */ 175 #define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 176 #define PRU_CONTROL 11 /* control operations on protocol */ 177 #define PRU_SENSE 12 /* return status into m */ 178 #define PRU_RCVOOB 13 /* retrieve out of band data */ 179 #define PRU_SENDOOB 14 /* send out of band data */ 180 #define PRU_SOCKADDR 15 /* fetch socket's address */ 181 #define PRU_PEERADDR 16 /* fetch peer's address */ 182 #define PRU_CONNECT2 17 /* connect two sockets */ 183 #define PRU_RESERVED1 18 /* formerly PRU_SOPOLL */ 184 /* begin for protocols internal use */ 185 #define PRU_FASTTIMO 19 /* 200ms timeout */ 186 #define PRU_SLOWTIMO 20 /* 500ms timeout */ 187 #define PRU_PROTORCV 21 /* receive from below */ 188 #define PRU_PROTOSEND 22 /* send to below */ 189 /* end for protocol's internal use */ 190 #define PRU_SEND_EOF 23 /* send and close */ 191 #define PRU_PRED 24 192 #define PRU_CTLOUTPUT 25 /* get/set opts */ 193 #define PRU_NREQ 26 194 195 #ifdef PRUREQUESTS 196 const char *prurequests[] = { 197 "ATTACH", "DETACH", "BIND", "LISTEN", 198 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 199 "RCVD", "SEND", "ABORT", "CONTROL", 200 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 201 "PEERADDR", "CONNECT2", "", 202 "FASTTIMO", "SLOWTIMO", "PROTORCV", "PROTOSEND", 203 "SEND_EOF", "PREDICATE" 204 }; 205 #endif 206 207 #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) 208 209 struct ifnet; 210 struct stat; 211 struct ucred; 212 struct uio; 213 struct sockbuf; 214 215 struct pru_attach_info { 216 struct rlimit *sb_rlimit; 217 struct ucred *p_ucred; 218 struct vnode *fd_rdir; 219 }; 220 221 /* 222 * These are netmsg'd requests almost universally in the context of the 223 * appropriate protocol thread. Exceptions: 224 * 225 * pru_sosend() - called synchronously from user context, typically 226 * runs generic kernel code and then messages via 227 * pru_send(). 228 * 229 * pru_soreceive() - called synchronously from user context. Typically 230 * runs generic kernel code and remains synchronous. 231 * 232 * pru_preconnect() - called synchronously from user context. Typically 233 * prepares for later asynchronous pru_connect, e.g. 234 * sets ISCONNECTING. Non-NULL means asynchronous 235 * pru_connect is supported. 236 */ 237 struct pr_usrreqs { 238 void (*pru_abort) (netmsg_t msg); 239 void (*pru_accept) (netmsg_t msg); 240 void (*pru_attach) (netmsg_t msg); 241 void (*pru_bind) (netmsg_t msg); 242 void (*pru_connect) (netmsg_t msg); 243 void (*pru_connect2) (netmsg_t msg); 244 void (*pru_control) (netmsg_t msg); 245 void (*pru_detach) (netmsg_t msg); 246 void (*pru_disconnect) (netmsg_t msg); 247 void (*pru_listen) (netmsg_t msg); 248 void (*pru_peeraddr) (netmsg_t msg); 249 void (*pru_rcvd) (netmsg_t msg); 250 void (*pru_rcvoob) (netmsg_t msg); 251 void (*pru_send) (netmsg_t msg); 252 void (*pru_sense) (netmsg_t msg); 253 void (*pru_shutdown) (netmsg_t msg); 254 void (*pru_sockaddr) (netmsg_t msg); 255 256 /* 257 * These are direct calls. Note that sosend() will sometimes 258 * be converted into an implied connect (pru_connect) with the 259 * mbufs and flags forwarded in pru_connect's netmsg. It is 260 * otherwise typically converted to a send (pru_send). 261 * 262 * soreceive() typically remains synchronous in the user's context. 263 * 264 * Any converted calls are netmsg's to the socket's protocol thread. 265 */ 266 int (*pru_sosend) (struct socket *so, struct sockaddr *addr, 267 struct uio *uio, struct mbuf *top, 268 struct mbuf *control, int flags, 269 struct thread *td); 270 int (*pru_soreceive) (struct socket *so, 271 struct sockaddr **paddr, 272 struct uio *uio, 273 struct sockbuf *sio, 274 struct mbuf **controlp, int *flagsp); 275 276 /* 277 * Synchronously called by protocol thread. Typically save the 278 * foreign address into socket.so_faddr. 279 */ 280 void (*pru_savefaddr) (struct socket *so, 281 const struct sockaddr *addr); 282 283 /* synchronously called by user thread. */ 284 int (*pru_preconnect) (struct socket *so, 285 const struct sockaddr *addr, 286 struct thread *td); 287 }; 288 289 typedef int (*pru_sosend_fn_t) (struct socket *so, struct sockaddr *addr, 290 struct uio *uio, struct mbuf *top, 291 struct mbuf *control, int flags, 292 struct thread *td); 293 typedef int (*pru_soreceive_fn_t) (struct socket *so, struct sockaddr **paddr, 294 struct uio *uio, 295 struct sockbuf *sio, 296 struct mbuf **controlp, 297 int *flagsp); 298 299 void pr_generic_notsupp(netmsg_t msg); 300 void pru_sense_null(netmsg_t msg); 301 302 int pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, 303 struct uio *uio, struct mbuf *top, 304 struct mbuf *control, int flags, 305 struct thread *td); 306 int pru_soreceive_notsupp(struct socket *so, 307 struct sockaddr **paddr, 308 struct uio *uio, 309 struct sockbuf *sio, 310 struct mbuf **controlp, int *flagsp); 311 312 struct lwkt_port *cpu0_soport(struct socket *, struct sockaddr *, 313 struct mbuf **); 314 struct lwkt_port *cpu0_ctlport(int, struct sockaddr *, void *); 315 316 #endif /* _KERNEL || _KERNEL_STRUCTURES */ 317 318 /* 319 * The arguments to the ctlinput routine are 320 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 321 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 322 * and arg is a `void *' argument used within a protocol family. 323 */ 324 #define PRC_IFDOWN 0 /* interface transition */ 325 #define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 326 #define PRC_IFUP 2 /* interface has come back up */ 327 #define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 328 #define PRC_QUENCH 4 /* some one said to slow down */ 329 #define PRC_MSGSIZE 5 /* message size forced drop */ 330 #define PRC_HOSTDEAD 6 /* host appears to be down */ 331 #define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 332 #define PRC_UNREACH_NET 8 /* no route to network */ 333 #define PRC_UNREACH_HOST 9 /* no route to host */ 334 #define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 335 #define PRC_UNREACH_PORT 11 /* bad port # */ 336 /* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 337 #define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 338 #define PRC_REDIRECT_NET 14 /* net routing redirect */ 339 #define PRC_REDIRECT_HOST 15 /* host routing redirect */ 340 #define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 341 #define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 342 #define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 343 #define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 344 #define PRC_PARAMPROB 20 /* header incorrect */ 345 #define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ 346 347 #define PRC_NCMDS 22 348 349 #define PRC_IS_REDIRECT(cmd) \ 350 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 351 352 #ifdef PRCREQUESTS 353 const char *prcrequests[] = { 354 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 355 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 356 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 357 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 358 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 359 "PARAMPROB", "ADMIN-UNREACH" 360 }; 361 #endif 362 363 /* 364 * The arguments to ctloutput are: 365 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 366 * req is one of the actions listed below, so is a (struct socket *), 367 * level is an indication of which protocol layer the option is intended. 368 * optname is a protocol dependent socket option request, 369 * optval is a pointer to a mbuf-chain pointer, for value-return results. 370 * The protocol is responsible for disposal of the mbuf chain *optval 371 * if supplied, 372 * the caller is responsible for any space held by *optval, when returned. 373 * A non-zero return from usrreq gives an 374 * UNIX error number which should be passed to higher level software. 375 */ 376 #define PRCO_GETOPT 0 377 #define PRCO_SETOPT 1 378 379 #define PRCO_NCMDS 2 380 381 #ifdef PRCOREQUESTS 382 const char *prcorequests[] = { 383 "GETOPT", "SETOPT", 384 }; 385 #endif 386 387 /* 388 * Kernel prototypes 389 */ 390 #ifdef _KERNEL 391 392 void kpfctlinput (int, struct sockaddr *); 393 void kpfctlinput2 (int, struct sockaddr *, void *); 394 struct protosw *pffindproto (int family, int protocol, int type); 395 struct protosw *pffindtype (int family, int type); 396 397 #define PR_GET_MPLOCK(_pr) \ 398 do { \ 399 if (((_pr)->pr_flags & PR_MPSAFE) == 0) \ 400 get_mplock(); \ 401 } while (0) 402 403 #define PR_REL_MPLOCK(_pr) \ 404 do { \ 405 if (((_pr)->pr_flags & PR_MPSAFE) == 0) \ 406 rel_mplock(); \ 407 } while (0) 408 409 #endif /* _KERNEL */ 410 411 #endif /* _SYS_PROTOSW_H_ */ 412