etnaviv: don't dereference etna_resource pointer if allocation fails
[mesa.git] / src / gallium / drivers / etnaviv / etnaviv_resource.c
1 /*
2 * Copyright (c) 2012-2015 Etnaviv Project
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sub license,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice (including the
12 * next paragraph) shall be included in all copies or substantial portions
13 * of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 * DEALINGS IN THE SOFTWARE.
22 *
23 * Authors:
24 * Wladimir J. van der Laan <laanwj@gmail.com>
25 */
26
27 #include "etnaviv_resource.h"
28
29 #include "hw/common.xml.h"
30
31 #include "etnaviv_context.h"
32 #include "etnaviv_debug.h"
33 #include "etnaviv_screen.h"
34 #include "etnaviv_translate.h"
35
36 #include "util/u_inlines.h"
37 #include "util/u_memory.h"
38
39 /* A tile is 4x4 pixels, having 'screen->specs.bits_per_tile' of tile status.
40 * So, in a buffer of N pixels, there are N / (4 * 4) tiles.
41 * We need N * screen->specs.bits_per_tile / (4 * 4) bits of tile status, or
42 * N * screen->specs.bits_per_tile / (4 * 4 * 8) bytes.
43 */
44 bool
45 etna_screen_resource_alloc_ts(struct pipe_screen *pscreen,
46 struct etna_resource *rsc)
47 {
48 struct etna_screen *screen = etna_screen(pscreen);
49 size_t rt_ts_size, ts_layer_stride, pixels;
50
51 assert(!rsc->ts_bo);
52
53 /* TS only for level 0 -- XXX is this formula correct? */
54 pixels = rsc->levels[0].layer_stride / util_format_get_blocksize(rsc->base.format);
55 ts_layer_stride = align(pixels * screen->specs.bits_per_tile / 0x80,
56 0x100 * screen->specs.pixel_pipes);
57 rt_ts_size = ts_layer_stride * rsc->base.array_size;
58 if (rt_ts_size == 0)
59 return true;
60
61 DBG_F(ETNA_DBG_RESOURCE_MSGS, "%p: Allocating tile status of size %zu",
62 rsc, rt_ts_size);
63
64 struct etna_bo *rt_ts;
65 rt_ts = etna_bo_new(screen->dev, rt_ts_size, DRM_ETNA_GEM_CACHE_WC);
66
67 if (unlikely(!rt_ts)) {
68 BUG("Problem allocating tile status for resource");
69 return false;
70 }
71
72 rsc->ts_bo = rt_ts;
73 rsc->levels[0].ts_offset = 0;
74 rsc->levels[0].ts_layer_stride = ts_layer_stride;
75 rsc->levels[0].ts_size = rt_ts_size;
76
77 /* It is important to initialize the TS, as random pattern
78 * can result in crashes. Do this on the CPU as this only happens once
79 * per surface anyway and it's a small area, so it may not be worth
80 * queuing this to the GPU. */
81 void *ts_map = etna_bo_map(rt_ts);
82 memset(ts_map, screen->specs.ts_clear_value, rt_ts_size);
83
84 return true;
85 }
86
87 static boolean
88 etna_screen_can_create_resource(struct pipe_screen *pscreen,
89 const struct pipe_resource *templat)
90 {
91 struct etna_screen *screen = etna_screen(pscreen);
92 if (!translate_samples_to_xyscale(templat->nr_samples, NULL, NULL, NULL))
93 return false;
94
95 /* templat->bind is not set here, so we must use the minimum sizes */
96 uint max_size =
97 MIN2(screen->specs.max_rendertarget_size, screen->specs.max_texture_size);
98
99 if (templat->width0 > max_size || templat->height0 > max_size)
100 return false;
101
102 return true;
103 }
104
105 static unsigned
106 setup_miptree(struct etna_resource *rsc, unsigned paddingX, unsigned paddingY,
107 unsigned msaa_xscale, unsigned msaa_yscale)
108 {
109 struct pipe_resource *prsc = &rsc->base;
110 unsigned level, size = 0;
111 unsigned width = prsc->width0;
112 unsigned height = prsc->height0;
113 unsigned depth = prsc->depth0;
114
115 for (level = 0; level <= prsc->last_level; level++) {
116 struct etna_resource_level *mip = &rsc->levels[level];
117
118 mip->width = width;
119 mip->height = height;
120 mip->padded_width = align(width * msaa_xscale, paddingX);
121 mip->padded_height = align(height * msaa_yscale, paddingY);
122 mip->stride = util_format_get_stride(prsc->format, mip->padded_width);
123 mip->offset = size;
124 mip->layer_stride = mip->stride * util_format_get_nblocksy(prsc->format, mip->padded_height);
125 mip->size = prsc->array_size * mip->layer_stride;
126
127 /* align levels to 64 bytes to be able to render to them */
128 size += align(mip->size, ETNA_PE_ALIGNMENT) * depth;
129
130 width = u_minify(width, 1);
131 height = u_minify(height, 1);
132 depth = u_minify(depth, 1);
133 }
134
135 return size;
136 }
137
138 /* Create a new resource object, using the given template info */
139 struct pipe_resource *
140 etna_resource_alloc(struct pipe_screen *pscreen, unsigned layout,
141 const struct pipe_resource *templat)
142 {
143 struct etna_screen *screen = etna_screen(pscreen);
144 unsigned size;
145
146 DBG_F(ETNA_DBG_RESOURCE_MSGS,
147 "target=%d, format=%s, %ux%ux%u, array_size=%u, "
148 "last_level=%u, nr_samples=%u, usage=%u, bind=%x, flags=%x",
149 templat->target, util_format_name(templat->format), templat->width0,
150 templat->height0, templat->depth0, templat->array_size,
151 templat->last_level, templat->nr_samples, templat->usage,
152 templat->bind, templat->flags);
153
154 /* Determine scaling for antialiasing, allow override using debug flag */
155 int nr_samples = templat->nr_samples;
156 if ((templat->bind & (PIPE_BIND_RENDER_TARGET | PIPE_BIND_DEPTH_STENCIL)) &&
157 !(templat->bind & PIPE_BIND_SAMPLER_VIEW)) {
158 if (DBG_ENABLED(ETNA_DBG_MSAA_2X))
159 nr_samples = 2;
160 if (DBG_ENABLED(ETNA_DBG_MSAA_4X))
161 nr_samples = 4;
162 }
163
164 int msaa_xscale = 1, msaa_yscale = 1;
165 if (!translate_samples_to_xyscale(nr_samples, &msaa_xscale, &msaa_yscale, NULL)) {
166 /* Number of samples not supported */
167 return NULL;
168 }
169
170 /* If we have the TEXTURE_HALIGN feature, we can always align to the
171 * resolve engine's width. If not, we must not align resources used
172 * only for textures. */
173 bool rs_align = VIV_FEATURE(screen, chipMinorFeatures1, TEXTURE_HALIGN) ||
174 !etna_resource_sampler_only(templat);
175
176 /* Determine needed padding (alignment of height/width) */
177 unsigned paddingX = 0, paddingY = 0;
178 unsigned halign = TEXTURE_HALIGN_FOUR;
179 etna_layout_multiple(layout, screen->specs.pixel_pipes, rs_align, &paddingX,
180 &paddingY, &halign);
181 assert(paddingX && paddingY);
182
183 if (templat->target != PIPE_BUFFER) {
184 unsigned min_paddingY = 4 * screen->specs.pixel_pipes;
185 if (paddingY < min_paddingY)
186 paddingY = min_paddingY;
187 }
188
189 struct etna_resource *rsc = CALLOC_STRUCT(etna_resource);
190
191 if (!rsc)
192 return NULL;
193
194 rsc->base = *templat;
195 rsc->base.screen = pscreen;
196 rsc->base.nr_samples = nr_samples;
197 rsc->layout = layout;
198 rsc->halign = halign;
199
200 pipe_reference_init(&rsc->base.reference, 1);
201 list_inithead(&rsc->list);
202
203 size = setup_miptree(rsc, paddingX, paddingY, msaa_xscale, msaa_yscale);
204
205 uint32_t flags = DRM_ETNA_GEM_CACHE_WC;
206 if (templat->bind & PIPE_BIND_VERTEX_BUFFER)
207 flags |= DRM_ETNA_GEM_FORCE_MMU;
208 struct etna_bo *bo = etna_bo_new(screen->dev, size, flags);
209 if (unlikely(bo == NULL)) {
210 BUG("Problem allocating video memory for resource");
211 goto free_rsc;
212 }
213
214 rsc->bo = bo;
215 rsc->ts_bo = 0; /* TS is only created when first bound to surface */
216
217 if (templat->bind & PIPE_BIND_SCANOUT)
218 rsc->scanout = renderonly_scanout_for_resource(&rsc->base, screen->ro);
219
220 if (DBG_ENABLED(ETNA_DBG_ZERO)) {
221 void *map = etna_bo_map(bo);
222 memset(map, 0, size);
223 }
224
225 return &rsc->base;
226
227 free_rsc:
228 FREE(rsc);
229 return NULL;
230 }
231
232 static struct pipe_resource *
233 etna_resource_create(struct pipe_screen *pscreen,
234 const struct pipe_resource *templat)
235 {
236 struct etna_screen *screen = etna_screen(pscreen);
237
238 /* Figure out what tiling to use -- for now, assume that texture cannot be linear.
239 * there is a capability LINEAR_TEXTURE_SUPPORT (supported on gc880 and
240 * gc2000 at least), but not sure how it works.
241 * Buffers always have LINEAR layout.
242 */
243 unsigned layout = ETNA_LAYOUT_LINEAR;
244 if (etna_resource_sampler_only(templat)) {
245 /* The buffer is only used for texturing, so create something
246 * directly compatible with the sampler. Such a buffer can
247 * never be rendered to. */
248 layout = ETNA_LAYOUT_TILED;
249
250 if (util_format_is_compressed(templat->format))
251 layout = ETNA_LAYOUT_LINEAR;
252 } else if (templat->target != PIPE_BUFFER) {
253 bool want_multitiled = false;
254 bool want_supertiled = screen->specs.can_supertile;
255
256 /* When this GPU supports single-buffer rendering, don't ever enable
257 * multi-tiling. This replicates the blob behavior on GC3000.
258 */
259 if (!screen->specs.single_buffer)
260 want_multitiled = screen->specs.pixel_pipes > 1;
261
262 /* Keep single byte blocksized resources as tiled, since we
263 * are unable to use the RS blit to de-tile them. However,
264 * if they're used as a render target or depth/stencil, they
265 * must be multi-tiled for GPUs with multiple pixel pipes.
266 * Ignore depth/stencil here, but it is an error for a render
267 * target.
268 */
269 if (util_format_get_blocksize(templat->format) == 1 &&
270 !(templat->bind & PIPE_BIND_DEPTH_STENCIL)) {
271 assert(!(templat->bind & PIPE_BIND_RENDER_TARGET && want_multitiled));
272 want_multitiled = want_supertiled = false;
273 }
274
275 layout = ETNA_LAYOUT_BIT_TILE;
276 if (want_multitiled)
277 layout |= ETNA_LAYOUT_BIT_MULTI;
278 if (want_supertiled)
279 layout |= ETNA_LAYOUT_BIT_SUPER;
280 }
281
282 if (templat->target == PIPE_TEXTURE_3D)
283 layout = ETNA_LAYOUT_LINEAR;
284
285 return etna_resource_alloc(pscreen, layout, templat);
286 }
287
288 static void
289 etna_resource_changed(struct pipe_screen *pscreen, struct pipe_resource *prsc)
290 {
291 struct etna_resource *res = etna_resource(prsc);
292
293 res->seqno++;
294 }
295
296 static void
297 etna_resource_destroy(struct pipe_screen *pscreen, struct pipe_resource *prsc)
298 {
299 struct etna_resource *rsc = etna_resource(prsc);
300
301 if (rsc->bo)
302 etna_bo_del(rsc->bo);
303
304 if (rsc->ts_bo)
305 etna_bo_del(rsc->ts_bo);
306
307 if (rsc->scanout)
308 renderonly_scanout_destroy(rsc->scanout, etna_screen(pscreen)->ro);
309
310 list_delinit(&rsc->list);
311
312 pipe_resource_reference(&rsc->texture, NULL);
313
314 FREE(rsc);
315 }
316
317 static struct pipe_resource *
318 etna_resource_from_handle(struct pipe_screen *pscreen,
319 const struct pipe_resource *tmpl,
320 struct winsys_handle *handle, unsigned usage)
321 {
322 struct etna_screen *screen = etna_screen(pscreen);
323 struct etna_resource *rsc;
324 struct etna_resource_level *level;
325 struct pipe_resource *prsc;
326 struct pipe_resource *ptiled = NULL;
327
328 DBG("target=%d, format=%s, %ux%ux%u, array_size=%u, last_level=%u, "
329 "nr_samples=%u, usage=%u, bind=%x, flags=%x",
330 tmpl->target, util_format_name(tmpl->format), tmpl->width0,
331 tmpl->height0, tmpl->depth0, tmpl->array_size, tmpl->last_level,
332 tmpl->nr_samples, tmpl->usage, tmpl->bind, tmpl->flags);
333
334 rsc = CALLOC_STRUCT(etna_resource);
335 if (!rsc)
336 return NULL;
337
338 level = &rsc->levels[0];
339 prsc = &rsc->base;
340
341 *prsc = *tmpl;
342
343 pipe_reference_init(&prsc->reference, 1);
344 list_inithead(&rsc->list);
345 prsc->screen = pscreen;
346
347 rsc->bo = etna_screen_bo_from_handle(pscreen, handle, &level->stride);
348 if (!rsc->bo)
349 goto fail;
350
351 rsc->seqno = 1;
352
353 level->width = tmpl->width0;
354 level->height = tmpl->height0;
355
356 /* We will be using the RS to copy with this resource, so we must
357 * ensure that it is appropriately aligned for the RS requirements. */
358 unsigned paddingX = ETNA_RS_WIDTH_MASK + 1;
359 unsigned paddingY = (ETNA_RS_HEIGHT_MASK + 1) * screen->specs.pixel_pipes;
360
361 level->padded_width = align(level->width, paddingX);
362 level->padded_height = align(level->height, paddingY);
363 level->layer_stride = level->stride * util_format_get_nblocksy(prsc->format,
364 level->padded_height);
365
366 /* The DDX must give us a BO which conforms to our padding size.
367 * The stride of the BO must be greater or equal to our padded
368 * stride. The size of the BO must accomodate the padded height. */
369 if (level->stride < util_format_get_stride(tmpl->format, level->padded_width)) {
370 BUG("BO stride is too small for RS engine width padding");
371 goto fail;
372 }
373 if (etna_bo_size(rsc->bo) < level->stride * level->padded_height) {
374 BUG("BO size is too small for RS engine height padding");
375 goto fail;
376 }
377
378 if (handle->type == DRM_API_HANDLE_TYPE_SHARED && tmpl->bind & PIPE_BIND_RENDER_TARGET) {
379 /* Render targets are linear in Xorg but must be tiled
380 * here. It would be nice if dri_drawable_get_format()
381 * set scanout for these buffers too. */
382 struct etna_resource *tiled;
383
384 ptiled = etna_resource_create(pscreen, tmpl);
385 if (!ptiled)
386 goto fail;
387
388 tiled = etna_resource(ptiled);
389 tiled->scanout = renderonly_scanout_for_prime(prsc, screen->ro);
390 if (!tiled->scanout)
391 goto fail;
392
393 return ptiled;
394 }
395
396 return prsc;
397
398 fail:
399 etna_resource_destroy(pscreen, prsc);
400 if (ptiled)
401 etna_resource_destroy(pscreen, ptiled);
402
403 return NULL;
404 }
405
406 static boolean
407 etna_resource_get_handle(struct pipe_screen *pscreen,
408 struct pipe_context *pctx,
409 struct pipe_resource *prsc,
410 struct winsys_handle *handle, unsigned usage)
411 {
412 struct etna_resource *rsc = etna_resource(prsc);
413
414 if (handle->type == DRM_API_HANDLE_TYPE_KMS &&
415 renderonly_get_handle(rsc->scanout, handle))
416 return TRUE;
417
418 return etna_screen_bo_get_handle(pscreen, rsc->bo, rsc->levels[0].stride,
419 handle);
420 }
421
422 void
423 etna_resource_used(struct etna_context *ctx, struct pipe_resource *prsc,
424 enum etna_resource_status status)
425 {
426 struct etna_resource *rsc;
427
428 if (!prsc)
429 return;
430
431 rsc = etna_resource(prsc);
432 rsc->status |= status;
433
434 /* TODO resources can actually be shared across contexts,
435 * so I'm not sure a single list-head will do the trick? */
436 debug_assert((rsc->pending_ctx == ctx) || !rsc->pending_ctx);
437 list_delinit(&rsc->list);
438 list_addtail(&rsc->list, &ctx->used_resources);
439 rsc->pending_ctx = ctx;
440 }
441
442 void
443 etna_resource_screen_init(struct pipe_screen *pscreen)
444 {
445 pscreen->can_create_resource = etna_screen_can_create_resource;
446 pscreen->resource_create = etna_resource_create;
447 pscreen->resource_from_handle = etna_resource_from_handle;
448 pscreen->resource_get_handle = etna_resource_get_handle;
449 pscreen->resource_changed = etna_resource_changed;
450 pscreen->resource_destroy = etna_resource_destroy;
451 }