protosw.h revision 272461
115396Spsadhukhan/*- 215396Spsadhukhan * Copyright (c) 1982, 1986, 1993 315396Spsadhukhan * The Regents of the University of California. All rights reserved. 415396Spsadhukhan * 515396Spsadhukhan * Redistribution and use in source and binary forms, with or without 615396Spsadhukhan * modification, are permitted provided that the following conditions 715396Spsadhukhan * are met: 815396Spsadhukhan * 1. Redistributions of source code must retain the above copyright 915396Spsadhukhan * notice, this list of conditions and the following disclaimer. 1015396Spsadhukhan * 2. Redistributions in binary form must reproduce the above copyright 1115396Spsadhukhan * notice, this list of conditions and the following disclaimer in the 1215396Spsadhukhan * documentation and/or other materials provided with the distribution. 1315396Spsadhukhan * 4. Neither the name of the University nor the names of its contributors 1415396Spsadhukhan * may be used to endorse or promote products derived from this software 1515396Spsadhukhan * without specific prior written permission. 1615396Spsadhukhan * 1715396Spsadhukhan * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 1815396Spsadhukhan * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1915396Spsadhukhan * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 2015396Spsadhukhan * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 2115396Spsadhukhan * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 2215396Spsadhukhan * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 2315396Spsadhukhan * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 2415396Spsadhukhan * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2515512Spsadhukhan * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2615396Spsadhukhan * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2715396Spsadhukhan * SUCH DAMAGE. 2815396Spsadhukhan * 2915396Spsadhukhan * @(#)protosw.h 8.1 (Berkeley) 6/2/93 3015396Spsadhukhan * $FreeBSD: releng/10.1/sys/sys/protosw.h 247667 2013-03-02 21:11:30Z pjd $ 3115396Spsadhukhan */ 3215512Spsadhukhan 3315512Spsadhukhan#ifndef _SYS_PROTOSW_H_ 3415396Spsadhukhan#define _SYS_PROTOSW_H_ 3515396Spsadhukhan 3615396Spsadhukhan/* Forward declare these structures referenced from prototypes below. */ 3715396Spsadhukhanstruct mbuf; 3815396Spsadhukhanstruct thread; 3915396Spsadhukhanstruct sockaddr; 4015396Spsadhukhanstruct socket; 4115396Spsadhukhanstruct sockopt; 4215396Spsadhukhan 4315396Spsadhukhan/*#ifdef _KERNEL*/ 4415396Spsadhukhan/* 4515396Spsadhukhan * Protocol switch table. 4615396Spsadhukhan * 4715396Spsadhukhan * Each protocol has a handle initializing one of these structures, 4815396Spsadhukhan * which is used for protocol-protocol and system-protocol communication. 4915396Spsadhukhan * 5015396Spsadhukhan * A protocol is called through the pr_init entry before any other. 5115396Spsadhukhan * Thereafter it is called every 200ms through the pr_fasttimo entry and 5215396Spsadhukhan * every 500ms through the pr_slowtimo for timer based actions. 5315396Spsadhukhan * The system will call the pr_drain entry if it is low on space and 5415396Spsadhukhan * this should throw away any non-critical data. 5515396Spsadhukhan * 5615396Spsadhukhan * Protocols pass data between themselves as chains of mbufs using 5715396Spsadhukhan * the pr_input and pr_output hooks. Pr_input passes data up (towards 5815396Spsadhukhan * the users) and pr_output passes it down (towards the interfaces); control 5915396Spsadhukhan * information passes up and down on pr_ctlinput and pr_ctloutput. 6015396Spsadhukhan * The protocol is responsible for the space occupied by any the 6115396Spsadhukhan * arguments to these entries and must dispose it. 6215396Spsadhukhan * 6315396Spsadhukhan * In retrospect, it would be a lot nicer to use an interface 6415396Spsadhukhan * similar to the vnode VOP interface. 6515396Spsadhukhan */ 6615396Spsadhukhan/* USE THESE FOR YOUR PROTOTYPES ! */ 6715396Spsadhukhantypedef void pr_input_t (struct mbuf *, int); 6815396Spsadhukhantypedef int pr_input6_t (struct mbuf **, int*, int); /* XXX FIX THIS */ 6915396Spsadhukhantypedef int pr_output_t (struct mbuf *, struct socket *); 7015396Spsadhukhantypedef void pr_ctlinput_t (int, struct sockaddr *, void *); 7115396Spsadhukhantypedef int pr_ctloutput_t (struct socket *, struct sockopt *); 7215396Spsadhukhantypedef void pr_init_t (void); 7315396Spsadhukhantypedef void pr_destroy_t (void); 7415396Spsadhukhantypedef void pr_fasttimo_t (void); 7515396Spsadhukhantypedef void pr_slowtimo_t (void); 7615396Spsadhukhantypedef void pr_drain_t (void); 7715396Spsadhukhan 7815396Spsadhukhanstruct protosw { 7915396Spsadhukhan short pr_type; /* socket type used for */ 8015396Spsadhukhan struct domain *pr_domain; /* domain protocol a member of */ 8115396Spsadhukhan short pr_protocol; /* protocol number */ 8215396Spsadhukhan short pr_flags; /* see below */ 8315396Spsadhukhan/* protocol-protocol hooks */ 8415396Spsadhukhan pr_input_t *pr_input; /* input to protocol (from below) */ 8515396Spsadhukhan pr_output_t *pr_output; /* output to protocol (from above) */ 8615396Spsadhukhan pr_ctlinput_t *pr_ctlinput; /* control input (from below) */ 8715396Spsadhukhan pr_ctloutput_t *pr_ctloutput; /* control output (from above) */ 8815396Spsadhukhan/* utility hooks */ 8915396Spsadhukhan pr_init_t *pr_init; 9015396Spsadhukhan pr_destroy_t *pr_destroy; 9115396Spsadhukhan pr_fasttimo_t *pr_fasttimo; /* fast timeout (200ms) */ 9215396Spsadhukhan pr_slowtimo_t *pr_slowtimo; /* slow timeout (500ms) */ 9315396Spsadhukhan pr_drain_t *pr_drain; /* flush any excess space possible */ 9415396Spsadhukhan 9515396Spsadhukhan struct pr_usrreqs *pr_usrreqs; /* user-protocol hook */ 9615396Spsadhukhan}; 9715396Spsadhukhan/*#endif*/ 9815396Spsadhukhan 9915396Spsadhukhan#define PR_SLOWHZ 2 /* 2 slow timeouts per second */ 10015396Spsadhukhan#define PR_FASTHZ 5 /* 5 fast timeouts per second */ 10115396Spsadhukhan 10215396Spsadhukhan/* 10315396Spsadhukhan * This number should be defined again within each protocol family to avoid 10415396Spsadhukhan * confusion. 10515396Spsadhukhan */ 10615396Spsadhukhan#define PROTO_SPACER 32767 /* spacer for loadable protocols */ 10715396Spsadhukhan 10815396Spsadhukhan/* 10915396Spsadhukhan * Values for pr_flags. 11015396Spsadhukhan * PR_ADDR requires PR_ATOMIC; 11115396Spsadhukhan * PR_ADDR and PR_CONNREQUIRED are mutually exclusive. 11215396Spsadhukhan * PR_IMPLOPCL means that the protocol allows sendto without prior connect, 11315396Spsadhukhan * and the protocol understands the MSG_EOF flag. The first property is 11415396Spsadhukhan * is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed 11515396Spsadhukhan * anyhow). 11615396Spsadhukhan */ 11715396Spsadhukhan#define PR_ATOMIC 0x01 /* exchange atomic messages only */ 11815396Spsadhukhan#define PR_ADDR 0x02 /* addresses given with messages */ 11915396Spsadhukhan#define PR_CONNREQUIRED 0x04 /* connection required by protocol */ 12015396Spsadhukhan#define PR_WANTRCVD 0x08 /* want PRU_RCVD calls */ 12115396Spsadhukhan#define PR_RIGHTS 0x10 /* passes capabilities */ 12215396Spsadhukhan#define PR_IMPLOPCL 0x20 /* implied open/close */ 12315396Spsadhukhan#define PR_LASTHDR 0x40 /* enforce ipsec policy; last header */ 12415396Spsadhukhan 12515396Spsadhukhan/* 12615396Spsadhukhan * In earlier BSD network stacks, a single pr_usrreq() function pointer was 12715396Spsadhukhan * invoked with an operation number indicating what operation was desired. 12815396Spsadhukhan * We now provide individual function pointers which protocols can implement, 12915396Spsadhukhan * which offers a number of benefits (such as type checking for arguments). 13015396Spsadhukhan * These older constants are still present in order to support TCP debugging. 13115396Spsadhukhan */ 13215396Spsadhukhan#define PRU_ATTACH 0 /* attach protocol to up */ 13315396Spsadhukhan#define PRU_DETACH 1 /* detach protocol from up */ 13415396Spsadhukhan#define PRU_BIND 2 /* bind socket to address */ 13515396Spsadhukhan#define PRU_LISTEN 3 /* listen for connection */ 13615396Spsadhukhan#define PRU_CONNECT 4 /* establish connection to peer */ 13715396Spsadhukhan#define PRU_ACCEPT 5 /* accept connection from peer */ 13815396Spsadhukhan#define PRU_DISCONNECT 6 /* disconnect from peer */ 13915396Spsadhukhan#define PRU_SHUTDOWN 7 /* won't send any more data */ 14015396Spsadhukhan#define PRU_RCVD 8 /* have taken data; more room now */ 14115396Spsadhukhan#define PRU_SEND 9 /* send this data */ 14215396Spsadhukhan#define PRU_ABORT 10 /* abort (fast DISCONNECT, DETATCH) */ 14315396Spsadhukhan#define PRU_CONTROL 11 /* control operations on protocol */ 14415396Spsadhukhan#define PRU_SENSE 12 /* return status into m */ 14515396Spsadhukhan#define PRU_RCVOOB 13 /* retrieve out of band data */ 14615396Spsadhukhan#define PRU_SENDOOB 14 /* send out of band data */ 14715396Spsadhukhan#define PRU_SOCKADDR 15 /* fetch socket's address */ 14815396Spsadhukhan#define PRU_PEERADDR 16 /* fetch peer's address */ 14915396Spsadhukhan#define PRU_CONNECT2 17 /* connect two sockets */ 15015396Spsadhukhan/* begin for protocols internal use */ 15115396Spsadhukhan#define PRU_FASTTIMO 18 /* 200ms timeout */ 15215396Spsadhukhan#define PRU_SLOWTIMO 19 /* 500ms timeout */ 15315396Spsadhukhan#define PRU_PROTORCV 20 /* receive from below */ 15415396Spsadhukhan#define PRU_PROTOSEND 21 /* send to below */ 15515396Spsadhukhan/* end for protocol's internal use */ 15615396Spsadhukhan#define PRU_SEND_EOF 22 /* send and close */ 15715396Spsadhukhan#define PRU_SOSETLABEL 23 /* MAC label change */ 15815396Spsadhukhan#define PRU_CLOSE 24 /* socket close */ 15915396Spsadhukhan#define PRU_FLUSH 25 /* flush the socket */ 16015396Spsadhukhan#define PRU_NREQ 25 16115396Spsadhukhan 16215396Spsadhukhan#ifdef PRUREQUESTS 16315396Spsadhukhanconst char *prurequests[] = { 16415396Spsadhukhan "ATTACH", "DETACH", "BIND", "LISTEN", 16515396Spsadhukhan "CONNECT", "ACCEPT", "DISCONNECT", "SHUTDOWN", 16615396Spsadhukhan "RCVD", "SEND", "ABORT", "CONTROL", 16715396Spsadhukhan "SENSE", "RCVOOB", "SENDOOB", "SOCKADDR", 16815396Spsadhukhan "PEERADDR", "CONNECT2", "FASTTIMO", "SLOWTIMO", 16915396Spsadhukhan "PROTORCV", "PROTOSEND", "SEND_EOF", "SOSETLABEL", 17015396Spsadhukhan "CLOSE", "FLUSH", 17115396Spsadhukhan}; 17215396Spsadhukhan#endif 173 174#ifdef _KERNEL /* users shouldn't see this decl */ 175 176struct ifnet; 177struct stat; 178struct ucred; 179struct uio; 180 181/* 182 * If the ordering here looks odd, that's because it's alphabetical. These 183 * should eventually be merged back into struct protosw. 184 * 185 * Some fields initialized to defaults if they are NULL. 186 * See uipc_domain.c:net_init_domain() 187 */ 188struct pr_usrreqs { 189 void (*pru_abort)(struct socket *so); 190 int (*pru_accept)(struct socket *so, struct sockaddr **nam); 191 int (*pru_attach)(struct socket *so, int proto, struct thread *td); 192 int (*pru_bind)(struct socket *so, struct sockaddr *nam, 193 struct thread *td); 194 int (*pru_connect)(struct socket *so, struct sockaddr *nam, 195 struct thread *td); 196 int (*pru_connect2)(struct socket *so1, struct socket *so2); 197 int (*pru_control)(struct socket *so, u_long cmd, caddr_t data, 198 struct ifnet *ifp, struct thread *td); 199 void (*pru_detach)(struct socket *so); 200 int (*pru_disconnect)(struct socket *so); 201 int (*pru_listen)(struct socket *so, int backlog, 202 struct thread *td); 203 int (*pru_peeraddr)(struct socket *so, struct sockaddr **nam); 204 int (*pru_rcvd)(struct socket *so, int flags); 205 int (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags); 206 int (*pru_send)(struct socket *so, int flags, struct mbuf *m, 207 struct sockaddr *addr, struct mbuf *control, 208 struct thread *td); 209#define PRUS_OOB 0x1 210#define PRUS_EOF 0x2 211#define PRUS_MORETOCOME 0x4 212 int (*pru_sense)(struct socket *so, struct stat *sb); 213 int (*pru_shutdown)(struct socket *so); 214 int (*pru_flush)(struct socket *so, int direction); 215 int (*pru_sockaddr)(struct socket *so, struct sockaddr **nam); 216 int (*pru_sosend)(struct socket *so, struct sockaddr *addr, 217 struct uio *uio, struct mbuf *top, struct mbuf *control, 218 int flags, struct thread *td); 219 int (*pru_soreceive)(struct socket *so, struct sockaddr **paddr, 220 struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 221 int *flagsp); 222 int (*pru_sopoll)(struct socket *so, int events, 223 struct ucred *cred, struct thread *td); 224 void (*pru_sosetlabel)(struct socket *so); 225 void (*pru_close)(struct socket *so); 226 int (*pru_bindat)(int fd, struct socket *so, struct sockaddr *nam, 227 struct thread *td); 228 int (*pru_connectat)(int fd, struct socket *so, 229 struct sockaddr *nam, struct thread *td); 230}; 231 232/* 233 * All nonvoid pru_*() functions below return EOPNOTSUPP. 234 */ 235int pru_accept_notsupp(struct socket *so, struct sockaddr **nam); 236int pru_attach_notsupp(struct socket *so, int proto, struct thread *td); 237int pru_bind_notsupp(struct socket *so, struct sockaddr *nam, 238 struct thread *td); 239int pru_bindat_notsupp(int fd, struct socket *so, struct sockaddr *nam, 240 struct thread *td); 241int pru_connect_notsupp(struct socket *so, struct sockaddr *nam, 242 struct thread *td); 243int pru_connectat_notsupp(int fd, struct socket *so, struct sockaddr *nam, 244 struct thread *td); 245int pru_connect2_notsupp(struct socket *so1, struct socket *so2); 246int pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data, 247 struct ifnet *ifp, struct thread *td); 248int pru_disconnect_notsupp(struct socket *so); 249int pru_listen_notsupp(struct socket *so, int backlog, struct thread *td); 250int pru_peeraddr_notsupp(struct socket *so, struct sockaddr **nam); 251int pru_rcvd_notsupp(struct socket *so, int flags); 252int pru_rcvoob_notsupp(struct socket *so, struct mbuf *m, int flags); 253int pru_send_notsupp(struct socket *so, int flags, struct mbuf *m, 254 struct sockaddr *addr, struct mbuf *control, struct thread *td); 255int pru_sense_null(struct socket *so, struct stat *sb); 256int pru_shutdown_notsupp(struct socket *so); 257int pru_sockaddr_notsupp(struct socket *so, struct sockaddr **nam); 258int pru_sosend_notsupp(struct socket *so, struct sockaddr *addr, 259 struct uio *uio, struct mbuf *top, struct mbuf *control, int flags, 260 struct thread *td); 261int pru_soreceive_notsupp(struct socket *so, struct sockaddr **paddr, 262 struct uio *uio, struct mbuf **mp0, struct mbuf **controlp, 263 int *flagsp); 264int pru_sopoll_notsupp(struct socket *so, int events, struct ucred *cred, 265 struct thread *td); 266 267#endif /* _KERNEL */ 268 269/* 270 * The arguments to the ctlinput routine are 271 * (*protosw[].pr_ctlinput)(cmd, sa, arg); 272 * where cmd is one of the commands below, sa is a pointer to a sockaddr, 273 * and arg is a `void *' argument used within a protocol family. 274 */ 275#define PRC_IFDOWN 0 /* interface transition */ 276#define PRC_ROUTEDEAD 1 /* select new route if possible ??? */ 277#define PRC_IFUP 2 /* interface has come back up */ 278#define PRC_QUENCH2 3 /* DEC congestion bit says slow down */ 279#define PRC_QUENCH 4 /* some one said to slow down */ 280#define PRC_MSGSIZE 5 /* message size forced drop */ 281#define PRC_HOSTDEAD 6 /* host appears to be down */ 282#define PRC_HOSTUNREACH 7 /* deprecated (use PRC_UNREACH_HOST) */ 283#define PRC_UNREACH_NET 8 /* no route to network */ 284#define PRC_UNREACH_HOST 9 /* no route to host */ 285#define PRC_UNREACH_PROTOCOL 10 /* dst says bad protocol */ 286#define PRC_UNREACH_PORT 11 /* bad port # */ 287/* was PRC_UNREACH_NEEDFRAG 12 (use PRC_MSGSIZE) */ 288#define PRC_UNREACH_SRCFAIL 13 /* source route failed */ 289#define PRC_REDIRECT_NET 14 /* net routing redirect */ 290#define PRC_REDIRECT_HOST 15 /* host routing redirect */ 291#define PRC_REDIRECT_TOSNET 16 /* redirect for type of service & net */ 292#define PRC_REDIRECT_TOSHOST 17 /* redirect for tos & host */ 293#define PRC_TIMXCEED_INTRANS 18 /* packet lifetime expired in transit */ 294#define PRC_TIMXCEED_REASS 19 /* lifetime expired on reass q */ 295#define PRC_PARAMPROB 20 /* header incorrect */ 296#define PRC_UNREACH_ADMIN_PROHIB 21 /* packet administrativly prohibited */ 297 298#define PRC_NCMDS 22 299 300#define PRC_IS_REDIRECT(cmd) \ 301 ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST) 302 303#ifdef PRCREQUESTS 304char *prcrequests[] = { 305 "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2", 306 "QUENCH", "MSGSIZE", "HOSTDEAD", "#7", 307 "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH", 308 "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT", 309 "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS", 310 "PARAMPROB", "ADMIN-UNREACH" 311}; 312#endif 313 314/* 315 * The arguments to ctloutput are: 316 * (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p); 317 * req is one of the actions listed below, so is a (struct socket *), 318 * level is an indication of which protocol layer the option is intended. 319 * optname is a protocol dependent socket option request, 320 * optval is a pointer to a mbuf-chain pointer, for value-return results. 321 * The protocol is responsible for disposal of the mbuf chain *optval 322 * if supplied, 323 * the caller is responsible for any space held by *optval, when returned. 324 * A non-zero return from ctloutput gives an 325 * UNIX error number which should be passed to higher level software. 326 */ 327#define PRCO_GETOPT 0 328#define PRCO_SETOPT 1 329 330#define PRCO_NCMDS 2 331 332#ifdef PRCOREQUESTS 333char *prcorequests[] = { 334 "GETOPT", "SETOPT", 335}; 336#endif 337 338#ifdef _KERNEL 339void pfctlinput(int, struct sockaddr *); 340void pfctlinput2(int, struct sockaddr *, void *); 341struct domain *pffinddomain(int family); 342struct protosw *pffindproto(int family, int protocol, int type); 343struct protosw *pffindtype(int family, int type); 344int pf_proto_register(int family, struct protosw *npr); 345int pf_proto_unregister(int family, int protocol, int type); 346#endif 347 348#endif 349