[apple/xnu.git] / bsd / nfs / nfsrtt.h

/*
 * Copyright (c) 2000-2002 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
/*
 * Copyright (c) 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Rick Macklem at The University of Guelph.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)nfsrtt.h	8.2 (Berkeley) 3/30/95
 * FreeBSD-Id: nfsrtt.h,v 1.8 1997/06/03 17:22:47 dfr Exp $
 */


#ifndef _NFS_NFSRTT_H_
#define _NFS_NFSRTT_H_

#include <sys/appleapiopts.h>

#ifdef __APPLE_API_PRIVATE
/*
 * Definitions for performance monitor.
 * The client and server logging are turned on by setting the global
 * constant "nfsrtton" to 1.
 */
#define	NFSRTTLOGSIZ	128

/*
 * Circular log of client side rpc activity. Each log entry is for one
 * rpc filled in upon completion. (ie. in order of completion)
 * The "pos" is the table index for the "next" entry, therefore the
 * list goes from nfsrtt.rttl[pos] --> nfsrtt.rttl[pos - 1] in
 * chronological order of completion.
 */
struct nfsrtt {
	int pos;			/* Position in array for next entry */
	struct rttl {
		u_int32_t proc;		/* NFS procedure number */
		int	rtt;		/* Measured round trip time */
		int	rto;		/* Round Trip Timeout */
		int	sent;		/* # rpcs in progress */
		int	cwnd;		/* Send window */
		int	srtt;		/* Ave Round Trip Time */
		int	sdrtt;		/* Ave mean deviation of RTT */
		fsid_t	fsid;		/* Fsid for mount point */
		struct timeval tstamp;	/* Timestamp of log entry */
	} rttl[NFSRTTLOGSIZ];
};

/*
 * And definitions for server side performance monitor.
 * The log organization is the same as above except it is filled in at the
 * time the server sends the rpc reply.
 */

/*
 * Bits for the flags field.
 */
#define	DRT_NQNFS	0x01	/* Rpc used Nqnfs protocol */
#define	DRT_TCP		0x02	/* Client used TCP transport */
#define	DRT_CACHEREPLY	0x04	/* Reply was from recent request cache */
#define	DRT_CACHEDROP	0x08	/* Rpc request dropped, due to recent reply */
#define DRT_NFSV3	0x10	/* Rpc used NFS Version 3 */

/*
 * Server log structure
 * NB: ipadr == INADDR_ANY indicates a client using a non IP protocol.
 *	(ISO perhaps?)
 */
struct nfsdrt {
	int pos;			/* Position of next log entry */
	struct drt {
		int	flag;		/* Bits as defined above */
		u_int32_t proc;		/* NFS procedure number */
		u_long	ipadr;		/* IP address of client */
		int	resptime;	/* Response time (usec) */
		struct timeval tstamp;	/* Timestamp of log entry */
	} drt[NFSRTTLOGSIZ];
};

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