fastfetch/src/modules/diskio/diskio.c

#include "common/printing.h"
#include "common/jsonconfig.h"
#include "common/size.h"
#include "common/strutil.h"
#include "detection/diskio/diskio.h"
#include "modules/diskio/diskio.h"

static int sortDevices(const FFDiskIOResult* left, const FFDiskIOResult* right) {
    return ffStrbufComp(&left->name, &right->name);
}

static void formatKey(const FFDiskIOOptions* options, FFDiskIOResult* dev, uint32_t index, FFstrbuf* key) {
    if (options->moduleArgs.key.length == 0) {
        ffStrbufSetF(key, "%s (%s)", FF_MODULE_GET_DISPLAY_NAME(DiskIO), dev->name.length ? dev->name.chars : dev->devPath.chars);
    } else {
        ffStrbufClear(key);
        FF_PARSE_FORMAT_STRING_CHECKED(key, &options->moduleArgs.key, ((FFformatarg[]) {
                                                                          FF_ARG(index, "index"),
                                                                          FF_ARG(dev->name, "name"),
                                                                          FF_ARG(dev->devPath, "dev-path"),
                                                                          FF_ARG(options->moduleArgs.keyIcon, "icon"),
                                                                      }));
    }
}

bool ffPrintDiskIO(FFDiskIOOptions* options) {
    FF_LIST_AUTO_DESTROY result = ffListCreate();
    const char* error = ffDetectDiskIO(&result, options);

    if (error) {
        ffPrintError(FF_MODULE_GET_DISPLAY_NAME(DiskIO), 0, &options->moduleArgs, FF_PRINT_TYPE_NO_CUSTOM_KEY, "%s", error);
        return false;
    }

    ffListSort(&result, sizeof(FFDiskIOResult), (const void*) sortDevices);

    uint32_t index = 0;
    FF_STRBUF_AUTO_DESTROY key = ffStrbufCreate();
    FF_STRBUF_AUTO_DESTROY buffer = ffStrbufCreate();
    FF_STRBUF_AUTO_DESTROY buffer2 = ffStrbufCreate();

    FF_LIST_FOR_EACH (FFDiskIOResult, dev, result) {
        formatKey(options, dev, result.length == 1 ? 0 : index + 1, &key);
        ffStrbufClear(&buffer);

        if (options->moduleArgs.outputFormat.length == 0) {
            ffPrintLogoAndKey(key.chars, 0, &options->moduleArgs, FF_PRINT_TYPE_NO_CUSTOM_KEY);

            ffSizeAppendNum(dev->bytesRead, &buffer);
            if (!options->detectTotal) {
                ffStrbufAppendS(&buffer, "/s");
            }
            ffStrbufAppendS(&buffer, " (R) - ");

            ffSizeAppendNum(dev->bytesWritten, &buffer);
            if (!options->detectTotal) {
                ffStrbufAppendS(&buffer, "/s");
            }
            ffStrbufAppendS(&buffer, " (W)");
            ffStrbufPutTo(&buffer, stdout);
        } else {
            ffSizeAppendNum(dev->bytesRead, &buffer);
            if (!options->detectTotal) {
                ffStrbufAppendS(&buffer, "/s");
            }
            ffStrbufClear(&buffer2);
            ffSizeAppendNum(dev->bytesWritten, &buffer2);
            if (!options->detectTotal) {
                ffStrbufAppendS(&buffer2, "/s");
            }

            FF_PRINT_FORMAT_CHECKED(key.chars, 0, &options->moduleArgs, FF_PRINT_TYPE_NO_CUSTOM_KEY, ((FFformatarg[]) {
                                                                                                         FF_ARG(buffer, "size-read"),
                                                                                                         FF_ARG(buffer2, "size-written"),
                                                                                                         FF_ARG(dev->name, "name"),
                                                                                                         FF_ARG(dev->devPath, "dev-path"),
                                                                                                         FF_ARG(dev->bytesRead, "bytes-read"),
                                                                                                         FF_ARG(dev->bytesWritten, "bytes-written"),
                                                                                                         FF_ARG(dev->readCount, "read-count"),
                                                                                                         FF_ARG(dev->writeCount, "write-count"),
                                                                                                     }));
        }
        ++index;
    }

    FF_LIST_FOR_EACH (FFDiskIOResult, dev, result) {
        ffStrbufDestroy(&dev->name);
        ffStrbufDestroy(&dev->devPath);
    }

    return true;
}

