[mirror_spl.git] / include / sys / kstat.h

/*
 *  This file is part of the SPL: Solaris Porting Layer.
 *
 *  Copyright (c) 2008 Lawrence Livermore National Security, LLC.
 *  Produced at Lawrence Livermore National Laboratory
 *  Written by:
 *          Brian Behlendorf <behlendorf1@llnl.gov>,
 *          Herb Wartens <wartens2@llnl.gov>,
 *          Jim Garlick <garlick@llnl.gov>
 *  UCRL-CODE-235197
 *
 *  This is free software; you can redistribute it and/or modify it
 *  under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This is distributed in the hope that it will be useful, but WITHOUT
 *  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 *  for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
 */

#ifndef _SPL_KSTAT_H
#define _SPL_KSTAT_H

#ifdef  __cplusplus
extern "C" {
#endif

#include <linux/module.h>
#include <sys/types.h>
#include <sys/time.h>
#include <sys/kmem.h>
#include <sys/proc.h>

#define KSTAT_STRLEN            31

/* For reference valid classes are:
 * disk, tape, net, controller, vm, kvm, hat, streams, kstat, misc
 */

#define KSTAT_TYPE_RAW          0       /* can be anything; ks_ndata >= 1 */
#define KSTAT_TYPE_NAMED        1       /* name/value pair; ks_ndata >= 1 */
#define KSTAT_TYPE_INTR         2       /* interrupt stats; ks_ndata == 1 */
#define KSTAT_TYPE_IO           3       /* I/O stats; ks_ndata == 1 */
#define KSTAT_TYPE_TIMER        4       /* event timer; ks_ndata >= 1 */
#define KSTAT_NUM_TYPES         5

#define KSTAT_DATA_CHAR         0
#define KSTAT_DATA_INT32        1
#define KSTAT_DATA_UINT32       2
#define KSTAT_DATA_INT64        3
#define KSTAT_DATA_UINT64       4
#define KSTAT_DATA_LONG         5
#define KSTAT_DATA_ULONG        6
#define KSTAT_DATA_STRING       7
#define KSTAT_NUM_DATAS         8

#define KSTAT_INTR_HARD         0
#define KSTAT_INTR_SOFT         1
#define KSTAT_INTR_WATCHDOG     2
#define KSTAT_INTR_SPURIOUS     3
#define KSTAT_INTR_MULTSVC      4
#define KSTAT_NUM_INTRS         5

#define KSTAT_FLAG_VIRTUAL      0x01
#define KSTAT_FLAG_VAR_SIZE     0x02
#define KSTAT_FLAG_WRITABLE     0x04
#define KSTAT_FLAG_PERSISTENT   0x08
#define KSTAT_FLAG_DORMANT      0x10
#define KSTAT_FLAG_UNSUPPORTED  (KSTAT_FLAG_VAR_SIZE | KSTAT_FLAG_WRITABLE | \
				 KSTAT_FLAG_PERSISTENT | KSTAT_FLAG_DORMANT)


#define KS_MAGIC                0x9d9d9d9d

typedef int kid_t;              /* unique kstat id */

typedef struct kstat_s {
	int              ks_magic;                  /* magic value */
        kid_t            ks_kid;                    /* unique kstat ID */
        hrtime_t         ks_crtime;                 /* creation time */
	hrtime_t         ks_snaptime;               /* last access time */
        char             ks_module[KSTAT_STRLEN+1]; /* provider module name */
        int              ks_instance;               /* provider module instance */
        char             ks_name[KSTAT_STRLEN+1];   /* kstat name */
        char             ks_class[KSTAT_STRLEN+1];  /* kstat class */
        uchar_t          ks_type;                   /* kstat data type */
        uchar_t          ks_flags;                  /* kstat flags */
        void             *ks_data;                  /* kstat type-specific data */
        uint_t           ks_ndata;                  /* # of type-specific data records */
        size_t           ks_data_size;              /* size of kstat data section */
        struct proc_dir_entry *ks_proc;             /* proc linkage */
        spinlock_t       ks_lock;                   /* kstat data lock */
        struct list_head ks_list;                   /* kstat linkage */
} kstat_t;

