bsd/nfs/nfsrvcache.h

   1 /*
   2  * Copyright (c) 2000-2010 Apple Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_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. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  29 /*
  30  * Copyright (c) 1989, 1993
  31  *      The Regents of the University of California.  All rights reserved.
  32  *
  33  * This code is derived from software contributed to Berkeley by
  34  * Rick Macklem at The University of Guelph.
  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  *      @(#)nfsrvcache.h        8.3 (Berkeley) 3/30/95
  65  * FreeBSD-Id: nfsrvcache.h,v 1.9 1997/06/03 17:22:47 dfr Exp $
  66  */
  67
  68
  69 #ifndef _NFS_NFSRVCACHE_H_
  70 #define _NFS_NFSRVCACHE_H_
  71
  72 #include <sys/appleapiopts.h>
  73
  74 #ifdef __APPLE_API_PRIVATE
  75 /*
  76  * Definitions for the server recent request cache
  77  */
  78
  79 /* Network address hash list element */
  80 union nethostaddr {
  81         in_addr_t had_inetaddr;
  82         struct in6_addr had_inet6addr;
  83         mbuf_t had_nam;
  84 };
  85
  86 #define NFSRVCACHESIZ   64
  87
  88 struct nfsrvcache {
  89         TAILQ_ENTRY(nfsrvcache) rc_lru;         /* LRU chain */
  90         LIST_ENTRY(nfsrvcache) rc_hash;         /* Hash chain */
  91         u_int32_t       rc_xid;                         /* rpc id number */
  92         union {
  93                 mbuf_t ru_repmb;                /* Reply mbuf list OR */
  94                 int ru_repstat;                 /* Reply status */
  95         } rc_un;
  96         sa_family_t rc_family;                  /* address family */
  97         union nethostaddr rc_haddr;             /* Host address */
  98         u_int32_t rc_proc;                      /* rpc proc number */
  99         u_char  rc_state;               /* Current state of request */
 100         u_char  rc_flag;                /* Flag bits */
 101 };
 102
 103 #define rc_reply        rc_un.ru_repmb
 104 #define rc_status       rc_un.ru_repstat
 105 #define rc_inetaddr     rc_haddr.had_inetaddr
 106 #define rc_inet6addr    rc_haddr.had_inet6addr
 107 #define rc_nam          rc_haddr.had_nam
 108
 109 /* Cache entry states */
 110 #define RC_UNUSED       0
 111 #define RC_INPROG       1
 112 #define RC_DONE         2
 113
 114 /* Return values */
 115 #define RC_DROPIT       0
 116 #define RC_REPLY        1
 117 #define RC_DOIT         2
 118 #define RC_CHECKIT      3
 119
 120 /* Flag bits */
 121 #define RC_LOCKED       0x01
 122 #define RC_WANTED       0x02
 123 #define RC_REPSTATUS    0x04
 124 #define RC_REPMBUF      0x08
 125 #define RC_INETADDR     0x20
 126 #define RC_NAM          0x40
 127
 128 extern lck_grp_t *nfsrv_reqcache_lck_grp;
 129 extern lck_mtx_t *nfsrv_reqcache_mutex;
 130
 131 #endif /* __APPLE_API_PRIVATE */
 132 #endif /* _NFS_NFSRVCACHE_H_ */