src/gallium/auxiliary/util/u_queue.h

   1 /*
   2  * Copyright © 2016 Advanced Micro Devices, Inc.
   3  * All Rights Reserved.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sub license, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  14  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
  15  * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  16  * NON-INFRINGEMENT. IN NO EVENT SHALL THE COPYRIGHT HOLDERS, AUTHORS
  17  * AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  20  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  *
  22  * The above copyright notice and this permission notice (including the
  23  * next paragraph) shall be included in all copies or substantial portions
  24  * of the Software.
  25  */
  26
  27 /* Job queue with execution in a separate thread.
  28  *
  29  * Jobs can be added from any thread. After that, the wait call can be used
  30  * to wait for completion of the job.
  31  */
  32
  33 #ifndef U_QUEUE_H
  34 #define U_QUEUE_H
  35
  36 #include "os/os_thread.h"
  37
  38 /* Job completion fence.
  39  * Put this into your job structure.
  40  */
  41 struct util_queue_fence {
  42    pipe_mutex mutex;
  43    pipe_condvar cond;
  44    int signalled;
  45 };
  46
  47 typedef void (*util_queue_execute_func)(void *job, int thread_index);
  48
  49 struct util_queue_job {
  50    void *job;
  51    struct util_queue_fence *fence;
  52    util_queue_execute_func execute;
  53    util_queue_execute_func cleanup;
  54 };
  55
  56 /* Put this into your context. */
  57 struct util_queue {
  58    const char *name;
  59    pipe_mutex lock;
  60    pipe_condvar has_queued_cond;
  61    pipe_condvar has_space_cond;
  62    pipe_thread *threads;
  63    int num_queued;
  64    unsigned num_threads;
  65    int kill_threads;
  66    int max_jobs;
  67    int write_idx, read_idx; /* ring buffer pointers */
  68    struct util_queue_job *jobs;
  69 };
  70
  71 bool util_queue_init(struct util_queue *queue,
  72                      const char *name,
  73                      unsigned max_jobs,
  74                      unsigned num_threads);
  75 void util_queue_destroy(struct util_queue *queue);
  76 void util_queue_fence_init(struct util_queue_fence *fence);
  77 void util_queue_fence_destroy(struct util_queue_fence *fence);
  78
  79 /* optional cleanup callback is called after fence is signaled: */
  80 void util_queue_add_job(struct util_queue *queue,
  81                         void *job,
  82                         struct util_queue_fence *fence,
  83                         util_queue_execute_func execute,
  84                         util_queue_execute_func cleanup);
  85
  86 void util_queue_job_wait(struct util_queue_fence *fence);
  87 int64_t util_queue_get_thread_time_nano(struct util_queue *queue,
  88                                         unsigned thread_index);
  89
  90 /* util_queue needs to be cleared to zeroes for this to work */
  91 static inline bool
  92 util_queue_is_initialized(struct util_queue *queue)
  93 {
  94    return queue->threads != NULL;
  95 }
  96
  97 static inline bool
  98 util_queue_fence_is_signalled(struct util_queue_fence *fence)
  99 {
 100    return fence->signalled != 0;
 101 }
 102
 103 #endif