protosw.h revision 12881
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 * $Id: protosw.h,v 1.8 1995/11/21 12:55:13 bde Exp $ 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_usrreq) __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}; 95 96#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 97#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 98 99/* 100 * Values for pr_flags. 101 * PR_ADDR requires PR_ATOMIC; 102 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 103 * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 104 * and the protocol understands the MSG_EOF flag. The first property is 105 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 106 * anyhow). 107 */ 108#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 109#define PR_ADDR 0x02 /* addresses given with messages */ 110#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 111#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 112#define PR_RIGHTS 0x10 /* passes capabilities */ 113#define PR_IMPLOPCL 0x20 /* implied open/close */ 114 115/* 116 * The arguments to usrreq are: 117 * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 118 * where up is a (struct socket *), req is one of these requests, 119 * m is a optional mbuf chain containing a message, 120 * nam is an optional mbuf chain containing an address, 121 * and opt is a pointer to a socketopt structure or nil. 122 * The protocol is responsible for disposal of the mbuf chain m, 123 * the caller is responsible for any space held by nam and opt. 124 * A non-zero return from usrreq gives an 125 * UNIX error number which should be passed to higher level software. 126 */ 127#define PRU_ATTACH 0 /* attach protocol to up */ 128#define PRU_DETACH 1 /* detach protocol from up */ 129#define PRU_BIND 2 /* bind socket to address */ 130#define PRU_LISTEN 3 /* listen for connection */ 131#define PRU_CONNECT 4 /* establish connection to peer */ 132#define PRU_ACCEPT 5 /* accept connection from peer */ 133#define PRU_DISCONNECT 6 /* disconnect from peer */ 134#define PRU_SHUTDOWN 7 /* won't send any more data */ 135#define PRU_RCVD 8 /* have taken data; more room now */ 136#define PRU_SEND 9 /* send this data */ 137#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 138#define PRU_CONTROL 11 /* control operations on protocol */ 139#define PRU_SENSE 12 /* return status into m */ 140#define PRU_RCVOOB 13 /* retrieve out of band data */ 141#define PRU_SENDOOB 14 /* send out of band data */ 142#define PRU_SOCKADDR 15 /* fetch socket's address */ 143#define PRU_PEERADDR 16 /* fetch peer's address */ 144#define PRU_CONNECT2 17 /* connect two sockets */ 145/* begin for protocols internal use */ 146#define PRU_FASTTIMO 18 /* 200ms timeout */ 147#define PRU_SLOWTIMO 19 /* 500ms timeout */ 148#define PRU_PROTORCV 20 /* receive from below */ 149#define PRU_PROTOSEND 21 /* send to below */ 150#define PRU_SEND_EOF 22 /* send and close */ 151#define PRU_NREQ 22 152 153#ifdef PRUREQUESTS 154char *prurequests[] = { 155 "ATTACH", "DETACH", "BIND", "LISTEN", 156 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 157 "RCVD", "SEND", "ABORT", "CONTROL", 158 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 159 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 160 "PROTORCV", "PROTOSEND", 161 "SEND_EOF", 162}; 163#endif 164 165/* 166 * The arguments to the ctlinput routine are 167 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 168 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 169 * and arg is a `void *' argument used within a protocol family. 170 */ 171#define PRC_IFDOWN 0 /* interface transition */ 172#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 173#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 174#define PRC_QUENCH 4 /* some one said to slow down */ 175#define PRC_MSGSIZE 5 /* message size forced drop */ 176#define PRC_HOSTDEAD 6 /* host appears to be down */ 177#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 178#define PRC_UNREACH_NET 8 /* no route to network */ 179#define PRC_UNREACH_HOST 9 /* no route to host */ 180#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 181#define PRC_UNREACH_PORT 11 /* bad port # */ 182/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 183#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 184#define PRC_REDIRECT_NET 14 /* net routing redirect */ 185#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 186#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 187#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 188#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 189#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 190#define PRC_PARAMPROB 20 /* header incorrect */ 191 192#define PRC_NCMDS 21 193 194#define PRC_IS_REDIRECT(cmd) \ 195 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 196 197#ifdef PRCREQUESTS 198char *prcrequests[] = { 199 "IFDOWN", "ROUTEDEAD", "#2", "DEC-BIT-QUENCH2", 200 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 201 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 202 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 203 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 204 "PARAMPROB" 205}; 206#endif 207 208/* 209 * The arguments to ctloutput are: 210 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval); 211 * req is one of the actions listed below, so is a (struct socket *), 212 * level is an indication of which protocol layer the option is intended. 213 * optname is a protocol dependent socket option request, 214 * optval is a pointer to a mbuf-chain pointer, for value-return results. 215 * The protocol is responsible for disposal of the mbuf chain *optval 216 * if supplied, 217 * the caller is responsible for any space held by *optval, when returned. 218 * A non-zero return from usrreq gives an 219 * UNIX error number which should be passed to higher level software. 220 */ 221#define PRCO_GETOPT 0 222#define PRCO_SETOPT 1 223 224#define PRCO_NCMDS 2 225 226#ifdef PRCOREQUESTS 227char *prcorequests[] = { 228 "GETOPT", "SETOPT", 229}; 230#endif 231 232#ifdef KERNEL 233struct protosw *pffindproto __P((int family, int protocol, int type)); 234struct protosw *pffindtype __P((int family, int type)); 235#endif 236 237#endif 238