Add a platform for Performance Co-Pilot (PCP) metrics

This introduces an initial platform for extracting metrics
using the PCP performance metrics API - PMAPI(3).  It can
be used via the --enable-pcp=yes configure option.

So far I've added support for live localhost metrics only,
and only using pre-defined metrics already found in htop.
If available, all sampling is performed by pmcd(1) - else,
we fallback to htop doing the metric sampling itself (all
below the PMAPI).  When pmcd is used, it may be configured
to run children with elevated privileges, so htop does not
need to be setuid (authentication with pmcd is available).

Additionally, the PMAPI allows us to support archives (for
historical analysis and for automated regression tests in
htop).  We'll need platform-specific command line argument
additions, which isn't yet feasible in htop (not difficult
to add though).

The goal of this first version is minimal impact in terms
of modifying the htop codebase, to introduce key ideas in
PCP (metric namespace, metadata, APIs and so on) and give
us something to discuss, experiment with and build on.

1 files changed, 214 insertions, 0 deletions

diff --git a/pcp/Platform.h b/pcp/Platform.h
new file mode 100644
index 00000000..c9e46b80
--- /dev/null
+++ b/pcp/Platform.h
@@ -0,0 +1,214 @@
+#ifndef HEADER_Platform
+#define HEADER_Platform
+/*
+htop - pcp/Platform.h
+(C) 2014 Hisham H. Muhammad
+(C) 2020 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>
+
+#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"
+#include "Meter.h"
+#include "Process.h"
+#include "ProcessLocksScreen.h"
+#include "SignalsPanel.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);
+
+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(unsigned long int* bytesReceived,
+                           unsigned long int* packetsReceived,
+                           unsigned long int* bytesTransmitted,
+                           unsigned long int* packetsTransmitted);
+
+void Platform_getBattery(double *percent, ACPresence *isOnAC);
+
+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_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_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_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_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);
+
+int Metric_instanceCount(Metric metric);
+
+int Metric_instanceOffset(Metric metric, int inst);
+
+pmAtomValue *Metric_instance(Metric metric, int inst, int offset, pmAtomValue *atom, int type);
+
+#endif