src/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 <string.h>
  37
  38 #include "util/list.h"
  39 #include "util/u_thread.h"
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 /* Job completion fence.
  46  * Put this into your job structure.
  47  */
  48 struct util_queue_fence {
  49    mtx_t mutex;
  50    cnd_t cond;
  51    int signalled;
  52 };
  53
  54 typedef void (*util_queue_execute_func)(void *job, int thread_index);
  55
  56 struct util_queue_job {
  57    void *job;
  58    struct util_queue_fence *fence;
  59    util_queue_execute_func execute;
  60    util_queue_execute_func cleanup;
  61 };
  62
  63 /* Put this into your context. */
  64 struct util_queue {
  65    const char *name;
  66    mtx_t lock;
  67    cnd_t has_queued_cond;
  68    cnd_t has_space_cond;
  69    thrd_t *threads;
  70    int num_queued;
  71    unsigned num_threads;
  72    int kill_threads;
  73    int max_jobs;
  74    int write_idx, read_idx; /* ring buffer pointers */
  75    struct util_queue_job *jobs;
  76
  77    /* for cleanup at exit(), protected by exit_mutex */
  78    struct list_head head;
  79 };
  80
  81 bool util_queue_init(struct util_queue *queue,
  82                      const char *name,
  83                      unsigned max_jobs,
  84                      unsigned num_threads);
  85 void util_queue_destroy(struct util_queue *queue);
  86 void util_queue_fence_init(struct util_queue_fence *fence);
  87 void util_queue_fence_destroy(struct util_queue_fence *fence);
  88
  89 /* optional cleanup callback is called after fence is signaled: */
  90 void util_queue_add_job(struct util_queue *queue,
  91                         void *job,
  92                         struct util_queue_fence *fence,
  93                         util_queue_execute_func execute,
  94                         util_queue_execute_func cleanup);
  95
  96 void util_queue_fence_wait(struct util_queue_fence *fence);
  97 int64_t util_queue_get_thread_time_nano(struct util_queue *queue,
  98                                         unsigned thread_index);
  99
 100 /* util_queue needs to be cleared to zeroes for this to work */
 101 static inline bool
 102 util_queue_is_initialized(struct util_queue *queue)
 103 {
 104    return queue->threads != NULL;
 105 }
 106
 107 static inline bool
 108 util_queue_fence_is_signalled(struct util_queue_fence *fence)
 109 {
 110    return fence->signalled != 0;
 111 }
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117 #endif