/* ************************************************************************** * Copyright (C) 2021-2025 Advanced Micro Devices, Inc. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF * SUCH DAMAGE. * *************************************************************************/ #pragma once #include "common/misc/client_util.hpp" #include "common/misc/clientcommon.hpp" #include "common/misc/lapack_host_reference.hpp" #include "common/misc/norm.hpp" #include "common/misc/rocsolver.hpp" #include "common/misc/rocsolver_arguments.hpp" #include "common/misc/rocsolver_test.hpp" #include "common/misc/rocsolver_timer.hpp" template void sygsx_hegsx_checkBadArgs(const rocblas_handle handle, const rocblas_eform itype, const rocblas_fill uplo, const rocblas_int n, T dA, const rocblas_int lda, const rocblas_stride stA, T dB, const rocblas_int ldb, const rocblas_stride stB, const rocblas_int bc) { // handle EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, nullptr, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc), rocblas_status_invalid_handle); // values EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, rocblas_eform(0), uplo, n, dA, lda, stA, dB, ldb, stB, bc), rocblas_status_invalid_value); EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, rocblas_fill_full, n, dA, lda, stA, dB, ldb, stB, bc), rocblas_status_invalid_value); // sizes (only check batch_count if applicable) if(STRIDED) EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, -1), rocblas_status_invalid_size); // pointers EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T) nullptr, lda, stA, dB, ldb, stB, bc), rocblas_status_invalid_pointer); EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA, lda, stA, (T) nullptr, ldb, stB, bc), rocblas_status_invalid_pointer); // quick return with invalid pointers EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, 0, (T) nullptr, lda, stA, dB, ldb, stB, bc), rocblas_status_success); EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, 0, dA, lda, stA, (T) nullptr, ldb, stB, bc), rocblas_status_success); // quick return with zero batch_count if applicable if(STRIDED) EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, 0), rocblas_status_success); } template void testing_sygsx_hegsx_bad_arg() { // safe arguments rocblas_local_handle handle; rocblas_eform itype = rocblas_eform_ax; rocblas_fill uplo = rocblas_fill_upper; rocblas_int n = 1; rocblas_int lda = 1; rocblas_stride stA = 1; rocblas_int ldb = 1; rocblas_stride stB = 1; rocblas_int bc = 1; if(BATCHED) { // memory allocations device_batch_vector dA(1, 1, 1); device_batch_vector dB(1, 1, 1); CHECK_HIP_ERROR(dA.memcheck()); CHECK_HIP_ERROR(dB.memcheck()); // check bad arguments sygsx_hegsx_checkBadArgs(handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc); } else { // memory allocations device_strided_batch_vector dA(1, 1, 1, 1); device_strided_batch_vector dB(1, 1, 1, 1); CHECK_HIP_ERROR(dA.memcheck()); CHECK_HIP_ERROR(dB.memcheck()); // check bad arguments sygsx_hegsx_checkBadArgs(handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc); } } template void sygsx_hegsx_initData(const rocblas_handle handle, const rocblas_eform itype, const rocblas_fill uplo, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_stride stA, Td& dB, const rocblas_int ldb, const rocblas_stride stB, const rocblas_int bc, Th& hA, Th& hB, host_strided_batch_vector& M, const bool test) { if(CPU) { rocblas_int info; const rocblas_int ldu = n; host_strided_batch_vector U(n * n, 1, n * n, bc); rocblas_init(hA, true); rocblas_init(U, true); for(rocblas_int b = 0; b < bc; ++b) { // for testing purposes, we start with the reduced matrix M of the standard equivalent problem. // Then we construct the generalized pair (A, B) from there for(rocblas_int i = 0; i < n; i++) { // scale matrices and set hA = M (symmetric/hermitian), hB = U (upper triangular) or hB = U' for(rocblas_int j = i; j < n; j++) { if(i == j) { hA[b][i + j * lda] = std::real(hA[b][i + j * lda]) + 100; U[b][i + j * ldu] = std::real(U[b][i + j * ldu]) / 100 + 1; hB[b][i + j * ldb] = U[b][i + j * ldu]; } else { hA[b][i + j * lda] = (hA[b][i + j * lda] - 5) / 10; hA[b][j + i * lda] = sconj(hA[b][i + j * lda]); U[b][i + j * ldu] = (U[b][i + j * ldu] - 5) / 100; if(uplo == rocblas_fill_upper) { hB[b][i + j * ldb] = U[b][i + j * ldu]; hB[b][j + i * ldb] = 0; } else { hB[b][j + i * ldb] = sconj(U[b][i + j * ldu]); hB[b][i + j * ldb] = 0; } } } } // store M = hA for implicit testing if(test) { for(rocblas_int i = 0; i < n; i++) for(rocblas_int j = 0; j < n; j++) M[b][i + j * lda] = hA[b][i + j * lda]; } T one = T(1); if(itype == rocblas_eform_ax) { // form A = U' M U cpu_trmm(rocblas_side_left, rocblas_fill_upper, rocblas_operation_conjugate_transpose, rocblas_diagonal_non_unit, n, n, one, U[b], ldu, hA[b], lda); cpu_trmm(rocblas_side_right, rocblas_fill_upper, rocblas_operation_none, rocblas_diagonal_non_unit, n, n, one, U[b], ldu, hA[b], lda); } else { // form A = inv(U) M inv(U') cpu_trsm(rocblas_side_left, rocblas_fill_upper, rocblas_operation_none, rocblas_diagonal_non_unit, n, n, one, U[b], ldu, hA[b], lda); cpu_trsm(rocblas_side_right, rocblas_fill_upper, rocblas_operation_conjugate_transpose, rocblas_diagonal_non_unit, n, n, one, U[b], ldu, hA[b], lda); } } } if(GPU) { // now copy data to the GPU CHECK_HIP_ERROR(dA.transfer_from(hA)); CHECK_HIP_ERROR(dB.transfer_from(hB)); } } template void sygsx_hegsx_getError(const rocblas_handle handle, const rocblas_eform itype, const rocblas_fill uplo, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_stride stA, Td& dB, const rocblas_int ldb, const rocblas_stride stB, const rocblas_int bc, Th& hA, Th& hARes, Th& hB, double* max_err) { constexpr bool VERIFY_IMPLICIT_TEST = false; host_strided_batch_vector M(lda * n, 1, lda * n, bc); // input data initialization sygsx_hegsx_initData(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, M, true); // execute computations // use verify_implicit_test to check correctness of the implicit test using // CPU lapack if(!VERIFY_IMPLICIT_TEST) { // GPU lapack CHECK_ROCBLAS_ERROR(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc)); CHECK_HIP_ERROR(hARes.transfer_from(dA)); } else { // CPU lapack for(rocblas_int b = 0; b < bc; ++b) { memcpy(hARes[b], hA[b], lda * n * sizeof(T)); SYGST ? cpu_sygst_hegst(itype, uplo, n, hARes[b], lda, hB[b], ldb) : cpu_sygs2_hegs2(itype, uplo, n, hARes[b], lda, hB[b], ldb); } } // error is ||M - hARes|| / ||M|| // using frobenius norm double err; *max_err = 0; for(rocblas_int b = 0; b < bc; ++b) { if(uplo == rocblas_fill_upper) err = norm_error_upperTr('F', n, n, lda, M[b], hARes[b]); else err = norm_error_lowerTr('F', n, n, lda, M[b], hARes[b]); *max_err = err > *max_err ? err : *max_err; } } template void sygsx_hegsx_getPerfData(const rocblas_handle handle, const rocblas_eform itype, const rocblas_fill uplo, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_stride stA, Td& dB, const rocblas_int ldb, const rocblas_stride stB, const rocblas_int bc, Th& hA, Th& hB, double* gpu_time_used, double* cpu_time_used, const rocblas_int hot_calls, const int profile, const bool profile_kernels, const bool perf) { host_strided_batch_vector M(lda * n, 1, lda * n, bc); if(!perf) { sygsx_hegsx_initData(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, M, false); // cpu-lapack performance (only if not in perf mode) *cpu_time_used = get_time_us_no_sync(); for(rocblas_int b = 0; b < bc; ++b) { SYGST ? cpu_sygst_hegst(itype, uplo, n, hA[b], lda, hB[b], ldb) : cpu_sygs2_hegs2(itype, uplo, n, hA[b], lda, hB[b], ldb); } *cpu_time_used = get_time_us_no_sync() - *cpu_time_used; } sygsx_hegsx_initData(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, M, false); // cold calls for(int iter = 0; iter < 2; iter++) { sygsx_hegsx_initData(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, M, false); CHECK_ROCBLAS_ERROR(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc)); } // gpu-lapack performance hipStream_t stream; CHECK_ROCBLAS_ERROR(rocblas_get_stream(handle, &stream)); rocsolver_timer timer; if(profile > 0) { if(profile_kernels) rocsolver_log_set_layer_mode(rocblas_layer_mode_log_profile | rocblas_layer_mode_ex_log_kernel); else rocsolver_log_set_layer_mode(rocblas_layer_mode_log_profile); rocsolver_log_set_max_levels(profile); } for(rocblas_int iter = 0; iter < hot_calls; iter++) { sygsx_hegsx_initData(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, M, false); timer.start(stream); rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc); timer.end(stream); } *gpu_time_used = timer.get_combined(); } template void testing_sygsx_hegsx(Arguments& argus) { // get arguments rocblas_local_handle handle; char itypeC = argus.get("itype"); char uploC = argus.get("uplo"); rocblas_int n = argus.get("n"); rocblas_int lda = argus.get("lda", n); rocblas_int ldb = argus.get("ldb", n); rocblas_stride stA = argus.get("strideA", lda * n); rocblas_stride stB = argus.get("strideB", ldb * n); rocblas_eform itype = char2rocblas_eform(itypeC); rocblas_fill uplo = char2rocblas_fill(uploC); rocblas_int bc = argus.batch_count; rocblas_int hot_calls = argus.iters; rocblas_stride stARes = (argus.unit_check || argus.norm_check) ? stA : 0; rocblas_stride stBRes = (argus.unit_check || argus.norm_check) ? stB : 0; // check non-supported values if(uplo != rocblas_fill_upper && uplo != rocblas_fill_lower) { if(BATCHED) EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T* const*)nullptr, lda, stA, (T* const*)nullptr, ldb, stB, bc), rocblas_status_invalid_value); else EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T*)nullptr, lda, stA, (T*)nullptr, ldb, stB, bc), rocblas_status_invalid_value); if(argus.timing) rocsolver_bench_inform(inform_invalid_args); return; } // determine sizes size_t size_A = size_t(lda) * n; size_t size_B = size_t(ldb) * n; double max_error = 0, gpu_time_used = 0, cpu_time_used = 0; size_t size_ARes = (argus.unit_check || argus.norm_check) ? size_A : 0; // check invalid sizes bool invalid_size = (n < 0 || lda < n || ldb < n || bc < 0); if(invalid_size) { if(BATCHED) EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T* const*)nullptr, lda, stA, (T* const*)nullptr, ldb, stB, bc), rocblas_status_invalid_size); else EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T*)nullptr, lda, stA, (T*)nullptr, ldb, stB, bc), rocblas_status_invalid_size); if(argus.timing) rocsolver_bench_inform(inform_invalid_size); return; } // memory size query is necessary if(argus.mem_query) { CHECK_ROCBLAS_ERROR(rocblas_start_device_memory_size_query(handle)); if(BATCHED) CHECK_ALLOC_QUERY(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T* const*)nullptr, lda, stA, (T* const*)nullptr, ldb, stB, bc)); else CHECK_ALLOC_QUERY(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, (T*)nullptr, lda, stA, (T*)nullptr, ldb, stB, bc)); size_t size; CHECK_ROCBLAS_ERROR(rocblas_stop_device_memory_size_query(handle, &size)); rocsolver_bench_inform(inform_mem_query, size); return; } if(BATCHED) { // memory allocations host_batch_vector hA(size_A, 1, bc); host_batch_vector hARes(size_ARes, 1, bc); host_batch_vector hB(size_B, 1, bc); device_batch_vector dA(size_A, 1, bc); device_batch_vector dB(size_B, 1, bc); if(size_A) CHECK_HIP_ERROR(dA.memcheck()); if(size_B) CHECK_HIP_ERROR(dB.memcheck()); // check quick return if(n == 0 || bc == 0) { EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc), rocblas_status_success); if(argus.timing) rocsolver_bench_inform(inform_quick_return); return; } // check computations if(argus.unit_check || argus.norm_check) sygsx_hegsx_getError(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hARes, hB, &max_error); // collect performance data if(argus.timing && hot_calls > 0) sygsx_hegsx_getPerfData( handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, &gpu_time_used, &cpu_time_used, hot_calls, argus.profile, argus.profile_kernels, argus.perf); } else { // memory allocations host_strided_batch_vector hA(size_A, 1, stA, bc); host_strided_batch_vector hARes(size_ARes, 1, stARes, bc); host_strided_batch_vector hB(size_B, 1, stB, bc); device_strided_batch_vector dA(size_A, 1, stA, bc); device_strided_batch_vector dB(size_B, 1, stB, bc); if(size_A) CHECK_HIP_ERROR(dA.memcheck()); if(size_B) CHECK_HIP_ERROR(dB.memcheck()); // check quick return if(n == 0 || bc == 0) { EXPECT_ROCBLAS_STATUS(rocsolver_sygsx_hegsx(STRIDED, SYGST, handle, itype, uplo, n, dA.data(), lda, stA, dB.data(), ldb, stB, bc), rocblas_status_success); if(argus.timing) rocsolver_bench_inform(inform_quick_return); return; } // check computations if(argus.unit_check || argus.norm_check) sygsx_hegsx_getError(handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hARes, hB, &max_error); // collect performance data if(argus.timing && hot_calls > 0) sygsx_hegsx_getPerfData( handle, itype, uplo, n, dA, lda, stA, dB, ldb, stB, bc, hA, hB, &gpu_time_used, &cpu_time_used, hot_calls, argus.profile, argus.profile_kernels, argus.perf); } // validate results for rocsolver-test // using n * machine_precision as tolerance if(argus.unit_check) ROCSOLVER_TEST_CHECK(T, max_error, n); // output results for rocsolver-bench if(argus.timing) { if(!argus.perf) { rocsolver_bench_header("Arguments:"); if(BATCHED) { rocsolver_bench_output("itype", "uplo", "n", "lda", "ldb", "batch_c"); rocsolver_bench_output(itypeC, uploC, n, lda, ldb, bc); } else if(STRIDED) { rocsolver_bench_output("itype", "uplo", "n", "lda", "strideA", "ldb", "strideB", "batch_c"); rocsolver_bench_output(itypeC, uploC, n, lda, stA, ldb, stB, bc); } else { rocsolver_bench_output("itype", "uplo", "n", "lda", "ldb"); rocsolver_bench_output(itypeC, uploC, n, lda, ldb); } rocsolver_bench_header("Results:"); if(argus.norm_check) { rocsolver_bench_output("cpu_time_us", "gpu_time_us", "error"); rocsolver_bench_output(cpu_time_used, gpu_time_used, max_error); } else { rocsolver_bench_output("cpu_time_us", "gpu_time_us"); rocsolver_bench_output(cpu_time_used, gpu_time_used); } rocsolver_bench_endl(); } else { if(argus.norm_check) rocsolver_bench_output(gpu_time_used, max_error); else rocsolver_bench_output(gpu_time_used); } } // ensure all arguments were consumed argus.validate_consumed(); } #define EXTERN_TESTING_SYGSX_HEGSX(...) \ extern template void testing_sygsx_hegsx<__VA_ARGS__>(Arguments&); INSTANTIATE(EXTERN_TESTING_SYGSX_HEGSX, FOREACH_MATRIX_DATA_LAYOUT, FOREACH_BLOCKED_VARIANT, FOREACH_SCALAR_TYPE, APPLY_STAMP)