mirror of
https://github.com/xzeldon/htop.git
synced 2025-07-13 12:44:34 +03:00
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.
This commit is contained in:
Nathan Scott
368
pcp/PCPDynamicMeter.c
Normal file
368
pcp/PCPDynamicMeter.c
Normal file
@ -0,0 +1,368 @@
|
||||
/*
|
||||
htop - PCPDynamicMeter.c
|
||||
(C) 2021 htop dev team
|
||||
(C) 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 "config.h" // IWYU pragma: keep
|
||||
|
||||
#include "pcp/PCPDynamicMeter.h"
|
||||
|
||||
#include <math.h>
|
||||
#include <stdint.h>
|
||||
#include <stdlib.h>
|
||||
#include <string.h>
|
||||
|
||||
#include "Object.h"
|
||||
#include "Platform.h"
|
||||
#include "ProcessList.h"
|
||||
#include "RichString.h"
|
||||
#include "Settings.h"
|
||||
#include "XUtils.h"
|
||||
|
||||
static PCPDynamicMetric* PCPDynamicMeter_lookupMetric(PCPDynamicMeters* meters, PCPDynamicMeter* meter, const char* name) {
|
||||
size_t bytes = 8 + strlen(meter->super.name) + strlen(name);
|
||||
char* metricName = xMalloc(bytes);
|
||||
xSnprintf(metricName, bytes, "htop.%s.%s", meter->super.name, name);
|
||||
|
||||
PCPDynamicMetric* metric;
|
||||
for (unsigned int i = 0; i < meter->totalMetrics; i++) {
|
||||
metric = &meter->metrics[i];
|
||||
if (String_eq(metric->name, metricName)) {
|
||||
free(metricName);
|
||||
return metric;
|
||||
}
|
||||
}
|
||||
|
||||
/* not an existing metric in this meter - add it */
|
||||
unsigned int n = meter->totalMetrics + 1;
|
||||
meter->metrics = xReallocArray(meter->metrics, n, sizeof(PCPDynamicMetric));
|
||||
meter->totalMetrics = n;
|
||||
metric = &meter->metrics[n-1];
|
||||
memset(metric, 0, sizeof(PCPDynamicMetric));
|
||||
metric->name = metricName;
|
||||
metric->id = meters->offset + meters->cursor;
|
||||
meters->cursor++;
|
||||
|
||||
Platform_addMetric(metric->id, metricName);
|
||||
|
||||
return metric;
|
||||
}
|
||||
|
||||
static void PCPDynamicMeter_parseMetric(PCPDynamicMeters* meters, PCPDynamicMeter* meter, const char *path, unsigned int line, char* key, char* value) {
|
||||
PCPDynamicMetric *metric;
|
||||
char* p;
|
||||
|
||||
if ((p = strchr(key, '.')) == NULL)
|
||||
return;
|
||||
*p++ = '\0'; /* end the name, p is now the attribute, e.g. 'label' */
|
||||
|
||||
if (String_eq(p, "metric")) {
|
||||
/* lookup a dynamic metric with this name, else create */
|
||||
metric = PCPDynamicMeter_lookupMetric(meters, meter, key);
|
||||
|
||||
/* use derived metrics in dynamic meters for simplicity */
|
||||
char* error;
|
||||
if (pmRegisterDerivedMetric(metric->name, value, &error) < 0) {
|
||||
char note[1024];
|
||||
xSnprintf(note, sizeof(note),
|
||||
"failed to parse expression in %s at line %u\n%s\n%s",
|
||||
path, line, error, pmGetProgname());
|
||||
free(error);
|
||||
errno = EINVAL;
|
||||
CRT_fatalError(note);
|
||||
}
|
||||
} else {
|
||||
/* this is a property of a dynamic metric - the metric expression */
|
||||
/* may not have been observed yet - i.e. we allow for any ordering */
|
||||
metric = PCPDynamicMeter_lookupMetric(meters, meter, key);
|
||||
if (String_eq(p, "color")) {
|
||||
if (String_eq(value, "gray"))
|
||||
metric->color = DYNAMIC_GRAY;
|
||||
else if (String_eq(value, "darkgray"))
|
||||
metric->color = DYNAMIC_DARKGRAY;
|
||||
else if (String_eq(value, "red"))
|
||||
metric->color = DYNAMIC_RED;
|
||||
else if (String_eq(value, "green"))
|
||||
metric->color = DYNAMIC_GREEN;
|
||||
else if (String_eq(value, "blue"))
|
||||
metric->color = DYNAMIC_BLUE;
|
||||
else if (String_eq(value, "cyan"))
|
||||
metric->color = DYNAMIC_CYAN;
|
||||
else if (String_eq(value, "magenta"))
|
||||
metric->color = DYNAMIC_MAGENTA;
|
||||
else if (String_eq(value, "yellow"))
|
||||
metric->color = DYNAMIC_YELLOW;
|
||||
else if (String_eq(value, "white"))
|
||||
metric->color = DYNAMIC_WHITE;
|
||||
} else if (String_eq(p, "label")) {
|
||||
free_and_xStrdup(&metric->label, value);
|
||||
} else if (String_eq(p, "suffix")) {
|
||||
free_and_xStrdup(&metric->suffix, value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Ensure a valid name for use in a PCP metric name and in htoprc
|
||||
static void PCPDynamicMeter_validateMeterName(char* key, const char *path, unsigned int line) {
|
||||
char* p = key;
|
||||
char* end = strrchr(key, ']');
|
||||
|
||||
if (end) {
|
||||
*end = '\0';
|
||||
} else {
|
||||
char note[1024];
|
||||
xSnprintf(note, sizeof(note),
|
||||
"No closing brace on meter name at %s line %u\n\"%s\"",
|
||||
path, line, key);
|
||||
errno = EINVAL;
|
||||
CRT_fatalError(note);
|
||||
}
|
||||
|
||||
while (*p) {
|
||||
if (p == key) {
|
||||
if (!isalpha(*p) && *p != '_')
|
||||
break;
|
||||
} else {
|
||||
if (!isalnum(*p) && *p != '_')
|
||||
break;
|
||||
}
|
||||
p++;
|
||||
}
|
||||
if (*p != '\0') { /* badness */
|
||||
char note[1024];
|
||||
xSnprintf(note, sizeof(note),
|
||||
"Invalid meter name at %s line %u\n\"%s\"",
|
||||
path, line, key);
|
||||
errno = EINVAL;
|
||||
CRT_fatalError(note);
|
||||
} else { /* overwrite closing brace */
|
||||
*p = '\0';
|
||||
}
|
||||
}
|
||||
|
||||
static PCPDynamicMeter* PCPDynamicMeter_new(PCPDynamicMeters* meters, const char* name) {
|
||||
PCPDynamicMeter* meter = xCalloc(1, sizeof(*meter));
|
||||
String_safeStrncpy(meter->super.name, name, sizeof(meter->super.name));
|
||||
Hashtable_put(meters->table, ++meters->count, meter);
|
||||
return meter;
|
||||
}
|
||||
|
||||
static void PCPDynamicMeter_parseFile(PCPDynamicMeters* meters, const char* path) {
|
||||
FILE* file = fopen(path, "r");
|
||||
if (!file)
|
||||
return;
|
||||
|
||||
PCPDynamicMeter* meter = NULL;
|
||||
unsigned int lineno = 0;
|
||||
for (;;) {
|
||||
char* line = String_readLine(file);
|
||||
if (!line)
|
||||
break;
|
||||
lineno++;
|
||||
|
||||
/* cleanup whitespace, skip comment lines */
|
||||
char* trimmed = String_trim(line);
|
||||
free(line);
|
||||
if (trimmed[0] == '#' || trimmed[0] == '\0') {
|
||||
free(trimmed);
|
||||
continue;
|
||||
}
|
||||
|
||||
size_t n;
|
||||
char** config = String_split(trimmed, '=', &n);
|
||||
free(trimmed);
|
||||
if (config == NULL)
|
||||
continue;
|
||||
|
||||
char* key = String_trim(config[0]);
|
||||
char* value = n > 1 ? String_trim(config[1]) : NULL;
|
||||
if (key[0] == '[') { /* new section heading - i.e. new meter */
|
||||
PCPDynamicMeter_validateMeterName(key+1, path, lineno);
|
||||
meter = PCPDynamicMeter_new(meters, key+1);
|
||||
} else if (value && String_eq(key, "caption")) {
|
||||
free_and_xStrdup(&meter->super.caption, value);
|
||||
} else if (value && String_eq(key, "description")) {
|
||||
free_and_xStrdup(&meter->super.description, value);
|
||||
} else if (value && String_eq(key, "type")) {
|
||||
if (String_eq(config[1], "bar"))
|
||||
meter->super.type = BAR_METERMODE;
|
||||
else if (String_eq(config[1], "text"))
|
||||
meter->super.type = TEXT_METERMODE;
|
||||
else if (String_eq(config[1], "graph"))
|
||||
meter->super.type = GRAPH_METERMODE;
|
||||
else if (String_eq(config[1], "led"))
|
||||
meter->super.type = LED_METERMODE;
|
||||
} else if (value && String_eq(key, "maximum")) {
|
||||
meter->super.maximum = strtod(value, NULL);
|
||||
} else if (value) {
|
||||
PCPDynamicMeter_parseMetric(meters, meter, path, lineno, key, value);
|
||||
}
|
||||
String_freeArray(config);
|
||||
free(value);
|
||||
free(key);
|
||||
}
|
||||
fclose(file);
|
||||
}
|
||||
|
||||
static void PCPDynamicMeter_scanDir(PCPDynamicMeters* meters, char* path) {
|
||||
DIR* dir = opendir(path);
|
||||
if (!dir)
|
||||
return;
|
||||
|
||||
struct dirent *dirent;
|
||||
while ((dirent = readdir(dir)) != NULL) {
|
||||
if (dirent->d_name[0] == '.')
|
||||
continue;
|
||||
|
||||
char *file = String_cat(path, dirent->d_name);
|
||||
PCPDynamicMeter_parseFile(meters, file);
|
||||
free(file);
|
||||
}
|
||||
closedir(dir);
|
||||
}
|
||||
|
||||
void PCPDynamicMeters_init(PCPDynamicMeters* meters) {
|
||||
const char* sysconf = pmGetConfig("PCP_SYSCONF_DIR");
|
||||
const char* xdgConfigHome = getenv("XDG_CONFIG_HOME");
|
||||
const char* home = getenv("HOME");
|
||||
char* path;
|
||||
|
||||
meters->table = Hashtable_new(0, true);
|
||||
|
||||
/* search in the users home directory first of all */
|
||||
if (xdgConfigHome) {
|
||||
path = String_cat(xdgConfigHome, "/htop/meters/");
|
||||
} else {
|
||||
if (!home)
|
||||
home = "";
|
||||
path = String_cat(home, "/.config/htop/meters/");
|
||||
}
|
||||
PCPDynamicMeter_scanDir(meters, path);
|
||||
free(path);
|
||||
|
||||
/* secondly search in the system meters directory */
|
||||
path = String_cat(sysconf, "/htop/meters/");
|
||||
PCPDynamicMeter_scanDir(meters, path);
|
||||
free(path);
|
||||
|
||||
/* check the working directory, as a final option */
|
||||
char cwd[PATH_MAX];
|
||||
if (getcwd(cwd, sizeof(cwd)) != NULL) {
|
||||
path = String_cat(cwd, "/pcp/meters/");
|
||||
PCPDynamicMeter_scanDir(meters, path);
|
||||
free(path);
|
||||
}
|
||||
}
|
||||
|
||||
void PCPDynamicMeter_enable(PCPDynamicMeter* this) {
|
||||
for (unsigned int i = 0; i < this->totalMetrics; i++)
|
||||
Metric_enable(this->metrics[i].id, true);
|
||||
}
|
||||
|
||||
void PCPDynamicMeter_updateValues(PCPDynamicMeter* this, Meter* meter) {
|
||||
char* buffer = meter->txtBuffer;
|
||||
size_t size = sizeof(meter->txtBuffer);
|
||||
size_t bytes = 0;
|
||||
|
||||
for (unsigned int i = 0; i < this->totalMetrics; i++) {
|
||||
if (i > 0 && bytes < size - 1)
|
||||
buffer[bytes++] = '/'; /* separator */
|
||||
|
||||
PCPDynamicMetric* metric = &this->metrics[i];
|
||||
const pmDesc* desc = Metric_desc(metric->id);
|
||||
pmAtomValue atom;
|
||||
|
||||
if (!Metric_values(metric->id, &atom, 1, desc->type)) {
|
||||
bytes--; /* clear the separator */
|
||||
continue;
|
||||
}
|
||||
/* TODO: pretty-print the values - pmConvScale, etc */
|
||||
switch (desc->type) {
|
||||
case PM_TYPE_STRING:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%s", atom.cp);
|
||||
free(atom.cp);
|
||||
break;
|
||||
case PM_TYPE_32:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%d", atom.l);
|
||||
break;
|
||||
case PM_TYPE_U32:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%u", atom.ul);
|
||||
break;
|
||||
case PM_TYPE_64:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%lld", (long long) atom.ll);
|
||||
break;
|
||||
case PM_TYPE_U64:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%llu", (unsigned long long) atom.ull);
|
||||
break;
|
||||
case PM_TYPE_FLOAT:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%f", (double) atom.f);
|
||||
break;
|
||||
case PM_TYPE_DOUBLE:
|
||||
bytes += xSnprintf(buffer + bytes, size - bytes, "%f", atom.d);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
if (!bytes)
|
||||
xSnprintf(buffer, size, "no data");
|
||||
}
|
||||
|
||||
void PCPDynamicMeter_display(PCPDynamicMeter* this, ATTR_UNUSED const Meter* meter, RichString* out) {
|
||||
int nodata = 1;
|
||||
|
||||
for (unsigned int i = 0; i < this->totalMetrics; i++) {
|
||||
PCPDynamicMetric* metric = &this->metrics[i];
|
||||
const pmDesc* desc = Metric_desc(metric->id);
|
||||
pmAtomValue atom;
|
||||
char buffer[64];
|
||||
int len;
|
||||
|
||||
if (!Metric_values(metric->id, &atom, 1, desc->type))
|
||||
continue;
|
||||
nodata = 0;
|
||||
|
||||
if (i > 0)
|
||||
RichString_appendnAscii(out, CRT_colors[metric->color], " ", 1);
|
||||
|
||||
if (metric->label) {
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%s ", metric->label);
|
||||
RichString_appendnAscii(out, CRT_colors[metric->color], buffer, len);
|
||||
}
|
||||
|
||||
/* TODO: pretty-print the values - pmConvScale, etc */
|
||||
len = 0;
|
||||
switch (desc->type) {
|
||||
case PM_TYPE_STRING:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%s", atom.cp);
|
||||
free(atom.cp);
|
||||
break;
|
||||
case PM_TYPE_32:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%d", atom.l);
|
||||
break;
|
||||
case PM_TYPE_U32:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%u", atom.ul);
|
||||
break;
|
||||
case PM_TYPE_64:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%lld", (long long) atom.ll);
|
||||
break;
|
||||
case PM_TYPE_U64:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%llu", (unsigned long long) atom.ull);
|
||||
break;
|
||||
case PM_TYPE_FLOAT:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%f", (double)atom.f);
|
||||
break;
|
||||
case PM_TYPE_DOUBLE:
|
||||
len = xSnprintf(buffer, sizeof(buffer), "%f", atom.d);
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
if (len)
|
||||
RichString_appendnAscii(out, CRT_colors[metric->color], buffer, len);
|
||||
}
|
||||
if (nodata)
|
||||
RichString_writeAscii(out, CRT_colors[METER_VALUE_ERROR], "no data");
|
||||
}
|
||||
Reference in New Issue
Block a user