[linux-block.git] / fs / ceph / metric.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _FS_CEPH_MDS_METRIC_H
#define _FS_CEPH_MDS_METRIC_H

#include <linux/types.h>
#include <linux/percpu_counter.h>
#include <linux/ktime.h>

extern bool disable_send_metrics;

enum ceph_metric_type {
	CLIENT_METRIC_TYPE_CAP_INFO,
	CLIENT_METRIC_TYPE_READ_LATENCY,
	CLIENT_METRIC_TYPE_WRITE_LATENCY,
	CLIENT_METRIC_TYPE_METADATA_LATENCY,
	CLIENT_METRIC_TYPE_DENTRY_LEASE,
	CLIENT_METRIC_TYPE_OPENED_FILES,
	CLIENT_METRIC_TYPE_PINNED_ICAPS,
	CLIENT_METRIC_TYPE_OPENED_INODES,
	CLIENT_METRIC_TYPE_READ_IO_SIZES,
	CLIENT_METRIC_TYPE_WRITE_IO_SIZES,

	CLIENT_METRIC_TYPE_MAX = CLIENT_METRIC_TYPE_WRITE_IO_SIZES,
};

/*
 * This will always have the highest metric bit value
 * as the last element of the array.
 */
#define CEPHFS_METRIC_SPEC_CLIENT_SUPPORTED {	\
	CLIENT_METRIC_TYPE_CAP_INFO,		\
	CLIENT_METRIC_TYPE_READ_LATENCY,	\
	CLIENT_METRIC_TYPE_WRITE_LATENCY,	\
	CLIENT_METRIC_TYPE_METADATA_LATENCY,	\
	CLIENT_METRIC_TYPE_DENTRY_LEASE,	\
	CLIENT_METRIC_TYPE_OPENED_FILES,	\
	CLIENT_METRIC_TYPE_PINNED_ICAPS,	\
	CLIENT_METRIC_TYPE_OPENED_INODES,	\
	CLIENT_METRIC_TYPE_READ_IO_SIZES,	\
	CLIENT_METRIC_TYPE_WRITE_IO_SIZES,	\
						\
	CLIENT_METRIC_TYPE_MAX,			\
}

struct ceph_metric_header {
	__le32 type;     /* ceph metric type */
	__u8  ver;
	__u8  compat;
	__le32 data_len; /* length of sizeof(hit + mis + total) */
} __packed;

/* metric caps header */
struct ceph_metric_cap {
	struct ceph_metric_header header;
	__le64 hit;
	__le64 mis;
	__le64 total;
} __packed;

/* metric read latency header */
struct ceph_metric_read_latency {
	struct ceph_metric_header header;
	__le32 sec;
	__le32 nsec;
} __packed;

/* metric write latency header */
struct ceph_metric_write_latency {
	struct ceph_metric_header header;
	__le32 sec;
	__le32 nsec;
} __packed;

/* metric metadata latency header */
struct ceph_metric_metadata_latency {
	struct ceph_metric_header header;
	__le32 sec;
	__le32 nsec;
} __packed;

/* metric dentry lease header */
struct ceph_metric_dlease {
	struct ceph_metric_header header;
	__le64 hit;
	__le64 mis;
	__le64 total;
} __packed;

/* metric opened files header */
struct ceph_opened_files {
	struct ceph_metric_header header;
	__le64 opened_files;
	__le64 total;
} __packed;

/* metric pinned i_caps header */
struct ceph_pinned_icaps {
	struct ceph_metric_header header;
	__le64 pinned_icaps;
	__le64 total;
} __packed;

/* metric opened inodes header */
struct ceph_opened_inodes {
	struct ceph_metric_header header;
	__le64 opened_inodes;
	__le64 total;
} __packed;

/* metric read io size header */
struct ceph_read_io_size {
	struct ceph_metric_header header;
	__le64 total_ops;
	__le64 total_size;
} __packed;

/* metric write io size header */
struct ceph_write_io_size {
	struct ceph_metric_header header;
	__le64 total_ops;
	__le64 total_size;
} __packed;

struct ceph_metric_head {
	__le32 num;	/* the number of metrics that will be sent */
} __packed;

