cl_format_coo_vec.hpp

Go to the documentation of this file.

/**********************************************************************************/
/* This file is part of spla project                                              */
/* https://github.com/SparseLinearAlgebra/spla                                    */
/**********************************************************************************/
/* MIT License                                                                    */
/*                                                                                */
/* Copyright (c) 2023 SparseLinearAlgebra                                         */
/*                                                                                */
/* 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.                                                                      */
/**********************************************************************************/
 
#ifndef SPLA_CL_FORMAT_COO_VEC_HPP
#define SPLA_CL_FORMAT_COO_VEC_HPP
 
#include <opencl/cl_debug.hpp>
#include <opencl/cl_fill.hpp>
#include <opencl/cl_formats.hpp>
#include <opencl/cl_program_builder.hpp>
#include <opencl/generated/auto_vector_formats.hpp>
 
namespace spla {
 
    template<typename T>
    void cl_coo_vec_init(const std::size_t n_values,
                         const uint*       Ai,
                         const T*          Ax,
                         CLCooVec<T>&      storage) {
        if (n_values == 0) {
            LOG_MSG(Status::Ok, "nothing to do");
 
            storage.values = 0;
            storage.Ai     = cl::Buffer();
            storage.Ax     = cl::Buffer();
            return;
        }
 
        const std::size_t buffer_size_Ai = n_values * sizeof(uint);
        const std::size_t buffer_size_Ax = n_values * sizeof(T);
        const auto        flags          = CL_MEM_READ_WRITE | CL_MEM_HOST_NO_ACCESS | CL_MEM_COPY_HOST_PTR;
 
        cl::Buffer buffer_Ai(get_acc_cl()->get_context(), flags, buffer_size_Ai, (void*) Ai);
        cl::Buffer buffer_Ax(get_acc_cl()->get_context(), flags, buffer_size_Ax, (void*) Ax);
 
        storage.Ai = std::move(buffer_Ai);
        storage.Ax = std::move(buffer_Ax);
 
        storage.values = n_values;
    }
 
    template<typename T>
    void cl_coo_vec_resize(const std::size_t n_values,
                           CLCooVec<T>&      storage) {
        if (n_values == 0) {
            LOG_MSG(Status::Ok, "nothing to do");
 
            storage.values = 0;
            storage.Ai     = cl::Buffer();
            storage.Ax     = cl::Buffer();
            return;
        }
 
        const std::size_t buffer_size_Ai = n_values * sizeof(uint);
        const std::size_t buffer_size_Ax = n_values * sizeof(T);
        const auto        flags          = CL_MEM_READ_WRITE | CL_MEM_HOST_NO_ACCESS;
 
        cl::Buffer buffer_Ai(get_acc_cl()->get_context(), flags, buffer_size_Ai);
        cl::Buffer buffer_Ax(get_acc_cl()->get_context(), flags, buffer_size_Ax);
 
        storage.Ai     = std::move(buffer_Ai);
        storage.Ax     = std::move(buffer_Ax);
        storage.values = n_values;
    }
 
    template<typename T>
    void cl_coo_vec_clear(CLCooVec<T>& storage) {
        storage.Ai     = cl::Buffer();
        storage.Ax     = cl::Buffer();
        storage.values = 0;
    }
 
    template<typename T>
    void cl_coo_vec_read(const std::size_t  n_values,
                         uint*              Ai,
                         T*                 Ax,
                         const CLCooVec<T>& storage,
                         cl::CommandQueue&  queue,
                         cl_mem_flags       staging_flags = CL_MEM_READ_ONLY | CL_MEM_HOST_READ_ONLY | CL_MEM_ALLOC_HOST_PTR,
                         bool               blocking      = true) {
        if (n_values == 0) {
            LOG_MSG(Status::Ok, "nothing to do");
            return;
        }
 
        const std::size_t buffer_size_Ai = n_values * sizeof(uint);
        const std::size_t buffer_size_Ax = n_values * sizeof(T);
 
        cl::Buffer staging_Ai(get_acc_cl()->get_context(), staging_flags, buffer_size_Ai);
        cl::Buffer staging_Ax(get_acc_cl()->get_context(), staging_flags, buffer_size_Ax);
 
        queue.enqueueCopyBuffer(storage.Ai, staging_Ai, 0, 0, buffer_size_Ai);
        queue.enqueueCopyBuffer(storage.Ax, staging_Ax, 0, 0, buffer_size_Ax);
        queue.enqueueReadBuffer(staging_Ai, blocking, 0, buffer_size_Ai, Ai);
        queue.enqueueReadBuffer(staging_Ax, blocking, 0, buffer_size_Ax, Ax);
    }
 
    template<typename T>
    void cl_coo_vec_to_dense(const std::size_t  n_rows,
                             const T            fill_value,
                             const CLCooVec<T>& in,
                             CLDenseVec<T>&     out,
                             cl::CommandQueue&  queue) {
        CLProgramBuilder builder;
        builder.set_name("vector_format")
                .add_type("TYPE", get_ttype<T>().template as<Type>())
                .set_source(source_vector_formats)
                .acquire();
 
        cl_fill_value<T>(queue, out.Ax, n_rows, fill_value);
 
        if (in.values == 0) {
            LOG_MSG(Status::Ok, "nothing to do");
            return;
        }
 
        auto* acc = get_acc_cl();
 
        uint block_size           = acc->get_default_wgs();
        uint n_groups_to_dispatch = std::max(std::min(in.values / block_size, uint(1024)), uint(1));
 
        auto kernel = builder.make_kernel("sparse_to_dense");
        kernel.setArg(0, in.Ai);
        kernel.setArg(1, in.Ax);
        kernel.setArg(2, out.Ax);
        kernel.setArg(3, uint(in.values));
 
        cl::NDRange global(block_size * n_groups_to_dispatch);
        cl::NDRange local(block_size);
        queue.enqueueNDRangeKernel(kernel, cl::NDRange(), global, local);
        CL_FINISH(queue);
    }
 
}// namespace spla
 
#endif//SPLA_CL_FORMAT_COO_VEC_HPP