/* ************************************************************************ * Copyright (C) 2020-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. * * ************************************************************************ */ #pragma once #include "auto_testing_bad_arg.hpp" #include "rocsparse_matrix_statistics.hpp" #include "rocsparse_traits.hpp" #include "testing_spmv_dispatch_traits.hpp" template struct testing_spmv_dispatch { private: using traits = testing_spmv_dispatch_traits; template using host_sparse_matrix = typename traits::template host_sparse_matrix; template using device_sparse_matrix = typename traits::template device_sparse_matrix; public: static void testing_spmv_bad_arg(const Arguments& arg) { const T local_alpha = static_cast(6); const T local_beta = static_cast(2); rocsparse_local_handle local_handle; rocsparse_handle handle = local_handle; rocsparse_operation trans = rocsparse_operation_none; const void* alpha = (const void*)&local_alpha; const void* beta = (const void*)&local_beta; rocsparse_spmv_alg alg = rocsparse_spmv_alg_default; rocsparse_spmv_stage stage = rocsparse_spmv_stage_compute; size_t local_buffer_size; size_t* buffer_size = &local_buffer_size; void* temp_buffer = (void*)0x4; rocsparse_datatype compute_type = get_datatype(); #define PARAMS \ handle, trans, alpha, mat, x, beta, y, compute_type, alg, stage, buffer_size, temp_buffer // // AUTOMATIC BAD ARGS. // { device_dense_matrix dx; device_dense_matrix dy; device_sparse_matrix dA; rocsparse_local_spmat local_mat(dA); rocsparse_local_dnvec local_x(dx); rocsparse_local_dnvec local_y(dy); rocsparse_spmat_descr mat = local_mat; rocsparse_dnvec_descr x = local_x; rocsparse_dnvec_descr y = local_y; // // WITH 2 ARGUMENTS BEING SKIPPED DURING THE CHECK. // static const int nex = 2; static const int ex[2] = {10, 11}; select_bad_arg_analysis(rocsparse_spmv, nex, ex, PARAMS); buffer_size = nullptr; temp_buffer = nullptr; EXPECT_ROCSPARSE_STATUS(rocsparse_spmv(PARAMS), rocsparse_status_invalid_pointer); } #undef PARAMS } static void testing_spmv(const Arguments& arg) { J M = arg.M; J N = arg.N; rocsparse_operation trans = arg.transA; rocsparse_index_base base = arg.baseA; rocsparse_spmv_alg alg = arg.spmv_alg; rocsparse_matrix_type matrix_type = arg.matrix_type; rocsparse_fill_mode uplo = arg.uplo; rocsparse_storage_mode storage = arg.storage; rocsparse_datatype ttype = get_datatype(); const bool call_stage_analysis = arg.call_stage_analysis; // Create rocsparse handle rocsparse_local_handle handle(arg); host_scalar h_alpha(arg.get_alpha()); host_scalar h_beta(arg.get_beta()); device_scalar d_alpha(h_alpha); device_scalar d_beta(h_beta); #define PARAMS(alpha_, A_, x_, beta_, y_, stage) \ handle, trans, alpha_, A_, x_, beta_, y_, ttype, alg, stage, &buffer_size, dbuffer // // INITIALIZATE THE SPARSE MATRIX // host_sparse_matrix hA; { int dev; CHECK_HIP_ERROR(hipGetDevice(&dev)); hipDeviceProp_t prop; CHECK_HIP_ERROR(hipGetDeviceProperties(&prop, dev)); const bool has_datafile = rocsparse_arguments_has_datafile(arg); bool to_int = false; to_int |= (prop.warpSize == 32); to_int |= (alg != rocsparse_spmv_alg_csr_rowsplit); to_int |= (trans != rocsparse_operation_none && has_datafile); to_int |= (matrix_type == rocsparse_matrix_type_symmetric && has_datafile); static constexpr bool full_rank = false; rocsparse_matrix_factory matrix_factory( arg, arg.unit_check ? to_int : false, full_rank); traits::sparse_initialization(matrix_factory, hA, M, N, base); // For bf16/f16 precision, set all matrix values to 1.0 for numerical stability if constexpr(is_low_precision_v) { set_array_to_ones(hA.val.data(), hA.val.size()); } } if((matrix_type == rocsparse_matrix_type_symmetric && M != N) || (matrix_type == rocsparse_matrix_type_triangular && M != N)) { return; } device_sparse_matrix dA(hA); host_dense_matrix hx((trans == rocsparse_operation_none) ? N : M, 1); // For bf16/f16 precision, set all vector values to 1.0 for numerical stability if constexpr(is_low_precision_v) { set_array_to_ones(hx.data(), static_cast(hx.m * hx.n)); } else { rocsparse_matrix_utils::init_exact(hx); } device_dense_matrix dx(hx); host_dense_matrix hy((trans == rocsparse_operation_none) ? M : N, 1); // For bf16/f16 precision, set all vector values to 1.0 for numerical stability if constexpr(is_low_precision_v) { set_array_to_ones(hy.data(), static_cast(hy.m * hy.n)); } else { rocsparse_matrix_utils::init_exact(hy); } device_dense_matrix dy(hy); rocsparse_local_spmat matA(dA); rocsparse_local_dnvec x(dx); rocsparse_local_dnvec y(dy); EXPECT_ROCSPARSE_STATUS( rocsparse_spmat_set_attribute( matA, rocsparse_spmat_matrix_type, &matrix_type, sizeof(matrix_type)), rocsparse_status_success); EXPECT_ROCSPARSE_STATUS( rocsparse_spmat_set_attribute(matA, rocsparse_spmat_fill_mode, &uplo, sizeof(uplo)), rocsparse_status_success); EXPECT_ROCSPARSE_STATUS(rocsparse_spmat_set_attribute( matA, rocsparse_spmat_storage_mode, &storage, sizeof(storage)), rocsparse_status_success); CHECK_ROCSPARSE_ERROR(rocsparse_set_pointer_mode(handle, rocsparse_pointer_mode_host)); // Run buffer size void* dbuffer = nullptr; size_t buffer_size = 0; CHECK_ROCSPARSE_ERROR( rocsparse_spmv(PARAMS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_buffer_size))); CHECK_HIP_ERROR(rocsparse_hipMalloc(&dbuffer, buffer_size)); if(call_stage_analysis) { // Run preprocess CHECK_ROCSPARSE_ERROR(rocsparse_spmv( PARAMS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_preprocess))); } if(arg.unit_check) { // Run solve CHECK_ROCSPARSE_ERROR(testing::rocsparse_spmv( PARAMS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_compute))); host_dense_matrix hy_copy(hy); traits::host_calculation(trans, h_alpha, hA, hx, h_beta, hy, alg, matrix_type); hy.near_check(dy); if(ROCSPARSE_REPRODUCIBILITY) { rocsparse_reproducibility::save("Y_pointer_mode_host", dy); } dy.transfer_from(hy_copy); CHECK_ROCSPARSE_ERROR( rocsparse_set_pointer_mode(handle, rocsparse_pointer_mode_device)); CHECK_ROCSPARSE_ERROR(testing::rocsparse_spmv( PARAMS(d_alpha, matA, x, d_beta, y, rocsparse_spmv_stage_compute))); CHECK_ROCSPARSE_ERROR(rocsparse_set_pointer_mode(handle, rocsparse_pointer_mode_host)); hy.near_check(dy); if(ROCSPARSE_REPRODUCIBILITY) { rocsparse_reproducibility::save("Y_pointer_mode_device", dy); } } if(arg.timing) { const double gpu_time_used = rocsparse_clients::run_benchmark( arg, rocsparse_spmv, PARAMS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_compute)); const double gflop_count = traits::gflop_count(hA, *h_beta != static_cast(0)); const double gbyte_count = traits::byte_count(hA, *h_beta != static_cast(0)); const double gpu_gflops = get_gpu_gflops(gpu_time_used, gflop_count); const double gpu_gbyte = get_gpu_gbyte(gpu_time_used, gbyte_count); if(arg.sparsity_pattern_statistics) { int64_t min_nnz_row; int64_t median_nnz_row; int64_t max_nnz_row; rocsparse_matrix_statistics::get_nnz_per_row( dA, min_nnz_row, median_nnz_row, max_nnz_row); int64_t min_nnz_col; int64_t median_nnz_col; int64_t max_nnz_col; rocsparse_matrix_statistics::get_nnz_per_column( dA, min_nnz_col, median_nnz_col, max_nnz_col); traits::display_info(arg, display_key_t::trans_A, rocsparse_operation2string(trans), dA, display_key_t::min_nnz_per_row, min_nnz_row, display_key_t::max_nnz_per_row, max_nnz_row, display_key_t::median_nnz_per_row, median_nnz_row, display_key_t::min_nnz_per_col, min_nnz_col, display_key_t::max_nnz_per_col, max_nnz_col, display_key_t::median_nnz_per_col, median_nnz_col, display_key_t::alpha, *h_alpha, display_key_t::beta, *h_beta, display_key_t::algorithm, rocsparse_spmvalg2string(alg), display_key_t::gflops, gpu_gflops, display_key_t::bandwidth, gpu_gbyte, display_key_t::time_ms, get_gpu_time_msec(gpu_time_used)); } else { traits::display_info(arg, display_key_t::trans_A, rocsparse_operation2string(trans), dA, display_key_t::alpha, *h_alpha, display_key_t::beta, *h_beta, display_key_t::algorithm, rocsparse_spmvalg2string(alg), display_key_t::gflops, gpu_gflops, display_key_t::bandwidth, gpu_gbyte, display_key_t::time_ms, get_gpu_time_msec(gpu_time_used)); } } CHECK_HIP_ERROR(rocsparse_hipFree(dbuffer)); } static void testing_spmv_analysis(const Arguments& arg) { J M = arg.M; J N = arg.N; rocsparse_operation trans = arg.transA; rocsparse_index_base base = arg.baseA; rocsparse_spmv_alg alg = arg.spmv_alg; rocsparse_matrix_type matrix_type = arg.matrix_type; rocsparse_fill_mode uplo = arg.uplo; rocsparse_storage_mode storage = arg.storage; rocsparse_datatype ttype = get_datatype(); // Create rocsparse handle rocsparse_local_handle handle(arg); host_scalar h_alpha(arg.get_alpha()); host_scalar h_beta(arg.get_beta()); device_scalar d_alpha(h_alpha); device_scalar d_beta(h_beta); #define PARAMS_ANALYSIS(alpha_, A_, x_, beta_, y_, stage) \ handle, trans, alpha_, A_, x_, beta_, y_, ttype, alg, stage, &buffer_size, dbuffer // // INITIALIZATE THE SPARSE MATRIX // host_sparse_matrix hA; { int dev; CHECK_HIP_ERROR(hipGetDevice(&dev)); hipDeviceProp_t prop; CHECK_HIP_ERROR(hipGetDeviceProperties(&prop, dev)); const bool has_datafile = rocsparse_arguments_has_datafile(arg); bool to_int = false; to_int |= (prop.warpSize == 32); to_int |= (alg != rocsparse_spmv_alg_csr_stream); to_int |= (trans != rocsparse_operation_none && has_datafile); to_int |= (matrix_type == rocsparse_matrix_type_symmetric && has_datafile); static constexpr bool full_rank = false; rocsparse_matrix_factory matrix_factory( arg, arg.unit_check ? to_int : false, full_rank); traits::sparse_initialization(matrix_factory, hA, M, N, base); // For bf16/f16 precision, set all matrix values to 1.0 for numerical stability if constexpr(is_low_precision_v) { set_array_to_ones(hA.val.data(), hA.val.size()); } } if((matrix_type == rocsparse_matrix_type_symmetric && M != N) || (matrix_type == rocsparse_matrix_type_triangular && M != N)) { return; } device_sparse_matrix dA(hA); host_dense_matrix hx((trans == rocsparse_operation_none) ? N : M, 1); // For bf16/f16 precision, set all vector values to 1.0 for numerical stability if constexpr(is_low_precision_v) { set_array_to_ones(hx.data(), static_cast(hx.m * hx.n)); } else { rocsparse_matrix_utils::init_exact(hx); } device_dense_matrix dx(hx); host_dense_matrix hy((trans == rocsparse_operation_none) ? M : N, 1); // For bf16/f16 precision, set all vector values to 1.0 for numerical stability if constexpr(is_low_precision_v) { set_array_to_ones(hy.data(), static_cast(hy.m * hy.n)); } else { rocsparse_matrix_utils::init_exact(hy); } device_dense_matrix dy(hy); rocsparse_local_spmat matA(dA); rocsparse_local_dnvec x(dx); rocsparse_local_dnvec y(dy); EXPECT_ROCSPARSE_STATUS( rocsparse_spmat_set_attribute( matA, rocsparse_spmat_matrix_type, &matrix_type, sizeof(matrix_type)), rocsparse_status_success); EXPECT_ROCSPARSE_STATUS( rocsparse_spmat_set_attribute(matA, rocsparse_spmat_fill_mode, &uplo, sizeof(uplo)), rocsparse_status_success); EXPECT_ROCSPARSE_STATUS(rocsparse_spmat_set_attribute( matA, rocsparse_spmat_storage_mode, &storage, sizeof(storage)), rocsparse_status_success); CHECK_ROCSPARSE_ERROR(rocsparse_set_pointer_mode(handle, rocsparse_pointer_mode_host)); // Run buffer size void* dbuffer = nullptr; size_t buffer_size = 0; CHECK_ROCSPARSE_ERROR(rocsparse_spmv( PARAMS_ANALYSIS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_buffer_size))); CHECK_HIP_ERROR(rocsparse_hipMalloc(&dbuffer, buffer_size)); // Run preprocess CHECK_ROCSPARSE_ERROR(rocsparse_spmv( PARAMS_ANALYSIS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_preprocess))); if(arg.timing) { const int number_cold_calls = 2; const int number_hot_calls = arg.iters; // Warm up for(int iter = 0; iter < number_cold_calls; ++iter) { void* dbuffer_iter; size_t buffer_size; dbuffer_iter = nullptr; buffer_size = 0; CHECK_ROCSPARSE_ERROR(rocsparse_spmv(PARAMS_ANALYSIS( h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_buffer_size))); CHECK_HIP_ERROR(rocsparse_hipMalloc(&dbuffer_iter, buffer_size)); // Run preprocess CHECK_ROCSPARSE_ERROR(rocsparse_spmv( PARAMS_ANALYSIS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_preprocess))); CHECK_HIP_ERROR(rocsparse_hipFree(dbuffer_iter)); } double gpu_time_used = get_time_us(); void* dbuffer_iter; size_t buffer_size; // Performance run for(int iter = 0; iter < number_hot_calls; ++iter) { CHECK_ROCSPARSE_ERROR(rocsparse_csr_set_pointers(matA, dA.ptr, dA.ind, dA.val)); dbuffer_iter = nullptr; buffer_size = 0; CHECK_ROCSPARSE_ERROR(rocsparse_spmv(PARAMS_ANALYSIS( h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_buffer_size))); CHECK_HIP_ERROR(rocsparse_hipMalloc(&dbuffer_iter, buffer_size)); // Run preprocess CHECK_ROCSPARSE_ERROR(rocsparse_spmv( PARAMS_ANALYSIS(h_alpha, matA, x, h_beta, y, rocsparse_spmv_stage_preprocess))); CHECK_HIP_ERROR(rocsparse_hipFree(dbuffer_iter)); } gpu_time_used = (get_time_us() - gpu_time_used) / number_hot_calls; const double gpu_gflops = 0; const double gpu_gbyte = 0; traits::display_info(arg, display_key_t::trans_A, rocsparse_operation2string(trans), dA, display_key_t::alpha, *h_alpha, display_key_t::beta, *h_beta, display_key_t::algorithm, rocsparse_spmvalg2string(alg), display_key_t::gflops, gpu_gflops, display_key_t::bandwidth, gpu_gbyte, display_key_t::time_ms, get_gpu_time_msec(gpu_time_used)); } CHECK_HIP_ERROR(rocsparse_hipFree(dbuffer)); } };