gallium/util: import the multithreaded job queue from amdgpu winsys (v2)

v2: rename the event to util_queue_fence

Reviewed-by: Nicolai Hähnle <[email protected]>

2 files changed, 209 insertions, 0 deletions

diff --git a/src/gallium/auxiliary/util/u_queue.c b/src/gallium/auxiliary/util/u_queue.c
new file mode 100644
index 00000000000..8e58414247b
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_queue.c
@@ -0,0 +1,129 @@
+/*
+ * Copyright © 2016 Advanced Micro Devices, Inc.
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, AUTHORS
+ * AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+ * USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ */
+
+#include "u_queue.h"
+
+static PIPE_THREAD_ROUTINE(util_queue_thread_func, param)
+{
+   struct util_queue *queue = (struct util_queue*)param;
+   unsigned i;
+
+   while (1) {
+      struct util_queue_job job;
+
+      pipe_semaphore_wait(&queue->queued);
+      if (queue->kill_thread)
+         break;
+
+      pipe_mutex_lock(queue->lock);
+      job = queue->jobs[0];
+      for (i = 1; i < queue->num_jobs; i++)
+         queue->jobs[i - 1] = queue->jobs[i];
+      queue->jobs[--queue->num_jobs].job = NULL;
+      pipe_mutex_unlock(queue->lock);
+
+      pipe_semaphore_signal(&queue->has_space);
+
+      if (job.job) {
+         queue->execute_job(job.job);
+         pipe_semaphore_signal(&job.fence->done);
+      }
+   }
+
+   /* signal remaining jobs before terminating */
+   pipe_mutex_lock(queue->lock);
+   for (i = 0; i < queue->num_jobs; i++) {
+      pipe_semaphore_signal(&queue->jobs[i].fence->done);
+      queue->jobs[i].job = NULL;
+   }
+   queue->num_jobs = 0;
+   pipe_mutex_unlock(queue->lock);
+   return 0;
+}
+
+void
+util_queue_init(struct util_queue *queue,
+                void (*execute_job)(void *))
+{
+   memset(queue, 0, sizeof(*queue));
+   queue->execute_job = execute_job;
+   pipe_mutex_init(queue->lock);
+   pipe_semaphore_init(&queue->has_space, ARRAY_SIZE(queue->jobs));
+   pipe_semaphore_init(&queue->queued, 0);
+   queue->thread = pipe_thread_create(util_queue_thread_func, queue);
+}
+
+void
+util_queue_destroy(struct util_queue *queue)
+{
+   queue->kill_thread = 1;
+   pipe_semaphore_signal(&queue->queued);
+   pipe_thread_wait(queue->thread);
+   pipe_semaphore_destroy(&queue->has_space);
+   pipe_semaphore_destroy(&queue->queued);
+   pipe_mutex_destroy(queue->lock);
+}
+
+void
+util_queue_fence_init(struct util_queue_fence *fence)
+{
+   pipe_semaphore_init(&fence->done, 1);
+}
+
+void
+util_queue_fence_destroy(struct util_queue_fence *fence)
+{
+   pipe_semaphore_destroy(&fence->done);
+}
+
+void
+util_queue_add_job(struct util_queue *queue,
+                   void *job,
+                   struct util_queue_fence *fence)
+{
+   /* Set the semaphore to "busy". */
+   pipe_semaphore_wait(&fence->done);
+
+   /* if the queue is full, wait until there is space */
+   pipe_semaphore_wait(&queue->has_space);
+
+   pipe_mutex_lock(queue->lock);
+   assert(queue->num_jobs < ARRAY_SIZE(queue->jobs));
+   queue->jobs[queue->num_jobs].job = job;
+   queue->jobs[queue->num_jobs].fence = fence;
+   queue->num_jobs++;
+   pipe_mutex_unlock(queue->lock);
+   pipe_semaphore_signal(&queue->queued);
+}
+
+void
+util_queue_job_wait(struct util_queue_fence *fence)
+{
+   /* wait and set the semaphore to "busy" */
+   pipe_semaphore_wait(&fence->done);
+   /* set the semaphore to "idle" */
+   pipe_semaphore_signal(&fence->done);
+}
diff --git a/src/gallium/auxiliary/util/u_queue.h b/src/gallium/auxiliary/util/u_queue.h
new file mode 100644
index 00000000000..db5a266fd41
--- /dev/null
+++ b/src/gallium/auxiliary/util/u_queue.h
@@ -0,0 +1,80 @@
+/*
+ * Copyright © 2016 Advanced Micro Devices, Inc.
+ * All Rights Reserved.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sub license, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, AUTHORS
+ * AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+ * USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * The above copyright notice and this permission notice (including the
+ * next paragraph) shall be included in all copies or substantial portions
+ * of the Software.
+ */
+
+/* Job queue with execution in a separate thread.
+ *
+ * Jobs can be added from any thread. After that, the wait call can be used
+ * to wait for completion of the job.
+ */
+
+#ifndef U_QUEUE_H
+#define U_QUEUE_H
+
+#include "os/os_thread.h"
+
+/* Job completion fence.
+ * Put this into your job structure.
+ */
+struct util_queue_fence {
+   pipe_semaphore done;
+};
+
+struct util_queue_job {
+   void *job;
+   struct util_queue_fence *fence;
+};
+
+/* Put this into your context. */
+struct util_queue {
+   pipe_mutex lock;
+   pipe_semaphore has_space;
+   pipe_semaphore queued;
+   pipe_thread thread;
+   int kill_thread;
+   int num_jobs;
+   struct util_queue_job jobs[8];
+   void (*execute_job)(void *job);
+};
+
+void util_queue_init(struct util_queue *queue,
+                     void (*execute_job)(void *));
+void util_queue_destroy(struct util_queue *queue);
+void util_queue_fence_init(struct util_queue_fence *fence);
+void util_queue_fence_destroy(struct util_queue_fence *fence);
+
+void util_queue_add_job(struct util_queue *queue,
+                        void *job,
+                        struct util_queue_fence *fence);
+void util_queue_job_wait(struct util_queue_fence *fence);
+
+/* util_queue needs to be cleared to zeroes for this to work */
+static inline bool
+util_queue_is_initialized(struct util_queue *queue)
+{
+   return queue->thread != 0;
+}
+
+#endif