TheRock/rocm-libraries/projects/rocsparse/clients/common/rocsparse_parse_data.cpp

/*! \file */
/* ************************************************************************
 * Copyright (C) 2019-2026 Advanced Micro Devices, Inc. All rights Reserved.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 * ************************************************************************ */

#include "rocsparse_parse_data.hpp"
#include "rocsparse-debugging.h"
#include "rocsparse_clients_matrices_dir.hpp"
#include "rocsparse_data.hpp"
#include "rocsparse_reproducibility.hpp"
#include "utility.hpp"

#include <fcntl.h>
#include <sys/types.h>

#ifdef WIN32

#include <filesystem>
namespace fs = std::filesystem;

#else
#include <sys/wait.h>
#include <unistd.h>
#endif

#include "rocsparse_clients_envariables.hpp"

// Parse YAML data
static std::string rocsparse_parse_yaml(const std::string& yaml, const char* include_path)
{
#ifdef WIN32
    // Generate "/tmp/rocsparse-XXXXXX" like file name
    const std::string alphanum     = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuv";
    int               stringlength = alphanum.length() - 1;
    std::string       uniquestr    = "rocsparse-";

    for(int n = 0; n <= 5; ++n)
    {
        uniquestr += alphanum.at(rand() % stringlength);
    }

    fs::path tmpname = fs::temp_directory_path() / uniquestr;

    auto gentestpath = rocsparse_gentestpath();
    auto datapath    = rocsparse_datapath();

    const char* matrices_path = rocsparse_clients_matrices_dir_get(false);
    auto        cmd           = "python " + gentestpath + "rocsparse_gentest.py ";

    if(include_path != nullptr)
    {
        cmd += " -I ";
        cmd += include_path;
    }
    else
    {
        cmd += " -I ./ ";
    }

    if(matrices_path && matrices_path[0] != '\0')
    {
        cmd += " -m ";
        cmd += matrices_path;
    }
    cmd += " --template " + datapath + "rocsparse_template.yaml -o " + tmpname.string() + " "
           + yaml;

    std::cerr << cmd << std::endl;

    int status = std::system(cmd.c_str());
    if(status != 0)
    {
        perror("system cmd failed");
        exit(EXIT_FAILURE);
    }

    return tmpname.string(); // results to be read and removed later
#else

    char tmp[] = "/tmp/rocsparse-XXXXXX";
    int  fd    = mkostemp(tmp, O_CLOEXEC);
    if(fd == -1)
    {
        perror("Cannot open temporary file");
        exit(EXIT_FAILURE);
    }

    auto gentestpath = rocsparse_gentestpath();
    auto datapath    = rocsparse_datapath();

    const char* matrices_path = rocsparse_clients_matrices_dir_get(false);
    auto        cmd           = gentestpath + "rocsparse_gentest.py ";
    if(include_path != nullptr)
    {
        cmd += " -I ";
        cmd += include_path;
    }
    else
    {
        cmd += " -I ./ ";
    }

    if(matrices_path && matrices_path[0] != '\0')
    {
        cmd += " -m ";
        cmd += matrices_path;
    }

    cmd += " --template " + datapath + "rocsparse_template.yaml -o " + tmp + " " + yaml;

    std::cerr << cmd << std::endl;

    int status = system(cmd.c_str());
    if(status == -1 || !WIFEXITED(status) || WEXITSTATUS(status))
        exit(EXIT_FAILURE);
    return tmp;

#endif
}

// Parse --data and --yaml command-line arguments, -- matrices-dir and optionally memstat-report

