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 /* The size of one batch and the maximum size of one call.
  28  *
  29  * This should be as low as possible, so that:
  30  * - multiple synchronizations within a frame don't slow us down much
  31  * - a smaller number of calls per frame can still get decent parallelism
  32  * - the memory footprint of the queue is low, and with that comes a lower
  33  *   chance of experiencing CPU cache thrashing
  34  * but it should be high enough so that u_queue overhead remains negligible.
  35  */
  36 #define MARSHAL_MAX_CMD_SIZE (8 * 1024)
  37
  38 /* The number of batch slots in memory.
  39  *
  40  * One batch is being executed, one batch is being filled, the rest are
  41  * waiting batches. There must be at least 1 slot for a waiting batch,
  42  * so the minimum number of batches is 3.
  43  */
  44 #define MARSHAL_MAX_BATCHES 8
  45
  46 #include <inttypes.h>
  47 #include <stdbool.h>
  48 #include "util/u_queue.h"
  49
  50 enum marshal_dispatch_cmd_id;
  51 struct gl_context;
  52
  53 /** A single batch of commands queued up for execution. */
  54 struct glthread_batch
  55 {
  56    /** Batch fence for waiting for the execution to finish. */
  57    struct util_queue_fence fence;
  58
  59    /** The worker thread will access the context with this. */
  60    struct gl_context *ctx;
  61
  62    /** Amount of data used by batch commands, in bytes. */
  63    int used;
  64
  65    /** Data contained in the command buffer. */
  66    uint8_t buffer[MARSHAL_MAX_CMD_SIZE];
  67 };
  68
  69 struct glthread_state
  70 {
  71    /** Multithreaded queue. */
  72    struct util_queue queue;
  73
  74    /** This is sent to the driver for framebuffer overlay / HUD. */
  75    struct util_queue_monitoring stats;
  76
  77    /** The ring of batches in memory. */
  78    struct glthread_batch batches[MARSHAL_MAX_BATCHES];
  79
  80    /** Index of the last submitted batch. */
  81    unsigned last;
  82
  83    /** Index of the batch being filled and about to be submitted. */
  84    unsigned next;
  85
  86    /**
  87     * Tracks on the main thread side whether the current vertex array binding
  88     * is in a VBO.
  89     */
  90    bool vertex_array_is_vbo;
  91
  92    /**
  93     * Tracks on the main thread side whether the current element array (index
  94     * buffer) binding is in a VBO.
  95     */
  96    bool element_array_is_vbo;
  97 };
  98
  99 void _mesa_glthread_init(struct gl_context *ctx);
 100 void _mesa_glthread_destroy(struct gl_context *ctx);
 101
 102 void _mesa_glthread_restore_dispatch(struct gl_context *ctx, const char *func);
 103 void _mesa_glthread_disable(struct gl_context *ctx, const char *func);
 104 void _mesa_glthread_flush_batch(struct gl_context *ctx);
 105 void _mesa_glthread_finish(struct gl_context *ctx);
 106 void _mesa_glthread_finish_before(struct gl_context *ctx, const char *func);
 107
 108 #endif /* _GLTHREAD_H*/