void ffParseDiskIOJsonObject(FFDiskIOOptions* 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, "namePrefix")) {
            ffStrbufSetJsonVal(&options->namePrefix, val);
            continue;
        }

        if (unsafe_yyjson_equals_str(key, "detectTotal")) {
            options->detectTotal = yyjson_get_bool(val);
            continue;
        }

        if (unsafe_yyjson_equals_str(key, "waitTime")) {
            options->waitTime = (uint32_t) yyjson_get_uint(val);
            continue;
        }

        ffPrintError(FF_MODULE_GET_DISPLAY_NAME(DiskIO), 0, &options->moduleArgs, FF_PRINT_TYPE_DEFAULT, "Unknown JSON key %s", unsafe_yyjson_get_str(key));
    }
}

void ffGenerateDiskIOJsonConfig(FFDiskIOOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module) {
    ffJsonConfigGenerateModuleArgsConfig(doc, module, &options->moduleArgs);

    yyjson_mut_obj_add_strbuf(doc, module, "namePrefix", &options->namePrefix);

    yyjson_mut_obj_add_bool(doc, module, "detectTotal", options->detectTotal);

    yyjson_mut_obj_add_uint(doc, module, "waitTime", options->waitTime);
}

bool ffGenerateDiskIOJsonResult(FFDiskIOOptions* options, yyjson_mut_doc* doc, yyjson_mut_val* module) {
    FF_LIST_AUTO_DESTROY result = ffListCreate();
    const char* error = ffDetectDiskIO(&result, options);

    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 (FFDiskIOResult, dev, result) {
        yyjson_mut_val* obj = yyjson_mut_arr_add_obj(doc, arr);
        yyjson_mut_obj_add_strbuf(doc, obj, "name", &dev->name);
        yyjson_mut_obj_add_strbuf(doc, obj, "devPath", &dev->devPath);
        yyjson_mut_obj_add_uint(doc, obj, "bytesRead", dev->bytesRead);
        yyjson_mut_obj_add_uint(doc, obj, "bytesWritten", dev->bytesWritten);
        yyjson_mut_obj_add_uint(doc, obj, "readCount", dev->readCount);
        yyjson_mut_obj_add_uint(doc, obj, "writeCount", dev->writeCount);
    }

    FF_LIST_FOR_EACH (FFDiskIOResult, dev, result) {
        ffStrbufDestroy(&dev->name);
        ffStrbufDestroy(&dev->devPath);
    }

    return true;
}

void ffInitDiskIOOptions(FFDiskIOOptions* options) {
    ffOptionInitModuleArg(&options->moduleArgs, "󰓅");

    ffStrbufInit(&options->namePrefix);
    options->detectTotal = false;
    options->waitTime = 500;
}

void ffDestroyDiskIOOptions(FFDiskIOOptions* options) {
    ffOptionDestroyModuleArg(&options->moduleArgs);
    ffStrbufDestroy(&options->namePrefix);
}

FFModuleBaseInfo ffDiskIOModuleInfo = {
    .name = "DiskIO",
    .description = "Print physical disk I/O throughput",
    .displayName = {
        .en = "Disk I/O",
        .ar = "إدخال/إخراج القرص",
        .de = "Festplatten I/O",
        .es = "E/S del disco",
        .fr = "Entrée/Sortie disque",
        .gl = "E/S do disco",
        .he = "קלט/פלט דיסק",
        .it = "I/O del disco",
        .ja = "ディスク I/O",
        .ko = "디스크 I/O",
        .pl = "Dysk I/O",
        .pt = "Disco I/O",
        .ru = "Дисковый I/O",
        .zh_CN = "磁盘 I/O",
        .zh_TW = "磁碟 I/O",
    },
    .initOptions = (void*) ffInitDiskIOOptions,
    .destroyOptions = (void*) ffDestroyDiskIOOptions,
    .parseJsonObject = (void*) ffParseDiskIOJsonObject,
    .printModule = (void*) ffPrintDiskIO,
    .generateJsonResult = (void*) ffGenerateDiskIOJsonResult,
    .generateJsonConfig = (void*) ffGenerateDiskIOJsonConfig,
    .formatArgs = FF_FORMAT_ARG_LIST(((FFModuleFormatArg[]) {
        { "Size of data read [per second] (formatted)", "size-read" },
        { "Size of data written [per second] (formatted)", "size-written" },
        { "Device name", "name" },
        { "Device raw file path", "dev-path" },
        { "Size of data read [per second] (in bytes)", "bytes-read" },
        { "Size of data written [per second] (in bytes)", "bytes-written" },
        { "Number of reads", "read-count" },
        { "Number of writes", "write-count" },
    })),
    .defaultOrder = 67,
};