diff mbox series

[FFmpeg-devel,v5] vvcdec: add thread executor

Message ID TYSPR06MB64334CEE2145D7CFDFA9A94AAA1FA@TYSPR06MB6433.apcprd06.prod.outlook.com
State New
Headers show
Series [FFmpeg-devel,v5] vvcdec: add thread executor | expand

Checks

Context Check Description
yinshiyou/make_loongarch64 success Make finished
yinshiyou/make_fate_loongarch64 success Make fate finished
andriy/make_x86 success Make finished
andriy/make_fate_x86 success Make fate finished

Commit Message

Nuo Mi Aug. 22, 2023, 1:32 p.m. UTC
The executor design pattern was inroduced by java
<https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/Executor.html>
it also adapted by python
<https://docs.python.org/3/library/concurrent.futures.html>
Compared to handcrafted thread pool management, it greatly simplifies the thread code.
---
 doc/APIchanges       |   3 +
 libavutil/Makefile   |   2 +
 libavutil/executor.c | 201 +++++++++++++++++++++++++++++++++++++++++++
 libavutil/executor.h |  67 +++++++++++++++
 libavutil/version.h  |   2 +-
 5 files changed, 274 insertions(+), 1 deletion(-)
 create mode 100644 libavutil/executor.c
 create mode 100644 libavutil/executor.h

Comments

Michael Niedermayer Aug. 28, 2023, 5:06 p.m. UTC | #1
On Tue, Aug 22, 2023 at 09:32:28PM +0800, Nuo Mi wrote:
> The executor design pattern was inroduced by java

inTroduced


> <https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/Executor.html>
> it also adapted by python
> <https://docs.python.org/3/library/concurrent.futures.html>
> Compared to handcrafted thread pool management, it greatly simplifies the thread code.
> ---
>  doc/APIchanges       |   3 +
>  libavutil/Makefile   |   2 +
>  libavutil/executor.c | 201 +++++++++++++++++++++++++++++++++++++++++++
>  libavutil/executor.h |  67 +++++++++++++++
>  libavutil/version.h  |   2 +-
>  5 files changed, 274 insertions(+), 1 deletion(-)
>  create mode 100644 libavutil/executor.c
>  create mode 100644 libavutil/executor.h
> 
> diff --git a/doc/APIchanges b/doc/APIchanges
> index ad1efe708d..06822f22da 100644
> --- a/doc/APIchanges
> +++ b/doc/APIchanges
> @@ -2,6 +2,9 @@ The last version increases of all libraries were on 2023-02-09
>  
>  API changes, most recent first:
>  
> +2023-08-22 - xxxxxxxxxx - lavu 58.18.100 - executor.h
> +  Add AVExecutor API
> +
>  2023-08-18 - xxxxxxxxxx - lavu 58.17.100 - channel_layout.h
>    All AV_CHANNEL_LAYOUT_* macros are now compatible with C++ 17 and older.
>  
> diff --git a/libavutil/Makefile b/libavutil/Makefile
> index 7828c94dc5..4711f8cde8 100644
> --- a/libavutil/Makefile
> +++ b/libavutil/Makefile
> @@ -31,6 +31,7 @@ HEADERS = adler32.h                                                     \
>            encryption_info.h                                             \
>            error.h                                                       \
>            eval.h                                                        \
> +          executor.h                                                    \
>            fifo.h                                                        \
>            file.h                                                        \
>            frame.h                                                       \
> @@ -127,6 +128,7 @@ OBJS = adler32.o                                                        \
>         encryption_info.o                                                \
>         error.o                                                          \
>         eval.o                                                           \
> +       executor.o                                                       \
>         fifo.o                                                           \
>         file.o                                                           \
>         file_open.o                                                      \
> diff --git a/libavutil/executor.c b/libavutil/executor.c
> new file mode 100644
> index 0000000000..38adaef811
> --- /dev/null
> +++ b/libavutil/executor.c
> @@ -0,0 +1,201 @@
> +/*
> + * Copyright (C) 2023 Nuo Mi
> + *
> + * This file is part of FFmpeg.
> + *
> + * FFmpeg is free software; you can redistribute it and/or
> + * modify it under the terms of the GNU Lesser General Public
> + * License as published by the Free Software Foundation; either
> + * version 2.1 of the License, or (at your option) any later version.
> + *
> + * FFmpeg 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
> + * Lesser General Public License for more details.
> + *
> + * You should have received a copy of the GNU Lesser General Public
> + * License along with FFmpeg; if not, write to the Free Software
> + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
> + */
> +#include "internal.h"
> +#include "mem.h"
> +#include "thread.h"
> +
> +#include "executor.h"
> +
> +#if !HAVE_THREADS
> +
> +#define executor_thread_t    char
> +
> +#define executor_thread_create(t, a, s, ar)      0
> +#define executor_thread_join(t, r)               do {} while(0)
> +
> +#else
> +

