bsd/netat/at_pcb.h

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