typedef struct kstat_named_s {
        char             name[KSTAT_STRLEN];        /* name of counter */
        uchar_t          data_type;                 /* data type */
        union {
                char            c[16];              /* 128-bit int */
                int32_t         i32;                /* 32-bit signed int */
                uint32_t        ui32;               /* 32-bit unsigned int */
                int64_t         i64;                /* 64-bit signed int */
                uint64_t        ui64;               /* 64-bit unsigned int */
                long            l;                  /* native signed long */
                ulong_t         ul;                 /* native unsigned long */
                struct {
                        union {
                                char *ptr;          /* NULL-term string */
                                char __pad[8];      /* 64-bit padding */
                        } addr;
                        uint32_t len;               /* # bytes for strlen + '\0' */
                } string;
        } value;
} kstat_named_t;

#define KSTAT_NAMED_STR_PTR(knptr) ((knptr)->value.string.addr.ptr)
#define KSTAT_NAMED_STR_BUFLEN(knptr) ((knptr)->value.string.len)

typedef struct kstat_intr {
        uint_t intrs[KSTAT_NUM_INTRS];
} kstat_intr_t;

typedef struct kstat_io {
        u_longlong_t     nread;       /* number of bytes read */
        u_longlong_t     nwritten;    /* number of bytes written */
        uint_t           reads;       /* number of read operations */
        uint_t           writes;      /* number of write operations */
        hrtime_t         wtime;       /* cumulative wait (pre-service) time */
        hrtime_t         wlentime;    /* cumulative wait length*time product*/
        hrtime_t         wlastupdate; /* last time wait queue changed */
        hrtime_t         rtime;       /* cumulative run (service) time */
        hrtime_t         rlentime;    /* cumulative run length*time product */
        hrtime_t         rlastupdate; /* last time run queue changed */
        uint_t           wcnt;        /* count of elements in wait state */
        uint_t           rcnt;        /* count of elements in run state */
} kstat_io_t;

typedef struct kstat_timer {
        char         name[KSTAT_STRLEN+1]; /* event name */
        u_longlong_t num_events;           /* number of events */
        hrtime_t     elapsed_time;         /* cumulative elapsed time */
        hrtime_t     min_time;             /* shortest event duration */
        hrtime_t     max_time;             /* longest event duration */
        hrtime_t     start_time;           /* previous event start time */
        hrtime_t     stop_time;            /* previous event stop time */
} kstat_timer_t;

int kstat_init(void);
void kstat_fini(void);

#ifdef DEBUG_KSTAT
extern kstat_t *__kstat_create(const char *ks_module, int ks_instance,
			     const char *ks_name, const char *ks_class,
			     uchar_t ks_type, uint_t ks_ndata,
			     uchar_t ks_flags);
extern void __kstat_install(kstat_t *ksp);
extern void __kstat_delete(kstat_t *ksp);

#define kstat_create(m,i,n,c,t,s,f)	__kstat_create(m,i,n,c,t,s,f)
#define kstat_install(k)		__kstat_install(k)
#define kstat_delete(k)			__kstat_delete(k)

#else

#define kstat_create(m,i,n,c,t,s,f)	(NULL)
#define kstat_install(k)		((void)0)
#define kstat_delete(k)			((void)0)

#endif /* DEBUG_KSTAT */

#ifdef  __cplusplus
}
#endif

#endif  /* _SPL_KSTAT_H */
Commit	Line	Data
715f6251	1	/*
	2	* This file is part of the SPL: Solaris Porting Layer.
	3	*
	4	* Copyright (c) 2008 Lawrence Livermore National Security, LLC.
	5	* Produced at Lawrence Livermore National Laboratory
	6	* Written by:
	7	* Brian Behlendorf <behlendorf1@llnl.gov>,
	8	* Herb Wartens <wartens2@llnl.gov>,
	9	* Jim Garlick <garlick@llnl.gov>
	10	* UCRL-CODE-235197
	11	*
	12	* This is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License as published by
	14	* the Free Software Foundation; either version 2 of the License, or
	15	* (at your option) any later version.
	16	*
	17	* This is distributed in the hope that it will be useful, but WITHOUT
	18	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	19	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
	20	* for more details.
	21	*
	22	* You should have received a copy of the GNU General Public License along
	23	* with this program; if not, write to the Free Software Foundation, Inc.,
	24	* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
	25	*/
	26
