include/linux/taskstats.h

   1 /* taskstats.h - exporting per-task statistics
   2  *
   3  * Copyright (C) Shailabh Nagar, IBM Corp. 2006
   4  *           (C) Balbir Singh,   IBM Corp. 2006
   5  *           (C) Jay Lan,        SGI, 2006
   6  *
   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
  33
  34 #define TASKSTATS_VERSION       2
  35 #define TS_COMM_LEN             16      /* should sync up with TASK_COMM_LEN
  36                                          * in linux/sched.h */
  37
  38 struct taskstats {
  39
  40         /* Version 1 */
  41         __u16   version;
  42         __u32   ac_exitcode;    /* Exit status */
  43         __u8    ac_flag;                /* Record flags */
  44         __u8    ac_nice;                /* task_nice */
  45
  46         /* Delay accounting fields start
  47          *
  48          * All values, until comment "Delay accounting fields end" are
  49          * available only if delay accounting is enabled, even though the last
  50          * few fields are not delays
  51          *
  52          * xxx_count is the number of delay values recorded
  53          * xxx_delay_total is the corresponding cumulative delay in nanoseconds
  54          *
  55          * xxx_delay_total wraps around to zero on overflow
  56          * xxx_count incremented regardless of overflow
  57          */
  58
  59         /* Delay waiting for cpu, while runnable
  60          * count, delay_total NOT updated atomically
  61          */
  62         __u64   cpu_count;
  63         __u64   cpu_delay_total;
  64
  65         /* Following four fields atomically updated using task->delays->lock */
  66
  67         /* Delay waiting for synchronous block I/O to complete
  68          * does not account for delays in I/O submission
  69          */
  70         __u64   blkio_count;
  71         __u64   blkio_delay_total;
  72
  73         /* Delay waiting for page fault I/O (swap in only) */
  74         __u64   swapin_count;
  75         __u64   swapin_delay_total;
  76
  77         /* cpu "wall-clock" running time
  78          * On some architectures, value will adjust for cpu time stolen
  79          * from the kernel in involuntary waits due to virtualization.
  80          * Value is cumulative, in nanoseconds, without a corresponding count
  81          * and wraps around to zero silently on overflow
  82          */
  83         __u64   cpu_run_real_total;
  84
  85         /* cpu "virtual" running time
  86          * Uses time intervals seen by the kernel i.e. no adjustment
  87          * for kernel's involuntary waits due to virtualization.
  88          * Value is cumulative, in nanoseconds, without a corresponding count
  89          * and wraps around to zero silently on overflow
  90          */
  91         __u64   cpu_run_virtual_total;
  92         /* Delay accounting fields end */
  93         /* version 1 ends here */
  94
  95         /* Basic Accounting Fields start */
  96         char    ac_comm[TS_COMM_LEN];   /* Command name */
  97         __u8    ac_sched;               /* Scheduling discipline */
  98         __u8    ac_pad[3];
  99         __u32   ac_uid;                 /* User ID */
 100         __u32   ac_gid;                 /* Group ID */
 101         __u32   ac_pid;                 /* Process ID */
 102         __u32   ac_ppid;                /* Parent process ID */
 103         __u32   ac_btime;               /* Begin time [sec since 1970] */
 104         __u64   ac_etime;               /* Elapsed time [usec] */
 105         __u64   ac_utime;               /* User CPU time [usec] */
 106         __u64   ac_stime;               /* SYstem CPU time [usec] */
 107         __u64   ac_minflt;              /* Minor Page Fault */
 108         __u64   ac_majflt;              /* Major Page Fault */
 109         /* Basic Accounting Fields end */
 110 };
 111
 112
 113 /*
 114  * Commands sent from userspace
 115  * Not versioned. New commands should only be inserted at the enum's end
 116  * prior to __TASKSTATS_CMD_MAX
 117  */
 118
 119 enum {
 120         TASKSTATS_CMD_UNSPEC = 0,       /* Reserved */
 121         TASKSTATS_CMD_GET,              /* user->kernel request/get-response */
 122         TASKSTATS_CMD_NEW,              /* kernel->user event */
 123         __TASKSTATS_CMD_MAX,
 124 };
 125
 126 #define TASKSTATS_CMD_MAX (__TASKSTATS_CMD_MAX - 1)
 127
 128 enum {
 129         TASKSTATS_TYPE_UNSPEC = 0,      /* Reserved */
 130         TASKSTATS_TYPE_PID,             /* Process id */
 131         TASKSTATS_TYPE_TGID,            /* Thread group id */
 132         TASKSTATS_TYPE_STATS,           /* taskstats structure */
 133         TASKSTATS_TYPE_AGGR_PID,        /* contains pid + stats */
 134         TASKSTATS_TYPE_AGGR_TGID,       /* contains tgid + stats */
 135         __TASKSTATS_TYPE_MAX,
 136 };
 137
 138 #define TASKSTATS_TYPE_MAX (__TASKSTATS_TYPE_MAX - 1)
 139
 140 enum {
 141         TASKSTATS_CMD_ATTR_UNSPEC = 0,
 142         TASKSTATS_CMD_ATTR_PID,
 143         TASKSTATS_CMD_ATTR_TGID,
 144         TASKSTATS_CMD_ATTR_REGISTER_CPUMASK,
 145         TASKSTATS_CMD_ATTR_DEREGISTER_CPUMASK,
 146         __TASKSTATS_CMD_ATTR_MAX,
 147 };
 148
 149 #define TASKSTATS_CMD_ATTR_MAX (__TASKSTATS_CMD_ATTR_MAX - 1)
 150
 151 /* NETLINK_GENERIC related info */
 152
 153 #define TASKSTATS_GENL_NAME     "TASKSTATS"
 154 #define TASKSTATS_GENL_VERSION  0x1
 155
 156 #endif /* _LINUX_TASKSTATS_H */