summaryrefslogtreecommitdiffstats
path: root/src/modules/physicalmemory/physicalmemory.c
diff options
context:
space:
mode:
authorsumuel <samuel@yakubos.org>2026-08-17 20:44:55 +0000
committersumuel <samuel@yakubos.org>2026-08-17 20:44:55 +0000
commit76424950e373d3b04ac3dd13019151bfba3e8423 (patch)
tree4c3cfdbda039e592b9186be3e28f8d7cfd439e8a /src/modules/physicalmemory/physicalmemory.c
Add the files
Diffstat (limited to 'src/modules/physicalmemory/physicalmemory.c')
-rw-r--r--src/modules/physicalmemory/physicalmemory.c184
1 files changed, 184 insertions, 0 deletions
diff --git a/src/modules/physicalmemory/physicalmemory.c b/src/modules/physicalmemory/physicalmemory.c
new file mode 100644
index 0000000..d4bee7d
--- /dev/null
+++ b/src/modules/physicalmemory/physicalmemory.c
@@ -0,0 +1,184 @@
+#include "common/printing.h"
+#include "common/jsonconfig.h"
+#include "common/size.h"
+#include "detection/physicalmemory/physicalmemory.h"
+#include "modules/physicalmemory/physicalmemory.h"
+
+#define FF_PHYSICALMEMORY_DISPLAY_NAME "Physical Memory"
+
+bool ffPrintPhysicalMemory(FFPhysicalMemoryOptions* options) {
+ FF_LIST_AUTO_DESTROY result = ffListCreate();
+ const char* error = ffDetectPhysicalMemory(options, &result);
+
+ if (error) {
+ ffPrintError(FF_PHYSICALMEMORY_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "%s", error);
+ return false;
+ }
+
+ if (result.length == 0) {
+ ffPrintError(FF_PHYSICALMEMORY_DISPLAY_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "No physical memory devices detected");
+ return false;
+ }
+
+ FF_STRBUF_AUTO_DESTROY prettySize = ffStrbufCreate();
+
+ uint32_t i = 0;
+ FF_LIST_FOR_EACH (FFPhysicalMemoryResult, device, result) {
+ ffStrbufClear(&prettySize);
+ if (device->installed) {
+ ffSizeAppendNum(device->size, &prettySize);
+ }
+
+ if (options->moduleArgs.outputFormat.length == 0) {
+ ffPrintLogoAndKey(FF_PHYSICALMEMORY_DISPLAY_NAME, result.length == 1 ? 0 : (uint8_t) (i + 1), &options->moduleArgs, FF_PRINT_TYPE_DEFAULT);
+
+ if (device->installed) {
+ fputs(prettySize.chars, stdout);
+ fputs(" - ", stdout);
+ ffStrbufWriteTo(&device->type, stdout);
+ if (device->maxSpeed > 0) {
+ printf("-%u", device->maxSpeed);
+ }
+ if (device->runningSpeed > 0 && device->runningSpeed != device->maxSpeed) {
+ printf(" @ %u MT/s", device->runningSpeed);
+ }
+ if (device->vendor.length > 0) {
+ printf(" (%s)", device->vendor.chars);
+ }
+ if (device->ecc) {
+ fputs(" - ECC", stdout);
+ }
+ } else {
+ fputs("Empty", stdout);
+ if (device->formFactor.length > 0) {
+ printf(" - %s", device->formFactor.chars);
+ }
+ if (device->locator.length > 0) {
+ printf(" (%s)", device->locator.chars);
+ }
+ }
+ putchar('\n');
+ } else {
+ FF_PRINT_FORMAT_CHECKED(FF_PHYSICALMEMORY_DISPLAY_NAME, (uint8_t) (i + 1), &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, ((FFformatarg[]) {
+ FF_ARG(device->size, "bytes"),
+ FF_ARG(prettySize, "size"),
+ FF_ARG(device->maxSpeed, "max-speed"),
+ FF_ARG(device->runningSpeed, "running-speed"),
+ FF_ARG(device->type, "type"),
+ FF_ARG(device->formFactor, "form-factor"),
+ FF_ARG(device->locator, "locator"),
+ FF_ARG(device->vendor, "vendor"),
+ FF_ARG(device->serial, "serial"),
+ FF_ARG(device->partNumber, "part-number"),
+ FF_ARG(device->ecc, "is-ecc-enabled"),
+ FF_ARG(device->installed, "is-installed"),
+ }));
+ }
+
+ i++;
+ }
+
+ FF_LIST_FOR_EACH (FFPhysicalMemoryResult, device, result) {
+ ffStrbufDestroy(&device->type);
+ ffStrbufDestroy(&device->locator);
+ ffStrbufDestroy(&device->formFactor);
+ ffStrbufDestroy(&device->vendor);
+ ffStrbufDestroy(&device->serial);
+ ffStrbufDestroy(&device->partNumber);
+ }
+
+ return true;
+}
+
+void ffParsePhysicalMemoryJsonObject(FFPhysicalMemoryOptions* options, yyjson_val* module) {
+ yyjson_val *key, *val;
+ size_t idx, max;
+ yyjson_obj_foreach (module, idx, max, key, val) {
+ if (ffJsonConfigParseModuleArgs(key, val, &options->moduleArgs)) {
+ continue;
+ }
+
+ if (unsafe_yyjson_equals_str(key, "showEmptySlots")) {
+ options->showEmptySlots = yyjson_get_bool(val);
+ continue;
+ }
+
+ ffPrintError(FF_PHYSICALMEMORY_MODULE_NAME, 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "Unknown JSON key %s", unsafe_yyjson_get_str(key));
+ }
+}
+
+void ffGeneratePhysicalMemoryJsonConfig(FFPhysicalMemoryOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module) {
+ ffJsonConfigGenerateModuleArgsConfig(doc, module, &options->moduleArgs);
+ yyjson_mut_obj_add_bool(doc, module, "showEmptySlots", options->showEmptySlots);
+}
+
+bool ffGeneratePhysicalMemoryJsonResult(FFPhysicalMemoryOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module) {
+ FF_LIST_AUTO_DESTROY result = ffListCreate();
+ const char* error = ffDetectPhysicalMemory(options, &result);
+
+ if (error) {
+ yyjson_mut_obj_add_str(doc, module, "error", error);
+ return false;
+ }
+
+ yyjson_mut_val* arr = yyjson_mut_obj_add_arr(doc, module, "result");
+ FF_LIST_FOR_EACH (FFPhysicalMemoryResult, device, result) {
+ yyjson_mut_val* obj = yyjson_mut_arr_add_obj(doc, arr);
+ yyjson_mut_obj_add_uint(doc, obj, "size", device->size);
+ yyjson_mut_obj_add_bool(doc, obj, "installed", device->installed);
+ yyjson_mut_obj_add_uint(doc, obj, "maxSpeed", device->maxSpeed);
+ yyjson_mut_obj_add_uint(doc, obj, "runningSpeed", device->runningSpeed);
+ yyjson_mut_obj_add_strbuf(doc, obj, "type", &device->type);
+ yyjson_mut_obj_add_strbuf(doc, obj, "locator", &device->locator);
+ yyjson_mut_obj_add_strbuf(doc, obj, "formFactor", &device->formFactor);
+ yyjson_mut_obj_add_strbuf(doc, obj, "vendor", &device->vendor);
+ yyjson_mut_obj_add_strbuf(doc, obj, "serial", &device->serial);
+ yyjson_mut_obj_add_strbuf(doc, obj, "partNumber", &device->partNumber);
+ yyjson_mut_obj_add_bool(doc, obj, "ecc", device->ecc);
+ }
+
+ FF_LIST_FOR_EACH (FFPhysicalMemoryResult, device, result) {
+ ffStrbufDestroy(&device->type);
+ ffStrbufDestroy(&device->locator);
+ ffStrbufDestroy(&device->formFactor);
+ ffStrbufDestroy(&device->vendor);
+ ffStrbufDestroy(&device->serial);
+ ffStrbufDestroy(&device->partNumber);
+ }
+
+ return true;
+}
+
+void ffInitPhysicalMemoryOptions(FFPhysicalMemoryOptions* options) {
+ ffOptionInitModuleArg(&options->moduleArgs, "󰑭");
+ options->showEmptySlots = false;
+}
+
+void ffDestroyPhysicalMemoryOptions(FFPhysicalMemoryOptions* options) {
+ ffOptionDestroyModuleArg(&options->moduleArgs);
+}
+
+FFModuleBaseInfo ffPhysicalMemoryModuleInfo = {
+ .name = FF_PHYSICALMEMORY_MODULE_NAME,
+ .description = "Print system physical memory devices",
+ .initOptions = (void*) ffInitPhysicalMemoryOptions,
+ .destroyOptions = (void*) ffDestroyPhysicalMemoryOptions,
+ .parseJsonObject = (void*) ffParsePhysicalMemoryJsonObject,
+ .printModule = (void*) ffPrintPhysicalMemory,
+ .generateJsonConfig = (void*) ffGeneratePhysicalMemoryJsonConfig,
+ .generateJsonResult = (void*) ffGeneratePhysicalMemoryJsonResult,
+ .formatArgs = FF_FORMAT_ARG_LIST(((FFModuleFormatArg[]) {
+ { "Size (in bytes)", "bytes" },
+ { "Size formatted", "size" },
+ { "Max speed (in MT/s)", "max-speed" },
+ { "Running speed (in MT/s)", "running-speed" },
+ { "Type (DDR4, DDR5, etc.)", "type" },
+ { "Form factor (SODIMM, DIMM, etc.)", "form-factor" },
+ { "Bank/Device Locator (BANK0/SIMM0, BANK0/SIMM1, etc.)", "locator" },
+ { "Vendor", "vendor" },
+ { "Serial number", "serial" },
+ { "Part number", "part-number" },
+ { "True if ECC enabled", "is-ecc-enabled" },
+ { "True if a memory module is installed in the slot", "is-installed" },
+ }))
+};