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

.github/workflows/ci.yml

@@ -110,6 +110,22 @@ jobs:
     - name: Distcheck
       run: make distcheck DISTCHECK_CONFIGURE_FLAGS='--enable-static --enable-werror --enable-openvz --enable-vserver --enable-ancient-vserver --enable-unicode --disable-hwloc --disable-delayacct --enable-sensors --enable-capabilities'
 
+  build-ubuntu-latest-pcp:
+    # Turns out 'ubuntu-latest' can be older than 20.04, we want PCP v5+
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install Dependencies
+      run: sudo apt-get install libpcp3-dev libncursesw5-dev libtinfo-dev libgpm-dev
+    - name: Bootstrap
+      run: ./autogen.sh
+    - name: Configure
+      # Until Ubuntu catches up with pcp-5.2.3+, cannot use -werror due to:
+      # passing argument 2 of ‘pmLookupName’ from incompatible pointer type
+      run: ./configure --enable-pcp --enable-unicode
+    - name: Build
+      run: make -k
+
   build-ubuntu-latest-clang-analyzer:
     runs-on: ubuntu-latest
     env:

.gitignore

@@ -1,5 +1,6 @@
-# the binary:
+# the binaries:
 htop
+pcp-htop
 
 # all object files
 *.o

Makefile.am

@@ -44,7 +44,6 @@ myhtopsources = \
 	Hashtable.c \
 	Header.c \
 	HostnameMeter.c \
-	htop.c \
 	IncSet.c \
 	InfoScreen.c \
 	ListItem.c \
@@ -328,6 +327,37 @@ myhtopplatheaders = $(solaris_platform_headers)
 myhtopplatsources = $(solaris_platform_sources)
 endif
 
+# Performance Co-Pilot (PCP)
+# --------------------------
+
+pcp_platform_headers = \
+	pcp/PCPProcess.h \
+	pcp/PCPProcessList.h \
+	pcp/Platform.h \
+	pcp/ProcessField.h \
+	linux/PressureStallMeter.h \
+	linux/ZramMeter.h \
+	linux/ZramStats.h \
+	zfs/ZfsArcMeter.h \
+	zfs/ZfsArcStats.h \
+	zfs/ZfsCompressedArcMeter.h
+
+pcp_platform_sources = \
+	pcp/PCPProcess.c \
+	pcp/PCPProcessList.c \
+	pcp/Platform.c \
+	linux/PressureStallMeter.c \
+	linux/ZramMeter.c \
+	zfs/ZfsArcMeter.c \
+	zfs/ZfsCompressedArcMeter.c
+
+if HTOP_PCP
+myhtopplatprogram = pcp-htop
+myhtopplatheaders = $(pcp_platform_headers)
+myhtopplatsources = $(pcp_platform_sources)
+pcp_htop_SOURCES  = $(myhtopplatprogram).c $(myhtopheaders) $(myhtopplatheaders) $(myhtopsources) $(myhtopplatsources)
+endif
+
 # Unsupported
 # -----------
 
@@ -353,7 +383,7 @@ endif
 # ----
 
 bin_PROGRAMS = $(myhtopplatprogram)
-htop_SOURCES = $(myhtopheaders) $(myhtopplatheaders) $(myhtopsources) $(myhtopplatsources)
+htop_SOURCES = $(myhtopplatprogram).c $(myhtopheaders) $(myhtopplatheaders) $(myhtopsources) $(myhtopplatsources)
 nodist_htop_SOURCES = config.h
 
 target:

configure.ac

@@ -95,6 +95,31 @@ esac
 
 # ----------------------------------------------------------------------
 
+# ----------------------------------------------------------------------
+# Checks for a PCP-based htop build.  (https://pcp.io)
+# ----------------------------------------------------------------------
+
+AC_ARG_ENABLE([pcp],
+              [AS_HELP_STRING([--enable-pcp],
+                              [build a pcp-htop binary @<:@default=no@:>@])],
+              [],
+              [enable_pcp=no])
+case "$enable_pcp" in
+   no)
+      ;;
+   yes)
+      AC_CHECK_HEADERS([pcp/pmapi.h], [my_htop_platform=pcp],
+		       [AC_MSG_ERROR([can not find PCP header file])])
+      AC_SEARCH_LIBS([pmNewContext], [pcp], [], [AC_MSG_ERROR([can not find PCP library])])
+      AC_DEFINE([HTOP_PCP], [1], [Define if building pcp-htop binary.])
+      ;;
+   *)
+      AC_MSG_ERROR([bad value '$enable_pcp' for --enable-pcp option])
+      ;;
+esac
+
+# ----------------------------------------------------------------------
+
 
 # ----------------------------------------------------------------------
 # Checks for generic header files.
@@ -608,6 +633,7 @@ AM_CONDITIONAL([HTOP_DRAGONFLYBSD], [test "$my_htop_platform" = dragonflybsd])
 AM_CONDITIONAL([HTOP_OPENBSD], [test "$my_htop_platform" = openbsd])
 AM_CONDITIONAL([HTOP_DARWIN], [test "$my_htop_platform" = darwin])
 AM_CONDITIONAL([HTOP_SOLARIS], [test "$my_htop_platform" = solaris])
+AM_CONDITIONAL([HTOP_PCP], [test "$my_htop_platform" = pcp])
 AM_CONDITIONAL([HTOP_UNSUPPORTED], [test "$my_htop_platform" = unsupported])
 
 AC_SUBST(my_htop_platform)

pcp-htop.c

@@ -0,0 +1,26 @@
+/*
+htop - pcp-htop.c
+(C) 2004-2011 Hisham H. Muhammad
+(C) 2020-2021 htop dev team
+Released under the GNU GPLv2, see the COPYING file
+in the source distribution for its full text.
+*/
+
+#include "config.h" // IWYU pragma: keep
+
+#include <pcp/pmapi.h>
+
+#include "CommandLine.h"
+#include "Platform.h"
+
+
+int main(int argc, char** argv) {
+   const char* name = "pcp-htop";
+   pmSetProgname(name);
+
+   /* extract environment variables */
+   opts.flags |= PM_OPTFLAG_ENV_ONLY;
+   (void)pmGetOptions(argc, argv, &opts);
+
+   return CommandLine_run(name, argc, argv);
+}