[linux-2.6-block.git] / include / linux / taskstats.h

/* taskstats.h - exporting per-task statistics
 *
 * Copyright (C) Shailabh Nagar, IBM Corp. 2006
 *           (C) Balbir Singh,   IBM Corp. 2006
 *           (C) Jay Lan,        SGI, 2006
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2.1 of the GNU Lesser General Public License
 * as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it would be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 */

#ifndef _LINUX_TASKSTATS_H
#define _LINUX_TASKSTATS_H

/* Format for per-task data returned to userland when
 *	- a task exits
 *	- listener requests stats for a task
 *
 * The struct is versioned. Newer versions should only add fields to
 * the bottom of the struct to maintain backward compatibility.
 *
 *
 * To add new fields
 *	a) bump up TASKSTATS_VERSION
 *	b) add comment indicating new version number at end of struct
 *	c) add new fields after version comment; maintain 64-bit alignment
 */


#define TASKSTATS_VERSION	3
#define TS_COMM_LEN		32	/* should be >= TASK_COMM_LEN
					 * in linux/sched.h */

struct taskstats {

	/* The version number of this struct. This field is always set to
	 * TAKSTATS_VERSION, which is defined in <linux/taskstats.h>.
	 * Each time the struct is changed, the value should be incremented.
	 */
	__u16	version;
	__u32	ac_exitcode;		/* Exit status */

	/* The accounting flags of a task as defined in <linux/acct.h>
	 * Defined values are AFORK, ASU, ACOMPAT, ACORE, and AXSIG.
	 */
	__u8	ac_flag;		/* Record flags */
	__u8	ac_nice;		/* task_nice */

	/* Delay accounting fields start
	 *
	 * All values, until comment "Delay accounting fields end" are
	 * available only if delay accounting is enabled, even though the last
	 * few fields are not delays
	 *
	 * xxx_count is the number of delay values recorded
	 * xxx_delay_total is the corresponding cumulative delay in nanoseconds
	 *
	 * xxx_delay_total wraps around to zero on overflow
	 * xxx_count incremented regardless of overflow
	 */

	/* Delay waiting for cpu, while runnable
	 * count, delay_total NOT updated atomically
	 */
	__u64	cpu_count;
	__u64	cpu_delay_total;

	/* Following four fields atomically updated using task->delays->lock */

	/* Delay waiting for synchronous block I/O to complete
	 * does not account for delays in I/O submission
	 */
	__u64	blkio_count;
	__u64	blkio_delay_total;

	/* Delay waiting for page fault I/O (swap in only) */
	__u64	swapin_count;
	__u64	swapin_delay_total;

	/* cpu "wall-clock" running time
	 * On some architectures, value will adjust for cpu time stolen
	 * from the kernel in involuntary waits due to virtualization.
	 * Value is cumulative, in nanoseconds, without a corresponding count
	 * and wraps around to zero silently on overflow
	 */
	__u64	cpu_run_real_total;

	/* cpu "virtual" running time
	 * Uses time intervals seen by the kernel i.e. no adjustment
	 * for kernel's involuntary waits due to virtualization.
	 * Value is cumulative, in nanoseconds, without a corresponding count
	 * and wraps around to zero silently on overflow
	 */
	__u64	cpu_run_virtual_total;
	/* Delay accounting fields end */
	/* version 1 ends here */

	/* Basic Accounting Fields start */
	char	ac_comm[TS_COMM_LEN];	/* Command name */
	__u8	ac_sched;		/* Scheduling discipline */
	__u8	ac_pad[3];
	__u32	ac_uid;			/* User ID */
	__u32	ac_gid;			/* Group ID */
	__u32	ac_pid;			/* Process ID */
	__u32	ac_ppid;		/* Parent process ID */
	__u32	ac_btime;		/* Begin time [sec since 1970] */
	__u64	ac_etime;		/* Elapsed time [usec] */
	__u64	ac_utime;		/* User CPU time [usec] */
	__u64	ac_stime;		/* SYstem CPU time [usec] */
	__u64	ac_minflt;		/* Minor Page Fault Count */
	__u64	ac_majflt;		/* Major Page Fault Count */
	/* Basic Accounting Fields end */

