FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavcodec/refstruct.c
Date: 2024-05-03 15:42:48
Exec Total Coverage
Lines: 150 163 92.0%
Functions: 20 20 100.0%
Branches: 46 58 79.3%
Line Branch Exec Source
1 /*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #include <stdatomic.h>
20 #include <stdint.h>
21 #include <string.h>
22
23 #include "refstruct.h"
24
25 #include "libavutil/avassert.h"
26 #include "libavutil/error.h"
27 #include "libavutil/macros.h"
28 #include "libavutil/mem.h"
29 #include "libavutil/mem_internal.h"
30 #include "libavutil/thread.h"
31
32 #ifndef REFSTRUCT_CHECKED
33 #ifndef ASSERT_LEVEL
34 #define ASSERT_LEVEL 0
35 #endif
36 #define REFSTRUCT_CHECKED (ASSERT_LEVEL >= 1)
37 #endif
38
39 #if REFSTRUCT_CHECKED
40 #define ff_assert(cond) av_assert0(cond)
41 #else
42 #define ff_assert(cond) ((void)0)
43 #endif
44
45 #define REFSTRUCT_COOKIE AV_NE((uint64_t)MKBETAG('R', 'e', 'f', 'S') << 32 | MKBETAG('t', 'r', 'u', 'c'), \
46 MKTAG('R', 'e', 'f', 'S') | (uint64_t)MKTAG('t', 'r', 'u', 'c') << 32)
47
48 #if __STDC_VERSION__ >= 201112L && !defined(_MSC_VER)
49 #define REFCOUNT_OFFSET FFALIGN(sizeof(RefCount), FFMAX(ALIGN_64, _Alignof(max_align_t)))
50 #else
51 #define REFCOUNT_OFFSET FFALIGN(sizeof(RefCount), ALIGN_64)
52 #endif
53
54 typedef struct RefCount {
55 /**
56 * An uintptr_t is big enough to hold the address of every reference,
57 * so no overflow can happen when incrementing the refcount as long as
58 * the user does not throw away references.
59 */
60 atomic_uintptr_t refcount;
61 FFRefStructOpaque opaque;
62 void (*free_cb)(FFRefStructOpaque opaque, void *obj);
63 void (*free)(void *ref);
64
65 #if REFSTRUCT_CHECKED
66 uint64_t cookie;
67 #endif
68 } RefCount;
69
70 3114049 static RefCount *get_refcount(void *obj)
71 {
72 3114049 RefCount *ref = (RefCount*)((char*)obj - REFCOUNT_OFFSET);
73 ff_assert(ref->cookie == REFSTRUCT_COOKIE);
74 3114049 return ref;
75 }
76
77 307 static const RefCount *cget_refcount(const void *obj)
78 {
79 307 const RefCount *ref = (const RefCount*)((const char*)obj - REFCOUNT_OFFSET);
80 ff_assert(ref->cookie == REFSTRUCT_COOKIE);
81 307 return ref;
82 }
83
84 2349440 static void *get_userdata(void *buf)
85 {
86 2349440 return (char*)buf + REFCOUNT_OFFSET;
87 }
88
89 214140 static void refcount_init(RefCount *ref, FFRefStructOpaque opaque,
90 void (*free_cb)(FFRefStructOpaque opaque, void *obj))
91 {
92 214140 atomic_init(&ref->refcount, 1);
93 214140 ref->opaque = opaque;
94 214140 ref->free_cb = free_cb;
95 214140 ref->free = av_free;
96
97 #if REFSTRUCT_CHECKED
98 ref->cookie = REFSTRUCT_COOKIE;
99 #endif
100 214140 }
101
102 214140 void *ff_refstruct_alloc_ext_c(size_t size, unsigned flags, FFRefStructOpaque opaque,
103 void (*free_cb)(FFRefStructOpaque opaque, void *obj))
104 {
105 void *buf, *obj;
106
107
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 214140 times.
 214140 if (size > SIZE_MAX - REFCOUNT_OFFSET)
108 ✗ return NULL;
109 214140 buf = av_malloc(size + REFCOUNT_OFFSET);
110
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 214140 times.
 214140 if (!buf)
111 ✗ return NULL;
112 214140 refcount_init(buf, opaque, free_cb);
113 214140 obj = get_userdata(buf);
114
2/2
✓ Branch 0 taken 207279 times.
✓ Branch 1 taken 6861 times.
 214140 if (!(flags & FF_REFSTRUCT_FLAG_NO_ZEROING))
115 207279 memset(obj, 0, size);
116
117 214140 return obj;
118 }
119
120 6697190 void ff_refstruct_unref(void *objp)
121 {
122 void *obj;
123 RefCount *ref;
124
125 6697190 memcpy(&obj, objp, sizeof(obj));
126
2/2
✓ Branch 0 taken 4029881 times.
✓ Branch 1 taken 2667309 times.
 6697190 if (!obj)
127 4029881 return;
128 2667309 memcpy(objp, &(void *){ NULL }, sizeof(obj));
129
130 2667309 ref = get_refcount(obj);
131
2/2
✓ Branch 0 taken 2340775 times.
✓ Branch 1 taken 326534 times.
 2667309 if (atomic_fetch_sub_explicit(&ref->refcount, 1, memory_order_acq_rel) == 1) {
132
2/2
✓ Branch 0 taken 101491 times.
✓ Branch 1 taken 2239284 times.
 2340775 if (ref->free_cb)
133 101491 ref->free_cb(ref->opaque, obj);
134 2340775 ref->free(ref);
135 }
136
137 2667309 return;
138 }
139
140 40503 void *ff_refstruct_ref(void *obj)
141 {
142 40503 RefCount *ref = get_refcount(obj);
143
144 40503 atomic_fetch_add_explicit(&ref->refcount, 1, memory_order_relaxed);
145
146 40503 return obj;
147 }
148
149 286031 const void *ff_refstruct_ref_c(const void *obj)
150 {
151 /* Casting const away here is fine, as it is only supposed
152 * to apply to the user's data and not our bookkeeping data. */
153 286031 RefCount *ref = get_refcount((void*)obj);
154
155 286031 atomic_fetch_add_explicit(&ref->refcount, 1, memory_order_relaxed);
156
157 286031 return obj;
158 }
159
160 442361 void ff_refstruct_replace(void *dstp, const void *src)
161 {
162 const void *dst;
163 442361 memcpy(&dst, dstp, sizeof(dst));
164
165
2/2
✓ Branch 0 taken 197075 times.
✓ Branch 1 taken 245286 times.
 442361 if (src == dst)
166 197075 return;
167 245286 ff_refstruct_unref(dstp);
168
1/2
✓ Branch 0 taken 245286 times.
✗ Branch 1 not taken.
 245286 if (src) {
169 245286 dst = ff_refstruct_ref_c(src);
170 245286 memcpy(dstp, &dst, sizeof(dst));
171 }
172 }
173
174 307 int ff_refstruct_exclusive(const void *obj)
175 {
176 307 const RefCount *ref = cget_refcount(obj);
177 /* Casting const away here is safe, because it is a load.
178 * It is necessary because atomic_load_explicit() does not
179 * accept const atomics in C11 (see also N1807). */
180 307 return atomic_load_explicit((atomic_uintptr_t*)&ref->refcount, memory_order_acquire) == 1;
181 }
182
183 struct FFRefStructPool {
184 size_t size;
185 FFRefStructOpaque opaque;
186 int (*init_cb)(FFRefStructOpaque opaque, void *obj);
187 void (*reset_cb)(FFRefStructOpaque opaque, void *obj);
188 void (*free_entry_cb)(FFRefStructOpaque opaque, void *obj);
189 void (*free_cb)(FFRefStructOpaque opaque);
190
191 int uninited;
192 unsigned entry_flags;
193 unsigned pool_flags;
194
195 /** The number of outstanding entries not in available_entries. */
196 atomic_uintptr_t refcount;
197 /**
198 * This is a linked list of available entries;
199 * the RefCount's opaque pointer is used as next pointer
200 * for available entries.
201 * While the entries are in use, the opaque is a pointer
202 * to the corresponding FFRefStructPool.
203 */
204 RefCount *available_entries;
205 AVMutex mutex;
206 };
207
208 6148 static void pool_free(FFRefStructPool *pool)
209 {
210 6148 ff_mutex_destroy(&pool->mutex);
211
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6148 times.
 6148 if (pool->free_cb)
212 ✗ pool->free_cb(pool->opaque);
213 6148 av_free(get_refcount(pool));
214 6148 }
215
216 107910 static void pool_free_entry(FFRefStructPool *pool, RefCount *ref)
217 {
218
2/2
✓ Branch 0 taken 2517 times.
✓ Branch 1 taken 105393 times.
 107910 if (pool->free_entry_cb)
219 2517 pool->free_entry_cb(pool->opaque, get_userdata(ref));
220 107910 av_free(ref);
221 107910 }
222
223 2234545 static void pool_return_entry(void *ref_)
224 {
225 2234545 RefCount *ref = ref_;
226 2234545 FFRefStructPool *pool = ref->opaque.nc;
227
228 2234545 ff_mutex_lock(&pool->mutex);
229
2/2
✓ Branch 0 taken 2219690 times.
✓ Branch 1 taken 14855 times.
 2234545 if (!pool->uninited) {
230 2219690 ref->opaque.nc = pool->available_entries;
231 2219690 pool->available_entries = ref;
232 2219690 ref = NULL;
233 }
234 2234545 ff_mutex_unlock(&pool->mutex);
235
236
2/2
✓ Branch 0 taken 14855 times.
✓ Branch 1 taken 2219690 times.
 2234545 if (ref)
237 14855 pool_free_entry(pool, ref);
238
239
2/2
✓ Branch 0 taken 3349 times.
✓ Branch 1 taken 2231196 times.
 2234545 if (atomic_fetch_sub_explicit(&pool->refcount, 1, memory_order_acq_rel) == 1)
240 3349 pool_free(pool);
241 2234545 }
242
243 15658 static void pool_reset_entry(FFRefStructOpaque opaque, void *entry)
244 {
245 15658 FFRefStructPool *pool = opaque.nc;
246
247 15658 pool->reset_cb(pool->opaque, entry);
248 15658 }
249
250 2234545 static int refstruct_pool_get_ext(void *datap, FFRefStructPool *pool)
251 {
252 2234545 void *ret = NULL;
253
254 2234545 memcpy(datap, &(void *){ NULL }, sizeof(void*));
255
256 2234545 ff_mutex_lock(&pool->mutex);
257 ff_assert(!pool->uninited);
258
2/2
✓ Branch 0 taken 2126635 times.
✓ Branch 1 taken 107910 times.
 2234545 if (pool->available_entries) {
259 2126635 RefCount *ref = pool->available_entries;
260 2126635 ret = get_userdata(ref);
261 2126635 pool->available_entries = ref->opaque.nc;
262 2126635 ref->opaque.nc = pool;
263 2126635 atomic_init(&ref->refcount, 1);
264 }
265 2234545 ff_mutex_unlock(&pool->mutex);
266
267
2/2
✓ Branch 0 taken 107910 times.
✓ Branch 1 taken 2126635 times.
 2234545 if (!ret) {
268 RefCount *ref;
269 107910 ret = ff_refstruct_alloc_ext(pool->size, pool->entry_flags, pool,
270
2/2
✓ Branch 0 taken 2517 times.
✓ Branch 1 taken 105393 times.
 107910 pool->reset_cb ? pool_reset_entry : NULL);
271
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 107910 times.
 107910 if (!ret)
272 ✗ return AVERROR(ENOMEM);
273 107910 ref = get_refcount(ret);
274 107910 ref->free = pool_return_entry;
275
2/2
✓ Branch 0 taken 2517 times.
✓ Branch 1 taken 105393 times.
 107910 if (pool->init_cb) {
276 2517 int err = pool->init_cb(pool->opaque, ret);
277
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 2517 times.
 2517 if (err < 0) {
278 ✗ if (pool->pool_flags & FF_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR)
279 ✗ pool->reset_cb(pool->opaque, ret);
280 ✗ if (pool->pool_flags & FF_REFSTRUCT_POOL_FLAG_FREE_ON_INIT_ERROR)
281 ✗ pool->free_entry_cb(pool->opaque, ret);
282 ✗ av_free(ref);
283 ✗ return err;
284 }
285 }
286 }
287 2234545 atomic_fetch_add_explicit(&pool->refcount, 1, memory_order_relaxed);
288
289
2/2
✓ Branch 0 taken 3181 times.
✓ Branch 1 taken 2231364 times.
 2234545 if (pool->pool_flags & FF_REFSTRUCT_POOL_FLAG_ZERO_EVERY_TIME)
290 3181 memset(ret, 0, pool->size);
291
292 2234545 memcpy(datap, &ret, sizeof(ret));
293
294 2234545 return 0;
295 }
296
297 2234545 void *ff_refstruct_pool_get(FFRefStructPool *pool)
298 {
299 void *ret;
300 2234545 refstruct_pool_get_ext(&ret, pool);
301 2234545 return ret;
302 }
303
304 /**
305 * Hint: The content of pool_unref() and refstruct_pool_uninit()
306 * could currently be merged; they are only separate functions
307 * in case we would ever introduce weak references.
308 */
309 6148 static void pool_unref(void *ref)
310 {
311 6148 FFRefStructPool *pool = get_userdata(ref);
312
2/2
✓ Branch 0 taken 2799 times.
✓ Branch 1 taken 3349 times.
 6148 if (atomic_fetch_sub_explicit(&pool->refcount, 1, memory_order_acq_rel) == 1)
313 2799 pool_free(pool);
314 6148 }
315
316 6148 static void refstruct_pool_uninit(FFRefStructOpaque unused, void *obj)
317 {
318 6148 FFRefStructPool *pool = obj;
319 RefCount *entry;
320
321 6148 ff_mutex_lock(&pool->mutex);
322 ff_assert(!pool->uninited);
323 6148 pool->uninited = 1;
324 6148 entry = pool->available_entries;
325 6148 pool->available_entries = NULL;
326 6148 ff_mutex_unlock(&pool->mutex);
327
328
2/2
✓ Branch 0 taken 93055 times.
✓ Branch 1 taken 6148 times.
 99203 while (entry) {
329 93055 void *next = entry->opaque.nc;
330 93055 pool_free_entry(pool, entry);
331 93055 entry = next;
332 }
333 6148 }
334
335 4878 FFRefStructPool *ff_refstruct_pool_alloc(size_t size, unsigned flags)
336 {
337 4878 return ff_refstruct_pool_alloc_ext(size, flags, NULL, NULL, NULL, NULL, NULL);
338 }
339
340 6148 FFRefStructPool *ff_refstruct_pool_alloc_ext_c(size_t size, unsigned flags,
341 FFRefStructOpaque opaque,
342 int (*init_cb)(FFRefStructOpaque opaque, void *obj),
343 void (*reset_cb)(FFRefStructOpaque opaque, void *obj),
344 void (*free_entry_cb)(FFRefStructOpaque opaque, void *obj),
345 void (*free_cb)(FFRefStructOpaque opaque))
346 {
347 6148 FFRefStructPool *pool = ff_refstruct_alloc_ext(sizeof(*pool), 0, NULL,
348 refstruct_pool_uninit);
349 int err;
350
351
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6148 times.
 6148 if (!pool)
352 ✗ return NULL;
353 6148 get_refcount(pool)->free = pool_unref;
354
355 6148 pool->size = size;
356 6148 pool->opaque = opaque;
357 6148 pool->init_cb = init_cb;
358 6148 pool->reset_cb = reset_cb;
359 6148 pool->free_entry_cb = free_entry_cb;
360 6148 pool->free_cb = free_cb;
361 #define COMMON_FLAGS FF_REFSTRUCT_POOL_FLAG_NO_ZEROING
362 6148 pool->entry_flags = flags & COMMON_FLAGS;
363 // Filter out nonsense combinations to avoid checks later.
364
2/2
✓ Branch 0 taken 4878 times.
✓ Branch 1 taken 1270 times.
 6148 if (!pool->reset_cb)
365 4878 flags &= ~FF_REFSTRUCT_POOL_FLAG_RESET_ON_INIT_ERROR;
366
2/2
✓ Branch 0 taken 4878 times.
✓ Branch 1 taken 1270 times.
 6148 if (!pool->free_entry_cb)
367 4878 flags &= ~FF_REFSTRUCT_POOL_FLAG_FREE_ON_INIT_ERROR;
368 6148 pool->pool_flags = flags;
369
370
2/2
✓ Branch 0 taken 682 times.
✓ Branch 1 taken 5466 times.
 6148 if (flags & FF_REFSTRUCT_POOL_FLAG_ZERO_EVERY_TIME) {
371 // We will zero the buffer before every use, so zeroing
372 // upon allocating the buffer is unnecessary.
373 682 pool->entry_flags |= FF_REFSTRUCT_FLAG_NO_ZEROING;
374 }
375
376 6148 atomic_init(&pool->refcount, 1);
377
378 6148 err = ff_mutex_init(&pool->mutex, NULL);
379
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 6148 times.
 6148 if (err) {
380 // Don't call ff_refstruct_uninit() on pool, as it hasn't been properly
381 // set up and is just a POD right now.
382 ✗ av_free(get_refcount(pool));
383 ✗ return NULL;
384 }
385 6148 return pool;
386 }
387