bool rocsparse_parse_data(int& argc, char** argv, const std::string& default_file)
{
    std::string filename;
    char**      argv_p = argv + 1;
    bool        help = false, yaml = false;
#ifdef ROCSPARSE_WITH_MEMSTAT
    const char* memory_report_filename = nullptr;
#endif

    // Scan, process and remove any --yaml or --data options
    std::string command = argv[0];
    for(int i = 1; i < argc; ++i)
    {
        command += std::string(" ") + argv[i];
    }
    const char* include_path = nullptr;
    rocsparse_reproducibility_t::instance().config().set_command(command);

    //
    // Disable debug argument verbose
    //
    {
        static constexpr const char* option_force_debug_arguments_verbose
            = "--force-debug-arguments-verbose";
        bool enable_debug_arguments_verbose = false;
        for(int iarg = 0; iarg < argc; ++iarg)
        {
            if(!strcmp(argv[iarg], option_force_debug_arguments_verbose))
            {
                enable_debug_arguments_verbose = true;
                (void)memcpy(argv + iarg, argv + iarg + 1, (argc - iarg) * sizeof(char*));
                argv[--argc] = nullptr;
                break;
            }
        }

        if(enable_debug_arguments_verbose == false)
        {
            rocsparse_disable_debug_arguments_verbose();
            std::cout << "rocsparse-test: debug arguments verbose is disabled for testings (use "
                      << option_force_debug_arguments_verbose << " to skip the disabling)"
                      << std::endl;
        }
    }

    //
    // Disable debug warnings
    //
    {
        static constexpr const char* option_force_warning  = "--force-warnings";
        bool                         enable_debug_warnings = false;
        for(int iarg = 0; iarg < argc; ++iarg)
        {
            if(!strcmp(argv[iarg], option_force_warning))
            {
                enable_debug_warnings = true;
                (void)memcpy(argv + iarg, argv + iarg + 1, (argc - iarg) * sizeof(char*));
                argv[--argc] = nullptr;
                break;
            }
        }

        if(enable_debug_warnings == false)
        {
            rocsparse_disable_debug_warnings();
            std::cout << "rocsparse-test: warnings are disabled for testings (use "
                      << option_force_warning << " to skip the disabling)" << std::endl;
        }
    }

    for(int i = 1; argv[i]; ++i)
    {

        if(!strcmp(argv[i], "-I"))
        {
            include_path = argv[++i];
        }
        else if(!strcmp(argv[i], "--data") || !strcmp(argv[i], "--yaml"))
        {
            yaml = true;

            if(filename != "")
            {
                std::cerr << "Only one of the --yaml and --data options may be specified"
                          << std::endl;
                exit(EXIT_FAILURE);
            }

            if(!argv[i + 1] || !argv[i + 1][0])
            {
                std::cerr << "The " << argv[i] << " option requires an argument" << std::endl;
                exit(EXIT_FAILURE);
            }
            filename = argv[++i];
        }
#ifdef ROCSPARSE_WITH_MEMSTAT
        else if(!strcmp(argv[i], "--memstat-report"))
        {
            if(!argv[i + 1] || !argv[i + 1][0])
            {
                std::cerr << "The " << argv[i] << " option requires an argument" << std::endl;
                exit(EXIT_FAILURE);
            }
            memory_report_filename = argv[++i];
        }
#endif
        else if(!strcmp(argv[i], "--matrices-dir"))
        {
            if(!argv[i + 1] || !argv[i + 1][0])
            {
                std::cerr << "The " << argv[i] << " option requires an argument" << std::endl;
                exit(EXIT_FAILURE);
            }
            rocsparse_clients_matrices_dir_set(argv[++i]);
        }
        else if(!strcmp(argv[i], "--r-o"))
        {
            if(!argv[i + 1] || !argv[i + 1][0])
            {
                std::cerr << "The " << argv[i] << " option requires an argument" << std::endl;
                exit(EXIT_FAILURE);
            }
            rocsparse_reproducibility_t::instance().config().set_filename(argv[++i]);
        }
        else if(!strcmp(argv[i], "--r"))
        {
            rocsparse_reproducibility_t::instance().enable();
        }
        else if(!strcmp(argv[i], "--r-niter"))
        {
            if(rocsparse_reproducibility_t::instance().is_enabled() == false)
            {
                std::cerr
                    << "--r-niter cannot be used if the reproducibility is not enabled with '--r'"
                    << std::endl;
                exit(EXIT_FAILURE);
            }
            if(!argv[i + 1] || !argv[i + 1][0])
            {
                std::cerr << "The " << argv[i] << " option requires an argument" << std::endl;
                exit(EXIT_FAILURE);
            }
            for(int j = 0; argv[i + 1][j] != '\0'; ++j)
            {
                if(argv[i + 1][j] < '0' || argv[i + 1][j] > '9')
                {
                    std::cerr << "The " << argv[i] << " option requires an integer as an argument"
                              << std::endl;
                    exit(EXIT_FAILURE);
                }
            }
            int32_t num_iterations = atoi(argv[++i]);
            if(num_iterations < 2)
            {
                std::cerr << "The " << argv[i - 1]
                          << " option requires a positive value greater or equal to 2."
                          << std::endl;
                exit(EXIT_FAILURE);
            }
            rocsparse_reproducibility_t::instance().set_num_iterations(num_iterations);
        }
        else if(!strcmp(argv[i], "--r-level"))
        {
            if(rocsparse_reproducibility_t::instance().is_enabled() == false)
            {
                std::cerr
                    << "--r-level cannot be used if the reproducibility is not enabled with '--r'"
                    << std::endl;
                exit(EXIT_FAILURE);
            }
            if(!argv[i + 1] || !argv[i + 1][0])
            {
                std::cerr << "The " << argv[i] << " option requires an argument" << std::endl;
                exit(EXIT_FAILURE);
            }
            int32_t r_level = atoi(argv[++i]);
            if(r_level < 0)
            {
                std::cerr << "The " << argv[i - 1] << " option requires a positive value"
                          << std::endl;
                exit(EXIT_FAILURE);
            }
            rocsparse_reproducibility_t::instance().config().set_info_level(r_level);
        }
        else
        {
            *argv_p++ = argv[i];
            if(!help && (!strcmp(argv[i], "-h") || !strcmp(argv[i], "--help")))
            {
                help = true;
                std::cout << "\n"
                          << argv[0]
                          << " [ --data <path> | --yaml <path> ] [--matrices-dir <path>] [-I "
                             "<path>] <options> ...\n"
                          << std::endl;
#ifdef ROCSPARSE_DEBUG

                std::cout << "" << std::endl;
                std::cout << "Rocsparse HIP debug testing options:" << std::endl;
                std::cout << "--test-hip-debug      enable rocsparse HIP debug testing."
                          << std::endl;
                std::cout
                    << "--test-hip-debug-full enable rocsparse hip debug testing, as opposed to "
                       "'--test-hip-debug' all checks regarding results must be consistent"
                    << std::endl;
                std::cout << "--test-hip-debug-o    output filename for HIP debug report."
                          << std::endl;

#endif

                std::cout << "Rocsparse reproducibility options:" << std::endl;
                std::cout << "--r          enable rocsparse reproducibility testing" << std::endl;
                std::cout << "--r-niter    set the number of "
                             "reproducibility iterations."
                          << std::endl;
                std::cout << "--r-o        file results for reproducibility." << std::endl;
                std::cout << "--r-level    level of information shrinking in the reproducibility "
                             "json file."
                          << std::endl;
                std::cout << "" << std::endl;
                std::cout << "Skipped test output options:" << std::endl;
                std::cout << "--show-skipped    Force showing skipped test output (overrides "
                             "default --yaml behavior)"
                          << std::endl;
                std::cout << "--hide-skipped    Force hiding skipped test output" << std::endl;
                std::cout << "" << std::endl;
                std::cout << "" << std::endl;
                std::cout << "Specific environment variables:" << std::endl;
                for(const auto v : rocsparse_clients_envariables::s_var_bool_all)
                {
                    std::cout << rocsparse_clients_envariables::get_name(v) << " "
                              << rocsparse_clients_envariables::get_description(v) << std::endl;
                }
                for(const auto v : rocsparse_clients_envariables::s_var_string_all)
                {
                    std::cout << rocsparse_clients_envariables::get_name(v) << " "
                              << rocsparse_clients_envariables::get_description(v) << std::endl;
                }
                std::cout << "" << std::endl;
            }
        }
    }

#ifdef ROCSPARSE_WITH_MEMSTAT
    rocsparse_status status = rocsparse_memstat_report(
        memory_report_filename ? memory_report_filename : "rocsparse_test_memstat.json");
    if(status != rocsparse_status_success)
    {
        std::cerr << "rocsparse_memstat_report failed " << std::endl;
        exit(EXIT_FAILURE);
    }
#endif

    // argc and argv contain remaining options and non-option arguments
    *argv_p = nullptr;
    argc    = argv_p - argv;

    if(filename == "-")
        filename = "/dev/stdin";
    else if(filename == "")
        filename = default_file;

    if(yaml)
        filename = rocsparse_parse_yaml(filename, include_path);

    if(filename != "")
    {
        RocSPARSE_TestData::set_filename(filename, yaml);
        RocSPARSE_TestData::set_yaml_filter_active(yaml);
        return true;
    }

    return false;
}