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 #ifndef LP_TEXTURE_H
29 #define LP_TEXTURE_H
30
31
32 #include "pipe/p_state.h"
33 #include "util/u_debug.h"
34 #include "lp_limits.h"
35
36
37 enum lp_texture_usage
38 {
39 LP_TEX_USAGE_READ = 100,
40 LP_TEX_USAGE_READ_WRITE,
41 LP_TEX_USAGE_WRITE_ALL
42 };
43
44
45 struct pipe_context;
46 struct pipe_screen;
47 struct llvmpipe_context;
48
49 struct sw_displaytarget;
50
51
52 /**
53 * llvmpipe subclass of pipe_resource. A texture, drawing surface,
54 * vertex buffer, const buffer, etc.
55 * Textures are stored differently than other types of objects such as
56 * vertex buffers and const buffers.
57 * The latter are simple malloc'd blocks of memory.
58 */
59 struct llvmpipe_resource
60 {
61 struct pipe_resource base;
62
63 /** Row stride in bytes */
64 unsigned row_stride[LP_MAX_TEXTURE_LEVELS];
65 /** Image stride (for cube maps, array or 3D textures) in bytes */
66 unsigned img_stride[LP_MAX_TEXTURE_LEVELS];
67 /** Offset to start of mipmap level, in bytes */
68 unsigned mip_offsets[LP_MAX_TEXTURE_LEVELS];
69 /** allocated total size (for non-display target texture resources only) */
70 unsigned total_alloc_size;
71
72 /**
73 * Display target, for textures with the PIPE_BIND_DISPLAY_TARGET
74 * usage.
75 */
76 struct sw_displaytarget *dt;
77
78 /**
79 * Malloc'ed data for regular textures, or a mapping to dt above.
80 */
81 void *tex_data;
82
83 /**
84 * Data for non-texture resources.
85 */
86 void *data;
87
88 boolean userBuffer; /** Is this a user-space buffer? */
89 unsigned timestamp;
90
91 unsigned id; /**< temporary, for debugging */
92
93 unsigned sample_stride;
94
95 uint64_t size_required;
96 uint64_t backing_offset;
97 bool backable;
98 #ifdef DEBUG
99 /** for linked list */
100 struct llvmpipe_resource *prev, *next;
101 #endif
102 };
103
104
105 struct llvmpipe_transfer
106 {
107 struct pipe_transfer base;
108
109 unsigned long offset;
110 };
111
112
113 /** cast wrappers */
114 static inline struct llvmpipe_resource *
llvmpipe_resource(struct pipe_resource * pt)115 llvmpipe_resource(struct pipe_resource *pt)
116 {
117 return (struct llvmpipe_resource *) pt;
118 }
119
120
121 static inline const struct llvmpipe_resource *
llvmpipe_resource_const(const struct pipe_resource * pt)122 llvmpipe_resource_const(const struct pipe_resource *pt)
123 {
124 return (const struct llvmpipe_resource *) pt;
125 }
126
127
128 static inline struct llvmpipe_transfer *
llvmpipe_transfer(struct pipe_transfer * pt)129 llvmpipe_transfer(struct pipe_transfer *pt)
130 {
131 return (struct llvmpipe_transfer *) pt;
132 }
133
134
135 void llvmpipe_init_screen_resource_funcs(struct pipe_screen *screen);
136 void llvmpipe_init_context_resource_funcs(struct pipe_context *pipe);
137
138
139 static inline boolean
llvmpipe_resource_is_texture(const struct pipe_resource * resource)140 llvmpipe_resource_is_texture(const struct pipe_resource *resource)
141 {
142 switch (resource->target) {
143 case PIPE_BUFFER:
144 return FALSE;
145 case PIPE_TEXTURE_1D:
146 case PIPE_TEXTURE_1D_ARRAY:
147 case PIPE_TEXTURE_2D:
148 case PIPE_TEXTURE_2D_ARRAY:
149 case PIPE_TEXTURE_RECT:
150 case PIPE_TEXTURE_3D:
151 case PIPE_TEXTURE_CUBE:
152 case PIPE_TEXTURE_CUBE_ARRAY:
153 return TRUE;
154 default:
155 assert(0);
156 return FALSE;
157 }
158 }
159
160
161 static inline boolean
llvmpipe_resource_is_1d(const struct pipe_resource * resource)162 llvmpipe_resource_is_1d(const struct pipe_resource *resource)
163 {
164 switch (resource->target) {
165 case PIPE_BUFFER:
166 case PIPE_TEXTURE_1D:
167 case PIPE_TEXTURE_1D_ARRAY:
168 return TRUE;
169 case PIPE_TEXTURE_2D:
170 case PIPE_TEXTURE_2D_ARRAY:
171 case PIPE_TEXTURE_RECT:
172 case PIPE_TEXTURE_3D:
173 case PIPE_TEXTURE_CUBE:
174 case PIPE_TEXTURE_CUBE_ARRAY:
175 return FALSE;
176 default:
177 assert(0);
178 return FALSE;
179 }
180 }
181
182
183 static inline unsigned
llvmpipe_layer_stride(struct pipe_resource * resource,unsigned level)184 llvmpipe_layer_stride(struct pipe_resource *resource,
185 unsigned level)
186 {
187 struct llvmpipe_resource *lpr = llvmpipe_resource(resource);
188 assert(level < LP_MAX_TEXTURE_2D_LEVELS);
189 return lpr->img_stride[level];
190 }
191
192
193 static inline unsigned
llvmpipe_resource_stride(struct pipe_resource * resource,unsigned level)194 llvmpipe_resource_stride(struct pipe_resource *resource,
195 unsigned level)
196 {
197 struct llvmpipe_resource *lpr = llvmpipe_resource(resource);
198 assert(level < LP_MAX_TEXTURE_2D_LEVELS);
199 return lpr->row_stride[level];
200 }
201
202 static inline unsigned
llvmpipe_sample_stride(struct pipe_resource * resource)203 llvmpipe_sample_stride(struct pipe_resource *resource)
204 {
205 struct llvmpipe_resource *lpr = llvmpipe_resource(resource);
206 return lpr->sample_stride;
207 }
208
209 void *
210 llvmpipe_resource_map(struct pipe_resource *resource,
211 unsigned level,
212 unsigned layer,
213 enum lp_texture_usage tex_usage);
214
215 void
216 llvmpipe_resource_unmap(struct pipe_resource *resource,
217 unsigned level,
218 unsigned layer);
219
220
221 void *
222 llvmpipe_resource_data(struct pipe_resource *resource);
223
224
225 unsigned
226 llvmpipe_resource_size(const struct pipe_resource *resource);
227
228
229 ubyte *
230 llvmpipe_get_texture_image_address(struct llvmpipe_resource *lpr,
231 unsigned face_slice, unsigned level);
232
233
234 extern void
235 llvmpipe_print_resources(void);
236
237
238 #define LP_UNREFERENCED 0
239 #define LP_REFERENCED_FOR_READ (1 << 0)
240 #define LP_REFERENCED_FOR_WRITE (1 << 1)
241
242 unsigned int
243 llvmpipe_is_resource_referenced( struct pipe_context *pipe,
244 struct pipe_resource *presource,
245 unsigned level);
246
247 unsigned
248 llvmpipe_get_format_alignment(enum pipe_format format);
249
250 void *
251 llvmpipe_transfer_map_ms( struct pipe_context *pipe,
252 struct pipe_resource *resource,
253 unsigned level,
254 unsigned usage,
255 unsigned sample,
256 const struct pipe_box *box,
257 struct pipe_transfer **transfer );
258 #endif /* LP_TEXTURE_H */
259