/* This is the global metrics */
struct ceph_client_metric {
	atomic64_t            total_dentries;
	struct percpu_counter d_lease_hit;
	struct percpu_counter d_lease_mis;

	atomic64_t            total_caps;
	struct percpu_counter i_caps_hit;
	struct percpu_counter i_caps_mis;

	spinlock_t read_metric_lock;
	u64 total_reads;
	u64 read_size_sum;
	u64 read_size_min;
	u64 read_size_max;
	ktime_t read_latency_sum;
	ktime_t read_latency_sq_sum;
	ktime_t read_latency_min;
	ktime_t read_latency_max;

	spinlock_t write_metric_lock;
	u64 total_writes;
	u64 write_size_sum;
	u64 write_size_min;
	u64 write_size_max;
	ktime_t write_latency_sum;
	ktime_t write_latency_sq_sum;
	ktime_t write_latency_min;
	ktime_t write_latency_max;

	spinlock_t metadata_metric_lock;
	u64 total_metadatas;
	ktime_t metadata_latency_sum;
	ktime_t metadata_latency_sq_sum;
	ktime_t metadata_latency_min;
	ktime_t metadata_latency_max;

	/* The total number of directories and files that are opened */
	atomic64_t opened_files;

	/* The total number of inodes that have opened files or directories */
	struct percpu_counter opened_inodes;
	struct percpu_counter total_inodes;

	struct ceph_mds_session *session;
	struct delayed_work delayed_work;  /* delayed work */
};

static inline void metric_schedule_delayed(struct ceph_client_metric *m)
{
	if (disable_send_metrics)
		return;

	/* per second */
	schedule_delayed_work(&m->delayed_work, round_jiffies_relative(HZ));
}

extern int ceph_metric_init(struct ceph_client_metric *m);
extern void ceph_metric_destroy(struct ceph_client_metric *m);

static inline void ceph_update_cap_hit(struct ceph_client_metric *m)
{
	percpu_counter_inc(&m->i_caps_hit);
}

static inline void ceph_update_cap_mis(struct ceph_client_metric *m)
{
	percpu_counter_inc(&m->i_caps_mis);
}

extern void ceph_update_read_metrics(struct ceph_client_metric *m,
				     ktime_t r_start, ktime_t r_end,
				     unsigned int size, int rc);
extern void ceph_update_write_metrics(struct ceph_client_metric *m,
				      ktime_t r_start, ktime_t r_end,
				      unsigned int size, int rc);
extern void ceph_update_metadata_metrics(struct ceph_client_metric *m,
				         ktime_t r_start, ktime_t r_end,
					 int rc);
#endif /* _FS_CEPH_MDS_METRIC_H */
Commit	Line	Data
f9009efa XL	1	/* SPDX-License-Identifier: GPL-2.0 */
	2	#ifndef _FS_CEPH_MDS_METRIC_H
	3	#define _FS_CEPH_MDS_METRIC_H
	4
	5	#include <linux/types.h>
	6	#include <linux/percpu_counter.h>
97e27aaa	7	#include <linux/ktime.h>
f9009efa	8
18f473b3 XL	9	extern bool disable_send_metrics;
	10
	11	enum ceph_metric_type {
	12	CLIENT_METRIC_TYPE_CAP_INFO,
	13	CLIENT_METRIC_TYPE_READ_LATENCY,
	14	CLIENT_METRIC_TYPE_WRITE_LATENCY,
	15	CLIENT_METRIC_TYPE_METADATA_LATENCY,
	16	CLIENT_METRIC_TYPE_DENTRY_LEASE,
3d8b6987 XL	17	CLIENT_METRIC_TYPE_OPENED_FILES,
	18	CLIENT_METRIC_TYPE_PINNED_ICAPS,
	19	CLIENT_METRIC_TYPE_OPENED_INODES,
903f4fec XL	20	CLIENT_METRIC_TYPE_READ_IO_SIZES,
903f4fec XL	21	CLIENT_METRIC_TYPE_WRITE_IO_SIZES,
18f473b3	22
903f4fec	23	CLIENT_METRIC_TYPE_MAX = CLIENT_METRIC_TYPE_WRITE_IO_SIZES,
18f473b3 XL	24	};
18f473b3 XL	25
3b4168dd XL	26	/*
	27	* This will always have the highest metric bit value
	28	* as the last element of the array.
	29	*/
	30	#define CEPHFS_METRIC_SPEC_CLIENT_SUPPORTED { \
	31	CLIENT_METRIC_TYPE_CAP_INFO, \
	32	CLIENT_METRIC_TYPE_READ_LATENCY, \
	33	CLIENT_METRIC_TYPE_WRITE_LATENCY, \
	34	CLIENT_METRIC_TYPE_METADATA_LATENCY, \
