src/mesa/drivers/dri/intel/intel_mipmap_tree.h

   1 /**************************************************************************
   2  *
   3  * Copyright 2006 Tungsten Graphics, Inc., Cedar Park, Texas.
   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 TUNGSTEN GRAPHICS 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 #ifndef INTEL_MIPMAP_TREE_H
  29 #define INTEL_MIPMAP_TREE_H
  30
  31 #include <assert.h>
  32
  33 #include "intel_regions.h"
  34 #include "intel_resolve_map.h"
  35
  36 /* A layer on top of the intel_regions code which adds:
  37  *
  38  * - Code to size and layout a region to hold a set of mipmaps.
  39  * - Query to determine if a new image fits in an existing tree.
  40  * - More refcounting
  41  *     - maybe able to remove refcounting from intel_region?
  42  * - ?
  43  *
  44  * The fixed mipmap layout of intel hardware where one offset
  45  * specifies the position of all images in a mipmap hierachy
  46  * complicates the implementation of GL texture image commands,
  47  * compared to hardware where each image is specified with an
  48  * independent offset.
  49  *
  50  * In an ideal world, each texture object would be associated with a
  51  * single bufmgr buffer or 2d intel_region, and all the images within
  52  * the texture object would slot into the tree as they arrive.  The
  53  * reality can be a little messier, as images can arrive from the user
  54  * with sizes that don't fit in the existing tree, or in an order
  55  * where the tree layout cannot be guessed immediately.
  56  *
  57  * This structure encodes an idealized mipmap tree.  The GL image
  58  * commands build these where possible, otherwise store the images in
  59  * temporary system buffers.
  60  */
  61
  62 struct intel_resolve_map;
  63 struct intel_texture_image;
  64
  65 struct intel_miptree_map {
  66    /** Bitfield of GL_MAP_READ_BIT, GL_MAP_WRITE_BIT, GL_MAP_INVALIDATE_BIT */
  67    GLbitfield mode;
  68    /** Region of interest for the map. */
  69    int x, y, w, h;
  70    /** Possibly malloced temporary buffer for the mapping. */
  71    void *buffer;
  72    /** Possible pointer to a BO temporary for the mapping. */
  73    drm_intel_bo *bo;
  74    /** Pointer to the start of (map_x, map_y) returned by the mapping. */
  75    void *ptr;
  76    /** Stride of the mapping. */
  77    int stride;
  78 };
  79
  80 /**
  81  * Describes the location of each texture image within a texture region.
  82  */
  83 struct intel_mipmap_level
  84 {
  85    /** Offset to this miptree level, used in computing x_offset. */
  86    GLuint level_x;
  87    /** Offset to this miptree level, used in computing y_offset. */
  88    GLuint level_y;
  89    GLuint width;
  90    GLuint height;
  91
  92    /**
  93     * \brief Number of 2D slices in this miplevel.
  94     *
  95     * The exact semantics of depth varies according to the texture target:
  96     *    - For GL_TEXTURE_CUBE_MAP, depth is 6.
  97     *    - For GL_TEXTURE_2D_ARRAY, depth is the number of array slices. It is
  98     *      identical for all miplevels in the texture.
  99     *    - For GL_TEXTURE_3D, it is the texture's depth at this miplevel. Its
 100     *      value, like width and height, varies with miplevel.
 101     *    - For other texture types, depth is 1.
 102     */
 103    GLuint depth;
 104
 105    /**
 106     * \brief List of 2D images in this mipmap level.
 107     *
 108     * This may be a list of cube faces, array slices in 2D array texture, or
 109     * layers in a 3D texture. The list's length is \c depth.
 110     */
 111    struct intel_mipmap_slice {
 112       /**
 113        * \name Offset to slice
 114        * \{
 115        *
 116        * Hardware formats are so diverse that that there is no unified way to
 117        * compute the slice offsets, so we store them in this table.
 118        *
 119        * The (x, y) offset to slice \c s at level \c l relative the miptrees
 120        * base address is
 121        * \code
 122        *     x = mt->level[l].slice[s].x_offset
 123        *     y = mt->level[l].slice[s].y_offset
 124        */
 125       GLuint x_offset;
 126       GLuint y_offset;
 127       /** \} */
 128
 129       /**
 130        * Pointer to mapping information, present across
 131        * intel_tex_image_map()/unmap of the slice.
 132        */
 133       struct intel_miptree_map *map;
 134    } *slice;
 135 };
 136
 137 struct intel_mipmap_tree
 138 {
 139    /* Effectively the key:
 140     */
 141    GLenum target;
 142
 143    /**
 144     * Generally, this is just the same as the gl_texture_image->TexFormat or
 145     * gl_renderbuffer->Format.
 146     *
 147     * However, for textures and renderbuffers with packed depth/stencil formats
 148     * on hardware where we want or need to use separate stencil, there will be
 149     * two miptrees for storing the data.  If the depthstencil texture or rb is
 150     * MESA_FORMAT_Z32_FLOAT_X24S8, then mt->format will be
 151     * MESA_FORMAT_Z32_FLOAT, otherwise for MESA_FORMAT_S8_Z24 objects it will be
 152     * MESA_FORMAT_S8_Z24 (textures) or MESA_FORMAT_X8_Z24 (renderbuffers).
 153     * mt->stencil_mt->format will always be MESA_FORMAT_S8.
 154     */
 155    gl_format format;
 156
 157    /**
 158     * The X offset of each image in the miptree must be aligned to this. See
 159     * the "Alignment Unit Size" section of the BSpec.
 160     */
 161    unsigned int align_w;
 162    unsigned int align_h; /**< \see align_w */
 163
 164    GLuint first_level;
 165    GLuint last_level;
 166
 167    GLuint width0, height0, depth0; /**< Level zero image dimensions */
 168    GLuint cpp;
 169    bool compressed;
 170
 171    /* Derived from the above:
 172     */
 173    GLuint total_width;
 174    GLuint total_height;
 175
 176    /* Includes image offset tables:
 177     */
 178    struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
 179
 180    /* The data is held here:
 181     */
 182    struct intel_region *region;
 183
 184    /**
 185     * \brief HiZ miptree
 186     *
 187     * This is non-null only if HiZ is enabled for this miptree.
 188     *
 189     * \see intel_miptree_alloc_hiz()
 190     */
 191    struct intel_mipmap_tree *hiz_mt;
 192
 193    /**
 194     * \brief Map of miptree slices to needed resolves.
 195     *
 196     * This is used only when the miptree has a child HiZ miptree.
 197     *
 198     * Let \c mt be a depth miptree with HiZ enabled. Then the resolve map is
 199     * \c mt->hiz_map. The resolve map of the child HiZ miptree, \c
 200     * mt->hiz_mt->hiz_map, is unused.
 201     */
 202    struct intel_resolve_map hiz_map;
 203
 204    /**
 205     * \brief Stencil miptree for depthstencil textures.
 206     *
 207     * This miptree is used for depthstencil textures and renderbuffers that
 208     * require separate stencil.  It always has the true copy of the stencil
 209     * bits, regardless of mt->format.
 210     *
 211     * \see intel_miptree_map_depthstencil()
 212     * \see intel_miptree_unmap_depthstencil()
 213     */
 214    struct intel_mipmap_tree *stencil_mt;
 215
 216    /* These are also refcounted:
 217     */
 218    GLuint refcount;
 219 };
 220
 221
 222
 223 struct intel_mipmap_tree *intel_miptree_create(struct intel_context *intel,
 224                                                GLenum target,
 225                                                gl_format format,
 226                                                GLuint first_level,
 227                                                GLuint last_level,
 228                                                GLuint width0,
 229                                                GLuint height0,
 230                                                GLuint depth0,
 231                                                bool expect_accelerated_upload);
 232
 233 struct intel_mipmap_tree *
 234 intel_miptree_create_for_region(struct intel_context *intel,
 235                                 GLenum target,
 236                                 gl_format format,
 237                                 struct intel_region *region);
 238
 239 /**
 240  * Create a miptree appropriate as the storage for a non-texture renderbuffer.
 241  * The miptree has the following properties:
 242  *     - The target is GL_TEXTURE_2D.
 243  *     - There are no levels other than the base level 0.
 244  *     - Depth is 1.
 245  */
 246 struct intel_mipmap_tree*
 247 intel_miptree_create_for_renderbuffer(struct intel_context *intel,
 248                                       gl_format format,
 249                                       uint32_t width,
 250                                       uint32_t height);
 251
 252 /** \brief Assert that the level and layer are valid for the miptree. */
 253 static inline void
 254 intel_miptree_check_level_layer(struct intel_mipmap_tree *mt,
 255                                 uint32_t level,
 256                                 uint32_t layer)
 257 {
 258    assert(level >= mt->first_level);
 259    assert(level <= mt->last_level);
 260    assert(layer < mt->level[level].depth);
 261 }
 262
 263 int intel_miptree_pitch_align (struct intel_context *intel,
 264                                struct intel_mipmap_tree *mt,
 265                                uint32_t tiling,
 266                                int pitch);
 267
 268 void intel_miptree_reference(struct intel_mipmap_tree **dst,
 269                              struct intel_mipmap_tree *src);
 270
 271 void intel_miptree_release(struct intel_mipmap_tree **mt);
 272
 273 /* Check if an image fits an existing mipmap tree layout
 274  */
 275 bool intel_miptree_match_image(struct intel_mipmap_tree *mt,
 276                                     struct gl_texture_image *image);
 277
 278 void
 279 intel_miptree_get_image_offset(struct intel_mipmap_tree *mt,
 280                                GLuint level, GLuint face, GLuint depth,
 281                                GLuint *x, GLuint *y);
 282
 283 void
 284 intel_miptree_get_dimensions_for_image(struct gl_texture_image *image,
 285                                        int *width, int *height, int *depth);
 286
 287 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
 288                                   GLuint level,
 289                                   GLuint x, GLuint y,
 290                                   GLuint w, GLuint h, GLuint d);
 291
 292 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
 293                                     GLuint level,
 294                                     GLuint img, GLuint x, GLuint y);
 295
 296 void
 297 intel_miptree_copy_teximage(struct intel_context *intel,
 298                             struct intel_texture_image *intelImage,
 299                             struct intel_mipmap_tree *dst_mt);
 300
 301 /**
 302  * Copy the stencil data from \c mt->stencil_mt->region to \c mt->region for
 303  * the given miptree slice.
 304  *
 305  * \see intel_mipmap_tree::stencil_mt
 306  */
 307 void
 308 intel_miptree_s8z24_scatter(struct intel_context *intel,
 309                             struct intel_mipmap_tree *mt,
 310                             uint32_t level,
 311                             uint32_t slice);
 312
 313 /**
 314  * Copy the stencil data in \c mt->stencil_mt->region to \c mt->region for the
 315  * given miptree slice.
 316  *
 317  * \see intel_mipmap_tree::stencil_mt
 318  */
 319 void
 320 intel_miptree_s8z24_gather(struct intel_context *intel,
 321                            struct intel_mipmap_tree *mt,
 322                            uint32_t level,
 323                            uint32_t layer);
 324
 325 /**
 326  * \name Miptree HiZ functions
 327  * \{
 328  *
 329  * It is safe to call the "slice_set_need_resolve" and "slice_resolve"
 330  * functions on a miptree without HiZ. In that case, each function is a no-op.
 331  */
 332
 333 /**
 334  * \brief Allocate the miptree's embedded HiZ miptree.
 335  * \see intel_mipmap_tree:hiz_mt
 336  * \return false if allocation failed
 337  */
 338
 339 bool
 340 intel_miptree_alloc_hiz(struct intel_context *intel,
 341                         struct intel_mipmap_tree *mt);
 342
 343 void
 344 intel_miptree_slice_set_needs_hiz_resolve(struct intel_mipmap_tree *mt,
 345                                           uint32_t level,
 346                                           uint32_t depth);
 347 void
 348 intel_miptree_slice_set_needs_depth_resolve(struct intel_mipmap_tree *mt,
 349                                             uint32_t level,
 350                                             uint32_t depth);
 351 void
 352 intel_miptree_all_slices_set_need_hiz_resolve(struct intel_mipmap_tree *mt);
 353
 354 void
 355 intel_miptree_all_slices_set_need_depth_resolve(struct intel_mipmap_tree *mt);
 356
 357 /**
 358  * \return false if no resolve was needed
 359  */
 360 bool
 361 intel_miptree_slice_resolve_hiz(struct intel_context *intel,
 362                                 struct intel_mipmap_tree *mt,
 363                                 unsigned int level,
 364                                 unsigned int depth);
 365
 366 /**
 367  * \return false if no resolve was needed
 368  */
 369 bool
 370 intel_miptree_slice_resolve_depth(struct intel_context *intel,
 371                                   struct intel_mipmap_tree *mt,
 372                                   unsigned int level,
 373                                   unsigned int depth);
 374
 375 /**
 376  * \return false if no resolve was needed
 377  */
 378 bool
 379 intel_miptree_all_slices_resolve_hiz(struct intel_context *intel,
 380                                      struct intel_mipmap_tree *mt);
 381
 382 /**
 383  * \return false if no resolve was needed
 384  */
 385 bool
 386 intel_miptree_all_slices_resolve_depth(struct intel_context *intel,
 387                                        struct intel_mipmap_tree *mt);
 388
 389 /**\}*/
 390
 391 /* i915_mipmap_tree.c:
 392  */
 393 void i915_miptree_layout(struct intel_mipmap_tree *mt);
 394 void i945_miptree_layout(struct intel_mipmap_tree *mt);
 395 void brw_miptree_layout(struct intel_context *intel,
 396                         struct intel_mipmap_tree *mt);
 397
 398 void
 399 intel_miptree_map(struct intel_context *intel,
 400                   struct intel_mipmap_tree *mt,
 401                   unsigned int level,
 402                   unsigned int slice,
 403                   unsigned int x,
 404                   unsigned int y,
 405                   unsigned int w,
 406                   unsigned int h,
 407                   GLbitfield mode,
 408                   void **out_ptr,
 409                   int *out_stride);
 410
 411 void
 412 intel_miptree_unmap(struct intel_context *intel,
 413                     struct intel_mipmap_tree *mt,
 414                     unsigned int level,
 415                     unsigned int slice);
 416
 417 #endif