bsd/nfs/nfsrtt.h

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