htop/Header.c

286 lines
8.7 KiB
C
Raw Permalink Normal View History

2006-03-04 18:16:49 +00:00
/*
htop - Header.c
2011-05-26 16:35:07 +00:00
(C) 2004-2011 Hisham H. Muhammad
Released under the GNU GPLv2, see the COPYING file
2006-03-04 18:16:49 +00:00
in the source distribution for its full text.
*/
#include "Header.h"
2021-08-24 15:27:43 +00:00
#include <assert.h>
2020-12-25 15:42:35 +00:00
#include <math.h>
#include <stdbool.h>
2021-08-24 15:27:43 +00:00
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
2011-12-26 21:35:57 +00:00
#include "CRT.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 "CPUMeter.h"
#include "DynamicMeter.h"
#include "Macros.h"
#include "Object.h"
#include "Platform.h"
#include "ProvideCurses.h"
2020-10-14 18:21:09 +00:00
#include "XUtils.h"
2011-12-26 21:35:57 +00:00
2006-03-04 18:16:49 +00:00
2020-12-25 15:42:35 +00:00
Header* Header_new(ProcessList* pl, Settings* settings, HeaderLayout hLayout) {
2016-02-02 14:53:02 +00:00
Header* this = xCalloc(1, sizeof(Header));
2020-12-25 15:42:35 +00:00
this->columns = xMallocArray(HeaderLayout_getColumns(hLayout), sizeof(Vector*));
this->settings = settings;
this->pl = pl;
2020-12-25 15:42:35 +00:00
this->headerLayout = hLayout;
Header_forEachColumn(this, i) {
this->columns[i] = Vector_new(Class(Meter), true, DEFAULT_SIZE);
}
2020-12-25 15:42:35 +00:00
2006-03-04 18:16:49 +00:00
return this;
}
void Header_delete(Header* this) {
Header_forEachColumn(this, i) {
Vector_delete(this->columns[i]);
}
2020-12-25 15:42:35 +00:00
free(this->columns);
2006-03-04 18:16:49 +00:00
free(this);
}
2020-12-25 15:42:35 +00:00
void Header_setLayout(Header* this, HeaderLayout hLayout) {
size_t oldColumns = HeaderLayout_getColumns(this->headerLayout);
size_t newColumns = HeaderLayout_getColumns(hLayout);
2019-10-31 16:39:12 +00:00
2020-12-25 15:42:35 +00:00
this->headerLayout = hLayout;
2019-10-31 16:39:12 +00:00
2020-12-25 15:42:35 +00:00
if (newColumns == oldColumns)
return;
2019-10-31 16:39:12 +00:00
2020-12-25 15:42:35 +00:00
if (newColumns > oldColumns) {
this->columns = xReallocArray(this->columns, newColumns, sizeof(Vector*));
for (size_t i = oldColumns; i < newColumns; i++)
this->columns[i] = Vector_new(Class(Meter), true, DEFAULT_SIZE);
} else {
// move meters from to-be-deleted columns into last one
for (size_t i = newColumns; i < oldColumns; i++) {
for (int j = this->columns[i]->items - 1; j >= 0; j--) {
Vector_add(this->columns[newColumns - 1], Vector_take(this->columns[i], j));
}
2020-12-25 15:42:35 +00:00
Vector_delete(this->columns[i]);
}
2020-12-25 15:42:35 +00:00
this->columns = xReallocArray(this->columns, newColumns, sizeof(Vector*));
}
2020-12-25 15:42:35 +00:00
Header_calculateHeight(this);
}
2020-12-25 15:42:35 +00:00
static void Header_addMeterByName(Header* this, const char* name, MeterModeId mode, unsigned int column) {
assert(column < HeaderLayout_getColumns(this->headerLayout));
Vector* meters = this->columns[column];
2006-03-04 18:16:49 +00:00
2020-12-25 15:42:35 +00:00
const char* paren = strchr(name, '(');
unsigned int param = 0;
2020-12-25 15:42:35 +00:00
size_t nameLen;
if (paren) {
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
int ok = sscanf(paren, "(%10u)", &param); // CPUMeter
if (!ok) {
2020-12-25 15:42:35 +00:00
char* end, dynamic[32] = {0};
if (sscanf(paren, "(%30s)", dynamic)) { // DynamicMeter
if ((end = strrchr(dynamic, ')')) == NULL)
2021-08-23 12:50:46 +00:00
return; // htoprc parse failure
*end = '\0';
if (!DynamicMeter_search(this->pl->dynamicMeters, dynamic, &param))
2021-08-23 12:50:46 +00:00
return; // name lookup failure
2020-12-25 15:42:35 +00:00
} else {
param = 0;
}
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
}
2020-12-25 15:42:35 +00:00
nameLen = paren - name;
} else {
nameLen = strlen(name);
}
2020-12-25 15:42:35 +00:00
2020-10-05 11:19:50 +00:00
for (const MeterClass* const* type = Platform_meterTypes; *type; type++) {
2020-12-25 15:42:35 +00:00
if (0 == strncmp(name, (*type)->name, nameLen) && (*type)->name[nameLen] == '\0') {
Meter* meter = Meter_new(this->pl, param, *type);
2020-12-25 15:42:35 +00:00
if (mode != 0) {
Meter_setMode(meter, mode);
}
Vector_add(meters, meter);
break;
}
2006-03-04 18:16:49 +00:00
}
2020-12-25 15:42:35 +00:00
}
void Header_populateFromSettings(Header* this) {
Header_setLayout(this, this->settings->hLayout);
2020-11-01 00:09:51 +00:00
2020-12-25 15:42:35 +00:00
Header_forEachColumn(this, col) {
const MeterColumnSetting* colSettings = &this->settings->hColumns[col];
Vector_prune(this->columns[col]);
for (size_t i = 0; i < colSettings->len; i++) {
Header_addMeterByName(this, colSettings->names[i], colSettings->modes[i], col);
}
}
2020-11-01 00:09:51 +00:00
2020-12-25 15:42:35 +00:00
Header_calculateHeight(this);
2006-03-04 18:16:49 +00:00
}
2020-12-25 15:42:35 +00:00
void Header_writeBackToSettings(const Header* this) {
Settings_setHeaderLayout(this->settings, this->headerLayout);
2006-03-04 18:16:49 +00:00
2020-12-25 15:42:35 +00:00
Header_forEachColumn(this, col) {
MeterColumnSetting* colSettings = &this->settings->hColumns[col];
if (colSettings->names) {
for (size_t j = 0; j < colSettings->len; j++)
free(colSettings->names[j]);
free(colSettings->names);
}
free(colSettings->modes);
2020-11-01 00:09:51 +00:00
2020-12-25 15:42:35 +00:00
const Vector* vec = this->columns[col];
int len = Vector_size(vec);
colSettings->names = len ? xCalloc(len, sizeof(char*)) : NULL;
colSettings->modes = len ? xCalloc(len, sizeof(int)) : NULL;
colSettings->len = len;
for (int i = 0; i < len; i++) {
const Meter* meter = (Meter*) Vector_get(vec, i);
char* name;
if (meter->param && As_Meter(meter) == &DynamicMeter_class) {
const char* dynamic = DynamicMeter_lookup(this->pl->dynamicMeters, meter->param);
xAsprintf(&name, "%s(%s)", As_Meter(meter)->name, dynamic);
} else if (meter->param && As_Meter(meter) == &CPUMeter_class) {
xAsprintf(&name, "%s(%u)", As_Meter(meter)->name, meter->param);
} else {
xAsprintf(&name, "%s", As_Meter(meter)->name);
}
colSettings->names[i] = name;
colSettings->modes[i] = meter->mode;
}
}
2006-03-04 18:16:49 +00:00
}
2020-12-25 15:42:35 +00:00
Meter* Header_addMeterByClass(Header* this, const MeterClass* type, unsigned int param, unsigned int column) {
assert(column < HeaderLayout_getColumns(this->headerLayout));
Vector* meters = this->columns[column];
2006-03-04 18:16:49 +00:00
Meter* meter = Meter_new(this->pl, param, type);
Vector_add(meters, meter);
return meter;
2006-03-04 18:16:49 +00:00
}
void Header_reinit(Header* this) {
Header_forEachColumn(this, col) {
for (int i = 0; i < Vector_size(this->columns[col]); i++) {
Meter* meter = (Meter*) Vector_get(this->columns[col], i);
2020-11-01 00:09:51 +00:00
if (Meter_initFn(meter)) {
Meter_init(meter);
2020-11-01 00:09:51 +00:00
}
}
}
}
void Header_draw(const Header* this) {
const int height = this->height;
const int pad = this->pad;
2006-03-04 18:16:49 +00:00
attrset(CRT_colors[RESET_COLOR]);
for (int y = 0; y < height; y++) {
mvhline(y, 0, ' ', COLS);
}
2020-12-25 15:42:35 +00:00
const int width = COLS - pad;
int x = pad;
2020-12-25 15:42:35 +00:00
float roundingLoss = 0.0f;
2019-10-31 16:39:12 +00:00
Header_forEachColumn(this, col) {
Vector* meters = this->columns[col];
2020-12-25 15:42:35 +00:00
float colWidth = (float)width * HeaderLayout_layouts[this->headerLayout].widths[col] / 100.0f;
roundingLoss += colWidth - floorf(colWidth);
if (roundingLoss >= 1.0f) {
colWidth += 1.0f;
roundingLoss -= 1.0f;
}
for (int y = (pad / 2), i = 0; i < Vector_size(meters); i++) {
Meter* meter = (Meter*) Vector_get(meters, i);
2020-12-25 15:42:35 +00:00
float actualWidth = colWidth;
if (meter->mode == TEXT_METERMODE) {
for (int j = 1; j < meter->columnWidthCount; j++) {
actualWidth += (float)width * HeaderLayout_layouts[this->headerLayout].widths[col + j] / 100.0f;
}
}
assert(meter->draw);
2020-12-25 15:42:35 +00:00
meter->draw(meter, x, y, floorf(actualWidth));
y += meter->h;
}
2020-12-25 15:42:35 +00:00
x += floorf(colWidth);
2006-03-04 18:16:49 +00:00
}
}
void Header_updateData(Header* this) {
Header_forEachColumn(this, col) {
Vector* meters = this->columns[col];
int items = Vector_size(meters);
for (int i = 0; i < items; i++) {
Meter* meter = (Meter*) Vector_get(meters, i);
Meter_updateValues(meter);
}
}
}
/*
* Calculate how many columns the current meter is allowed to span,
* by counting how many columns to the right are empty or contain a BlankMeter.
* Returns the number of columns to span, i.e. if the direct neighbor is occupied 1.
*/
2020-12-25 15:42:35 +00:00
static int calcColumnWidthCount(const Header* this, const Meter* curMeter, const int pad, const unsigned int curColumn, const int curHeight) {
for (size_t i = curColumn + 1; i < HeaderLayout_getColumns(this->headerLayout); i++) {
const Vector* meters = this->columns[i];
int height = pad;
for (int j = 0; j < Vector_size(meters); j++) {
const Meter* meter = (const Meter*) Vector_get(meters, j);
if (height >= curHeight + curMeter->h)
break;
height += meter->h;
if (height <= curHeight)
continue;
if (!Object_isA((const Object*) meter, (const ObjectClass*) &BlankMeter_class))
return i - curColumn;
}
}
2020-12-25 15:42:35 +00:00
return HeaderLayout_getColumns(this->headerLayout) - curColumn;
}
2006-03-04 18:16:49 +00:00
int Header_calculateHeight(Header* this) {
const int pad = this->settings->headerMargin ? 2 : 0;
int maxHeight = pad;
Header_forEachColumn(this, col) {
const Vector* meters = this->columns[col];
int height = pad;
for (int i = 0; i < Vector_size(meters); i++) {
Meter* meter = (Meter*) Vector_get(meters, i);
meter->columnWidthCount = calcColumnWidthCount(this, meter, pad, col, height);
height += meter->h;
}
maxHeight = MAXIMUM(maxHeight, height);
2006-03-04 18:16:49 +00:00
}
this->height = maxHeight;
this->pad = pad;
return maxHeight;
2006-03-04 18:16:49 +00:00
}