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$ 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 int pr_output_t (struct mbuf *, struct socket *); 7081501Sjuliantypedef void pr_ctlinput_t (int, struct sockaddr *, void *); 7181501Sjuliantypedef int pr_ctloutput_t (struct socket *, struct sockopt *); 7281501Sjuliantypedef void pr_init_t (void); 73193731Szectypedef void pr_destroy_t (void); 7481501Sjuliantypedef void pr_fasttimo_t (void); 7581501Sjuliantypedef void pr_slowtimo_t (void); 7681501Sjuliantypedef void pr_drain_t (void); 7781501Sjulian 781541Srgrimesstruct protosw { 791541Srgrimes short pr_type; /* socket type used for */ 801541Srgrimes struct domain *pr_domain; /* domain protocol a member of */ 811541Srgrimes short pr_protocol; /* protocol number */ 821541Srgrimes short pr_flags; /* see below */ 831541Srgrimes/* protocol-protocol hooks */ 8481501Sjulian pr_input_t *pr_input; /* input to protocol (from below) */ 8581501Sjulian pr_output_t *pr_output; /* output to protocol (from above) */ 8681501Sjulian pr_ctlinput_t *pr_ctlinput; /* control input (from below) */ 8781501Sjulian pr_ctloutput_t *pr_ctloutput; /* control output (from above) */ 881541Srgrimes/* utility hooks */ 8981501Sjulian pr_init_t *pr_init; 90193731Szec pr_destroy_t *pr_destroy; 9181501Sjulian pr_fasttimo_t *pr_fasttimo; /* fast timeout (200ms) */ 9281501Sjulian pr_slowtimo_t *pr_slowtimo; /* slow timeout (500ms) */ 9381501Sjulian pr_drain_t *pr_drain; /* flush any excess space possible */ 9481501Sjulian 95186809Sbz struct pr_usrreqs *pr_usrreqs; /* user-protocol hook */ 961541Srgrimes}; 9728270Swollman/*#endif*/ 981541Srgrimes 991541Srgrimes#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 1001541Srgrimes#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 1011541Srgrimes 1021541Srgrimes/* 103136692Sandre * This number should be defined again within each protocol family to avoid 104136692Sandre * confusion. 105136692Sandre */ 106136692Sandre#define PROTO_SPACER 32767 /* spacer for loadable protocols */ 107136692Sandre 108136692Sandre/* 1091541Srgrimes * Values for pr_flags. 1101541Srgrimes * PR_ADDR requires PR_ATOMIC; 1111541Srgrimes * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 1126223Swollman * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 1136223Swollman * and the protocol understands the MSG_EOF flag. The first property is 1146223Swollman * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 1156223Swollman * anyhow). 1161541Srgrimes */ 1171541Srgrimes#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 1181541Srgrimes#define PR_ADDR 0x02 /* addresses given with messages */ 1191541Srgrimes#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 1201541Srgrimes#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 1211541Srgrimes#define PR_RIGHTS 0x10 /* passes capabilities */ 1226223Swollman#define PR_IMPLOPCL 0x20 /* implied open/close */ 12378064Sume#define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ 1241541Srgrimes 1251541Srgrimes/* 126159374Srwatson * In earlier BSD network stacks, a single pr_usrreq() function pointer was 127159374Srwatson * invoked with an operation number indicating what operation was desired. 128159374Srwatson * We now provide individual function pointers which protocols can implement, 129159374Srwatson * which offers a number of benefits (such as type checking for arguments). 130159374Srwatson * These older constants are still present in order to support TCP debugging. 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 */ 157160342Srwatson#define PRU_SOSETLABEL 23 /* MAC label change */ 158160342Srwatson#define PRU_CLOSE 24 /* socket close */ 159186809Sbz#define PRU_FLUSH 25 /* flush the socket */ 160186809Sbz#define PRU_NREQ 25 1611541Srgrimes 1621541Srgrimes#ifdef PRUREQUESTS 163101975Salfredconst char *prurequests[] = { 1641541Srgrimes "ATTACH", "DETACH", "BIND", "LISTEN", 1651541Srgrimes "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 1661541Srgrimes "RCVD", "SEND", "ABORT", "CONTROL", 1671541Srgrimes "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 1681541Srgrimes "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 169160342Srwatson "PROTORCV", "PROTOSEND", "SEND_EOF", "SOSETLABEL", 170186809Sbz "CLOSE", "FLUSH", 1711541Srgrimes}; 1721541Srgrimes#endif 1731541Srgrimes 17455205Speter#ifdef _KERNEL /* users shouldn't see this decl */ 17517047Swollman 17632995Sbdestruct ifnet; 17732995Sbdestruct stat; 17832995Sbdestruct ucred; 17932995Sbdestruct uio; 18032995Sbde 1811541Srgrimes/* 182159374Srwatson * If the ordering here looks odd, that's because it's alphabetical. These 183159374Srwatson * should eventually be merged back into struct protosw. 184137386Sphk * 185137386Sphk * Some fields initialized to defaults if they are NULL. 186137386Sphk * See uipc_domain.c:net_init_domain() 18717047Swollman */ 18817047Swollmanstruct pr_usrreqs { 189157366Srwatson void (*pru_abort)(struct socket *so); 19092719Salfred int (*pru_accept)(struct socket *so, struct sockaddr **nam); 19192719Salfred int (*pru_attach)(struct socket *so, int proto, struct thread *td); 19292719Salfred int (*pru_bind)(struct socket *so, struct sockaddr *nam, 19393008Sbde struct thread *td); 19492719Salfred int (*pru_connect)(struct socket *so, struct sockaddr *nam, 19593008Sbde struct thread *td); 19692719Salfred int (*pru_connect2)(struct socket *so1, struct socket *so2); 19792719Salfred int (*pru_control)(struct socket *so, u_long cmd, caddr_t data, 19893008Sbde struct ifnet *ifp, struct thread *td); 199157370Srwatson void (*pru_detach)(struct socket *so); 20092719Salfred int (*pru_disconnect)(struct socket *so); 201151888Srwatson int (*pru_listen)(struct socket *so, int backlog, 202151888Srwatson struct thread *td); 20392719Salfred int (*pru_peeraddr)(struct socket *so, struct sockaddr **nam); 20492719Salfred int (*pru_rcvd)(struct socket *so, int flags); 20592719Salfred int (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags); 206246902Spjd int (*pru_send)(struct socket *so, int flags, struct mbuf *m, 20793008Sbde struct sockaddr *addr, struct mbuf *control, 20893008Sbde struct thread *td); 20917047Swollman#define PRUS_OOB 0x1 21017047Swollman#define PRUS_EOF 0x2 21142902Sfenner#define PRUS_MORETOCOME 0x4 21292719Salfred int (*pru_sense)(struct socket *so, struct stat *sb); 213246954Spjd int (*pru_shutdown)(struct socket *so); 214246902Spjd int (*pru_flush)(struct socket *so, int direction); 21592719Salfred int (*pru_sockaddr)(struct socket *so, struct sockaddr **nam); 21692719Salfred int (*pru_sosend)(struct socket *so, struct sockaddr *addr, 21793008Sbde struct uio *uio, struct mbuf *top, struct mbuf *control, 21893008Sbde int flags, struct thread *td); 21993008Sbde int (*pru_soreceive)(struct socket *so, struct sockaddr **paddr, 22093008Sbde struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 22193008Sbde int *flagsp); 22292719Salfred int (*pru_sopoll)(struct socket *so, int events, 22393008Sbde struct ucred *cred, struct thread *td); 224122875Srwatson void (*pru_sosetlabel)(struct socket *so); 225160342Srwatson void (*pru_close)(struct socket *so); 226247667Spjd int (*pru_bindat)(int fd, struct socket *so, struct sockaddr *nam, 227247667Spjd struct thread *td); 228247667Spjd int (*pru_connectat)(int fd, struct socket *so, 229247667Spjd struct sockaddr *nam, struct thread *td); 23017047Swollman}; 23117047Swollman 232136692Sandre/* 233148965Sobrien * All nonvoid pru_*() functions below return EOPNOTSUPP. 234136692Sandre */ 23592719Salfredint pru_accept_notsupp(struct socket *so, struct sockaddr **nam); 236136692Sandreint pru_attach_notsupp(struct socket *so, int proto, struct thread *td); 237136692Sandreint pru_bind_notsupp(struct socket *so, struct sockaddr *nam, 238136692Sandre struct thread *td); 239247667Spjdint pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam, 240247667Spjd struct thread *td); 24192719Salfredint pru_connect_notsupp(struct socket *so, struct sockaddr *nam, 24293008Sbde struct thread *td); 243247667Spjdint pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam, 244247667Spjd struct thread *td); 24592719Salfredint pru_connect2_notsupp(struct socket *so1, struct socket *so2); 24692719Salfredint pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data, 24793008Sbde struct ifnet *ifp, struct thread *td); 248136692Sandreint pru_disconnect_notsupp(struct socket *so); 249151888Srwatsonint pru_listen_notsupp(struct socket *so, int backlog, struct thread *td); 250136692Sandreint pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam); 25192719Salfredint pru_rcvd_notsupp(struct socket *so, int flags); 25292719Salfredint pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags); 253136692Sandreint pru_send_notsupp(struct socket *so, int flags, struct mbuf *m, 254136692Sandre struct sockaddr *addr, struct mbuf *control, struct thread *td); 25592719Salfredint pru_sense_null(struct socket *so, struct stat *sb); 256136692Sandreint pru_shutdown_notsupp(struct socket *so); 257136692Sandreint pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam); 258136692Sandreint pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, 259136692Sandre struct uio *uio, struct mbuf *top, struct mbuf *control, int flags, 260136692Sandre struct thread *td); 261136692Sandreint pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr, 262136692Sandre struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 263136692Sandre int *flagsp); 264136692Sandreint pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred, 265136692Sandre struct thread *td); 26617096Swollman 26755205Speter#endif /* _KERNEL */ 26817047Swollman 26917047Swollman/* 2701541Srgrimes * The arguments to the ctlinput routine are 2711541Srgrimes * (*protosw[].pr_ctlinput)(cmd, sa, arg); 2721541Srgrimes * where cmd is one of the commands below, sa is a pointer to a sockaddr, 27312881Sbde * and arg is a `void *' argument used within a protocol family. 2741541Srgrimes */ 2751541Srgrimes#define PRC_IFDOWN 0 /* interface transition */ 2761541Srgrimes#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 277246954Spjd#define PRC_IFUP 2 /* interface has come back up */ 2781541Srgrimes#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 2791541Srgrimes#define PRC_QUENCH 4 /* some one said to slow down */ 2801541Srgrimes#define PRC_MSGSIZE 5 /* message size forced drop */ 2811541Srgrimes#define PRC_HOSTDEAD 6 /* host appears to be down */ 2821541Srgrimes#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 2831541Srgrimes#define PRC_UNREACH_NET 8 /* no route to network */ 2841541Srgrimes#define PRC_UNREACH_HOST 9 /* no route to host */ 2851541Srgrimes#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 2861541Srgrimes#define PRC_UNREACH_PORT 11 /* bad port # */ 2871541Srgrimes/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 2881541Srgrimes#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 2891541Srgrimes#define PRC_REDIRECT_NET 14 /* net routing redirect */ 2901541Srgrimes#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 2911541Srgrimes#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 2921541Srgrimes#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 2931541Srgrimes#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 2941541Srgrimes#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 2951541Srgrimes#define PRC_PARAMPROB 20 /* header incorrect */ 29672638Sphk#define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ 2971541Srgrimes 29872638Sphk#define PRC_NCMDS 22 2991541Srgrimes 3001541Srgrimes#define PRC_IS_REDIRECT(cmd) \ 3011541Srgrimes ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 3021541Srgrimes 3031541Srgrimes#ifdef PRCREQUESTS 3041541Srgrimeschar *prcrequests[] = { 30522614Swollman "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 3061541Srgrimes "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 3071541Srgrimes "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 3081541Srgrimes "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 3091541Srgrimes "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 31072638Sphk "PARAMPROB", "ADMIN-UNREACH" 3111541Srgrimes}; 3121541Srgrimes#endif 3131541Srgrimes 3141541Srgrimes/* 3151541Srgrimes * The arguments to ctloutput are: 31625201Swollman * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 3171541Srgrimes * req is one of the actions listed below, so is a (struct socket *), 3181541Srgrimes * level is an indication of which protocol layer the option is intended. 3191541Srgrimes * optname is a protocol dependent socket option request, 3201541Srgrimes * optval is a pointer to a mbuf-chain pointer, for value-return results. 3211541Srgrimes * The protocol is responsible for disposal of the mbuf chain *optval 3221541Srgrimes * if supplied, 3231541Srgrimes * the caller is responsible for any space held by *optval, when returned. 324186809Sbz * A non-zero return from ctloutput gives an 3251541Srgrimes * UNIX error number which should be passed to higher level software. 3261541Srgrimes */ 3271541Srgrimes#define PRCO_GETOPT 0 3281541Srgrimes#define PRCO_SETOPT 1 3291541Srgrimes 3301541Srgrimes#define PRCO_NCMDS 2 3311541Srgrimes 3321541Srgrimes#ifdef PRCOREQUESTS 3331541Srgrimeschar *prcorequests[] = { 3341541Srgrimes "GETOPT", "SETOPT", 3351541Srgrimes}; 3361541Srgrimes#endif 3371541Srgrimes 33855205Speter#ifdef _KERNEL 33992719Salfredvoid pfctlinput(int, struct sockaddr *); 34092719Salfredvoid pfctlinput2(int, struct sockaddr *, void *); 341243965Skevlostruct domain *pffinddomain(int family); 34292719Salfredstruct protosw *pffindproto(int family, int protocol, int type); 34392719Salfredstruct protosw *pffindtype(int family, int type); 344136692Sandreint pf_proto_register(int family, struct protosw *npr); 345136692Sandreint pf_proto_unregister(int family, int protocol, int type); 3461541Srgrimes#endif 3472165Spaul 3482165Spaul#endif 349