blob: 45248806ae9c5916a416102d9bd1a8c9b54a03a2 [file] [log] [blame]
Shailabh Nagarc7572492006-07-14 00:24:40 -07001/* taskstats.h - exporting per-task statistics
2 *
3 * Copyright (C) Shailabh Nagar, IBM Corp. 2006
4 * (C) Balbir Singh, IBM Corp. 2006
Jay Lanf3cef7a2006-09-30 23:28:55 -07005 * (C) Jay Lan, SGI, 2006
Shailabh Nagarc7572492006-07-14 00:24:40 -07006 *
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
Jay Lanf3cef7a2006-09-30 23:28:55 -070033
34#define TASKSTATS_VERSION 2
Jay Landb5fed262006-09-30 23:29:00 -070035#define TS_COMM_LEN 32 /* should be >= TASK_COMM_LEN
Jay Lanf3cef7a2006-09-30 23:28:55 -070036 * in linux/sched.h */
Shailabh Nagarc7572492006-07-14 00:24:40 -070037
38struct taskstats {
39
Jay Landb5fed262006-09-30 23:29:00 -070040 /* 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 */
Shailabh Nagar6f449932006-07-14 00:24:41 -070044 __u16 version;
Jay Landb5fed262006-09-30 23:29:00 -070045 __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 */
Jay Lanf3cef7a2006-09-30 23:28:55 -070050 __u8 ac_flag; /* Record flags */
51 __u8 ac_nice; /* task_nice */
Shailabh Nagar6f449932006-07-14 00:24:41 -070052
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 */
Jay Lanf3cef7a2006-09-30 23:28:55 -0700101
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] */
Jay Landb5fed262006-09-30 23:29:00 -0700114 __u64 ac_minflt; /* Minor Page Fault Count */
115 __u64 ac_majflt; /* Major Page Fault Count */
Jay Lanf3cef7a2006-09-30 23:28:55 -0700116 /* Basic Accounting Fields end */
Jay Lan9acc1852006-09-30 23:28:58 -0700117
118 /* Extended accounting fields start */
Jay Landb5fed262006-09-30 23:29:00 -0700119 /* 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 */
125 __u64 coremem; /* accumulated RSS usage in MB-usec */
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 */
129 __u64 virtmem; /* accumulated VM usage in MB-usec */
130
131 /* High watermark of RSS and virtual memory usage in duration of
132 * a task, in KBytes.
133 */
134 __u64 hiwater_rss; /* High-watermark of RSS usage, in KB */
135 __u64 hiwater_vm; /* High-water VM usage, in KB */
136
137 /* The following four fields are I/O statistics of a task. */
Jay Lan9acc1852006-09-30 23:28:58 -0700138 __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 */
Shailabh Nagarc7572492006-07-14 00:24:40 -0700143};
144
145
Shailabh Nagarc7572492006-07-14 00:24:40 -0700146/*
147 * Commands sent from userspace
148 * Not versioned. New commands should only be inserted at the enum's end
149 * prior to __TASKSTATS_CMD_MAX
150 */
151
152enum {
153 TASKSTATS_CMD_UNSPEC = 0, /* Reserved */
154 TASKSTATS_CMD_GET, /* user->kernel request/get-response */
155 TASKSTATS_CMD_NEW, /* kernel->user event */
156 __TASKSTATS_CMD_MAX,
157};
158
159#define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)
160
161enum {
162 TASKSTATS_TYPE_UNSPEC = 0, /* Reserved */
163 TASKSTATS_TYPE_PID, /* Process id */
164 TASKSTATS_TYPE_TGID, /* Thread group id */
165 TASKSTATS_TYPE_STATS, /* taskstats structure */
166 TASKSTATS_TYPE_AGGR_PID, /* contains pid + stats */
167 TASKSTATS_TYPE_AGGR_TGID, /* contains tgid + stats */
168 __TASKSTATS_TYPE_MAX,
169};
170
171#define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)
172
173enum {
174 TASKSTATS_CMD_ATTR_UNSPEC = 0,
175 TASKSTATS_CMD_ATTR_PID,
176 TASKSTATS_CMD_ATTR_TGID,
Shailabh Nagarf9fd8912006-07-14 00:24:47 -0700177 TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
178 TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
Shailabh Nagarc7572492006-07-14 00:24:40 -0700179 __TASKSTATS_CMD_ATTR_MAX,
180};
181
182#define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)
183
184/* NETLINK_GENERIC related info */
185
186#define TASKSTATS_GENL_NAME "TASKSTATS"
187#define TASKSTATS_GENL_VERSION 0x1
188
189#endif /* _LINUX_TASKSTATS_H */