-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
pixelpipe_cache.c
487 lines (428 loc) · 16 KB
/
pixelpipe_cache.c
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
/*
This file is part of darktable,
Copyright (C) 2009-2023 darktable developers.
darktable 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.
darktable 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 darktable. If not, see <http://www.gnu.org/licenses/>.
*/
#include "develop/pixelpipe_cache.h"
#include "develop/format.h"
#include "develop/pixelpipe_hb.h"
#include "libs/lib.h"
#include "libs/colorpicker.h"
#include <stdlib.h>
#define INVALID_CACHEHASH 0
static inline int _to_mb(size_t m)
{
return (int)((m + 0x80000lu) / 0x400lu / 0x400lu);
}
gboolean dt_dev_pixelpipe_cache_init(
struct dt_dev_pixelpipe_t *pipe,
const int entries,
const size_t size,
const size_t limit)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
cache->entries = entries;
cache->allmem = cache->hits = cache->calls = cache->tests = 0;
cache->memlimit = limit;
const size_t csize = sizeof(void *) + sizeof(size_t) + sizeof(dt_iop_buffer_dsc_t) + 2*sizeof(int32_t) + sizeof(uint64_t);
cache->data = (void **) calloc(entries, csize);
cache->size = (size_t *)((void *)cache->data + entries * sizeof(void *));
cache->dsc = (dt_iop_buffer_dsc_t *)((void *)cache->size + entries * sizeof(size_t));
cache->hash = (dt_hash_t *)((void *)cache->dsc + entries * sizeof(dt_iop_buffer_dsc_t));
cache->used = (int32_t *)((void *)cache->hash + entries * sizeof(dt_hash_t));
cache->ioporder = (int32_t *)((void *)cache->used + entries * sizeof(int32_t));
for(int k = 0; k < entries; k++)
{
cache->hash[k] = INVALID_CACHEHASH;
cache->used[k] = 64 + k;
}
if(!size) return TRUE;
// some pixelpipes use preallocated cachelines, following code is special for those
for(int k = 0; k < entries; k++)
{
cache->size[k] = size;
cache->data[k] = (void *)dt_alloc_aligned(size);
if(!cache->data[k])
goto alloc_memory_fail;
cache->allmem += size;
}
return TRUE;
alloc_memory_fail:
// Make sure all cachelines are cleared.
// A warning about low memory will appear but the pipeline still has valid data so dt won't crash
// but will only fail to generate thumbnails for example.
for(int k = 0; k < cache->entries; k++)
{
dt_free_align(cache->data[k]);
cache->size[k] = 0;
cache->data[k] = NULL;
}
cache->allmem = 0;
return FALSE;
}
void dt_dev_pixelpipe_cache_cleanup(struct dt_dev_pixelpipe_t *pipe)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
if(pipe->type == DT_DEV_PIXELPIPE_FULL)
{
dt_print(DT_DEBUG_PIPE, "Session fullpipe cache report. hits/run=%.2f, hits/test=%.3f\n",
(double)(cache->hits) / fmax(1.0, pipe->runs),
(double)(cache->hits) / fmax(1.0, cache->tests));
}
for(int k = 0; k < cache->entries; k++)
{
dt_free_align(cache->data[k]);
cache->data[k] = NULL;
}
free(cache->data);
cache->data = NULL;
}
static dt_hash_t _dev_pixelpipe_cache_basichash(
const dt_imgid_t imgid,
struct dt_dev_pixelpipe_t *pipe,
const int position)
{
/* What do we use for the basic hash
1) imgid as all structures using the hash might possibly contain data from other images
2) pipe->type for the cache it's important to keep status of fast mode included here
also, we might use the hash also for different pipe.
3) pipe->want_detail_mask make sure old cachelines from before activating details are
not valid any more.
Do we have to keep the roi of details mask? No as that is always defined by roi_in
of the mask writing module (rawprepare or demosaic)
*/
const uint32_t hashing_pipemode[3] = {(uint32_t)imgid,
(uint32_t)pipe->type,
(uint32_t)pipe->want_detail_mask };
dt_hash_t hash = dt_hash(DT_INITHASH, &hashing_pipemode, sizeof(hashing_pipemode));
// go through all modules up to position and compute a hash using the operation and params.
GList *pieces = pipe->nodes;
for(int k = 0; k < position && pieces; k++)
{
dt_dev_pixelpipe_iop_t *piece = (dt_dev_pixelpipe_iop_t *)pieces->data;
dt_develop_t *dev = piece->module->dev;
// don't take skipped modules into account
const gboolean skipped = dt_iop_module_is_skipped(dev, piece->module)
&& (pipe->type & DT_DEV_PIXELPIPE_BASIC);
if(!skipped)
{
hash = dt_hash(hash, &piece->hash, sizeof(piece->hash));
if(piece->module->request_color_pick != DT_REQUEST_COLORPICK_OFF)
{
if(darktable.lib->proxy.colorpicker.primary_sample->size == DT_LIB_COLORPICKER_SIZE_BOX)
{
hash = dt_hash(hash, darktable.lib->proxy.colorpicker.primary_sample->box, 4 * sizeof(float));
}
else if(darktable.lib->proxy.colorpicker.primary_sample->size == DT_LIB_COLORPICKER_SIZE_POINT)
{
hash = dt_hash(hash, darktable.lib->proxy.colorpicker.primary_sample->point, 2 * sizeof(float));
}
}
}
pieces = g_list_next(pieces);
}
return hash;
}
dt_hash_t dt_dev_pixelpipe_cache_hash(
const dt_imgid_t imgid,
const dt_iop_roi_t *roi,
struct dt_dev_pixelpipe_t *pipe,
const int position)
{
dt_hash_t hash = _dev_pixelpipe_cache_basichash(imgid, pipe, position);
// also include roi data
// FIXME include full roi data in cachelines
hash = dt_hash(hash, roi, sizeof(dt_iop_roi_t));
return dt_hash(hash, &pipe->scharr.hash, sizeof(pipe->scharr.hash));
}
gboolean dt_dev_pixelpipe_cache_available(
dt_dev_pixelpipe_t *pipe,
const dt_hash_t hash,
const size_t size)
{
if(pipe->mask_display
|| pipe->nocache
|| (hash == INVALID_CACHEHASH))
return FALSE;
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
cache->tests++;
// search for hash in cache and make the sizes are identical
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if((cache->size[k] == size) && (cache->hash[k] == hash))
{
cache->hits++;
return TRUE;
}
}
return FALSE;
}
// While looking for the oldest cacheline we always ignore the first two lines as they are used
// for swapping buffers while in entries==DT_PIPECACHE_MIN or masking mode
static int _get_oldest_cacheline(dt_dev_pixelpipe_cache_t *cache,
dt_dev_pixelpipe_cache_test_t mode)
{
// we never want the latest used cacheline! It was <= 0 and the weight has increased just now
int age = 1;
int id = 0;
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
gboolean older = (cache->used[k] > age) && (k != cache->lastline);
if(older)
{
if(mode == DT_CACHETEST_USED) older = cache->data[k] != NULL;
else if(mode == DT_CACHETEST_FREE) older = cache->data[k] == NULL;
else if(mode == DT_CACHETEST_INVALID) older = cache->hash[k] == INVALID_CACHEHASH;
if(older)
{
age = cache->used[k];
id = k;
}
}
}
return id;
}
static int __get_cacheline(struct dt_dev_pixelpipe_cache_t *cache)
{
int oldest = _get_oldest_cacheline(cache, DT_CACHETEST_INVALID);
if(oldest > 0) return oldest;
oldest = _get_oldest_cacheline(cache, DT_CACHETEST_FREE);
if(oldest > 0) return oldest;
oldest = _get_oldest_cacheline(cache, DT_CACHETEST_PLAIN);
return (oldest == 0) ? cache->calls & 1 : oldest;
}
static int _get_cacheline(struct dt_dev_pixelpipe_t *pipe)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
// If pipe has only two cachelines or we are in masking or nocache mode
// we just toggle between the first two cachelines.
// These are also taken if there is no valid cacheline returned
if((cache->entries == DT_PIPECACHE_MIN) || pipe->mask_display || pipe->nocache)
return cache->calls & 1;
cache->lastline = __get_cacheline(cache);
return cache->lastline;
}
// return TRUE in case of a hit
static gboolean _get_by_hash(
struct dt_dev_pixelpipe_t *pipe,
struct dt_iop_module_t *module,
const dt_hash_t hash,
const size_t size,
void **data,
dt_iop_buffer_dsc_t **dsc)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if(cache->hash[k] == hash)
{
if(cache->size[k] != size)
{
/* We check for situation with a hash identity but buffer sizes don't match.
This could happen because of "hash overlaps" or other situations where the hash
doesn't reflect the complete status.
Anyway this has to be accepted as a dt bug so we always report
*/
cache->hash[k] = INVALID_CACHEHASH;
dt_print_pipe(DT_DEBUG_ALWAYS, "CACHELINE_SIZE ERROR",
pipe, module, DT_DEVICE_NONE, NULL, NULL, "\n");
}
else if(pipe->mask_display || pipe->nocache)
{
// this should not happen but we make sure
cache->hash[k] = INVALID_CACHEHASH;
}
else
{
// we have a proper hit
*data = cache->data[k];
*dsc = &cache->dsc[k];
// in case of a hit it's always good to further keep the cacheline as important
cache->used[k] = -cache->entries;
return TRUE;
}
}
}
return FALSE;
}
gboolean dt_dev_pixelpipe_cache_get(
struct dt_dev_pixelpipe_t *pipe,
const dt_hash_t hash,
const size_t size,
void **data,
dt_iop_buffer_dsc_t **dsc,
struct dt_iop_module_t *module,
const gboolean important)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
cache->calls++;
for(int k = 0; k < cache->entries; k++)
cache->used[k]++; // age all entries
// cache keeps history and we have a cache hit, so no new buffer
if(cache->entries > DT_PIPECACHE_MIN
&& (hash != INVALID_CACHEHASH)
&& _get_by_hash(pipe, module, hash, size, data, dsc))
{
const dt_iop_buffer_dsc_t *cdsc = *dsc;
dt_print_pipe(DT_DEBUG_PIPE, "cache HIT",
pipe, module, DT_DEVICE_NONE, NULL, NULL,
"%s, hash=%" PRIx64 "\n",
dt_iop_colorspace_to_name(cdsc->cst), hash);
return FALSE;
}
// We need a fresh buffer as there was no hit.
//
// Pipes with two cache lines have pre-allocated memory, but we must
// grow storage if a later iop requires a larger buffer.
//
// Otherwise, get an old/free cacheline and allocate required size.
// Check both for free and non-matching (and grow or shrink buffer).
const int cline = _get_cacheline(pipe);
if(((cache->entries == DT_PIPECACHE_MIN) && (cache->size[cline] < size))
|| ((cache->entries > DT_PIPECACHE_MIN) && (cache->size[cline] != size)))
{
dt_free_align(cache->data[cline]);
cache->allmem -= cache->size[cline];
cache->data[cline] = (void *)dt_alloc_aligned(size);
if(cache->data[cline])
{
cache->size[cline] = size;
cache->allmem += size;
}
else
{
cache->size[cline] = 0;
}
}
*data = cache->data[cline];
// first, update our copy, then update the pointer to point at our copy
cache->dsc[cline] = **dsc;
*dsc = &cache->dsc[cline];
const gboolean masking = pipe->mask_display != DT_DEV_PIXELPIPE_DISPLAY_NONE;
cache->hash[cline] = masking ? INVALID_CACHEHASH : hash;
const dt_iop_buffer_dsc_t *cdsc = *dsc;
dt_print_pipe(DT_DEBUG_PIPE | DT_DEBUG_VERBOSE, "pipe cache get",
pipe, module, DT_DEVICE_NONE, NULL, NULL,
"%s %sline%3i(%2i) at %p. hash=%" PRIx64 "%s\n",
dt_iop_colorspace_to_name(cdsc->cst),
important ? "important " : "",
cline, cache->used[cline], cache->data[cline], cache->hash[cline],
masking ? ". masking." : "");
cache->used[cline] = !masking && important ? -cache->entries : 0;
cache->ioporder[cline] = module ? module->iop_order : 0;
return TRUE;
}
static void _mark_invalid_cacheline(const dt_dev_pixelpipe_cache_t *cache, const int k)
{
cache->hash[k] = INVALID_CACHEHASH;
cache->ioporder[k] = 0;
}
void dt_dev_pixelpipe_cache_invalidate_later(
const struct dt_dev_pixelpipe_t *pipe,
const int32_t order)
{
const dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if((cache->ioporder[k] >= order) && (cache->hash[k] != INVALID_CACHEHASH))
_mark_invalid_cacheline(cache, k);
}
}
void dt_dev_pixelpipe_cache_flush(const struct dt_dev_pixelpipe_t *pipe)
{
dt_dev_pixelpipe_cache_invalidate_later(pipe, 0);
}
void dt_dev_pixelpipe_important_cacheline(
const struct dt_dev_pixelpipe_t *pipe,
const void *data,
const size_t size)
{
const dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if((cache->data[k] == data)
&& (size == cache->size[k])
&& (cache->hash[k] != INVALID_CACHEHASH))
cache->used[k] = -cache->entries;
}
}
void dt_dev_pixelpipe_invalidate_cacheline(const struct dt_dev_pixelpipe_t *pipe,
const void *data)
{
const dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if(cache->data[k] == data) _mark_invalid_cacheline(cache, k);
}
}
static size_t _free_cacheline(dt_dev_pixelpipe_cache_t *cache, const int k)
{
const size_t removed = cache->size[k];
dt_free_align(cache->data[k]);
cache->allmem -= removed;
cache->size[k] = 0;
cache->data[k] = NULL;
_mark_invalid_cacheline(cache, k);
return removed;
}
static void _cline_stats(dt_dev_pixelpipe_cache_t *cache)
{
cache->lused = cache->linvalid = cache->limportant = 0;
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if(cache->data[k] != NULL) cache->lused++;
if((cache->data[k] != NULL) && (cache->hash[k] == INVALID_CACHEHASH)) cache->linvalid++;
if(cache->used[k] < 0) cache->limportant++;
}
}
void dt_dev_pixelpipe_cache_checkmem(struct dt_dev_pixelpipe_t *pipe)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
// we have pixelpipes like export & thumbnail that just use
// alternating buffers so no cleanup
if(cache->entries == DT_PIPECACHE_MIN) return;
// We always free cachelines maked as not valid
size_t freed = 0;
for(int k = DT_PIPECACHE_MIN; k < cache->entries; k++)
{
if((cache->hash[k] == INVALID_CACHEHASH) && cache->data)
freed += _free_cacheline(cache, k);
}
while(cache->memlimit && (cache->memlimit < cache->allmem))
{
const int k = _get_oldest_cacheline(cache, DT_CACHETEST_USED);
if(k == 0) break;
freed += _free_cacheline(cache, k);
}
_cline_stats(cache);
dt_print_pipe(DT_DEBUG_PIPE, "pipe cache check", pipe, NULL, DT_DEVICE_NONE, NULL, NULL,
"%i lines (important=%i, used=%i). Freed %iMB. Using using %iMB, limit=%iMB\n",
cache->entries, cache->limportant, cache->lused,
_to_mb(freed), _to_mb(cache->allmem), _to_mb(cache->memlimit));
}
void dt_dev_pixelpipe_cache_report(struct dt_dev_pixelpipe_t *pipe)
{
dt_dev_pixelpipe_cache_t *cache = &(pipe->cache);
_cline_stats(cache);
dt_print_pipe(DT_DEBUG_PIPE, "cache report", pipe, NULL, DT_DEVICE_NONE, NULL, NULL,
"%i lines (important=%i, used=%i, invalid=%i). Using %iMB, limit=%iMB. Hits/run=%.2f. Hits/test=%.3f\n",
cache->entries, cache->limportant, cache->lused, cache->linvalid,
_to_mb(cache->allmem), _to_mb(cache->memlimit),
(double)(cache->hits) / fmax(1.0, pipe->runs),
(double)(cache->hits) / fmax(1.0, cache->tests));
}
#undef INVALID_CACHEHASH
// 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