---

/root/resourcemonitord/resourcemonitord/rmProcessMonitor/RM_ProcessMonitor.h

Go to the documentation of this file.

/***************************************************************************
                          RM_ProcessMonitor.h  -  description
                             -------------------
    begin                : Fri Sep 21 2001
    copyright            : (C) 2001 by Todd C. Davis
    email                : todd.c.davis@intel.com
 ***************************************************************************/


/*M*
BSD License

Copyright (c) 2002, Intel Corporation
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  a.. Redistributions of source code must retain the above copyright notice,
      this list of conditions and the following disclaimer.
  b.. Redistributions in binary form must reproduce the above copyright notice,
      this list of conditions and the following disclaimer in the documentation
      and/or other materials provided with the distribution.
  c.. Neither the name of Intel Corporation nor the names of its contributors
      may be used to endorse or promote products derived from this software
      without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 *M*/


#ifndef __RM_ProcessMonitor_h__
#define __RM_ProcessMonitor_h__

#ifdef __cplusplus

namespace ProcessMonitor
{
#endif  // __cplusplus

#define RM_PROCESS_UUID_STRING  "09d5fc35-b13d-4cf0-9e02-d655255f9aca"

//
// The text strings can be localized here and the library rebuilt
//
#ifdef RM_USING_WIDE_CHARS
#define RM_PROCESS_NAME     L"ProcessMonitor"
#define RM_PROCESS_DESCRIPTION  L"ProcessMonitor is a resource monitor subsystem that \
provides access to statistics about a running processes. \
Each running process is a resource and the statistics \
are obtain from /proc/pid/[fd|stat|statm]"

#define RM_PROCESS_RESOURCE_NAME    L"ProcessMonitorPid"
#define RM_PROCESS_RESOURCE_DESCRIPTION L"A ProcessMonitor resource is a process. \
A valid pid of a running process is used as the resource id when creating a monitor \
or accessing the value of a process statistic."

#define CPU_putime_NAME L"percent user mode time"
#define CPU_putime_DESCRIPTION  L"The percentage of time that this process has been scheduled in user mode.\
 It is the percentage of accummulated user mode time over the last 10 readings."
#define CPU_putime_UNITS    L"percent"

#define CPU_pstime_NAME L"percent system mode time"
#define CPU_pstime_DESCRIPTION  L"The percentage of time that this process has been scheduled in kernel mode.\
 It is the percentage of accummulated kernel mode time over the last 10 readings."
#define CPU_pstime_UNITS    L"percent"

#define CPU_ptime_NAME  L"percent CPU time"
#define CPU_ptime_DESCRIPTION   L"The percentage of time that this process has been scheduled in user and kernel mode.\
 It is the percentage of accummulated user plus system mode time over the last 10 readings."
#define CPU_ptime_UNITS L"percent"

#define FD_fds_NAME L"open files"
#define FD_fds_DESCRIPTION  L"Current number of open files as reported in the /proc/pid/fd directory"
#define FD_fds_UNITS    L"file descriptors"

#define STAT_minflt_NAME    L"minor faults"
#define STAT_minflt_DESCRIPTION L"The number of minor faults the process has made, those which have not required loading a memory page from disk."
#define STAT_minflt_UNITS   L"faults"

#define STAT_cminflt_NAME   L"children minor faults"
#define STAT_cminflt_DESCRIPTION    L"The number of minor faults that the process and its children have made."
#define STAT_cminflt_UNITS  L"faults"

#define STAT_majflt_NAME    L"major fault"
#define STAT_majflt_DESCRIPTION L"The number of major faults the process has made, those which have required loading a memory page from disk."
#define STAT_majflt_UNITS   L"faults"

#define STAT_cmajflt_NAME   L"children major faults"
#define STAT_cmajflt_DESCRIPTION    L"The number of major faults that the process and its children have made."
#define STAT_cmajflt_UNITS  L"faults"

#define STAT_utime_NAME L"user mode time"
#define STAT_utime_DESCRIPTION  L"The number of jiffies that this process has been scheduled in user mode."
#define STAT_utime_UNITS    L"jiffies"

#define STAT_stime_NAME L"system mode time"
#define STAT_stime_DESCRIPTION  L"The number of jiffies that this process has been scheduled in kernel mode."
#define STAT_stime_UNITS    L"jiffies"

#define STAT_cutime_NAME    L"children user mode time"
#define STAT_cutime_DESCRIPTION L"The number of jiffies that this process and its children have been scheduled in user mode."
#define STAT_cutime_UNITS   L"jiffies"

#define STAT_cstime_NAME    L"children system mode time"
#define STAT_cstime_DESCRIPTION L"The number of jiffies that this process and its children have been scheduled in kernel mode."
#define STAT_cstime_UNITS   L"jiffies"

#define STAT_counter_NAME   L"current timeslice"
#define STAT_counter_DESCRIPTION    L"The current maximum size in jiffies of the process's next timeslice, or what is currently left of its current timeslice, if it is the currently running process."
#define STAT_counter_UNITS  L"jiffies"

#define STAT_priority_NAME  L"priority"
#define STAT_priority_DESCRIPTION   L"The standard nice value, plus fifteen. The value is never negative in the kernel."
#define STAT_priority_UNITS L""

#define STAT_timeout_NAME   L"next timeout"
#define STAT_timeout_DESCRIPTION    L"The time in jiffies of the process's next timeout."
#define STAT_timeout_UNITS  L"jiffies"

#define STAT_itrealvalue_NAME   L"next SIGALRM"
#define STAT_itrealvalue_DESCRIPTION    L"The time (in jiffies) before the next SIGALRM is sent to the process due to an interval timer."
#define STAT_itrealvalue_UNITS  L"jiffies"

#define STAT_starttime_NAME L"start time"
#define STAT_starttime_DESCRIPTION  L"Time the process started in jiffies after system boot."
#define STAT_starttime_UNITS    L"jiffies"

#define STAT_vsize_NAME L"virtual memory size"
#define STAT_vsize_DESCRIPTION  L"Virtual memory size."
#define STAT_vsize_UNITS    L"bytes"

#define STAT_rss_NAME   L"resident set size"
#define STAT_rss_DESCRIPTION    L"Resident Set Size: number of pages the process has in real memory, minus 3 for administrative purposes. This is just the pages which count towards text, data, or stack space. This does not include pages which have not been demand-loaded in, or which are swapped out."
#define STAT_rss_UNITS  L"pages"

#define STAT_rlim_NAME  L"resident set limit"
#define STAT_rlim_DESCRIPTION   L"Current limit in bytes on the rss of the process (usually 2,147,483,647)."
#define STAT_rlim_UNITS L"bytes"

#define STATM_size_NAME L"total program size"
#define STATM_size_DESCRIPTION  L"total program size in pages"
#define STATM_size_UNITS    L"pages"

#define STATM_resident_NAME L"resident size"
#define STATM_resident_DESCRIPTION  L"resident size of memory portions in pages"
#define STATM_resident_UNITS    L"pages"

#define STATM_shared_NAME   L"shared size"
#define STATM_shared_DESCRIPTION    L"number of pages that are shared"
#define STATM_shared_UNITS  L"pages"

#define STATM_trs_NAME  L"code size"
#define STATM_trs_DESCRIPTION   L"number of pages that are 'code'"
#define STATM_trs_UNITS L"pages"

#define STATM_drs_NAME  L"data size"
#define STATM_drs_DESCRIPTION   L"number of pages of data/stack"
#define STATM_drs_UNITS L"pages"

#define STATM_lrs_NAME  L"library size"
#define STATM_lrs_DESCRIPTION   L"number of pages of library"
#define STATM_lrs_UNITS L"pages"

#define STATM_dt_NAME   L"dirty size"
#define STATM_dt_DESCRIPTION    L"number of dirty pages"
#define STATM_dt_UNITS  L"pages"

#ifdef  InlineProcessMonitor
#define RM_PROCESS__MONITOR_NAME    L"Sample Inline Monitor"
#define RM_PROCESS__MONITOR_DESCRIPTION L"Sample Inline Monitor - for demonstration purposes only"
#endif  //InlineProcessMonitor

#else   // RM_USING_WIDE_CHARS

#define RM_PROCESS_NAME     "ProcessMonitor"
#define RM_PROCESS_DESCRIPTION  "ProcessMonitor is a resource monitor subsystem that \
provides access to statistics about a running processes. \
Each running process is a resource and the statistics \
are obtain from /proc/pid/[fd|stat|statm]"

#define RM_PROCESS_RESOURCE_NAME    "ProcessMonitorPid"
#define RM_PROCESS_RESOURCE_DESCRIPTION "A ProcessMonitor resource is a process. \
A valid pid of a running process is used as the resource id when creating a monitor \
or accessing the value of a process statistic."

#define CPU_putime_NAME "percent user mode time"
#define CPU_putime_DESCRIPTION  "The percentage of time that this process has been scheduled in user mode.\
 It is the percentage of accummulated user mode time over the last 10 readings."
#define CPU_putime_UNITS    "percent"

#define CPU_pstime_NAME "percent system mode time"
#define CPU_pstime_DESCRIPTION  "The percentage of time that this process has been scheduled in kernel mode.\
 It is the percentage of accummulated kernel mode time over the last 10 readings."
#define CPU_pstime_UNITS    "percent"

#define CPU_ptime_NAME  "percent CPU time"
#define CPU_ptime_DESCRIPTION   "The percentage of time that this process has been scheduled in user and kernel mode.\
 It is the percentage of accummulated user plus system mode time over the last 10 readings."
#define CPU_ptime_UNITS "percent"

#define FD_fds_NAME "open files"
#define FD_fds_DESCRIPTION  "Current number of open files as reported in the /proc/pid/fd directory"
#define FD_fds_UNITS    "file descriptors"

#define STAT_minflt_NAME    "minor faults"
#define STAT_minflt_DESCRIPTION "The number of minor faults the process has made, those which have not required loading a memory page from disk."
#define STAT_minflt_UNITS   "faults"

#define STAT_cminflt_NAME   "children minor faults"
#define STAT_cminflt_DESCRIPTION    "The number of minor faults that the process and its children have made."
#define STAT_cminflt_UNITS  "faults"

#define STAT_majflt_NAME    "major fault"
#define STAT_majflt_DESCRIPTION "The number of major faults the process has made, those which have required loading a memory page from disk."
#define STAT_majflt_UNITS   "faults"

#define STAT_cmajflt_NAME   "children major faults"
#define STAT_cmajflt_DESCRIPTION    "The number of major faults that the process and its children have made."
#define STAT_cmajflt_UNITS  "faults"

#define STAT_utime_NAME "user mode time"
#define STAT_utime_DESCRIPTION  "The number of jiffies that this process has been scheduled in user mode."
#define STAT_utime_UNITS    "jiffies"

#define STAT_stime_NAME "system mode time"
#define STAT_stime_DESCRIPTION  "The number of jiffies that this process has been scheduled in kernel mode."
#define STAT_stime_UNITS    "jiffies"

#define STAT_cutime_NAME    "children user mode time"
#define STAT_cutime_DESCRIPTION "The number of jiffies that this process and its children have been scheduled in user mode."
#define STAT_cutime_UNITS   "jiffies"

#define STAT_cstime_NAME    "children system mode time"
#define STAT_cstime_DESCRIPTION "The number of jiffies that this process and its children have been scheduled in kernel mode."
#define STAT_cstime_UNITS   "jiffies"

#define STAT_counter_NAME   "current timeslice"
#define STAT_counter_DESCRIPTION    "The current maximum size in jiffies of the process's next timeslice, or what is currently left of its current timeslice, if it is the currently running process."
#define STAT_counter_UNITS  "jiffies"

#define STAT_priority_NAME  "priority"
#define STAT_priority_DESCRIPTION   "The standard nice value, plus fifteen. The value is never negative in the kernel."
#define STAT_priority_UNITS ""

#define STAT_timeout_NAME   "next timeout"
#define STAT_timeout_DESCRIPTION    "The time in jiffies of the process's next timeout."
#define STAT_timeout_UNITS  "jiffies"

#define STAT_itrealvalue_NAME   "next SIGARM"
#define STAT_itrealvalue_DESCRIPTION    "The time (in jiffies) before the next SIGARM is sent to the process due to an interval timer."
#define STAT_itrealvalue_UNITS  "jiffies"

#define STAT_starttime_NAME "start time"
#define STAT_starttime_DESCRIPTION  "Time the process started in jiffies after system boot."
#define STAT_starttime_UNITS    "jiffies"

#define STAT_vsize_NAME "virtual memory size"
#define STAT_vsize_DESCRIPTION  "Virtual memory size."
#define STAT_vsize_UNITS    "bytes"

#define STAT_rss_NAME   "resident set size"
#define STAT_rss_DESCRIPTION    "Resident Set Size: number of pages the process has in real memory, minus 3 for administrative purposes. This is just the pages which count towards text, data, or stack space. This does not include pages which have not been demand-loaded in, or which are swapped out."
#define STAT_rss_UNITS  "pages"

#define STAT_rlim_NAME  "resident set limit"
#define STAT_rlim_DESCRIPTION   "Current limit in bytes on the rss of the process (usually 2,147,483,647)."
#define STAT_rlim_UNITS "bytes"

#define STATM_size_NAME "total program size"
#define STATM_size_DESCRIPTION  "total program size in pages"
#define STATM_size_UNITS    "pages"

#define STATM_resident_NAME "resident size"
#define STATM_resident_DESCRIPTION  "resident size of memory portions in pages"
#define STATM_resident_UNITS    "pages"

#define STATM_shared_NAME   "shared size"
#define STATM_shared_DESCRIPTION    "number of pages that are shared"
#define STATM_shared_UNITS  "pages"

#define STATM_trs_NAME  "code size"
#define STATM_trs_DESCRIPTION   "number of pages that are 'code'"
#define STATM_trs_UNITS "pages"

#define STATM_drs_NAME  "data size"
#define STATM_drs_DESCRIPTION   "number of pages of data/stack"
#define STATM_drs_UNITS "pages"

#define STATM_lrs_NAME  "library size"
#define STATM_lrs_DESCRIPTION   "number of pages of library"
#define STATM_lrs_UNITS "pages"

#define STATM_dt_NAME   "dirty size"
#define STATM_dt_DESCRIPTION    "number of dirty pages"
#define STATM_dt_UNITS  "pages"

#ifdef  InlineProcessMonitor
#define RM_PROCESS__MONITOR_NAME    "Sample Inline Monitor"
#define RM_PROCESS__MONITOR_DESCRIPTION "Sample Inline Monitor - for demonstration purposes only"
#endif  //InlineProcessMonitor

#endif // RM_USING_WIDE_CHARS

#define CPU_putime_ID   60
#define CPU_putime_TYPE rmGauge
#define CPU_putime_SIZE rmSizeU32
#define CPU_putime_SCALE    rmScaleNone
#define CPU_pstime_ID   61
#define CPU_pstime_TYPE rmGauge
#define CPU_pstime_SIZE rmSizeU32
#define CPU_pstime_SCALE    rmScaleNone
#define CPU_ptime_ID    62
#define CPU_ptime_TYPE  rmGauge
#define CPU_ptime_SIZE  rmSizeU32
#define CPU_ptime_SCALE rmScaleNone
#define FD_fds_ID   80
#define FD_fds_TYPE rmGauge
#define FD_fds_SIZE rmSizeU32
#define FD_fds_SCALE    rmScaleNone
#define STAT_minflt_ID  100
#define STAT_minflt_TYPE    rmCounter
#define STAT_minflt_SIZE    rmSizeU32
#define STAT_minflt_SCALE   rmScaleNone
#define STAT_cminflt_ID 101
#define STAT_cminflt_TYPE   rmCounter
#define STAT_cminflt_SIZE   rmSizeU32
#define STAT_cminflt_SCALE  rmScaleNone
#define STAT_majflt_ID  102
#define STAT_majflt_TYPE    rmCounter
#define STAT_majflt_SIZE    rmSizeU32
#define STAT_majflt_SCALE   rmScaleNone
#define STAT_cmajflt_ID 103
#define STAT_cmajflt_TYPE   rmCounter
#define STAT_cmajflt_SIZE   rmSizeU32
#define STAT_cmajflt_SCALE  rmScaleNone
#define STAT_utime_ID   104
#define STAT_utime_TYPE rmCounter
#define STAT_utime_SIZE rmSizeU32
#define STAT_utime_SCALE    rmScaleJiffies
#define STAT_stime_ID   105
#define STAT_stime_TYPE rmCounter
#define STAT_stime_SIZE rmSizeU32
#define STAT_stime_SCALE    rmScaleJiffies
#define STAT_cutime_ID  106
#define STAT_cutime_TYPE    rmCounter
#define STAT_cutime_SIZE    rmSizeU32
#define STAT_cutime_SCALE   rmScaleJiffies
#define STAT_cstime_ID   107
#define STAT_cstime_TYPE    rmCounter
#define STAT_cstime_SIZE    rmSizeU32
#define STAT_cstime_SCALE   rmScaleJiffies
#define STAT_counter_ID 108
#define STAT_counter_TYPE   rmGauge
#define STAT_counter_SIZE   rmSizeU32
#define STAT_counter_SCALE  rmScaleJiffies
#define STAT_priority_ID    109
#define STAT_priority_TYPE  rmGauge
#define STAT_priority_SIZE  rmSizeU32
#define STAT_priority_SCALE rmScaleNone
#define STAT_timeout_ID 110
#define STAT_timeout_TYPE   rmGauge
#define STAT_timeout_SIZE   rmSizeU32
#define STAT_timeout_SCALE  rmScaleJiffies
#define STAT_itrealvalue_ID 111
#define STAT_itrealvalue_TYPE   rmGauge
#define STAT_itrealvalue_SIZE   rmSizeU32
#define STAT_itrealvalue_SCALE  rmScaleJiffies
#define STAT_starttime_ID   112
#define STAT_starttime_TYPE rmCounter
#define STAT_starttime_SIZE rmSizeU32
#define STAT_starttime_SCALE    rmScaleJiffies
#define STAT_vsize_ID   113
#define STAT_vsize_TYPE rmGauge
#define STAT_vsize_SIZE rmSizeU32
#define STAT_vsize_SCALE    rmScaleByte
#define STAT_rss_ID 114
#define STAT_rss_TYPE   rmGauge
#define STAT_rss_SIZE   rmSizeU32
#define STAT_rss_SCALE  rmScalePages
#define STAT_rlim_ID    115
#define STAT_rlim_TYPE  rmCounter
#define STAT_rlim_SIZE  rmSizeU32
#define STAT_rlim_SCALE   rmScaleByte
#define STATM_size_ID   150
#define STATM_size_TYPE rmGauge
#define STATM_size_SIZE rmSizeU32
#define STATM_size_SCALE    rmScalePages
#define STATM_resident_ID   151
#define STATM_resident_TYPE rmGauge
#define STATM_resident_SIZE rmSizeU32
#define STATM_resident_SCALE    rmScalePages
#define STATM_shared_ID 152
#define STATM_shared_TYPE   rmGauge
#define STATM_shared_SIZE   rmSizeU32
#define STATM_shared_SCALE  rmScalePages
#define STATM_trs_ID    153
#define STATM_trs_TYPE  rmGauge
#define STATM_trs_SIZE  rmSizeU32
#define STATM_trs_SCALE rmScalePages
#define STATM_drs_ID    154
#define STATM_drs_TYPE  rmGauge
#define STATM_drs_SIZE  rmSizeU32
#define STATM_drs_SCALE rmScalePages
#define STATM_lrs_ID    155
#define STATM_lrs_TYPE  rmGauge
#define STATM_lrs_SIZE  rmSizeU32
#define STATM_lrs_SCALE rmScalePages
#define STATM_dt_ID 156
#define STATM_dt_TYPE   rmGauge
#define STATM_dt_SIZE   rmSizeU32
#define STATM_dt_SCALE  rmScalePages

#ifdef __cplusplus
};  //ProcessMonitor
#endif
#endif      //  __RM_ProcessMonitor_h__

---