FFmpeg coverage

Directory: ../../../ffmpeg/
File: src/libavutil/slicethread.c
Date: 2025-06-23 20:06:14
Exec Total Coverage
Lines: 112 136 82.4%
Functions: 5 5 100.0%
Branches: 41 66 62.1%
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 "cpu.h"
21 #include "internal.h"
22 #include "slicethread.h"
23 #include "mem.h"
24 #include "thread.h"
25 #include "avassert.h"
26
27 #define MAX_AUTO_THREADS 16
28
29 #if HAVE_PTHREADS || HAVE_W32THREADS || HAVE_OS2THREADS
30
31 typedef struct WorkerContext {
32 AVSliceThread *ctx;
33 pthread_mutex_t mutex;
34 pthread_cond_t cond;
35 pthread_t thread;
36 int done;
37 } WorkerContext;
38
39 struct AVSliceThread {
40 WorkerContext *workers;
41 int nb_threads;
42 int nb_active_threads;
43 int nb_jobs;
44
45 atomic_uint first_job;
46 atomic_uint current_job;
47 pthread_mutex_t done_mutex;
48 pthread_cond_t done_cond;
49 int done;
50 int finished;
51
52 void *priv;
53 void (*worker_func)(void *priv, int jobnr, int threadnr, int nb_jobs, int nb_threads);
54 void (*main_func)(void *priv);
55 };
56
57 667640 static int run_jobs(AVSliceThread *ctx)
58 {
59 667640 unsigned nb_jobs = ctx->nb_jobs;
60 667640 unsigned nb_active_threads = ctx->nb_active_threads;
61 667640 unsigned first_job = atomic_fetch_add_explicit(&ctx->first_job, 1, memory_order_acq_rel);
62 667640 unsigned current_job = first_job;
63
64 do {
65 667640 ctx->worker_func(ctx->priv, current_job, first_job, nb_jobs, nb_active_threads);
66
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 667640 times.
 667640 } while ((current_job = atomic_fetch_add_explicit(&ctx->current_job, 1, memory_order_acq_rel)) < nb_jobs);
67
68 667640 return current_job == nb_jobs + nb_active_threads - 1;
69 }
70
71 49863 static void *attribute_align_arg thread_worker(void *v)
72 {
73 49863 WorkerContext *w = v;
74 49863 AVSliceThread *ctx = w->ctx;
75
76 49863 pthread_mutex_lock(&w->mutex);
77 49863 pthread_cond_signal(&w->cond);
78
79 while (1) {
80 610652 w->done = 1;
81
2/2
✓ Branch 0 taken 610652 times.
✓ Branch 1 taken 610652 times.
 1221304 while (w->done)
82 610652 pthread_cond_wait(&w->cond, &w->mutex);
83
84
2/2
✓ Branch 0 taken 49863 times.
✓ Branch 1 taken 560789 times.
 610652 if (ctx->finished) {
85 49863 pthread_mutex_unlock(&w->mutex);
86 49863 return NULL;
87 }
88
89
2/2
✓ Branch 1 taken 67672 times.
✓ Branch 2 taken 493117 times.
 560789 if (run_jobs(ctx)) {
90 67672 pthread_mutex_lock(&ctx->done_mutex);
91 67672 ctx->done = 1;
92 67672 pthread_cond_signal(&ctx->done_cond);
93 67672 pthread_mutex_unlock(&ctx->done_mutex);
94 }
95 }
96 }
97
98 av_cold
99 9941 int avpriv_slicethread_create(AVSliceThread **pctx, void *priv,
100 void (*worker_func)(void *priv, int jobnr, int threadnr, int nb_jobs, int nb_threads),
101 void (*main_func)(void *priv),
102 int nb_threads)
103 {
104 AVSliceThread *ctx;
105 int nb_workers, i;
106 int ret;
107
108
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9941 times.
 9941 av_assert0(nb_threads >= 0);
109
2/2
✓ Branch 0 taken 3730 times.
✓ Branch 1 taken 6211 times.
 9941 if (!nb_threads) {
110 3730 int nb_cpus = av_cpu_count();
111
1/2
✓ Branch 0 taken 3730 times.
✗ Branch 1 not taken.
 3730 if (nb_cpus > 1)
112 3730 nb_threads = FFMIN(nb_cpus + 1, MAX_AUTO_THREADS);
113 else
114 ✗ nb_threads = 1;
115 }
116
117 9941 nb_workers = nb_threads;
118
1/2
✓ Branch 0 taken 9941 times.
✗ Branch 1 not taken.
 9941 if (!main_func)
119 9941 nb_workers--;
120
121 9941 *pctx = ctx = av_mallocz(sizeof(*ctx));
122
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9941 times.
 9941 if (!ctx)
123 ✗ return AVERROR(ENOMEM);
124
125
3/4
✓ Branch 0 taken 6265 times.
✓ Branch 1 taken 3676 times.
✗ Branch 3 not taken.
✓ Branch 4 taken 6265 times.
 9941 if (nb_workers && !(ctx->workers = av_calloc(nb_workers, sizeof(*ctx->workers)))) {
126 ✗ av_freep(pctx);
127 ✗ return AVERROR(ENOMEM);
128 }
129
130 9941 ctx->priv = priv;
131 9941 ctx->worker_func = worker_func;
132 9941 ctx->main_func = main_func;
133 9941 ctx->nb_threads = nb_threads;
134 9941 ctx->nb_active_threads = 0;
135 9941 ctx->nb_jobs = 0;
136 9941 ctx->finished = 0;
137
138 9941 atomic_init(&ctx->first_job, 0);
139 9941 atomic_init(&ctx->current_job, 0);
140 9941 ret = pthread_mutex_init(&ctx->done_mutex, NULL);
141
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9941 times.
 9941 if (ret) {
142 ✗ av_freep(&ctx->workers);
143 ✗ av_freep(pctx);
144 ✗ return AVERROR(ret);
145 }
146 9941 ret = pthread_cond_init(&ctx->done_cond, NULL);
147
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 9941 times.
 9941 if (ret) {
148 ✗ ctx->nb_threads = main_func ? 0 : 1;
149 ✗ avpriv_slicethread_free(pctx);
150 ✗ return AVERROR(ret);
151 }
152 9941 ctx->done = 0;
153
154
2/2
✓ Branch 0 taken 49863 times.
✓ Branch 1 taken 9941 times.
 59804 for (i = 0; i < nb_workers; i++) {
155 49863 WorkerContext *w = &ctx->workers[i];
156 int ret;
157 49863 w->ctx = ctx;
158 49863 ret = pthread_mutex_init(&w->mutex, NULL);
159
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 49863 times.
 49863 if (ret) {
160 ✗ ctx->nb_threads = main_func ? i : i + 1;
161 ✗ avpriv_slicethread_free(pctx);
162 ✗ return AVERROR(ret);
163 }
164 49863 ret = pthread_cond_init(&w->cond, NULL);
165
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 49863 times.
 49863 if (ret) {
166 ✗ pthread_mutex_destroy(&w->mutex);
167 ✗ ctx->nb_threads = main_func ? i : i + 1;
168 ✗ avpriv_slicethread_free(pctx);
169 ✗ return AVERROR(ret);
170 }
171 49863 pthread_mutex_lock(&w->mutex);
172 49863 w->done = 0;
173
174
1/2
✗ Branch 1 not taken.
✓ Branch 2 taken 49863 times.
 49863 if (ret = pthread_create(&w->thread, NULL, thread_worker, w)) {
175 ✗ ctx->nb_threads = main_func ? i : i + 1;
176 ✗ pthread_mutex_unlock(&w->mutex);
177 ✗ pthread_cond_destroy(&w->cond);
178 ✗ pthread_mutex_destroy(&w->mutex);
179 ✗ avpriv_slicethread_free(pctx);
180 ✗ return AVERROR(ret);
181 }
182
183
2/2
✓ Branch 0 taken 49863 times.
✓ Branch 1 taken 49863 times.
 99726 while (!w->done)
184 49863 pthread_cond_wait(&w->cond, &w->mutex);
185 49863 pthread_mutex_unlock(&w->mutex);
186 }
187
188 9941 return nb_threads;
189 }
190
191 106851 void avpriv_slicethread_execute(AVSliceThread *ctx, int nb_jobs, int execute_main)
192 {
193 106851 int nb_workers, i, is_last = 0;
194
195
1/2
✗ Branch 0 not taken.
✓ Branch 1 taken 106851 times.
 106851 av_assert0(nb_jobs > 0);
196 106851 ctx->nb_jobs = nb_jobs;
197 106851 ctx->nb_active_threads = FFMIN(nb_jobs, ctx->nb_threads);
198 106851 atomic_store_explicit(&ctx->first_job, 0, memory_order_relaxed);
199 106851 atomic_store_explicit(&ctx->current_job, ctx->nb_active_threads, memory_order_relaxed);
200 106851 nb_workers = ctx->nb_active_threads;
201
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 106851 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 106851 if (!ctx->main_func || !execute_main)
202 106851 nb_workers--;
203
204
2/2
✓ Branch 0 taken 560789 times.
✓ Branch 1 taken 106851 times.
 667640 for (i = 0; i < nb_workers; i++) {
205 560789 WorkerContext *w = &ctx->workers[i];
206 560789 pthread_mutex_lock(&w->mutex);
207 560789 w->done = 0;
208 560789 pthread_cond_signal(&w->cond);
209 560789 pthread_mutex_unlock(&w->mutex);
210 }
211
212
1/4
✗ Branch 0 not taken.
✓ Branch 1 taken 106851 times.
✗ Branch 2 not taken.
✗ Branch 3 not taken.
 106851 if (ctx->main_func && execute_main)
213 ✗ ctx->main_func(ctx->priv);
214 else
215 106851 is_last = run_jobs(ctx);
216
217
2/2
✓ Branch 0 taken 67672 times.
✓ Branch 1 taken 39179 times.
 106851 if (!is_last) {
218 67672 pthread_mutex_lock(&ctx->done_mutex);
219
2/2
✓ Branch 0 taken 67672 times.
✓ Branch 1 taken 67672 times.
 135344 while (!ctx->done)
220 67672 pthread_cond_wait(&ctx->done_cond, &ctx->done_mutex);
221 67672 ctx->done = 0;
222 67672 pthread_mutex_unlock(&ctx->done_mutex);
223 }
224 106851 }
225
226 52592 av_cold void avpriv_slicethread_free(AVSliceThread **pctx)
227 {
228 52592 AVSliceThread *ctx = *pctx;
229 int nb_workers, i;
230
231
2/2
✓ Branch 0 taken 42651 times.
✓ Branch 1 taken 9941 times.
 52592 if (!ctx)
232 42651 return;
233
234 9941 nb_workers = ctx->nb_threads;
235
1/2
✓ Branch 0 taken 9941 times.
✗ Branch 1 not taken.
 9941 if (!ctx->main_func)
236 9941 nb_workers--;
237
238 9941 ctx->finished = 1;
239
2/2
✓ Branch 0 taken 49863 times.
✓ Branch 1 taken 9941 times.
 59804 for (i = 0; i < nb_workers; i++) {
240 49863 WorkerContext *w = &ctx->workers[i];
241 49863 pthread_mutex_lock(&w->mutex);
242 49863 w->done = 0;
243 49863 pthread_cond_signal(&w->cond);
244 49863 pthread_mutex_unlock(&w->mutex);
245 }
246
247
2/2
✓ Branch 0 taken 49863 times.
✓ Branch 1 taken 9941 times.
 59804 for (i = 0; i < nb_workers; i++) {
248 49863 WorkerContext *w = &ctx->workers[i];
249 49863 pthread_join(w->thread, NULL);
250 49863 pthread_cond_destroy(&w->cond);
251 49863 pthread_mutex_destroy(&w->mutex);
252 }
253
254 9941 pthread_cond_destroy(&ctx->done_cond);
255 9941 pthread_mutex_destroy(&ctx->done_mutex);
256 9941 av_freep(&ctx->workers);
257 9941 av_freep(pctx);
258 }
259
260 #else /* HAVE_PTHREADS || HAVE_W32THREADS || HAVE_OS32THREADS */
261
262 int avpriv_slicethread_create(AVSliceThread **pctx, void *priv,
263 void (*worker_func)(void *priv, int jobnr, int threadnr, int nb_jobs, int nb_threads),
264 void (*main_func)(void *priv),
265 int nb_threads)
266 {
267 *pctx = NULL;
268 return AVERROR(ENOSYS);
269 }
270
271 void avpriv_slicethread_execute(AVSliceThread *ctx, int nb_jobs, int execute_main)
272 {
273 av_assert0(0);
274 }
275
276 void avpriv_slicethread_free(AVSliceThread **pctx)
277 {
278 av_assert0(!pctx || !*pctx);
279 }
280
281 #endif /* HAVE_PTHREADS || HAVE_W32THREADS || HAVE_OS32THREADS */
282