1 /**************************************************************************
3 * Copyright 2007 VMware, Inc.
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:
14 * The above copyright notice and this permission notice (including the
15 * next paragraph) shall be included in all copies or substantial portions
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.
26 **************************************************************************/
31 #include "pipe/p_context.h"
32 #include "pipe/p_defines.h"
33 #include "pipe/p_shader_tokens.h"
34 #include "pipe/p_state.h"
35 #include "pipe/p_screen.h"
36 #include "util/u_debug.h"
37 #include "util/u_debug_describe.h"
38 #include "util/u_debug_refcnt.h"
39 #include "util/u_atomic.h"
40 #include "util/u_box.h"
41 #include "util/u_math.h"
50 * Reference counting helper functions.
55 pipe_reference_init(struct pipe_reference
*reference
, unsigned count
)
57 p_atomic_set(&reference
->count
, count
);
61 pipe_is_referenced(struct pipe_reference
*reference
)
63 return p_atomic_read(&reference
->count
) != 0;
67 * Update reference counting.
68 * The old thing pointed to, if any, will be unreferenced.
69 * Both 'ptr' and 'reference' may be NULL.
70 * \return TRUE if the object's refcount hits zero and should be destroyed.
73 pipe_reference_described(struct pipe_reference
*ptr
,
74 struct pipe_reference
*reference
,
75 debug_reference_descriptor get_desc
)
77 boolean destroy
= FALSE
;
79 if(ptr
!= reference
) {
80 /* bump the reference.count first */
82 assert(pipe_is_referenced(reference
));
83 p_atomic_inc(&reference
->count
);
84 debug_reference(reference
, get_desc
, 1);
88 assert(pipe_is_referenced(ptr
));
89 if (p_atomic_dec_zero(&ptr
->count
)) {
92 debug_reference(ptr
, get_desc
, -1);
100 pipe_reference(struct pipe_reference
*ptr
, struct pipe_reference
*reference
)
102 return pipe_reference_described(ptr
, reference
,
103 (debug_reference_descriptor
)debug_describe_reference
);
107 pipe_surface_reference(struct pipe_surface
**ptr
, struct pipe_surface
*surf
)
109 struct pipe_surface
*old_surf
= *ptr
;
111 if (pipe_reference_described(&(*ptr
)->reference
, &surf
->reference
,
112 (debug_reference_descriptor
)debug_describe_surface
))
113 old_surf
->context
->surface_destroy(old_surf
->context
, old_surf
);
118 * Similar to pipe_surface_reference() but always set the pointer to NULL
119 * and pass in an explicit context. The explicit context avoids the problem
120 * of using a deleted context's surface_destroy() method when freeing a surface
121 * that's shared by multiple contexts.
124 pipe_surface_release(struct pipe_context
*pipe
, struct pipe_surface
**ptr
)
126 if (pipe_reference_described(&(*ptr
)->reference
, NULL
,
127 (debug_reference_descriptor
)debug_describe_surface
))
128 pipe
->surface_destroy(pipe
, *ptr
);
134 pipe_resource_reference(struct pipe_resource
**ptr
, struct pipe_resource
*tex
)
136 struct pipe_resource
*old_tex
= *ptr
;
138 if (pipe_reference_described(&(*ptr
)->reference
, &tex
->reference
,
139 (debug_reference_descriptor
)debug_describe_resource
)) {
140 pipe_resource_reference(&old_tex
->next
, NULL
);
141 old_tex
->screen
->resource_destroy(old_tex
->screen
, old_tex
);
147 pipe_sampler_view_reference(struct pipe_sampler_view
**ptr
, struct pipe_sampler_view
*view
)
149 struct pipe_sampler_view
*old_view
= *ptr
;
151 if (pipe_reference_described(&(*ptr
)->reference
, &view
->reference
,
152 (debug_reference_descriptor
)debug_describe_sampler_view
))
153 old_view
->context
->sampler_view_destroy(old_view
->context
, old_view
);
158 * Similar to pipe_sampler_view_reference() but always set the pointer to
159 * NULL and pass in an explicit context. Passing an explicit context is a
160 * work-around for fixing a dangling context pointer problem when textures
161 * are shared by multiple contexts. XXX fix this someday.
164 pipe_sampler_view_release(struct pipe_context
*ctx
,
165 struct pipe_sampler_view
**ptr
)
167 struct pipe_sampler_view
*old_view
= *ptr
;
168 if (*ptr
&& (*ptr
)->context
!= ctx
) {
169 debug_printf_once(("context mis-match in pipe_sampler_view_release()\n"));
171 if (pipe_reference_described(&(*ptr
)->reference
, NULL
,
172 (debug_reference_descriptor
)debug_describe_sampler_view
)) {
173 ctx
->sampler_view_destroy(ctx
, old_view
);
179 pipe_so_target_reference(struct pipe_stream_output_target
**ptr
,
180 struct pipe_stream_output_target
*target
)
182 struct pipe_stream_output_target
*old
= *ptr
;
184 if (pipe_reference_described(&(*ptr
)->reference
, &target
->reference
,
185 (debug_reference_descriptor
)debug_describe_so_target
))
186 old
->context
->stream_output_target_destroy(old
->context
, old
);
191 pipe_surface_reset(struct pipe_context
*ctx
, struct pipe_surface
* ps
,
192 struct pipe_resource
*pt
, unsigned level
, unsigned layer
)
194 pipe_resource_reference(&ps
->texture
, pt
);
195 ps
->format
= pt
->format
;
196 ps
->width
= u_minify(pt
->width0
, level
);
197 ps
->height
= u_minify(pt
->height0
, level
);
198 ps
->u
.tex
.level
= level
;
199 ps
->u
.tex
.first_layer
= ps
->u
.tex
.last_layer
= layer
;
204 pipe_surface_init(struct pipe_context
*ctx
, struct pipe_surface
* ps
,
205 struct pipe_resource
*pt
, unsigned level
, unsigned layer
)
208 pipe_reference_init(&ps
->reference
, 1);
209 pipe_surface_reset(ctx
, ps
, pt
, level
, layer
);
212 /* Return true if the surfaces are equal. */
213 static inline boolean
214 pipe_surface_equal(struct pipe_surface
*s1
, struct pipe_surface
*s2
)
216 return s1
->texture
== s2
->texture
&&
217 s1
->format
== s2
->format
&&
218 (s1
->texture
->target
!= PIPE_BUFFER
||
219 (s1
->u
.buf
.first_element
== s2
->u
.buf
.first_element
&&
220 s1
->u
.buf
.last_element
== s2
->u
.buf
.last_element
)) &&
221 (s1
->texture
->target
== PIPE_BUFFER
||
222 (s1
->u
.tex
.level
== s2
->u
.tex
.level
&&
223 s1
->u
.tex
.first_layer
== s2
->u
.tex
.first_layer
&&
224 s1
->u
.tex
.last_layer
== s2
->u
.tex
.last_layer
));
228 * Convenience wrappers for screen buffer functions.
233 * Create a new resource.
234 * \param bind bitmask of PIPE_BIND_x flags
235 * \param usage a PIPE_USAGE_x value
237 static inline struct pipe_resource
*
238 pipe_buffer_create( struct pipe_screen
*screen
,
240 enum pipe_resource_usage usage
,
243 struct pipe_resource buffer
;
244 memset(&buffer
, 0, sizeof buffer
);
245 buffer
.target
= PIPE_BUFFER
;
246 buffer
.format
= PIPE_FORMAT_R8_UNORM
; /* want TYPELESS or similar */
248 buffer
.usage
= usage
;
250 buffer
.width0
= size
;
253 buffer
.array_size
= 1;
254 return screen
->resource_create(screen
, &buffer
);
259 * Map a range of a resource.
260 * \param offset start of region, in bytes
261 * \param length size of region, in bytes
262 * \param access bitmask of PIPE_TRANSFER_x flags
263 * \param transfer returns a transfer object
266 pipe_buffer_map_range(struct pipe_context
*pipe
,
267 struct pipe_resource
*buffer
,
271 struct pipe_transfer
**transfer
)
276 assert(offset
< buffer
->width0
);
277 assert(offset
+ length
<= buffer
->width0
);
280 u_box_1d(offset
, length
, &box
);
282 map
= pipe
->transfer_map(pipe
, buffer
, 0, access
, &box
, transfer
);
292 * Map whole resource.
293 * \param access bitmask of PIPE_TRANSFER_x flags
294 * \param transfer returns a transfer object
297 pipe_buffer_map(struct pipe_context
*pipe
,
298 struct pipe_resource
*buffer
,
300 struct pipe_transfer
**transfer
)
302 return pipe_buffer_map_range(pipe
, buffer
, 0, buffer
->width0
, access
, transfer
);
307 pipe_buffer_unmap(struct pipe_context
*pipe
,
308 struct pipe_transfer
*transfer
)
310 pipe
->transfer_unmap(pipe
, transfer
);
314 pipe_buffer_flush_mapped_range(struct pipe_context
*pipe
,
315 struct pipe_transfer
*transfer
,
323 assert(transfer
->box
.x
<= (int) offset
);
324 assert((int) (offset
+ length
) <= transfer
->box
.x
+ transfer
->box
.width
);
326 /* Match old screen->buffer_flush_mapped_range() behaviour, where
327 * offset parameter is relative to the start of the buffer, not the
330 transfer_offset
= offset
- transfer
->box
.x
;
332 u_box_1d(transfer_offset
, length
, &box
);
334 pipe
->transfer_flush_region(pipe
, transfer
, &box
);
338 pipe_buffer_write(struct pipe_context
*pipe
,
339 struct pipe_resource
*buf
,
344 /* Don't set any other usage bits. Drivers should derive them. */
345 pipe
->buffer_subdata(pipe
, buf
, PIPE_TRANSFER_WRITE
, offset
, size
, data
);
349 * Special case for writing non-overlapping ranges.
351 * We can avoid GPU/CPU synchronization when writing range that has never
352 * been written before.
355 pipe_buffer_write_nooverlap(struct pipe_context
*pipe
,
356 struct pipe_resource
*buf
,
357 unsigned offset
, unsigned size
,
360 pipe
->buffer_subdata(pipe
, buf
,
361 (PIPE_TRANSFER_WRITE
|
362 PIPE_TRANSFER_UNSYNCHRONIZED
),
368 * Create a new resource and immediately put data into it
369 * \param bind bitmask of PIPE_BIND_x flags
370 * \param usage bitmask of PIPE_USAGE_x flags
372 static inline struct pipe_resource
*
373 pipe_buffer_create_with_data(struct pipe_context
*pipe
,
375 enum pipe_resource_usage usage
,
379 struct pipe_resource
*res
= pipe_buffer_create(pipe
->screen
,
381 pipe_buffer_write_nooverlap(pipe
, res
, 0, size
, ptr
);
386 pipe_buffer_read(struct pipe_context
*pipe
,
387 struct pipe_resource
*buf
,
392 struct pipe_transfer
*src_transfer
;
395 map
= (ubyte
*) pipe_buffer_map_range(pipe
,
403 memcpy(data
, map
, size
);
404 pipe_buffer_unmap(pipe
, src_transfer
);
409 * Map a resource for reading/writing.
410 * \param access bitmask of PIPE_TRANSFER_x flags
413 pipe_transfer_map(struct pipe_context
*context
,
414 struct pipe_resource
*resource
,
415 unsigned level
, unsigned layer
,
417 unsigned x
, unsigned y
,
418 unsigned w
, unsigned h
,
419 struct pipe_transfer
**transfer
)
422 u_box_2d_zslice(x
, y
, layer
, w
, h
, &box
);
423 return context
->transfer_map(context
,
432 * Map a 3D (texture) resource for reading/writing.
433 * \param access bitmask of PIPE_TRANSFER_x flags
436 pipe_transfer_map_3d(struct pipe_context
*context
,
437 struct pipe_resource
*resource
,
440 unsigned x
, unsigned y
, unsigned z
,
441 unsigned w
, unsigned h
, unsigned d
,
442 struct pipe_transfer
**transfer
)
445 u_box_3d(x
, y
, z
, w
, h
, d
, &box
);
446 return context
->transfer_map(context
,
454 pipe_transfer_unmap( struct pipe_context
*context
,
455 struct pipe_transfer
*transfer
)
457 context
->transfer_unmap( context
, transfer
);
461 pipe_set_constant_buffer(struct pipe_context
*pipe
, uint shader
, uint index
,
462 struct pipe_resource
*buf
)
465 struct pipe_constant_buffer cb
;
467 cb
.buffer_offset
= 0;
468 cb
.buffer_size
= buf
->width0
;
469 cb
.user_buffer
= NULL
;
470 pipe
->set_constant_buffer(pipe
, shader
, index
, &cb
);
472 pipe
->set_constant_buffer(pipe
, shader
, index
, NULL
);
478 * Get the polygon offset enable/disable flag for the given polygon fill mode.
479 * \param fill_mode one of PIPE_POLYGON_MODE_POINT/LINE/FILL
481 static inline boolean
482 util_get_offset(const struct pipe_rasterizer_state
*templ
,
486 case PIPE_POLYGON_MODE_POINT
:
487 return templ
->offset_point
;
488 case PIPE_POLYGON_MODE_LINE
:
489 return templ
->offset_line
;
490 case PIPE_POLYGON_MODE_FILL
:
491 return templ
->offset_tri
;
499 util_get_min_point_size(const struct pipe_rasterizer_state
*state
)
501 /* The point size should be clamped to this value at the rasterizer stage.
503 return !state
->point_quad_rasterization
&&
504 !state
->point_smooth
&&
505 !state
->multisample
? 1.0f
: 0.0f
;
509 util_query_clear_result(union pipe_query_result
*result
, unsigned type
)
512 case PIPE_QUERY_OCCLUSION_PREDICATE
:
513 case PIPE_QUERY_SO_OVERFLOW_PREDICATE
:
514 case PIPE_QUERY_GPU_FINISHED
:
517 case PIPE_QUERY_OCCLUSION_COUNTER
:
518 case PIPE_QUERY_TIMESTAMP
:
519 case PIPE_QUERY_TIME_ELAPSED
:
520 case PIPE_QUERY_PRIMITIVES_GENERATED
:
521 case PIPE_QUERY_PRIMITIVES_EMITTED
:
524 case PIPE_QUERY_SO_STATISTICS
:
525 memset(&result
->so_statistics
, 0, sizeof(result
->so_statistics
));
527 case PIPE_QUERY_TIMESTAMP_DISJOINT
:
528 memset(&result
->timestamp_disjoint
, 0, sizeof(result
->timestamp_disjoint
));
530 case PIPE_QUERY_PIPELINE_STATISTICS
:
531 memset(&result
->pipeline_statistics
, 0, sizeof(result
->pipeline_statistics
));
534 memset(result
, 0, sizeof(*result
));
538 /** Convert PIPE_TEXTURE_x to TGSI_TEXTURE_x */
539 static inline unsigned
540 util_pipe_tex_to_tgsi_tex(enum pipe_texture_target pipe_tex_target
,
543 switch (pipe_tex_target
) {
545 return TGSI_TEXTURE_BUFFER
;
547 case PIPE_TEXTURE_1D
:
548 assert(nr_samples
<= 1);
549 return TGSI_TEXTURE_1D
;
551 case PIPE_TEXTURE_2D
:
552 return nr_samples
> 1 ? TGSI_TEXTURE_2D_MSAA
: TGSI_TEXTURE_2D
;
554 case PIPE_TEXTURE_RECT
:
555 assert(nr_samples
<= 1);
556 return TGSI_TEXTURE_RECT
;
558 case PIPE_TEXTURE_3D
:
559 assert(nr_samples
<= 1);
560 return TGSI_TEXTURE_3D
;
562 case PIPE_TEXTURE_CUBE
:
563 assert(nr_samples
<= 1);
564 return TGSI_TEXTURE_CUBE
;
566 case PIPE_TEXTURE_1D_ARRAY
:
567 assert(nr_samples
<= 1);
568 return TGSI_TEXTURE_1D_ARRAY
;
570 case PIPE_TEXTURE_2D_ARRAY
:
571 return nr_samples
> 1 ? TGSI_TEXTURE_2D_ARRAY_MSAA
:
572 TGSI_TEXTURE_2D_ARRAY
;
574 case PIPE_TEXTURE_CUBE_ARRAY
:
575 return TGSI_TEXTURE_CUBE_ARRAY
;
578 assert(0 && "unexpected texture target");
579 return TGSI_TEXTURE_UNKNOWN
;
585 util_copy_constant_buffer(struct pipe_constant_buffer
*dst
,
586 const struct pipe_constant_buffer
*src
)
589 pipe_resource_reference(&dst
->buffer
, src
->buffer
);
590 dst
->buffer_offset
= src
->buffer_offset
;
591 dst
->buffer_size
= src
->buffer_size
;
592 dst
->user_buffer
= src
->user_buffer
;
595 pipe_resource_reference(&dst
->buffer
, NULL
);
596 dst
->buffer_offset
= 0;
597 dst
->buffer_size
= 0;
598 dst
->user_buffer
= NULL
;
603 util_copy_image_view(struct pipe_image_view
*dst
,
604 const struct pipe_image_view
*src
)
607 pipe_resource_reference(&dst
->resource
, src
->resource
);
608 dst
->format
= src
->format
;
609 dst
->access
= src
->access
;
612 pipe_resource_reference(&dst
->resource
, NULL
);
613 dst
->format
= PIPE_FORMAT_NONE
;
615 memset(&dst
->u
, 0, sizeof(dst
->u
));
619 static inline unsigned
620 util_max_layer(const struct pipe_resource
*r
, unsigned level
)
623 case PIPE_TEXTURE_3D
:
624 return u_minify(r
->depth0
, level
) - 1;
625 case PIPE_TEXTURE_CUBE
:
626 assert(r
->array_size
== 6);
628 case PIPE_TEXTURE_1D_ARRAY
:
629 case PIPE_TEXTURE_2D_ARRAY
:
630 case PIPE_TEXTURE_CUBE_ARRAY
:
631 return r
->array_size
- 1;
638 util_texrange_covers_whole_level(const struct pipe_resource
*tex
,
639 unsigned level
, unsigned x
, unsigned y
,
640 unsigned z
, unsigned width
,
641 unsigned height
, unsigned depth
)
643 return x
== 0 && y
== 0 && z
== 0 &&
644 width
== u_minify(tex
->width0
, level
) &&
645 height
== u_minify(tex
->height0
, level
) &&
646 depth
== util_max_layer(tex
, level
) + 1;
653 #endif /* U_INLINES_H */