bsd/nfs/nfsrtt.h

   1 /*
   2  * Copyright (c) 2000-2004 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_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. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
  24 /*
  25  * Copyright (c) 1992, 1993
  26  *      The Regents of the University of California.  All rights reserved.
  27  *
  28  * This code is derived from software contributed to Berkeley by
  29  * Rick Macklem at The University of Guelph.
  30  *
  31  * Redistribution and use in source and binary forms, with or without
  32  * modification, are permitted provided that the following conditions
  33  * are met:
  34  * 1. Redistributions of source code must retain the above copyright
  35  *    notice, this list of conditions and the following disclaimer.
  36  * 2. Redistributions in binary form must reproduce the above copyright
  37  *    notice, this list of conditions and the following disclaimer in the
  38  *    documentation and/or other materials provided with the distribution.
  39  * 3. All advertising materials mentioning features or use of this software
  40  *    must display the following acknowledgement:
  41  *      This product includes software developed by the University of
  42  *      California, Berkeley and its contributors.
  43  * 4. Neither the name of the University nor the names of its contributors
  44  *    may be used to endorse or promote products derived from this software
  45  *    without specific prior written permission.
  46  *
  47  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  48  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  49  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  50  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  51  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  52  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  53  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  54  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  55  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  56  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  57  * SUCH DAMAGE.
  58  *
  59  *      @(#)nfsrtt.h    8.2 (Berkeley) 3/30/95
  60  * FreeBSD-Id: nfsrtt.h,v 1.8 1997/06/03 17:22:47 dfr Exp $
  61  */
  62
  63
  64 #ifndef _NFS_NFSRTT_H_
  65 #define _NFS_NFSRTT_H_
  66
  67 #include <sys/appleapiopts.h>
  68
  69 #ifdef __APPLE_API_PRIVATE
  70 /*
  71  * Definitions for performance monitor.
  72  * The client and server logging are turned on by setting the global
  73  * constant "nfsrtton" to 1.
  74  */
  75 #define NFSRTTLOGSIZ    128
  76
  77 /*
  78  * Circular log of client side rpc activity. Each log entry is for one
  79  * rpc filled in upon completion. (ie. in order of completion)
  80  * The "pos" is the table index for the "next" entry, therefore the
  81  * list goes from nfsrtt.rttl[pos] --> nfsrtt.rttl[pos - 1] in
  82  * chronological order of completion.
  83  */
  84 struct nfsrtt {
  85         int pos;                        /* Position in array for next entry */
  86         struct rttl {
  87                 u_int32_t proc;         /* NFS procedure number */
  88                 int     rtt;            /* Measured round trip time */
  89                 int     rto;            /* Round Trip Timeout */
  90                 int     sent;           /* # rpcs in progress */
  91                 int     cwnd;           /* Send window */
  92                 int     srtt;           /* Ave Round Trip Time */
  93                 int     sdrtt;          /* Ave mean deviation of RTT */
  94                 fsid_t  fsid;           /* Fsid for mount point */
  95                 struct timeval tstamp;  /* Timestamp of log entry */
  96         } rttl[NFSRTTLOGSIZ];
  97 };
  98
  99 /*
 100  * And definitions for server side performance monitor.
 101  * The log organization is the same as above except it is filled in at the
 102  * time the server sends the rpc reply.
 103  */
 104
 105 /*
 106  * Bits for the flags field.
 107  */
 108 #define DRT_TCP         0x02    /* Client used TCP transport */
 109 #define DRT_CACHEREPLY  0x04    /* Reply was from recent request cache */
 110 #define DRT_CACHEDROP   0x08    /* Rpc request dropped, due to recent reply */
 111 #define DRT_NFSV3       0x10    /* Rpc used NFS Version 3 */
 112
 113 /*
 114  * Server log structure
 115  * NB: ipadr == INADDR_ANY indicates a client using a non IP protocol.
 116  *      (ISO perhaps?)
 117  */
 118 struct nfsdrt {
 119         int pos;                        /* Position of next log entry */
 120         struct drt {
 121                 int     flag;           /* Bits as defined above */
 122                 u_int32_t proc;         /* NFS procedure number */
 123                 u_long  ipadr;          /* IP address of client */
 124                 int     resptime;       /* Response time (usec) */
 125                 struct timeval tstamp;  /* Timestamp of log entry */
 126         } drt[NFSRTTLOGSIZ];
 127 };
 128
 129 #endif /* __APPLE_API_PRIVATE */
 130 #endif /* _NFS_NFSRTT_H_ */