Ansel 0.0
A darktable fork - bloat + design vision
Loading...
Searching...
No Matches
cache.h File Reference
#include "system/dtpthread.h"
#include <glib.h>
#include <inttypes.h>
#include <stddef.h>
Include dependency graph for caches/cache.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  dt_cache_entry_t
struct  dt_cache_t

Macros

#define dt_cache_get(A, B, C)
#define dt_cache_release(A, B)

Typedefs

typedef struct dt_cache_entry_t dt_cache_entry_t
typedef struct dt_cache_t dt_cache_t

Functions

typedef void ((*dt_cache_allocate_t)(void *userdata, dt_cache_entry_t *entry))
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.
void dt_cache_init (dt_cache_t *cache, size_t entry_size, size_t cost_quota)
void dt_cache_cleanup (dt_cache_t *cache)
static void dt_cache_set_allocate_callback (dt_cache_t *cache, dt_cache_allocate_t allocate_cb, void *allocate_data)
static void dt_cache_set_cleanup_callback (dt_cache_t *cache, dt_cache_cleanup_t cleanup_cb, void *cleanup_data)
dt_cache_entry_t * dt_cache_get_with_caller (dt_cache_t *cache, const uint32_t key, char mode, const char *file, int line)
dt_cache_entry_t * dt_cache_testget (dt_cache_t *cache, const uint32_t key, char mode)
void dt_cache_release_with_caller (dt_cache_t *cache, dt_cache_entry_t *entry, const char *file, int line)
int32_t dt_cache_contains (dt_cache_t *cache, const uint32_t key)
int32_t dt_cache_remove (dt_cache_t *cache, const uint32_t key)
int dt_cache_seed (dt_cache_t *cache, const uint32_t key, const void *data, size_t data_size, size_t cost)
size_t dt_cache_gc (dt_cache_t *cache, const float fill_ratio)
int dt_cache_for_all (dt_cache_t *cache, int(*process)(const uint32_t key, const void *data, void *user_data), void *user_data)

Macro Definition Documentation

◆ dt_cache_get

#define dt_cache_get ( A,
B,
C )
Value:
dt_cache_get_with_caller(A, B, C, __FILE__, __LINE__)
#define B(y, x)
#define A(y, x)
static const float const float C
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 106 of file caches/cache.h.

Referenced by dt_image_cache_get(), dt_image_cache_get_reload(), and dt_mipmap_cache_get_with_caller_and_shutdown().

◆ dt_cache_release

Typedef Documentation

◆ dt_cache_entry_t

typedef struct dt_cache_entry_t dt_cache_entry_t

◆ dt_cache_t

typedef struct dt_cache_t dt_cache_t

Function Documentation

◆ dt_cache_cleanup()

◆ dt_cache_contains()

int32_t dt_cache_contains ( dt_cache_t * cache,
const uint32_t key )

◆ 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 473 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 468 of file src/caches/cache.c.

Referenced by dt_imageio_open_standalone().

◆ dt_cache_for_all()

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_gc()

size_t dt_cache_gc ( dt_cache_t * cache,
const float fill_ratio )

◆ dt_cache_get_with_caller()

◆ dt_cache_init()

◆ 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 )

◆ dt_cache_remove()

◆ dt_cache_seed()

◆ dt_cache_set_allocate_callback()

void dt_cache_set_allocate_callback ( dt_cache_t * cache,
dt_cache_allocate_t allocate_cb,
void * allocate_data )
inlinestatic

Definition at line 91 of file caches/cache.h.

References dt_cache_t::allocate, and dt_cache_t::allocate_data.

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

◆ dt_cache_set_cleanup_callback()

void dt_cache_set_cleanup_callback ( dt_cache_t * cache,
dt_cache_cleanup_t cleanup_cb,
void * cleanup_data )
inlinestatic

Definition at line 97 of file caches/cache.h.

References dt_cache_t::cleanup, and dt_cache_t::cleanup_data.

Referenced by dt_image_cache_init(), and dt_mipmap_cache_init().

◆ dt_cache_testget()

◆ void()

typedef void ( (* dt_cache_allocate_t )(void *userdata, dt_cache_entry_t *entry))

