src/gallium/drivers/iris/iris_resource.h

   1 /*
   2  * Copyright 2017 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  * on the rights to use, copy, modify, merge, publish, distribute, sub
   8  * license, and/or sell copies of the Software, and to permit persons to whom
   9  * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
  18  * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
  19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  21  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  22  */
  23 #ifndef IRIS_RESOURCE_H
  24 #define IRIS_RESOURCE_H
  25
  26 #include "pipe/p_state.h"
  27 #include "util/u_inlines.h"
  28 #include "util/u_range.h"
  29 #include "intel/isl/isl.h"
  30
  31 struct iris_batch;
  32 struct iris_context;
  33
  34 #define IRIS_MAX_MIPLEVELS 15
  35
  36 struct iris_format_info {
  37    enum isl_format fmt;
  38    struct isl_swizzle swizzle;
  39 };
  40
  41 #define IRIS_RESOURCE_FLAG_SHADER_MEMZONE  (PIPE_RESOURCE_FLAG_DRV_PRIV << 0)
  42 #define IRIS_RESOURCE_FLAG_SURFACE_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 1)
  43 #define IRIS_RESOURCE_FLAG_DYNAMIC_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 2)
  44
  45 enum gen9_astc5x5_wa_tex_type {
  46    GEN9_ASTC5X5_WA_TEX_TYPE_ASTC5x5 = 1 << 0,
  47    GEN9_ASTC5X5_WA_TEX_TYPE_AUX     = 1 << 1,
  48 };
  49
  50 /**
  51  * Resources represent a GPU buffer object or image (mipmap tree).
  52  *
  53  * They contain the storage (BO) and layout information (ISL surface).
  54  */
  55 struct iris_resource {
  56    struct pipe_resource base;
  57    enum pipe_format internal_format;
  58
  59    /**
  60     * The ISL surface layout information for this resource.
  61     *
  62     * This is not filled out for PIPE_BUFFER resources, but is guaranteed
  63     * to be zeroed.  Note that this also guarantees that res->surf.tiling
  64     * will be ISL_TILING_LINEAR, so it's safe to check that.
  65     */
  66    struct isl_surf surf;
  67
  68    /** Backing storage for the resource */
  69    struct iris_bo *bo;
  70
  71    /** offset at which data starts in the BO */
  72    uint64_t offset;
  73
  74    /**
  75     * A bitfield of PIPE_BIND_* indicating how this resource was bound
  76     * in the past.  Only meaningful for PIPE_BUFFER; used for flushing.
  77     */
  78    unsigned bind_history;
  79
  80    /**
  81     * For PIPE_BUFFER resources, a range which may contain valid data.
  82     *
  83     * This is a conservative estimate of what part of the buffer contains
  84     * valid data that we have to preserve.  The rest of the buffer is
  85     * considered invalid, and we can promote writes to that region to
  86     * be unsynchronized writes, avoiding blit copies.
  87     */
  88    struct util_range valid_buffer_range;
  89
  90    /**
  91     * Auxiliary buffer information (CCS, MCS, or HiZ).
  92     */
  93    struct {
  94       /** The surface layout for the auxiliary buffer. */
  95       struct isl_surf surf;
  96
  97       /** The buffer object containing the auxiliary data. */
  98       struct iris_bo *bo;
  99
 100       /** Offset into 'bo' where the auxiliary surface starts. */
 101       uint32_t offset;
 102
 103       /**
 104        * Fast clear color for this surface.  For depth surfaces, the clear
 105        * value is stored as a float32 in the red component.
 106        */
 107       union isl_color_value clear_color;
 108
 109       /** Buffer object containing the indirect clear color.  */
 110       struct iris_bo *clear_color_bo;
 111
 112       /** Offset into bo where the clear color can be found.  */
 113       uint64_t clear_color_offset;
 114
 115       /**
 116        * \brief The type of auxiliary compression used by this resource.
 117        *
 118        * This describes the type of auxiliary compression that is intended to
 119        * be used by this resource.  An aux usage of ISL_AUX_USAGE_NONE means
 120        * that auxiliary compression is permanently disabled.  An aux usage
 121        * other than ISL_AUX_USAGE_NONE does not imply that auxiliary
 122        * compression will always be enabled for this surface.
 123        */
 124       enum isl_aux_usage usage;
 125
 126       /**
 127        * A bitfield of ISL_AUX_* modes that might this resource might use.
 128        *
 129        * For example, a surface might use both CCS_E and CCS_D at times.
 130        */
 131       unsigned possible_usages;
 132
 133       /**
 134        * Same as possible_usages, but only with modes supported for sampling.
 135        */
 136       unsigned sampler_usages;
 137
 138       /**
 139        * \brief Maps miptree slices to their current aux state.
 140        *
 141        * This two-dimensional array is indexed as [level][layer] and stores an
 142        * aux state for each slice.
 143        */
 144       enum isl_aux_state **state;
 145
 146       /**
 147        * If (1 << level) is set, HiZ is enabled for that miplevel.
 148        */
 149       uint16_t has_hiz;
 150    } aux;
 151
 152    /**
 153     * For external surfaces, this is DRM format modifier that was used to
 154     * create or import the surface.  For internal surfaces, this will always
 155     * be DRM_FORMAT_MOD_INVALID.
 156     */
 157    const struct isl_drm_modifier_info *mod_info;
 158 };
 159
 160 /**
 161  * A simple <resource, offset> tuple for storing a reference to a
 162  * piece of state stored in a GPU buffer object.
 163  */
 164 struct iris_state_ref {
 165    struct pipe_resource *res;
 166    uint32_t offset;
 167 };
 168
 169 /**
 170  * Gallium CSO for sampler views (texture views).
 171  *
 172  * In addition to the normal pipe_resource, this adds an ISL view
 173  * which may reinterpret the format or restrict levels/layers.
 174  *
 175  * These can also be linear texture buffers.
 176  */
 177 struct iris_sampler_view {
 178    struct pipe_sampler_view base;
 179    struct isl_view view;
 180
 181    union isl_color_value clear_color;
 182
 183    /* A short-cut (not a reference) to the actual resource being viewed.
 184     * Multi-planar (or depth+stencil) images may have multiple resources
 185     * chained together; this skips having to traverse base->texture->*.
 186     */
 187    struct iris_resource *res;
 188
 189    /** The resource (BO) holding our SURFACE_STATE. */
 190    struct iris_state_ref surface_state;
 191 };
 192
 193 /**
 194  * Image view representation.
 195  */
 196 struct iris_image_view {
 197    struct pipe_image_view base;
 198
 199    /** The resource (BO) holding our SURFACE_STATE. */
 200    struct iris_state_ref surface_state;
 201 };
 202
 203 /**
 204  * Gallium CSO for surfaces (framebuffer attachments).
 205  *
 206  * A view of a surface that can be bound to a color render target or
 207  * depth/stencil attachment.
 208  */
 209 struct iris_surface {
 210    struct pipe_surface base;
 211    struct isl_view view;
 212    struct isl_view read_view;
 213    union isl_color_value clear_color;
 214
 215    /** The resource (BO) holding our SURFACE_STATE. */
 216    struct iris_state_ref surface_state;
 217    /** The resource (BO) holding our SURFACE_STATE for read. */
 218    struct iris_state_ref surface_state_read;
 219 };
 220
 221 /**
 222  * Transfer object - information about a buffer mapping.
 223  */
 224 struct iris_transfer {
 225    struct pipe_transfer base;
 226    struct pipe_debug_callback *dbg;
 227    void *buffer;
 228    void *ptr;
 229
 230    /** A linear staging resource for GPU-based copy_region transfers. */
 231    struct pipe_resource *staging;
 232    struct blorp_context *blorp;
 233    struct iris_batch *batch;
 234
 235    bool dest_had_defined_contents;
 236
 237    void (*unmap)(struct iris_transfer *);
 238 };
 239
 240 /**
 241  * Unwrap a pipe_resource to get the underlying iris_bo (for convenience).
 242  */
 243 static inline struct iris_bo *
 244 iris_resource_bo(struct pipe_resource *p_res)
 245 {
 246    struct iris_resource *res = (void *) p_res;
 247    return res->bo;
 248 }
 249
 250 struct iris_format_info iris_format_for_usage(const struct gen_device_info *,
 251                                               enum pipe_format pf,
 252                                               isl_surf_usage_flags_t usage);
 253
 254 struct pipe_resource *iris_resource_get_separate_stencil(struct pipe_resource *);
 255
 256 void iris_get_depth_stencil_resources(struct pipe_resource *res,
 257                                       struct iris_resource **out_z,
 258                                       struct iris_resource **out_s);
 259 bool iris_resource_set_clear_color(struct iris_context *ice,
 260                                    struct iris_resource *res,
 261                                    union isl_color_value color);
 262 union isl_color_value
 263 iris_resource_get_clear_color(const struct iris_resource *res,
 264                               struct iris_bo **clear_color_bo,
 265                               uint64_t *clear_color_offset);
 266
 267 void iris_init_screen_resource_functions(struct pipe_screen *pscreen);
 268
 269 void iris_dirty_for_history(struct iris_context *ice,
 270                             struct iris_resource *res);
 271 uint32_t iris_flush_bits_for_history(struct iris_resource *res);
 272
 273 void iris_flush_and_dirty_for_history(struct iris_context *ice,
 274                                       struct iris_batch *batch,
 275                                       struct iris_resource *res,
 276                                       uint32_t extra_flags,
 277                                       const char *reason);
 278
 279 unsigned iris_get_num_logical_layers(const struct iris_resource *res,
 280                                      unsigned level);
 281
 282 void iris_resource_disable_aux(struct iris_resource *res);
 283
 284 #define INTEL_REMAINING_LAYERS UINT32_MAX
 285 #define INTEL_REMAINING_LEVELS UINT32_MAX
 286
 287 void
 288 iris_hiz_exec(struct iris_context *ice,
 289               struct iris_batch *batch,
 290               struct iris_resource *res,
 291               unsigned int level, unsigned int start_layer,
 292               unsigned int num_layers, enum isl_aux_op op,
 293               bool update_clear_depth);
 294
 295 /**
 296  * Prepare a miptree for access
 297  *
 298  * This function should be called prior to any access to miptree in order to
 299  * perform any needed resolves.
 300  *
 301  * \param[in]  start_level    The first mip level to be accessed
 302  *
 303  * \param[in]  num_levels     The number of miplevels to be accessed or
 304  *                            INTEL_REMAINING_LEVELS to indicate every level
 305  *                            above start_level will be accessed
 306  *
 307  * \param[in]  start_layer    The first array slice or 3D layer to be accessed
 308  *
 309  * \param[in]  num_layers     The number of array slices or 3D layers be
 310  *                            accessed or INTEL_REMAINING_LAYERS to indicate
 311  *                            every layer above start_layer will be accessed
 312  *
 313  * \param[in]  aux_supported  Whether or not the access will support the
 314  *                            miptree's auxiliary compression format;  this
 315  *                            must be false for uncompressed miptrees
 316  *
 317  * \param[in]  fast_clear_supported Whether or not the access will support
 318  *                                  fast clears in the miptree's auxiliary
 319  *                                  compression format
 320  */
 321 void
 322 iris_resource_prepare_access(struct iris_context *ice,
 323                              struct iris_batch *batch,
 324                              struct iris_resource *res,
 325                              uint32_t start_level, uint32_t num_levels,
 326                              uint32_t start_layer, uint32_t num_layers,
 327                              enum isl_aux_usage aux_usage,
 328                              bool fast_clear_supported);
 329
 330 /**
 331  * Complete a write operation
 332  *
 333  * This function should be called after any operation writes to a miptree.
 334  * This will update the miptree's compression state so that future resolves
 335  * happen correctly.  Technically, this function can be called before the
 336  * write occurs but the caller must ensure that they don't interlace
 337  * iris_resource_prepare_access and iris_resource_finish_write calls to
 338  * overlapping layer/level ranges.
 339  *
 340  * \param[in]  level             The mip level that was written
 341  *
 342  * \param[in]  start_layer       The first array slice or 3D layer written
 343  *
 344  * \param[in]  num_layers        The number of array slices or 3D layers
 345  *                               written or INTEL_REMAINING_LAYERS to indicate
 346  *                               every layer above start_layer was written
 347  *
 348  * \param[in]  written_with_aux  Whether or not the write was done with
 349  *                               auxiliary compression enabled
 350  */
 351 void
 352 iris_resource_finish_write(struct iris_context *ice,
 353                            struct iris_resource *res, uint32_t level,
 354                            uint32_t start_layer, uint32_t num_layers,
 355                            enum isl_aux_usage aux_usage);
 356
 357 /** Get the auxiliary compression state of a miptree slice */
 358 enum isl_aux_state
 359 iris_resource_get_aux_state(const struct iris_resource *res,
 360                             uint32_t level, uint32_t layer);
 361
 362 /**
 363  * Set the auxiliary compression state of a miptree slice range
 364  *
 365  * This function directly sets the auxiliary compression state of a slice
 366  * range of a miptree.  It only modifies data structures and does not do any
 367  * resolves.  This should only be called by code which directly performs
 368  * compression operations such as fast clears and resolves.  Most code should
 369  * use iris_resource_prepare_access or iris_resource_finish_write.
 370  */
 371 void
 372 iris_resource_set_aux_state(struct iris_context *ice,
 373                             struct iris_resource *res, uint32_t level,
 374                             uint32_t start_layer, uint32_t num_layers,
 375                             enum isl_aux_state aux_state);
 376
 377 /**
 378  * Prepare a miptree for raw access
 379  *
 380  * This helper prepares the miptree for access that knows nothing about any
 381  * sort of compression whatsoever.  This is useful when mapping the surface or
 382  * using it with the blitter.
 383  */
 384 static inline void
 385 iris_resource_access_raw(struct iris_context *ice,
 386                          struct iris_batch *batch,
 387                          struct iris_resource *res,
 388                          uint32_t level, uint32_t layer,
 389                          uint32_t num_layers,
 390                          bool write)
 391 {
 392    iris_resource_prepare_access(ice, batch, res, level, 1, layer, num_layers,
 393                                 ISL_AUX_USAGE_NONE, false);
 394    if (write) {
 395       iris_resource_finish_write(ice, res, level, layer, num_layers,
 396                                  ISL_AUX_USAGE_NONE);
 397    }
 398 }
 399
 400 enum isl_dim_layout iris_get_isl_dim_layout(const struct gen_device_info *devinfo,
 401                                             enum isl_tiling tiling,
 402                                             enum pipe_texture_target target);
 403 enum isl_surf_dim target_to_isl_surf_dim(enum pipe_texture_target target);
 404 uint32_t iris_resource_get_tile_offsets(const struct iris_resource *res,
 405                                         uint32_t level, uint32_t z,
 406                                         uint32_t *tile_x, uint32_t *tile_y);
 407 enum isl_aux_usage iris_resource_texture_aux_usage(struct iris_context *ice,
 408                                                    const struct iris_resource *res,
 409                                                    enum isl_format view_fmt,
 410                                                    enum gen9_astc5x5_wa_tex_type);
 411 void iris_resource_prepare_texture(struct iris_context *ice,
 412                                    struct iris_batch *batch,
 413                                    struct iris_resource *res,
 414                                    enum isl_format view_format,
 415                                    uint32_t start_level, uint32_t num_levels,
 416                                    uint32_t start_layer, uint32_t num_layers,
 417                                    enum gen9_astc5x5_wa_tex_type);
 418 void iris_resource_prepare_image(struct iris_context *ice,
 419                                  struct iris_batch *batch,
 420                                  struct iris_resource *res);
 421
 422 static inline bool
 423 iris_resource_unfinished_aux_import(struct iris_resource *res)
 424 {
 425    return res->base.next != NULL && res->mod_info &&
 426       res->mod_info->aux_usage != ISL_AUX_USAGE_NONE;
 427 }
 428
 429 void iris_resource_finish_aux_import(struct pipe_screen *pscreen,
 430                                      struct iris_resource *res);
 431
 432 bool iris_has_color_unresolved(const struct iris_resource *res,
 433                                unsigned start_level, unsigned num_levels,
 434                                unsigned start_layer, unsigned num_layers);
 435
 436 void iris_resource_check_level_layer(const struct iris_resource *res,
 437                                      uint32_t level, uint32_t layer);
 438
 439 bool iris_resource_level_has_hiz(const struct iris_resource *res,
 440                                  uint32_t level);
 441 bool iris_has_color_unresolved(const struct iris_resource *res,
 442                                unsigned start_level, unsigned num_levels,
 443                                unsigned start_layer, unsigned num_layers);
 444
 445 enum isl_aux_usage iris_resource_render_aux_usage(struct iris_context *ice,
 446                                                   struct iris_resource *res,
 447                                                   enum isl_format render_fmt,
 448                                                   bool blend_enabled,
 449                                                   bool draw_aux_disabled);
 450 void iris_resource_prepare_render(struct iris_context *ice,
 451                                   struct iris_batch *batch,
 452                                   struct iris_resource *res, uint32_t level,
 453                                   uint32_t start_layer, uint32_t layer_count,
 454                                   enum isl_aux_usage aux_usage);
 455 void iris_resource_finish_render(struct iris_context *ice,
 456                                  struct iris_resource *res, uint32_t level,
 457                                  uint32_t start_layer, uint32_t layer_count,
 458                                  enum isl_aux_usage aux_usage);
 459 void iris_resource_prepare_depth(struct iris_context *ice,
 460                                  struct iris_batch *batch,
 461                                  struct iris_resource *res, uint32_t level,
 462                                  uint32_t start_layer, uint32_t layer_count);
 463 void iris_resource_finish_depth(struct iris_context *ice,
 464                                 struct iris_resource *res, uint32_t level,
 465                                 uint32_t start_layer, uint32_t layer_count,
 466                                 bool depth_written);
 467 #endif