src/mesa/main/glthread.h

   1 /*
   2  * Copyright © 2012 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #ifndef _GLTHREAD_H
  25 #define _GLTHREAD_H
  26
  27 #include "main/mtypes.h"
  28
  29 /* Command size is a number of bytes stored in a short. */
  30 #define MARSHAL_MAX_CMD_SIZE 65535
  31
  32 #ifdef HAVE_PTHREAD
  33
  34 #include <inttypes.h>
  35 #include <stdbool.h>
  36 #include <pthread.h>
  37
  38 enum marshal_dispatch_cmd_id;
  39
  40 struct glthread_state
  41 {
  42    /** The worker thread that asynchronously processes our GL commands. */
  43    pthread_t thread;
  44
  45    /**
  46     * Mutex used for synchronizing between the main thread and the worker
  47     * thread.
  48     */
  49    pthread_mutex_t mutex;
  50
  51    /** Condvar used for waking the worker thread. */
  52    pthread_cond_t new_work;
  53
  54    /** Condvar used for waking the main thread. */
  55    pthread_cond_t work_done;
  56
  57    /** Used to tell the worker thread to quit */
  58    bool shutdown;
  59
  60    /** Indicates that the worker thread is currently processing a batch */
  61    bool busy;
  62
  63    /**
  64     * Singly-linked list of command batches that are awaiting execution by
  65     * a thread pool task.  NULL if empty.
  66     */
  67    struct glthread_batch *batch_queue;
  68
  69    /**
  70     * Tail pointer for appending batches to the end of batch_queue.  If the
  71     * queue is empty, this points to batch_queue.
  72     */
  73    struct glthread_batch **batch_queue_tail;
  74
  75    /**
  76     * Batch containing commands that are being prepared for insertion into
  77     * batch_queue.  NULL if there are no such commands.
  78     *
  79     * Since this is only used by the main thread, it doesn't need the mutex to
  80     * be accessed.
  81     */
  82    struct glthread_batch *batch;
  83
  84    /**
  85     * Tracks on the main thread side whether the current vertex array binding
  86     * is in a VBO.
  87     */
  88    bool vertex_array_is_vbo;
  89
  90    /**
  91     * Tracks on the main thread side whether the current element array (index
  92     * buffer) binding is in a VBO.
  93     */
  94    bool element_array_is_vbo;
  95 };
  96
  97 /**
  98  * A single batch of commands queued up for later execution by a thread pool
  99  * task.
 100  */
 101 struct glthread_batch
 102 {
 103    /**
 104     * Next batch of commands to execute after this batch, or NULL if this is
 105     * the last set of commands queued.  Protected by ctx->Marshal.Mutex.
 106     */
 107    struct glthread_batch *next;
 108
 109    /**
 110     * Amount of data used by batch commands, in bytes.
 111     */
 112    size_t used;
 113
 114    /**
 115     * Data contained in the command buffer.
 116     */
 117    uint8_t buffer[MARSHAL_MAX_CMD_SIZE];
 118 };
 119
 120 void _mesa_glthread_init(struct gl_context *ctx);
 121 void _mesa_glthread_destroy(struct gl_context *ctx);
 122
 123 void _mesa_glthread_restore_dispatch(struct gl_context *ctx);
 124 void _mesa_glthread_flush_batch(struct gl_context *ctx);
 125 void _mesa_glthread_finish(struct gl_context *ctx);
 126
 127 #else /* HAVE_PTHREAD */
 128
 129 static inline void
 130 _mesa_glthread_init(struct gl_context *ctx)
 131 {
 132 }
 133
 134 static inline void
 135 _mesa_glthread_destroy(struct gl_context *ctx)
 136 {
 137 }
 138
 139 static inline void
 140 _mesa_glthread_finish(struct gl_context *ctx)
 141 {
 142 }
 143
 144 static inline void
 145 _mesa_glthread_restore_dispatch(struct gl_context *ctx)
 146 {
 147 }
 148
 149 static inline void
 150 _mesa_glthread_flush_batch(struct gl_context *ctx)
 151 {
 152 }
 153
 154 #endif /* !HAVE_PTHREAD */
 155 #endif /* _GLTHREAD_H*/