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