09b414e8	27	#ifndef _SPL_KSTAT_H
09b414e8	28	#define _SPL_KSTAT_H
f1ca4da6	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
f1b59d26	34	#include <linux/module.h>
f4b37741	35	#include <sys/types.h>
f4b37741	36	#include <sys/time.h>
04a479f7	37	#include <sys/kmem.h>
04a479f7	38	#include <sys/proc.h>
f1ca4da6	39
04a479f7	40	#define KSTAT_STRLEN 31
f1ca4da6	41
04a479f7	42	/* For reference valid classes are:
	43	* disk, tape, net, controller, vm, kvm, hat, streams, kstat, misc
	44	*/
f1ca4da6	45
04a479f7	46	#define KSTAT_TYPE_RAW 0 /* can be anything; ks_ndata >= 1 */
	47	#define KSTAT_TYPE_NAMED 1 /* name/value pair; ks_ndata >= 1 */
	48	#define KSTAT_TYPE_INTR 2 /* interrupt stats; ks_ndata == 1 */
	49	#define KSTAT_TYPE_IO 3 /* I/O stats; ks_ndata == 1 */
	50	#define KSTAT_TYPE_TIMER 4 /* event timer; ks_ndata >= 1 */
f1ca4da6	51	#define KSTAT_NUM_TYPES 5
f1ca4da6	52
f1ca4da6	53	#define KSTAT_DATA_CHAR 0
	54	#define KSTAT_DATA_INT32 1
	55	#define KSTAT_DATA_UINT32 2
	56	#define KSTAT_DATA_INT64 3
	57	#define KSTAT_DATA_UINT64 4
04a479f7	58	#define KSTAT_DATA_LONG 5
	59	#define KSTAT_DATA_ULONG 6
	60	#define KSTAT_DATA_STRING 7
	61	#define KSTAT_NUM_DATAS 8
	62
	63	#define KSTAT_INTR_HARD 0
	64	#define KSTAT_INTR_SOFT 1
	65	#define KSTAT_INTR_WATCHDOG 2
	66	#define KSTAT_INTR_SPURIOUS 3
	67	#define KSTAT_INTR_MULTSVC 4
	68	#define KSTAT_NUM_INTRS 5
f1ca4da6	69
04a479f7	70	#define KSTAT_FLAG_VIRTUAL 0x01
	71	#define KSTAT_FLAG_VAR_SIZE 0x02
	72	#define KSTAT_FLAG_WRITABLE 0x04
	73	#define KSTAT_FLAG_PERSISTENT 0x08
	74	#define KSTAT_FLAG_DORMANT 0x10
	75	#define KSTAT_FLAG_UNSUPPORTED (KSTAT_FLAG_VAR_SIZE \| KSTAT_FLAG_WRITABLE \| \
	76	KSTAT_FLAG_PERSISTENT \| KSTAT_FLAG_DORMANT)
