[linux-block.git] / include / linux / sunrpc / metrics.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  linux/include/linux/sunrpc/metrics.h
 *
 *  Declarations for RPC client per-operation metrics
 *
 *  Copyright (C) 2005	Chuck Lever <cel@netapp.com>
 *
 *  RPC client per-operation statistics provide latency and retry
 *  information about each type of RPC procedure in a given RPC program.
 *  These statistics are not for detailed problem diagnosis, but simply
 *  to indicate whether the problem is local or remote.
 *
 *  These counters are not meant to be human-readable, but are meant to be
 *  integrated into system monitoring tools such as "sar" and "iostat".  As
 *  such, the counters are sampled by the tools over time, and are never
 *  zeroed after a file system is mounted.  Moving averages can be computed
 *  by the tools by taking the difference between two instantaneous samples
 *  and dividing that by the time between the samples.
 *
 *  The counters are maintained in a single array per RPC client, indexed
 *  by procedure number.  There is no need to maintain separate counter
 *  arrays per-CPU because these counters are always modified behind locks.
 */

#ifndef _LINUX_SUNRPC_METRICS_H
#define _LINUX_SUNRPC_METRICS_H

#include <linux/seq_file.h>
#include <linux/ktime.h>
#include <linux/spinlock.h>

#define RPC_IOSTATS_VERS	"1.0"

struct rpc_iostats {
	spinlock_t		om_lock;

	/*
	 * These counters give an idea about how many request
	 * transmissions are required, on average, to complete that
	 * particular procedure.  Some procedures may require more
	 * than one transmission because the server is unresponsive,
	 * the client is retransmitting too aggressively, or the
	 * requests are large and the network is congested.
	 */
	unsigned long		om_ops,		/* count of operations */
				om_ntrans,	/* count of RPC transmissions */
				om_timeouts;	/* count of major timeouts */

	/*
	 * These count how many bytes are sent and received for a
	 * given RPC procedure type.  This indicates how much load a
	 * particular procedure is putting on the network.  These
	 * counts include the RPC and ULP headers, and the request
	 * payload.
	 */
	unsigned long long      om_bytes_sent,	/* count of bytes out */
				om_bytes_recv;	/* count of bytes in */

	/*
	 * The length of time an RPC request waits in queue before
	 * transmission, the network + server latency of the request,
	 * and the total time the request spent from init to release
	 * are measured.
	 */
	ktime_t			om_queue,	/* queued for xmit */
				om_rtt,		/* RPC RTT */
				om_execute;	/* RPC execution */
} ____cacheline_aligned;

struct rpc_task;
struct rpc_clnt;

/*
 * EXPORTed functions for managing rpc_iostats structures
 */

#ifdef CONFIG_PROC_FS

struct rpc_iostats *	rpc_alloc_iostats(struct rpc_clnt *);
void			rpc_count_iostats(const struct rpc_task *,
					  struct rpc_iostats *);
void			rpc_count_iostats_metrics(const struct rpc_task *,
					  struct rpc_iostats *);
void			rpc_print_iostats(struct seq_file *, struct rpc_clnt *);
void			rpc_free_iostats(struct rpc_iostats *);

#else  /*  CONFIG_PROC_FS  */

static inline struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt) { return NULL; }
static inline void rpc_count_iostats(const struct rpc_task *task,
				     struct rpc_iostats *stats) {}
static inline void rpc_count_iostats_metrics(const struct rpc_task *task,
					     struct rpc_iostats *stats)
{
}

static inline void rpc_print_iostats(struct seq_file *seq, struct rpc_clnt *clnt) {}
static inline void rpc_free_iostats(struct rpc_iostats *stats) {}

#endif  /*  CONFIG_PROC_FS  */

