pb_buffer_fenced.h revision 92fcbf6e7bc622dcace226bb70ff6d5cdbdbaecb 
1/**************************************************************************
2 *
3 * Copyright 2007 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/**
29 * \file
30 * Buffer fencing.
31 *
32 * "Fenced buffers" is actually a misnomer. They should be referred as
33 * "fenceable buffers", i.e, buffers that can be fenced, but I couldn't find
34 * the word "fenceable" in the dictionary.
35 *
36 * A "fenced buffer" is a decorator around a normal buffer, which adds two
37 * special properties:
38 * - the ability for the destruction to be delayed by a fence;
39 * - reference counting.
40 *
41 * Usually DMA buffers have a life-time that will extend the life-time of its
42 * handle. The end-of-life is dictated by the fence signalling.
43 *
44 * Between the handle's destruction, and the fence signalling, the buffer is
45 * stored in a fenced buffer list.
46 *
47 * \author Jos� Fonseca <jrfonseca@tungstengraphics.com>
48 */
49
50#ifndef PB_BUFFER_FENCED_H_
51#define PB_BUFFER_FENCED_H_
52
53
54#include "pipe/p_debug.h"
55
56
57struct pipe_winsys;
58struct pipe_buffer;
59struct pipe_fence_handle;
60
61
62/**
63 * List of buffers which are awaiting fence signalling.
64 */
65struct fenced_buffer_list;
66
67
68/**
69 * The fenced buffer's virtual function table.
70 *
71 * NOTE: Made public for debugging purposes.
72 */
73extern const struct pb_vtbl fenced_buffer_vtbl;
74
75
76/**
77 * Create a fenced buffer list.
78 *
79 * See also fenced_bufmgr_create for a more convenient way to use this.
80 */
81struct fenced_buffer_list *
82fenced_buffer_list_create(struct pipe_winsys *winsys);
83
84
85/**
86 * Walk the fenced buffer list to check and free signalled buffers.
87 */
88void
89fenced_buffer_list_check_free(struct fenced_buffer_list *fenced_list,
90                              int wait);
91
92void
93fenced_buffer_list_destroy(struct fenced_buffer_list *fenced_list);
94
95
96/**
97 * Wrap a buffer in a fenced buffer.
98 *
99 * NOTE: this will not increase the buffer reference count.
100 */
101struct pb_buffer *
102fenced_buffer_create(struct fenced_buffer_list *fenced,
103                     struct pb_buffer *buffer);
104
105
106/**
107 * Set a buffer's fence.
108 *
109 * NOTE: Although it takes a generic pb_buffer argument, it will fail
110 * on everything but buffers returned by fenced_buffer_create.
111 */
112void
113buffer_fence(struct pb_buffer *buf,
114             struct pipe_fence_handle *fence);
115
116
117#endif /*PB_BUFFER_FENCED_H_*/
118