> +#define executor_thread_t    pthread_t

I think *_t is reserved by POSIX


should be ok otherwise

thx

[...]
Nuo Mi Aug. 29, 2023, 1:07 p.m. UTC | #2
On Tue, Aug 29, 2023 at 1:06 AM Michael Niedermayer <michael@niedermayer.cc>
wrote:

> On Tue, Aug 22, 2023 at 09:32:28PM +0800, Nuo Mi wrote:
> > The executor design pattern was inroduced by java
>
> inTroduced
>
>
> > <
> https://docs.oracle.com/en/java/javase/20/docs/api/java.base/java/util/concurrent/Executor.html
> >
> > it also adapted by python
> > <https://docs.python.org/3/library/concurrent.futures.html>
> > Compared to handcrafted thread pool management, it greatly simplifies
> the thread code.
> > ---
> >  doc/APIchanges       |   3 +
> >  libavutil/Makefile   |   2 +
> >  libavutil/executor.c | 201 +++++++++++++++++++++++++++++++++++++++++++
> >  libavutil/executor.h |  67 +++++++++++++++
> >  libavutil/version.h  |   2 +-
> >  5 files changed, 274 insertions(+), 1 deletion(-)
> >  create mode 100644 libavutil/executor.c
> >  create mode 100644 libavutil/executor.h
> >
> > diff --git a/doc/APIchanges b/doc/APIchanges
> > index ad1efe708d..06822f22da 100644
> > --- a/doc/APIchanges
> > +++ b/doc/APIchanges
> > @@ -2,6 +2,9 @@ The last version increases of all libraries were on
> 2023-02-09
> >
> >  API changes, most recent first:
> >
> > +2023-08-22 - xxxxxxxxxx - lavu 58.18.100 - executor.h
> > +  Add AVExecutor API
> > +
> >  2023-08-18 - xxxxxxxxxx - lavu 58.17.100 - channel_layout.h
> >    All AV_CHANNEL_LAYOUT_* macros are now compatible with C++ 17 and
> older.
> >
> > diff --git a/libavutil/Makefile b/libavutil/Makefile
> > index 7828c94dc5..4711f8cde8 100644
> > --- a/libavutil/Makefile
> > +++ b/libavutil/Makefile
> > @@ -31,6 +31,7 @@ HEADERS = adler32.h
>                  \
> >            encryption_info.h
>  \
> >            error.h
>  \
> >            eval.h
> \
> > +          executor.h
> \
> >            fifo.h
> \
> >            file.h
> \
> >            frame.h
>  \
> > @@ -127,6 +128,7 @@ OBJS = adler32.o
>                     \
> >         encryption_info.o
> \
> >         error.o
> \
> >         eval.o
>  \
> > +       executor.o
>  \
> >         fifo.o
>  \
> >         file.o
>  \
> >         file_open.o
> \
> > diff --git a/libavutil/executor.c b/libavutil/executor.c
> > new file mode 100644
> > index 0000000000..38adaef811
> > --- /dev/null
> > +++ b/libavutil/executor.c
> > @@ -0,0 +1,201 @@
> > +/*
> > + * Copyright (C) 2023 Nuo Mi
> > + *
> > + * This file is part of FFmpeg.
> > + *
> > + * FFmpeg is free software; you can redistribute it and/or
> > + * modify it under the terms of the GNU Lesser General Public
> > + * License as published by the Free Software Foundation; either
> > + * version 2.1 of the License, or (at your option) any later version.
> > + *
> > + * FFmpeg 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
> > + * Lesser General Public License for more details.
> > + *
> > + * You should have received a copy of the GNU Lesser General Public
> > + * License along with FFmpeg; if not, write to the Free Software
> > + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
> 02110-1301 USA
> > + */
> > +#include "internal.h"
> > +#include "mem.h"
> > +#include "thread.h"
> > +
> > +#include "executor.h"
> > +
> > +#if !HAVE_THREADS
> > +
> > +#define executor_thread_t    char
> > +
> > +#define executor_thread_create(t, a, s, ar)      0
> > +#define executor_thread_join(t, r)               do {} while(0)
> > +
> > +#else
> > +
>
> > +#define executor_thread_t    pthread_t
>
> I think *_t is reserved by POSIX
>
fixed by v6.
thank you

>
>
> should be ok otherwise
>
> thx
>
> [...]
> --
> Michael     GnuPG fingerprint: 9FF2128B147EF6730BADF133611EC787040B0FAB
>
> Everything should be made as simple as possible, but not simpler.
> -- Albert Einstein
> _______________________________________________
> ffmpeg-devel mailing list
> ffmpeg-devel@ffmpeg.org
> https://ffmpeg.org/mailman/listinfo/ffmpeg-devel
>
> To unsubscribe, visit link above, or email
> ffmpeg-devel-request@ffmpeg.org with subject "unsubscribe".
>
diff mbox series

