1/* SPDX-License-Identifier: LGPL-2.1 WITH Linux-syscall-note */
2/* taskstats.h - exporting per-task statistics
3 *
4 * Copyright (C) Shailabh Nagar, IBM Corp. 2006
5 * (C) Balbir Singh, IBM Corp. 2006
6 * (C) Jay Lan, SGI, 2006
7 *
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of version 2.1 of the GNU Lesser General Public License
10 * as published by the Free Software Foundation.
11 *
12 * This program is distributed in the hope that it would be useful, but
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15 */
16
17#ifndef _LINUX_TASKSTATS_H
18#define _LINUX_TASKSTATS_H
19
20#include <linux/types.h>
21
22/* Format for per-task data returned to userland when
23 * - a task exits
24 * - listener requests stats for a task
25 *
26 * The struct is versioned. Newer versions should only add fields to
27 * the bottom of the struct to maintain backward compatibility.
28 *
29 *
30 * To add new fields
31 * a) bump up TASKSTATS_VERSION
32 * b) add comment indicating new version number at end of struct
33 * c) add new fields after version comment; maintain 64-bit alignment
34 */
35
36
37#define TASKSTATS_VERSION 9
38#define TS_COMM_LEN 32 /* should be >= TASK_COMM_LEN
39 * in linux/sched.h */
40
41struct taskstats {
42
43 /* The version number of this struct. This field is always set to
44 * TAKSTATS_VERSION, which is defined in <linux/taskstats.h>.
45 * Each time the struct is changed, the value should be incremented.
46 */
47 __u16 version;
48 __u32 ac_exitcode; /* Exit status */
49
50 /* The accounting flags of a task as defined in <linux/acct.h>
51 * Defined values are AFORK, ASU, ACOMPAT, ACORE, and AXSIG.
52 */
53 __u8 ac_flag; /* Record flags */
54 __u8 ac_nice; /* task_nice */
55
56 /* Delay accounting fields start
57 *
58 * All values, until comment "Delay accounting fields end" are
59 * available only if delay accounting is enabled, even though the last
60 * few fields are not delays
61 *
62 * xxx_count is the number of delay values recorded
63 * xxx_delay_total is the corresponding cumulative delay in nanoseconds
64 *
65 * xxx_delay_total wraps around to zero on overflow
66 * xxx_count incremented regardless of overflow
67 */
68
69 /* Delay waiting for cpu, while runnable
70 * count, delay_total NOT updated atomically
71 */
72 __u64 cpu_count __attribute__((aligned(8)));
73 __u64 cpu_delay_total;
74
75 /* Following four fields atomically updated using task->delays->lock */
76
77 /* Delay waiting for synchronous block I/O to complete
78 * does not account for delays in I/O submission
79 */
80 __u64 blkio_count;
81 __u64 blkio_delay_total;
82
83 /* Delay waiting for page fault I/O (swap in only) */
84 __u64 swapin_count;
85 __u64 swapin_delay_total;
86
87 /* cpu "wall-clock" running time
88 * On some architectures, value will adjust for cpu time stolen
89 * from the kernel in involuntary waits due to virtualization.
90 * Value is cumulative, in nanoseconds, without a corresponding count
91 * and wraps around to zero silently on overflow
92 */
93 __u64 cpu_run_real_total;
94
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
100 */
101 __u64 cpu_run_virtual_total;
102 /* Delay accounting fields end */
103 /* version 1 ends here */
104
105 /* Basic Accounting Fields start */
106 char ac_comm[TS_COMM_LEN]; /* Command name */
107 __u8 ac_sched __attribute__((aligned(8)));
108 /* Scheduling discipline */
109 __u8 ac_pad[3];
110 __u32 ac_uid __attribute__((aligned(8)));
111 /* User ID */
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 */
123
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.
130 */
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.
134 */
135 __u64 virtmem; /* accumulated VM usage in MB-usec */
136
137 /* High watermark of RSS and virtual memory usage in duration of
138 * a task, in KBytes.
139 */
140 __u64 hiwater_rss; /* High-watermark of RSS usage, in KB */
141 __u64 hiwater_vm; /* High-water VM usage, in KB */
142
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 */
148 /* Extended accounting fields end */
149
150#define TASKSTATS_HAS_IO_ACCOUNTING
151 /* Per-task storage I/O accounting starts */
152 __u64 read_bytes; /* bytes of read I/O */
153 __u64 write_bytes; /* bytes of write I/O */
154 __u64 cancelled_write_bytes; /* bytes of cancelled write I/O */
155
156 __u64 nvcsw; /* voluntary_ctxt_switches */
157 __u64 nivcsw; /* nonvoluntary_ctxt_switches */
158
159 /* time accounting for SMT machines */
160 __u64 ac_utimescaled; /* utime scaled on frequency etc */
161 __u64 ac_stimescaled; /* stime scaled on frequency etc */
162 __u64 cpu_scaled_run_real_total; /* scaled cpu_run_real_total */
163
164 /* Delay waiting for memory reclaim */
165 __u64 freepages_count;
166 __u64 freepages_delay_total;
167
168 /* Delay waiting for thrashing page */
169 __u64 thrashing_count;
170 __u64 thrashing_delay_total;
171};
172
173
174/*
175 * Commands sent from userspace
176 * Not versioned. New commands should only be inserted at the enum's end
177 * prior to __TASKSTATS_CMD_MAX
178 */
179
180enum {
181 TASKSTATS_CMD_UNSPEC = 0, /* Reserved */
182 TASKSTATS_CMD_GET, /* user->kernel request/get-response */
183 TASKSTATS_CMD_NEW, /* kernel->user event */
184 __TASKSTATS_CMD_MAX,
185};
186
187#define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)
188
189enum {
190 TASKSTATS_TYPE_UNSPEC = 0, /* Reserved */
191 TASKSTATS_TYPE_PID, /* Process id */
192 TASKSTATS_TYPE_TGID, /* Thread group id */
193 TASKSTATS_TYPE_STATS, /* taskstats structure */
194 TASKSTATS_TYPE_AGGR_PID, /* contains pid + stats */
195 TASKSTATS_TYPE_AGGR_TGID, /* contains tgid + stats */
196 TASKSTATS_TYPE_NULL, /* contains nothing */
197 __TASKSTATS_TYPE_MAX,
198};
199
200#define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)
201
202enum {
203 TASKSTATS_CMD_ATTR_UNSPEC = 0,
204 TASKSTATS_CMD_ATTR_PID,
205 TASKSTATS_CMD_ATTR_TGID,
206 TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
207 TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
208 __TASKSTATS_CMD_ATTR_MAX,
209};
210
211#define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)
212
213/* NETLINK_GENERIC related info */
214
215#define TASKSTATS_GENL_NAME "TASKSTATS"
216#define TASKSTATS_GENL_VERSION 0x1
217
218#endif /* _LINUX_TASKSTATS_H */
219