pipe_cache_policy.h

Go to the documentation of this file.

/*
    This file is part of Ansel.
    Copyright (C) 2026 Aurélien Pierre.
 
    Ansel is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
 
    Ansel is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with Ansel.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#ifndef DT_DEVELOP_PIPE_CACHE_POLICY_H
#define DT_DEVELOP_PIPE_CACHE_POLICY_H
 
#include <glib.h>
 
#include "system/macros.h"   // IS_NULL_PTR
 
typedef struct dt_dev_pipe_cache_policy_inputs_t
{
  gboolean authored_cache;
  gboolean user_requested_cache;
  gboolean supports_opencl;
  gboolean color_picker_on;
  gboolean global_hist_output_on;
  gboolean global_hist_input_on;
  gboolean module_hist_on;
  gboolean active_in_gui;
  gboolean has_autoset;
} dt_dev_pipe_cache_policy_inputs_t;
 
static inline gboolean dt_dev_pipe_cache_policy_decide(const dt_dev_pipe_cache_policy_inputs_t *in,
                                                       const gboolean inherited_requirement,
                                                       gboolean *upstream_requirement)
{
  // What THIS node needs from the node before it.
  const gboolean own_input_requirement
      = !in->supports_opencl || in->active_in_gui || in->module_hist_on
        || in->global_hist_input_on || in->has_autoset;
 
  // A GPU-capable node that needs no host input of its own must not ERASE a requirement
  // inherited from further downstream -- a CPU-only module reached through it, or one that is
  // disabled right now but was enabled a moment ago and left a stale host-less cacheline
  // behind. This was an `=' once, and an intermediate GPU module silently reset the flag; the
  // module before it then skipped a readback that a later, non-adjacent consumer needed, and
  // read the previous life of a rekeyed cacheline. Only reproducible with OpenCL enabled.
  if(!IS_NULL_PTR(upstream_requirement))
    *upstream_requirement = own_input_requirement || inherited_requirement;
 
  return in->authored_cache || in->user_requested_cache || in->color_picker_on
         || in->global_hist_output_on || inherited_requirement;
}
 
#endif // DT_DEVELOP_PIPE_CACHE_POLICY_H
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on