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 #include <linux/time_types.h> 22 23 /* Format for per-task data returned to userland when 24 * - a task exits 25 * - listener requests stats for a task 26 * 27 * The struct is versioned. Newer versions should only add fields to 28 * the bottom of the struct to maintain backward compatibility. 29 * 30 * 31 * To add new fields 32 * a) bump up TASKSTATS_VERSION 33 * b) add comment indicating new version number at end of struct 34 * c) add new fields after version comment; maintain 64-bit alignment 35 */ 36 37 38 #define TASKSTATS_VERSION 17 39 #define TS_COMM_LEN 32 /* should be >= TASK_COMM_LEN 40 * in linux/sched.h */ 41 42 struct taskstats { 43 44 /* The version number of this struct. This field is always set to 45 * TAKSTATS_VERSION, which is defined in <linux/taskstats.h>. 46 * Each time the struct is changed, the value should be incremented. 47 */ 48 __u16 version; 49 __u32 ac_exitcode; /* Exit status */ 50 51 /* The accounting flags of a task as defined in <linux/acct.h> 52 * Defined values are AFORK, ASU, ACOMPAT, ACORE, AXSIG, and AGROUP. 53 * (AGROUP since version 12). 54 */ 55 __u8 ac_flag; /* Record flags */ 56 __u8 ac_nice; /* task_nice */ 57 58 /* Delay accounting fields start 59 * 60 * All values, until comment "Delay accounting fields end" are 61 * available only if delay accounting is enabled, even though the last 62 * few fields are not delays 63 * 64 * xxx_count is the number of delay values recorded 65 * xxx_delay_total is the corresponding cumulative delay in nanoseconds 66 * 67 * xxx_delay_total wraps around to zero on overflow 68 * xxx_count incremented regardless of overflow 69 */ 70 71 /* Delay waiting for cpu, while runnable 72 * count, delay_total NOT updated atomically 73 */ 74 __u64 cpu_count __attribute__((aligned(8))); 75 __u64 cpu_delay_total; 76 77 /* Following four fields atomically updated using task->delays->lock */ 78 79 /* Delay waiting for synchronous block I/O to complete 80 * does not account for delays in I/O submission 81 */ 82 __u64 blkio_count; 83 __u64 blkio_delay_total; 84 85 /* Delay waiting for page fault I/O (swap in only) */ 86 __u64 swapin_count; 87 __u64 swapin_delay_total; 88 89 /* cpu "wall-clock" running time 90 * On some architectures, value will adjust for cpu time stolen 91 * from the kernel in involuntary waits due to virtualization. 92 * Value is cumulative, in nanoseconds, without a corresponding count 93 * and wraps around to zero silently on overflow 94 */ 95 __u64 cpu_run_real_total; 96 97 /* cpu "virtual" running time 98 * Uses time intervals seen by the kernel i.e. no adjustment 99 * for kernel's involuntary waits due to virtualization. 100 * Value is cumulative, in nanoseconds, without a corresponding count 101 * and wraps around to zero silently on overflow 102 */ 103 __u64 cpu_run_virtual_total; 104 /* Delay accounting fields end */ 105 /* version 1 ends here */ 106 107 /* Basic Accounting Fields start */ 108 char ac_comm[TS_COMM_LEN]; /* Command name */ 109 __u8 ac_sched __attribute__((aligned(8))); 110 /* Scheduling discipline */ 111 __u8 ac_pad[3]; 112 __u32 ac_uid __attribute__((aligned(8))); 113 /* User ID */ 114 __u32 ac_gid; /* Group ID */ 115 __u32 ac_pid; /* Process ID */ 116 __u32 ac_ppid; /* Parent process ID */ 117 /* __u32 range means times from 1970 to 2106 */ 118 __u32 ac_btime; /* Begin time [sec since 1970] */ 119 __u64 ac_etime __attribute__((aligned(8))); 120 /* Elapsed time [usec] */ 121 __u64 ac_utime; /* User CPU time [usec] */ 122 __u64 ac_stime; /* SYstem CPU time [usec] */ 123 __u64 ac_minflt; /* Minor Page Fault Count */ 124 __u64 ac_majflt; /* Major Page Fault Count */ 125 /* Basic Accounting Fields end */ 126 127 /* Extended accounting fields start */ 128 /* Accumulated RSS usage in duration of a task, in MBytes-usecs. 129 * The current rss usage is added to this counter every time 130 * a tick is charged to a task's system time. So, at the end we 131 * will have memory usage multiplied by system time. Thus an 132 * average usage per system time unit can be calculated. 133 */ 134 __u64 coremem; /* accumulated RSS usage in MB-usec */ 135 /* Accumulated virtual memory usage in duration of a task. 136 * Same as acct_rss_mem1 above except that we keep track of VM usage. 137 */ 138 __u64 virtmem; /* accumulated VM usage in MB-usec */ 139 140 /* High watermark of RSS and virtual memory usage in duration of 141 * a task, in KBytes. 142 */ 143 __u64 hiwater_rss; /* High-watermark of RSS usage, in KB */ 144 __u64 hiwater_vm; /* High-water VM usage, in KB */ 145 146 /* The following four fields are I/O statistics of a task. */ 147 __u64 read_char; /* bytes read */ 148 __u64 write_char; /* bytes written */ 149 __u64 read_syscalls; /* read syscalls */ 150 __u64 write_syscalls; /* write syscalls */ 151 /* Extended accounting fields end */ 152 153 #define TASKSTATS_HAS_IO_ACCOUNTING 154 /* Per-task storage I/O accounting starts */ 155 __u64 read_bytes; /* bytes of read I/O */ 156 __u64 write_bytes; /* bytes of write I/O */ 157 __u64 cancelled_write_bytes; /* bytes of cancelled write I/O */ 158 159 __u64 nvcsw; /* voluntary_ctxt_switches */ 160 __u64 nivcsw; /* nonvoluntary_ctxt_switches */ 161 162 /* time accounting for SMT machines */ 163 __u64 ac_utimescaled; /* utime scaled on frequency etc */ 164 __u64 ac_stimescaled; /* stime scaled on frequency etc */ 165 __u64 cpu_scaled_run_real_total; /* scaled cpu_run_real_total */ 166 167 /* Delay waiting for memory reclaim */ 168 __u64 freepages_count; 169 __u64 freepages_delay_total; 170 171 172 /* Delay waiting for thrashing page */ 173 __u64 thrashing_count; 174 __u64 thrashing_delay_total; 175 176 /* v10: 64-bit btime to avoid overflow */ 177 __u64 ac_btime64; /* 64-bit begin time */ 178 179 /* v11: Delay waiting for memory compact */ 180 __u64 compact_count; 181 __u64 compact_delay_total; 182 183 /* v12 begin */ 184 __u32 ac_tgid; /* thread group ID */ 185 /* Thread group walltime up to now. This is total process walltime if 186 * AGROUP flag is set. 187 */ 188 __u64 ac_tgetime __attribute__((aligned(8))); 189 /* Lightweight information to identify process binary files. 190 * This leaves userspace to match this to a file system path, using 191 * MAJOR() and MINOR() macros to identify a device and mount point, 192 * the inode to identify the executable file. This is /proc/self/exe 193 * at the end, so matching the most recent exec(). Values are zero 194 * for kernel threads. 195 */ 196 __u64 ac_exe_dev; /* program binary device ID */ 197 __u64 ac_exe_inode; /* program binary inode number */ 198 /* v12 end */ 199 200 /* v13: Delay waiting for write-protect copy */ 201 __u64 wpcopy_count; 202 __u64 wpcopy_delay_total; 203 204 /* v14: Delay waiting for IRQ/SOFTIRQ */ 205 __u64 irq_count; 206 __u64 irq_delay_total; 207 208 /* v15: add Delay max and Delay min */ 209 210 /* v16: move Delay max and Delay min to the end of taskstat */ 211 __u64 cpu_delay_max; 212 __u64 cpu_delay_min; 213 214 __u64 blkio_delay_max; 215 __u64 blkio_delay_min; 216 217 __u64 swapin_delay_max; 218 __u64 swapin_delay_min; 219 220 __u64 freepages_delay_max; 221 __u64 freepages_delay_min; 222 223 __u64 thrashing_delay_max; 224 __u64 thrashing_delay_min; 225 226 __u64 compact_delay_max; 227 __u64 compact_delay_min; 228 229 __u64 wpcopy_delay_max; 230 __u64 wpcopy_delay_min; 231 232 __u64 irq_delay_max; 233 __u64 irq_delay_min; 234 235 /*v17: delay max timestamp record*/ 236 struct __kernel_timespec cpu_delay_max_ts; 237 struct __kernel_timespec blkio_delay_max_ts; 238 struct __kernel_timespec swapin_delay_max_ts; 239 struct __kernel_timespec freepages_delay_max_ts; 240 struct __kernel_timespec thrashing_delay_max_ts; 241 struct __kernel_timespec compact_delay_max_ts; 242 struct __kernel_timespec wpcopy_delay_max_ts; 243 struct __kernel_timespec irq_delay_max_ts; 244 }; 245 246 247 /* 248 * Commands sent from userspace 249 * Not versioned. New commands should only be inserted at the enum's end 250 * prior to __TASKSTATS_CMD_MAX 251 */ 252 253 enum { 254 TASKSTATS_CMD_UNSPEC = 0, /* Reserved */ 255 TASKSTATS_CMD_GET, /* user->kernel request/get-response */ 256 TASKSTATS_CMD_NEW, /* kernel->user event */ 257 __TASKSTATS_CMD_MAX, 258 }; 259 260 #define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1) 261 262 enum { 263 TASKSTATS_TYPE_UNSPEC = 0, /* Reserved */ 264 TASKSTATS_TYPE_PID, /* Process id */ 265 TASKSTATS_TYPE_TGID, /* Thread group id */ 266 TASKSTATS_TYPE_STATS, /* taskstats structure */ 267 TASKSTATS_TYPE_AGGR_PID, /* contains pid + stats */ 268 TASKSTATS_TYPE_AGGR_TGID, /* contains tgid + stats */ 269 TASKSTATS_TYPE_NULL, /* contains nothing */ 270 __TASKSTATS_TYPE_MAX, 271 }; 272 273 #define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1) 274 275 enum { 276 TASKSTATS_CMD_ATTR_UNSPEC = 0, 277 TASKSTATS_CMD_ATTR_PID, 278 TASKSTATS_CMD_ATTR_TGID, 279 TASKSTATS_CMD_ATTR_REGISTER_CPUMASK, 280 TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK, 281 __TASKSTATS_CMD_ATTR_MAX, 282 }; 283 284 #define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1) 285 286 /* NETLINK_GENERIC related info */ 287 288 #define TASKSTATS_GENL_NAME "TASKSTATS" 289 #define TASKSTATS_GENL_VERSION 0x1 290 291 #endif /* _LINUX_TASKSTATS_H */ 292