8ba3b8c7	35	CLIENT_METRIC_TYPE_DENTRY_LEASE, \
3d8b6987 XL	36	CLIENT_METRIC_TYPE_OPENED_FILES, \
	37	CLIENT_METRIC_TYPE_PINNED_ICAPS, \
	38	CLIENT_METRIC_TYPE_OPENED_INODES, \
903f4fec XL	39	CLIENT_METRIC_TYPE_READ_IO_SIZES, \
903f4fec XL	40	CLIENT_METRIC_TYPE_WRITE_IO_SIZES, \
3b4168dd XL	41	\
	42	CLIENT_METRIC_TYPE_MAX, \
	43	}
	44
8ecd34c7	45	struct ceph_metric_header {
18f473b3	46	__le32 type; /* ceph metric type */
18f473b3 XL	47	__u8 ver;
18f473b3 XL	48	__u8 compat;
18f473b3	49	__le32 data_len; /* length of sizeof(hit + mis + total) */
8ecd34c7 XL	50	} __packed;
	51
	52	/* metric caps header */
	53	struct ceph_metric_cap {
	54	struct ceph_metric_header header;
18f473b3 XL	55	__le64 hit;
	56	__le64 mis;
	57	__le64 total;
	58	} __packed;
	59
	60	/* metric read latency header */
	61	struct ceph_metric_read_latency {
8ecd34c7	62	struct ceph_metric_header header;
18f473b3 XL	63	__le32 sec;
	64	__le32 nsec;
	65	} __packed;
	66
	67	/* metric write latency header */
	68	struct ceph_metric_write_latency {
8ecd34c7	69	struct ceph_metric_header header;
18f473b3 XL	70	__le32 sec;
	71	__le32 nsec;
	72	} __packed;
	73
	74	/* metric metadata latency header */
	75	struct ceph_metric_metadata_latency {
8ecd34c7	76	struct ceph_metric_header header;
18f473b3 XL	77	__le32 sec;
	78	__le32 nsec;
	79	} __packed;
	80
8ba3b8c7 XL	81	/* metric dentry lease header */
8ba3b8c7 XL	82	struct ceph_metric_dlease {
8ecd34c7	83	struct ceph_metric_header header;
8ba3b8c7 XL	84	__le64 hit;
	85	__le64 mis;
	86	__le64 total;
	87	} __packed;
	88
3d8b6987 XL	89	/* metric opened files header */
3d8b6987 XL	90	struct ceph_opened_files {
8ecd34c7	91	struct ceph_metric_header header;
3d8b6987 XL	92	__le64 opened_files;
	93	__le64 total;
	94	} __packed;
	95
	96	/* metric pinned i_caps header */
	97	struct ceph_pinned_icaps {
8ecd34c7	98	struct ceph_metric_header header;
3d8b6987 XL	99	__le64 pinned_icaps;
	100	__le64 total;
	101	} __packed;
	102
	103	/* metric opened inodes header */
	104	struct ceph_opened_inodes {
8ecd34c7	105	struct ceph_metric_header header;
3d8b6987 XL	106	__le64 opened_inodes;
	107	__le64 total;
	108	} __packed;
	109
903f4fec XL	110	/* metric read io size header */
	111	struct ceph_read_io_size {
	112	struct ceph_metric_header header;
	113	__le64 total_ops;
	114	__le64 total_size;
	115	} __packed;
	116
	117	/* metric write io size header */
	118	struct ceph_write_io_size {
	119	struct ceph_metric_header header;
	120	__le64 total_ops;
	121	__le64 total_size;
	122	} __packed;
	123