Patch

diff --git a/doc/APIchanges b/doc/APIchanges
index ad1efe708d..06822f22da 100644
--- a/doc/APIchanges
+++ b/doc/APIchanges
@@ -2,6 +2,9 @@  The last version increases of all libraries were on 2023-02-09
 
 API changes, most recent first:
 
+2023-08-22 - xxxxxxxxxx - lavu 58.18.100 - executor.h
+  Add AVExecutor API
+
 2023-08-18 - xxxxxxxxxx - lavu 58.17.100 - channel_layout.h
   All AV_CHANNEL_LAYOUT_* macros are now compatible with C++ 17 and older.
 
diff --git a/libavutil/Makefile b/libavutil/Makefile
index 7828c94dc5..4711f8cde8 100644
--- a/libavutil/Makefile
+++ b/libavutil/Makefile
@@ -31,6 +31,7 @@  HEADERS = adler32.h                                                     \
           encryption_info.h                                             \
           error.h                                                       \
           eval.h                                                        \
+          executor.h                                                    \
           fifo.h                                                        \
           file.h                                                        \
           frame.h                                                       \
@@ -127,6 +128,7 @@  OBJS = adler32.o                                                        \
        encryption_info.o                                                \
        error.o                                                          \
        eval.o                                                           \
+       executor.o                                                       \
        fifo.o                                                           \
        file.o                                                           \
        file_open.o                                                      \
