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_BufferData;
 155 struct marshal_cmd_BufferSubData;
 156 struct marshal_cmd_NamedBufferSubData;
 157
 158 void GLAPIENTRY
 159 _mesa_marshal_ShaderSource(GLuint shader, GLsizei count,
 160                            const GLchar * const *string, const GLint *length);
 161
 162 void
 163 _mesa_unmarshal_ShaderSource(struct gl_context *ctx,
 164                              const struct marshal_cmd_ShaderSource *cmd);
 165
 166 void
 167 _mesa_glthread_BindBuffer(struct gl_context *ctx, GLenum target, GLuint buffer);
 168
 169 void
 170 _mesa_unmarshal_BufferData(struct gl_context *ctx,
 171                            const struct marshal_cmd_BufferData *cmd);
 172
 173 void
 174 _mesa_unmarshal_NamedBufferData(struct gl_context *ctx,
 175                                 const struct marshal_cmd_BufferData *cmd);
 176
 177 void GLAPIENTRY
 178 _mesa_marshal_BufferData(GLenum target, GLsizeiptr size, const GLvoid * data,
 179                          GLenum usage);
 180
 181 void GLAPIENTRY
 182 _mesa_marshal_NamedBufferData(GLuint buffer, GLsizeiptr size,
 183                               const GLvoid * data, GLenum usage);
 184
 185 void
 186 _mesa_unmarshal_BufferSubData(struct gl_context *ctx,
 187                               const struct marshal_cmd_BufferSubData *cmd);
 188
 189 void GLAPIENTRY
 190 _mesa_marshal_BufferSubData(GLenum target, GLintptr offset, GLsizeiptr size,
 191                             const GLvoid * data);
 192
 193 void
 194 _mesa_unmarshal_NamedBufferSubData(struct gl_context *ctx,
 195                                    const struct marshal_cmd_NamedBufferSubData *cmd);
 196
 197 void GLAPIENTRY
 198 _mesa_marshal_NamedBufferSubData(GLuint buffer, GLintptr offset, GLsizeiptr size,
 199                                  const GLvoid * data);
 200
 201 static inline unsigned
 202 _mesa_buffer_enum_to_count(GLenum buffer)
 203 {
 204    switch (buffer) {
 205    case GL_COLOR:
 206       return 4;
 207    case GL_DEPTH_STENCIL:
 208       return 2;
 209    case GL_STENCIL:
 210    case GL_DEPTH:
 211       return 1;
 212    default:
 213       return 0;
 214    }
 215 }
 216
 217 static inline unsigned
 218 _mesa_tex_param_enum_to_count(GLenum pname)
 219 {
 220    switch (pname) {
 221    case GL_TEXTURE_MIN_FILTER:
 222    case GL_TEXTURE_MAG_FILTER:
 223    case GL_TEXTURE_WRAP_S:
 224    case GL_TEXTURE_WRAP_T:
 225    case GL_TEXTURE_WRAP_R:
 226    case GL_TEXTURE_BASE_LEVEL:
 227    case GL_TEXTURE_MAX_LEVEL:
 228    case GL_GENERATE_MIPMAP_SGIS:
 229    case GL_TEXTURE_COMPARE_MODE_ARB:
 230    case GL_TEXTURE_COMPARE_FUNC_ARB:
 231    case GL_DEPTH_TEXTURE_MODE_ARB:
 232    case GL_DEPTH_STENCIL_TEXTURE_MODE:
 233    case GL_TEXTURE_SRGB_DECODE_EXT:
 234    case GL_TEXTURE_CUBE_MAP_SEAMLESS:
 235    case GL_TEXTURE_SWIZZLE_R:
 236    case GL_TEXTURE_SWIZZLE_G:
 237    case GL_TEXTURE_SWIZZLE_B:
 238    case GL_TEXTURE_SWIZZLE_A:
 239    case GL_TEXTURE_MIN_LOD:
 240    case GL_TEXTURE_MAX_LOD:
 241    case GL_TEXTURE_PRIORITY:
 242    case GL_TEXTURE_MAX_ANISOTROPY_EXT:
 243    case GL_TEXTURE_LOD_BIAS:
 244    case GL_TEXTURE_TILING_EXT:
 245       return 1;
 246    case GL_TEXTURE_CROP_RECT_OES:
 247    case GL_TEXTURE_SWIZZLE_RGBA:
 248    case GL_TEXTURE_BORDER_COLOR:
 249       return 4;
 250    default:
 251       return 0;
 252    }
 253 }
 254
 255 static inline unsigned
 256 _mesa_fog_enum_to_count(GLenum pname)
 257 {
 258    switch (pname) {
 259    case GL_FOG_MODE:
 260    case GL_FOG_DENSITY:
 261    case GL_FOG_START:
 262    case GL_FOG_END:
 263    case GL_FOG_INDEX:
 264    case GL_FOG_COORDINATE_SOURCE_EXT:
 265    case GL_FOG_DISTANCE_MODE_NV:
 266       return 1;
 267    case GL_FOG_COLOR:
 268       return 4;
 269    default:
 270       return 0;
 271    }
 272 }
 273
 274 static inline unsigned
 275 _mesa_light_enum_to_count(GLenum pname)
 276 {
 277    switch (pname) {
 278    case GL_AMBIENT:
 279    case GL_DIFFUSE:
 280    case GL_SPECULAR:
 281    case GL_POSITION:
 282       return 4;
 283    case GL_SPOT_DIRECTION:
 284       return 3;
 285    case GL_SPOT_EXPONENT:
 286    case GL_SPOT_CUTOFF:
 287    case GL_CONSTANT_ATTENUATION:
 288    case GL_LINEAR_ATTENUATION:
 289    case GL_QUADRATIC_ATTENUATION:
 290       return 1;
 291    default:
 292       return 0;
 293    }
 294 }
 295
 296 static inline unsigned
 297 _mesa_light_model_enum_to_count(GLenum pname)
 298 {
 299    switch (pname) {
 300    case GL_LIGHT_MODEL_AMBIENT:
 301       return 4;
 302    case GL_LIGHT_MODEL_LOCAL_VIEWER:
 303    case GL_LIGHT_MODEL_TWO_SIDE:
 304    case GL_LIGHT_MODEL_COLOR_CONTROL:
 305       return 1;
 306    default:
 307       return 0;
 308    }
 309 }
 310
 311 static inline unsigned
 312 _mesa_texenv_enum_to_count(GLenum pname)
 313 {
 314    switch (pname) {
 315    case GL_TEXTURE_ENV_MODE:
 316    case GL_COMBINE_RGB:
 317    case GL_COMBINE_ALPHA:
 318    case GL_SOURCE0_RGB:
 319    case GL_SOURCE1_RGB:
 320    case GL_SOURCE2_RGB:
 321    case GL_SOURCE3_RGB_NV:
 322    case GL_SOURCE0_ALPHA:
 323    case GL_SOURCE1_ALPHA:
 324    case GL_SOURCE2_ALPHA:
 325    case GL_SOURCE3_ALPHA_NV:
 326    case GL_OPERAND0_RGB:
 327    case GL_OPERAND1_RGB:
 328    case GL_OPERAND2_RGB:
 329    case GL_OPERAND3_RGB_NV:
 330    case GL_OPERAND0_ALPHA:
 331    case GL_OPERAND1_ALPHA:
 332    case GL_OPERAND2_ALPHA:
 333    case GL_OPERAND3_ALPHA_NV:
 334    case GL_RGB_SCALE:
 335    case GL_ALPHA_SCALE:
 336    case GL_TEXTURE_LOD_BIAS_EXT:
 337    case GL_COORD_REPLACE_NV:
 338       return 1;
 339    case GL_TEXTURE_ENV_COLOR:
 340       return 4;
 341    default:
 342       return 0;
 343    }
 344 }
 345
 346 static inline unsigned
 347 _mesa_texgen_enum_to_count(GLenum pname)
 348 {
 349    switch (pname) {
 350    case GL_TEXTURE_GEN_MODE:
 351       return 1;
 352    case GL_OBJECT_PLANE:
 353    case GL_EYE_PLANE:
 354       return 4;
 355    default:
 356       return 0;
 357    }
 358 }
 359
 360 static inline unsigned
 361 _mesa_material_enum_to_count(GLenum pname)
 362 {
 363    switch (pname) {
 364    case GL_EMISSION:
 365    case GL_AMBIENT:
 366    case GL_DIFFUSE:
 367    case GL_SPECULAR:
 368    case GL_AMBIENT_AND_DIFFUSE:
 369       return 4;
 370    case GL_COLOR_INDEXES:
 371       return 3;
 372    case GL_SHININESS:
 373       return 1;
 374    default:
 375       return 0;
 376    }
 377 }
 378
 379 static inline unsigned
 380 _mesa_point_param_enum_to_count(GLenum pname)
 381 {
 382    switch (pname) {
 383    case GL_DISTANCE_ATTENUATION_EXT:
 384       return 3;
 385    case GL_POINT_SIZE_MIN_EXT:
 386    case GL_POINT_SIZE_MAX_EXT:
 387    case GL_POINT_FADE_THRESHOLD_SIZE_EXT:
 388    case GL_POINT_SPRITE_R_MODE_NV:
 389    case GL_POINT_SPRITE_COORD_ORIGIN:
 390       return 1;
 391    default:
 392       return 0;
 393    }
 394 }
 395
 396 static inline unsigned
 397 _mesa_calllists_enum_to_count(GLenum type)
 398 {
 399    switch (type) {
 400    case GL_BYTE:
 401    case GL_UNSIGNED_BYTE:
 402       return 1;
 403    case GL_SHORT:
 404    case GL_UNSIGNED_SHORT:
 405    case GL_2_BYTES:
 406       return 2;
 407    case GL_3_BYTES:
 408       return 3;
 409    case GL_INT:
 410    case GL_UNSIGNED_INT:
 411    case GL_FLOAT:
 412    case GL_4_BYTES:
 413       return 4;
 414    default:
 415       return 0;
 416    }
 417 }
 418
 419 static inline unsigned
 420 _mesa_patch_param_enum_to_count(GLenum pname)
 421 {
 422    switch (pname) {
 423    case GL_PATCH_DEFAULT_OUTER_LEVEL:
 424       return 4;
 425    case GL_PATCH_DEFAULT_INNER_LEVEL:
 426       return 2;
 427    default:
 428       return 0;
 429    }
 430 }
 431
 432 static inline unsigned
 433 _mesa_memobj_enum_to_count(GLenum pname)
 434 {
 435    switch (pname) {
 436    case GL_DEDICATED_MEMORY_OBJECT_EXT:
 437       return 1;
 438    default:
 439       return 0;
 440    }
 441 }
 442
 443 static inline unsigned
 444 _mesa_semaphore_enum_to_count(GLenum pname)
 445 {
 446    switch (pname) {
 447    /* EXT_semaphore and EXT_semaphore_fd define no parameters */
 448    default:
 449       return 0;
 450    }
 451 }
 452
 453 #endif /* MARSHAL_H */