protosw.h revision 17047
11541Srgrimes/*- 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 291541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301541Srgrimes * 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 3417047Swollman * $Id: protosw.h,v 1.9 1995/12/16 02:14:44 bde Exp $ 351541Srgrimes */ 361541Srgrimes 372165Spaul#ifndef _SYS_PROTOSW_H_ 382165Spaul#define _SYS_PROTOSW_H_ 392165Spaul 4012453Sbdestruct mbuf; 4112453Sbdestruct sockaddr; 4212453Sbdestruct socket; 4312453Sbdestruct sockproto; 4412453Sbde 451541Srgrimes/* 461541Srgrimes * Protocol switch table. 471541Srgrimes * 481541Srgrimes * Each protocol has a handle initializing one of these structures, 491541Srgrimes * which is used for protocol-protocol and system-protocol communication. 501541Srgrimes * 511541Srgrimes * A protocol is called through the pr_init entry before any other. 521541Srgrimes * Thereafter it is called every 200ms through the pr_fasttimo entry and 531541Srgrimes * every 500ms through the pr_slowtimo for timer based actions. 541541Srgrimes * The system will call the pr_drain entry if it is low on space and 551541Srgrimes * this should throw away any non-critical data. 561541Srgrimes * 571541Srgrimes * Protocols pass data between themselves as chains of mbufs using 581541Srgrimes * the pr_input and pr_output hooks. Pr_input passes data up (towards 591541Srgrimes * UNIX) and pr_output passes it down (towards the imps); control 601541Srgrimes * information passes up and down on pr_ctlinput and pr_ctloutput. 611541Srgrimes * The protocol is responsible for the space occupied by any the 621541Srgrimes * arguments to these entries and must dispose it. 631541Srgrimes * 641541Srgrimes * The userreq routine interfaces protocols to the system and is 651541Srgrimes * described below. 661541Srgrimes */ 671541Srgrimesstruct protosw { 681541Srgrimes short pr_type; /* socket type used for */ 691541Srgrimes struct domain *pr_domain; /* domain protocol a member of */ 701541Srgrimes short pr_protocol; /* protocol number */ 711541Srgrimes short pr_flags; /* see below */ 721541Srgrimes/* protocol-protocol hooks */ 7312453Sbde void (*pr_input) __P((struct mbuf *, int len)); 7412453Sbde /* input to protocol (from below) */ 7512453Sbde int (*pr_output) __P((struct mbuf *m, struct socket *so)); 7612453Sbde /* output to protocol (from above) */ 7712881Sbde void (*pr_ctlinput)__P((int, struct sockaddr *, void *)); 7812453Sbde /* control input (from below) */ 7912453Sbde int (*pr_ctloutput)__P((int, struct socket *, int, int, 8012453Sbde struct mbuf **)); 8112453Sbde /* control output (from above) */ 821541Srgrimes/* user-protocol hook */ 8312453Sbde int (*pr_usrreq) __P((struct socket *, int, struct mbuf *, 8412453Sbde struct mbuf *, struct mbuf *)); 8512453Sbde /* user request: see list below */ 861541Srgrimes/* utility hooks */ 8712453Sbde void (*pr_init) __P((void)); /* initialization hook */ 8812453Sbde void (*pr_fasttimo) __P((void)); 8912453Sbde /* fast timeout (200ms) */ 9012453Sbde void (*pr_slowtimo) __P((void)); 9112453Sbde /* slow timeout (500ms) */ 9212453Sbde void (*pr_drain) __P((void)); 9312453Sbde /* flush any excess space possible */ 9417047Swollman struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 951541Srgrimes}; 961541Srgrimes 971541Srgrimes#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 981541Srgrimes#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 991541Srgrimes 1001541Srgrimes/* 1011541Srgrimes * Values for pr_flags. 1021541Srgrimes * PR_ADDR requires PR_ATOMIC; 1031541Srgrimes * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 1046223Swollman * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 1056223Swollman * and the protocol understands the MSG_EOF flag. The first property is 1066223Swollman * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 1076223Swollman * anyhow). 1081541Srgrimes */ 1091541Srgrimes#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 1101541Srgrimes#define PR_ADDR 0x02 /* addresses given with messages */ 1111541Srgrimes#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 1121541Srgrimes#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 1131541Srgrimes#define PR_RIGHTS 0x10 /* passes capabilities */ 1146223Swollman#define PR_IMPLOPCL 0x20 /* implied open/close */ 1151541Srgrimes 1161541Srgrimes/* 1171541Srgrimes * The arguments to usrreq are: 1181541Srgrimes * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 1191541Srgrimes * where up is a (struct socket *), req is one of these requests, 1201541Srgrimes * m is a optional mbuf chain containing a message, 1211541Srgrimes * nam is an optional mbuf chain containing an address, 1221541Srgrimes * and opt is a pointer to a socketopt structure or nil. 1231541Srgrimes * The protocol is responsible for disposal of the mbuf chain m, 1241541Srgrimes * the caller is responsible for any space held by nam and opt. 1251541Srgrimes * A non-zero return from usrreq gives an 1261541Srgrimes * UNIX error number which should be passed to higher level software. 1271541Srgrimes */ 1281541Srgrimes#define PRU_ATTACH 0 /* attach protocol to up */ 1291541Srgrimes#define PRU_DETACH 1 /* detach protocol from up */ 1301541Srgrimes#define PRU_BIND 2 /* bind socket to address */ 1311541Srgrimes#define PRU_LISTEN 3 /* listen for connection */ 1321541Srgrimes#define PRU_CONNECT 4 /* establish connection to peer */ 1331541Srgrimes#define PRU_ACCEPT 5 /* accept connection from peer */ 1341541Srgrimes#define PRU_DISCONNECT 6 /* disconnect from peer */ 1351541Srgrimes#define PRU_SHUTDOWN 7 /* won't send any more data */ 1361541Srgrimes#define PRU_RCVD 8 /* have taken data; more room now */ 1371541Srgrimes#define PRU_SEND 9 /* send this data */ 1381541Srgrimes#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 1391541Srgrimes#define PRU_CONTROL 11 /* control operations on protocol */ 1401541Srgrimes#define PRU_SENSE 12 /* return status into m */ 1411541Srgrimes#define PRU_RCVOOB 13 /* retrieve out of band data */ 1421541Srgrimes#define PRU_SENDOOB 14 /* send out of band data */ 1431541Srgrimes#define PRU_SOCKADDR 15 /* fetch socket's address */ 1441541Srgrimes#define PRU_PEERADDR 16 /* fetch peer's address */ 1451541Srgrimes#define PRU_CONNECT2 17 /* connect two sockets */ 1461541Srgrimes/* begin for protocols internal use */ 1471541Srgrimes#define PRU_FASTTIMO 18 /* 200ms timeout */ 1481541Srgrimes#define PRU_SLOWTIMO 19 /* 500ms timeout */ 1491541Srgrimes#define PRU_PROTORCV 20 /* receive from below */ 1501541Srgrimes#define PRU_PROTOSEND 21 /* send to below */ 15117047Swollman/* end for protocol's internal use */ 1526223Swollman#define PRU_SEND_EOF 22 /* send and close */ 1536223Swollman#define PRU_NREQ 22 1541541Srgrimes 1551541Srgrimes#ifdef PRUREQUESTS 1561541Srgrimeschar *prurequests[] = { 1571541Srgrimes "ATTACH", "DETACH", "BIND", "LISTEN", 1581541Srgrimes "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 1591541Srgrimes "RCVD", "SEND", "ABORT", "CONTROL", 1601541Srgrimes "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 1611541Srgrimes "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 1621541Srgrimes "PROTORCV", "PROTOSEND", 1636223Swollman "SEND_EOF", 1641541Srgrimes}; 1651541Srgrimes#endif 1661541Srgrimes 16717047Swollman#ifdef KERNEL /* users shouldn't see this decl */ 16817047Swollmanstruct stat; 16917047Swollman 1701541Srgrimes/* 17117047Swollman * If the ordering here looks odd, that's because it's alphabetical. 17217047Swollman */ 17317047Swollmanstruct pr_usrreqs { 17417047Swollman int (*pru_abort) __P((struct socket *so)); 17517047Swollman int (*pru_accept) __P((struct socket *so, struct mbuf *nam)); 17617047Swollman int (*pru_attach) __P((struct socket *so, int proto)); 17717047Swollman int (*pru_bind) __P((struct socket *so, struct mbuf *nam)); 17817047Swollman int (*pru_connect) __P((struct socket *so, struct mbuf *nam)); 17917047Swollman int (*pru_connect2) __P((struct socket *so1, struct socket *so2)); 18017047Swollman int (*pru_control) __P((struct socket *so, int cmd, caddr_t data)); 18117047Swollman int (*pru_detach) __P((struct socket *so)); 18217047Swollman int (*pru_disconnect) __P((struct socket *so)); 18317047Swollman int (*pru_listen) __P((struct socket *so)); 18417047Swollman int (*pru_peeraddr) __P((struct socket *so, struct mbuf *nam)); 18517047Swollman int (*pru_rcvd) __P((struct socket *so, int flags)); 18617047Swollman int (*pru_rcvoob) __P((struct socket *so, struct mbuf *m, int flags)); 18717047Swollman /* 18817047Swollman * The `m' parameter here is almost certainly going to become a 18917047Swollman * `struct uio' at some point in the future. Similar changes 19017047Swollman * will probably happen for the receive entry points. 19117047Swollman */ 19217047Swollman int (*pru_send) __P((struct socket *so, int flags, struct mbuf *m, 19317047Swollman struct mbuf *addr, struct mbuf *control)); 19417047Swollman#define PRUS_OOB 0x1 19517047Swollman#define PRUS_EOF 0x2 19617047Swollman int (*pru_sense) __P((struct socket *so, struct stat *sb)); 19717047Swollman int (*pru_shutdown) __P((struct socket *so)); 19817047Swollman int (*pru_sockaddr) __P((struct socket *so, struct mbuf *nam)); 19917047Swollman}; 20017047Swollman 20117047Swollman#define PRU_OLDSTYLE 20217047Swollman 20317047Swollman#ifdef PRU_OLDSTYLE 20417047Swollman/* 20517047Swollman * Protocols which don't yet implement pr_usrreqs can point it to this 20617047Swollman * structure, which will call the old pr_usrreq() entry point with the 20717047Swollman * appropriate arguments. 20817047Swollman */ 20917047Swollmanextern struct pr_usrreqs pru_oldstyle; 21017047Swollmanint pr_newstyle_usrreq(struct socket *, int, struct mbuf *, struct mbuf *, 21117047Swollman struct mbuf *); 21217047Swollman#endif /* PRU_OLDSTYLE */ 21317047Swollman 21417047Swollman#endif /* KERNEL */ 21517047Swollman 21617047Swollman/* 2171541Srgrimes * The arguments to the ctlinput routine are 2181541Srgrimes * (*protosw[].pr_ctlinput)(cmd, sa, arg); 2191541Srgrimes * where cmd is one of the commands below, sa is a pointer to a sockaddr, 22012881Sbde * and arg is a `void *' argument used within a protocol family. 2211541Srgrimes */ 2221541Srgrimes#define PRC_IFDOWN 0 /* interface transition */ 2231541Srgrimes#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 2241541Srgrimes#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 2251541Srgrimes#define PRC_QUENCH 4 /* some one said to slow down */ 2261541Srgrimes#define PRC_MSGSIZE 5 /* message size forced drop */ 2271541Srgrimes#define PRC_HOSTDEAD 6 /* host appears to be down */ 2281541Srgrimes#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 2291541Srgrimes#define PRC_UNREACH_NET 8 /* no route to network */ 2301541Srgrimes#define PRC_UNREACH_HOST 9 /* no route to host */ 2311541Srgrimes#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 2321541Srgrimes#define PRC_UNREACH_PORT 11 /* bad port # */ 2331541Srgrimes/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 2341541Srgrimes#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 2351541Srgrimes#define PRC_REDIRECT_NET 14 /* net routing redirect */ 2361541Srgrimes#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 2371541Srgrimes#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 2381541Srgrimes#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 2391541Srgrimes#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 2401541Srgrimes#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 2411541Srgrimes#define PRC_PARAMPROB 20 /* header incorrect */ 2421541Srgrimes 2431541Srgrimes#define PRC_NCMDS 21 2441541Srgrimes 2451541Srgrimes#define PRC_IS_REDIRECT(cmd) \ 2461541Srgrimes ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 2471541Srgrimes 2481541Srgrimes#ifdef PRCREQUESTS 2491541Srgrimeschar *prcrequests[] = { 2501541Srgrimes "IFDOWN", "ROUTEDEAD", "#2", "DEC-BIT-QUENCH2", 2511541Srgrimes "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 2521541Srgrimes "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 2531541Srgrimes "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 2541541Srgrimes "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 2551541Srgrimes "PARAMPROB" 2561541Srgrimes}; 2571541Srgrimes#endif 2581541Srgrimes 2591541Srgrimes/* 2601541Srgrimes * The arguments to ctloutput are: 2611541Srgrimes * (*protosw[].pr_ctloutput)(req, so, level, optname, optval); 2621541Srgrimes * req is one of the actions listed below, so is a (struct socket *), 2631541Srgrimes * level is an indication of which protocol layer the option is intended. 2641541Srgrimes * optname is a protocol dependent socket option request, 2651541Srgrimes * optval is a pointer to a mbuf-chain pointer, for value-return results. 2661541Srgrimes * The protocol is responsible for disposal of the mbuf chain *optval 2671541Srgrimes * if supplied, 2681541Srgrimes * the caller is responsible for any space held by *optval, when returned. 2691541Srgrimes * A non-zero return from usrreq gives an 2701541Srgrimes * UNIX error number which should be passed to higher level software. 2711541Srgrimes */ 2721541Srgrimes#define PRCO_GETOPT 0 2731541Srgrimes#define PRCO_SETOPT 1 2741541Srgrimes 2751541Srgrimes#define PRCO_NCMDS 2 2761541Srgrimes 2771541Srgrimes#ifdef PRCOREQUESTS 2781541Srgrimeschar *prcorequests[] = { 2791541Srgrimes "GETOPT", "SETOPT", 2801541Srgrimes}; 2811541Srgrimes#endif 2821541Srgrimes 2831541Srgrimes#ifdef KERNEL 28412453Sbdestruct protosw *pffindproto __P((int family, int protocol, int type)); 28512453Sbdestruct protosw *pffindtype __P((int family, int type)); 2861541Srgrimes#endif 2872165Spaul 2882165Spaul#endif 289