src/mesa/main/marshal.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 /** \file marshal.h
  25  *
  26  * Declarations of functions related to marshalling GL calls from a client
  27  * thread to a server thread.
  28  */
  29
  30 #ifndef MARSHAL_H
  31 #define MARSHAL_H
  32
  33 #include "main/glthread.h"
  34 #include "main/context.h"
  35 #include "main/macros.h"
  36 #include "marshal_generated.h"
  37
  38 struct marshal_cmd_base
  39 {
  40    /**
  41     * Type of command.  See enum marshal_dispatch_cmd_id.
  42     */
  43    uint16_t cmd_id;
  44
  45    /**
  46     * Size of command, in multiples of 4 bytes, including cmd_base.
  47     */
  48    uint16_t cmd_size;
  49 };
  50
  51 typedef void (*_mesa_unmarshal_func)(struct gl_context *ctx, const void *cmd);
  52 extern const _mesa_unmarshal_func _mesa_unmarshal_dispatch[NUM_DISPATCH_CMD];
  53
  54 static inline void *
  55 _mesa_glthread_allocate_command(struct gl_context *ctx,
  56                                 uint16_t cmd_id,
  57                                 int size)
  58 {
  59    struct glthread_state *glthread = ctx->GLThread;
  60    struct glthread_batch *next = &glthread->batches[glthread->next];
  61    struct marshal_cmd_base *cmd_base;
  62    const int aligned_size = ALIGN(size, 8);
  63
  64    if (unlikely(next->used + size > MARSHAL_MAX_CMD_SIZE)) {
  65       _mesa_glthread_flush_batch(ctx);
  66       next = &glthread->batches[glthread->next];
  67    }
  68
  69    cmd_base = (struct marshal_cmd_base *)&next->buffer[next->used];
  70    next->used += aligned_size;
  71    cmd_base->cmd_id = cmd_id;
  72    cmd_base->cmd_size = aligned_size;
  73    return cmd_base;
  74 }
  75
  76 /**
  77  * Instead of conditionally handling marshaling immediate index data in draw
  78  * calls (deprecated and removed in GL core), we just disable threading.
  79  */
  80 static inline bool
  81 _mesa_glthread_is_non_vbo_draw_elements(const struct gl_context *ctx)
  82 {
  83    struct glthread_state *glthread = ctx->GLThread;
  84
  85    return ctx->API != API_OPENGL_CORE &&
  86           (glthread->CurrentVAO->IndexBufferIsUserPointer ||
  87            glthread->CurrentVAO->HasUserPointer);
  88 }
  89
  90 static inline bool
  91 _mesa_glthread_is_non_vbo_draw_arrays(const struct gl_context *ctx)
  92 {
  93    struct glthread_state *glthread = ctx->GLThread;
  94
  95    return ctx->API != API_OPENGL_CORE && glthread->CurrentVAO->HasUserPointer;
  96 }
  97
  98 static inline bool
  99 _mesa_glthread_is_non_vbo_draw_arrays_indirect(const struct gl_context *ctx)
 100 {
 101    struct glthread_state *glthread = ctx->GLThread;
 102
 103    return ctx->API != API_OPENGL_CORE &&
 104           (!glthread->draw_indirect_buffer_is_vbo ||
 105            glthread->CurrentVAO->HasUserPointer );
 106 }
 107
 108 static inline bool
 109 _mesa_glthread_is_non_vbo_draw_elements_indirect(const struct gl_context *ctx)
 110 {
 111    struct glthread_state *glthread = ctx->GLThread;
 112
 113    return ctx->API != API_OPENGL_CORE &&
 114           (!glthread->draw_indirect_buffer_is_vbo ||
 115            glthread->CurrentVAO->IndexBufferIsUserPointer ||
 116            glthread->CurrentVAO->HasUserPointer);
 117 }
 118
 119 #define DEBUG_MARSHAL_PRINT_CALLS 0
 120
 121 /**
 122  * This is printed when we have fallen back to a sync. This can happen when
 123  * MARSHAL_MAX_CMD_SIZE is exceeded.
 124  */
 125 static inline void
 126 debug_print_sync_fallback(const char *func)
 127 {
 128 #if DEBUG_MARSHAL_PRINT_CALLS
 129    printf("fallback to sync: %s\n", func);
 130 #endif
 131 }
 132
 133
 134 static inline void
 135 debug_print_sync(const char *func)
 136 {
 137 #if DEBUG_MARSHAL_PRINT_CALLS
 138    printf("sync: %s\n", func);
 139 #endif
 140 }
 141
 142 static inline void
 143 debug_print_marshal(const char *func)
 144 {
 145 #if DEBUG_MARSHAL_PRINT_CALLS
 146    printf("marshal: %s\n", func);
 147 #endif
 148 }
 149
 150 struct _glapi_table *
 151 _mesa_create_marshal_table(const struct gl_context *ctx);
 152
 153 struct marshal_cmd_ShaderSource;
 154 struct marshal_cmd_BindBuffer;
 155 struct marshal_cmd_BufferData;
 156 struct marshal_cmd_BufferSubData;
 157 struct marshal_cmd_NamedBufferData;
 158 struct marshal_cmd_NamedBufferSubData;
 159
 160 void GLAPIENTRY
 161 _mesa_marshal_ShaderSource(GLuint shader, GLsizei count,
 162                            const GLchar * const *string, const GLint *length);
 163
 164 void
 165 _mesa_unmarshal_ShaderSource(struct gl_context *ctx,
 166                              const struct marshal_cmd_ShaderSource *cmd);
 167
 168 void GLAPIENTRY
 169 _mesa_marshal_BindBuffer(GLenum target, GLuint buffer);
 170
 171 void
 172 _mesa_unmarshal_BindBuffer(struct gl_context *ctx,
 173                            const struct marshal_cmd_BindBuffer *cmd);
 174
 175 void
 176 _mesa_unmarshal_BufferData(struct gl_context *ctx,
 177                            const struct marshal_cmd_BufferData *cmd);
 178
 179 void GLAPIENTRY
 180 _mesa_marshal_BufferData(GLenum target, GLsizeiptr size, const GLvoid * data,
 181                          GLenum usage);
 182
 183 void
 184 _mesa_unmarshal_BufferSubData(struct gl_context *ctx,
 185                               const struct marshal_cmd_BufferSubData *cmd);
 186
 187 void GLAPIENTRY
 188 _mesa_marshal_BufferSubData(GLenum target, GLintptr offset, GLsizeiptr size,
 189                             const GLvoid * data);
 190
 191 void
 192 _mesa_unmarshal_NamedBufferData(struct gl_context *ctx,
 193                                 const struct marshal_cmd_NamedBufferData *cmd);
 194
 195 void GLAPIENTRY
 196 _mesa_marshal_NamedBufferData(GLuint buffer, GLsizeiptr size,
 197                               const GLvoid * data, GLenum usage);
 198
 199 void
 200 _mesa_unmarshal_NamedBufferSubData(struct gl_context *ctx,
 201                                    const struct marshal_cmd_NamedBufferSubData *cmd);
 202
 203 void GLAPIENTRY
 204 _mesa_marshal_NamedBufferSubData(GLuint buffer, GLintptr offset, GLsizeiptr size,
 205                                  const GLvoid * data);
 206
 207 static inline unsigned
 208 _mesa_buffer_enum_to_count(GLenum buffer)
 209 {
 210    switch (buffer) {
 211    case GL_COLOR:
 212       return 4;
 213    case GL_DEPTH_STENCIL:
 214       return 2;
 215    case GL_STENCIL:
 216    case GL_DEPTH:
 217       return 1;
 218    default:
 219       return 0;
 220    }
 221 }
 222
 223 static inline unsigned
 224 _mesa_tex_param_enum_to_count(GLenum pname)
 225 {
 226    switch (pname) {
 227    case GL_TEXTURE_MIN_FILTER:
 228    case GL_TEXTURE_MAG_FILTER:
 229    case GL_TEXTURE_WRAP_S:
 230    case GL_TEXTURE_WRAP_T:
 231    case GL_TEXTURE_WRAP_R:
 232    case GL_TEXTURE_BASE_LEVEL:
 233    case GL_TEXTURE_MAX_LEVEL:
 234    case GL_GENERATE_MIPMAP_SGIS:
 235    case GL_TEXTURE_COMPARE_MODE_ARB:
 236    case GL_TEXTURE_COMPARE_FUNC_ARB:
 237    case GL_DEPTH_TEXTURE_MODE_ARB:
 238    case GL_DEPTH_STENCIL_TEXTURE_MODE:
 239    case GL_TEXTURE_SRGB_DECODE_EXT:
 240    case GL_TEXTURE_CUBE_MAP_SEAMLESS:
 241    case GL_TEXTURE_SWIZZLE_R:
 242    case GL_TEXTURE_SWIZZLE_G:
 243    case GL_TEXTURE_SWIZZLE_B:
 244    case GL_TEXTURE_SWIZZLE_A:
 245    case GL_TEXTURE_MIN_LOD:
 246    case GL_TEXTURE_MAX_LOD:
 247    case GL_TEXTURE_PRIORITY:
 248    case GL_TEXTURE_MAX_ANISOTROPY_EXT:
 249    case GL_TEXTURE_LOD_BIAS:
 250    case GL_TEXTURE_TILING_EXT:
 251       return 1;
 252    case GL_TEXTURE_CROP_RECT_OES:
 253    case GL_TEXTURE_SWIZZLE_RGBA:
 254    case GL_TEXTURE_BORDER_COLOR:
 255       return 4;
 256    default:
 257       return 0;
 258    }
 259 }
 260
 261 static inline unsigned
 262 _mesa_fog_enum_to_count(GLenum pname)
 263 {
 264    switch (pname) {
 265    case GL_FOG_MODE:
 266    case GL_FOG_DENSITY:
 267    case GL_FOG_START:
 268    case GL_FOG_END:
 269    case GL_FOG_INDEX:
 270    case GL_FOG_COORDINATE_SOURCE_EXT:
 271    case GL_FOG_DISTANCE_MODE_NV:
 272       return 1;
 273    case GL_FOG_COLOR:
 274       return 4;
 275    default:
 276       return 0;
 277    }
 278 }
 279
 280 static inline unsigned
 281 _mesa_light_enum_to_count(GLenum pname)
 282 {
 283    switch (pname) {
 284    case GL_AMBIENT:
 285    case GL_DIFFUSE:
 286    case GL_SPECULAR:
 287    case GL_POSITION:
 288       return 4;
 289    case GL_SPOT_DIRECTION:
 290       return 3;
 291    case GL_SPOT_EXPONENT:
 292    case GL_SPOT_CUTOFF:
 293    case GL_CONSTANT_ATTENUATION:
 294    case GL_LINEAR_ATTENUATION:
 295    case GL_QUADRATIC_ATTENUATION:
 296       return 1;
 297    default:
 298       return 0;
 299    }
 300 }
 301
 302 static inline unsigned
 303 _mesa_light_model_enum_to_count(GLenum pname)
 304 {
 305    switch (pname) {
 306    case GL_LIGHT_MODEL_AMBIENT:
 307       return 4;
 308    case GL_LIGHT_MODEL_LOCAL_VIEWER:
 309    case GL_LIGHT_MODEL_TWO_SIDE:
 310    case GL_LIGHT_MODEL_COLOR_CONTROL:
 311       return 1;
 312    default:
 313       return 0;
 314    }
 315 }
 316
 317 static inline unsigned
 318 _mesa_texenv_enum_to_count(GLenum pname)
 319 {
 320    switch (pname) {
 321    case GL_TEXTURE_ENV_MODE:
 322    case GL_COMBINE_RGB:
 323    case GL_COMBINE_ALPHA:
 324    case GL_SOURCE0_RGB:
 325    case GL_SOURCE1_RGB:
 326    case GL_SOURCE2_RGB:
 327    case GL_SOURCE3_RGB_NV:
 328    case GL_SOURCE0_ALPHA:
 329    case GL_SOURCE1_ALPHA:
 330    case GL_SOURCE2_ALPHA:
 331    case GL_SOURCE3_ALPHA_NV:
 332    case GL_OPERAND0_RGB:
 333    case GL_OPERAND1_RGB:
 334    case GL_OPERAND2_RGB:
 335    case GL_OPERAND3_RGB_NV:
 336    case GL_OPERAND0_ALPHA:
 337    case GL_OPERAND1_ALPHA:
 338    case GL_OPERAND2_ALPHA:
 339    case GL_OPERAND3_ALPHA_NV:
 340    case GL_RGB_SCALE:
 341    case GL_ALPHA_SCALE:
 342    case GL_TEXTURE_LOD_BIAS_EXT:
 343    case GL_COORD_REPLACE_NV:
 344       return 1;
 345    case GL_TEXTURE_ENV_COLOR:
 346       return 4;
 347    default:
 348       return 0;
 349    }
 350 }
 351
 352 static inline unsigned
 353 _mesa_texgen_enum_to_count(GLenum pname)
 354 {
 355    switch (pname) {
 356    case GL_TEXTURE_GEN_MODE:
 357       return 1;
 358    case GL_OBJECT_PLANE:
 359    case GL_EYE_PLANE:
 360       return 4;
 361    default:
 362       return 0;
 363    }
 364 }
 365
 366 static inline unsigned
 367 _mesa_material_enum_to_count(GLenum pname)
 368 {
 369    switch (pname) {
 370    case GL_EMISSION:
 371    case GL_AMBIENT:
 372    case GL_DIFFUSE:
 373    case GL_SPECULAR:
 374    case GL_AMBIENT_AND_DIFFUSE:
 375       return 4;
 376    case GL_COLOR_INDEXES:
 377       return 3;
 378    case GL_SHININESS:
 379       return 1;
 380    default:
 381       return 0;
 382    }
 383 }
 384
 385 static inline unsigned
 386 _mesa_point_param_enum_to_count(GLenum pname)
 387 {
 388    switch (pname) {
 389    case GL_DISTANCE_ATTENUATION_EXT:
 390       return 3;
 391    case GL_POINT_SIZE_MIN_EXT:
 392    case GL_POINT_SIZE_MAX_EXT:
 393    case GL_POINT_FADE_THRESHOLD_SIZE_EXT:
 394    case GL_POINT_SPRITE_R_MODE_NV:
 395    case GL_POINT_SPRITE_COORD_ORIGIN:
 396       return 1;
 397    default:
 398       return 0;
 399    }
 400 }
 401
 402 static inline unsigned
 403 _mesa_calllists_enum_to_count(GLenum type)
 404 {
 405    switch (type) {
 406    case GL_BYTE:
 407    case GL_UNSIGNED_BYTE:
 408       return 1;
 409    case GL_SHORT:
 410    case GL_UNSIGNED_SHORT:
 411    case GL_2_BYTES:
 412       return 2;
 413    case GL_3_BYTES:
 414       return 3;
 415    case GL_INT:
 416    case GL_UNSIGNED_INT:
 417    case GL_FLOAT:
 418    case GL_4_BYTES:
 419       return 4;
 420    default:
 421       return 0;
 422    }
 423 }
 424
 425 static inline unsigned
 426 _mesa_patch_param_enum_to_count(GLenum pname)
 427 {
 428    switch (pname) {
 429    case GL_PATCH_DEFAULT_OUTER_LEVEL:
 430       return 4;
 431    case GL_PATCH_DEFAULT_INNER_LEVEL:
 432       return 2;
 433    default:
 434       return 0;
 435    }
 436 }
 437
 438 static inline unsigned
 439 _mesa_memobj_enum_to_count(GLenum pname)
 440 {
 441    switch (pname) {
 442    case GL_DEDICATED_MEMORY_OBJECT_EXT:
 443       return 1;
 444    default:
 445       return 0;
 446    }
 447 }
 448
 449 static inline unsigned
 450 _mesa_semaphore_enum_to_count(GLenum pname)
 451 {
 452    switch (pname) {
 453    /* EXT_semaphore and EXT_semaphore_fd define no parameters */
 454    default:
 455       return 0;
 456    }
 457 }
 458
 459 #endif /* MARSHAL_H */