htop/pcp/Platform.h

274 lines
10 KiB
C
Raw Normal View History

#ifndef HEADER_Platform
#define HEADER_Platform
/*
htop - pcp/Platform.h
(C) 2014 Hisham H. Muhammad
(C) 2020-2021 htop dev team
(C) 2020-2021 Red Hat, Inc. All Rights Reserved.
Released under the GNU GPLv2, see the COPYING file
in the source distribution for its full text.
*/
#include <ctype.h>
#include <stdbool.h>
#include <pcp/pmapi.h>
/* use htop config.h values for these macros, not pcp values */
#undef PACKAGE_URL
#undef PACKAGE_NAME
#undef PACKAGE_STRING
#undef PACKAGE_TARNAME
#undef PACKAGE_VERSION
#undef PACKAGE_BUGREPORT
#include "Action.h"
#include "BatteryMeter.h"
#include "DiskIOMeter.h"
Add a new DynamicMeter class for runtime Meter extension This commit is based on exploratory work by Sohaib Mohamed. The end goal is two-fold - to support addition of Meters we build via configuration files for both the PCP platform and for scripts ( https://github.com/htop-dev/htop/issues/526 ) Here, we focus on generic code and the PCP support. A new class DynamicMeter is introduced - it uses the special case 'param' field handling that previously was used only by the CPUMeter, such that every runtime-configured Meter is given a unique identifier. Unlike with the CPUMeter this is used internally only. When reading/writing to htoprc instead of CPU(N) - where N is an integer param (CPU number) - we use the string name for each meter. For example, if we have a configuration for a DynamicMeter for some Redis metrics, we might read and write "Dynamic(redis)". This identifier is subsequently matched (back) up to the configuration file so we're able to re-create arbitrary user configurations. The PCP platform configuration file format is fairly simple. We expand configs from several directories, including the users homedir alongside htoprc (below htop/meters/) and also /etc/pcp/htop/meters. The format will be described via a new pcp-htop(5) man page, but its basically ini-style and each Meter has one or more metric expressions associated, as well as specifications for labels, color and so on via a dot separated notation for individual metrics within the Meter. A few initial sample configuration files are provided below ./pcp/meters that give the general idea. The PCP "derived" metric specification - see pmRegisterDerived(3) - is used as the syntax for specifying metrics in PCP DynamicMeters.
2021-06-23 07:44:56 +00:00
#include "Hashtable.h"
#include "Meter.h"
#include "NetworkIOMeter.h"
#include "Process.h"
#include "ProcessLocksScreen.h"
#include "SignalsPanel.h"
#include "SysArchMeter.h"
extern ProcessField Platform_defaultFields[];
extern int Platform_numberOfFields;
extern const SignalItem Platform_signals[];
extern const unsigned int Platform_numberOfSignals;
extern const MeterClass* const Platform_meterTypes[];
void Platform_init(void);
void Platform_done(void);
void Platform_setBindings(Htop_Action* keys);
int Platform_getUptime(void);
void Platform_getLoadAverage(double* one, double* five, double* fifteen);
long long Platform_getBootTime(void);
int Platform_getMaxCPU(void);
int Platform_getMaxPid(void);
double Platform_setCPUValues(Meter* this, int cpu);
void Platform_setMemoryValues(Meter* this);
void Platform_setSwapValues(Meter* this);
void Platform_setZramValues(Meter* this);
void Platform_setZfsArcValues(Meter* this);
void Platform_setZfsCompressedArcValues(Meter* this);
char* Platform_getProcessEnv(pid_t pid);
char* Platform_getInodeFilename(pid_t pid, ino_t inode);
FileLocks_ProcessData* Platform_getProcessLocks(pid_t pid);
void Platform_getPressureStall(const char *file, bool some, double* ten, double* sixty, double* threehundred);
bool Platform_getDiskIO(DiskIOData* data);
bool Platform_getNetworkIO(NetworkIOData* data);
void Platform_getBattery(double *percent, ACPresence *isOnAC);
void Platform_getHostname(char* buffer, size_t size);
void Platform_getRelease(char** string);
enum {
PLATFORM_LONGOPT_HOST = 128,
PLATFORM_LONGOPT_TIMEZONE,
PLATFORM_LONGOPT_HOSTZONE,
};
#define PLATFORM_LONG_OPTIONS \
{PMLONGOPT_HOST, optional_argument, 0, PLATFORM_LONGOPT_HOST}, \
{PMLONGOPT_TIMEZONE, optional_argument, 0, PLATFORM_LONGOPT_TIMEZONE}, \
{PMLONGOPT_HOSTZONE, optional_argument, 0, PLATFORM_LONGOPT_HOSTZONE}, \
void Platform_longOptionsUsage(const char* name);
bool Platform_getLongOption(int opt, int argc, char** argv);
extern pmOptions opts;
typedef enum Metric_ {
PCP_CONTROL_THREADS, /* proc.control.perclient.threads */
PCP_HINV_NCPU, /* hinv.ncpu */
PCP_HINV_CPUCLOCK, /* hinv.cpu.clock */
PCP_UNAME_SYSNAME, /* kernel.uname.sysname */
PCP_UNAME_RELEASE, /* kernel.uname.release */
PCP_UNAME_MACHINE, /* kernel.uname.machine */
PCP_UNAME_DISTRO, /* kernel.uname.distro */
PCP_LOAD_AVERAGE, /* kernel.all.load */
PCP_PID_MAX, /* kernel.all.pid_max */
PCP_UPTIME, /* kernel.all.uptime */
PCP_BOOTTIME, /* kernel.all.boottime */
PCP_CPU_USER, /* kernel.all.cpu.user */
PCP_CPU_NICE, /* kernel.all.cpu.nice */
PCP_CPU_SYSTEM, /* kernel.all.cpu.sys */
PCP_CPU_IDLE, /* kernel.all.cpu.idle */
PCP_CPU_IOWAIT, /* kernel.all.cpu.wait.total */
PCP_CPU_IRQ, /* kernel.all.cpu.intr */
PCP_CPU_SOFTIRQ, /* kernel.all.cpu.irq.soft */
PCP_CPU_STEAL, /* kernel.all.cpu.steal */
PCP_CPU_GUEST, /* kernel.all.cpu.guest */
PCP_CPU_GUESTNICE, /* kernel.all.cpu.guest_nice */
PCP_PERCPU_USER, /* kernel.percpu.cpu.user */
PCP_PERCPU_NICE, /* kernel.percpu.cpu.nice */
PCP_PERCPU_SYSTEM, /* kernel.percpu.cpu.sys */
PCP_PERCPU_IDLE, /* kernel.percpu.cpu.idle */
PCP_PERCPU_IOWAIT, /* kernel.percpu.cpu.wait.total */
PCP_PERCPU_IRQ, /* kernel.percpu.cpu.intr */
PCP_PERCPU_SOFTIRQ, /* kernel.percpu.cpu.irq.soft */
PCP_PERCPU_STEAL, /* kernel.percpu.cpu.steal */
PCP_PERCPU_GUEST, /* kernel.percpu.cpu.guest */
PCP_PERCPU_GUESTNICE, /* kernel.percpu.cpu.guest_nice */
PCP_MEM_TOTAL, /* mem.physmem */
PCP_MEM_FREE, /* mem.util.free */
PCP_MEM_BUFFERS, /* mem.util.bufmem */
PCP_MEM_CACHED, /* mem.util.cached */
PCP_MEM_SHARED, /* mem.util.shared */
PCP_MEM_AVAILABLE, /* mem.util.available */
PCP_MEM_SRECLAIM, /* mem.util.slabReclaimable */
PCP_MEM_SWAPCACHED, /* mem.util.swapCached */
PCP_MEM_SWAPTOTAL, /* mem.util.swapTotal */
PCP_MEM_SWAPFREE, /* mem.util.swapFree */
PCP_DISK_READB, /* disk.all.read_bytes */
PCP_DISK_WRITEB, /* disk.all.write_bytes */
PCP_DISK_ACTIVE, /* disk.all.avactive */
PCP_NET_RECVB, /* network.all.in.bytes */
PCP_NET_SENDB, /* network.all.out.bytes */
PCP_NET_RECVP, /* network.all.in.packets */
PCP_NET_SENDP, /* network.all.out.packets */
PCP_PSI_CPUSOME, /* kernel.all.pressure.cpu.some.avg */
PCP_PSI_IOSOME, /* kernel.all.pressure.io.some.avg */
PCP_PSI_IOFULL, /* kernel.all.pressure.io.full.avg */
PCP_PSI_MEMSOME, /* kernel.all.pressure.memory.some.avg */
PCP_PSI_MEMFULL, /* kernel.all.pressure.memory.full.avg */
PCP_ZFS_ARC_ANON_SIZE, /* zfs.arc.anon_size */
PCP_ZFS_ARC_BONUS_SIZE, /* zfs.arc.bonus_size */
PCP_ZFS_ARC_COMPRESSED_SIZE, /* zfs.arc.compressed_size */
PCP_ZFS_ARC_UNCOMPRESSED_SIZE, /* zfs.arc.uncompressed_size */
PCP_ZFS_ARC_C_MAX, /* zfs.arc.c_max */
PCP_ZFS_ARC_DBUF_SIZE, /* zfs.arc.dbuf_size */
PCP_ZFS_ARC_DNODE_SIZE, /* zfs.arc.dnode_size */
PCP_ZFS_ARC_HDR_SIZE, /* zfs.arc.hdr_size */
PCP_ZFS_ARC_MFU_SIZE, /* zfs.arc.mfu_size */
PCP_ZFS_ARC_MRU_SIZE, /* zfs.arc.mru_size */
PCP_ZFS_ARC_SIZE, /* zfs.arc.size */
PCP_ZRAM_CAPACITY, /* zram.capacity */
PCP_ZRAM_ORIGINAL, /* zram.mm_stat.data_size.original */
PCP_ZRAM_COMPRESSED, /* zram.mm_stat.data_size.compressed */
PCP_PROC_PID, /* proc.psinfo.pid */
PCP_PROC_PPID, /* proc.psinfo.ppid */
PCP_PROC_TGID, /* proc.psinfo.tgid */
PCP_PROC_PGRP, /* proc.psinfo.pgrp */
PCP_PROC_SESSION, /* proc.psinfo.session */
PCP_PROC_STATE, /* proc.psinfo.sname */
PCP_PROC_TTY, /* proc.psinfo.tty */
PCP_PROC_TTYPGRP, /* proc.psinfo.tty_pgrp */
PCP_PROC_MINFLT, /* proc.psinfo.minflt */
PCP_PROC_MAJFLT, /* proc.psinfo.maj_flt */
PCP_PROC_CMINFLT, /* proc.psinfo.cmin_flt */
PCP_PROC_CMAJFLT, /* proc.psinfo.cmaj_flt */
PCP_PROC_UTIME, /* proc.psinfo.utime */
PCP_PROC_STIME, /* proc.psinfo.stime */
PCP_PROC_CUTIME, /* proc.psinfo.cutime */
PCP_PROC_CSTIME, /* proc.psinfo.cstime */
PCP_PROC_PRIORITY, /* proc.psinfo.priority */
PCP_PROC_NICE, /* proc.psinfo.nice */
PCP_PROC_THREADS, /* proc.psinfo.threads */
PCP_PROC_STARTTIME, /* proc.psinfo.start_time */
PCP_PROC_PROCESSOR, /* proc.psinfo.processor */
PCP_PROC_CMD, /* proc.psinfo.cmd */
PCP_PROC_PSARGS, /* proc.psinfo.psargs */
PCP_PROC_CGROUPS, /* proc.psinfo.cgroups */
PCP_PROC_OOMSCORE, /* proc.psinfo.oom_score */
PCP_PROC_VCTXSW, /* proc.psinfo.vctxsw */
PCP_PROC_NVCTXSW, /* proc.psinfo.nvctxsw */
PCP_PROC_LABELS, /* proc.psinfo.labels */
PCP_PROC_ENVIRON, /* proc.psinfo.environ */
PCP_PROC_TTYNAME, /* proc.psinfo.ttyname */
PCP_PROC_EXE, /* proc.psinfo.exe */
PCP_PROC_CWD, /* proc.psinfo.cwd */
PCP_PROC_ID_UID, /* proc.id.uid */
PCP_PROC_ID_USER, /* proc.id.uid_nm */
PCP_PROC_IO_RCHAR, /* proc.io.rchar */
PCP_PROC_IO_WCHAR, /* proc.io.wchar */
PCP_PROC_IO_SYSCR, /* proc.io.syscr */
PCP_PROC_IO_SYSCW, /* proc.io.syscw */
PCP_PROC_IO_READB, /* proc.io.read_bytes */
PCP_PROC_IO_WRITEB, /* proc.io.write_bytes */
PCP_PROC_IO_CANCELLED, /* proc.io.cancelled_write_bytes */
PCP_PROC_MEM_SIZE, /* proc.memory.size */
PCP_PROC_MEM_RSS, /* proc.memory.rss */
PCP_PROC_MEM_SHARE, /* proc.memory.share */
PCP_PROC_MEM_TEXTRS, /* proc.memory.textrss */
PCP_PROC_MEM_LIBRS, /* proc.memory.librss */
PCP_PROC_MEM_DATRS, /* proc.memory.datrss */
PCP_PROC_MEM_DIRTY, /* proc.memory.dirty */
PCP_PROC_SMAPS_PSS, /* proc.smaps.pss */
PCP_PROC_SMAPS_SWAP, /* proc.smaps.swap */
PCP_PROC_SMAPS_SWAPPSS, /* proc.smaps.swappss */
PCP_METRIC_COUNT /* total metric count */
} Metric;
void Metric_enable(Metric metric, bool enable);
bool Metric_enabled(Metric metric);
void Metric_enableThreads(void);
bool Metric_fetch(struct timeval *timestamp);
bool Metric_iterate(Metric metric, int* instp, int* offsetp);
pmAtomValue* Metric_values(Metric metric, pmAtomValue *atom, int count, int type);
Add a new DynamicMeter class for runtime Meter extension This commit is based on exploratory work by Sohaib Mohamed. The end goal is two-fold - to support addition of Meters we build via configuration files for both the PCP platform and for scripts ( https://github.com/htop-dev/htop/issues/526 ) Here, we focus on generic code and the PCP support. A new class DynamicMeter is introduced - it uses the special case 'param' field handling that previously was used only by the CPUMeter, such that every runtime-configured Meter is given a unique identifier. Unlike with the CPUMeter this is used internally only. When reading/writing to htoprc instead of CPU(N) - where N is an integer param (CPU number) - we use the string name for each meter. For example, if we have a configuration for a DynamicMeter for some Redis metrics, we might read and write "Dynamic(redis)". This identifier is subsequently matched (back) up to the configuration file so we're able to re-create arbitrary user configurations. The PCP platform configuration file format is fairly simple. We expand configs from several directories, including the users homedir alongside htoprc (below htop/meters/) and also /etc/pcp/htop/meters. The format will be described via a new pcp-htop(5) man page, but its basically ini-style and each Meter has one or more metric expressions associated, as well as specifications for labels, color and so on via a dot separated notation for individual metrics within the Meter. A few initial sample configuration files are provided below ./pcp/meters that give the general idea. The PCP "derived" metric specification - see pmRegisterDerived(3) - is used as the syntax for specifying metrics in PCP DynamicMeters.
2021-06-23 07:44:56 +00:00
const pmDesc* Metric_desc(Metric metric);
int Metric_instanceCount(Metric metric);
int Metric_instanceOffset(Metric metric, int inst);
Add a new DynamicMeter class for runtime Meter extension This commit is based on exploratory work by Sohaib Mohamed. The end goal is two-fold - to support addition of Meters we build via configuration files for both the PCP platform and for scripts ( https://github.com/htop-dev/htop/issues/526 ) Here, we focus on generic code and the PCP support. A new class DynamicMeter is introduced - it uses the special case 'param' field handling that previously was used only by the CPUMeter, such that every runtime-configured Meter is given a unique identifier. Unlike with the CPUMeter this is used internally only. When reading/writing to htoprc instead of CPU(N) - where N is an integer param (CPU number) - we use the string name for each meter. For example, if we have a configuration for a DynamicMeter for some Redis metrics, we might read and write "Dynamic(redis)". This identifier is subsequently matched (back) up to the configuration file so we're able to re-create arbitrary user configurations. The PCP platform configuration file format is fairly simple. We expand configs from several directories, including the users homedir alongside htoprc (below htop/meters/) and also /etc/pcp/htop/meters. The format will be described via a new pcp-htop(5) man page, but its basically ini-style and each Meter has one or more metric expressions associated, as well as specifications for labels, color and so on via a dot separated notation for individual metrics within the Meter. A few initial sample configuration files are provided below ./pcp/meters that give the general idea. The PCP "derived" metric specification - see pmRegisterDerived(3) - is used as the syntax for specifying metrics in PCP DynamicMeters.
2021-06-23 07:44:56 +00:00
pmAtomValue* Metric_instance(Metric metric, int inst, int offset, pmAtomValue *atom, int type);
int Platform_addMetric(Metric id, const char *name);
void Platform_gettime_realtime(struct timeval* tv, uint64_t* msec);
void Platform_gettime_monotonic(uint64_t* msec);
Add a new DynamicMeter class for runtime Meter extension This commit is based on exploratory work by Sohaib Mohamed. The end goal is two-fold - to support addition of Meters we build via configuration files for both the PCP platform and for scripts ( https://github.com/htop-dev/htop/issues/526 ) Here, we focus on generic code and the PCP support. A new class DynamicMeter is introduced - it uses the special case 'param' field handling that previously was used only by the CPUMeter, such that every runtime-configured Meter is given a unique identifier. Unlike with the CPUMeter this is used internally only. When reading/writing to htoprc instead of CPU(N) - where N is an integer param (CPU number) - we use the string name for each meter. For example, if we have a configuration for a DynamicMeter for some Redis metrics, we might read and write "Dynamic(redis)". This identifier is subsequently matched (back) up to the configuration file so we're able to re-create arbitrary user configurations. The PCP platform configuration file format is fairly simple. We expand configs from several directories, including the users homedir alongside htoprc (below htop/meters/) and also /etc/pcp/htop/meters. The format will be described via a new pcp-htop(5) man page, but its basically ini-style and each Meter has one or more metric expressions associated, as well as specifications for labels, color and so on via a dot separated notation for individual metrics within the Meter. A few initial sample configuration files are provided below ./pcp/meters that give the general idea. The PCP "derived" metric specification - see pmRegisterDerived(3) - is used as the syntax for specifying metrics in PCP DynamicMeters.
2021-06-23 07:44:56 +00:00
Hashtable* Platform_dynamicMeters(void);
void Platform_dynamicMeterInit(Meter* meter);
void Platform_dynamicMeterUpdateValues(Meter* meter);
void Platform_dynamicMeterDisplay(const Meter* meter, RichString* out);
#endif