protosw.h revision 92719
1/*- 2 * Copyright (c) 1982, 1986, 1993 3 * The Regents of the University of California. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. All advertising materials mentioning features or use of this software 14 * must display the following acknowledgement: 15 * This product includes software developed by the University of 16 * California, Berkeley and its contributors. 17 * 4. Neither the name of the University nor the names of its contributors 18 * may be used to endorse or promote products derived from this software 19 * without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 25 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 29 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 30 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * @(#)protosw.h 8.1 (Berkeley) 6/2/93 34 * $FreeBSD: head/sys/sys/protosw.h 92719 2002-03-19 20:18:42Z alfred $ 35 */ 36 37#ifndef _SYS_PROTOSW_H_ 38#define _SYS_PROTOSW_H_ 39 40/* 41 * For pfil_head structure. 42 */ 43#include <net/pfil.h> 44 45/* Forward declare these structures referenced from prototypes below. */ 46struct mbuf; 47struct thread; 48struct sockaddr; 49struct socket; 50struct sockopt; 51 52/*#ifdef _KERNEL*/ 53/* 54 * Protocol switch table. 55 * 56 * Each protocol has a handle initializing one of these structures, 57 * which is used for protocol-protocol and system-protocol communication. 58 * 59 * A protocol is called through the pr_init entry before any other. 60 * Thereafter it is called every 200ms through the pr_fasttimo entry and 61 * every 500ms through the pr_slowtimo for timer based actions. 62 * The system will call the pr_drain entry if it is low on space and 63 * this should throw away any non-critical data. 64 * 65 * Protocols pass data between themselves as chains of mbufs using 66 * the pr_input and pr_output hooks. Pr_input passes data up (towards 67 * the users) and pr_output passes it down (towards the interfaces); control 68 * information passes up and down on pr_ctlinput and pr_ctloutput. 69 * The protocol is responsible for the space occupied by any the 70 * arguments to these entries and must dispose it. 71 * 72 * In retrospect, it would be a lot nicer to use an interface 73 * similar to the vnode VOP interface. 74 */ 75/* USE THESE FOR YOUR PROTOTYPES ! */ 76typedef void pr_input_t (struct mbuf *, int); 77typedef int pr_input6_t (struct mbuf **, int*, int); /* XXX FIX THIS */ 78typedef void pr_in_input_t (struct mbuf *, int, int); /* XXX FIX THIS */ 79typedef int pr_output_t (struct mbuf *, struct socket *); 80typedef int pr_in_output_t (struct mbuf *, struct socket *, struct sockaddr *); 81typedef void pr_ctlinput_t (int, struct sockaddr *, void *); 82typedef int pr_ctloutput_t (struct socket *, struct sockopt *); 83typedef void pr_init_t (void); 84typedef void pr_fasttimo_t (void); 85typedef void pr_slowtimo_t (void); 86typedef void pr_drain_t (void); 87 88typedef int pr_usrreq_t(struct socket *, int, struct mbuf *, 89 struct mbuf *, struct mbuf *, struct thread *); 90 91struct protosw { 92 short pr_type; /* socket type used for */ 93 struct domain *pr_domain; /* domain protocol a member of */ 94 short pr_protocol; /* protocol number */ 95 short pr_flags; /* see below */ 96/* protocol-protocol hooks */ 97 pr_input_t *pr_input; /* input to protocol (from below) */ 98 pr_output_t *pr_output; /* output to protocol (from above) */ 99 pr_ctlinput_t *pr_ctlinput; /* control input (from below) */ 100 pr_ctloutput_t *pr_ctloutput; /* control output (from above) */ 101/* user-protocol hook */ 102 pr_usrreq_t *pr_ousrreq; 103/* utility hooks */ 104 pr_init_t *pr_init; 105 pr_fasttimo_t *pr_fasttimo; /* fast timeout (200ms) */ 106 pr_slowtimo_t *pr_slowtimo; /* slow timeout (500ms) */ 107 pr_drain_t *pr_drain; /* flush any excess space possible */ 108 109 struct pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */ 110 struct pfil_head pr_pfh; 111}; 112/*#endif*/ 113 114#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 115#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 116 117/* 118 * Values for pr_flags. 119 * PR_ADDR requires PR_ATOMIC; 120 * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 121 * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 122 * and the protocol understands the MSG_EOF flag. The first property is 123 * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 124 * anyhow). 125 */ 126#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 127#define PR_ADDR 0x02 /* addresses given with messages */ 128#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 129#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 130#define PR_RIGHTS 0x10 /* passes capabilities */ 131#define PR_IMPLOPCL 0x20 /* implied open/close */ 132#define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ 133 134/* 135 * The arguments to usrreq are: 136 * (*protosw[].pr_usrreq)(up, req, m, nam, opt); 137 * where up is a (struct socket *), req is one of these requests, 138 * m is a optional mbuf chain containing a message, 139 * nam is an optional mbuf chain containing an address, 140 * and opt is a pointer to a socketopt structure or nil. 141 * The protocol is responsible for disposal of the mbuf chain m, 142 * the caller is responsible for any space held by nam and opt. 143 * A non-zero return from usrreq gives an 144 * UNIX error number which should be passed to higher level software. 145 */ 146#define PRU_ATTACH 0 /* attach protocol to up */ 147#define PRU_DETACH 1 /* detach protocol from up */ 148#define PRU_BIND 2 /* bind socket to address */ 149#define PRU_LISTEN 3 /* listen for connection */ 150#define PRU_CONNECT 4 /* establish connection to peer */ 151#define PRU_ACCEPT 5 /* accept connection from peer */ 152#define PRU_DISCONNECT 6 /* disconnect from peer */ 153#define PRU_SHUTDOWN 7 /* won't send any more data */ 154#define PRU_RCVD 8 /* have taken data; more room now */ 155#define PRU_SEND 9 /* send this data */ 156#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 157#define PRU_CONTROL 11 /* control operations on protocol */ 158#define PRU_SENSE 12 /* return status into m */ 159#define PRU_RCVOOB 13 /* retrieve out of band data */ 160#define PRU_SENDOOB 14 /* send out of band data */ 161#define PRU_SOCKADDR 15 /* fetch socket's address */ 162#define PRU_PEERADDR 16 /* fetch peer's address */ 163#define PRU_CONNECT2 17 /* connect two sockets */ 164/* begin for protocols internal use */ 165#define PRU_FASTTIMO 18 /* 200ms timeout */ 166#define PRU_SLOWTIMO 19 /* 500ms timeout */ 167#define PRU_PROTORCV 20 /* receive from below */ 168#define PRU_PROTOSEND 21 /* send to below */ 169/* end for protocol's internal use */ 170#define PRU_SEND_EOF 22 /* send and close */ 171#define PRU_NREQ 22 172 173#ifdef PRUREQUESTS 174char *prurequests[] = { 175 "ATTACH", "DETACH", "BIND", "LISTEN", 176 "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 177 "RCVD", "SEND", "ABORT", "CONTROL", 178 "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 179 "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 180 "PROTORCV", "PROTOSEND", 181 "SEND_EOF", 182}; 183#endif 184 185#ifdef _KERNEL /* users shouldn't see this decl */ 186 187struct ifnet; 188struct stat; 189struct ucred; 190struct uio; 191 192/* 193 * If the ordering here looks odd, that's because it's alphabetical. 194 * Having this structure separated out from the main protoswitch is allegedly 195 * a big (12 cycles per call) lose on high-end CPUs. We will eventually 196 * migrate this stuff back into the main structure. 197 */ 198struct pr_usrreqs { 199 int (*pru_abort)(struct socket *so); 200 int (*pru_accept)(struct socket *so, struct sockaddr **nam); 201 int (*pru_attach)(struct socket *so, int proto, struct thread *td); 202 int (*pru_bind)(struct socket *so, struct sockaddr *nam, 203 struct thread *td); 204 int (*pru_connect)(struct socket *so, struct sockaddr *nam, 205 struct thread *td); 206 int (*pru_connect2)(struct socket *so1, struct socket *so2); 207 int (*pru_control)(struct socket *so, u_long cmd, caddr_t data, 208 struct ifnet *ifp, struct thread *td); 209 int (*pru_detach)(struct socket *so); 210 int (*pru_disconnect)(struct socket *so); 211 int (*pru_listen)(struct socket *so, struct thread *td); 212 int (*pru_peeraddr)(struct socket *so, struct sockaddr **nam); 213 int (*pru_rcvd)(struct socket *so, int flags); 214 int (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags); 215 int (*pru_send)(struct socket *so, int flags, struct mbuf *m, 216 struct sockaddr *addr, struct mbuf *control, 217 struct thread *td); 218#define PRUS_OOB 0x1 219#define PRUS_EOF 0x2 220#define PRUS_MORETOCOME 0x4 221 int (*pru_sense)(struct socket *so, struct stat *sb); 222 int (*pru_shutdown)(struct socket *so); 223 int (*pru_sockaddr)(struct socket *so, struct sockaddr **nam); 224 225 /* 226 * These three added later, so they are out of order. They are used 227 * for shortcutting (fast path input/output) in some protocols. 228 * XXX - that's a lie, they are not implemented yet 229 * Rather than calling sosend() etc. directly, calls are made 230 * through these entry points. For protocols which still use 231 * the generic code, these just point to those routines. 232 */ 233 int (*pru_sosend)(struct socket *so, struct sockaddr *addr, 234 struct uio *uio, struct mbuf *top, 235 struct mbuf *control, int flags, 236 struct thread *td); 237 int (*pru_soreceive)(struct socket *so, 238 struct sockaddr **paddr, 239 struct uio *uio, struct mbuf **mp0, 240 struct mbuf **controlp, int *flagsp); 241 int (*pru_sopoll)(struct socket *so, int events, 242 struct ucred *cred, struct thread *td); 243}; 244 245int pru_accept_notsupp(struct socket *so, struct sockaddr **nam); 246int pru_connect_notsupp(struct socket *so, struct sockaddr *nam, 247 struct thread *td); 248int pru_connect2_notsupp(struct socket *so1, struct socket *so2); 249int pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data, 250 struct ifnet *ifp, struct thread *td); 251int pru_listen_notsupp(struct socket *so, struct thread *td); 252int pru_rcvd_notsupp(struct socket *so, int flags); 253int pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags); 254int pru_sense_null(struct socket *so, struct stat *sb); 255 256#endif /* _KERNEL */ 257 258/* 259 * The arguments to the ctlinput routine are 260 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 261 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 262 * and arg is a `void *' argument used within a protocol family. 263 */ 264#define PRC_IFDOWN 0 /* interface transition */ 265#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 266#define PRC_IFUP 2 /* interface has come back up */ 267#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 268#define PRC_QUENCH 4 /* some one said to slow down */ 269#define PRC_MSGSIZE 5 /* message size forced drop */ 270#define PRC_HOSTDEAD 6 /* host appears to be down */ 271#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 272#define PRC_UNREACH_NET 8 /* no route to network */ 273#define PRC_UNREACH_HOST 9 /* no route to host */ 274#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 275#define PRC_UNREACH_PORT 11 /* bad port # */ 276/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 277#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 278#define PRC_REDIRECT_NET 14 /* net routing redirect */ 279#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 280#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 281#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 282#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 283#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 284#define PRC_PARAMPROB 20 /* header incorrect */ 285#define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ 286 287#define PRC_NCMDS 22 288 289#define PRC_IS_REDIRECT(cmd) \ 290 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 291 292#ifdef PRCREQUESTS 293char *prcrequests[] = { 294 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 295 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 296 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 297 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 298 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 299 "PARAMPROB", "ADMIN-UNREACH" 300}; 301#endif 302 303/* 304 * The arguments to ctloutput are: 305 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 306 * req is one of the actions listed below, so is a (struct socket *), 307 * level is an indication of which protocol layer the option is intended. 308 * optname is a protocol dependent socket option request, 309 * optval is a pointer to a mbuf-chain pointer, for value-return results. 310 * The protocol is responsible for disposal of the mbuf chain *optval 311 * if supplied, 312 * the caller is responsible for any space held by *optval, when returned. 313 * A non-zero return from usrreq gives an 314 * UNIX error number which should be passed to higher level software. 315 */ 316#define PRCO_GETOPT 0 317#define PRCO_SETOPT 1 318 319#define PRCO_NCMDS 2 320 321#ifdef PRCOREQUESTS 322char *prcorequests[] = { 323 "GETOPT", "SETOPT", 324}; 325#endif 326 327#ifdef _KERNEL 328void pfctlinput(int, struct sockaddr *); 329void pfctlinput2(int, struct sockaddr *, void *); 330struct protosw *pffindproto(int family, int protocol, int type); 331struct protosw *pffindtype(int family, int type); 332#endif 333 334#endif 335