library.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_LIBRARY_HPP
#define SPLA_LIBRARY_HPP
 
#include "config.hpp"
 
#include <memory>
#include <string>
#include <unordered_map>
 
namespace spla {
 
    class Library final {
    public:
        SPLA_API Library();
        SPLA_API ~Library();
 
        Library(const Library&) = delete;
        Library(Library&&)      = delete;
 
        SPLA_API void finalize();
 
        SPLA_API Status set_accelerator(AcceleratorType accelerator);
 
        SPLA_API Status set_platform(int index);
 
        SPLA_API Status set_device(int index);
 
        SPLA_API Status set_queues_count(int count);
 
        SPLA_API Status set_message_callback(MessageCallback callback);
 
        SPLA_API Status set_default_callback();
 
        SPLA_API Status set_force_no_acceleration(bool value);
        SPLA_API bool   is_set_force_no_acceleration();
 
        SPLA_API Status get_accelerator_info(std::string& info);
 
        SPLA_API Status time_profile_dump();
        SPLA_API Status time_profile_reset();
 
        class Accelerator* get_accelerator();
 
        class Registry* get_registry();
 
        class Dispatcher* get_dispatcher();
 
        class Logger* get_logger();
 
        class TimeProfiler* get_time_profiler();
 
        SPLA_API static Library* get();
 
    private:
        std::unordered_map<std::string, std::string> m_env;
        std::unique_ptr<class Accelerator>           m_accelerator;
        std::unique_ptr<class Registry>              m_registry;
        std::unique_ptr<class Dispatcher>            m_dispatcher;
        std::unique_ptr<class Logger>                m_logger;
        std::unique_ptr<class TimeProfiler>          m_time_profiler;
        bool                                         m_force_no_acc = false;
    };
 
}// namespace spla
 
#endif//SPLA_LIBRARY_HPP