bsd/nfs/nfsrvcache.h

   1 /*
   2  * Copyright (c) 2000-2004 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) 1995 NeXT Computer, Inc. All Rights Reserved */
  31 /*
  32  * Copyright (c) 1989, 1993
  33  *      The Regents of the University of California.  All rights reserved.
  34  *
  35  * This code is derived from software contributed to Berkeley by
  36  * Rick Macklem at The University of Guelph.
  37  *
  38  * Redistribution and use in source and binary forms, with or without
  39  * modification, are permitted provided that the following conditions
  40  * are met:
  41  * 1. Redistributions of source code must retain the above copyright
  42  *    notice, this list of conditions and the following disclaimer.
  43  * 2. Redistributions in binary form must reproduce the above copyright
  44  *    notice, this list of conditions and the following disclaimer in the
  45  *    documentation and/or other materials provided with the distribution.
  46  * 3. All advertising materials mentioning features or use of this software
  47  *    must display the following acknowledgement:
  48  *      This product includes software developed by the University of
  49  *      California, Berkeley and its contributors.
  50  * 4. Neither the name of the University nor the names of its contributors
  51  *    may be used to endorse or promote products derived from this software
  52  *    without specific prior written permission.
  53  *
  54  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  55  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  56  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  57  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  58  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  59  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  60  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  61  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  62  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  63  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  64  * SUCH DAMAGE.
  65  *
  66  *      @(#)nfsrvcache.h        8.3 (Berkeley) 3/30/95
  67  * FreeBSD-Id: nfsrvcache.h,v 1.9 1997/06/03 17:22:47 dfr Exp $
  68  */
  69
  70
  71 #ifndef _NFS_NFSRVCACHE_H_
  72 #define _NFS_NFSRVCACHE_H_
  73
  74 #include <sys/appleapiopts.h>
  75
  76 #ifdef __APPLE_API_PRIVATE
  77 /*
  78  * Definitions for the server recent request cache
  79  */
  80
  81 #define NFSRVCACHESIZ   64
  82
  83 struct nfsrvcache {
  84         TAILQ_ENTRY(nfsrvcache) rc_lru;         /* LRU chain */
  85         LIST_ENTRY(nfsrvcache) rc_hash;         /* Hash chain */
  86         u_long  rc_xid;                         /* rpc id number */
  87         union {
  88                 mbuf_t ru_repmb;                /* Reply mbuf list OR */
  89                 int ru_repstat;                 /* Reply status */
  90         } rc_un;
  91         union nethostaddr rc_haddr;             /* Host address */
  92         u_int32_t rc_proc;                      /* rpc proc number */
  93         u_char  rc_state;               /* Current state of request */
  94         u_char  rc_flag;                /* Flag bits */
  95 };
  96
  97 #define rc_reply        rc_un.ru_repmb
  98 #define rc_status       rc_un.ru_repstat
  99 #define rc_inetaddr     rc_haddr.had_inetaddr
 100 #define rc_nam          rc_haddr.had_nam
 101
 102 /* Cache entry states */
 103 #define RC_UNUSED       0
 104 #define RC_INPROG       1
 105 #define RC_DONE         2
 106
 107 /* Return values */
 108 #define RC_DROPIT       0
 109 #define RC_REPLY        1
 110 #define RC_DOIT         2
 111 #define RC_CHECKIT      3
 112
 113 /* Flag bits */
 114 #define RC_LOCKED       0x01
 115 #define RC_WANTED       0x02
 116 #define RC_REPSTATUS    0x04
 117 #define RC_REPMBUF      0x08
 118 #define RC_INETADDR     0x20
 119 #define RC_NAM          0x40
 120
 121 #endif /* __APPLE_API_PRIVATE */
 122 #endif /* _NFS_NFSRVCACHE_H_ */