global_mutexes.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_COMMON_GLOBAL_MUTEXES_H
#define DT_COMMON_GLOBAL_MUTEXES_H
 
/* Process-wide locks owned by the orchestrator (darktable.c).
 *
 * They are process-wide because the thing they serialize is process-wide -- a
 * non-reentrant third-party library, or a resource the whole application shares.
 * There is no per-call context to carry them on, so an accessor is the end state
 * here, not a stepping stone: see doc/globals-migration.md, category "process-wide
 * buses".
 *
 * Declared here so that the modules which need them (iop/watermark.c,
 * imageio/storage/disk.c, imageio/imageio_rawspeed.cc, ...) do not have to include
 * darktable.h, and therefore the whole application, to take a lock.
 *
 * Audited 2026-08-27; see doc/lock-audit.md for what each one protects and what was
 * removed. The list is deliberately short and getting shorter: a lock belongs to the module
 * whose invariant it defends, not to the application struct. What remains here is
 * process-wide because the thing it serializes genuinely is. */
 
#include "system/dtpthread.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
dt_pthread_mutex_t *dt_pipeline_threadsafe_mutex(void);
 
#ifdef __cplusplus
}
#endif
 
#endif // DT_COMMON_GLOBAL_MUTEXES_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