	/* Extended accounting fields start */
	/* Accumulated RSS usage in duration of a task, in MBytes-usecs.
	 * The current rss usage is added to this counter every time
	 * a tick is charged to a task's system time. So, at the end we
	 * will have memory usage multiplied by system time. Thus an
	 * average usage per system time unit can be calculated.
	 */
	__u64	coremem;		/* accumulated RSS usage in MB-usec */
	/* Accumulated virtual memory usage in duration of a task.
	 * Same as acct_rss_mem1 above except that we keep track of VM usage.
	 */
	__u64	virtmem;		/* accumulated VM  usage in MB-usec */

	/* High watermark of RSS and virtual memory usage in duration of
	 * a task, in KBytes.
	 */
	__u64	hiwater_rss;		/* High-watermark of RSS usage, in KB */
	__u64	hiwater_vm;		/* High-water VM usage, in KB */

	/* The following four fields are I/O statistics of a task. */
	__u64	read_char;		/* bytes read */
	__u64	write_char;		/* bytes written */
	__u64	read_syscalls;		/* read syscalls */
	__u64	write_syscalls;		/* write syscalls */
	/* Extended accounting fields end */

#define TASKSTATS_HAS_IO_ACCOUNTING
	/* Per-task storage I/O accounting starts */
	__u64	read_bytes;		/* bytes of read I/O */
	__u64	write_bytes;		/* bytes of write I/O */
	__u64	cancelled_write_bytes;	/* bytes of cancelled write I/O */
};


/*
 * Commands sent from userspace
 * Not versioned. New commands should only be inserted at the enum's end
 * prior to __TASKSTATS_CMD_MAX
 */

enum {
	TASKSTATS_CMD_UNSPEC = 0,	/* Reserved */
	TASKSTATS_CMD_GET,		/* user->kernel request/get-response */
	TASKSTATS_CMD_NEW,		/* kernel->user event */
	__TASKSTATS_CMD_MAX,
};

#define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)

enum {
	TASKSTATS_TYPE_UNSPEC = 0,	/* Reserved */
	TASKSTATS_TYPE_PID,		/* Process id */
	TASKSTATS_TYPE_TGID,		/* Thread group id */
	TASKSTATS_TYPE_STATS,		/* taskstats structure */
	TASKSTATS_TYPE_AGGR_PID,	/* contains pid + stats */
	TASKSTATS_TYPE_AGGR_TGID,	/* contains tgid + stats */
	__TASKSTATS_TYPE_MAX,
};

#define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)

enum {
	TASKSTATS_CMD_ATTR_UNSPEC = 0,
	TASKSTATS_CMD_ATTR_PID,
	TASKSTATS_CMD_ATTR_TGID,
	TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
	TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
	__TASKSTATS_CMD_ATTR_MAX,
};

#define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)

/* NETLINK_GENERIC related info */

#define TASKSTATS_GENL_NAME	"TASKSTATS"
#define TASKSTATS_GENL_VERSION	0x1

#endif /* _LINUX_TASKSTATS_H */
Commit	Line	Data
c757249a SN	1	/* taskstats.h - exporting per-task statistics
	2	*
	3	* Copyright (C) Shailabh Nagar, IBM Corp. 2006
	4	* (C) Balbir Singh, IBM Corp. 2006
f3cef7a9	5	* (C) Jay Lan, SGI, 2006
c757249a SN	6	*
	7	* This program is free software; you can redistribute it and/or modify it
	8	* under the terms of version 2.1 of the GNU Lesser General Public License
	9	* as published by the Free Software Foundation.
	10	*
	11	* This program is distributed in the hope that it would be useful, but
	12	* WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
	14	*/
	15
	16	#ifndef _LINUX_TASKSTATS_H
	17	#define _LINUX_TASKSTATS_H
	18
	19	/* Format for per-task data returned to userland when
	20	* - a task exits
	21	* - listener requests stats for a task
	22	*
	23	* The struct is versioned. Newer versions should only add fields to
	24	* the bottom of the struct to maintain backward compatibility.
	25	*
	26	*
	27	* To add new fields
	28	* a) bump up TASKSTATS_VERSION
	29	* b) add comment indicating new version number at end of struct
	30	* c) add new fields after version comment; maintain 64-bit alignment
	31	*/
	32
