protosw.h revision 151888
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 * 4. Neither the name of the University nor the names of its contributors 141541Srgrimes * may be used to endorse or promote products derived from this software 151541Srgrimes * without specific prior written permission. 161541Srgrimes * 171541Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 181541Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 191541Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 201541Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 211541Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 221541Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 231541Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 241541Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 251541Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 261541Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 271541Srgrimes * SUCH DAMAGE. 281541Srgrimes * 291541Srgrimes * @(#)protosw.h 8.1 (Berkeley) 6/2/93 3050477Speter * $FreeBSD: head/sys/sys/protosw.h 151888 2005-10-30 19:44:40Z rwatson $ 311541Srgrimes */ 321541Srgrimes 332165Spaul#ifndef _SYS_PROTOSW_H_ 342165Spaul#define _SYS_PROTOSW_H_ 352165Spaul 3623888Swollman/* Forward declare these structures referenced from prototypes below. */ 3712453Sbdestruct mbuf; 3883366Sjulianstruct thread; 3912453Sbdestruct sockaddr; 4012453Sbdestruct socket; 4138482Swollmanstruct sockopt; 4212453Sbde 4355205Speter/*#ifdef _KERNEL*/ 441541Srgrimes/* 451541Srgrimes * Protocol switch table. 461541Srgrimes * 471541Srgrimes * Each protocol has a handle initializing one of these structures, 481541Srgrimes * which is used for protocol-protocol and system-protocol communication. 491541Srgrimes * 501541Srgrimes * A protocol is called through the pr_init entry before any other. 511541Srgrimes * Thereafter it is called every 200ms through the pr_fasttimo entry and 521541Srgrimes * every 500ms through the pr_slowtimo for timer based actions. 531541Srgrimes * The system will call the pr_drain entry if it is low on space and 541541Srgrimes * this should throw away any non-critical data. 551541Srgrimes * 561541Srgrimes * Protocols pass data between themselves as chains of mbufs using 571541Srgrimes * the pr_input and pr_output hooks. Pr_input passes data up (towards 5838482Swollman * the users) and pr_output passes it down (towards the interfaces); control 591541Srgrimes * information passes up and down on pr_ctlinput and pr_ctloutput. 601541Srgrimes * The protocol is responsible for the space occupied by any the 611541Srgrimes * arguments to these entries and must dispose it. 621541Srgrimes * 6338482Swollman * In retrospect, it would be a lot nicer to use an interface 6438482Swollman * similar to the vnode VOP interface. 651541Srgrimes */ 6681501Sjulian/* USE THESE FOR YOUR PROTOTYPES ! */ 6781501Sjuliantypedef void pr_input_t (struct mbuf *, int); 6882824Sjuliantypedef int pr_input6_t (struct mbuf **, int*, int); /* XXX FIX THIS */ 6981501Sjuliantypedef void pr_in_input_t (struct mbuf *, int, int); /* XXX FIX THIS */ 7081501Sjuliantypedef int pr_output_t (struct mbuf *, struct socket *); 7182824Sjuliantypedef int pr_in_output_t (struct mbuf *, struct socket *, struct sockaddr *); 7281501Sjuliantypedef void pr_ctlinput_t (int, struct sockaddr *, void *); 7381501Sjuliantypedef int pr_ctloutput_t (struct socket *, struct sockopt *); 7481501Sjuliantypedef void pr_init_t (void); 7581501Sjuliantypedef void pr_fasttimo_t (void); 7681501Sjuliantypedef void pr_slowtimo_t (void); 7781501Sjuliantypedef void pr_drain_t (void); 7881501Sjulian 7982824Sjuliantypedef int pr_usrreq_t(struct socket *, int, struct mbuf *, 8083366Sjulian struct mbuf *, struct mbuf *, struct thread *); 8181501Sjulian 821541Srgrimesstruct protosw { 831541Srgrimes short pr_type; /* socket type used for */ 841541Srgrimes struct domain *pr_domain; /* domain protocol a member of */ 851541Srgrimes short pr_protocol; /* protocol number */ 861541Srgrimes short pr_flags; /* see below */ 871541Srgrimes/* protocol-protocol hooks */ 8881501Sjulian pr_input_t *pr_input; /* input to protocol (from below) */ 8981501Sjulian pr_output_t *pr_output; /* output to protocol (from above) */ 9081501Sjulian pr_ctlinput_t *pr_ctlinput; /* control input (from below) */ 9181501Sjulian pr_ctloutput_t *pr_ctloutput; /* control output (from above) */ 921541Srgrimes/* user-protocol hook */ 9382824Sjulian pr_usrreq_t *pr_ousrreq; 941541Srgrimes/* utility hooks */ 9581501Sjulian pr_init_t *pr_init; 9681501Sjulian pr_fasttimo_t *pr_fasttimo; /* fast timeout (200ms) */ 9781501Sjulian pr_slowtimo_t *pr_slowtimo; /* slow timeout (500ms) */ 9881501Sjulian pr_drain_t *pr_drain; /* flush any excess space possible */ 9981501Sjulian 10017047Swollman struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 1011541Srgrimes}; 10228270Swollman/*#endif*/ 1031541Srgrimes 1041541Srgrimes#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 1051541Srgrimes#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 1061541Srgrimes 1071541Srgrimes/* 108136692Sandre * This number should be defined again within each protocol family to avoid 109136692Sandre * confusion. 110136692Sandre */ 111136692Sandre#define PROTO_SPACER 32767 /* spacer for loadable protocols */ 112136692Sandre 113136692Sandre/* 1141541Srgrimes * Values for pr_flags. 1151541Srgrimes * PR_ADDR requires PR_ATOMIC; 1161541Srgrimes * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 1176223Swollman * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 1186223Swollman * and the protocol understands the MSG_EOF flag. The first property is 1196223Swollman * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 1206223Swollman * anyhow). 1211541Srgrimes */ 1221541Srgrimes#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 1231541Srgrimes#define PR_ADDR 0x02 /* addresses given with messages */ 1241541Srgrimes#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 1251541Srgrimes#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 1261541Srgrimes#define PR_RIGHTS 0x10 /* passes capabilities */ 1276223Swollman#define PR_IMPLOPCL 0x20 /* implied open/close */ 12878064Sume#define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ 1291541Srgrimes 1301541Srgrimes/* 1311541Srgrimes * The arguments to usrreq are: 1321541Srgrimes * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 1331541Srgrimes * where up is a (struct socket *), req is one of these requests, 134108533Sschweikh * m is an optional mbuf chain containing a message, 1351541Srgrimes * nam is an optional mbuf chain containing an address, 1361541Srgrimes * and opt is a pointer to a socketopt structure or nil. 1371541Srgrimes * The protocol is responsible for disposal of the mbuf chain m, 1381541Srgrimes * the caller is responsible for any space held by nam and opt. 1391541Srgrimes * A non-zero return from usrreq gives an 1401541Srgrimes * UNIX error number which should be passed to higher level software. 1411541Srgrimes */ 1421541Srgrimes#define PRU_ATTACH 0 /* attach protocol to up */ 1431541Srgrimes#define PRU_DETACH 1 /* detach protocol from up */ 1441541Srgrimes#define PRU_BIND 2 /* bind socket to address */ 1451541Srgrimes#define PRU_LISTEN 3 /* listen for connection */ 1461541Srgrimes#define PRU_CONNECT 4 /* establish connection to peer */ 1471541Srgrimes#define PRU_ACCEPT 5 /* accept connection from peer */ 1481541Srgrimes#define PRU_DISCONNECT 6 /* disconnect from peer */ 1491541Srgrimes#define PRU_SHUTDOWN 7 /* won't send any more data */ 1501541Srgrimes#define PRU_RCVD 8 /* have taken data; more room now */ 1511541Srgrimes#define PRU_SEND 9 /* send this data */ 1521541Srgrimes#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 1531541Srgrimes#define PRU_CONTROL 11 /* control operations on protocol */ 1541541Srgrimes#define PRU_SENSE 12 /* return status into m */ 1551541Srgrimes#define PRU_RCVOOB 13 /* retrieve out of band data */ 1561541Srgrimes#define PRU_SENDOOB 14 /* send out of band data */ 1571541Srgrimes#define PRU_SOCKADDR 15 /* fetch socket's address */ 1581541Srgrimes#define PRU_PEERADDR 16 /* fetch peer's address */ 1591541Srgrimes#define PRU_CONNECT2 17 /* connect two sockets */ 1601541Srgrimes/* begin for protocols internal use */ 1611541Srgrimes#define PRU_FASTTIMO 18 /* 200ms timeout */ 1621541Srgrimes#define PRU_SLOWTIMO 19 /* 500ms timeout */ 1631541Srgrimes#define PRU_PROTORCV 20 /* receive from below */ 1641541Srgrimes#define PRU_PROTOSEND 21 /* send to below */ 16517047Swollman/* end for protocol's internal use */ 1666223Swollman#define PRU_SEND_EOF 22 /* send and close */ 1676223Swollman#define PRU_NREQ 22 1681541Srgrimes 1691541Srgrimes#ifdef PRUREQUESTS 170101975Salfredconst char *prurequests[] = { 1711541Srgrimes "ATTACH", "DETACH", "BIND", "LISTEN", 1721541Srgrimes "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 1731541Srgrimes "RCVD", "SEND", "ABORT", "CONTROL", 1741541Srgrimes "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 1751541Srgrimes "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 1761541Srgrimes "PROTORCV", "PROTOSEND", 1776223Swollman "SEND_EOF", 1781541Srgrimes}; 1791541Srgrimes#endif 1801541Srgrimes 18155205Speter#ifdef _KERNEL /* users shouldn't see this decl */ 18217047Swollman 18332995Sbdestruct ifnet; 18432995Sbdestruct stat; 18532995Sbdestruct ucred; 18632995Sbdestruct uio; 18732995Sbde 1881541Srgrimes/* 18917047Swollman * If the ordering here looks odd, that's because it's alphabetical. 19025201Swollman * Having this structure separated out from the main protoswitch is allegedly 19123888Swollman * a big (12 cycles per call) lose on high-end CPUs. We will eventually 19223888Swollman * migrate this stuff back into the main structure. 193137386Sphk * 194137386Sphk * Some fields initialized to defaults if they are NULL. 195137386Sphk * See uipc_domain.c:net_init_domain() 19617047Swollman */ 19717047Swollmanstruct pr_usrreqs { 198137386Sphk double __Break_the_struct_layout_for_now; 19992719Salfred int (*pru_abort)(struct socket *so); 20092719Salfred int (*pru_accept)(struct socket *so, struct sockaddr **nam); 20192719Salfred int (*pru_attach)(struct socket *so, int proto, struct thread *td); 20292719Salfred int (*pru_bind)(struct socket *so, struct sockaddr *nam, 20393008Sbde struct thread *td); 20492719Salfred int (*pru_connect)(struct socket *so, struct sockaddr *nam, 20593008Sbde struct thread *td); 20692719Salfred int (*pru_connect2)(struct socket *so1, struct socket *so2); 20792719Salfred int (*pru_control)(struct socket *so, u_long cmd, caddr_t data, 20893008Sbde struct ifnet *ifp, struct thread *td); 20992719Salfred int (*pru_detach)(struct socket *so); 21092719Salfred int (*pru_disconnect)(struct socket *so); 211151888Srwatson int (*pru_listen)(struct socket *so, int backlog, 212151888Srwatson struct thread *td); 21392719Salfred int (*pru_peeraddr)(struct socket *so, struct sockaddr **nam); 21492719Salfred int (*pru_rcvd)(struct socket *so, int flags); 21592719Salfred int (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags); 21692719Salfred int (*pru_send)(struct socket *so, int flags, struct mbuf *m, 21793008Sbde struct sockaddr *addr, struct mbuf *control, 21893008Sbde struct thread *td); 21917047Swollman#define PRUS_OOB 0x1 22017047Swollman#define PRUS_EOF 0x2 22142902Sfenner#define PRUS_MORETOCOME 0x4 22292719Salfred int (*pru_sense)(struct socket *so, struct stat *sb); 22392719Salfred int (*pru_shutdown)(struct socket *so); 22492719Salfred int (*pru_sockaddr)(struct socket *so, struct sockaddr **nam); 22523888Swollman 22623888Swollman /* 22725201Swollman * These three added later, so they are out of order. They are used 22823888Swollman * for shortcutting (fast path input/output) in some protocols. 22923888Swollman * XXX - that's a lie, they are not implemented yet 23025201Swollman * Rather than calling sosend() etc. directly, calls are made 23125201Swollman * through these entry points. For protocols which still use 23225201Swollman * the generic code, these just point to those routines. 23323888Swollman */ 23492719Salfred int (*pru_sosend)(struct socket *so, struct sockaddr *addr, 23593008Sbde struct uio *uio, struct mbuf *top, struct mbuf *control, 23693008Sbde int flags, struct thread *td); 23793008Sbde int (*pru_soreceive)(struct socket *so, struct sockaddr **paddr, 23893008Sbde struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 23993008Sbde int *flagsp); 24092719Salfred int (*pru_sopoll)(struct socket *so, int events, 24193008Sbde struct ucred *cred, struct thread *td); 242122875Srwatson void (*pru_sosetlabel)(struct socket *so); 24317047Swollman}; 24417047Swollman 245136692Sandre/* 246148965Sobrien * All nonvoid pru_*() functions below return EOPNOTSUPP. 247136692Sandre */ 248136692Sandre 249136692Sandreint pru_abort_notsupp(struct socket *so); 25092719Salfredint pru_accept_notsupp(struct socket *so, struct sockaddr **nam); 251136692Sandreint pru_attach_notsupp(struct socket *so, int proto, struct thread *td); 252136692Sandreint pru_bind_notsupp(struct socket *so, struct sockaddr *nam, 253136692Sandre struct thread *td); 25492719Salfredint pru_connect_notsupp(struct socket *so, struct sockaddr *nam, 25593008Sbde struct thread *td); 25692719Salfredint pru_connect2_notsupp(struct socket *so1, struct socket *so2); 25792719Salfredint pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data, 25893008Sbde struct ifnet *ifp, struct thread *td); 259136692Sandreint pru_detach_notsupp(struct socket *so); 260136692Sandreint pru_disconnect_notsupp(struct socket *so); 261151888Srwatsonint pru_listen_notsupp(struct socket *so, int backlog, struct thread *td); 262136692Sandreint pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam); 26392719Salfredint pru_rcvd_notsupp(struct socket *so, int flags); 26492719Salfredint pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags); 265136692Sandreint pru_send_notsupp(struct socket *so, int flags, struct mbuf *m, 266136692Sandre struct sockaddr *addr, struct mbuf *control, struct thread *td); 26792719Salfredint pru_sense_null(struct socket *so, struct stat *sb); 268136692Sandreint pru_shutdown_notsupp(struct socket *so); 269136692Sandreint pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam); 270136692Sandreint pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, 271136692Sandre struct uio *uio, struct mbuf *top, struct mbuf *control, int flags, 272136692Sandre struct thread *td); 273136692Sandreint pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr, 274136692Sandre struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 275136692Sandre int *flagsp); 276136692Sandreint pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred, 277136692Sandre struct thread *td); 278122875Srwatsonvoid pru_sosetlabel_null(struct socket *so); 27917096Swollman 28055205Speter#endif /* _KERNEL */ 28117047Swollman 28217047Swollman/* 2831541Srgrimes * The arguments to the ctlinput routine are 2841541Srgrimes * (*protosw[].pr_ctlinput)(cmd, sa, arg); 2851541Srgrimes * where cmd is one of the commands below, sa is a pointer to a sockaddr, 28612881Sbde * and arg is a `void *' argument used within a protocol family. 2871541Srgrimes */ 2881541Srgrimes#define PRC_IFDOWN 0 /* interface transition */ 2891541Srgrimes#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 29022614Swollman#define PRC_IFUP 2 /* interface has come back up */ 2911541Srgrimes#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 2921541Srgrimes#define PRC_QUENCH 4 /* some one said to slow down */ 2931541Srgrimes#define PRC_MSGSIZE 5 /* message size forced drop */ 2941541Srgrimes#define PRC_HOSTDEAD 6 /* host appears to be down */ 2951541Srgrimes#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 2961541Srgrimes#define PRC_UNREACH_NET 8 /* no route to network */ 2971541Srgrimes#define PRC_UNREACH_HOST 9 /* no route to host */ 2981541Srgrimes#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 2991541Srgrimes#define PRC_UNREACH_PORT 11 /* bad port # */ 3001541Srgrimes/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 3011541Srgrimes#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 3021541Srgrimes#define PRC_REDIRECT_NET 14 /* net routing redirect */ 3031541Srgrimes#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 3041541Srgrimes#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 3051541Srgrimes#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 3061541Srgrimes#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 3071541Srgrimes#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 3081541Srgrimes#define PRC_PARAMPROB 20 /* header incorrect */ 30972638Sphk#define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ 3101541Srgrimes 31172638Sphk#define PRC_NCMDS 22 3121541Srgrimes 3131541Srgrimes#define PRC_IS_REDIRECT(cmd) \ 3141541Srgrimes ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 3151541Srgrimes 3161541Srgrimes#ifdef PRCREQUESTS 3171541Srgrimeschar *prcrequests[] = { 31822614Swollman "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 3191541Srgrimes "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 3201541Srgrimes "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 3211541Srgrimes "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 3221541Srgrimes "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 32372638Sphk "PARAMPROB", "ADMIN-UNREACH" 3241541Srgrimes}; 3251541Srgrimes#endif 3261541Srgrimes 3271541Srgrimes/* 3281541Srgrimes * The arguments to ctloutput are: 32925201Swollman * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 3301541Srgrimes * req is one of the actions listed below, so is a (struct socket *), 3311541Srgrimes * level is an indication of which protocol layer the option is intended. 3321541Srgrimes * optname is a protocol dependent socket option request, 3331541Srgrimes * optval is a pointer to a mbuf-chain pointer, for value-return results. 3341541Srgrimes * The protocol is responsible for disposal of the mbuf chain *optval 3351541Srgrimes * if supplied, 3361541Srgrimes * the caller is responsible for any space held by *optval, when returned. 3371541Srgrimes * A non-zero return from usrreq gives an 3381541Srgrimes * UNIX error number which should be passed to higher level software. 3391541Srgrimes */ 3401541Srgrimes#define PRCO_GETOPT 0 3411541Srgrimes#define PRCO_SETOPT 1 3421541Srgrimes 3431541Srgrimes#define PRCO_NCMDS 2 3441541Srgrimes 3451541Srgrimes#ifdef PRCOREQUESTS 3461541Srgrimeschar *prcorequests[] = { 3471541Srgrimes "GETOPT", "SETOPT", 3481541Srgrimes}; 3491541Srgrimes#endif 3501541Srgrimes 35155205Speter#ifdef _KERNEL 35292719Salfredvoid pfctlinput(int, struct sockaddr *); 35392719Salfredvoid pfctlinput2(int, struct sockaddr *, void *); 35492719Salfredstruct protosw *pffindproto(int family, int protocol, int type); 35592719Salfredstruct protosw *pffindtype(int family, int type); 356136692Sandreint pf_proto_register(int family, struct protosw *npr); 357136692Sandreint pf_proto_unregister(int family, int protocol, int type); 3581541Srgrimes#endif 3592165Spaul 3602165Spaul#endif 361