taskstats.h 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  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. #ifndef _LINUX_TASKSTATS_H
  17. #define _LINUX_TASKSTATS_H
  18. #include <linux/types.h>
  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. #define TASKSTATS_VERSION 14
  33. #define TS_COMM_LEN 32 /* should be >= TASK_COMM_LEN
  34. * in linux/sched.h */
  35. struct taskstats {
  36. /* The version number of this struct. This field is always set to
  37. * TAKSTATS_VERSION, which is defined in <linux/taskstats.h>.
  38. * Each time the struct is changed, the value should be incremented.
  39. */
  40. __u16 version;
  41. __u32 ac_exitcode; /* Exit status */
  42. /* The accounting flags of a task as defined in <linux/acct.h>
  43. * Defined values are AFORK, ASU, ACOMPAT, ACORE, AXSIG, and AGROUP.
  44. * (AGROUP since version 12).
  45. */
  46. __u8 ac_flag; /* Record flags */
  47. __u8 ac_nice; /* task_nice */
  48. /* Delay accounting fields start
  49. *
  50. * All values, until comment "Delay accounting fields end" are
  51. * available only if delay accounting is enabled, even though the last
  52. * few fields are not delays
  53. *
  54. * xxx_count is the number of delay values recorded
  55. * xxx_delay_total is the corresponding cumulative delay in nanoseconds
  56. *
  57. * xxx_delay_total wraps around to zero on overflow
  58. * xxx_count incremented regardless of overflow
  59. */
  60. /* Delay waiting for cpu, while runnable
  61. * count, delay_total NOT updated atomically
  62. */
  63. __u64 cpu_count __attribute__((aligned(8)));
  64. __u64 cpu_delay_total;
  65. /* Following four fields atomically updated using task->delays->lock */
  66. /* Delay waiting for synchronous block I/O to complete
  67. * does not account for delays in I/O submission
  68. */
  69. __u64 blkio_count;
  70. __u64 blkio_delay_total;
  71. /* Delay waiting for page fault I/O (swap in only) */
  72. __u64 swapin_count;
  73. __u64 swapin_delay_total;
  74. /* cpu "wall-clock" running time
  75. * On some architectures, value will adjust for cpu time stolen
  76. * from the kernel in involuntary waits due to virtualization.
  77. * Value is cumulative, in nanoseconds, without a corresponding count
  78. * and wraps around to zero silently on overflow
  79. */
  80. __u64 cpu_run_real_total;
  81. /* cpu "virtual" running time
  82. * Uses time intervals seen by the kernel i.e. no adjustment
  83. * for kernel's involuntary waits due to virtualization.
  84. * Value is cumulative, in nanoseconds, without a corresponding count
  85. * and wraps around to zero silently on overflow
  86. */
  87. __u64 cpu_run_virtual_total;
  88. /* Delay accounting fields end */
  89. /* version 1 ends here */
  90. /* Basic Accounting Fields start */
  91. char ac_comm[TS_COMM_LEN]; /* Command name */
  92. __u8 ac_sched __attribute__((aligned(8)));
  93. /* Scheduling discipline */
  94. __u8 ac_pad[3];
  95. __u32 ac_uid __attribute__((aligned(8)));
  96. /* User ID */
  97. __u32 ac_gid; /* Group ID */
  98. __u32 ac_pid; /* Process ID */
  99. __u32 ac_ppid; /* Parent process ID */
  100. /* __u32 range means times from 1970 to 2106 */
  101. __u32 ac_btime; /* Begin time [sec since 1970] */
  102. __u64 ac_etime __attribute__((aligned(8)));
  103. /* Elapsed time [usec] */
  104. __u64 ac_utime; /* User CPU time [usec] */
  105. __u64 ac_stime; /* SYstem CPU time [usec] */
  106. __u64 ac_minflt; /* Minor Page Fault Count */
  107. __u64 ac_majflt; /* Major Page Fault Count */
  108. /* Basic Accounting Fields end */
  109. /* Extended accounting fields start */
  110. /* Accumulated RSS usage in duration of a task, in MBytes-usecs.
  111. * The current rss usage is added to this counter every time
  112. * a tick is charged to a task's system time. So, at the end we
  113. * will have memory usage multiplied by system time. Thus an
  114. * average usage per system time unit can be calculated.
  115. */
  116. __u64 coremem; /* accumulated RSS usage in MB-usec */
  117. /* Accumulated virtual memory usage in duration of a task.
  118. * Same as acct_rss_mem1 above except that we keep track of VM usage.
  119. */
  120. __u64 virtmem; /* accumulated VM usage in MB-usec */
  121. /* High watermark of RSS and virtual memory usage in duration of
  122. * a task, in KBytes.
  123. */
  124. __u64 hiwater_rss; /* High-watermark of RSS usage, in KB */
  125. __u64 hiwater_vm; /* High-water VM usage, in KB */
  126. /* The following four fields are I/O statistics of a task. */
  127. __u64 read_char; /* bytes read */
  128. __u64 write_char; /* bytes written */
  129. __u64 read_syscalls; /* read syscalls */
  130. __u64 write_syscalls; /* write syscalls */
  131. /* Extended accounting fields end */
  132. #define TASKSTATS_HAS_IO_ACCOUNTING
  133. /* Per-task storage I/O accounting starts */
  134. __u64 read_bytes; /* bytes of read I/O */
  135. __u64 write_bytes; /* bytes of write I/O */
  136. __u64 cancelled_write_bytes; /* bytes of cancelled write I/O */
  137. __u64 nvcsw; /* voluntary_ctxt_switches */
  138. __u64 nivcsw; /* nonvoluntary_ctxt_switches */
  139. /* time accounting for SMT machines */
  140. __u64 ac_utimescaled; /* utime scaled on frequency etc */
  141. __u64 ac_stimescaled; /* stime scaled on frequency etc */
  142. __u64 cpu_scaled_run_real_total; /* scaled cpu_run_real_total */
  143. /* Delay waiting for memory reclaim */
  144. __u64 freepages_count;
  145. __u64 freepages_delay_total;
  146. /* Delay waiting for thrashing page */
  147. __u64 thrashing_count;
  148. __u64 thrashing_delay_total;
  149. /* v10: 64-bit btime to avoid overflow */
  150. __u64 ac_btime64; /* 64-bit begin time */
  151. /* v11: Delay waiting for memory compact */
  152. __u64 compact_count;
  153. __u64 compact_delay_total;
  154. /* v12 begin */
  155. __u32 ac_tgid; /* thread group ID */
  156. /* Thread group walltime up to now. This is total process walltime if
  157. * AGROUP flag is set.
  158. */
  159. __u64 ac_tgetime __attribute__((aligned(8)));
  160. /* Lightweight information to identify process binary files.
  161. * This leaves userspace to match this to a file system path, using
  162. * MAJOR() and MINOR() macros to identify a device and mount point,
  163. * the inode to identify the executable file. This is /proc/self/exe
  164. * at the end, so matching the most recent exec(). Values are zero
  165. * for kernel threads.
  166. */
  167. __u64 ac_exe_dev; /* program binary device ID */
  168. __u64 ac_exe_inode; /* program binary inode number */
  169. /* v12 end */
  170. /* v13: Delay waiting for write-protect copy */
  171. __u64 wpcopy_count;
  172. __u64 wpcopy_delay_total;
  173. /* v14: Delay waiting for IRQ/SOFTIRQ */
  174. __u64 irq_count;
  175. __u64 irq_delay_total;
  176. };
  177. /*
  178. * Commands sent from userspace
  179. * Not versioned. New commands should only be inserted at the enum's end
  180. * prior to __TASKSTATS_CMD_MAX
  181. */
  182. enum {
  183. TASKSTATS_CMD_UNSPEC = 0, /* Reserved */
  184. TASKSTATS_CMD_GET, /* user->kernel request/get-response */
  185. TASKSTATS_CMD_NEW, /* kernel->user event */
  186. __TASKSTATS_CMD_MAX,
  187. };
  188. #define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)
  189. enum {
  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. #define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)
  200. enum {
  201. TASKSTATS_CMD_ATTR_UNSPEC = 0,
  202. TASKSTATS_CMD_ATTR_PID,
  203. TASKSTATS_CMD_ATTR_TGID,
  204. TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
  205. TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
  206. __TASKSTATS_CMD_ATTR_MAX,
  207. };
  208. #define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)
  209. /* NETLINK_GENERIC related info */
  210. #define TASKSTATS_GENL_NAME "TASKSTATS"
  211. #define TASKSTATS_GENL_VERSION 0x1
  212. #endif /* _LINUX_TASKSTATS_H */