f3cef7a9	33
4a7864ca	34	#define TASKSTATS_VERSION 3
db5fed26	35	#define TS_COMM_LEN 32 /* should be >= TASK_COMM_LEN
f3cef7a9	36	* in linux/sched.h */
c757249a SN	37
	38	struct taskstats {
	39
db5fed26 JL	40	/* The version number of this struct. This field is always set to
	41	* TAKSTATS_VERSION, which is defined in <linux/taskstats.h>.
	42	* Each time the struct is changed, the value should be incremented.
	43	*/
6f44993f	44	__u16 version;
db5fed26 JL	45	__u32 ac_exitcode; /* Exit status */
	46
	47	/* The accounting flags of a task as defined in <linux/acct.h>
	48	* Defined values are AFORK, ASU, ACOMPAT, ACORE, and AXSIG.
	49	*/
f3cef7a9 JL	50	__u8 ac_flag; /* Record flags */
f3cef7a9 JL	51	__u8 ac_nice; /* task_nice */
6f44993f SN	52
	53	/* Delay accounting fields start
	54	*
	55	* All values, until comment "Delay accounting fields end" are
	56	* available only if delay accounting is enabled, even though the last
	57	* few fields are not delays
	58	*
	59	* xxx_count is the number of delay values recorded
	60	* xxx_delay_total is the corresponding cumulative delay in nanoseconds
	61	*
	62	* xxx_delay_total wraps around to zero on overflow
	63	* xxx_count incremented regardless of overflow
	64	*/
	65
	66	/* Delay waiting for cpu, while runnable
	67	* count, delay_total NOT updated atomically
	68	*/
	69	__u64 cpu_count;
	70	__u64 cpu_delay_total;
	71
	72	/* Following four fields atomically updated using task->delays->lock */
	73
	74	/* Delay waiting for synchronous block I/O to complete
	75	* does not account for delays in I/O submission
	76	*/
	77	__u64 blkio_count;
	78	__u64 blkio_delay_total;
	79
	80	/* Delay waiting for page fault I/O (swap in only) */
	81	__u64 swapin_count;
	82	__u64 swapin_delay_total;
	83
	84	/* cpu "wall-clock" running time
	85	* On some architectures, value will adjust for cpu time stolen
	86	* from the kernel in involuntary waits due to virtualization.
	87	* Value is cumulative, in nanoseconds, without a corresponding count
	88	* and wraps around to zero silently on overflow
	89	*/
	90	__u64 cpu_run_real_total;
	91
	92	/* cpu "virtual" running time
	93	* Uses time intervals seen by the kernel i.e. no adjustment
	94	* for kernel's involuntary waits due to virtualization.
	95	* Value is cumulative, in nanoseconds, without a corresponding count
	96	* and wraps around to zero silently on overflow
	97	*/
	98	__u64 cpu_run_virtual_total;
	99	/* Delay accounting fields end */
	100	/* version 1 ends here */
f3cef7a9 JL	101
	102	/* Basic Accounting Fields start */
	103	char ac_comm[TS_COMM_LEN]; /* Command name */
	104	__u8 ac_sched; /* Scheduling discipline */
	105	__u8 ac_pad[3];
	106	__u32 ac_uid; /* User ID */
	107	__u32 ac_gid; /* Group ID */
	108	__u32 ac_pid; /* Process ID */
	109	__u32 ac_ppid; /* Parent process ID */
	110	__u32 ac_btime; /* Begin time [sec since 1970] */
	111	__u64 ac_etime; /* Elapsed time [usec] */
	112	__u64 ac_utime; /* User CPU time [usec] */
	113	__u64 ac_stime; /* SYstem CPU time [usec] */
db5fed26 JL	114	__u64 ac_minflt; /* Minor Page Fault Count */
db5fed26 JL	115	__u64 ac_majflt; /* Major Page Fault Count */
f3cef7a9	116	/* Basic Accounting Fields end */
9acc1853	117
f2f1f8a3	118	/* Extended accounting fields start */
db5fed26 JL	119	/* Accumulated RSS usage in duration of a task, in MBytes-usecs.
	120	* The current rss usage is added to this counter every time
	121	* a tick is charged to a task's system time. So, at the end we
	122	* will have memory usage multiplied by system time. Thus an
	123	* average usage per system time unit can be calculated.
	124	*/
f2f1f8a3	125	__u64 coremem; /* accumulated RSS usage in MB-usec */
db5fed26 JL	126	/* Accumulated virtual memory usage in duration of a task.
	127	* Same as acct_rss_mem1 above except that we keep track of VM usage.
	128	*/
f2f1f8a3	129	__u64 virtmem; /* accumulated VM usage in MB-usec */
db5fed26 JL	130
	131	/* High watermark of RSS and virtual memory usage in duration of
	132	* a task, in KBytes.
	133	*/
f2f1f8a3 AM	134	__u64 hiwater_rss; /* High-watermark of RSS usage, in KB */
f2f1f8a3 AM	135	__u64 hiwater_vm; /* High-water VM usage, in KB */
db5fed26 JL	136
db5fed26 JL	137	/* The following four fields are I/O statistics of a task. */
f2f1f8a3 AM	138	__u64 read_char; /* bytes read */
	139	__u64 write_char; /* bytes written */
	140	__u64 read_syscalls; /* read syscalls */
	141	__u64 write_syscalls; /* write syscalls */
	142	/* Extended accounting fields end */
4a7864ca AM	143
	144	#define TASKSTATS_HAS_IO_ACCOUNTING
	145	/* Per-task storage I/O accounting starts */
	146	__u64 read_bytes; /* bytes of read I/O */
	147	__u64 write_bytes; /* bytes of write I/O */
	148	__u64 cancelled_write_bytes; /* bytes of cancelled write I/O */
c757249a SN	149	};
	150
	151
