/* ************************************************************************** * Copyright (C) 2020-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 sytxx_hetxx_checkBadArgs(const rocblas_handle handle, const rocblas_fill uplo, const rocblas_int n, T dA, const rocblas_int lda, const rocblas_stride stA, S dD, const rocblas_stride stD, S dE, const rocblas_stride stE, U dTau, const rocblas_stride stP, const rocblas_int bc) { // handle EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, nullptr, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, bc), rocblas_status_invalid_handle); // values EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, rocblas_fill_full, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, bc), rocblas_status_invalid_value); // sizes (only check batch_count if applicable) if(STRIDED) EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, -1), rocblas_status_invalid_size); // pointers EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T) nullptr, lda, stA, dD, stD, dE, stE, dTau, stP, bc), rocblas_status_invalid_pointer); EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA, lda, stA, (S) nullptr, stD, dE, stE, dTau, stP, bc), rocblas_status_invalid_pointer); EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA, lda, stA, dD, stD, (S) nullptr, stE, dTau, stP, bc), rocblas_status_invalid_pointer); EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, (U) nullptr, stP, bc), rocblas_status_invalid_pointer); // quick return with invalid pointers EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, 0, (T) nullptr, lda, stA, (S) nullptr, stD, (S) nullptr, stE, (U) nullptr, stP, bc), rocblas_status_success); // quick return with zero batch_count if applicable if(STRIDED) EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, 0), rocblas_status_success); } template void testing_sytxx_hetxx_bad_arg() { using S = decltype(std::real(T{})); // safe arguments rocblas_local_handle handle; rocblas_fill uplo = rocblas_fill_upper; rocblas_int n = 2; rocblas_int lda = 2; rocblas_stride stA = 1; rocblas_stride stD = 1; rocblas_stride stE = 1; rocblas_stride stP = 1; rocblas_int bc = 1; if(BATCHED) { // memory allocations device_batch_vector dA(1, 1, 1); device_strided_batch_vector dD(1, 1, 1, 1); device_strided_batch_vector dE(1, 1, 1, 1); device_strided_batch_vector dTau(1, 1, 1, 1); CHECK_HIP_ERROR(dA.memcheck()); CHECK_HIP_ERROR(dD.memcheck()); CHECK_HIP_ERROR(dE.memcheck()); CHECK_HIP_ERROR(dTau.memcheck()); // check bad arguments sytxx_hetxx_checkBadArgs(handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, bc); } else { // memory allocations device_strided_batch_vector dA(1, 1, 1, 1); device_strided_batch_vector dD(1, 1, 1, 1); device_strided_batch_vector dE(1, 1, 1, 1); device_strided_batch_vector dTau(1, 1, 1, 1); CHECK_HIP_ERROR(dA.memcheck()); CHECK_HIP_ERROR(dD.memcheck()); CHECK_HIP_ERROR(dE.memcheck()); CHECK_HIP_ERROR(dTau.memcheck()); // check bad arguments sytxx_hetxx_checkBadArgs(handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, bc); } } template , int> = 0> void sytxx_hetxx_initData(const rocblas_handle handle, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_int bc, Th& hA) { if(CPU) { rocblas_init(hA, true); // scale A to avoid singularities for(rocblas_int b = 0; b < bc; ++b) { for(rocblas_int i = 0; i < n; i++) { for(rocblas_int j = 0; j < n; j++) { if(i == j || i == j + 1 || i == j - 1) hA[b][i + j * lda] += 400; else hA[b][i + j * lda] -= 4; } } } } if(GPU) { // now copy to the GPU CHECK_HIP_ERROR(dA.transfer_from(hA)); } } template , int> = 0> void sytxx_hetxx_initData(const rocblas_handle handle, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_int bc, Th& hA) { if(CPU) { rocblas_init(hA, true); // scale A to avoid singularities for(rocblas_int b = 0; b < bc; ++b) { for(rocblas_int i = 0; i < n; i++) { for(rocblas_int j = 0; j < n; j++) { if(i == j) hA[b][i + j * lda] = hA[b][i + j * lda].real() + 400; else if(i == j + 1 || i == j - 1) hA[b][i + j * lda] += 400; else hA[b][i + j * lda] -= 4; } } } } if(GPU) { // now copy to the GPU CHECK_HIP_ERROR(dA.transfer_from(hA)); } } template void sytxx_hetxx_getError(const rocblas_handle handle, const rocblas_fill uplo, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_stride stA, Sd& dD, const rocblas_stride stD, Sd& dE, const rocblas_stride stE, Ud& dTau, const rocblas_stride stP, const rocblas_int bc, Th& hA, Th& hARes, Sh& hD, Sh& hE, Uh& hTau, double* max_err) { constexpr bool COMPLEX = rocblas_is_complex; std::vector hW(32 * n); // input data initialization sytxx_hetxx_initData(handle, n, dA, lda, bc, hA); // execute computations // GPU lapack CHECK_ROCBLAS_ERROR(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, bc)); CHECK_HIP_ERROR(hARes.transfer_from(dA)); CHECK_HIP_ERROR(hTau.transfer_from(dTau)); // Reconstruct matrix A from the factorization for implicit testing // A = H(n-1)...H(2)H(1)*T*H(1)'H(2)'...H(n-1)' if upper // A = H(1)H(2)...H(n-1)*T*H(n-1)'...H(2)'H(1)' if lower std::vector v(n); for(rocblas_int b = 0; b < bc; ++b) { T* a = hARes[b]; T* t = hTau[b]; if(uplo == rocblas_fill_lower) { for(rocblas_int i = 0; i < n - 2; ++i) a[i + (n - 1) * lda] = 0; a[(n - 2) + (n - 1) * lda] = a[(n - 1) + (n - 2) * lda]; // for each column for(rocblas_int j = n - 2; j >= 0; --j) { // prepare T and v for(rocblas_int i = 0; i < j - 1; ++i) a[i + j * lda] = 0; if(j > 0) a[(j - 1) + j * lda] = a[j + (j - 1) * lda]; for(rocblas_int i = j + 2; i < n; ++i) { v[i - j - 1] = a[i + j * lda]; a[i + j * lda] = 0; } v[0] = 1; // apply householder reflector cpu_larf(rocblas_side_left, n - 1 - j, n - j, v.data(), 1, t + j, a + (j + 1) + j * lda, lda, hW.data()); if(COMPLEX) cpu_lacgv(1, t + j, 1); cpu_larf(rocblas_side_right, n - j, n - 1 - j, v.data(), 1, t + j, a + j + (j + 1) * lda, lda, hW.data()); } } else { a[1] = a[lda]; for(rocblas_int i = 2; i < n; ++i) a[i] = 0; // for each column for(rocblas_int j = 1; j <= n - 1; ++j) { // prepare T and v for(rocblas_int i = 0; i < j - 1; ++i) { v[i] = a[i + j * lda]; a[i + j * lda] = 0; } v[j - 1] = 1; if(j < n - 1) a[(j + 1) + j * lda] = a[j + (j + 1) * lda]; for(rocblas_int i = j + 2; i < n; ++i) a[i + j * lda] = 0; // apply householder reflector cpu_larf(rocblas_side_left, j, j + 1, v.data(), 1, t + j - 1, a, lda, hW.data()); if(COMPLEX) cpu_lacgv(1, t + j - 1, 1); cpu_larf(rocblas_side_right, j + 1, j, v.data(), 1, t + j - 1, a, lda, hW.data()); } } } // error is ||hA - hARes|| / ||hA|| // using frobenius norm double err; *max_err = 0; for(rocblas_int b = 0; b < bc; ++b) { *max_err = (uplo == rocblas_fill_lower) ? norm_error_lowerTr('F', n, n, lda, hA[b], hARes[b]) : norm_error_upperTr('F', n, n, lda, hA[b], hARes[b]); } } template void sytxx_hetxx_getPerfData(const rocblas_handle handle, const rocblas_fill uplo, const rocblas_int n, Td& dA, const rocblas_int lda, const rocblas_stride stA, Sd& dD, const rocblas_stride stD, Sd& dE, const rocblas_stride stE, Ud& dTau, const rocblas_stride stP, const rocblas_int bc, Th& hA, Sh& hD, Sh& hE, Uh& hTau, double* gpu_time_used, double* cpu_time_used, const rocblas_int hot_calls, const int profile, const bool profile_kernels, const bool perf) { std::vector hW(32 * n); if(!perf) { sytxx_hetxx_initData(handle, n, dA, lda, bc, hA); // 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) { SYTRD ? cpu_sytrd_hetrd(uplo, n, hA[b], lda, hD[b], hE[b], hTau[b], hW.data(), 32 * n) : cpu_sytd2_hetd2(uplo, n, hA[b], lda, hD[b], hE[b], hTau[b]); } *cpu_time_used = get_time_us_no_sync() - *cpu_time_used; } sytxx_hetxx_initData(handle, n, dA, lda, bc, hA); // cold calls for(int iter = 0; iter < 2; iter++) { sytxx_hetxx_initData(handle, n, dA, lda, bc, hA); CHECK_ROCBLAS_ERROR(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, 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++) { sytxx_hetxx_initData(handle, n, dA, lda, bc, hA); timer.start(stream); rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, bc); timer.end(stream); } *gpu_time_used = timer.get_combined(); } template void testing_sytxx_hetxx(Arguments& argus) { using S = decltype(std::real(T{})); // get arguments rocblas_local_handle handle; char uploC = argus.get("uplo"); rocblas_int n = argus.get("n"); rocblas_int lda = argus.get("lda", n); rocblas_stride stA = argus.get("strideA", lda * n); rocblas_stride stD = argus.get("strideD", n); rocblas_stride stE = argus.get("strideE", n - 1); rocblas_stride stP = argus.get("strideP", n - 1); 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; // check non-supported values if(uplo != rocblas_fill_upper && uplo != rocblas_fill_lower) { if(BATCHED) EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T* const*)nullptr, lda, stA, (S*)nullptr, stD, (S*)nullptr, stE, (T*)nullptr, stP, bc), rocblas_status_invalid_value); else EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T*)nullptr, lda, stA, (S*)nullptr, stD, (S*)nullptr, stE, (T*)nullptr, stP, bc), rocblas_status_invalid_value); if(argus.timing) rocsolver_bench_inform(inform_invalid_args); return; } // determine sizes size_t size_A = lda * n; size_t size_D = n; size_t size_E = n - 1; size_t size_tau = n - 1; 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 || bc < 0); if(invalid_size) { if(BATCHED) EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T* const*)nullptr, lda, stA, (S*)nullptr, stD, (S*)nullptr, stE, (T*)nullptr, stP, bc), rocblas_status_invalid_size); else EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T*)nullptr, lda, stA, (S*)nullptr, stD, (S*)nullptr, stE, (T*)nullptr, stP, 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_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T* const*)nullptr, lda, stA, (S*)nullptr, stD, (S*)nullptr, stE, (T*)nullptr, stP, bc)); else CHECK_ALLOC_QUERY(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, (T*)nullptr, lda, stA, (S*)nullptr, stD, (S*)nullptr, stE, (T*)nullptr, stP, bc)); size_t size; CHECK_ROCBLAS_ERROR(rocblas_stop_device_memory_size_query(handle, &size)); rocsolver_bench_inform(inform_mem_query, size); return; } // memory allocations (all cases) // host host_strided_batch_vector hD(size_D, 1, stD, bc); host_strided_batch_vector hE(size_E, 1, stE, bc); host_strided_batch_vector hTau(size_tau, 1, stP, bc); // device device_strided_batch_vector dD(size_D, 1, stD, bc); device_strided_batch_vector dE(size_E, 1, stE, bc); device_strided_batch_vector dTau(size_tau, 1, stP, bc); if(size_D) CHECK_HIP_ERROR(dD.memcheck()); if(size_E) CHECK_HIP_ERROR(dE.memcheck()); if(size_tau) CHECK_HIP_ERROR(dTau.memcheck()); if(BATCHED) { // memory allocations host_batch_vector hA(size_A, 1, bc); host_batch_vector hARes(size_ARes, 1, bc); device_batch_vector dA(size_A, 1, bc); if(size_A) CHECK_HIP_ERROR(dA.memcheck()); // check quick return if(n == 0 || bc == 0) { EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, bc), rocblas_status_success); if(argus.timing) rocsolver_bench_inform(inform_quick_return); return; } // check computations if(argus.unit_check || argus.norm_check) sytxx_hetxx_getError(handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, bc, hA, hARes, hD, hE, hTau, &max_error); // collect performance data if(argus.timing && hot_calls > 0) sytxx_hetxx_getPerfData( handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, bc, hA, hD, hE, hTau, &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); device_strided_batch_vector dA(size_A, 1, stA, bc); if(size_A) CHECK_HIP_ERROR(dA.memcheck()); // check quick return if(n == 0 || bc == 0) { EXPECT_ROCBLAS_STATUS(rocsolver_sytxx_hetxx(STRIDED, SYTRD, handle, uplo, n, dA.data(), lda, stA, dD.data(), stD, dE.data(), stE, dTau.data(), stP, bc), rocblas_status_success); if(argus.timing) rocsolver_bench_inform(inform_quick_return); return; } // check computations if(argus.unit_check || argus.norm_check) sytxx_hetxx_getError(handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, bc, hA, hARes, hD, hE, hTau, &max_error); // collect performance data if(argus.timing && hot_calls > 0) sytxx_hetxx_getPerfData( handle, uplo, n, dA, lda, stA, dD, stD, dE, stE, dTau, stP, bc, hA, hD, hE, hTau, &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("uplo", "n", "lda", "strideD", "strideE", "strideP", "batch_c"); rocsolver_bench_output(uploC, n, lda, stD, stE, stP, bc); } else if(STRIDED) { rocsolver_bench_output("uplo", "n", "lda", "strideA", "strideD", "strideE", "strideP", "batch_c"); rocsolver_bench_output(uploC, n, lda, stA, stD, stE, stP, bc); } else { rocsolver_bench_output("uplo", "n", "lda"); rocsolver_bench_output(uploC, n, lda); } 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_SYTXX_HETXX(...) \ extern template void testing_sytxx_hetxx<__VA_ARGS__>(Arguments&); INSTANTIATE(EXTERN_TESTING_SYTXX_HETXX, FOREACH_MATRIX_DATA_LAYOUT, FOREACH_BLOCKED_VARIANT, FOREACH_SCALAR_TYPE, APPLY_STAMP)