protosw.h revision 50477
1315051Sbapt/*- 2315051Sbapt * Copyright (c) 1982, 1986, 1993 3315051Sbapt * The Regents of the University of California. All rights reserved. 4315051Sbapt * 5315051Sbapt * Redistribution and use in source and binary forms, with or without 6315051Sbapt * modification, are permitted provided that the following conditions 7315051Sbapt * are met: 8315051Sbapt * 1. Redistributions of source code must retain the above copyright 9315051Sbapt * notice, this list of conditions and the following disclaimer. 10315051Sbapt * 2. Redistributions in binary form must reproduce the above copyright 11315051Sbapt * notice, this list of conditions and the following disclaimer in the 12315051Sbapt * documentation and/or other materials provided with the distribution. 13315051Sbapt * 3. All advertising materials mentioning features or use of this software 14315051Sbapt * must display the following acknowledgement: 15315051Sbapt * This product includes software developed by the University of 16315051Sbapt * California, Berkeley and its contributors. 17315051Sbapt * 4. Neither the name of the University nor the names of its contributors 18315051Sbapt * may be used to endorse or promote products derived from this software 19315051Sbapt * without specific prior written permission. 20315051Sbapt * 21315051Sbapt * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22315051Sbapt * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23315051Sbapt * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24315051Sbapt * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25315051Sbapt * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26315051Sbapt * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27315051Sbapt * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28315051Sbapt * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29315051Sbapt * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30315051Sbapt * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31315051Sbapt * SUCH DAMAGE. 32315051Sbapt * 33315051Sbapt * @(#)protosw.h 8.1 (Berkeley) 6/2/93 34315051Sbapt * $FreeBSD: head/sys/sys/protosw.h 50477 1999-08-28 01:08:13Z peter $ 35315051Sbapt */ 36315051Sbapt 37315051Sbapt#ifndef _SYS_PROTOSW_H_ 38315051Sbapt#define _SYS_PROTOSW_H_ 39315051Sbapt 40315051Sbapt/* Forward declare these structures referenced from prototypes below. */ 41315051Sbaptstruct mbuf; 42315051Sbaptstruct proc; 43315051Sbaptstruct sockaddr; 44315051Sbaptstruct socket; 45315051Sbaptstruct sockopt; 46315051Sbapt 47315051Sbapt/*#ifdef KERNEL*/ 48315051Sbapt/* 49315051Sbapt * Protocol switch table. 50315051Sbapt * 51315051Sbapt * Each protocol has a handle initializing one of these structures, 52315051Sbapt * which is used for protocol-protocol and system-protocol communication. 53315051Sbapt * 54315051Sbapt * A protocol is called through the pr_init entry before any other. 55315051Sbapt * Thereafter it is called every 200ms through the pr_fasttimo entry and 56331465Sian * every 500ms through the pr_slowtimo for timer based actions. 57331465Sian * The system will call the pr_drain entry if it is low on space and 58315051Sbapt * this should throw away any non-critical data. 59315051Sbapt * 60315051Sbapt * Protocols pass data between themselves as chains of mbufs using 61315051Sbapt * the pr_input and pr_output hooks. Pr_input passes data up (towards 62315051Sbapt * the users) and pr_output passes it down (towards the interfaces); control 63315051Sbapt * information passes up and down on pr_ctlinput and pr_ctloutput. 64315051Sbapt * The protocol is responsible for the space occupied by any the 65315051Sbapt * arguments to these entries and must dispose it. 66315051Sbapt * 67315051Sbapt * In retrospect, it would be a lot nicer to use an interface 68315051Sbapt * similar to the vnode VOP interface. 69315051Sbapt */ 70315051Sbaptstruct protosw { 71315051Sbapt short pr_type; /* socket type used for */ 72315051Sbapt struct domain *pr_domain; /* domain protocol a member of */ 73315051Sbapt short pr_protocol; /* protocol number */ 74315051Sbapt short pr_flags; /* see below */ 75315051Sbapt/* protocol-protocol hooks */ 76315051Sbapt void (*pr_input) __P((struct mbuf *, int len)); 77315051Sbapt /* input to protocol (from below) */ 78315051Sbapt int (*pr_output) __P((struct mbuf *m, struct socket *so)); 79315051Sbapt /* output to protocol (from above) */ 80315051Sbapt void (*pr_ctlinput)__P((int, struct sockaddr *, void *)); 81315051Sbapt /* control input (from below) */ 82315051Sbapt int (*pr_ctloutput)__P((struct socket *, struct sockopt *)); 83315051Sbapt /* control output (from above) */ 84315051Sbapt/* user-protocol hook */ 85315051Sbapt void *pr_ousrreq; 86315051Sbapt/* utility hooks */ 87315051Sbapt void (*pr_init) __P((void)); /* initialization hook */ 88315051Sbapt void (*pr_fasttimo) __P((void)); 89315051Sbapt /* fast timeout (200ms) */ 90315051Sbapt void (*pr_slowtimo) __P((void)); 91315051Sbapt /* slow timeout (500ms) */ 92315051Sbapt void (*pr_drain) __P((void)); 93315051Sbapt /* flush any excess space possible */ 94315051Sbapt struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 95315051Sbapt}; 96315051Sbapt/*#endif*/ 97315051Sbapt 98315051Sbapt#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 99315051Sbapt#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 100315051Sbapt 101315051Sbapt/* 102315051Sbapt * Values for pr_flags. 103315051Sbapt * PR_ADDR requires PR_ATOMIC; 104315051Sbapt * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 105315051Sbapt * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 106315051Sbapt * and the protocol understands the MSG_EOF flag. The first property is 107315051Sbapt * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 108315051Sbapt * anyhow). 109315051Sbapt */ 110315051Sbapt#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 111315051Sbapt#define PR_ADDR 0x02 /* addresses given with messages */ 112315051Sbapt#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 113315051Sbapt#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 114315051Sbapt#define PR_RIGHTS 0x10 /* passes capabilities */ 115315051Sbapt#define PR_IMPLOPCL 0x20 /* implied open/close */ 116315051Sbapt 117315051Sbapt/* 118315051Sbapt * The arguments to usrreq are: 119315051Sbapt * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 120315051Sbapt * where up is a (struct socket *), req is one of these requests, 121315051Sbapt * m is a optional mbuf chain containing a message, 122315051Sbapt * nam is an optional mbuf chain containing an address, 123315051Sbapt * and opt is a pointer to a socketopt structure or nil. 124315051Sbapt * The protocol is responsible for disposal of the mbuf chain m, 125315051Sbapt * the caller is responsible for any space held by nam and opt. 126315051Sbapt * A non-zero return from usrreq gives an 127315051Sbapt * UNIX error number which should be passed to higher level software. 128315051Sbapt */ 129315051Sbapt#define PRU_ATTACH 0 /* attach protocol to up */ 130315051Sbapt#define PRU_DETACH 1 /* detach protocol from up */ 131315051Sbapt#define PRU_BIND 2 /* bind socket to address */ 132315051Sbapt#define PRU_LISTEN 3 /* listen for connection */ 133315051Sbapt#define PRU_CONNECT 4 /* establish connection to peer */ 134315051Sbapt#define PRU_ACCEPT 5 /* accept connection from peer */ 135315051Sbapt#define PRU_DISCONNECT 6 /* disconnect from peer */ 136315051Sbapt#define PRU_SHUTDOWN 7 /* won't send any more data */ 137331465Sian#define PRU_RCVD 8 /* have taken data; more room now */ 138315051Sbapt#define PRU_SEND 9 /* send this data */ 139331465Sian#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 140331465Sian#define PRU_CONTROL 11 /* control operations on protocol */ 141315051Sbapt#define PRU_SENSE 12 /* return status into m */ 142315051Sbapt#define PRU_RCVOOB 13 /* retrieve out of band data */ 143315051Sbapt#define PRU_SENDOOB 14 /* send out of band data */ 144315051Sbapt#define PRU_SOCKADDR 15 /* fetch socket's address */ 145315051Sbapt#define PRU_PEERADDR 16 /* fetch peer's address */ 146315051Sbapt#define PRU_CONNECT2 17 /* connect two sockets */ 147331465Sian/* begin for protocols internal use */ 148315051Sbapt#define PRU_FASTTIMO 18 /* 200ms timeout */ 149331465Sian#define PRU_SLOWTIMO 19 /* 500ms timeout */ 150331465Sian#define PRU_PROTORCV 20 /* receive from below */ 151315051Sbapt#define PRU_PROTOSEND 21 /* send to below */ 152315051Sbapt/* end for protocol's internal use */ 153315051Sbapt#define PRU_SEND_EOF 22 /* send and close */ 154315051Sbapt#define PRU_NREQ 22 155315051Sbapt 156315051Sbapt#ifdef PRUREQUESTS 157315051Sbaptchar *prurequests[] = { 158315051Sbapt "ATTACH", "DETACH", "BIND", "LISTEN", 159315051Sbapt "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 160315051Sbapt "RCVD", "SEND", "ABORT", "CONTROL", 161315051Sbapt "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 162315051Sbapt "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 163315051Sbapt "PROTORCV", "PROTOSEND", 164315051Sbapt "SEND_EOF", 165315051Sbapt}; 166315051Sbapt#endif 167315051Sbapt 168315051Sbapt#ifdef KERNEL /* users shouldn't see this decl */ 169315051Sbapt 170315051Sbaptstruct ifnet; 171315051Sbaptstruct stat; 172315051Sbaptstruct ucred; 173315051Sbaptstruct uio; 174315051Sbapt 175315051Sbapt/* 176315051Sbapt * If the ordering here looks odd, that's because it's alphabetical. 177315051Sbapt * Having this structure separated out from the main protoswitch is allegedly 178315051Sbapt * a big (12 cycles per call) lose on high-end CPUs. We will eventually 179315051Sbapt * migrate this stuff back into the main structure. 180315051Sbapt */ 181315051Sbaptstruct pr_usrreqs { 182315051Sbapt int (*pru_abort) __P((struct socket *so)); 183315051Sbapt int (*pru_accept) __P((struct socket *so, struct sockaddr **nam)); 184315051Sbapt int (*pru_attach) __P((struct socket *so, int proto, 185315051Sbapt struct proc *p)); 186315051Sbapt int (*pru_bind) __P((struct socket *so, struct sockaddr *nam, 187315051Sbapt struct proc *p)); 188315051Sbapt int (*pru_connect) __P((struct socket *so, struct sockaddr *nam, 189315051Sbapt struct proc *p)); 190315051Sbapt int (*pru_connect2) __P((struct socket *so1, struct socket *so2)); 191315051Sbapt int (*pru_control) __P((struct socket *so, u_long cmd, caddr_t data, 192315051Sbapt struct ifnet *ifp, struct proc *p)); 193315051Sbapt int (*pru_detach) __P((struct socket *so)); 194315051Sbapt int (*pru_disconnect) __P((struct socket *so)); 195315051Sbapt int (*pru_listen) __P((struct socket *so, struct proc *p)); 196315051Sbapt int (*pru_peeraddr) __P((struct socket *so, 197315051Sbapt struct sockaddr **nam)); 198315051Sbapt int (*pru_rcvd) __P((struct socket *so, int flags)); 199315051Sbapt int (*pru_rcvoob) __P((struct socket *so, struct mbuf *m, 200315051Sbapt int flags)); 201315051Sbapt int (*pru_send) __P((struct socket *so, int flags, struct mbuf *m, 202315051Sbapt struct sockaddr *addr, struct mbuf *control, 203315051Sbapt struct proc *p)); 204315051Sbapt#define PRUS_OOB 0x1 205315051Sbapt#define PRUS_EOF 0x2 206315051Sbapt#define PRUS_MORETOCOME 0x4 207315051Sbapt int (*pru_sense) __P((struct socket *so, struct stat *sb)); 208315051Sbapt int (*pru_shutdown) __P((struct socket *so)); 209315051Sbapt int (*pru_sockaddr) __P((struct socket *so, 210315051Sbapt struct sockaddr **nam)); 211315051Sbapt 212315051Sbapt /* 213315051Sbapt * These three added later, so they are out of order. They are used 214315051Sbapt * for shortcutting (fast path input/output) in some protocols. 215315051Sbapt * XXX - that's a lie, they are not implemented yet 216315051Sbapt * Rather than calling sosend() etc. directly, calls are made 217315051Sbapt * through these entry points. For protocols which still use 218315051Sbapt * the generic code, these just point to those routines. 219315051Sbapt */ 220315051Sbapt int (*pru_sosend) __P((struct socket *so, struct sockaddr *addr, 221315051Sbapt struct uio *uio, struct mbuf *top, 222315051Sbapt struct mbuf *control, int flags, 223315051Sbapt struct proc *p)); 224315051Sbapt int (*pru_soreceive) __P((struct socket *so, 225315051Sbapt struct sockaddr **paddr, 226315051Sbapt struct uio *uio, struct mbuf **mp0, 227315051Sbapt struct mbuf **controlp, int *flagsp)); 228315051Sbapt int (*pru_sopoll) __P((struct socket *so, int events, 229315051Sbapt struct ucred *cred, struct proc *p)); 230315051Sbapt}; 231315051Sbapt 232315051Sbaptint pru_accept_notsupp __P((struct socket *so, struct sockaddr **nam)); 233315051Sbaptint pru_connect_notsupp __P((struct socket *so, struct sockaddr *nam, 234315051Sbapt struct proc *p)); 235315051Sbaptint pru_connect2_notsupp __P((struct socket *so1, struct socket *so2)); 236315051Sbaptint pru_control_notsupp __P((struct socket *so, u_long cmd, caddr_t data, 237315051Sbapt struct ifnet *ifp, struct proc *p)); 238315051Sbaptint pru_listen_notsupp __P((struct socket *so, struct proc *p)); 239315051Sbaptint pru_rcvd_notsupp __P((struct socket *so, int flags)); 240int pru_rcvoob_notsupp __P((struct socket *so, struct mbuf *m, int flags)); 241int pru_sense_null __P((struct socket *so, struct stat *sb)); 242 243#endif /* KERNEL */ 244 245/* 246 * The arguments to the ctlinput routine are 247 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 248 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 249 * and arg is a `void *' argument used within a protocol family. 250 */ 251#define PRC_IFDOWN 0 /* interface transition */ 252#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 253#define PRC_IFUP 2 /* interface has come back up */ 254#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 255#define PRC_QUENCH 4 /* some one said to slow down */ 256#define PRC_MSGSIZE 5 /* message size forced drop */ 257#define PRC_HOSTDEAD 6 /* host appears to be down */ 258#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 259#define PRC_UNREACH_NET 8 /* no route to network */ 260#define PRC_UNREACH_HOST 9 /* no route to host */ 261#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 262#define PRC_UNREACH_PORT 11 /* bad port # */ 263/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 264#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 265#define PRC_REDIRECT_NET 14 /* net routing redirect */ 266#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 267#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 268#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 269#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 270#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 271#define PRC_PARAMPROB 20 /* header incorrect */ 272 273#define PRC_NCMDS 21 274 275#define PRC_IS_REDIRECT(cmd) \ 276 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 277 278#ifdef PRCREQUESTS 279char *prcrequests[] = { 280 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 281 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 282 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 283 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 284 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 285 "PARAMPROB" 286}; 287#endif 288 289/* 290 * The arguments to ctloutput are: 291 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 292 * req is one of the actions listed below, so is a (struct socket *), 293 * level is an indication of which protocol layer the option is intended. 294 * optname is a protocol dependent socket option request, 295 * optval is a pointer to a mbuf-chain pointer, for value-return results. 296 * The protocol is responsible for disposal of the mbuf chain *optval 297 * if supplied, 298 * the caller is responsible for any space held by *optval, when returned. 299 * A non-zero return from usrreq gives an 300 * UNIX error number which should be passed to higher level software. 301 */ 302#define PRCO_GETOPT 0 303#define PRCO_SETOPT 1 304 305#define PRCO_NCMDS 2 306 307#ifdef PRCOREQUESTS 308char *prcorequests[] = { 309 "GETOPT", "SETOPT", 310}; 311#endif 312 313#ifdef KERNEL 314void pfctlinput __P((int, struct sockaddr *)); 315struct protosw *pffindproto __P((int family, int protocol, int type)); 316struct protosw *pffindtype __P((int family, int type)); 317#endif 318 319#endif 320