c757249a SN	152	/*
	153	* Commands sent from userspace
	154	* Not versioned. New commands should only be inserted at the enum's end
	155	* prior to __TASKSTATS_CMD_MAX
	156	*/
	157
	158	enum {
	159	TASKSTATS_CMD_UNSPEC = 0, /* Reserved */
	160	TASKSTATS_CMD_GET, /* user->kernel request/get-response */
	161	TASKSTATS_CMD_NEW, /* kernel->user event */
	162	__TASKSTATS_CMD_MAX,
	163	};
	164
	165	#define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)
	166
	167	enum {
	168	TASKSTATS_TYPE_UNSPEC = 0, /* Reserved */
	169	TASKSTATS_TYPE_PID, /* Process id */
	170	TASKSTATS_TYPE_TGID, /* Thread group id */
	171	TASKSTATS_TYPE_STATS, /* taskstats structure */
	172	TASKSTATS_TYPE_AGGR_PID, /* contains pid + stats */
	173	TASKSTATS_TYPE_AGGR_TGID, /* contains tgid + stats */
	174	__TASKSTATS_TYPE_MAX,
	175	};
	176
	177	#define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)
	178
	179	enum {
	180	TASKSTATS_CMD_ATTR_UNSPEC = 0,
	181	TASKSTATS_CMD_ATTR_PID,
	182	TASKSTATS_CMD_ATTR_TGID,
f9fd8914 SN	183	TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
f9fd8914 SN	184	TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
c757249a SN	185	__TASKSTATS_CMD_ATTR_MAX,
	186	};
	187
	188	#define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)
	189
	190	/* NETLINK_GENERIC related info */
	191
	192	#define TASKSTATS_GENL_NAME "TASKSTATS"
	193	#define TASKSTATS_GENL_VERSION 0x1
	194
	195	#endif /* _LINUX_TASKSTATS_H */