bsd/sys/protosw.h

   1 /*
   2  * Copyright (c) 2006 Apple Computer, Inc. All Rights Reserved.
   3  *
   4  * @APPLE_LICENSE_OSREFERENCE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License.  The rights granted to you under the
  10  * License may not be used to create, or enable the creation or
  11  * redistribution of, unlawful or unlicensed copies of an Apple operating
  12  * system, or to circumvent, violate, or enable the circumvention or
  13  * violation of, any terms of an Apple operating system software license
  14  * agreement.
  15  *
  16  * Please obtain a copy of the License at
  17  * http://www.opensource.apple.com/apsl/ and read it before using this
  18  * file.
  19  *
  20  * The Original Code and all software distributed under the License are
  21  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  22  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  23  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  25  * Please see the License for the specific language governing rights and
  26  * limitations under the License.
  27  *
  28  * @APPLE_LICENSE_OSREFERENCE_HEADER_END@
  29  */
  30 /* Copyright (c) 1998, 1999 Apple Computer, Inc. All Rights Reserved */
  31 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  32 /*
  33  * Copyright (c) 1982, 1986, 1993
  34  *      The Regents of the University of California.  All rights reserved.
  35  *
  36  * Redistribution and use in source and binary forms, with or without
  37  * modification, are permitted provided that the following conditions
  38  * are met:
  39  * 1. Redistributions of source code must retain the above copyright
  40  *    notice, this list of conditions and the following disclaimer.
  41  * 2. Redistributions in binary form must reproduce the above copyright
  42  *    notice, this list of conditions and the following disclaimer in the
  43  *    documentation and/or other materials provided with the distribution.
  44  * 3. All advertising materials mentioning features or use of this software
  45  *    must display the following acknowledgement:
  46  *      This product includes software developed by the University of
  47  *      California, Berkeley and its contributors.
  48  * 4. Neither the name of the University nor the names of its contributors
  49  *    may be used to endorse or promote products derived from this software
  50  *    without specific prior written permission.
  51  *
  52  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  53  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  54  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  55  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  56  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  57  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  58  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  59  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  60  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  61  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  62  * SUCH DAMAGE.
  63  *
  64  *      @(#)protosw.h   8.1 (Berkeley) 6/2/93
  65  * $FreeBSD: src/sys/sys/protosw.h,v 1.28.2.2 2001/07/03 11:02:01 ume Exp $
  66  */
  67
  68 #ifndef _SYS_PROTOSW_H_
  69 #define _SYS_PROTOSW_H_
  70
  71 #include <sys/appleapiopts.h>
  72 #include <sys/cdefs.h>
  73
  74 #define PR_SLOWHZ       2               /* 2 slow timeouts per second */
  75 #define PR_FASTHZ       5               /* 5 fast timeouts per second */
  76
  77 #ifdef PRIVATE
  78
  79 /* Forward declare these structures referenced from prototypes below. */
  80 struct mbuf;
  81 struct proc;
  82 struct sockaddr;
  83 struct socket;
  84 struct sockopt;
  85 struct socket_filter;
  86
  87 /*#ifdef _KERNEL*/
  88 /*
  89  * Protocol switch table.
  90  *
  91  * Each protocol has a handle initializing one of these structures,
  92  * which is used for protocol-protocol and system-protocol communication.
  93  *
  94  * A protocol is called through the pr_init entry before any other.
  95  * Thereafter it is called every 200ms through the pr_fasttimo entry and
  96  * every 500ms through the pr_slowtimo for timer based actions.
  97  * The system will call the pr_drain entry if it is low on space and
  98  * this should throw away any non-critical data.
  99  *
 100  * Protocols pass data between themselves as chains of mbufs using
 101  * the pr_input and pr_output hooks.  Pr_input passes data up (towards
 102  * the users) and pr_output passes it down (towards the interfaces); control
 103  * information passes up and down on pr_ctlinput and pr_ctloutput.
 104  * The protocol is responsible for the space occupied by any the
 105  * arguments to these entries and must dispose it.
 106  *
 107  * The userreq routine interfaces protocols to the system and is
 108  * described below.
 109  */
 110
 111 #include <sys/socketvar.h>
 112 #include <sys/queue.h>
 113 #ifdef KERNEL
 114 #include <kern/locks.h>
 115 #endif /* KERNEL */
 116
 117 #if __DARWIN_ALIGN_POWER
 118 #pragma options align=power
 119 #endif
 120
 121 struct protosw {
 122         short   pr_type;                /* socket type used for */
 123         struct  domain *pr_domain;      /* domain protocol a member of */
 124         short   pr_protocol;            /* protocol number */
 125         unsigned int pr_flags;          /* see below */
 126 /* protocol-protocol hooks */
 127         void    (*pr_input)(struct mbuf *, int len);
 128                                         /* input to protocol (from below) */
 129         int     (*pr_output)(struct mbuf *m, struct socket *so);
 130                                         /* output to protocol (from above) */
 131         void    (*pr_ctlinput)(int, struct sockaddr *, void *);
 132                                         /* control input (from below) */
 133         int     (*pr_ctloutput)(struct socket *, struct sockopt *);
 134                                         /* control output (from above) */
 135 /* user-protocol hook */
 136         void    *pr_ousrreq;
 137 /* utility hooks */
 138         void    (*pr_init)(void);       /* initialization hook */
 139         void    (*pr_fasttimo)(void);
 140                                         /* fast timeout (200ms) */
 141         void    (*pr_slowtimo)(void);
 142                                         /* slow timeout (500ms) */
 143         void    (*pr_drain)(void);
 144                                         /* flush any excess space possible */
 145 #if __APPLE__
 146         int     (*pr_sysctl)(int *, u_int, void *, size_t *, void *, size_t);
 147                                         /* sysctl for protocol */
 148 #endif
 149         struct  pr_usrreqs *pr_usrreqs; /* supersedes pr_usrreq() */
 150 #if __APPLE__
 151         int     (*pr_lock)      (struct socket *so, int locktype, int debug); /* lock function for protocol */
 152         int     (*pr_unlock)    (struct socket *so, int locktype, int debug); /* unlock for protocol */
 153 #ifdef _KERN_LOCKS_H_
 154         lck_mtx_t *     (*pr_getlock)   (struct socket *so, int locktype);
 155 #else
 156         void *  (*pr_getlock)   (struct socket *so, int locktype);
 157 #endif
 158 #endif
 159 #if __APPLE__
 160 /* Implant hooks */
 161         TAILQ_HEAD(, socket_filter) pr_filter_head;
 162         struct protosw *pr_next;        /* Chain for domain */
 163         u_long  reserved[1];            /* Padding for future use */
 164 #endif
 165 };
 166
 167 #if __DARWIN_ALIGN_POWER
 168 #pragma options align=reset
 169 #endif
 170
 171 /*
 172  * Values for pr_flags.
 173  * PR_ADDR requires PR_ATOMIC;
 174  * PR_ADDR and PR_CONNREQUIRED are mutually exclusive.
 175  * PR_IMPLOPCL means that the protocol allows sendto without prior connect,
 176  *      and the protocol understands the MSG_EOF flag.  The first property is
 177  *      is only relevant if PR_CONNREQUIRED is set (otherwise sendto is allowed
 178  *      anyhow).
 179  */
 180 #define PR_ATOMIC                       0x01            /* exchange atomic messages only */
 181 #define PR_ADDR                 0x02            /* addresses given with messages */
 182 #define PR_CONNREQUIRED 0x04            /* connection required by protocol */
 183 #define PR_WANTRCVD             0x08            /* want PRU_RCVD calls */
 184 #define PR_RIGHTS                       0x10            /* passes capabilities */
 185 #define PR_IMPLOPCL             0x20            /* implied open/close */
 186 #define PR_LASTHDR              0x40            /* enforce ipsec policy; last header */
 187 #define PR_PROTOLOCK            0x80            /* protocol takes care of it's own locking */
 188 #define PR_PCBLOCK              0x100   /* protocol supports per pcb finer grain locking */
 189 #define PR_DISPOSE              0x200   /* protocol requires late lists disposal */
 190
 191 /*
 192  * The arguments to usrreq are:
 193  *      (*protosw[].pr_usrreq)(up, req, m, nam, opt);
 194  * where up is a (struct socket *), req is one of these requests,
 195  * m is a optional mbuf chain containing a message,
 196  * nam is an optional mbuf chain containing an address,
 197  * and opt is a pointer to a socketopt structure or nil.
 198  * The protocol is responsible for disposal of the mbuf chain m,
 199  * the caller is responsible for any space held by nam and opt.
 200  * A non-zero return from usrreq gives an
 201  * UNIX error number which should be passed to higher level software.
 202  */
 203 #define PRU_ATTACH              0       /* attach protocol to up */
 204 #define PRU_DETACH              1       /* detach protocol from up */
 205 #define PRU_BIND                2       /* bind socket to address */
 206 #define PRU_LISTEN              3       /* listen for connection */
 207 #define PRU_CONNECT             4       /* establish connection to peer */
 208 #define PRU_ACCEPT              5       /* accept connection from peer */
 209 #define PRU_DISCONNECT          6       /* disconnect from peer */
 210 #define PRU_SHUTDOWN            7       /* won't send any more data */
 211 #define PRU_RCVD                8       /* have taken data; more room now */
 212 #define PRU_SEND                9       /* send this data */
 213 #define PRU_ABORT               10      /* abort (fast DISCONNECT, DETATCH) */
 214 #define PRU_CONTROL             11      /* control operations on protocol */
 215 #define PRU_SENSE               12      /* return status into m */
 216 #define PRU_RCVOOB              13      /* retrieve out of band data */
 217 #define PRU_SENDOOB             14      /* send out of band data */
 218 #define PRU_SOCKADDR            15      /* fetch socket's address */
 219 #define PRU_PEERADDR            16      /* fetch peer's address */
 220 #define PRU_CONNECT2            17      /* connect two sockets */
 221 /* begin for protocols internal use */
 222 #define PRU_FASTTIMO            18      /* 200ms timeout */
 223 #define PRU_SLOWTIMO            19      /* 500ms timeout */
 224 #define PRU_PROTORCV            20      /* receive from below */
 225 #define PRU_PROTOSEND           21      /* send to below */
 226 /* end for protocol's internal use */
 227 #define PRU_SEND_EOF            22      /* send and close */
 228 #define PRU_NREQ                22
 229
 230 #ifdef PRUREQUESTS
 231 char *prurequests[] = {
 232         "ATTACH",       "DETACH",       "BIND",         "LISTEN",
 233         "CONNECT",      "ACCEPT",       "DISCONNECT",   "SHUTDOWN",
 234         "RCVD",         "SEND",         "ABORT",        "CONTROL",
 235         "SENSE",        "RCVOOB",       "SENDOOB",      "SOCKADDR",
 236         "PEERADDR",     "CONNECT2",     "FASTTIMO",     "SLOWTIMO",
 237         "PROTORCV",     "PROTOSEND",
 238         "SEND_EOF",
 239 };
 240 #endif
 241
 242 #ifdef  KERNEL                  /* users shouldn't see this decl */
 243
 244 struct ifnet;
 245 struct stat;
 246 struct ucred;
 247 struct uio;
 248
 249 /*
 250  * If the ordering here looks odd, that's because it's alphabetical.
 251  * Having this structure separated out from the main protoswitch is allegedly
 252  * a big (12 cycles per call) lose on high-end CPUs.  We will eventually
 253  * migrate this stuff back into the main structure.
 254  */
 255 struct pr_usrreqs {
 256         int     (*pru_abort)(struct socket *so);
 257         int     (*pru_accept)(struct socket *so, struct sockaddr **nam);
 258         int     (*pru_attach)(struct socket *so, int proto, struct proc *p);
 259         int     (*pru_bind)(struct socket *so, struct sockaddr *nam,
 260                                  struct proc *p);
 261         int     (*pru_connect)(struct socket *so, struct sockaddr *nam,
 262                                     struct proc *p);
 263         int     (*pru_connect2)(struct socket *so1, struct socket *so2);
 264         int     (*pru_control)(struct socket *so, u_long cmd, caddr_t data,
 265                                     struct ifnet *ifp, struct proc *p);
 266         int     (*pru_detach)(struct socket *so);
 267         int     (*pru_disconnect)(struct socket *so);
 268         int     (*pru_listen)(struct socket *so, struct proc *p);
 269         int     (*pru_peeraddr)(struct socket *so, struct sockaddr **nam);
 270         int     (*pru_rcvd)(struct socket *so, int flags);
 271         int     (*pru_rcvoob)(struct socket *so, struct mbuf *m, int flags);
 272         int     (*pru_send)(struct socket *so, int flags, struct mbuf *m,
 273                                  struct sockaddr *addr, struct mbuf *control,
 274                                  struct proc *p);
 275 #define PRUS_OOB        0x1
 276 #define PRUS_EOF        0x2
 277 #define PRUS_MORETOCOME 0x4
 278         int     (*pru_sense)(struct socket *so, struct stat *sb);
 279         int     (*pru_shutdown)(struct socket *so);
 280         int     (*pru_sockaddr)(struct socket *so, struct sockaddr **nam);
 281
 282         /*
 283          * These three added later, so they are out of order.  They are used
 284          * for shortcutting (fast path input/output) in some protocols.
 285          * XXX - that's a lie, they are not implemented yet
 286          * Rather than calling sosend() etc. directly, calls are made
 287          * through these entry points.  For protocols which still use
 288          * the generic code, these just point to those routines.
 289          */
 290         int     (*pru_sosend)(struct socket *so, struct sockaddr *addr,
 291                                    struct uio *uio, struct mbuf *top,
 292                                    struct mbuf *control, int flags);
 293         int     (*pru_soreceive)(struct socket *so,
 294                                       struct sockaddr **paddr,
 295                                       struct uio *uio, struct mbuf **mp0,
 296                                       struct mbuf **controlp, int *flagsp);
 297         int     (*pru_sopoll)(struct socket *so, int events,
 298                                    struct ucred *cred, void *);
 299 };
 300
 301 __BEGIN_DECLS
 302
 303 extern int      pru_abort_notsupp(struct socket *so);
 304 extern int      pru_accept_notsupp(struct socket *so, struct sockaddr **nam);
 305 extern int      pru_attach_notsupp(struct socket *so, int proto,
 306                                    struct proc *p);
 307 extern int      pru_bind_notsupp(struct socket *so, struct sockaddr *nam,
 308                                  struct proc *p);
 309 extern int      pru_connect_notsupp(struct socket *so, struct sockaddr *nam,
 310                                     struct proc *p);
 311 extern int      pru_connect2_notsupp(struct socket *so1, struct socket *so2);
 312 extern int      pru_control_notsupp(struct socket *so, u_long cmd, caddr_t data,
 313                                     struct ifnet *ifp, struct proc *p);
 314 extern int      pru_detach_notsupp(struct socket *so);
 315 extern int      pru_disconnect_notsupp(struct socket *so);
 316 extern int      pru_listen_notsupp(struct socket *so, struct proc *p);
 317 extern int      pru_peeraddr_notsupp(struct socket *so,
 318                                      struct sockaddr **nam);
 319 extern int      pru_rcvd_notsupp(struct socket *so, int flags);
 320 extern int      pru_rcvoob_notsupp(struct socket *so, struct mbuf *m,
 321                                    int flags);
 322 extern int      pru_send_notsupp(struct socket *so, int flags, struct mbuf *m,
 323                                  struct sockaddr *addr, struct mbuf *control,
 324                                  struct proc *p);
 325 extern int      pru_sense_null(struct socket *so, struct stat *sb);
 326 extern int      pru_shutdown_notsupp(struct socket *so);
 327 extern int      pru_sockaddr_notsupp(struct socket *so,
 328                                      struct sockaddr **nam);
 329 extern int      pru_sosend_notsupp(struct socket *so, struct sockaddr *addr,
 330                                    struct uio *uio, struct mbuf *top,
 331                                    struct mbuf *control, int flags);
 332 extern int      pru_soreceive_notsupp(struct socket *so,
 333                                       struct sockaddr **paddr,
 334                                       struct uio *uio, struct mbuf **mp0,
 335                                       struct mbuf **controlp, int *flagsp);
 336 extern int      pru_sopoll_notsupp(struct socket *so, int events,
 337                                    struct ucred *cred, void *);
 338
 339 __END_DECLS
 340
 341 #endif /* KERNEL */
 342
 343 /*
 344  * The arguments to the ctlinput routine are
 345  *      (*protosw[].pr_ctlinput)(cmd, sa, arg);
 346  * where cmd is one of the commands below, sa is a pointer to a sockaddr,
 347  * and arg is a `void *' argument used within a protocol family.
 348  */
 349 #define PRC_IFDOWN              0       /* interface transition */
 350 #define PRC_ROUTEDEAD           1       /* select new route if possible ??? */
 351 #define PRC_IFUP                2       /* interface has come back up */
 352 #define PRC_QUENCH2             3       /* DEC congestion bit says slow down */
 353 #define PRC_QUENCH              4       /* some one said to slow down */
 354 #define PRC_MSGSIZE             5       /* message size forced drop */
 355 #define PRC_HOSTDEAD            6       /* host appears to be down */
 356 #define PRC_HOSTUNREACH         7       /* deprecated (use PRC_UNREACH_HOST) */
 357 #define PRC_UNREACH_NET         8       /* no route to network */
 358 #define PRC_UNREACH_HOST        9       /* no route to host */
 359 #define PRC_UNREACH_PROTOCOL    10      /* dst says bad protocol */
 360 #define PRC_UNREACH_PORT        11      /* bad port # */
 361 /* was  PRC_UNREACH_NEEDFRAG    12         (use PRC_MSGSIZE) */
 362 #define PRC_UNREACH_SRCFAIL     13      /* source route failed */
 363 #define PRC_REDIRECT_NET        14      /* net routing redirect */
 364 #define PRC_REDIRECT_HOST       15      /* host routing redirect */
 365 #define PRC_REDIRECT_TOSNET     16      /* redirect for type of service & net */
 366 #define PRC_REDIRECT_TOSHOST    17      /* redirect for tos & host */
 367 #define PRC_TIMXCEED_INTRANS    18      /* packet lifetime expired in transit */
 368 #define PRC_TIMXCEED_REASS      19      /* lifetime expired on reass q */
 369 #define PRC_PARAMPROB           20      /* header incorrect */
 370 #define PRC_UNREACH_ADMIN_PROHIB        21      /* packet administrativly prohibited */
 371
 372 #define PRC_NCMDS               22
 373
 374 #define PRC_IS_REDIRECT(cmd)    \
 375         ((cmd) >= PRC_REDIRECT_NET && (cmd) <= PRC_REDIRECT_TOSHOST)
 376
 377 #ifdef PRCREQUESTS
 378 char    *prcrequests[] = {
 379         "IFDOWN", "ROUTEDEAD", "IFUP", "DEC-BIT-QUENCH2",
 380         "QUENCH", "MSGSIZE", "HOSTDEAD", "#7",
 381         "NET-UNREACH", "HOST-UNREACH", "PROTO-UNREACH", "PORT-UNREACH",
 382         "#12", "SRCFAIL-UNREACH", "NET-REDIRECT", "HOST-REDIRECT",
 383         "TOSNET-REDIRECT", "TOSHOST-REDIRECT", "TX-INTRANS", "TX-REASS",
 384         "PARAMPROB", "ADMIN-UNREACH"
 385 };
 386 #endif
 387
 388 /*
 389  * The arguments to ctloutput are:
 390  *      (*protosw[].pr_ctloutput)(req, so, level, optname, optval, p);
 391  * req is one of the actions listed below, so is a (struct socket *),
 392  * level is an indication of which protocol layer the option is intended.
 393  * optname is a protocol dependent socket option request,
 394  * optval is a pointer to a mbuf-chain pointer, for value-return results.
 395  * The protocol is responsible for disposal of the mbuf chain *optval
 396  * if supplied,
 397  * the caller is responsible for any space held by *optval, when returned.
 398  * A non-zero return from usrreq gives an
 399  * UNIX error number which should be passed to higher level software.
 400  */
 401 #define PRCO_GETOPT     0
 402 #define PRCO_SETOPT     1
 403
 404 #define PRCO_NCMDS      2
 405
 406 #ifdef PRCOREQUESTS
 407 char    *prcorequests[] = {
 408         "GETOPT", "SETOPT",
 409 };
 410 #endif
 411
 412 #ifdef KERNEL
 413
 414 __BEGIN_DECLS
 415
 416 void    pfctlinput(int, struct sockaddr *);
 417 void    pfctlinput2(int, struct sockaddr *, void *);
 418 struct protosw *pffindproto(int family, int protocol, int type);
 419 struct protosw *pffindproto_locked(int family, int protocol, int type);
 420 struct protosw *pffindtype(int family, int type);
 421
 422 extern int net_add_proto(struct protosw *, struct domain *);
 423 extern int net_del_proto(int, int, struct domain *);
 424
 425 __END_DECLS
 426
 427 /* Temp hack to link static domains together */
 428
 429 #define LINK_PROTOS(psw) \
 430 static void link_ ## psw ## _protos() \
 431 { \
 432       int i; \
 433                  \
 434     for (i=0; i < ((sizeof(psw)/sizeof(psw[0])) - 1); i++) \
 435              psw[i].pr_next = &psw[i + 1]; \
 436 }
 437
 438 #endif
 439
 440 #endif /* PRIVATE */
 441 #endif  /* !_SYS_PROTOSW_H_ */