bsd/nfs/nfsrtt.h

   1 /*
   2  * Copyright (c) 2006 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) 1992, 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  *      @(#)nfsrtt.h    8.2 (Berkeley) 3/30/95
  67  * FreeBSD-Id: nfsrtt.h,v 1.8 1997/06/03 17:22:47 dfr Exp $
  68  */
  69
  70
  71 #ifndef _NFS_NFSRTT_H_
  72 #define _NFS_NFSRTT_H_
  73
  74 #include <sys/appleapiopts.h>
  75
  76 #ifdef __APPLE_API_PRIVATE
  77 /*
  78  * Definitions for performance monitor.
  79  * The client and server logging are turned on by setting the global
  80  * constant "nfsrtton" to 1.
  81  */
  82 #define NFSRTTLOGSIZ    128
  83
  84 /*
  85  * Circular log of client side rpc activity. Each log entry is for one
  86  * rpc filled in upon completion. (ie. in order of completion)
  87  * The "pos" is the table index for the "next" entry, therefore the
  88  * list goes from nfsrtt.rttl[pos] --> nfsrtt.rttl[pos - 1] in
  89  * chronological order of completion.
  90  */
  91 struct nfsrtt {
  92         int pos;                        /* Position in array for next entry */
  93         struct rttl {
  94                 u_int32_t proc;         /* NFS procedure number */
  95                 int     rtt;            /* Measured round trip time */
  96                 int     rto;            /* Round Trip Timeout */
  97                 int     sent;           /* # rpcs in progress */
  98                 int     cwnd;           /* Send window */
  99                 int     srtt;           /* Ave Round Trip Time */
 100                 int     sdrtt;          /* Ave mean deviation of RTT */
 101                 fsid_t  fsid;           /* Fsid for mount point */
 102                 struct timeval tstamp;  /* Timestamp of log entry */
 103         } rttl[NFSRTTLOGSIZ];
 104 };
 105
 106 /*
 107  * And definitions for server side performance monitor.
 108  * The log organization is the same as above except it is filled in at the
 109  * time the server sends the rpc reply.
 110  */
 111
 112 /*
 113  * Bits for the flags field.
 114  */
 115 #define DRT_TCP         0x02    /* Client used TCP transport */
 116 #define DRT_CACHEREPLY  0x04    /* Reply was from recent request cache */
 117 #define DRT_CACHEDROP   0x08    /* Rpc request dropped, due to recent reply */
 118 #define DRT_NFSV3       0x10    /* Rpc used NFS Version 3 */
 119
 120 /*
 121  * Server log structure
 122  * NB: ipadr == INADDR_ANY indicates a client using a non IP protocol.
 123  *      (ISO perhaps?)
 124  */
 125 struct nfsdrt {
 126         int pos;                        /* Position of next log entry */
 127         struct drt {
 128                 int     flag;           /* Bits as defined above */
 129                 u_int32_t proc;         /* NFS procedure number */
 130                 u_long  ipadr;          /* IP address of client */
 131                 int     resptime;       /* Response time (usec) */
 132                 struct timeval tstamp;  /* Timestamp of log entry */
 133         } drt[NFSRTTLOGSIZ];
 134 };
 135
 136 #endif /* __APPLE_API_PRIVATE */
 137 #endif /* _NFS_NFSRTT_H_ */