bsd/netat/at_pcb.h

   1 /*
   2  * Copyright (c) 2000 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 /*
  31  *      Copyright (c) 1997-1999 Apple Computer, Inc.
  32  *      All Rights Reserved.
  33  */
  34 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  35 /*
  36  * Copyright (c) 1982, 1986, 1990, 1993
  37  *      The Regents of the University of California.  All rights reserved.
  38  *
  39  * Redistribution and use in source and binary forms, with or without
  40  * modification, are permitted provided that the following conditions
  41  * are met:
  42  * 1. Redistributions of source code must retain the above copyright
  43  *    notice, this list of conditions and the following disclaimer.
  44  * 2. Redistributions in binary form must reproduce the above copyright
  45  *    notice, this list of conditions and the following disclaimer in the
  46  *    documentation and/or other materials provided with the distribution.
  47  * 3. All advertising materials mentioning features or use of this software
  48  *    must display the following acknowledgement:
  49  *      This product includes software developed by the University of
  50  *      California, Berkeley and its contributors.
  51  * 4. Neither the name of the University nor the names of its contributors
  52  *    may be used to endorse or promote products derived from this software
  53  *    without specific prior written permission.
  54  *
  55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  65  * SUCH DAMAGE.
  66  */
  67
  68 /* at_pcb.h */
  69 #include <sys/appleapiopts.h>
  70
  71 #ifdef __APPLE_API_OBSOLETE
  72 #ifdef KERNEL_PRIVATE
  73 /*
  74  * Common structure pcb for internet protocol implementation.
  75  * Here are stored pointers to local and foreign host table
  76  * entries, local and foreign socket numbers, and pointers
  77  * up (to a socket structure) and down (to a protocol-specific)
  78  * control block.
  79  */
  80 struct atpcb;
  81 typedef struct atpcb gref_t;
  82 struct atpcb {
  83         struct atpcb    *atpcb_next,    /* pointers to other pcb's */
  84                         *atpcb_prev,
  85                         *atpcb_head;    /* pointer back to chain of atpcb's
  86                                            for this protocol */
  87         struct socket   *atpcb_socket;  /* back pointer to socket */
  88         u_char          ddptype,        /* DDP type */
  89                         lport,          /* local DDP socket */
  90                         rport;          /* remote DDP socket */
  91         struct at_addr  laddr,          /* local net and node */
  92                         raddr;          /* remote net and node */
  93         int             ddp_flags;      /* generic IP/datagram flags */
  94         caddr_t         at_ppcb;        /* pointer to per-protocol pcb */
  95
  96   /* from the gref structure */
  97
  98         void *info;
  99         gbuf_t *ichead;
 100         gbuf_t *ictail;
 101         gbuf_t *rdhead;
 102         gbuf_t *rdtail;
 103         unsigned char   proto;          /* old-style ATPROTO_* */
 104         unsigned char  errno;
 105         unsigned short sevents;
 106         int pid;
 107         atlock_t lock;
 108         atevent_t event;
 109         atevent_t iocevent;
 110         int (*writeable)(gref_t *gref);
 111         int (*readable)(gref_t *gref);
 112         struct selinfo si;      /* BSD 4.4 selinfo structure for
 113                                    selrecord/selwakeup */
 114 };
 115
 116 #define sotoatpcb(so)((struct atpcb *)(so)->so_pcb)
 117
 118 /* ddp_flags */
 119 #define DDPFLG_CHKSUM    0x01   /* DDP checksums to be used on this connection */
 120 #define DDPFLG_SLFSND    0x02   /* packets sent to the cable-multicast address
 121                                    on this socket should be looped back */
 122 #define DDPFLG_HDRINCL   0x08   /* user supplies entire DDP header */
 123 #define DDPFLG_STRIPHDR 0x200   /* drop DDP header on receive (raw) */
 124
 125 int     at_pcballoc(struct socket *, struct atpcb *);
 126 int     at_pcbdetach(struct atpcb *);
 127 int     at_pcbbind(struct atpcb *, struct sockaddr *);
 128
 129 int atalk_getref(struct fileproc *, int , gref_t ** , struct proc *, int);
 130 int atalk_getref_locked(struct fileproc *, int , gref_t ** , struct proc *, int);
 131
 132
 133 #endif /* KERNEL_PRIVATE */
 134 #endif /* __APPLE_API_OBSOLETE */