f1ca4da6	77
f1ca4da6	78
04a479f7	79	#define KS_MAGIC 0x9d9d9d9d
f1ca4da6	80
04a479f7	81	typedef int kid_t; /* unique kstat id */
f1ca4da6	82
f1ca4da6	83	typedef struct kstat_s {
04a479f7	84	int ks_magic; /* magic value */
	85	kid_t ks_kid; /* unique kstat ID */
	86	hrtime_t ks_crtime; /* creation time */
	87	hrtime_t ks_snaptime; /* last access time */
	88	char ks_module[KSTAT_STRLEN+1]; /* provider module name */
	89	int ks_instance; /* provider module instance */
	90	char ks_name[KSTAT_STRLEN+1]; /* kstat name */
	91	char ks_class[KSTAT_STRLEN+1]; /* kstat class */
	92	uchar_t ks_type; /* kstat data type */
	93	uchar_t ks_flags; /* kstat flags */
	94	void ks_data; / kstat type-specific data */
	95	uint_t ks_ndata; /* # of type-specific data records */
	96	size_t ks_data_size; /* size of kstat data section */
	97	struct proc_dir_entry ks_proc; / proc linkage */
	98	spinlock_t ks_lock; /* kstat data lock */
	99	struct list_head ks_list; /* kstat linkage */
f1ca4da6	100	} kstat_t;
	101
	102	typedef struct kstat_named_s {
04a479f7	103	char name[KSTAT_STRLEN]; /* name of counter */
04a479f7	104	uchar_t data_type; /* data type */
f1ca4da6	105	union {
04a479f7	106	char c[16]; /* 128-bit int */
	107	int32_t i32; /* 32-bit signed int */
	108	uint32_t ui32; /* 32-bit unsigned int */
	109	int64_t i64; /* 64-bit signed int */
	110	uint64_t ui64; /* 64-bit unsigned int */
	111	long l; /* native signed long */
	112	ulong_t ul; /* native unsigned long */
f1ca4da6	113	struct {
f1ca4da6	114	union {
04a479f7	115	char ptr; / NULL-term string */
04a479f7	116	char __pad[8]; /* 64-bit padding */
f1ca4da6	117	} addr;
04a479f7	118	uint32_t len; /* # bytes for strlen + '\0' */
	119	} string;
	120	} value;
f1ca4da6	121	} kstat_named_t;
f1ca4da6	122
04a479f7	123	#define KSTAT_NAMED_STR_PTR(knptr) ((knptr)->value.string.addr.ptr)
	124	#define KSTAT_NAMED_STR_BUFLEN(knptr) ((knptr)->value.string.len)
	125
	126	typedef struct kstat_intr {
	127	uint_t intrs[KSTAT_NUM_INTRS];
	128	} kstat_intr_t;
	129
	130	typedef struct kstat_io {
	131	u_longlong_t nread; /* number of bytes read */
	132	u_longlong_t nwritten; /* number of bytes written */
	133	uint_t reads; /* number of read operations */
	134	uint_t writes; /* number of write operations */
	135	hrtime_t wtime; /* cumulative wait (pre-service) time */
	136	hrtime_t wlentime; /* cumulative wait lengthtime product/
	137	hrtime_t wlastupdate; /* last time wait queue changed */
	138	hrtime_t rtime; /* cumulative run (service) time */
	139	hrtime_t rlentime; /* cumulative run lengthtime product /
	140	hrtime_t rlastupdate; /* last time run queue changed */
	141	uint_t wcnt; /* count of elements in wait state */
	142	uint_t rcnt; /* count of elements in run state */
	143	} kstat_io_t;
	144
	145	typedef struct kstat_timer {
	146	char name[KSTAT_STRLEN+1]; /* event name */
	147	u_longlong_t num_events; /* number of events */
	148	hrtime_t elapsed_time; /* cumulative elapsed time */
	149	hrtime_t min_time; /* shortest event duration */
	150	hrtime_t max_time; /* longest event duration */
	151	hrtime_t start_time; /* previous event start time */
	152	hrtime_t stop_time; /* previous event stop time */
	153	} kstat_timer_t;
	154
	155	int kstat_init(void);
	156	void kstat_fini(void);
	157
	158	#ifdef DEBUG_KSTAT
	159	extern kstat_t __kstat_create(const char ks_module, int ks_instance,
	160	const char ks_name, const char ks_class,
	161	uchar_t ks_type, uint_t ks_ndata,
	162	uchar_t ks_flags);
	163	extern void __kstat_install(kstat_t *ksp);
	164	extern void __kstat_delete(kstat_t *ksp);
	165
	166	#define kstat_create(m,i,n,c,t,s,f) __kstat_create(m,i,n,c,t,s,f)
	167	#define kstat_install(k) __kstat_install(k)
	168	#define kstat_delete(k) __kstat_delete(k)
	169
	170	#else
	171
	172	#define kstat_create(m,i,n,c,t,s,f) (NULL)
	173	#define kstat_install(k) ((void)0)
	174	#define kstat_delete(k) ((void)0)
	175
	176	#endif /* DEBUG_KSTAT */
f1ca4da6	177
	178	#ifdef __cplusplus
	179	}
	180	#endif
	181
09b414e8	182	#endif /* _SPL_KSTAT_H */
f1ca4da6	183