bsd/netat/at_pcb.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * Copyright (c) 1999-2003 Apple Computer, Inc.  All Rights Reserved.
   7  *
   8  * This file contains Original Code and/or Modifications of Original Code
   9  * as defined in and that are subject to the Apple Public Source License
  10  * Version 2.0 (the 'License'). You may not use this file except in
  11  * compliance with the License. Please obtain a copy of the License at
  12  * http://www.opensource.apple.com/apsl/ and read it before using this
  13  * file.
  14  *
  15  * The Original Code and all software distributed under the License are
  16  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  17  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  18  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  20  * Please see the License for the specific language governing rights and
  21  * limitations under the License.
  22  *
  23  * @APPLE_LICENSE_HEADER_END@
  24  */
  25 /*
  26  *      Copyright (c) 1997-1999 Apple Computer, Inc.
  27  *      All Rights Reserved.
  28  */
  29 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  30 /*
  31  * Copyright (c) 1982, 1986, 1990, 1993
  32  *      The Regents of the University of California.  All rights reserved.
  33  *
  34  * Redistribution and use in source and binary forms, with or without
  35  * modification, are permitted provided that the following conditions
  36  * are met:
  37  * 1. Redistributions of source code must retain the above copyright
  38  *    notice, this list of conditions and the following disclaimer.
  39  * 2. Redistributions in binary form must reproduce the above copyright
  40  *    notice, this list of conditions and the following disclaimer in the
  41  *    documentation and/or other materials provided with the distribution.
  42  * 3. All advertising materials mentioning features or use of this software
  43  *    must display the following acknowledgement:
  44  *      This product includes software developed by the University of
  45  *      California, Berkeley and its contributors.
  46  * 4. Neither the name of the University nor the names of its contributors
  47  *    may be used to endorse or promote products derived from this software
  48  *    without specific prior written permission.
  49  *
  50  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  51  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  52  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  53  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  54  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  55  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  56  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  57  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  58  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  59  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  60  * SUCH DAMAGE.
  61  */
  62
  63 /* at_pcb.h */
  64 #include <sys/appleapiopts.h>
  65
  66 #ifdef __APPLE_API_PRIVATE
  67 /*
  68  * Common structure pcb for internet protocol implementation.
  69  * Here are stored pointers to local and foreign host table
  70  * entries, local and foreign socket numbers, and pointers
  71  * up (to a socket structure) and down (to a protocol-specific)
  72  * control block.
  73  */
  74 struct atpcb {
  75         struct atpcb    *atpcb_next,    /* pointers to other pcb's */
  76                         *atpcb_prev,
  77                         *atpcb_head;    /* pointer back to chain of atpcb's
  78                                            for this protocol */
  79         struct socket   *atpcb_socket;  /* back pointer to socket */
  80         u_char          ddptype,        /* DDP type */
  81                         lport,          /* local DDP socket */
  82                         rport;          /* remote DDP socket */
  83         struct at_addr  laddr,          /* local net and node */
  84                         raddr;          /* remote net and node */
  85         int             ddp_flags;      /* generic IP/datagram flags */
  86         caddr_t         at_ppcb;        /* pointer to per-protocol pcb */
  87
  88   /* from the gref structure */
  89
  90         void *info;
  91         gbuf_t *ichead;
  92         gbuf_t *ictail;
  93         gbuf_t *rdhead;
  94         gbuf_t *rdtail;
  95         unsigned char   proto;          /* old-style ATPROTO_* */
  96         unsigned char  errno;
  97         unsigned short sevents;
  98         int pid;
  99         atlock_t lock;
 100         atevent_t event;
 101         atevent_t iocevent;
 102         int (*writeable)();
 103         int (*readable)();
 104         struct selinfo si;      /* BSD 4.4 selinfo structure for
 105                                    selrecord/selwakeup */
 106 };
 107
 108 #define sotoatpcb(so)((struct atpcb *)(so)->so_pcb)
 109 #endif /* __APPLE_API_PRIVATE */
 110
 111 /* ddp_flags */
 112 #define DDPFLG_CHKSUM    0x01   /* DDP checksums to be used on this connection */
 113 #define DDPFLG_SLFSND    0x02   /* packets sent to the cable-multicast address
 114                                    on this socket should be looped back */
 115 #define DDPFLG_HDRINCL   0x08   /* user supplies entire DDP header */
 116 #define DDPFLG_STRIPHDR 0x200   /* drop DDP header on receive (raw) */
 117
 118 #ifdef __APPLE_API_PRIVATE
 119 #ifdef KERNEL
 120 typedef struct atpcb gref_t;
 121
 122 int     at_pcballoc __P((struct socket *, struct atpcb *));
 123 int     at_pcbdetach __P((struct atpcb *));
 124 int     at_pcbbind __P((struct atpcb *, struct sockaddr *));
 125 #endif /* KERNEL */
 126 #endif /* __APPLE_API_PRIVATE */