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