pixelpipe_cache_wait.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_CACHES_PIXELPIPE_CACHE_WAIT_H
#define DT_CACHES_PIXELPIPE_CACHE_WAIT_H
 
#include <glib.h>
#include <stdint.h>
 
#include "system/dtpthread.h"
 
typedef void (*dt_pixelpipe_cache_ready_callback_t)(gpointer user_data);
 
typedef struct dt_pixelpipe_cache_wait_t
{
  /* Identity only, never dereferenced: which pipe and which module this waiter is about, so a
   * re-request can be recognised as the same one and a teardown can cancel by owner. The queue
   * outlives neither object, which is why the labels below are copies rather than reads. */
  const void *pipe;
  const void *module;
 
  /* Captured when the wait is queued, for debug traces and telemetry keys. */
  char module_op[20];
  int module_multi_priority;
  int pipe_type;
  int32_t pipe_imgid;
 
  uint64_t hash;
 
  uint64_t target_node_key;
 
  dt_pixelpipe_cache_ready_callback_t restart;
  gpointer user_data;
  const char *owner_tag;
  gpointer owner_object;
  uint64_t request_id;
  gboolean connected;
} dt_pixelpipe_cache_wait_t;
 
gboolean dt_pixelpipe_cache_wait_enqueue(dt_pixelpipe_cache_wait_t *wait);
 
GList *dt_pixelpipe_cache_wait_take_matching(uint64_t hash, uint64_t producer_node_key,
                                             gboolean *drained);
 
gboolean dt_pixelpipe_cache_wait_cancel(dt_pixelpipe_cache_wait_t *wait, gboolean *drained);
 
guint dt_pixelpipe_cache_wait_pending_count(void);
 
void dt_pixelpipe_cache_wait_get_stats(uint64_t *queued, uint64_t *served, uint64_t *cancelled,
                                       uint64_t *immediate_hits, uint64_t *misses);
 
void dt_pixelpipe_cache_wait_count_immediate_hit(void);
 
void dt_pixelpipe_cache_wait_count_miss(void);
 
typedef void (*dt_pixelpipe_cache_wait_visitor_t)(const dt_pixelpipe_cache_wait_t *wait,
                                                  int64_t age_us, gpointer user_data);
void dt_pixelpipe_cache_wait_foreach_pending(dt_pixelpipe_cache_wait_visitor_t callback,
                                             gpointer user_data);
 
#endif // DT_CACHES_PIXELPIPE_CACHE_WAIT_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