protosw.h revision 42902
1139825Simp/*- 21541Srgrimes * Copyright (c) 1982, 1986, 1993 31541Srgrimes * The Regents of the University of California. All rights reserved. 41541Srgrimes * 51541Srgrimes * Redistribution and use in source and binary forms, with or without 61541Srgrimes * modification, are permitted provided that the following conditions 71541Srgrimes * are met: 81541Srgrimes * 1. Redistributions of source code must retain the above copyright 91541Srgrimes * notice, this list of conditions and the following disclaimer. 101541Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111541Srgrimes * notice, this list of conditions and the following disclaimer in the 121541Srgrimes * documentation and/or other materials provided with the distribution. 131541Srgrimes * 3. All advertising materials mentioning features or use of this software 141541Srgrimes * must display the following acknowledgement: 151541Srgrimes * This product includes software developed by the University of 161541Srgrimes * California, Berkeley and its contributors. 171541Srgrimes * 4. Neither the name of the University nor the names of its contributors 181541Srgrimes * may be used to endorse or promote products derived from this software 191541Srgrimes * without specific prior written permission. 201541Srgrimes * 211541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2914488Shsu * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 3050477Speter * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311541Srgrimes * SUCH DAMAGE. 321541Srgrimes * 331541Srgrimes * @(#)protosw.h 8.1 (Berkeley) 6/2/93 341541Srgrimes * $Id: protosw.h,v 1.25 1998/08/23 03:07:17 wollman Exp $ 351541Srgrimes */ 361541Srgrimes 371541Srgrimes#ifndef _SYS_PROTOSW_H_ 3843429Sphk#define _SYS_PROTOSW_H_ 3943429Sphk 4093593Sjhb/* Forward declare these structures referenced from prototypes below. */ 411541Srgrimesstruct mbuf; 42102538Salfredstruct proc; 431541Srgrimesstruct sockaddr; 4499092Sbdestruct socket; 4584827Sjhbstruct sockopt; 4699092Sbde 4799092Sbde/*#ifdef KERNEL*/ 4899092Sbde/* 4999092Sbde * Protocol switch table. 5099092Sbde * 5199092Sbde * Each protocol has a handle initializing one of these structures, 52147641Sdelphij * which is used for protocol-protocol and system-protocol communication. 5390757Sjulian * 5490757Sjulian * A protocol is called through the pr_init entry before any other. 55112704Smaxim * Thereafter it is called every 200ms through the pr_fasttimo entry and 56100986Srwatson * every 500ms through the pr_slowtimo for timer based actions. 57122524Srwatson * The system will call the pr_drain entry if it is low on space and 5894020Sdd * this should throw away any non-critical data. 591541Srgrimes * 6098745Sbde * Protocols pass data between themselves as chains of mbufs using 6198745Sbde * the pr_input and pr_output hooks. Pr_input passes data up (towards 62102538Salfred * the users) and pr_output passes it down (towards the interfaces); control 631541Srgrimes * information passes up and down on pr_ctlinput and pr_ctloutput. 6472650Sgreen * The protocol is responsible for the space occupied by any the 6594020Sdd * arguments to these entries and must dispose it. 6672650Sgreen * 6772650Sgreen * In retrospect, it would be a lot nicer to use an interface 6891354Sdd * similar to the vnode VOP interface. 6972650Sgreen */ 7072650Sgreenstruct protosw { 7172650Sgreen short pr_type; /* socket type used for */ 7272650Sgreen struct domain *pr_domain; /* domain protocol a member of */ 7372650Sgreen short pr_protocol; /* protocol number */ 7491354Sdd short pr_flags; /* see below */ 7572650Sgreen/* protocol-protocol hooks */ 7694020Sdd void (*pr_input) __P((struct mbuf *, int len)); 7798745Sbde /* input to protocol (from below) */ 7894020Sdd int (*pr_output) __P((struct mbuf *m, struct socket *so)); 7955205Speter /* output to protocol (from above) */ 8094020Sdd void (*pr_ctlinput)__P((int, struct sockaddr *, void *)); 813438Sphk /* control input (from below) */ 8298745Sbde int (*pr_ctloutput)__P((struct socket *, struct sockopt *)); 8398745Sbde /* control output (from above) */ 8498745Sbde/* user-protocol hook */ 8598745Sbde void *pr_ousrreq; 8698745Sbde/* utility hooks */ 8798745Sbde void (*pr_init) __P((void)); /* initialization hook */ 8898745Sbde void (*pr_fasttimo) __P((void)); 8990757Sjulian /* fast timeout (200ms) */ 9098745Sbde void (*pr_slowtimo) __P((void)); 9198745Sbde /* slow timeout (500ms) */ 9290757Sjulian void (*pr_drain) __P((void)); 9390757Sjulian /* flush any excess space possible */ 9498745Sbde struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 9598745Sbde}; 9698745Sbde/*#endif*/ 9755205Speter 981541Srgrimes#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 991541Srgrimes#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 100 101/* 102 * Values for pr_flags. 103 * PR_ADDR requires PR_ATOMIC; 104 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 105 * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 106 * and the protocol understands the MSG_EOF flag. The first property is 107 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 108 * anyhow). 109 */ 110#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 111#define PR_ADDR 0x02 /* addresses given with messages */ 112#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 113#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 114#define PR_RIGHTS 0x10 /* passes capabilities */ 115#define PR_IMPLOPCL 0x20 /* implied open/close */ 116 117/* 118 * The arguments to usrreq are: 119 * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 120 * where up is a (struct socket *), req is one of these requests, 121 * m is a optional mbuf chain containing a message, 122 * nam is an optional mbuf chain containing an address, 123 * and opt is a pointer to a socketopt structure or nil. 124 * The protocol is responsible for disposal of the mbuf chain m, 125 * the caller is responsible for any space held by nam and opt. 126 * A non-zero return from usrreq gives an 127 * UNIX error number which should be passed to higher level software. 128 */ 129#define PRU_ATTACH 0 /* attach protocol to up */ 130#define PRU_DETACH 1 /* detach protocol from up */ 131#define PRU_BIND 2 /* bind socket to address */ 132#define PRU_LISTEN 3 /* listen for connection */ 133#define PRU_CONNECT 4 /* establish connection to peer */ 134#define PRU_ACCEPT 5 /* accept connection from peer */ 135#define PRU_DISCONNECT 6 /* disconnect from peer */ 136#define PRU_SHUTDOWN 7 /* won't send any more data */ 137#define PRU_RCVD 8 /* have taken data; more room now */ 138#define PRU_SEND 9 /* send this data */ 139#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 140#define PRU_CONTROL 11 /* control operations on protocol */ 141#define PRU_SENSE 12 /* return status into m */ 142#define PRU_RCVOOB 13 /* retrieve out of band data */ 143#define PRU_SENDOOB 14 /* send out of band data */ 144#define PRU_SOCKADDR 15 /* fetch socket's address */ 145#define PRU_PEERADDR 16 /* fetch peer's address */ 146#define PRU_CONNECT2 17 /* connect two sockets */ 147/* begin for protocols internal use */ 148#define PRU_FASTTIMO 18 /* 200ms timeout */ 149#define PRU_SLOWTIMO 19 /* 500ms timeout */ 150#define PRU_PROTORCV 20 /* receive from below */ 151#define PRU_PROTOSEND 21 /* send to below */ 152/* end for protocol's internal use */ 153#define PRU_SEND_EOF 22 /* send and close */ 154#define PRU_NREQ 22 155 156#ifdef PRUREQUESTS 157char *prurequests[] = { 158 "ATTACH", "DETACH", "BIND", "LISTEN", 159 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 160 "RCVD", "SEND", "ABORT", "CONTROL", 161 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 162 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 163 "PROTORCV", "PROTOSEND", 164 "SEND_EOF", 165}; 166#endif 167 168#ifdef KERNEL /* users shouldn't see this decl */ 169 170struct ifnet; 171struct stat; 172struct ucred; 173struct uio; 174 175/* 176 * If the ordering here looks odd, that's because it's alphabetical. 177 * Having this structure separated out from the main protoswitch is allegedly 178 * a big (12 cycles per call) lose on high-end CPUs. We will eventually 179 * migrate this stuff back into the main structure. 180 */ 181struct pr_usrreqs { 182 int (*pru_abort) __P((struct socket *so)); 183 int (*pru_accept) __P((struct socket *so, struct sockaddr **nam)); 184 int (*pru_attach) __P((struct socket *so, int proto, 185 struct proc *p)); 186 int (*pru_bind) __P((struct socket *so, struct sockaddr *nam, 187 struct proc *p)); 188 int (*pru_connect) __P((struct socket *so, struct sockaddr *nam, 189 struct proc *p)); 190 int (*pru_connect2) __P((struct socket *so1, struct socket *so2)); 191 int (*pru_control) __P((struct socket *so, u_long cmd, caddr_t data, 192 struct ifnet *ifp, struct proc *p)); 193 int (*pru_detach) __P((struct socket *so)); 194 int (*pru_disconnect) __P((struct socket *so)); 195 int (*pru_listen) __P((struct socket *so, struct proc *p)); 196 int (*pru_peeraddr) __P((struct socket *so, 197 struct sockaddr **nam)); 198 int (*pru_rcvd) __P((struct socket *so, int flags)); 199 int (*pru_rcvoob) __P((struct socket *so, struct mbuf *m, 200 int flags)); 201 int (*pru_send) __P((struct socket *so, int flags, struct mbuf *m, 202 struct sockaddr *addr, struct mbuf *control, 203 struct proc *p)); 204#define PRUS_OOB 0x1 205#define PRUS_EOF 0x2 206#define PRUS_MORETOCOME 0x4 207 int (*pru_sense) __P((struct socket *so, struct stat *sb)); 208 int (*pru_shutdown) __P((struct socket *so)); 209 int (*pru_sockaddr) __P((struct socket *so, 210 struct sockaddr **nam)); 211 212 /* 213 * These three added later, so they are out of order. They are used 214 * for shortcutting (fast path input/output) in some protocols. 215 * XXX - that's a lie, they are not implemented yet 216 * Rather than calling sosend() etc. directly, calls are made 217 * through these entry points. For protocols which still use 218 * the generic code, these just point to those routines. 219 */ 220 int (*pru_sosend) __P((struct socket *so, struct sockaddr *addr, 221 struct uio *uio, struct mbuf *top, 222 struct mbuf *control, int flags, 223 struct proc *p)); 224 int (*pru_soreceive) __P((struct socket *so, 225 struct sockaddr **paddr, 226 struct uio *uio, struct mbuf **mp0, 227 struct mbuf **controlp, int *flagsp)); 228 int (*pru_sopoll) __P((struct socket *so, int events, 229 struct ucred *cred, struct proc *p)); 230}; 231 232int pru_accept_notsupp __P((struct socket *so, struct sockaddr **nam)); 233int pru_connect_notsupp __P((struct socket *so, struct sockaddr *nam, 234 struct proc *p)); 235int pru_connect2_notsupp __P((struct socket *so1, struct socket *so2)); 236int pru_control_notsupp __P((struct socket *so, u_long cmd, caddr_t data, 237 struct ifnet *ifp, struct proc *p)); 238int pru_listen_notsupp __P((struct socket *so, struct proc *p)); 239int 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