protosw.h revision 23888
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 3423888Swollman * $Id: protosw.h,v 1.15 1997/02/22 09:45:42 peter Exp $ 351541Srgrimes */ 361541Srgrimes 372165Spaul#ifndef _SYS_PROTOSW_H_ 382165Spaul#define _SYS_PROTOSW_H_ 392165Spaul 4023888Swollman/* Forward declare these structures referenced from prototypes below. */ 4123888Swollmanstruct ifnet; 4212453Sbdestruct mbuf; 4312453Sbdestruct sockaddr; 4412453Sbdestruct socket; 4512453Sbdestruct sockproto; 4623888Swollmanstruct stat; 4723888Swollmanstruct uio; 4812453Sbde 491541Srgrimes/* 501541Srgrimes * Protocol switch table. 511541Srgrimes * 521541Srgrimes * Each protocol has a handle initializing one of these structures, 531541Srgrimes * which is used for protocol-protocol and system-protocol communication. 541541Srgrimes * 551541Srgrimes * A protocol is called through the pr_init entry before any other. 561541Srgrimes * Thereafter it is called every 200ms through the pr_fasttimo entry and 571541Srgrimes * every 500ms through the pr_slowtimo for timer based actions. 581541Srgrimes * The system will call the pr_drain entry if it is low on space and 591541Srgrimes * this should throw away any non-critical data. 601541Srgrimes * 611541Srgrimes * Protocols pass data between themselves as chains of mbufs using 621541Srgrimes * the pr_input and pr_output hooks. Pr_input passes data up (towards 631541Srgrimes * UNIX) and pr_output passes it down (towards the imps); control 641541Srgrimes * information passes up and down on pr_ctlinput and pr_ctloutput. 651541Srgrimes * The protocol is responsible for the space occupied by any the 661541Srgrimes * arguments to these entries and must dispose it. 671541Srgrimes * 681541Srgrimes * The userreq routine interfaces protocols to the system and is 691541Srgrimes * described below. 701541Srgrimes */ 711541Srgrimesstruct protosw { 721541Srgrimes short pr_type; /* socket type used for */ 731541Srgrimes struct domain *pr_domain; /* domain protocol a member of */ 741541Srgrimes short pr_protocol; /* protocol number */ 751541Srgrimes short pr_flags; /* see below */ 761541Srgrimes/* protocol-protocol hooks */ 7712453Sbde void (*pr_input) __P((struct mbuf *, int len)); 7812453Sbde /* input to protocol (from below) */ 7912453Sbde int (*pr_output) __P((struct mbuf *m, struct socket *so)); 8012453Sbde /* output to protocol (from above) */ 8112881Sbde void (*pr_ctlinput)__P((int, struct sockaddr *, void *)); 8212453Sbde /* control input (from below) */ 8312453Sbde int (*pr_ctloutput)__P((int, struct socket *, int, int, 8412453Sbde struct mbuf **)); 8512453Sbde /* control output (from above) */ 861541Srgrimes/* user-protocol hook */ 8717096Swollman int (*pr_ousrreq) __P((struct socket *, int, struct mbuf *, 8817096Swollman struct mbuf *, struct mbuf *)); 8912453Sbde /* user request: see list below */ 901541Srgrimes/* utility hooks */ 9112453Sbde void (*pr_init) __P((void)); /* initialization hook */ 9212453Sbde void (*pr_fasttimo) __P((void)); 9312453Sbde /* fast timeout (200ms) */ 9412453Sbde void (*pr_slowtimo) __P((void)); 9512453Sbde /* slow timeout (500ms) */ 9612453Sbde void (*pr_drain) __P((void)); 9712453Sbde /* flush any excess space possible */ 9817047Swollman struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 991541Srgrimes}; 1001541Srgrimes 1011541Srgrimes#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 1021541Srgrimes#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 1031541Srgrimes 1041541Srgrimes/* 1051541Srgrimes * Values for pr_flags. 1061541Srgrimes * PR_ADDR requires PR_ATOMIC; 1071541Srgrimes * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 1086223Swollman * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 1096223Swollman * and the protocol understands the MSG_EOF flag. The first property is 1106223Swollman * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 1116223Swollman * anyhow). 1121541Srgrimes */ 1131541Srgrimes#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 1141541Srgrimes#define PR_ADDR 0x02 /* addresses given with messages */ 1151541Srgrimes#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 1161541Srgrimes#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 1171541Srgrimes#define PR_RIGHTS 0x10 /* passes capabilities */ 1186223Swollman#define PR_IMPLOPCL 0x20 /* implied open/close */ 1191541Srgrimes 1201541Srgrimes/* 1211541Srgrimes * The arguments to usrreq are: 1221541Srgrimes * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 1231541Srgrimes * where up is a (struct socket *), req is one of these requests, 1241541Srgrimes * m is a optional mbuf chain containing a message, 1251541Srgrimes * nam is an optional mbuf chain containing an address, 1261541Srgrimes * and opt is a pointer to a socketopt structure or nil. 1271541Srgrimes * The protocol is responsible for disposal of the mbuf chain m, 1281541Srgrimes * the caller is responsible for any space held by nam and opt. 1291541Srgrimes * A non-zero return from usrreq gives an 1301541Srgrimes * UNIX error number which should be passed to higher level software. 1311541Srgrimes */ 1321541Srgrimes#define PRU_ATTACH 0 /* attach protocol to up */ 1331541Srgrimes#define PRU_DETACH 1 /* detach protocol from up */ 1341541Srgrimes#define PRU_BIND 2 /* bind socket to address */ 1351541Srgrimes#define PRU_LISTEN 3 /* listen for connection */ 1361541Srgrimes#define PRU_CONNECT 4 /* establish connection to peer */ 1371541Srgrimes#define PRU_ACCEPT 5 /* accept connection from peer */ 1381541Srgrimes#define PRU_DISCONNECT 6 /* disconnect from peer */ 1391541Srgrimes#define PRU_SHUTDOWN 7 /* won't send any more data */ 1401541Srgrimes#define PRU_RCVD 8 /* have taken data; more room now */ 1411541Srgrimes#define PRU_SEND 9 /* send this data */ 1421541Srgrimes#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 1431541Srgrimes#define PRU_CONTROL 11 /* control operations on protocol */ 1441541Srgrimes#define PRU_SENSE 12 /* return status into m */ 1451541Srgrimes#define PRU_RCVOOB 13 /* retrieve out of band data */ 1461541Srgrimes#define PRU_SENDOOB 14 /* send out of band data */ 1471541Srgrimes#define PRU_SOCKADDR 15 /* fetch socket's address */ 1481541Srgrimes#define PRU_PEERADDR 16 /* fetch peer's address */ 1491541Srgrimes#define PRU_CONNECT2 17 /* connect two sockets */ 1501541Srgrimes/* begin for protocols internal use */ 1511541Srgrimes#define PRU_FASTTIMO 18 /* 200ms timeout */ 1521541Srgrimes#define PRU_SLOWTIMO 19 /* 500ms timeout */ 1531541Srgrimes#define PRU_PROTORCV 20 /* receive from below */ 1541541Srgrimes#define PRU_PROTOSEND 21 /* send to below */ 15517047Swollman/* end for protocol's internal use */ 1566223Swollman#define PRU_SEND_EOF 22 /* send and close */ 1576223Swollman#define PRU_NREQ 22 1581541Srgrimes 1591541Srgrimes#ifdef PRUREQUESTS 1601541Srgrimeschar *prurequests[] = { 1611541Srgrimes "ATTACH", "DETACH", "BIND", "LISTEN", 1621541Srgrimes "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 1631541Srgrimes "RCVD", "SEND", "ABORT", "CONTROL", 1641541Srgrimes "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 1651541Srgrimes "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 1661541Srgrimes "PROTORCV", "PROTOSEND", 1676223Swollman "SEND_EOF", 1681541Srgrimes}; 1691541Srgrimes#endif 1701541Srgrimes 17117047Swollman#ifdef KERNEL /* users shouldn't see this decl */ 17217047Swollman 1731541Srgrimes/* 17417047Swollman * If the ordering here looks odd, that's because it's alphabetical. 17523888Swollman * Having this structure separated out from the main protoswitch is actually 17623888Swollman * a big (12 cycles per call) lose on high-end CPUs. We will eventually 17723888Swollman * migrate this stuff back into the main structure. 17817047Swollman */ 17917047Swollmanstruct pr_usrreqs { 18017047Swollman int (*pru_abort) __P((struct socket *so)); 18117047Swollman int (*pru_accept) __P((struct socket *so, struct mbuf *nam)); 18217047Swollman int (*pru_attach) __P((struct socket *so, int proto)); 18317047Swollman int (*pru_bind) __P((struct socket *so, struct mbuf *nam)); 18417047Swollman int (*pru_connect) __P((struct socket *so, struct mbuf *nam)); 18517047Swollman int (*pru_connect2) __P((struct socket *so1, struct socket *so2)); 18617096Swollman int (*pru_control) __P((struct socket *so, int cmd, caddr_t data, 18717096Swollman struct ifnet *ifp)); 18817047Swollman int (*pru_detach) __P((struct socket *so)); 18917047Swollman int (*pru_disconnect) __P((struct socket *so)); 19017047Swollman int (*pru_listen) __P((struct socket *so)); 19117047Swollman int (*pru_peeraddr) __P((struct socket *so, struct mbuf *nam)); 19217047Swollman int (*pru_rcvd) __P((struct socket *so, int flags)); 19317096Swollman int (*pru_rcvoob) __P((struct socket *so, struct mbuf *m, 19417096Swollman int flags)); 19517047Swollman int (*pru_send) __P((struct socket *so, int flags, struct mbuf *m, 19617047Swollman struct mbuf *addr, struct mbuf *control)); 19717047Swollman#define PRUS_OOB 0x1 19817047Swollman#define PRUS_EOF 0x2 19917047Swollman int (*pru_sense) __P((struct socket *so, struct stat *sb)); 20017047Swollman int (*pru_shutdown) __P((struct socket *so)); 20117047Swollman int (*pru_sockaddr) __P((struct socket *so, struct mbuf *nam)); 20223888Swollman 20323888Swollman /* 20423888Swollman * These two added later, so they are out of order. They are used 20523888Swollman * for shortcutting (fast path input/output) in some protocols. 20623888Swollman * XXX - that's a lie, they are not implemented yet 20723888Swollman */ 20823888Swollman int (*pru_sosend) __P((struct socket *so, struct mbuf *addr, 20923888Swollman struct uio *uio, struct mbuf *top, 21023888Swollman struct mbuf *control, int flags)); 21123888Swollman int (*pru_soreceive) __P((struct socket *so, struct mbuf **paddr, 21223888Swollman struct uio *uio, struct mbuf **mp0, 21323888Swollman struct mbuf **controlp, int *flagsp)); 21417047Swollman}; 21517047Swollman 21622901Swollmanint pru_accept_notsupp __P((struct socket *so, struct mbuf *nam)); 21717096Swollmanint pru_connect2_notsupp __P((struct socket *so1, struct socket *so2)); 21822901Swollmanint pru_listen_notsupp __P((struct socket *so)); 21922901Swollmanint pru_rcvd_notsupp __P((struct socket *so, int flags)); 22022901Swollmanint pru_rcvoob_notsupp __P((struct socket *so, struct mbuf *m, int flags)); 22122901Swollmanint pru_sense_null __P((struct socket *so, struct stat *sb)); 22217096Swollman 22317047Swollman#define PRU_OLDSTYLE 22417047Swollman 22517047Swollman#ifdef PRU_OLDSTYLE 22617047Swollman/* 22717047Swollman * Protocols which don't yet implement pr_usrreqs can point it to this 22817047Swollman * structure, which will call the old pr_usrreq() entry point with the 22917047Swollman * appropriate arguments. 23017047Swollman */ 23117047Swollmanextern struct pr_usrreqs pru_oldstyle; 23217047Swollman#endif /* PRU_OLDSTYLE */ 23317047Swollman 23417047Swollman#endif /* KERNEL */ 23517047Swollman 23617047Swollman/* 2371541Srgrimes * The arguments to the ctlinput routine are 2381541Srgrimes * (*protosw[].pr_ctlinput)(cmd, sa, arg); 2391541Srgrimes * where cmd is one of the commands below, sa is a pointer to a sockaddr, 24012881Sbde * and arg is a `void *' argument used within a protocol family. 2411541Srgrimes */ 2421541Srgrimes#define PRC_IFDOWN 0 /* interface transition */ 2431541Srgrimes#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 24422614Swollman#define PRC_IFUP 2 /* interface has come back up */ 2451541Srgrimes#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 2461541Srgrimes#define PRC_QUENCH 4 /* some one said to slow down */ 2471541Srgrimes#define PRC_MSGSIZE 5 /* message size forced drop */ 2481541Srgrimes#define PRC_HOSTDEAD 6 /* host appears to be down */ 2491541Srgrimes#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 2501541Srgrimes#define PRC_UNREACH_NET 8 /* no route to network */ 2511541Srgrimes#define PRC_UNREACH_HOST 9 /* no route to host */ 2521541Srgrimes#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 2531541Srgrimes#define PRC_UNREACH_PORT 11 /* bad port # */ 2541541Srgrimes/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 2551541Srgrimes#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 2561541Srgrimes#define PRC_REDIRECT_NET 14 /* net routing redirect */ 2571541Srgrimes#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 2581541Srgrimes#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 2591541Srgrimes#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 2601541Srgrimes#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 2611541Srgrimes#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 2621541Srgrimes#define PRC_PARAMPROB 20 /* header incorrect */ 2631541Srgrimes 2641541Srgrimes#define PRC_NCMDS 21 2651541Srgrimes 2661541Srgrimes#define PRC_IS_REDIRECT(cmd) \ 2671541Srgrimes ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 2681541Srgrimes 2691541Srgrimes#ifdef PRCREQUESTS 2701541Srgrimeschar *prcrequests[] = { 27122614Swollman "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 2721541Srgrimes "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 2731541Srgrimes "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 2741541Srgrimes "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 2751541Srgrimes "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 2761541Srgrimes "PARAMPROB" 2771541Srgrimes}; 2781541Srgrimes#endif 2791541Srgrimes 2801541Srgrimes/* 2811541Srgrimes * The arguments to ctloutput are: 2821541Srgrimes * (*protosw[].pr_ctloutput)(req, so, level, optname, optval); 2831541Srgrimes * req is one of the actions listed below, so is a (struct socket *), 2841541Srgrimes * level is an indication of which protocol layer the option is intended. 2851541Srgrimes * optname is a protocol dependent socket option request, 2861541Srgrimes * optval is a pointer to a mbuf-chain pointer, for value-return results. 2871541Srgrimes * The protocol is responsible for disposal of the mbuf chain *optval 2881541Srgrimes * if supplied, 2891541Srgrimes * the caller is responsible for any space held by *optval, when returned. 2901541Srgrimes * A non-zero return from usrreq gives an 2911541Srgrimes * UNIX error number which should be passed to higher level software. 2921541Srgrimes */ 2931541Srgrimes#define PRCO_GETOPT 0 2941541Srgrimes#define PRCO_SETOPT 1 2951541Srgrimes 2961541Srgrimes#define PRCO_NCMDS 2 2971541Srgrimes 2981541Srgrimes#ifdef PRCOREQUESTS 2991541Srgrimeschar *prcorequests[] = { 3001541Srgrimes "GETOPT", "SETOPT", 3011541Srgrimes}; 3021541Srgrimes#endif 3031541Srgrimes 3041541Srgrimes#ifdef KERNEL 30512453Sbdestruct protosw *pffindproto __P((int family, int protocol, int type)); 30612453Sbdestruct protosw *pffindtype __P((int family, int type)); 3071541Srgrimes#endif 3082165Spaul 3092165Spaul#endif 310