#include "config.h"
#include "caches/cache.h"
#include "system/dtpthread.h"
#include "system/macros.h"
#include "system/mem_alloc.h"
#include <assert.h>
#include <inttypes.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

Include dependency graph for src/caches/cache.c:

Functions
void	dt_cache_init (dt_cache_t *cache, size_t entry_size, size_t cost_quota)

void	dt_cache_cleanup (dt_cache_t *cache)

int32_t	dt_cache_contains (dt_cache_t *cache, const uint32_t key)

int	dt_cache_for_all (dt_cache_t cache, int(process)(const uint32_t key, const void data, void user_data), void *user_data)

dt_cache_entry_t *	dt_cache_testget (dt_cache_t *cache, const uint32_t key, char mode)

dt_cache_entry_t *	dt_cache_get_with_caller (dt_cache_t cache, const uint32_t key, char mode, const char file, int line)

int	dt_cache_remove (dt_cache_t *cache, const uint32_t key)

void	dt_cache_gc (dt_cache_t *cache, const float fill_ratio)

void	dt_cache_release_with_caller (dt_cache_t cache, dt_cache_entry_t entry, const char *file, int line)

int	dt_cache_seed (dt_cache_t cache, const uint32_t key, const void data, size_t data_size, size_t cost, gboolean aligned_alloc)

dt_cache_entry_t *	dt_cache_entry_new_detached (void)
	Allocate a cache entry that belongs to NO cache, for a one-shot decode.

void	dt_cache_entry_free_detached (dt_cache_entry_t *entry)
	Release an entry from dt_cache_entry_new_detached(), and its `data`. NULL-safe.

Function Documentation

◆ dt_cache_cleanup()

void dt_cache_cleanup ( dt_cache_t * cache )

Definition at line 62 of file src/caches/cache.c.

References ASAN_UNPOISON_MEMORY_REGION, dt_cache_t::cleanup, dt_cache_t::cleanup_data, dt_cache_entry_t::data, dt_cache_entry_t::data_size, dt_free_align, dt_pthread_mutex_destroy(), dt_pthread_rwlock_destroy(), dt_cache_t::hashtable, L, dt_cache_entry_t::lock, dt_cache_t::lock, and dt_cache_t::lru.

Referenced by dt_image_cache_cleanup(), dt_mipmap_cache_cleanup(), and main().

◆ dt_cache_contains()

int32_t dt_cache_contains	(	dt_cache_t *	cache,
		const uint32_t	key
	)

Definition at line 90 of file src/caches/cache.c.

References dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), dt_cache_t::hashtable, key, L, and dt_cache_t::lock.

Referenced by main().

◆ dt_cache_entry_free_detached()

void dt_cache_entry_free_detached ( dt_cache_entry_t * entry )

Release an entry from dt_cache_entry_new_detached(), and its data. NULL-safe.

Definition at line 459 of file src/caches/cache.c.

References dt_cache_entry_t::data, dt_free_align, and IS_NULL_PTR.

Referenced by dt_imageio_close_standalone().

◆ dt_cache_entry_new_detached()

dt_cache_entry_t * dt_cache_entry_new_detached ( void )

Allocate a cache entry that belongs to NO cache, for a one-shot decode.

The decoders write into whatever dt_cache_entry_t they are handed, which is normally one the mipmap cache owns. A caller that just wants a file decoded once has no cache to get one from, and used to declare a zeroed entry on its own stack – assembling this module's bookkeeping by hand to borrow a decoder. These two exist so nothing outside src/caches needs the layout.

Returns: An entry whose data is NULL, or NULL on allocation failure. Release it with dt_cache_entry_free_detached(), which frees data too.

See also: dt_imageio_open_standalone(), its only caller.

Definition at line 454 of file src/caches/cache.c.

References L.

Referenced by dt_imageio_open_standalone().

◆ dt_cache_for_all()

int dt_cache_for_all	(	dt_cache_t *	cache,
		int()(const uint32_t key, const void data, void *user_data)	process,
		void *	user_data
	)

Definition at line 98 of file src/caches/cache.c.

References dt_cache_entry_t::data, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), dt_cache_t::hashtable, key, L, dt_cache_t::lock, process(), and value.

◆ dt_cache_gc()

void dt_cache_gc	(	dt_cache_t *	cache,
		const float	fill_ratio
	)

◆ dt_cache_get_with_caller()

dt_cache_entry_t * dt_cache_get_with_caller	(	dt_cache_t *	cache,
		const uint32_t	key,
		char	mode,
		const char *	file,
		int	line
	)

Definition at line 165 of file src/caches/cache.c.

References dt_cache_entry_t::_lock_demoting, dt_cache_t::allocate, dt_cache_t::allocate_data, ASAN_POISON_MEMORY_REGION, dt_cache_entry_t::cost, dt_cache_t::cost, dt_cache_t::cost_quota, dt_cache_entry_t::data, dt_cache_entry_t::data_size, dt_alloc_align(), dt_cache_gc(), dt_free, dt_pthread_mutex_lock(), dt_pthread_mutex_unlock(), dt_pthread_rwlock_init(), dt_pthread_rwlock_rdlock_with_caller, dt_pthread_rwlock_tryrdlock_with_caller, dt_pthread_rwlock_trywrlock_with_caller, dt_pthread_rwlock_wrlock_with_caller, dt_cache_t::entry_size, dt_cache_t::hashtable, IS_NULL_PTR, dt_cache_entry_t::key, key, L, dt_cache_entry_t::link, dt_cache_entry_t::lock, dt_cache_t::lock, dt_cache_t::lru, and value.

Referenced by dt_mipmap_cache_get_with_caller_and_shutdown(), and dt_mipmap_cache_swap_at_size().

◆ dt_cache_init()

void dt_cache_init	(	dt_cache_t *	cache,
		size_t	entry_size,
		size_t	cost_quota
	)

Definition at line 45 of file src/caches/cache.c.

References dt_cache_t::allocate, dt_cache_t::allocate_data, dt_cache_t::cleanup, dt_cache_t::cleanup_data, dt_cache_t::cost, dt_cache_t::cost_quota, dt_pthread_mutex_init(), dt_cache_t::entry_size, dt_cache_t::hashtable, L, dt_cache_t::lock, and dt_cache_t::lru.

Referenced by dt_image_cache_init(), dt_mipmap_cache_init(), and main().

◆ dt_cache_release_with_caller()

void dt_cache_release_with_caller	(	dt_cache_t *	cache,
		dt_cache_entry_t *	entry,
		const char *	file,
		int	line
	)

Definition at line 379 of file src/caches/cache.c.

References ASAN_POISON_MEMORY_REGION, dt_cache_entry_t::data, dt_cache_entry_t::data_size, dt_pthread_rwlock_unlock(), L, dt_cache_entry_t::lock, and dt_pthread_rwlock_t::lock.

Referenced by dt_mipmap_cache_release_with_caller().

◆ dt_cache_remove()

int dt_cache_remove	(	dt_cache_t *	cache,
		const uint32_t	key
	)

◆ dt_cache_seed()

int dt_cache_seed	(	dt_cache_t *	cache,
		const uint32_t	key,
		const void *	data,
		size_t	data_size,
		size_t	cost,
		gboolean	aligned_alloc
	)

◆ dt_cache_testget()

dt_cache_entry_t * dt_cache_testget	(	dt_cache_t *	cache,
		const uint32_t	key,
		char	mode
	)

Functions