intel: Add support for LLC-cached reads of X-tiled miptrees using a blit.
[mesa.git] / 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 gl_format format;
143
144 /**
145 * The X offset of each image in the miptree must be aligned to this. See
146 * the "Alignment Unit Size" section of the BSpec.
147 */
148 unsigned int align_w;
149 unsigned int align_h; /**< \see align_w */
150
151 GLuint first_level;
152 GLuint last_level;
153
154 GLuint width0, height0, depth0; /**< Level zero image dimensions */
155 GLuint cpp;
156 bool compressed;
157
158 /* Derived from the above:
159 */
160 GLuint total_width;
161 GLuint total_height;
162
163 /* Includes image offset tables:
164 */
165 struct intel_mipmap_level level[MAX_TEXTURE_LEVELS];
166
167 /* The data is held here:
168 */
169 struct intel_region *region;
170
171 /**
172 * \brief HiZ miptree
173 *
174 * This is non-null only if HiZ is enabled for this miptree.
175 *
176 * \see intel_miptree_alloc_hiz()
177 */
178 struct intel_mipmap_tree *hiz_mt;
179
180 /**
181 * \brief Map of miptree slices to needed resolves.
182 *
183 * This is used only when the miptree has a child HiZ miptree.
184 *
185 * Let \c mt be a depth miptree with HiZ enabled. Then the resolve map is
186 * \c mt->hiz_map. The resolve map of the child HiZ miptree, \c
187 * mt->hiz_mt->hiz_map, is unused.
188 */
189 struct intel_resolve_map hiz_map;
190
191 /**
192 * \brief Stencil miptree for depthstencil textures.
193 *
194 * This miptree is used for depthstencil textures that require separate
195 * stencil. The stencil miptree's data is the golden copy of the
196 * parent miptree's stencil bits. When necessary, we scatter/gather the
197 * stencil bits between the parent miptree and the stencil miptree.
198 *
199 * \see intel_miptree_s8z24_scatter()
200 * \see intel_miptree_s8z24_gather()
201 */
202 struct intel_mipmap_tree *stencil_mt;
203
204 /* These are also refcounted:
205 */
206 GLuint refcount;
207 };
208
209
210
211 struct intel_mipmap_tree *intel_miptree_create(struct intel_context *intel,
212 GLenum target,
213 gl_format format,
214 GLuint first_level,
215 GLuint last_level,
216 GLuint width0,
217 GLuint height0,
218 GLuint depth0,
219 bool expect_accelerated_upload);
220
221 struct intel_mipmap_tree *
222 intel_miptree_create_for_region(struct intel_context *intel,
223 GLenum target,
224 gl_format format,
225 struct intel_region *region);
226
227 /**
228 * Create a miptree appropriate as the storage for a non-texture renderbuffer.
229 * The miptree has the following properties:
230 * - The target is GL_TEXTURE_2D.
231 * - There are no levels other than the base level 0.
232 * - Depth is 1.
233 */
234 struct intel_mipmap_tree*
235 intel_miptree_create_for_renderbuffer(struct intel_context *intel,
236 gl_format format,
237 uint32_t tiling,
238 uint32_t cpp,
239 uint32_t width,
240 uint32_t height);
241
242 /** \brief Assert that the level and layer are valid for the miptree. */
243 static inline void
244 intel_miptree_check_level_layer(struct intel_mipmap_tree *mt,
245 uint32_t level,
246 uint32_t layer)
247 {
248 assert(level >= mt->first_level);
249 assert(level <= mt->last_level);
250 assert(layer < mt->level[level].depth);
251 }
252
253 int intel_miptree_pitch_align (struct intel_context *intel,
254 struct intel_mipmap_tree *mt,
255 uint32_t tiling,
256 int pitch);
257
258 void intel_miptree_reference(struct intel_mipmap_tree **dst,
259 struct intel_mipmap_tree *src);
260
261 void intel_miptree_release(struct intel_mipmap_tree **mt);
262
263 /* Check if an image fits an existing mipmap tree layout
264 */
265 bool intel_miptree_match_image(struct intel_mipmap_tree *mt,
266 struct gl_texture_image *image);
267
268 void
269 intel_miptree_get_image_offset(struct intel_mipmap_tree *mt,
270 GLuint level, GLuint face, GLuint depth,
271 GLuint *x, GLuint *y);
272
273 void
274 intel_miptree_get_dimensions_for_image(struct gl_texture_image *image,
275 int *width, int *height, int *depth);
276
277 void intel_miptree_set_level_info(struct intel_mipmap_tree *mt,
278 GLuint level,
279 GLuint x, GLuint y,
280 GLuint w, GLuint h, GLuint d);
281
282 void intel_miptree_set_image_offset(struct intel_mipmap_tree *mt,
283 GLuint level,
284 GLuint img, GLuint x, GLuint y);
285
286 void
287 intel_miptree_copy_teximage(struct intel_context *intel,
288 struct intel_texture_image *intelImage,
289 struct intel_mipmap_tree *dst_mt);
290
291 /**
292 * Copy the stencil data from \c mt->stencil_mt->region to \c mt->region for
293 * the given miptree slice.
294 *
295 * \see intel_mipmap_tree::stencil_mt
296 */
297 void
298 intel_miptree_s8z24_scatter(struct intel_context *intel,
299 struct intel_mipmap_tree *mt,
300 uint32_t level,
301 uint32_t slice);
302
303 /**
304 * Copy the stencil data in \c mt->stencil_mt->region to \c mt->region for the
305 * given miptree slice.
306 *
307 * \see intel_mipmap_tree::stencil_mt
308 */
309 void
310 intel_miptree_s8z24_gather(struct intel_context *intel,
311 struct intel_mipmap_tree *mt,
312 uint32_t level,
313 uint32_t layer);
314
315 /**
316 * \name Miptree HiZ functions
317 * \{
318 *
319 * It is safe to call the "slice_set_need_resolve" and "slice_resolve"
320 * functions on a miptree without HiZ. In that case, each function is a no-op.
321 */
322
323 /**
324 * \brief Allocate the miptree's embedded HiZ miptree.
325 * \see intel_mipmap_tree:hiz_mt
326 * \return false if allocation failed
327 */
328
329 bool
330 intel_miptree_alloc_hiz(struct intel_context *intel,
331 struct intel_mipmap_tree *mt);
332
333 void
334 intel_miptree_slice_set_needs_hiz_resolve(struct intel_mipmap_tree *mt,
335 uint32_t level,
336 uint32_t depth);
337 void
338 intel_miptree_slice_set_needs_depth_resolve(struct intel_mipmap_tree *mt,
339 uint32_t level,
340 uint32_t depth);
341 void
342 intel_miptree_all_slices_set_need_hiz_resolve(struct intel_mipmap_tree *mt);
343
344 void
345 intel_miptree_all_slices_set_need_depth_resolve(struct intel_mipmap_tree *mt);
346
347 /**
348 * \return false if no resolve was needed
349 */
350 bool
351 intel_miptree_slice_resolve_hiz(struct intel_context *intel,
352 struct intel_mipmap_tree *mt,
353 unsigned int level,
354 unsigned int depth);
355
356 /**
357 * \return false if no resolve was needed
358 */
359 bool
360 intel_miptree_slice_resolve_depth(struct intel_context *intel,
361 struct intel_mipmap_tree *mt,
362 unsigned int level,
363 unsigned int depth);
364
365 /**
366 * \return false if no resolve was needed
367 */
368 bool
369 intel_miptree_all_slices_resolve_hiz(struct intel_context *intel,
370 struct intel_mipmap_tree *mt);
371
372 /**
373 * \return false if no resolve was needed
374 */
375 bool
376 intel_miptree_all_slices_resolve_depth(struct intel_context *intel,
377 struct intel_mipmap_tree *mt);
378
379 /**\}*/
380
381 /* i915_mipmap_tree.c:
382 */
383 void i915_miptree_layout(struct intel_mipmap_tree *mt);
384 void i945_miptree_layout(struct intel_mipmap_tree *mt);
385 void brw_miptree_layout(struct intel_context *intel,
386 struct intel_mipmap_tree *mt);
387
388 void
389 intel_miptree_map(struct intel_context *intel,
390 struct intel_mipmap_tree *mt,
391 unsigned int level,
392 unsigned int slice,
393 unsigned int x,
394 unsigned int y,
395 unsigned int w,
396 unsigned int h,
397 GLbitfield mode,
398 void **out_ptr,
399 int *out_stride);
400
401 void
402 intel_miptree_unmap(struct intel_context *intel,
403 struct intel_mipmap_tree *mt,
404 unsigned int level,
405 unsigned int slice);
406
407 #endif