protosw.h revision 22614
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: head/sys/sys/protosw.h 22614 1997-02-12 18:54:32Z wollman $ 35 */ 36 37#ifndef _SYS_PROTOSW_H_ 38#define _SYS_PROTOSW_H_ 39 40struct mbuf; 41struct sockaddr; 42struct socket; 43struct sockproto; 44 45/* 46 * Protocol switch table. 47 * 48 * Each protocol has a handle initializing one of these structures, 49 * which is used for protocol-protocol and system-protocol communication. 50 * 51 * A protocol is called through the pr_init entry before any other. 52 * Thereafter it is called every 200ms through the pr_fasttimo entry and 53 * every 500ms through the pr_slowtimo for timer based actions. 54 * The system will call the pr_drain entry if it is low on space and 55 * this should throw away any non-critical data. 56 * 57 * Protocols pass data between themselves as chains of mbufs using 58 * the pr_input and pr_output hooks. Pr_input passes data up (towards 59 * UNIX) and pr_output passes it down (towards the imps); control 60 * information passes up and down on pr_ctlinput and pr_ctloutput. 61 * The protocol is responsible for the space occupied by any the 62 * arguments to these entries and must dispose it. 63 * 64 * The userreq routine interfaces protocols to the system and is 65 * described below. 66 */ 67struct protosw { 68 short pr_type; /* socket type used for */ 69 struct domain *pr_domain; /* domain protocol a member of */ 70 short pr_protocol; /* protocol number */ 71 short pr_flags; /* see below */ 72/* protocol-protocol hooks */ 73 void (*pr_input) __P((struct mbuf *, int len)); 74 /* input to protocol (from below) */ 75 int (*pr_output) __P((struct mbuf *m, struct socket *so)); 76 /* output to protocol (from above) */ 77 void (*pr_ctlinput)__P((int, struct sockaddr *, void *)); 78 /* control input (from below) */ 79 int (*pr_ctloutput)__P((int, struct socket *, int, int, 80 struct mbuf **)); 81 /* control output (from above) */ 82/* user-protocol hook */ 83 int (*pr_ousrreq) __P((struct socket *, int, struct mbuf *, 84 struct mbuf *, struct mbuf *)); 85 /* user request: see list below */ 86/* utility hooks */ 87 void (*pr_init) __P((void)); /* initialization hook */ 88 void (*pr_fasttimo) __P((void)); 89 /* fast timeout (200ms) */ 90 void (*pr_slowtimo) __P((void)); 91 /* slow timeout (500ms) */ 92 void (*pr_drain) __P((void)); 93 /* flush any excess space possible */ 94 struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 95}; 96 97#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 98#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 99 100/* 101 * Values for pr_flags. 102 * PR_ADDR requires PR_ATOMIC; 103 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 104 * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 105 * and the protocol understands the MSG_EOF flag. The first property is 106 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 107 * anyhow). 108 */ 109#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 110#define PR_ADDR 0x02 /* addresses given with messages */ 111#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 112#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 113#define PR_RIGHTS 0x10 /* passes capabilities */ 114#define PR_IMPLOPCL 0x20 /* implied open/close */ 115 116/* 117 * The arguments to usrreq are: 118 * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 119 * where up is a (struct socket *), req is one of these requests, 120 * m is a optional mbuf chain containing a message, 121 * nam is an optional mbuf chain containing an address, 122 * and opt is a pointer to a socketopt structure or nil. 123 * The protocol is responsible for disposal of the mbuf chain m, 124 * the caller is responsible for any space held by nam and opt. 125 * A non-zero return from usrreq gives an 126 * UNIX error number which should be passed to higher level software. 127 */ 128#define PRU_ATTACH 0 /* attach protocol to up */ 129#define PRU_DETACH 1 /* detach protocol from up */ 130#define PRU_BIND 2 /* bind socket to address */ 131#define PRU_LISTEN 3 /* listen for connection */ 132#define PRU_CONNECT 4 /* establish connection to peer */ 133#define PRU_ACCEPT 5 /* accept connection from peer */ 134#define PRU_DISCONNECT 6 /* disconnect from peer */ 135#define PRU_SHUTDOWN 7 /* won't send any more data */ 136#define PRU_RCVD 8 /* have taken data; more room now */ 137#define PRU_SEND 9 /* send this data */ 138#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 139#define PRU_CONTROL 11 /* control operations on protocol */ 140#define PRU_SENSE 12 /* return status into m */ 141#define PRU_RCVOOB 13 /* retrieve out of band data */ 142#define PRU_SENDOOB 14 /* send out of band data */ 143#define PRU_SOCKADDR 15 /* fetch socket's address */ 144#define PRU_PEERADDR 16 /* fetch peer's address */ 145#define PRU_CONNECT2 17 /* connect two sockets */ 146/* begin for protocols internal use */ 147#define PRU_FASTTIMO 18 /* 200ms timeout */ 148#define PRU_SLOWTIMO 19 /* 500ms timeout */ 149#define PRU_PROTORCV 20 /* receive from below */ 150#define PRU_PROTOSEND 21 /* send to below */ 151/* end for protocol's internal use */ 152#define PRU_SEND_EOF 22 /* send and close */ 153#define PRU_NREQ 22 154 155#ifdef PRUREQUESTS 156char *prurequests[] = { 157 "ATTACH", "DETACH", "BIND", "LISTEN", 158 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 159 "RCVD", "SEND", "ABORT", "CONTROL", 160 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 161 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 162 "PROTORCV", "PROTOSEND", 163 "SEND_EOF", 164}; 165#endif 166 167#ifdef KERNEL /* users shouldn't see this decl */ 168struct stat; 169struct ifnet; 170 171/* 172 * If the ordering here looks odd, that's because it's alphabetical. 173 */ 174struct pr_usrreqs { 175 int (*pru_abort) __P((struct socket *so)); 176 int (*pru_accept) __P((struct socket *so, struct mbuf *nam)); 177 int (*pru_attach) __P((struct socket *so, int proto)); 178 int (*pru_bind) __P((struct socket *so, struct mbuf *nam)); 179 int (*pru_connect) __P((struct socket *so, struct mbuf *nam)); 180 int (*pru_connect2) __P((struct socket *so1, struct socket *so2)); 181 int (*pru_control) __P((struct socket *so, int cmd, caddr_t data, 182 struct ifnet *ifp)); 183 int (*pru_detach) __P((struct socket *so)); 184 int (*pru_disconnect) __P((struct socket *so)); 185 int (*pru_listen) __P((struct socket *so)); 186 int (*pru_peeraddr) __P((struct socket *so, struct mbuf *nam)); 187 int (*pru_rcvd) __P((struct socket *so, int flags)); 188 int (*pru_rcvoob) __P((struct socket *so, struct mbuf *m, 189 int flags)); 190 /* 191 * The `m' parameter here is almost certainly going to become a 192 * `struct uio' at some point in the future. Similar changes 193 * will probably happen for the receive entry points. 194 */ 195 int (*pru_send) __P((struct socket *so, int flags, struct mbuf *m, 196 struct mbuf *addr, struct mbuf *control)); 197#define PRUS_OOB 0x1 198#define PRUS_EOF 0x2 199 int (*pru_sense) __P((struct socket *so, struct stat *sb)); 200 int (*pru_shutdown) __P((struct socket *so)); 201 int (*pru_sockaddr) __P((struct socket *so, struct mbuf *nam)); 202}; 203 204int pru_connect2_notsupp __P((struct socket *so1, struct socket *so2)); 205 206#define PRU_OLDSTYLE 207 208#ifdef PRU_OLDSTYLE 209/* 210 * Protocols which don't yet implement pr_usrreqs can point it to this 211 * structure, which will call the old pr_usrreq() entry point with the 212 * appropriate arguments. 213 */ 214extern struct pr_usrreqs pru_oldstyle; 215#endif /* PRU_OLDSTYLE */ 216 217#endif /* KERNEL */ 218 219/* 220 * The arguments to the ctlinput routine are 221 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 222 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 223 * and arg is a `void *' argument used within a protocol family. 224 */ 225#define PRC_IFDOWN 0 /* interface transition */ 226#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 227#define PRC_IFUP 2 /* interface has come back up */ 228#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 229#define PRC_QUENCH 4 /* some one said to slow down */ 230#define PRC_MSGSIZE 5 /* message size forced drop */ 231#define PRC_HOSTDEAD 6 /* host appears to be down */ 232#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 233#define PRC_UNREACH_NET 8 /* no route to network */ 234#define PRC_UNREACH_HOST 9 /* no route to host */ 235#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 236#define PRC_UNREACH_PORT 11 /* bad port # */ 237/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 238#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 239#define PRC_REDIRECT_NET 14 /* net routing redirect */ 240#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 241#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 242#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 243#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 244#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 245#define PRC_PARAMPROB 20 /* header incorrect */ 246 247#define PRC_NCMDS 21 248 249#define PRC_IS_REDIRECT(cmd) \ 250 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 251 252#ifdef PRCREQUESTS 253char *prcrequests[] = { 254 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 255 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 256 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 257 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 258 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 259 "PARAMPROB" 260}; 261#endif 262 263/* 264 * The arguments to ctloutput are: 265 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval); 266 * req is one of the actions listed below, so is a (struct socket *), 267 * level is an indication of which protocol layer the option is intended. 268 * optname is a protocol dependent socket option request, 269 * optval is a pointer to a mbuf-chain pointer, for value-return results. 270 * The protocol is responsible for disposal of the mbuf chain *optval 271 * if supplied, 272 * the caller is responsible for any space held by *optval, when returned. 273 * A non-zero return from usrreq gives an 274 * UNIX error number which should be passed to higher level software. 275 */ 276#define PRCO_GETOPT 0 277#define PRCO_SETOPT 1 278 279#define PRCO_NCMDS 2 280 281#ifdef PRCOREQUESTS 282char *prcorequests[] = { 283 "GETOPT", "SETOPT", 284}; 285#endif 286 287#ifdef KERNEL 288struct protosw *pffindproto __P((int family, int protocol, int type)); 289struct protosw *pffindtype __P((int family, int type)); 290#endif 291 292#endif 293