diff --git a/libavutil/executor.c b/libavutil/executor.c
new file mode 100644
index 0000000000..38adaef811
--- /dev/null
+++ b/libavutil/executor.c
@@ -0,0 +1,201 @@ 
+/*
+ * Copyright (C) 2023 Nuo Mi
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+#include "internal.h"
+#include "mem.h"
+#include "thread.h"
+
+#include "executor.h"
+
+#if !HAVE_THREADS
+
+#define executor_thread_t    char
+
+#define executor_thread_create(t, a, s, ar)      0
+#define executor_thread_join(t, r)               do {} while(0)
+
+#else
+
+#define executor_thread_t    pthread_t
+
+#define executor_thread_create(t, a, s, ar)      pthread_create(t, a, s, ar)
+#define executor_thread_join(t, r)               pthread_join(t, r)
+
+#endif //!HAVE_THREADS
+
+typedef struct ThreadInfo {
+    AVExecutor *e;
+    executor_thread_t thread;
+} ThreadInfo;
+
+struct AVExecutor {
+    AVTaskCallbacks cb;
+    int thread_count;
+
+    ThreadInfo *threads;
+    uint8_t *local_contexts;
+
+    AVMutex lock;
+    AVCond cond;
+    int die;
+
+    AVTask *tasks;
+};
+
+static AVTask* remove_task(AVTask **prev, AVTask *t)
+{
+    *prev  = t->next;
+    t->next = NULL;
+    return t;
+}
+
+static void add_task(AVTask **prev, AVTask *t)
+{
+    t->next = *prev;
+    *prev   = t;
+}
+
+static int run_one_task(AVExecutor *e, void *lc)
+{
+    AVTaskCallbacks *cb = &e->cb;
+    AVTask **prev;
+
+    for (prev = &e->tasks; *prev && !cb->ready(*prev, cb->user_data); prev = &(*prev)->next)
+        /* nothing */;
+    if (*prev) {
+        AVTask *t = remove_task(prev, *prev);
+        ff_mutex_unlock(&e->lock);
+        cb->run(t, lc, cb->user_data);
+        ff_mutex_lock(&e->lock);
+        return 1;
+    }
+    return 0;
+}
+
+#if HAVE_THREADS
+static void *executor_worker_task(void *data)
+{
+    ThreadInfo *ti = (ThreadInfo*)data;
+    AVExecutor *e  = ti->e;
+    void *lc       = e->local_contexts + (ti - e->threads) * e->cb.local_context_size;
+
+    ff_mutex_lock(&e->lock);
+    while (1) {
+        if (e->die) break;
+
+        if (!run_one_task(e, lc)) {
+            //no task in one loop
+            ff_cond_wait(&e->cond, &e->lock);
+        }
+    }
+    ff_mutex_unlock(&e->lock);
+    return NULL;
+}
+#endif
+
+static void executor_free(AVExecutor *e, const int has_lock, const int has_cond)
+{
+    if (e->thread_count) {
+        //signal die
+        ff_mutex_lock(&e->lock);
+        e->die = 1;
+        ff_cond_broadcast(&e->cond);
+        ff_mutex_unlock(&e->lock);
+
+        for (int i = 0; i < e->thread_count; i++)
+            executor_thread_join(e->threads[i].thread, NULL);
+    }
+    if (has_cond)
+        ff_cond_destroy(&e->cond);
+    if (has_lock)
+        ff_mutex_destroy(&e->lock);
+
+    av_free(e->threads);
+    av_free(e->local_contexts);
+
+    av_free(e);
+}
+
+AVExecutor* av_executor_alloc(const AVTaskCallbacks *cb, int thread_count)
+{
+    AVExecutor *e;
+    int has_lock = 0, has_cond = 0;
+    if (!cb || !cb->user_data || !cb->ready || !cb->run || !cb->priority_higher)
+        return NULL;
+
+    e = av_mallocz(sizeof(*e));
+    if (!e)
+        return NULL;
+    e->cb = *cb;
+
+    e->local_contexts = av_calloc(thread_count, e->cb.local_context_size);
+    if (!e->local_contexts)
+        goto free_executor;
+
+    e->threads = av_calloc(thread_count, sizeof(*e->threads));
+    if (!e->threads)
+        goto free_executor;
+
+    has_lock = !ff_mutex_init(&e->lock, NULL);
+    has_cond = !ff_cond_init(&e->cond, NULL);
+
+    if (!has_lock || !has_cond)
+        goto free_executor;
+
+    for (/* nothing */; e->thread_count < thread_count; e->thread_count++) {
+        ThreadInfo *ti = e->threads + e->thread_count;
+        ti->e = e;
+        if (executor_thread_create(&ti->thread, NULL, executor_worker_task, ti))
+            goto free_executor;
+    }
+    return e;
+
+free_executor:
+    executor_free(e, has_lock, has_cond);
+    return NULL;
+}
+
+void av_executor_free(AVExecutor **executor)
+{
+    if (!executor || !*executor)
+        return;
+    executor_free(*executor, 1, 1);
+    *executor = NULL;
+}
+
+void av_executor_execute(AVExecutor *e, AVTask *t)
+{
+    AVTaskCallbacks *cb = &e->cb;
+    AVTask **prev;
+
+    ff_mutex_lock(&e->lock);
+    if (t) {
+        for (prev = &e->tasks; *prev && cb->priority_higher(*prev, t); prev = &(*prev)->next)
+            /* nothing */;
+        add_task(prev, t);
+    }
+    ff_cond_signal(&e->cond);
+    ff_mutex_unlock(&e->lock);
+
+#if !HAVE_THREADS
+    // We are running in a single-threaded environment, so we must handle all tasks ourselves
+    while (run_one_task(e, e->local_contexts))
+        /* nothing */;
+#endif
+}
diff --git a/libavutil/executor.h b/libavutil/executor.h
new file mode 100644
index 0000000000..c3fe44bd0e
--- /dev/null
+++ b/libavutil/executor.h
@@ -0,0 +1,67 @@ 
+/*
+ * Copyright (C) 2023 Nuo Mi
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#ifndef AVUTIL_EXECUTOR_H
+#define AVUTIL_EXECUTOR_H
+
+typedef struct AVExecutor AVExecutor;
+typedef struct AVTask AVTask;
+
+struct AVTask {
+    AVTask *next;
+};
+
+typedef struct AVTaskCallbacks {
+    void *user_data;
+
+    int local_context_size;
+
+    // return 1 if a's priority > b's priority
+    int (*priority_higher)(const AVTask *a, const AVTask *b);
+
+    // task is ready for run
+    int (*ready)(const AVTask *t, void *user_data);
+
+    // run the task
+    int (*run)(AVTask *t, void *local_context, void *user_data);
+} AVTaskCallbacks;
+
+/**
+ * Alloc executor
+ * @param callbacks callback strucutre for executor
+ * @param thread_count worker thread number
+ * @return return the executor
+ */
+AVExecutor* av_executor_alloc(const AVTaskCallbacks *callbacks, int thread_count);
+
+/**
+ * Free executor
+ * @param e  pointer to executor
+ */
+void av_executor_free(AVExecutor **e);
+
+/**
+ * Add task to executor
+ * @param e pointer to executor
+ * @param t pointer to task. If NULL, it will wakeup one work thread
+ */
+void av_executor_execute(AVExecutor *e, AVTask *t);
+
+#endif //AVUTIL_EXECUTOR_H
diff --git a/libavutil/version.h b/libavutil/version.h
index bc43baca9f..6d27f91cce 100644
--- a/libavutil/version.h
+++ b/libavutil/version.h
@@ -79,7 +79,7 @@ 
  */
 
 #define LIBAVUTIL_VERSION_MAJOR  58
-#define LIBAVUTIL_VERSION_MINOR  17
+#define LIBAVUTIL_VERSION_MINOR  18
 #define LIBAVUTIL_VERSION_MICRO 100
 
 #define LIBAVUTIL_VERSION_INT   AV_VERSION_INT(LIBAVUTIL_VERSION_MAJOR, \