/*- * Copyright (c) 1982, 1986, 1993 * The Regents of the University of California. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. Neither the name of the University nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * * @(#)protosw.h 8.1 (Berkeley) 6/2/93 * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $ */ #ifndef _SYS_PROTOSW_H_ #define _SYS_PROTOSW_H_ #ifndef _SYS_TYPES_H_ #include <sys/types.h> #endif /* Forward declare these structures referenced from prototypes below. */ struct mbuf; struct thread; struct sockaddr; struct socket; struct sockopt; struct pr_output_info { pid_t p_pid; }; #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) /* * netmsg_t union of possible netmsgs typically sent to protocol threads. */ typedef union netmsg *netmsg_t; /* * Protocol switch table. * * Each protocol has a handle initializing one of these structures, * which is used for protocol-protocol and system-protocol communication. * * A protocol is called through the pr_init entry before any other. * The system will call the pr_drain entry if it is low on space and this * should throw away any non-critical data. * * Protocols pass data between themselves as chains of mbufs using * the pr_input and pr_output hooks. Pr_input passes data up (towards * the users) and pr_output passes it down (towards the interfaces); control * information passes up and down on pr_ctlinput and pr_ctloutput. * The protocol is responsible for the space occupied by any the * arguments to these entries and must dispose it. * * In retrospect, it would be a lot nicer to use an interface * similar to the vnode VOP interface. */ struct protosw { short pr_type; /* socket type used for */ const struct domain *pr_domain; /* domain protocol a member of */ short pr_protocol; /* protocol number */ short pr_flags; /* see below */ struct lwkt_port *(*pr_initport)(void); /* initial msgport */ /* * Protocol hooks. These are typically called directly within the * context of a protocol thread based on the toeplitz hash. * * pr_input() is called using the port supplied by the toeplitz * hash via the netisr port function. * * pr_ctlinput() is called using the port supplied by pr_ctlport * * pr_ctloutput() and pr_output() are typically called */ int (*pr_input)(struct mbuf **, int *, int); /* input to protocol (from below) */ int (*pr_output)(struct mbuf *, struct socket *, ...); /* output to protocol (from above) */ void (*pr_ctlinput)(netmsg_t); /* control input (from below) */ struct netmsg_pr_ctloutput *(*pr_ctloutmsg)(struct sockopt *); /* allocate netmsg for ctloutput */ void (*pr_ctloutput)(netmsg_t); /* control output (from above) */ struct lwkt_port *(*pr_ctlport)(int, struct sockaddr *, void *, int *); /* * Utility hooks, not called with any particular context. */ void (*pr_init) (void); /* initialization hook */ void (*pr_drain) (void); /* flush any excess space possible */ struct pr_usrreqs *pr_usrreqs; /* messaged requests to proto thread */ }; #endif #define PR_SLOWHZ 2 /* 2 slow timeouts per second */ #define PR_FASTHZ 5 /* 5 fast timeouts per second */ /* * Values for pr_flags. * PR_ADDR requires PR_ATOMIC; * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. * PR_IMPLOPCL means that the protocol allows sendto without prior connect, * and the protocol understands the MSG_EOF flag. The first property is * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed * anyhow). */ #define PR_ATOMIC 0x01 /* exchange atomic messages only */ #define PR_ADDR 0x02 /* addresses given with messages */ #define PR_CONNREQUIRED 0x04 /* connection required by protocol */ #define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ #define PR_RIGHTS 0x10 /* passes capabilities */ #define PR_IMPLOPCL 0x20 /* implied open/close */ #define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ #define PR_UNUSED07 0x80 /* was: allow addresses during delivery (SCTP) */ #define PR_MPSAFE 0x0100 /* protocal is MPSAFE */ #define PR_SYNC_PORT 0x0200 /* synchronous port (no proto thrds) */ #define PR_ASYNC_SEND 0x0400 /* async pru_send */ #define PR_ASYNC_RCVD 0x0800 /* async pru_rcvd */ #define PR_ASEND_HOLDTD 0x1000 /* async pru_send hold orig thread */ #define PR_ACONN_HOLDTD 0x2000 /* async pru_connect hold orig thread */ /* * The arguments to usrreq are: * (*protosw[].pr_usrreq)(up, req, m, nam, opt); * where up is a (struct socket *), req is one of these requests, * m is a optional mbuf chain containing a message, * nam is an optional mbuf chain containing an address, * and opt is a pointer to a socketopt structure or nil. * The protocol is responsible for disposal of the mbuf chain m, * the caller is responsible for any space held by nam and opt. * A non-zero return from usrreq gives an * UNIX error number which should be passed to higher level software. */ #define PRU_ATTACH 0 /* attach protocol to up */ #define PRU_DETACH 1 /* detach protocol from up */ #define PRU_BIND 2 /* bind socket to address */ #define PRU_LISTEN 3 /* listen for connection */ #define PRU_CONNECT 4 /* establish connection to peer */ #define PRU_ACCEPT 5 /* accept connection from peer */ #define PRU_DISCONNECT 6 /* disconnect from peer */ #define PRU_SHUTDOWN 7 /* won't send any more data */ #define PRU_RCVD 8 /* have taken data; more room now */ #define PRU_SEND 9 /* send this data */ #define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ #define PRU_CONTROL 11 /* control operations on protocol */ #define PRU_SENSE 12 /* return status into m */ #define PRU_RCVOOB 13 /* retrieve out of band data */ #define PRU_SENDOOB 14 /* send out of band data */ #define PRU_SOCKADDR 15 /* fetch socket's address */ #define PRU_PEERADDR 16 /* fetch peer's address */ #define PRU_CONNECT2 17 /* connect two sockets */ #define PRU_RESERVED1 18 /* formerly PRU_SOPOLL */ /* begin for protocols internal use */ #define PRU_FASTTIMO 19 /* 200ms timeout */ #define PRU_SLOWTIMO 20 /* 500ms timeout */ #define PRU_PROTORCV 21 /* receive from below */ #define PRU_PROTOSEND 22 /* send to below */ /* end for protocol's internal use */ #define PRU_SEND_EOF 23 /* send and close */ #define PRU_PRED 24 #define PRU_CTLOUTPUT 25 /* get/set opts */ #define PRU_NREQ 26 #ifdef PRUREQUESTS const char *prurequests[] = { "ATTACH", "DETACH", "BIND", "LISTEN", "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", "RCVD", "SEND", "ABORT", "CONTROL", "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", "PEERADDR", "CONNECT2", "", "FASTTIMO", "SLOWTIMO", "PROTORCV", "PROTOSEND", "SEND_EOF", "PREDICATE" }; #endif #if defined(_KERNEL) || defined(_KERNEL_STRUCTURES) struct ifnet; struct stat; struct ucred; struct uio; struct sockbuf; struct pru_attach_info { struct rlimit *sb_rlimit; struct ucred *p_ucred; struct vnode *fd_rdir; }; /* * These are netmsg'd requests almost universally in the context of the * appropriate protocol thread. Exceptions: * * pru_sosend() - called synchronously from user context, typically * runs generic kernel code and then messages via * pru_send(). * * pru_soreceive() - called synchronously from user context. Typically * runs generic kernel code and remains synchronous. * * pru_preconnect() - called synchronously from user context. Typically * prepares for later asynchronous pru_connect, e.g. * sets ISCONNECTING. Non-NULL means asynchronous * pru_connect is supported. */ struct pr_usrreqs { void (*pru_abort) (netmsg_t msg); void (*pru_accept) (netmsg_t msg); void (*pru_attach) (netmsg_t msg); void (*pru_bind) (netmsg_t msg); void (*pru_connect) (netmsg_t msg); void (*pru_connect2) (netmsg_t msg); void (*pru_control) (netmsg_t msg); /* * If pru_detach() returns EJUSTRETURN, then protocol will * call sodiscard() and sofree() for soclose(). */ void (*pru_detach) (netmsg_t msg); void (*pru_disconnect) (netmsg_t msg); void (*pru_listen) (netmsg_t msg); void (*pru_peeraddr) (netmsg_t msg); void (*pru_rcvd) (netmsg_t msg); void (*pru_rcvoob) (netmsg_t msg); void (*pru_send) (netmsg_t msg); void (*pru_sense) (netmsg_t msg); void (*pru_shutdown) (netmsg_t msg); void (*pru_sockaddr) (netmsg_t msg); /* * These are direct calls. Note that sosend() will sometimes * be converted into an implied connect (pru_connect) with the * mbufs and flags forwarded in pru_connect's netmsg. It is * otherwise typically converted to a send (pru_send). * * soreceive() typically remains synchronous in the user's context. * * Any converted calls are netmsg's to the socket's protocol thread. */ int (*pru_sosend) (struct socket *so, struct sockaddr *addr, struct uio *uio, struct mbuf *top, struct mbuf *control, int flags, struct thread *td); int (*pru_soreceive) (struct socket *so, struct sockaddr **paddr, struct uio *uio, struct sockbuf *sio, struct mbuf **controlp, int *flagsp); /* * Synchronously called by protocol thread. Typically save the * foreign address into socket.so_faddr. */ void (*pru_savefaddr) (struct socket *so, const struct sockaddr *addr); /* synchronously called by user thread. */ int (*pru_preconnect) (struct socket *so, const struct sockaddr *addr, struct thread *td); int (*pru_preattach) (struct socket *so, int, struct pru_attach_info *); }; typedef int (*pru_sosend_fn_t) (struct socket *so, struct sockaddr *addr, struct uio *uio, struct mbuf *top, struct mbuf *control, int flags, struct thread *td); typedef int (*pru_soreceive_fn_t) (struct socket *so, struct sockaddr **paddr, struct uio *uio, struct sockbuf *sio, struct mbuf **controlp, int *flagsp); void pr_generic_notsupp(netmsg_t msg); void pru_sense_null(netmsg_t msg); int pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, struct uio *uio, struct mbuf *top, struct mbuf *control, int flags, struct thread *td); int pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr, struct uio *uio, struct sockbuf *sio, struct mbuf **controlp, int *flagsp); struct lwkt_port *cpu0_soport(struct socket *, struct sockaddr *, struct mbuf **); struct lwkt_port *cpu0_ctlport(int, struct sockaddr *, void *, int *); #endif /* _KERNEL || _KERNEL_STRUCTURES */ /* * The arguments to the ctlinput routine are * (*protosw[].pr_ctlinput)(cmd, sa, arg); * where cmd is one of the commands below, sa is a pointer to a sockaddr, * and arg is a `void *' argument used within a protocol family. */ #define PRC_IFDOWN 0 /* interface transition */ #define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ #define PRC_IFUP 2 /* interface has come back up */ #define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ #define PRC_QUENCH 4 /* some one said to slow down */ #define PRC_MSGSIZE 5 /* message size forced drop */ #define PRC_HOSTDEAD 6 /* host appears to be down */ #define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ #define PRC_UNREACH_NET 8 /* no route to network */ #define PRC_UNREACH_HOST 9 /* no route to host */ #define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ #define PRC_UNREACH_PORT 11 /* bad port # */ /* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ #define PRC_UNREACH_SRCFAIL 13 /* source route failed */ #define PRC_REDIRECT_NET 14 /* net routing redirect */ #define PRC_REDIRECT_HOST 15 /* host routing redirect */ #define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ #define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ #define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ #define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ #define PRC_PARAMPROB 20 /* header incorrect */ #define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ #define PRC_NCMDS 22 #define PRC_IS_REDIRECT(cmd) \ ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) #ifdef PRCREQUESTS const char *prcrequests[] = { "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", "PARAMPROB", "ADMIN-UNREACH" }; #endif /* * The arguments to ctloutput are: * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); * req is one of the actions listed below, so is a (struct socket *), * level is an indication of which protocol layer the option is intended. * optname is a protocol dependent socket option request, * optval is a pointer to a mbuf-chain pointer, for value-return results. * The protocol is responsible for disposal of the mbuf chain *optval * if supplied, * the caller is responsible for any space held by *optval, when returned. * A non-zero return from usrreq gives an * UNIX error number which should be passed to higher level software. */ #define PRCO_GETOPT 0 #define PRCO_SETOPT 1 #define PRCO_NCMDS 2 #ifdef PRCOREQUESTS const char *prcorequests[] = { "GETOPT", "SETOPT", }; #endif /* * Kernel prototypes */ #ifdef _KERNEL void kpfctlinput (int, struct sockaddr *); void kpfctlinput_direct (int, struct sockaddr *); void kpfctlinput2 (int, struct sockaddr *, void *); struct protosw *pffindproto (int family, int protocol, int type); struct protosw *pffindtype (int family, int type); #define PR_GET_MPLOCK(_pr) \ do { \ if (((_pr)->pr_flags & PR_MPSAFE) == 0) \ get_mplock(); \ } while (0) #define PR_REL_MPLOCK(_pr) \ do { \ if (((_pr)->pr_flags & PR_MPSAFE) == 0) \ rel_mplock(); \ } while (0) #endif /* _KERNEL */ #endif /* _SYS_PROTOSW_H_ */
