/*******************************************************************************
 *
 * MIT License
 *
 * Copyright (c) 2024 Advanced Micro Devices, Inc.
 *
 * 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 GUARD_MLOPEN_BINARY_CACHE_HPP
#define GUARD_MLOPEN_BINARY_CACHE_HPP

#include <miopen/config.hpp>
#include <miopen/target_properties.hpp>
#include <miopen/filesystem.hpp>

#include <string>
#include <vector>

namespace miopen {

MIOPEN_INTERNALS_EXPORT bool IsCacheDisabled();

MIOPEN_INTERNALS_EXPORT fs::path
GetCacheFile(const std::string& device, const fs::path& name, const std::string& args);

MIOPEN_INTERNALS_EXPORT fs::path GetCachePath(bool is_system);

#if !MIOPEN_ENABLE_SQLITE_KERN_CACHE
MIOPEN_INTERNALS_EXPORT fs::path LoadBinary(const TargetProperties& target,
                                            std::size_t num_cu,
                                            const fs::path& name,
                                            const std::string& args);

fs::path SaveBinary(const fs::path& binary_path,
                    const TargetProperties& target,
                    const fs::path& name,
                    const std::string& args);
#else
MIOPEN_INTERNALS_EXPORT std::vector<char> LoadBinary(const TargetProperties& target,
                                                     std::size_t num_cu,
                                                     const fs::path& name,
                                                     const std::string& args);

MIOPEN_INTERNALS_EXPORT void SaveBinary(const std::vector<char>& hsaco,
                                        const TargetProperties& target,
                                        std::size_t num_cu,
                                        const fs::path& name,
                                        const std::string& args);
#endif

#ifdef MIOPEN_BUILD_TESTING
namespace testing {
/// Reset cached paths for testing purposes
/// This allows tests to reinitialize paths with different mocks/env vars
MIOPEN_INTERNALS_EXPORT void ResetCachedPaths();
} // namespace testing
#endif

} // namespace miopen

#endif