#endif /* _LINUX_SUNRPC_METRICS_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
11c556b3 CL	2	/*
	3	* linux/include/linux/sunrpc/metrics.h
	4	*
	5	* Declarations for RPC client per-operation metrics
	6	*
	7	* Copyright (C) 2005 Chuck Lever <cel@netapp.com>
	8	*
	9	* RPC client per-operation statistics provide latency and retry
	10	* information about each type of RPC procedure in a given RPC program.
	11	* These statistics are not for detailed problem diagnosis, but simply
	12	* to indicate whether the problem is local or remote.
	13	*
	14	* These counters are not meant to be human-readable, but are meant to be
	15	* integrated into system monitoring tools such as "sar" and "iostat". As
	16	* such, the counters are sampled by the tools over time, and are never
	17	* zeroed after a file system is mounted. Moving averages can be computed
	18	* by the tools by taking the difference between two instantaneous samples
	19	* and dividing that by the time between the samples.
	20	*
	21	* The counters are maintained in a single array per RPC client, indexed
	22	* by procedure number. There is no need to maintain separate counter
	23	* arrays per-CPU because these counters are always modified behind locks.
	24	*/
	25
	26	#ifndef _LINUX_SUNRPC_METRICS_H
	27	#define _LINUX_SUNRPC_METRICS_H
	28
	29	#include <linux/seq_file.h>
ff839970	30	#include <linux/ktime.h>
edef1297	31	#include <linux/spinlock.h>
11c556b3 CL	32
	33	#define RPC_IOSTATS_VERS "1.0"
	34
	35	struct rpc_iostats {
edef1297 CL	36	spinlock_t om_lock;
edef1297 CL	37
11c556b3 CL	38	/*
	39	* These counters give an idea about how many request
	40	* transmissions are required, on average, to complete that
	41	* particular procedure. Some procedures may require more
	42	* than one transmission because the server is unresponsive,
	43	* the client is retransmitting too aggressively, or the
	44	* requests are large and the network is congested.
	45	*/
	46	unsigned long om_ops, /* count of operations */
	47	om_ntrans, /* count of RPC transmissions */
	48	om_timeouts; /* count of major timeouts */
	49
	50	/*
	51	* These count how many bytes are sent and received for a
	52	* given RPC procedure type. This indicates how much load a
	53	* particular procedure is putting on the network. These
	54	* counts include the RPC and ULP headers, and the request
	55	* payload.
	56	*/
	57	unsigned long long om_bytes_sent, /* count of bytes out */
	58	om_bytes_recv; /* count of bytes in */
	59
	60	/*
	61	* The length of time an RPC request waits in queue before
	62	* transmission, the network + server latency of the request,
	63	* and the total time the request spent from init to release
	64	* are measured.
	65	*/
ff839970 CL	66	ktime_t om_queue, /* queued for xmit */
	67	om_rtt, /* RPC RTT */
	68	om_execute; /* RPC execution */
11c556b3 CL	69	} ____cacheline_aligned;
	70
	71	struct rpc_task;
	72	struct rpc_clnt;
	73
	74	/*
	75	* EXPORTed functions for managing rpc_iostats structures
	76	*/
7866baba AB	77
	78	#ifdef CONFIG_PROC_FS
	79
11c556b3	80	struct rpc_iostats * rpc_alloc_iostats(struct rpc_clnt *);
0a702195 WAA	81	void rpc_count_iostats(const struct rpc_task *,
0a702195 WAA	82	struct rpc_iostats *);
840210fc WAA	83	void rpc_count_iostats_metrics(const struct rpc_task *,
840210fc WAA	84	struct rpc_iostats *);
11c556b3 CL	85	void rpc_print_iostats(struct seq_file , struct rpc_clnt );
	86	void rpc_free_iostats(struct rpc_iostats *);
	87
7866baba AB	88	#else /* CONFIG_PROC_FS */
	89
	90	static inline struct rpc_iostats rpc_alloc_iostats(struct rpc_clnt clnt) { return NULL; }
0a702195 WAA	91	static inline void rpc_count_iostats(const struct rpc_task *task,
0a702195 WAA	92	struct rpc_iostats *stats) {}
54d7e72a TM	93	static inline void rpc_count_iostats_metrics(const struct rpc_task *task,
	94	struct rpc_iostats *stats)
	95	{
	96	}
	97
7866baba AB	98	static inline void rpc_print_iostats(struct seq_file seq, struct rpc_clnt clnt) {}
	99	static inline void rpc_free_iostats(struct rpc_iostats *stats) {}
	100
	101	#endif /* CONFIG_PROC_FS */
	102
11c556b3	103	#endif /* _LINUX_SUNRPC_METRICS_H */