local_cache.hpp

//--------------------------------------------------------------------------------------------------
// Copyright (c) 2019 Marcus Geelnard
//
// This software is provided 'as-is', without any express or implied warranty. In no event will the
// authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose, including commercial
// applications, and to alter it and redistribute it freely, subject to the following restrictions:
//
//  1. The origin of this software must not be misrepresented; you must not claim that you wrote
//     the original software. If you use this software in a product, an acknowledgment in the
//     product documentation would be appreciated but is not required.
//
//  2. Altered source versions must be plainly marked as such, and must not be misrepresented as
//     being the original software.
//
//  3. This notice may not be removed or altered from any source distribution.
//--------------------------------------------------------------------------------------------------
 
#ifndef BUILDCACHE_LOCAL_CACHE_HPP_
#define BUILDCACHE_LOCAL_CACHE_HPP_
 
#include <base/file_lock.hpp>
#include <base/file_utils.hpp>
#include <cache/cache_entry.hpp>
#include <cache/cache_stats.hpp>
#include <cache/direct_mode_manifest.hpp>
#include <cache/expected_file.hpp>
 
#include <map>
#include <string>
#include <utility>
 
namespace bcache {
 
class local_cache_t {
public:
  local_cache_t();
 
  ~local_cache_t();
 
  void clear();
 
  void show_stats();
 
  void zero_stats();
 
  void add_direct(const std::string& direct_hash, const direct_mode_manifest_t& manifest);
 
  direct_mode_manifest_t lookup_direct(const std::string& direct_hash);
 
  void add(const std::string& hash,
           const cache_entry_t& entry,
           const std::map<std::string, expected_file_t>& expected_files,
           const bool allow_hard_links);
 
  std::pair<cache_entry_t, file::file_lock_t> lookup(const std::string& hash);
 
  void get_file(const std::string& hash,
                const std::string& source_id,
                const std::string& target_path,
                const bool is_compressed,
                const bool allow_hard_links);
 
  bool update_stats(const std::string& hash, const cache_stats_t& delta) const noexcept;
 
private:
  std::string hash_to_cache_entry_path(const std::string& hash) const;
  std::string get_cache_files_folder() const;
 
  void perform_housekeeping();
};
 
}  // namespace bcache
 
#endif  // BUILDCACHE_LOCAL_CACHE_HPP_