BLI_cache_mutex.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once

 
#include <atomic>
 
#include "BLI_function_ref.hh"
#include "BLI_mutex.hh"
 
namespace blender {
 
class CacheMutex {
 private:
  Mutex mutex_;
  std::atomic<bool> cache_valid_ = false;
 
 public:
  void ensure(const FunctionRef<void()> compute_cache)
  {
    /* Handle fast case when the cache is up-to-date. */
    if (cache_valid_.load(std::memory_order_acquire)) {
      return;
    }
    this->ensure_impl(compute_cache);
  }

  void tag_dirty()
  {
    cache_valid_.store(false);
  }

  bool is_dirty() const
  {
    return !this->is_cached();
  }

  bool is_cached() const
  {
    return cache_valid_.load(std::memory_order_relaxed);
  }
 
 private:
  void ensure_impl(FunctionRef<void()> compute_cache);
};
 
}  // namespace blender