1 /* taskstats.h - exporting per-task statistics
3 * Copyright (C) Shailabh Nagar, IBM Corp. 2006
4 * (C) Balbir Singh, IBM Corp. 2006
5 * (C) Jay Lan, SGI, 2006
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.
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.
16 #ifndef _LINUX_TASKSTATS_H
17 #define _LINUX_TASKSTATS_H
19 /* Format for per-task data returned to userland when
21 * - listener requests stats for a task
23 * The struct is versioned. Newer versions should only add fields to
24 * the bottom of the struct to maintain backward compatibility.
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
34 #define TASKSTATS_VERSION 6
35 #define TS_COMM_LEN 32 /* should be >= TASK_COMM_LEN
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.
45 __u32 ac_exitcode; /* Exit status */
47 /* The accounting flags of a task as defined in <linux/acct.h>
48 * Defined values are AFORK, ASU, ACOMPAT, ACORE, and AXSIG.
50 __u8 ac_flag; /* Record flags */
51 __u8 ac_nice; /* task_nice */
53 /* Delay accounting fields start
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
59 * xxx_count is the number of delay values recorded
60 * xxx_delay_total is the corresponding cumulative delay in nanoseconds
62 * xxx_delay_total wraps around to zero on overflow
63 * xxx_count incremented regardless of overflow
66 /* Delay waiting for cpu, while runnable
67 * count, delay_total NOT updated atomically
69 __u64 cpu_count __attribute__((aligned(8)));
70 __u64 cpu_delay_total;
72 /* Following four fields atomically updated using task->delays->lock */
74 /* Delay waiting for synchronous block I/O to complete
75 * does not account for delays in I/O submission
78 __u64 blkio_delay_total;
80 /* Delay waiting for page fault I/O (swap in only) */
82 __u64 swapin_delay_total;
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. The
89 * _scaled_ version accounts for cpus which can scale the
90 * number of instructions executed each cycle.
92 __u64 cpu_run_real_total;
93 __u64 cpu_scaled_run_real_total;
95 /* cpu "virtual" running time
96 * Uses time intervals seen by the kernel i.e. no adjustment
97 * for kernel's involuntary waits due to virtualization.
98 * Value is cumulative, in nanoseconds, without a corresponding count
99 * and wraps around to zero silently on overflow
101 __u64 cpu_run_virtual_total;
102 /* Delay accounting fields end */
103 /* version 1 ends here */
105 /* Basic Accounting Fields start */
106 char ac_comm[TS_COMM_LEN]; /* Command name */
107 __u8 ac_sched __attribute__((aligned(8)));
108 /* Scheduling discipline */
110 __u32 ac_uid __attribute__((aligned(8)));
112 __u32 ac_gid; /* Group ID */
113 __u32 ac_pid; /* Process ID */
114 __u32 ac_ppid; /* Parent process ID */
115 __u32 ac_btime; /* Begin time [sec since 1970] */
116 __u64 ac_etime __attribute__((aligned(8)));
117 /* Elapsed time [usec] */
118 __u64 ac_utime; /* User CPU time [usec] */
119 __u64 ac_stime; /* SYstem CPU time [usec] */
120 __u64 ac_minflt; /* Minor Page Fault Count */
121 __u64 ac_majflt; /* Major Page Fault Count */
122 /* Basic Accounting Fields end */
124 /* Extended accounting fields start */
125 /* Accumulated RSS usage in duration of a task, in MBytes-usecs.
126 * The current rss usage is added to this counter every time
127 * a tick is charged to a task's system time. So, at the end we
128 * will have memory usage multiplied by system time. Thus an
129 * average usage per system time unit can be calculated.
131 __u64 coremem; /* accumulated RSS usage in MB-usec */
132 /* Accumulated virtual memory usage in duration of a task.
133 * Same as acct_rss_mem1 above except that we keep track of VM usage.
135 __u64 virtmem; /* accumulated VM usage in MB-usec */
137 /* High watermark of RSS and virtual memory usage in duration of
140 __u64 hiwater_rss; /* High-watermark of RSS usage, in KB */
141 __u64 hiwater_vm; /* High-water VM usage, in KB */
143 /* The following four fields are I/O statistics of a task. */
144 __u64 read_char; /* bytes read */
145 __u64 write_char; /* bytes written */
146 __u64 read_syscalls; /* read syscalls */
147 __u64 write_syscalls; /* write syscalls */
149 /* time accounting for SMT machines */
150 __u64 ac_utimescaled; /* utime scaled on frequency etc */
151 __u64 ac_stimescaled; /* stime scaled on frequency etc */
152 /* Extended accounting fields end */
154 #define TASKSTATS_HAS_IO_ACCOUNTING
155 /* Per-task storage I/O accounting starts */
156 __u64 read_bytes; /* bytes of read I/O */
157 __u64 write_bytes; /* bytes of write I/O */
158 __u64 cancelled_write_bytes; /* bytes of cancelled write I/O */
160 __u64 nvcsw; /* voluntary_ctxt_switches */
161 __u64 nivcsw; /* nonvoluntary_ctxt_switches */
166 * Commands sent from userspace
167 * Not versioned. New commands should only be inserted at the enum's end
168 * prior to __TASKSTATS_CMD_MAX
172 TASKSTATS_CMD_UNSPEC = 0, /* Reserved */
173 TASKSTATS_CMD_GET, /* user->kernel request/get-response */
174 TASKSTATS_CMD_NEW, /* kernel->user event */
178 #define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)
181 TASKSTATS_TYPE_UNSPEC = 0, /* Reserved */
182 TASKSTATS_TYPE_PID, /* Process id */
183 TASKSTATS_TYPE_TGID, /* Thread group id */
184 TASKSTATS_TYPE_STATS, /* taskstats structure */
185 TASKSTATS_TYPE_AGGR_PID, /* contains pid + stats */
186 TASKSTATS_TYPE_AGGR_TGID, /* contains tgid + stats */
187 __TASKSTATS_TYPE_MAX,
190 #define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)
193 TASKSTATS_CMD_ATTR_UNSPEC = 0,
194 TASKSTATS_CMD_ATTR_PID,
195 TASKSTATS_CMD_ATTR_TGID,
196 TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
197 TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
198 __TASKSTATS_CMD_ATTR_MAX,
201 #define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)
203 /* NETLINK_GENERIC related info */
205 #define TASKSTATS_GENL_NAME "TASKSTATS"
206 #define TASKSTATS_GENL_VERSION 0x1
208 #endif /* _LINUX_TASKSTATS_H */