src/gallium/auxiliary/draw/draw_llvm_sample.c

   1 /**************************************************************************
   2  *
   3  * Copyright 2010 VMware, Inc.
   4  * All rights reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  19  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  20  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
  21  * IN NO EVENT SHALL VMWARE AND/OR ITS SUPPLIERS BE LIABLE FOR
  22  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  23  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
  24  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27
  28 /**
  29  * Texture sampling code generation
  30  * @author Jose Fonseca <jfonseca@vmware.com>
  31  */
  32
  33 #include "pipe/p_defines.h"
  34 #include "pipe/p_shader_tokens.h"
  35 #include "gallivm/lp_bld_const.h"
  36 #include "gallivm/lp_bld_debug.h"
  37 #include "gallivm/lp_bld_type.h"
  38 #include "gallivm/lp_bld_sample.h"
  39 #include "gallivm/lp_bld_tgsi.h"
  40
  41
  42 #include "util/u_debug.h"
  43 #include "util/u_memory.h"
  44 #include "util/u_pointer.h"
  45 #include "util/u_string.h"
  46
  47 #include "draw_llvm.h"
  48
  49
  50 /**
  51  * This provides the bridge between the sampler state store in
  52  * lp_jit_context and lp_jit_texture and the sampler code
  53  * generator. It provides the texture layout information required by
  54  * the texture sampler code generator in terms of the state stored in
  55  * lp_jit_context and lp_jit_texture in runtime.
  56  */
  57 struct draw_llvm_sampler_dynamic_state
  58 {
  59    struct lp_sampler_dynamic_state base;
  60
  61    const struct draw_sampler_static_state *static_state;
  62 };
  63
  64
  65 /**
  66  * This is the bridge between our sampler and the TGSI translator.
  67  */
  68 struct draw_llvm_sampler_soa
  69 {
  70    struct lp_build_sampler_soa base;
  71
  72    struct draw_llvm_sampler_dynamic_state dynamic_state;
  73
  74    unsigned nr_samplers;
  75 };
  76
  77 struct draw_llvm_image_dynamic_state
  78 {
  79    struct lp_sampler_dynamic_state base;
  80
  81    const struct draw_image_static_state *static_state;
  82 };
  83
  84 struct draw_llvm_image_soa
  85 {
  86    struct lp_build_image_soa base;
  87
  88    struct draw_llvm_image_dynamic_state dynamic_state;
  89
  90    unsigned nr_images;
  91 };
  92
  93 /**
  94  * Fetch the specified member of the lp_jit_texture structure.
  95  * \param emit_load  if TRUE, emit the LLVM load instruction to actually
  96  *                   fetch the field's value.  Otherwise, just emit the
  97  *                   GEP code to address the field.
  98  *
  99  * @sa http://llvm.org/docs/GetElementPtr.html
 100  */
 101 static LLVMValueRef
 102 draw_llvm_texture_member(const struct lp_sampler_dynamic_state *base,
 103                          struct gallivm_state *gallivm,
 104                          LLVMValueRef context_ptr,
 105                          unsigned texture_unit,
 106                          LLVMValueRef texture_unit_offset,
 107                          unsigned member_index,
 108                          const char *member_name,
 109                          boolean emit_load)
 110 {
 111    LLVMBuilderRef builder = gallivm->builder;
 112    LLVMValueRef indices[4];
 113    LLVMValueRef ptr;
 114    LLVMValueRef res;
 115
 116    debug_assert(texture_unit < PIPE_MAX_SHADER_SAMPLER_VIEWS);
 117
 118    /* context[0] */
 119    indices[0] = lp_build_const_int32(gallivm, 0);
 120    /* context[0].textures */
 121    indices[1] = lp_build_const_int32(gallivm, DRAW_JIT_CTX_TEXTURES);
 122    /* context[0].textures[unit] */
 123    indices[2] = lp_build_const_int32(gallivm, texture_unit);
 124    if (texture_unit_offset) {
 125       indices[2] = LLVMBuildAdd(gallivm->builder, indices[2], texture_unit_offset, "");
 126       LLVMValueRef cond = LLVMBuildICmp(gallivm->builder, LLVMIntULT, indices[2], lp_build_const_int32(gallivm, PIPE_MAX_SHADER_SAMPLER_VIEWS), "");
 127       indices[2] = LLVMBuildSelect(gallivm->builder, cond, indices[2], lp_build_const_int32(gallivm, texture_unit), "");
 128    }
 129    /* context[0].textures[unit].member */
 130    indices[3] = lp_build_const_int32(gallivm, member_index);
 131
 132    ptr = LLVMBuildGEP(builder, context_ptr, indices, ARRAY_SIZE(indices), "");
 133
 134    if (emit_load)
 135       res = LLVMBuildLoad(builder, ptr, "");
 136    else
 137       res = ptr;
 138
 139    lp_build_name(res, "context.texture%u.%s", texture_unit, member_name);
 140
 141    return res;
 142 }
 143
 144
 145 /**
 146  * Fetch the specified member of the lp_jit_sampler structure.
 147  * \param emit_load  if TRUE, emit the LLVM load instruction to actually
 148  *                   fetch the field's value.  Otherwise, just emit the
 149  *                   GEP code to address the field.
 150  *
 151  * @sa http://llvm.org/docs/GetElementPtr.html
 152  */
 153 static LLVMValueRef
 154 draw_llvm_sampler_member(const struct lp_sampler_dynamic_state *base,
 155                          struct gallivm_state *gallivm,
 156                          LLVMValueRef context_ptr,
 157                          unsigned sampler_unit,
 158                          unsigned member_index,
 159                          const char *member_name,
 160                          boolean emit_load)
 161 {
 162    LLVMBuilderRef builder = gallivm->builder;
 163    LLVMValueRef indices[4];
 164    LLVMValueRef ptr;
 165    LLVMValueRef res;
 166
 167    debug_assert(sampler_unit < PIPE_MAX_SAMPLERS);
 168
 169    /* context[0] */
 170    indices[0] = lp_build_const_int32(gallivm, 0);
 171    /* context[0].samplers */
 172    indices[1] = lp_build_const_int32(gallivm, DRAW_JIT_CTX_SAMPLERS);
 173    /* context[0].samplers[unit] */
 174    indices[2] = lp_build_const_int32(gallivm, sampler_unit);
 175    /* context[0].samplers[unit].member */
 176    indices[3] = lp_build_const_int32(gallivm, member_index);
 177
 178    ptr = LLVMBuildGEP(builder, context_ptr, indices, ARRAY_SIZE(indices), "");
 179
 180    if (emit_load)
 181       res = LLVMBuildLoad(builder, ptr, "");
 182    else
 183       res = ptr;
 184
 185    lp_build_name(res, "context.sampler%u.%s", sampler_unit, member_name);
 186
 187    return res;
 188 }
 189
 190 /**
 191  * Fetch the specified member of the lp_jit_texture structure.
 192  * \param emit_load  if TRUE, emit the LLVM load instruction to actually
 193  *                   fetch the field's value.  Otherwise, just emit the
 194  *                   GEP code to address the field.
 195  *
 196  * @sa http://llvm.org/docs/GetElementPtr.html
 197  */
 198 static LLVMValueRef
 199 draw_llvm_image_member(const struct lp_sampler_dynamic_state *base,
 200                        struct gallivm_state *gallivm,
 201                        LLVMValueRef context_ptr,
 202                        unsigned image_unit,
 203                        LLVMValueRef image_unit_offset,
 204                        unsigned member_index,
 205                        const char *member_name,
 206                        boolean emit_load)
 207 {
 208    LLVMBuilderRef builder = gallivm->builder;
 209    LLVMValueRef indices[4];
 210    LLVMValueRef ptr;
 211    LLVMValueRef res;
 212
 213    debug_assert(image_unit < PIPE_MAX_SHADER_IMAGES);
 214
 215    /* context[0] */
 216    indices[0] = lp_build_const_int32(gallivm, 0);
 217    /* context[0].textures */
 218    indices[1] = lp_build_const_int32(gallivm, DRAW_JIT_CTX_IMAGES);
 219    /* context[0].textures[unit] */
 220    indices[2] = lp_build_const_int32(gallivm, image_unit);
 221    if (image_unit_offset) {
 222       indices[2] = LLVMBuildAdd(gallivm->builder, indices[2], image_unit_offset, "");
 223       LLVMValueRef cond = LLVMBuildICmp(gallivm->builder, LLVMIntULT, indices[2], lp_build_const_int32(gallivm, PIPE_MAX_SHADER_IMAGES), "");
 224       indices[2] = LLVMBuildSelect(gallivm->builder, cond, indices[2], lp_build_const_int32(gallivm, image_unit), "");
 225    }
 226    /* context[0].textures[unit].member */
 227    indices[3] = lp_build_const_int32(gallivm, member_index);
 228
 229    ptr = LLVMBuildGEP(builder, context_ptr, indices, ARRAY_SIZE(indices), "");
 230
 231    if (emit_load)
 232       res = LLVMBuildLoad(builder, ptr, "");
 233    else
 234       res = ptr;
 235
 236    lp_build_name(res, "context.image%u.%s", image_unit, member_name);
 237
 238    return res;
 239 }
 240
 241 /**
 242  * Helper macro to instantiate the functions that generate the code to
 243  * fetch the members of lp_jit_texture to fulfill the sampler code
 244  * generator requests.
 245  *
 246  * This complexity is the price we have to pay to keep the texture
 247  * sampler code generator a reusable module without dependencies to
 248  * llvmpipe internals.
 249  */
 250 #define DRAW_LLVM_TEXTURE_MEMBER(_name, _index, _emit_load)  \
 251    static LLVMValueRef \
 252    draw_llvm_texture_##_name( const struct lp_sampler_dynamic_state *base, \
 253                               struct gallivm_state *gallivm,               \
 254                               LLVMValueRef context_ptr,                    \
 255                               unsigned texture_unit,                       \
 256                               LLVMValueRef texture_unit_offset)            \
 257    { \
 258       return draw_llvm_texture_member(base, gallivm, context_ptr, \
 259                                       texture_unit, texture_unit_offset, \
 260                                       _index, #_name, _emit_load );     \
 261    }
 262
 263
 264 DRAW_LLVM_TEXTURE_MEMBER(width,      DRAW_JIT_TEXTURE_WIDTH, TRUE)
 265 DRAW_LLVM_TEXTURE_MEMBER(height,     DRAW_JIT_TEXTURE_HEIGHT, TRUE)
 266 DRAW_LLVM_TEXTURE_MEMBER(depth,      DRAW_JIT_TEXTURE_DEPTH, TRUE)
 267 DRAW_LLVM_TEXTURE_MEMBER(first_level,DRAW_JIT_TEXTURE_FIRST_LEVEL, TRUE)
 268 DRAW_LLVM_TEXTURE_MEMBER(last_level, DRAW_JIT_TEXTURE_LAST_LEVEL, TRUE)
 269 DRAW_LLVM_TEXTURE_MEMBER(base_ptr,   DRAW_JIT_TEXTURE_BASE, TRUE)
 270 DRAW_LLVM_TEXTURE_MEMBER(row_stride, DRAW_JIT_TEXTURE_ROW_STRIDE, FALSE)
 271 DRAW_LLVM_TEXTURE_MEMBER(img_stride, DRAW_JIT_TEXTURE_IMG_STRIDE, FALSE)
 272 DRAW_LLVM_TEXTURE_MEMBER(mip_offsets, DRAW_JIT_TEXTURE_MIP_OFFSETS, FALSE)
 273 DRAW_LLVM_TEXTURE_MEMBER(num_samples, DRAW_JIT_TEXTURE_NUM_SAMPLES, TRUE)
 274 DRAW_LLVM_TEXTURE_MEMBER(sample_stride, DRAW_JIT_TEXTURE_SAMPLE_STRIDE, TRUE)
 275
 276 #define DRAW_LLVM_SAMPLER_MEMBER(_name, _index, _emit_load)  \
 277    static LLVMValueRef \
 278    draw_llvm_sampler_##_name( const struct lp_sampler_dynamic_state *base, \
 279                               struct gallivm_state *gallivm,               \
 280                               LLVMValueRef context_ptr,                    \
 281                               unsigned sampler_unit)                       \
 282    { \
 283       return draw_llvm_sampler_member(base, gallivm, context_ptr, \
 284                                       sampler_unit, _index, #_name, _emit_load ); \
 285    }
 286
 287
 288 DRAW_LLVM_SAMPLER_MEMBER(min_lod,    DRAW_JIT_SAMPLER_MIN_LOD, TRUE)
 289 DRAW_LLVM_SAMPLER_MEMBER(max_lod,    DRAW_JIT_SAMPLER_MAX_LOD, TRUE)
 290 DRAW_LLVM_SAMPLER_MEMBER(lod_bias,   DRAW_JIT_SAMPLER_LOD_BIAS, TRUE)
 291 DRAW_LLVM_SAMPLER_MEMBER(border_color, DRAW_JIT_SAMPLER_BORDER_COLOR, FALSE)
 292
 293 #define DRAW_LLVM_IMAGE_MEMBER(_name, _index, _emit_load)  \
 294    static LLVMValueRef \
 295    draw_llvm_image_##_name( const struct lp_sampler_dynamic_state *base, \
 296                             struct gallivm_state *gallivm,               \
 297                             LLVMValueRef context_ptr,                    \
 298                             unsigned image_unit, LLVMValueRef image_unit_offset) \
 299    { \
 300       return draw_llvm_image_member(base, gallivm, context_ptr, \
 301                                     image_unit, image_unit_offset, \
 302                                     _index, #_name, _emit_load );  \
 303    }
 304
 305
 306 DRAW_LLVM_IMAGE_MEMBER(width,      DRAW_JIT_IMAGE_WIDTH, TRUE)
 307 DRAW_LLVM_IMAGE_MEMBER(height,     DRAW_JIT_IMAGE_HEIGHT, TRUE)
 308 DRAW_LLVM_IMAGE_MEMBER(depth,      DRAW_JIT_IMAGE_DEPTH, TRUE)
 309 DRAW_LLVM_IMAGE_MEMBER(base_ptr,   DRAW_JIT_IMAGE_BASE, TRUE)
 310 DRAW_LLVM_IMAGE_MEMBER(row_stride, DRAW_JIT_IMAGE_ROW_STRIDE, TRUE)
 311 DRAW_LLVM_IMAGE_MEMBER(img_stride, DRAW_JIT_IMAGE_IMG_STRIDE, TRUE)
 312 DRAW_LLVM_IMAGE_MEMBER(num_samples, DRAW_JIT_IMAGE_NUM_SAMPLES, TRUE)
 313 DRAW_LLVM_IMAGE_MEMBER(sample_stride, DRAW_JIT_IMAGE_SAMPLE_STRIDE, TRUE)
 314
 315 static void
 316 draw_llvm_sampler_soa_destroy(struct lp_build_sampler_soa *sampler)
 317 {
 318    FREE(sampler);
 319 }
 320
 321
 322 /**
 323  * Fetch filtered values from texture.
 324  * The 'texel' parameter returns four vectors corresponding to R, G, B, A.
 325  */
 326 static void
 327 draw_llvm_sampler_soa_emit_fetch_texel(const struct lp_build_sampler_soa *base,
 328                                        struct gallivm_state *gallivm,
 329                                        const struct lp_sampler_params *params)
 330 {
 331    struct draw_llvm_sampler_soa *sampler = (struct draw_llvm_sampler_soa *)base;
 332    unsigned texture_index = params->texture_index;
 333    unsigned sampler_index = params->sampler_index;
 334
 335    assert(texture_index < PIPE_MAX_SHADER_SAMPLER_VIEWS);
 336    assert(sampler_index < PIPE_MAX_SAMPLERS);
 337
 338    if (params->texture_index_offset) {
 339       struct lp_build_sample_array_switch switch_info;
 340       memset(&switch_info, 0, sizeof(switch_info));
 341       LLVMValueRef unit = LLVMBuildAdd(gallivm->builder, params->texture_index_offset,
 342                                        lp_build_const_int32(gallivm, texture_index), "");
 343       lp_build_sample_array_init_soa(&switch_info, gallivm, params, unit,
 344                                      0, sampler->nr_samplers);
 345
 346       for (unsigned i = 0; i < sampler->nr_samplers; i++) {
 347          lp_build_sample_array_case_soa(&switch_info, i,
 348                                         &sampler->dynamic_state.static_state[i].texture_state,
 349                                         &sampler->dynamic_state.static_state[i].sampler_state,
 350                                         &sampler->dynamic_state.base);
 351       }
 352       lp_build_sample_array_fini_soa(&switch_info);
 353    } else {
 354       lp_build_sample_soa(&sampler->dynamic_state.static_state[texture_index].texture_state,
 355                           &sampler->dynamic_state.static_state[sampler_index].sampler_state,
 356                           &sampler->dynamic_state.base,
 357                           gallivm, params);
 358    }
 359 }
 360
 361
 362 /**
 363  * Fetch the texture size.
 364  */
 365 static void
 366 draw_llvm_sampler_soa_emit_size_query(const struct lp_build_sampler_soa *base,
 367                                       struct gallivm_state *gallivm,
 368                                       const struct lp_sampler_size_query_params *params)
 369 {
 370    struct draw_llvm_sampler_soa *sampler = (struct draw_llvm_sampler_soa *)base;
 371
 372    assert(params->texture_unit < PIPE_MAX_SHADER_SAMPLER_VIEWS);
 373
 374    lp_build_size_query_soa(gallivm,
 375                            &sampler->dynamic_state.static_state[params->texture_unit].texture_state,
 376                            &sampler->dynamic_state.base,
 377                            params);
 378 }
 379
 380 struct lp_build_sampler_soa *
 381 draw_llvm_sampler_soa_create(const struct draw_sampler_static_state *static_state,
 382                              unsigned nr_samplers)
 383 {
 384    struct draw_llvm_sampler_soa *sampler;
 385
 386    sampler = CALLOC_STRUCT(draw_llvm_sampler_soa);
 387    if (!sampler)
 388       return NULL;
 389
 390    sampler->base.destroy = draw_llvm_sampler_soa_destroy;
 391    sampler->base.emit_tex_sample = draw_llvm_sampler_soa_emit_fetch_texel;
 392    sampler->base.emit_size_query = draw_llvm_sampler_soa_emit_size_query;
 393    sampler->dynamic_state.base.width = draw_llvm_texture_width;
 394    sampler->dynamic_state.base.height = draw_llvm_texture_height;
 395    sampler->dynamic_state.base.depth = draw_llvm_texture_depth;
 396    sampler->dynamic_state.base.first_level = draw_llvm_texture_first_level;
 397    sampler->dynamic_state.base.last_level = draw_llvm_texture_last_level;
 398    sampler->dynamic_state.base.row_stride = draw_llvm_texture_row_stride;
 399    sampler->dynamic_state.base.img_stride = draw_llvm_texture_img_stride;
 400    sampler->dynamic_state.base.base_ptr = draw_llvm_texture_base_ptr;
 401    sampler->dynamic_state.base.mip_offsets = draw_llvm_texture_mip_offsets;
 402    sampler->dynamic_state.base.num_samples = draw_llvm_texture_num_samples;
 403    sampler->dynamic_state.base.sample_stride = draw_llvm_texture_sample_stride;
 404    sampler->dynamic_state.base.min_lod = draw_llvm_sampler_min_lod;
 405    sampler->dynamic_state.base.max_lod = draw_llvm_sampler_max_lod;
 406    sampler->dynamic_state.base.lod_bias = draw_llvm_sampler_lod_bias;
 407    sampler->dynamic_state.base.border_color = draw_llvm_sampler_border_color;
 408    sampler->dynamic_state.static_state = static_state;
 409
 410    sampler->nr_samplers = nr_samplers;
 411    return &sampler->base;
 412 }
 413
 414 static void
 415 draw_llvm_image_soa_emit_op(const struct lp_build_image_soa *base,
 416                             struct gallivm_state *gallivm,
 417                             const struct lp_img_params *params)
 418 {
 419    struct draw_llvm_image_soa *image = (struct draw_llvm_image_soa *)base;
 420    unsigned image_index = params->image_index;
 421    assert(image_index < PIPE_MAX_SHADER_IMAGES);
 422
 423    lp_build_img_op_soa(&image->dynamic_state.static_state[image_index].image_state,
 424                        &image->dynamic_state.base,
 425                        gallivm, params, params->outdata);
 426 }
 427 /**
 428  * Fetch the texture size.
 429  */
 430 static void
 431 draw_llvm_image_soa_emit_size_query(const struct lp_build_image_soa *base,
 432                                     struct gallivm_state *gallivm,
 433                                     const struct lp_sampler_size_query_params *params)
 434 {
 435    struct draw_llvm_image_soa *image = (struct draw_llvm_image_soa *)base;
 436
 437    assert(params->texture_unit < PIPE_MAX_SHADER_IMAGES);
 438
 439    lp_build_size_query_soa(gallivm,
 440                            &image->dynamic_state.static_state[params->texture_unit].image_state,
 441                            &image->dynamic_state.base,
 442                            params);
 443 }
 444 static void
 445 draw_llvm_image_soa_destroy(struct lp_build_image_soa *image)
 446 {
 447    FREE(image);
 448 }
 449
 450 struct lp_build_image_soa *
 451 draw_llvm_image_soa_create(const struct draw_image_static_state *static_state,
 452                            unsigned nr_images)
 453 {
 454    struct draw_llvm_image_soa *image;
 455
 456    image = CALLOC_STRUCT(draw_llvm_image_soa);
 457    if (!image)
 458       return NULL;
 459
 460    image->base.destroy = draw_llvm_image_soa_destroy;
 461    image->base.emit_op = draw_llvm_image_soa_emit_op;
 462    image->base.emit_size_query = draw_llvm_image_soa_emit_size_query;
 463
 464    image->dynamic_state.base.width = draw_llvm_image_width;
 465    image->dynamic_state.base.height = draw_llvm_image_height;
 466
 467    image->dynamic_state.base.depth = draw_llvm_image_depth;
 468    image->dynamic_state.base.base_ptr = draw_llvm_image_base_ptr;
 469    image->dynamic_state.base.row_stride = draw_llvm_image_row_stride;
 470    image->dynamic_state.base.img_stride = draw_llvm_image_img_stride;
 471    image->dynamic_state.base.num_samples = draw_llvm_image_num_samples;
 472    image->dynamic_state.base.sample_stride = draw_llvm_image_sample_stride;
 473
 474    image->dynamic_state.static_state = static_state;
 475
 476    image->nr_images = nr_images;
 477    return &image->base;
 478 }