st/mesa: don't return an error from update_single_texture
[mesa.git] / src / mesa / state_tracker / st_texture.c
1 /**************************************************************************
2 *
3 * Copyright 2007 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 #include <stdio.h>
29
30 #include "st_context.h"
31 #include "st_format.h"
32 #include "st_texture.h"
33 #include "st_cb_fbo.h"
34 #include "main/enums.h"
35
36 #include "pipe/p_state.h"
37 #include "pipe/p_context.h"
38 #include "pipe/p_defines.h"
39 #include "util/u_inlines.h"
40 #include "util/u_format.h"
41 #include "util/u_rect.h"
42 #include "util/u_math.h"
43 #include "util/u_memory.h"
44
45
46 #define DBG if(0) printf
47
48
49 /**
50 * Allocate a new pipe_resource object
51 * width0, height0, depth0 are the dimensions of the level 0 image
52 * (the highest resolution). last_level indicates how many mipmap levels
53 * to allocate storage for. For non-mipmapped textures, this will be zero.
54 */
55 struct pipe_resource *
56 st_texture_create(struct st_context *st,
57 enum pipe_texture_target target,
58 enum pipe_format format,
59 GLuint last_level,
60 GLuint width0,
61 GLuint height0,
62 GLuint depth0,
63 GLuint layers,
64 GLuint nr_samples,
65 GLuint bind )
66 {
67 struct pipe_resource pt, *newtex;
68 struct pipe_screen *screen = st->pipe->screen;
69
70 assert(target < PIPE_MAX_TEXTURE_TYPES);
71 assert(width0 > 0);
72 assert(height0 > 0);
73 assert(depth0 > 0);
74 if (target == PIPE_TEXTURE_CUBE)
75 assert(layers == 6);
76
77 DBG("%s target %d format %s last_level %d\n", __func__,
78 (int) target, util_format_name(format), last_level);
79
80 assert(format);
81 assert(screen->is_format_supported(screen, format, target, 0,
82 PIPE_BIND_SAMPLER_VIEW));
83
84 memset(&pt, 0, sizeof(pt));
85 pt.target = target;
86 pt.format = format;
87 pt.last_level = last_level;
88 pt.width0 = width0;
89 pt.height0 = height0;
90 pt.depth0 = depth0;
91 pt.array_size = layers;
92 pt.usage = PIPE_USAGE_DEFAULT;
93 pt.bind = bind;
94 /* only set this for OpenGL textures, not renderbuffers */
95 pt.flags = PIPE_RESOURCE_FLAG_TEXTURING_MORE_LIKELY;
96 pt.nr_samples = nr_samples;
97
98 newtex = screen->resource_create(screen, &pt);
99
100 assert(!newtex || pipe_is_referenced(&newtex->reference));
101
102 return newtex;
103 }
104
105
106 /**
107 * In OpenGL the number of 1D array texture layers is the "height" and
108 * the number of 2D array texture layers is the "depth". In Gallium the
109 * number of layers in an array texture is a separate 'array_size' field.
110 * This function converts dimensions from the former to the later.
111 */
112 void
113 st_gl_texture_dims_to_pipe_dims(GLenum texture,
114 unsigned widthIn,
115 uint16_t heightIn,
116 uint16_t depthIn,
117 unsigned *widthOut,
118 uint16_t *heightOut,
119 uint16_t *depthOut,
120 uint16_t *layersOut)
121 {
122 switch (texture) {
123 case GL_TEXTURE_1D:
124 case GL_PROXY_TEXTURE_1D:
125 assert(heightIn == 1);
126 assert(depthIn == 1);
127 *widthOut = widthIn;
128 *heightOut = 1;
129 *depthOut = 1;
130 *layersOut = 1;
131 break;
132 case GL_TEXTURE_1D_ARRAY:
133 case GL_PROXY_TEXTURE_1D_ARRAY:
134 assert(depthIn == 1);
135 *widthOut = widthIn;
136 *heightOut = 1;
137 *depthOut = 1;
138 *layersOut = heightIn;
139 break;
140 case GL_TEXTURE_2D:
141 case GL_PROXY_TEXTURE_2D:
142 case GL_TEXTURE_RECTANGLE:
143 case GL_PROXY_TEXTURE_RECTANGLE:
144 case GL_TEXTURE_EXTERNAL_OES:
145 case GL_PROXY_TEXTURE_2D_MULTISAMPLE:
146 case GL_TEXTURE_2D_MULTISAMPLE:
147 assert(depthIn == 1);
148 *widthOut = widthIn;
149 *heightOut = heightIn;
150 *depthOut = 1;
151 *layersOut = 1;
152 break;
153 case GL_TEXTURE_CUBE_MAP:
154 case GL_PROXY_TEXTURE_CUBE_MAP:
155 case GL_TEXTURE_CUBE_MAP_POSITIVE_X:
156 case GL_TEXTURE_CUBE_MAP_NEGATIVE_X:
157 case GL_TEXTURE_CUBE_MAP_POSITIVE_Y:
158 case GL_TEXTURE_CUBE_MAP_NEGATIVE_Y:
159 case GL_TEXTURE_CUBE_MAP_POSITIVE_Z:
160 case GL_TEXTURE_CUBE_MAP_NEGATIVE_Z:
161 assert(depthIn == 1);
162 *widthOut = widthIn;
163 *heightOut = heightIn;
164 *depthOut = 1;
165 *layersOut = 6;
166 break;
167 case GL_TEXTURE_2D_ARRAY:
168 case GL_TEXTURE_2D_MULTISAMPLE_ARRAY:
169 case GL_PROXY_TEXTURE_2D_ARRAY:
170 case GL_PROXY_TEXTURE_2D_MULTISAMPLE_ARRAY:
171 *widthOut = widthIn;
172 *heightOut = heightIn;
173 *depthOut = 1;
174 *layersOut = depthIn;
175 break;
176 case GL_TEXTURE_CUBE_MAP_ARRAY:
177 case GL_PROXY_TEXTURE_CUBE_MAP_ARRAY:
178 *widthOut = widthIn;
179 *heightOut = heightIn;
180 *depthOut = 1;
181 *layersOut = util_align_npot(depthIn, 6);
182 break;
183 default:
184 assert(0 && "Unexpected texture in st_gl_texture_dims_to_pipe_dims()");
185 /* fall-through */
186 case GL_TEXTURE_3D:
187 case GL_PROXY_TEXTURE_3D:
188 *widthOut = widthIn;
189 *heightOut = heightIn;
190 *depthOut = depthIn;
191 *layersOut = 1;
192 break;
193 }
194 }
195
196
197 /**
198 * Check if a texture image can be pulled into a unified mipmap texture.
199 */
200 GLboolean
201 st_texture_match_image(struct st_context *st,
202 const struct pipe_resource *pt,
203 const struct gl_texture_image *image)
204 {
205 unsigned ptWidth;
206 uint16_t ptHeight, ptDepth, ptLayers;
207
208 /* Images with borders are never pulled into mipmap textures.
209 */
210 if (image->Border)
211 return GL_FALSE;
212
213 /* Check if this image's format matches the established texture's format.
214 */
215 if (st_mesa_format_to_pipe_format(st, image->TexFormat) != pt->format)
216 return GL_FALSE;
217
218 st_gl_texture_dims_to_pipe_dims(image->TexObject->Target,
219 image->Width, image->Height, image->Depth,
220 &ptWidth, &ptHeight, &ptDepth, &ptLayers);
221
222 /* Test if this image's size matches what's expected in the
223 * established texture.
224 */
225 if (ptWidth != u_minify(pt->width0, image->Level) ||
226 ptHeight != u_minify(pt->height0, image->Level) ||
227 ptDepth != u_minify(pt->depth0, image->Level) ||
228 ptLayers != pt->array_size)
229 return GL_FALSE;
230
231 if (image->Level > pt->last_level)
232 return GL_FALSE;
233
234 return GL_TRUE;
235 }
236
237
238 /**
239 * Map a texture image and return the address for a particular 2D face/slice/
240 * layer. The stImage indicates the cube face and mipmap level. The slice
241 * of the 3D texture is passed in 'zoffset'.
242 * \param usage one of the PIPE_TRANSFER_x values
243 * \param x, y, w, h the region of interest of the 2D image.
244 * \return address of mapping or NULL if any error
245 */
246 GLubyte *
247 st_texture_image_map(struct st_context *st, struct st_texture_image *stImage,
248 enum pipe_transfer_usage usage,
249 GLuint x, GLuint y, GLuint z,
250 GLuint w, GLuint h, GLuint d,
251 struct pipe_transfer **transfer)
252 {
253 struct st_texture_object *stObj =
254 st_texture_object(stImage->base.TexObject);
255 GLuint level;
256 void *map;
257
258 DBG("%s \n", __func__);
259
260 if (!stImage->pt)
261 return NULL;
262
263 if (stObj->pt != stImage->pt)
264 level = 0;
265 else
266 level = stImage->base.Level;
267
268 if (stObj->base.Immutable) {
269 level += stObj->base.MinLevel;
270 z += stObj->base.MinLayer;
271 if (stObj->pt->array_size > 1)
272 d = MIN2(d, stObj->base.NumLayers);
273 }
274
275 z += stImage->base.Face;
276
277 map = pipe_transfer_map_3d(st->pipe, stImage->pt, level, usage,
278 x, y, z, w, h, d, transfer);
279 if (map) {
280 /* Enlarge the transfer array if it's not large enough. */
281 if (z >= stImage->num_transfers) {
282 unsigned new_size = z + 1;
283
284 stImage->transfer = realloc(stImage->transfer,
285 new_size * sizeof(struct st_texture_image_transfer));
286 memset(&stImage->transfer[stImage->num_transfers], 0,
287 (new_size - stImage->num_transfers) *
288 sizeof(struct st_texture_image_transfer));
289 stImage->num_transfers = new_size;
290 }
291
292 assert(!stImage->transfer[z].transfer);
293 stImage->transfer[z].transfer = *transfer;
294 }
295 return map;
296 }
297
298
299 void
300 st_texture_image_unmap(struct st_context *st,
301 struct st_texture_image *stImage, unsigned slice)
302 {
303 struct pipe_context *pipe = st->pipe;
304 struct st_texture_object *stObj =
305 st_texture_object(stImage->base.TexObject);
306 struct pipe_transfer **transfer;
307
308 if (stObj->base.Immutable)
309 slice += stObj->base.MinLayer;
310 transfer = &stImage->transfer[slice + stImage->base.Face].transfer;
311
312 DBG("%s\n", __func__);
313
314 pipe_transfer_unmap(pipe, *transfer);
315 *transfer = NULL;
316 }
317
318 /**
319 * For debug only: get/print center pixel in the src resource.
320 */
321 static void
322 print_center_pixel(struct pipe_context *pipe, struct pipe_resource *src)
323 {
324 struct pipe_transfer *xfer;
325 struct pipe_box region;
326 ubyte *map;
327
328 region.x = src->width0 / 2;
329 region.y = src->height0 / 2;
330 region.z = 0;
331 region.width = 1;
332 region.height = 1;
333 region.depth = 1;
334
335 map = pipe->transfer_map(pipe, src, 0, PIPE_TRANSFER_READ, &region, &xfer);
336
337 printf("center pixel: %d %d %d %d\n", map[0], map[1], map[2], map[3]);
338
339 pipe->transfer_unmap(pipe, xfer);
340 }
341
342
343 /**
344 * Copy the image at level=0 in 'src' to the 'dst' resource at 'dstLevel'.
345 * This is used to copy mipmap images from one texture buffer to another.
346 * This typically happens when our initial guess at the total texture size
347 * is incorrect (see the guess_and_alloc_texture() function).
348 */
349 void
350 st_texture_image_copy(struct pipe_context *pipe,
351 struct pipe_resource *dst, GLuint dstLevel,
352 struct pipe_resource *src, GLuint srcLevel,
353 GLuint face)
354 {
355 GLuint width = u_minify(dst->width0, dstLevel);
356 GLuint height = u_minify(dst->height0, dstLevel);
357 GLuint depth = u_minify(dst->depth0, dstLevel);
358 struct pipe_box src_box;
359 GLuint i;
360
361 if (u_minify(src->width0, srcLevel) != width ||
362 u_minify(src->height0, srcLevel) != height ||
363 u_minify(src->depth0, srcLevel) != depth) {
364 /* The source image size doesn't match the destination image size.
365 * This can happen in some degenerate situations such as rendering to a
366 * cube map face which was set up with mismatched texture sizes.
367 */
368 return;
369 }
370
371 src_box.x = 0;
372 src_box.y = 0;
373 src_box.width = width;
374 src_box.height = height;
375 src_box.depth = 1;
376
377 if (src->target == PIPE_TEXTURE_1D_ARRAY ||
378 src->target == PIPE_TEXTURE_2D_ARRAY ||
379 src->target == PIPE_TEXTURE_CUBE_ARRAY) {
380 face = 0;
381 depth = src->array_size;
382 }
383
384 /* Loop over 3D image slices */
385 /* could (and probably should) use "true" 3d box here -
386 but drivers can't quite handle it yet */
387 for (i = face; i < face + depth; i++) {
388 src_box.z = i;
389
390 if (0) {
391 print_center_pixel(pipe, src);
392 }
393
394 pipe->resource_copy_region(pipe,
395 dst,
396 dstLevel,
397 0, 0, i,/* destX, Y, Z */
398 src,
399 srcLevel,
400 &src_box);
401 }
402 }
403
404
405 struct pipe_resource *
406 st_create_color_map_texture(struct gl_context *ctx)
407 {
408 struct st_context *st = st_context(ctx);
409 struct pipe_resource *pt;
410 enum pipe_format format;
411 const uint texSize = 256; /* simple, and usually perfect */
412
413 /* find an RGBA texture format */
414 format = st_choose_format(st, GL_RGBA, GL_NONE, GL_NONE,
415 PIPE_TEXTURE_2D, 0, PIPE_BIND_SAMPLER_VIEW,
416 FALSE);
417
418 /* create texture for color map/table */
419 pt = st_texture_create(st, PIPE_TEXTURE_2D, format, 0,
420 texSize, texSize, 1, 1, 0, PIPE_BIND_SAMPLER_VIEW);
421 return pt;
422 }
423
424 /**
425 * Destroy bound texture handles for the given stage.
426 */
427 static void
428 st_destroy_bound_texture_handles_per_stage(struct st_context *st,
429 enum pipe_shader_type shader)
430 {
431 struct st_bound_handles *bound_handles = &st->bound_texture_handles[shader];
432 struct pipe_context *pipe = st->pipe;
433 unsigned i;
434
435 if (likely(!bound_handles->num_handles))
436 return;
437
438 for (i = 0; i < bound_handles->num_handles; i++) {
439 uint64_t handle = bound_handles->handles[i];
440
441 pipe->make_texture_handle_resident(pipe, handle, false);
442 pipe->delete_texture_handle(pipe, handle);
443 }
444 free(bound_handles->handles);
445 bound_handles->handles = NULL;
446 bound_handles->num_handles = 0;
447 }
448
449
450 /**
451 * Destroy all bound texture handles in the context.
452 */
453 void
454 st_destroy_bound_texture_handles(struct st_context *st)
455 {
456 unsigned i;
457
458 for (i = 0; i < PIPE_SHADER_TYPES; i++) {
459 st_destroy_bound_texture_handles_per_stage(st, i);
460 }
461 }
462
463
464 /**
465 * Destroy bound image handles for the given stage.
466 */
467 static void
468 st_destroy_bound_image_handles_per_stage(struct st_context *st,
469 enum pipe_shader_type shader)
470 {
471 struct st_bound_handles *bound_handles = &st->bound_image_handles[shader];
472 struct pipe_context *pipe = st->pipe;
473 unsigned i;
474
475 if (likely(!bound_handles->num_handles))
476 return;
477
478 for (i = 0; i < bound_handles->num_handles; i++) {
479 uint64_t handle = bound_handles->handles[i];
480
481 pipe->make_image_handle_resident(pipe, handle, GL_READ_WRITE, false);
482 pipe->delete_image_handle(pipe, handle);
483 }
484 free(bound_handles->handles);
485 bound_handles->handles = NULL;
486 bound_handles->num_handles = 0;
487 }
488
489
490 /**
491 * Destroy all bound image handles in the context.
492 */
493 void
494 st_destroy_bound_image_handles(struct st_context *st)
495 {
496 unsigned i;
497
498 for (i = 0; i < PIPE_SHADER_TYPES; i++) {
499 st_destroy_bound_image_handles_per_stage(st, i);
500 }
501 }
502
503
504 /**
505 * Create a texture handle from a texture unit.
506 */
507 static GLuint64
508 st_create_texture_handle_from_unit(struct st_context *st,
509 struct gl_program *prog, GLuint texUnit)
510 {
511 struct pipe_context *pipe = st->pipe;
512 struct pipe_sampler_view *view;
513 struct pipe_sampler_state sampler = {0};
514
515 st_update_single_texture(st, &view, texUnit, prog->sh.data->Version);
516 if (!view)
517 return 0;
518
519 if (view->target != PIPE_BUFFER)
520 st_convert_sampler_from_unit(st, &sampler, texUnit);
521
522 assert(st->ctx->Texture.Unit[texUnit]._Current);
523
524 return pipe->create_texture_handle(pipe, view, &sampler);
525 }
526
527
528 /**
529 * Create an image handle from an image unit.
530 */
531 static GLuint64
532 st_create_image_handle_from_unit(struct st_context *st,
533 struct gl_program *prog, GLuint imgUnit)
534 {
535 struct pipe_context *pipe = st->pipe;
536 struct pipe_image_view img;
537
538 st_convert_image_from_unit(st, &img, imgUnit);
539
540 return pipe->create_image_handle(pipe, &img);
541 }
542
543
544 /**
545 * Make all bindless samplers bound to texture units resident in the context.
546 */
547 void
548 st_make_bound_samplers_resident(struct st_context *st,
549 struct gl_program *prog)
550 {
551 enum pipe_shader_type shader = st_shader_stage_to_ptarget(prog->info.stage);
552 struct st_bound_handles *bound_handles = &st->bound_texture_handles[shader];
553 struct pipe_context *pipe = st->pipe;
554 GLuint64 handle;
555 int i;
556
557 /* Remove previous bound texture handles for this stage. */
558 st_destroy_bound_texture_handles_per_stage(st, shader);
559
560 if (likely(!prog->sh.HasBoundBindlessSampler))
561 return;
562
563 for (i = 0; i < prog->sh.NumBindlessSamplers; i++) {
564 struct gl_bindless_sampler *sampler = &prog->sh.BindlessSamplers[i];
565
566 if (!sampler->bound)
567 continue;
568
569 /* Request a new texture handle from the driver and make it resident. */
570 handle = st_create_texture_handle_from_unit(st, prog, sampler->unit);
571 if (!handle)
572 continue;
573
574 pipe->make_texture_handle_resident(st->pipe, handle, true);
575
576 /* Overwrite the texture unit value by the resident handle before
577 * uploading the constant buffer.
578 */
579 *(uint64_t *)sampler->data = handle;
580
581 /* Store the handle in the context. */
582 bound_handles->handles = (uint64_t *)
583 realloc(bound_handles->handles,
584 (bound_handles->num_handles + 1) * sizeof(uint64_t));
585 bound_handles->handles[bound_handles->num_handles] = handle;
586 bound_handles->num_handles++;
587 }
588 }
589
590
591 /**
592 * Make all bindless images bound to image units resident in the context.
593 */
594 void
595 st_make_bound_images_resident(struct st_context *st,
596 struct gl_program *prog)
597 {
598 enum pipe_shader_type shader = st_shader_stage_to_ptarget(prog->info.stage);
599 struct st_bound_handles *bound_handles = &st->bound_image_handles[shader];
600 struct pipe_context *pipe = st->pipe;
601 GLuint64 handle;
602 int i;
603
604 /* Remove previous bound image handles for this stage. */
605 st_destroy_bound_image_handles_per_stage(st, shader);
606
607 if (likely(!prog->sh.HasBoundBindlessImage))
608 return;
609
610 for (i = 0; i < prog->sh.NumBindlessImages; i++) {
611 struct gl_bindless_image *image = &prog->sh.BindlessImages[i];
612
613 if (!image->bound)
614 continue;
615
616 /* Request a new image handle from the driver and make it resident. */
617 handle = st_create_image_handle_from_unit(st, prog, image->unit);
618 if (!handle)
619 continue;
620
621 pipe->make_image_handle_resident(st->pipe, handle, GL_READ_WRITE, true);
622
623 /* Overwrite the image unit value by the resident handle before uploading
624 * the constant buffer.
625 */
626 *(uint64_t *)image->data = handle;
627
628 /* Store the handle in the context. */
629 bound_handles->handles = (uint64_t *)
630 realloc(bound_handles->handles,
631 (bound_handles->num_handles + 1) * sizeof(uint64_t));
632 bound_handles->handles[bound_handles->num_handles] = handle;
633 bound_handles->num_handles++;
634 }
635 }