18f473b3 XL	124	struct ceph_metric_head {
	125	__le32 num; /* the number of metrics that will be sent */
	126	} __packed;
	127
f9009efa XL	128	/* This is the global metrics */
	129	struct ceph_client_metric {
	130	atomic64_t total_dentries;
	131	struct percpu_counter d_lease_hit;
	132	struct percpu_counter d_lease_mis;
1af16d54	133
4f1d756d	134	atomic64_t total_caps;
1af16d54 XL	135	struct percpu_counter i_caps_hit;
1af16d54 XL	136	struct percpu_counter i_caps_mis;
97e27aaa	137
8ae99ae2	138	spinlock_t read_metric_lock;
97e27aaa	139	u64 total_reads;
903f4fec XL	140	u64 read_size_sum;
	141	u64 read_size_min;
	142	u64 read_size_max;
97e27aaa XL	143	ktime_t read_latency_sum;
	144	ktime_t read_latency_sq_sum;
	145	ktime_t read_latency_min;
	146	ktime_t read_latency_max;
	147
8ae99ae2	148	spinlock_t write_metric_lock;
97e27aaa	149	u64 total_writes;
903f4fec XL	150	u64 write_size_sum;
	151	u64 write_size_min;
	152	u64 write_size_max;
97e27aaa XL	153	ktime_t write_latency_sum;
	154	ktime_t write_latency_sq_sum;
	155	ktime_t write_latency_min;
	156	ktime_t write_latency_max;
70c94820	157
8ae99ae2	158	spinlock_t metadata_metric_lock;
70c94820 XL	159	u64 total_metadatas;
	160	ktime_t metadata_latency_sum;
	161	ktime_t metadata_latency_sq_sum;
	162	ktime_t metadata_latency_min;
	163	ktime_t metadata_latency_max;
18f473b3	164
1dd8d470 XL	165	/* The total number of directories and files that are opened */
	166	atomic64_t opened_files;
	167
	168	/* The total number of inodes that have opened files or directories */
	169	struct percpu_counter opened_inodes;
	170	struct percpu_counter total_inodes;
	171
18f473b3 XL	172	struct ceph_mds_session *session;
18f473b3 XL	173	struct delayed_work delayed_work; /* delayed work */
f9009efa XL	174	};
f9009efa XL	175
18f473b3 XL	176	static inline void metric_schedule_delayed(struct ceph_client_metric *m)
	177	{
	178	if (disable_send_metrics)
	179	return;
	180
	181	/* per second */
	182	schedule_delayed_work(&m->delayed_work, round_jiffies_relative(HZ));
	183	}
	184
f9009efa XL	185	extern int ceph_metric_init(struct ceph_client_metric *m);
f9009efa XL	186	extern void ceph_metric_destroy(struct ceph_client_metric *m);
1af16d54 XL	187
	188	static inline void ceph_update_cap_hit(struct ceph_client_metric *m)
	189	{
	190	percpu_counter_inc(&m->i_caps_hit);
	191	}
	192
	193	static inline void ceph_update_cap_mis(struct ceph_client_metric *m)
	194	{
	195	percpu_counter_inc(&m->i_caps_mis);
	196	}
97e27aaa	197
8ae99ae2	198	extern void ceph_update_read_metrics(struct ceph_client_metric *m,
97e27aaa	199	ktime_t r_start, ktime_t r_end,
903f4fec	200	unsigned int size, int rc);
8ae99ae2	201	extern void ceph_update_write_metrics(struct ceph_client_metric *m,
97e27aaa	202	ktime_t r_start, ktime_t r_end,
903f4fec	203	unsigned int size, int rc);
8ae99ae2	204	extern void ceph_update_metadata_metrics(struct ceph_client_metric *m,
70c94820 XL	205	ktime_t r_start, ktime_t r_end,
70c94820 XL	206	int rc);
f9009efa	207	#endif /* _FS_CEPH_MDS_METRIC_H */