Referenced by _a_cpu_node_publishes_its_producer_and_no_further(), _a_cpu_node_still_makes_its_producer_publish(), _a_device_scaled_surface_is_painted_in_its_pixels(), _a_gpu_node_does_not_relay_its_consumers_requirement(), _a_gpu_node_nothing_reads_from_ram_caches_nothing(), _a_horizontal_line_paints_a_band_of_its_width(), _a_null_attr_mutex_is_recursive(), _a_path_in_a_pushed_group_lands_where_cairo_puts_it(), _a_pure_gpu_chain_nobody_reads_caches_nothing(), _a_shape_with_no_geometry_rasterises_empty(), _a_shape_with_no_rasteriser_is_an_error(), _a_shared_group_is_cloned_before_its_opacity_changes(), _a_shed_lowers_the_budget_to_what_is_left(), _a_surface_it_cannot_write_is_refused_and_the_path_kept(), _a_user_binding_wins_over_the_default(), _a_zero_default_cannot_tell_absent_from_cleared(), _accels_tooltip_query_hook(), _active_modules_popup(), _an_absent_path_takes_the_app_default(), _an_emptied_entry_stays_cleared(), _an_empty_cache_is_not_the_cause(), _an_explicit_attribute_is_honoured(), _an_rwlock_writer_may_re_enter(), _an_unbuildable_outline_is_never_reported_as_built(), _area_and_mask_always_write_their_out_parameters(), _attach_selected_layer_clicked(), _backup_db(), _blendop_blendif_disp_alternative_reset(), _blendop_blending_notebook_switch(), _blendop_masks_all_name_edited(), _blendop_masks_all_toggled(), _blendop_masks_group_name_focus_out(), _blendop_masks_handler_callback(), _borrowed_value_survives_being_replaced(), _brush_draw_shape(), _cacheline_ready_callback(), _child_no_focus(), _circle_draw_shape(), _collect_active(), _color_picker_button_press(), _color_picker_button_release(), _color_picker_callback_button_press(), _color_picker_motion(), _color_picker_widget_destroy(), _completion_row_activated(), _copy_members_preserves_order_and_reports_the_total(), _copy_members_refuses_anything_that_is_not_a_group(), _count_two_rows(), _cpu_only_node_needs_its_input_on_host(), _create_background_clicked(), _create_layer_clicked(), _dashes_leave_gaps_along_the_line(), _delete_child(), _delete_layer_clicked(), _develop_cacheline_ready_callback(), _develop_history_resync_callback(), _develop_ui_pipe_finished_callback(), _dispatch_pending_tasks(), _drain_pending_commits(), _dump_one_pending(), _each_own_input_reason_raises_upstream(), _each_own_output_reason_raises_own(), _edit_button_release(), _edit_key_press(), _edit_key_release(), _edit_preset_response(), _ellipse_draw_shape(), _event_process_after_preview_callback(), _event_process_after_ui_callback(), _event_structure_auto_clicked(), _every_displaced_value_stays_readable(), _fill_black_clicked(), _fill_transparent_clicked(), _fill_white_clicked(), _find_holder_names_the_group_that_references_a_shape(), _flat_caps_stop_at_the_ends(), _form_info_describes_a_shape(), _form_info_leaves_out_untouched_on_failure(), _from_status_maps_zero_to_ok_and_everything_else_to_error(), _get_debug_pipe_name(), _get_member_reads_a_row_by_identity(), _gpu_node_requires_nothing_on_its_own(), _gradient_draw_shape(), _gtk_main_quit_safe(), _history_compress_apply(), _history_resync_callback(), _image_import_internal(), _inverse_toggles_and_leaves_the_operator_alone(), _iop_color_picker_cacheline_ready_callback(), _iop_color_picker_history_resync_callback(), _iop_color_picker_notebook_tab_changed_callback(), _iop_color_picker_pipe_finished_callback(), _ioporder_draw_mask_arrow(), _ioporder_runtime_band_profile_info(), _lens_build_data(), _lib_histogram_cacheline_ready_callback(), _lib_histogram_history_resync_callback(), _lib_navigation_control_redraw_callback(), _lib_navigation_history_resync_callback(), _log_arena_allocation_failure(), _mask_indicator_tooltip(), _metadata_get_flags(), _metadata_view_update_values(), _null_upstream_pointer_is_allowed(), _only_the_displayed_output_is_cached_in_a_gpu_chain(), _perform_runtime_widget_cache_sync(), _polygon_draw_shape(), _preferences_changed(), _prepare_resampling_plan(), _preview_cacheline_ready_callback(), _preview_history_resync_callback(), _preview_map(), _record_folder_status(), _recovery_reaches_the_plan_without_a_jump(), _recovery_waits_under_the_mark(), _region_guided_filter(), _rename_layer_clicked(), _reported_budget_never_underflows_its_readers(), _rewriting_the_same_value_retires_nothing(), _run_pending_preview_job(), _save_layer_clicked(), _saving_marks_defaults_as_comments_and_changes_as_lines(), _session_pattern_hash(), _set_opacity_clamps_and_reports_what_it_stored(), _set_opacity_refuses_a_nan_rather_than_clamping_it(), _set_operation_rejects_what_it_cannot_do(), _set_operation_replaces_the_combine_op(), _setting_the_state_it_already_has_is_unchanged(), _setup(), _setup(), _sheds_a_share_of_what_is_held(), _splash_scale_factor_changed(), _starts_at_the_plan(), _stroke_flow_alpha(), _teardown(), _teardown(), _textview_focus_out(), _the_blocking_lock_also_re_enters(), _the_bright_pass_paints_over_the_dark_one(), _the_budget_never_falls_under_the_floor(), _the_generation_advances_on_a_change_and_not_otherwise(), _the_matrix_scales_widths_and_positions(), _the_touched_record_resets(), _type_tokens_are_the_persisted_conf_key_spellings(), _typed_setters_retire_too(), _widget_auto_model_row_changed(), _widget_auto_model_row_collapsed(), _widget_auto_model_row_deleted(), _widget_auto_model_row_expanded(), _widget_auto_model_row_inserted(), _widget_auto_model_rows_reordered(), _widget_auto_on_buffer_changed(), _widget_auto_on_model_changed(), _widget_auto_text_buffer_changed(), _xmp_mode_preferences_changed(), append_file(), append_image(), append_run(), camera_menusearch_clicked(), cleanup_pipe(), color_picker_apply(), commit_params(), default_distort_backtransform(), default_distort_transform(), default_runtime_data_hash(), delete_children(), distort_backtransform(), distort_mask(), distort_mask(), distort_transform(), dt_cache_remove(), dt_control_save_xmps(), dt_dev_add_history_item_real(), dt_dev_free_history_item(), dt_dev_history_item_update_from_params(), dt_dev_pixelpipe_cache_return_cl_payload(), dt_dev_pixelpipe_gpu_flush_host_pinned_images(), dt_dev_pixelpipe_process(), dt_dev_toolbox_show_popup(), dt_develop_blendif_raw_blend(), dt_dlopencl_init(), dt_drawlayer_conf_sync_params_from_gui(), dt_drawlayer_worker_pause(), dt_drawlayer_worker_resume(), dt_drawlayer_worker_seal_for_commit(), dt_drawlayer_worker_wait_idle(), dt_gui_freeze_begin_(), dt_gui_preferences_show(), dt_image_read_duplicates(), dt_imageio_jpeg_decompress(), dt_imageio_jpeg_read(), dt_imageio_open_avif(), dt_imageio_open_j2k(), dt_imageio_open_jpeg(), dt_imageio_open_png(), dt_imageio_open_rawspeed(), dt_imageio_open_tiff(), dt_init(), dt_iop_alloc_image_buffers(), dt_iop_set_mask_mode(), dt_masks_release_all_forms(), dt_memory_pressure_read_full_stall(), dt_memory_pressure_watch_levels(), dt_memory_pressure_watch_start(), dt_opencl_events_get_slot(), dt_opencl_note_crash_backtrace(), dt_set_signal_handlers(), G_GNUC_PRINTF(), gui_init(), gui_init(), icuLoadCollation(), icuRegexpFunc(), if(), init(), init_pipe(), key_released(), key_swap_callback(), lens_comboentry_aperture_update(), lens_comboentry_distance_update(), lens_comboentry_focal_update(), lens_menusearch_clicked(), line_detect(), modify_roi_in(), modify_roi_in(), process(), process(), process(), process(), process_cl(), process_harmonic(), process_laplacian(), process_nlmeans_cl(), read_image(), reduce_2D_Bspline(), runtime_data_hash(), sqlite3IcuInit(), test_batch_is_thread_count_independent(), test_batch_matches_serial_erase(), test_batch_matches_serial_paint_capped(), test_batch_matches_serial_paint_dense(), test_batch_matches_serial_paint_sparse(), test_batch_matches_serial_sprinkles(), test_cached_entry_overwrites_a_row_written_behind_it(), test_channels_are_independent(), test_count_distinct_fields(), test_crawl_corrects_an_entry_the_row_already_agrees_with(), test_crawl_keeps_a_cached_entry_in_step(), test_crawl_reads_a_miscased_name_as_the_filesystem_does(), test_crawl_waits_for_a_held_entry(), test_editing_the_entry_survives_the_next_rating(), test_find_version_for_params(), test_flag_among_multi_image(), test_foreach_active_module(), test_foreach_with_path_stops_when_asked(), test_full_paths(), test_gate_refuses_non_uniform(), test_group_member_rows(), test_handler_can_be_removed(), test_history_item_cycle(), test_id_range(), test_kinds_stay_distinct(), test_list_all_carries_the_tree_row(), test_list_editable_excludes_shipped(), test_list_for_upgrade_returns_all_versions(), test_metadata_foreach_selected(), test_module_order_absent_vs_zero(), test_no_handler_is_silent(), test_refresh_exposes_new_hierarchical_tag(), test_report_batch_speedup(), test_selection_lowest_id(), test_set_flags_masked_leaves_other_bits(), test_set_module_version_leaves_params_alone(), test_tag_agreement(), test_tags_changed_fires_each_time(), test_testget_does_not_create_an_entry(), test_window_contained(), test_window_entirely_outside(), test_window_negative_offset(), test_window_single_pixel_source(), test_window_taller_than_source(), test_window_transposed_source(), test_window_wider_than_source(), test_write_timestamp_is_64bit(), testdb_setup(), testdb_teardown(), tiling_callback(), try_enter(), write_image(), write_image(), and write_pfm().