OSDN Git Service

c261faa78b828082fb92922908cfcb9820006dad
[android-x86/external-mesa.git] / src / intel / vulkan / anv_private.h
1 /*
2  * Copyright © 2015 Intel Corporation
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, sublicense,
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 next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * 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 NONINFRINGEMENT.  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 DEALINGS
21  * IN THE SOFTWARE.
22  */
23
24 #ifndef ANV_PRIVATE_H
25 #define ANV_PRIVATE_H
26
27 #include <stdlib.h>
28 #include <stdio.h>
29 #include <stdbool.h>
30 #include <pthread.h>
31 #include <assert.h>
32 #include <stdint.h>
33 #include <i915_drm.h>
34
35 #ifdef HAVE_VALGRIND
36 #include <valgrind.h>
37 #include <memcheck.h>
38 #define VG(x) x
39 #define __gen_validate_value(x) VALGRIND_CHECK_MEM_IS_DEFINED(&(x), sizeof(x))
40 #else
41 #define VG(x)
42 #endif
43
44 #include "common/gen_device_info.h"
45 #include "blorp/blorp.h"
46 #include "compiler/brw_compiler.h"
47 #include "util/macros.h"
48 #include "util/list.h"
49 #include "util/u_vector.h"
50 #include "util/vk_alloc.h"
51
52 /* Pre-declarations needed for WSI entrypoints */
53 struct wl_surface;
54 struct wl_display;
55 typedef struct xcb_connection_t xcb_connection_t;
56 typedef uint32_t xcb_visualid_t;
57 typedef uint32_t xcb_window_t;
58
59 struct anv_buffer;
60 struct anv_buffer_view;
61 struct anv_image_view;
62
63 struct gen_l3_config;
64
65 #include <vulkan/vulkan.h>
66 #include <vulkan/vulkan_intel.h>
67 #include <vulkan/vk_icd.h>
68
69 #include "anv_entrypoints.h"
70 #include "isl/isl.h"
71
72 #include "common/gen_debug.h"
73 #include "wsi_common.h"
74
75 /* Allowing different clear colors requires us to perform a depth resolve at
76  * the end of certain render passes. This is because while slow clears store
77  * the clear color in the HiZ buffer, fast clears (without a resolve) don't.
78  * See the PRMs for examples describing when additional resolves would be
79  * necessary. To enable fast clears without requiring extra resolves, we set
80  * the clear value to a globally-defined one. We could allow different values
81  * if the user doesn't expect coherent data during or after a render passes
82  * (VK_ATTACHMENT_STORE_OP_DONT_CARE), but such users (aside from the CTS)
83  * don't seem to exist yet. In almost all Vulkan applications tested thus far,
84  * 1.0f seems to be the only value used. The only application that doesn't set
85  * this value does so through the usage of an seemingly uninitialized clear
86  * value.
87  */
88 #define ANV_HZ_FC_VAL 1.0f
89
90 #define MAX_VBS         31
91 #define MAX_SETS         8
92 #define MAX_RTS          8
93 #define MAX_VIEWPORTS   16
94 #define MAX_SCISSORS    16
95 #define MAX_PUSH_CONSTANTS_SIZE 128
96 #define MAX_DYNAMIC_BUFFERS 16
97 #define MAX_IMAGES 8
98 #define MAX_PUSH_DESCRIPTORS 32 /* Minimum requirement */
99
100 #define ANV_SVGS_VB_INDEX    MAX_VBS
101 #define ANV_DRAWID_VB_INDEX (MAX_VBS + 1)
102
103 #define anv_printflike(a, b) __attribute__((__format__(__printf__, a, b)))
104
105 static inline uint32_t
106 align_down_npot_u32(uint32_t v, uint32_t a)
107 {
108    return v - (v % a);
109 }
110
111 static inline uint32_t
112 align_u32(uint32_t v, uint32_t a)
113 {
114    assert(a != 0 && a == (a & -a));
115    return (v + a - 1) & ~(a - 1);
116 }
117
118 static inline uint64_t
119 align_u64(uint64_t v, uint64_t a)
120 {
121    assert(a != 0 && a == (a & -a));
122    return (v + a - 1) & ~(a - 1);
123 }
124
125 static inline int32_t
126 align_i32(int32_t v, int32_t a)
127 {
128    assert(a != 0 && a == (a & -a));
129    return (v + a - 1) & ~(a - 1);
130 }
131
132 /** Alignment must be a power of 2. */
133 static inline bool
134 anv_is_aligned(uintmax_t n, uintmax_t a)
135 {
136    assert(a == (a & -a));
137    return (n & (a - 1)) == 0;
138 }
139
140 static inline uint32_t
141 anv_minify(uint32_t n, uint32_t levels)
142 {
143    if (unlikely(n == 0))
144       return 0;
145    else
146       return MAX2(n >> levels, 1);
147 }
148
149 static inline float
150 anv_clamp_f(float f, float min, float max)
151 {
152    assert(min < max);
153
154    if (f > max)
155       return max;
156    else if (f < min)
157       return min;
158    else
159       return f;
160 }
161
162 static inline bool
163 anv_clear_mask(uint32_t *inout_mask, uint32_t clear_mask)
164 {
165    if (*inout_mask & clear_mask) {
166       *inout_mask &= ~clear_mask;
167       return true;
168    } else {
169       return false;
170    }
171 }
172
173 static inline union isl_color_value
174 vk_to_isl_color(VkClearColorValue color)
175 {
176    return (union isl_color_value) {
177       .u32 = {
178          color.uint32[0],
179          color.uint32[1],
180          color.uint32[2],
181          color.uint32[3],
182       },
183    };
184 }
185
186 #define for_each_bit(b, dword)                          \
187    for (uint32_t __dword = (dword);                     \
188         (b) = __builtin_ffs(__dword) - 1, __dword;      \
189         __dword &= ~(1 << (b)))
190
191 #define typed_memcpy(dest, src, count) ({ \
192    STATIC_ASSERT(sizeof(*src) == sizeof(*dest)); \
193    memcpy((dest), (src), (count) * sizeof(*(src))); \
194 })
195
196 /* Whenever we generate an error, pass it through this function. Useful for
197  * debugging, where we can break on it. Only call at error site, not when
198  * propagating errors. Might be useful to plug in a stack trace here.
199  */
200
201 VkResult __vk_errorf(VkResult error, const char *file, int line, const char *format, ...);
202
203 #ifdef DEBUG
204 #define vk_error(error) __vk_errorf(error, __FILE__, __LINE__, NULL);
205 #define vk_errorf(error, format, ...) __vk_errorf(error, __FILE__, __LINE__, format, ## __VA_ARGS__);
206 #define anv_debug(format, ...) fprintf(stderr, "debug: " format, ##__VA_ARGS__)
207 #else
208 #define vk_error(error) error
209 #define vk_errorf(error, format, ...) error
210 #define anv_debug(format, ...)
211 #endif
212
213 /**
214  * Warn on ignored extension structs.
215  *
216  * The Vulkan spec requires us to ignore unsupported or unknown structs in
217  * a pNext chain.  In debug mode, emitting warnings for ignored structs may
218  * help us discover structs that we should not have ignored.
219  *
220  *
221  * From the Vulkan 1.0.38 spec:
222  *
223  *    Any component of the implementation (the loader, any enabled layers,
224  *    and drivers) must skip over, without processing (other than reading the
225  *    sType and pNext members) any chained structures with sType values not
226  *    defined by extensions supported by that component.
227  */
228 #define anv_debug_ignored_stype(sType) \
229    anv_debug("debug: %s: ignored VkStructureType %u\n", __func__, (sType))
230
231 void __anv_finishme(const char *file, int line, const char *format, ...)
232    anv_printflike(3, 4);
233 void __anv_perf_warn(const char *file, int line, const char *format, ...)
234    anv_printflike(3, 4);
235 void anv_loge(const char *format, ...) anv_printflike(1, 2);
236 void anv_loge_v(const char *format, va_list va);
237
238 /**
239  * Print a FINISHME message, including its source location.
240  */
241 #define anv_finishme(format, ...) \
242    do { \
243       static bool reported = false; \
244       if (!reported) { \
245          __anv_finishme(__FILE__, __LINE__, format, ##__VA_ARGS__); \
246          reported = true; \
247       } \
248    } while (0)
249
250 /**
251  * Print a perf warning message.  Set INTEL_DEBUG=perf to see these.
252  */
253 #define anv_perf_warn(format, ...) \
254    do { \
255       static bool reported = false; \
256       if (!reported && unlikely(INTEL_DEBUG & DEBUG_PERF)) { \
257          __anv_perf_warn(__FILE__, __LINE__, format, ##__VA_ARGS__); \
258          reported = true; \
259       } \
260    } while (0)
261
262 /* A non-fatal assert.  Useful for debugging. */
263 #ifdef DEBUG
264 #define anv_assert(x) ({ \
265    if (unlikely(!(x))) \
266       fprintf(stderr, "%s:%d ASSERT: %s\n", __FILE__, __LINE__, #x); \
267 })
268 #else
269 #define anv_assert(x)
270 #endif
271
272 /* A multi-pointer allocator
273  *
274  * When copying data structures from the user (such as a render pass), it's
275  * common to need to allocate data for a bunch of different things.  Instead
276  * of doing several allocations and having to handle all of the error checking
277  * that entails, it can be easier to do a single allocation.  This struct
278  * helps facilitate that.  The intended usage looks like this:
279  *
280  *    ANV_MULTIALLOC(ma)
281  *    anv_multialloc_add(&ma, &main_ptr, 1);
282  *    anv_multialloc_add(&ma, &substruct1, substruct1Count);
283  *    anv_multialloc_add(&ma, &substruct2, substruct2Count);
284  *
285  *    if (!anv_multialloc_alloc(&ma, pAllocator, VK_ALLOCATION_SCOPE_FOO))
286  *       return vk_error(VK_ERROR_OUT_OF_HOST_MEORY);
287  */
288 struct anv_multialloc {
289     size_t size;
290     size_t align;
291
292     uint32_t ptr_count;
293     void **ptrs[8];
294 };
295
296 #define ANV_MULTIALLOC_INIT \
297    ((struct anv_multialloc) { 0, })
298
299 #define ANV_MULTIALLOC(_name) \
300    struct anv_multialloc _name = ANV_MULTIALLOC_INIT
301
302 __attribute__((always_inline))
303 static inline void
304 _anv_multialloc_add(struct anv_multialloc *ma,
305                     void **ptr, size_t size, size_t align)
306 {
307    size_t offset = align_u64(ma->size, align);
308    ma->size = offset + size;
309    ma->align = MAX2(ma->align, align);
310
311    /* Store the offset in the pointer. */
312    *ptr = (void *)(uintptr_t)offset;
313
314    assert(ma->ptr_count < ARRAY_SIZE(ma->ptrs));
315    ma->ptrs[ma->ptr_count++] = ptr;
316 }
317
318 #define anv_multialloc_add(_ma, _ptr, _count) \
319    _anv_multialloc_add((_ma), (void **)(_ptr), \
320                        (_count) * sizeof(**(_ptr)), __alignof__(**(_ptr)))
321
322 __attribute__((always_inline))
323 static inline void *
324 anv_multialloc_alloc(struct anv_multialloc *ma,
325                      const VkAllocationCallbacks *alloc,
326                      VkSystemAllocationScope scope)
327 {
328    void *ptr = vk_alloc(alloc, ma->size, ma->align, scope);
329    if (!ptr)
330       return NULL;
331
332    /* Fill out each of the pointers with their final value.
333     *
334     *   for (uint32_t i = 0; i < ma->ptr_count; i++)
335     *      *ma->ptrs[i] = ptr + (uintptr_t)*ma->ptrs[i];
336     *
337     * Unfortunately, even though ma->ptr_count is basically guaranteed to be a
338     * constant, GCC is incapable of figuring this out and unrolling the loop
339     * so we have to give it a little help.
340     */
341    STATIC_ASSERT(ARRAY_SIZE(ma->ptrs) == 8);
342 #define _ANV_MULTIALLOC_UPDATE_POINTER(_i) \
343    if ((_i) < ma->ptr_count) \
344       *ma->ptrs[_i] = ptr + (uintptr_t)*ma->ptrs[_i]
345    _ANV_MULTIALLOC_UPDATE_POINTER(0);
346    _ANV_MULTIALLOC_UPDATE_POINTER(1);
347    _ANV_MULTIALLOC_UPDATE_POINTER(2);
348    _ANV_MULTIALLOC_UPDATE_POINTER(3);
349    _ANV_MULTIALLOC_UPDATE_POINTER(4);
350    _ANV_MULTIALLOC_UPDATE_POINTER(5);
351    _ANV_MULTIALLOC_UPDATE_POINTER(6);
352    _ANV_MULTIALLOC_UPDATE_POINTER(7);
353 #undef _ANV_MULTIALLOC_UPDATE_POINTER
354
355    return ptr;
356 }
357
358 __attribute__((always_inline))
359 static inline void *
360 anv_multialloc_alloc2(struct anv_multialloc *ma,
361                       const VkAllocationCallbacks *parent_alloc,
362                       const VkAllocationCallbacks *alloc,
363                       VkSystemAllocationScope scope)
364 {
365    return anv_multialloc_alloc(ma, alloc ? alloc : parent_alloc, scope);
366 }
367
368 /**
369  * A dynamically growable, circular buffer.  Elements are added at head and
370  * removed from tail. head and tail are free-running uint32_t indices and we
371  * only compute the modulo with size when accessing the array.  This way,
372  * number of bytes in the queue is always head - tail, even in case of
373  * wraparound.
374  */
375
376 struct anv_bo {
377    uint32_t gem_handle;
378
379    /* Index into the current validation list.  This is used by the
380     * validation list building alrogithm to track which buffers are already
381     * in the validation list so that we can ensure uniqueness.
382     */
383    uint32_t index;
384
385    /* Last known offset.  This value is provided by the kernel when we
386     * execbuf and is used as the presumed offset for the next bunch of
387     * relocations.
388     */
389    uint64_t offset;
390
391    uint64_t size;
392    void *map;
393
394    /** Flags to pass to the kernel through drm_i915_exec_object2::flags */
395    uint32_t flags;
396 };
397
398 static inline void
399 anv_bo_init(struct anv_bo *bo, uint32_t gem_handle, uint64_t size)
400 {
401    bo->gem_handle = gem_handle;
402    bo->index = 0;
403    bo->offset = -1;
404    bo->size = size;
405    bo->map = NULL;
406    bo->flags = 0;
407 }
408
409 /* Represents a lock-free linked list of "free" things.  This is used by
410  * both the block pool and the state pools.  Unfortunately, in order to
411  * solve the ABA problem, we can't use a single uint32_t head.
412  */
413 union anv_free_list {
414    struct {
415       int32_t offset;
416
417       /* A simple count that is incremented every time the head changes. */
418       uint32_t count;
419    };
420    uint64_t u64;
421 };
422
423 #define ANV_FREE_LIST_EMPTY ((union anv_free_list) { { 1, 0 } })
424
425 struct anv_block_state {
426    union {
427       struct {
428          uint32_t next;
429          uint32_t end;
430       };
431       uint64_t u64;
432    };
433 };
434
435 struct anv_block_pool {
436    struct anv_device *device;
437
438    struct anv_bo bo;
439
440    /* The offset from the start of the bo to the "center" of the block
441     * pool.  Pointers to allocated blocks are given by
442     * bo.map + center_bo_offset + offsets.
443     */
444    uint32_t center_bo_offset;
445
446    /* Current memory map of the block pool.  This pointer may or may not
447     * point to the actual beginning of the block pool memory.  If
448     * anv_block_pool_alloc_back has ever been called, then this pointer
449     * will point to the "center" position of the buffer and all offsets
450     * (negative or positive) given out by the block pool alloc functions
451     * will be valid relative to this pointer.
452     *
453     * In particular, map == bo.map + center_offset
454     */
455    void *map;
456    int fd;
457
458    /**
459     * Array of mmaps and gem handles owned by the block pool, reclaimed when
460     * the block pool is destroyed.
461     */
462    struct u_vector mmap_cleanups;
463
464    struct anv_block_state state;
465
466    struct anv_block_state back_state;
467 };
468
469 /* Block pools are backed by a fixed-size 1GB memfd */
470 #define BLOCK_POOL_MEMFD_SIZE (1ul << 30)
471
472 /* The center of the block pool is also the middle of the memfd.  This may
473  * change in the future if we decide differently for some reason.
474  */
475 #define BLOCK_POOL_MEMFD_CENTER (BLOCK_POOL_MEMFD_SIZE / 2)
476
477 static inline uint32_t
478 anv_block_pool_size(struct anv_block_pool *pool)
479 {
480    return pool->state.end + pool->back_state.end;
481 }
482
483 struct anv_state {
484    int32_t offset;
485    uint32_t alloc_size;
486    void *map;
487 };
488
489 #define ANV_STATE_NULL ((struct anv_state) { .alloc_size = 0 })
490
491 struct anv_fixed_size_state_pool {
492    union anv_free_list free_list;
493    struct anv_block_state block;
494 };
495
496 #define ANV_MIN_STATE_SIZE_LOG2 6
497 #define ANV_MAX_STATE_SIZE_LOG2 20
498
499 #define ANV_STATE_BUCKETS (ANV_MAX_STATE_SIZE_LOG2 - ANV_MIN_STATE_SIZE_LOG2 + 1)
500
501 struct anv_state_pool {
502    struct anv_block_pool block_pool;
503
504    /* The size of blocks which will be allocated from the block pool */
505    uint32_t block_size;
506
507    /** Free list for "back" allocations */
508    union anv_free_list back_alloc_free_list;
509
510    struct anv_fixed_size_state_pool buckets[ANV_STATE_BUCKETS];
511 };
512
513 struct anv_state_stream_block;
514
515 struct anv_state_stream {
516    struct anv_state_pool *state_pool;
517
518    /* The size of blocks to allocate from the state pool */
519    uint32_t block_size;
520
521    /* Current block we're allocating from */
522    struct anv_state block;
523
524    /* Offset into the current block at which to allocate the next state */
525    uint32_t next;
526
527    /* List of all blocks allocated from this pool */
528    struct anv_state_stream_block *block_list;
529 };
530
531 #define CACHELINE_SIZE 64
532 #define CACHELINE_MASK 63
533
534 static inline void
535 anv_clflush_range(void *start, size_t size)
536 {
537    void *p = (void *) (((uintptr_t) start) & ~CACHELINE_MASK);
538    void *end = start + size;
539
540    while (p < end) {
541       __builtin_ia32_clflush(p);
542       p += CACHELINE_SIZE;
543    }
544 }
545
546 static inline void
547 anv_flush_range(void *start, size_t size)
548 {
549    __builtin_ia32_mfence();
550    anv_clflush_range(start, size);
551 }
552
553 static inline void
554 anv_invalidate_range(void *start, size_t size)
555 {
556    anv_clflush_range(start, size);
557    __builtin_ia32_mfence();
558 }
559
560 /* The block_pool functions exported for testing only.  The block pool should
561  * only be used via a state pool (see below).
562  */
563 VkResult anv_block_pool_init(struct anv_block_pool *pool,
564                              struct anv_device *device,
565                              uint32_t initial_size);
566 void anv_block_pool_finish(struct anv_block_pool *pool);
567 int32_t anv_block_pool_alloc(struct anv_block_pool *pool,
568                              uint32_t block_size);
569 int32_t anv_block_pool_alloc_back(struct anv_block_pool *pool,
570                                   uint32_t block_size);
571
572 VkResult anv_state_pool_init(struct anv_state_pool *pool,
573                              struct anv_device *device,
574                              uint32_t block_size);
575 void anv_state_pool_finish(struct anv_state_pool *pool);
576 struct anv_state anv_state_pool_alloc(struct anv_state_pool *pool,
577                                       uint32_t state_size, uint32_t alignment);
578 struct anv_state anv_state_pool_alloc_back(struct anv_state_pool *pool);
579 void anv_state_pool_free(struct anv_state_pool *pool, struct anv_state state);
580 void anv_state_stream_init(struct anv_state_stream *stream,
581                            struct anv_state_pool *state_pool,
582                            uint32_t block_size);
583 void anv_state_stream_finish(struct anv_state_stream *stream);
584 struct anv_state anv_state_stream_alloc(struct anv_state_stream *stream,
585                                         uint32_t size, uint32_t alignment);
586
587 /**
588  * Implements a pool of re-usable BOs.  The interface is identical to that
589  * of block_pool except that each block is its own BO.
590  */
591 struct anv_bo_pool {
592    struct anv_device *device;
593
594    void *free_list[16];
595 };
596
597 void anv_bo_pool_init(struct anv_bo_pool *pool, struct anv_device *device);
598 void anv_bo_pool_finish(struct anv_bo_pool *pool);
599 VkResult anv_bo_pool_alloc(struct anv_bo_pool *pool, struct anv_bo *bo,
600                            uint32_t size);
601 void anv_bo_pool_free(struct anv_bo_pool *pool, const struct anv_bo *bo);
602
603 struct anv_scratch_bo {
604    bool exists;
605    struct anv_bo bo;
606 };
607
608 struct anv_scratch_pool {
609    /* Indexed by Per-Thread Scratch Space number (the hardware value) and stage */
610    struct anv_scratch_bo bos[16][MESA_SHADER_STAGES];
611 };
612
613 void anv_scratch_pool_init(struct anv_device *device,
614                            struct anv_scratch_pool *pool);
615 void anv_scratch_pool_finish(struct anv_device *device,
616                              struct anv_scratch_pool *pool);
617 struct anv_bo *anv_scratch_pool_alloc(struct anv_device *device,
618                                       struct anv_scratch_pool *pool,
619                                       gl_shader_stage stage,
620                                       unsigned per_thread_scratch);
621
622 /** Implements a BO cache that ensures a 1-1 mapping of GEM BOs to anv_bos */
623 struct anv_bo_cache {
624    struct hash_table *bo_map;
625    pthread_mutex_t mutex;
626 };
627
628 VkResult anv_bo_cache_init(struct anv_bo_cache *cache);
629 void anv_bo_cache_finish(struct anv_bo_cache *cache);
630 VkResult anv_bo_cache_alloc(struct anv_device *device,
631                             struct anv_bo_cache *cache,
632                             uint64_t size, struct anv_bo **bo);
633 VkResult anv_bo_cache_import(struct anv_device *device,
634                              struct anv_bo_cache *cache,
635                              int fd, uint64_t size, struct anv_bo **bo);
636 VkResult anv_bo_cache_export(struct anv_device *device,
637                              struct anv_bo_cache *cache,
638                              struct anv_bo *bo_in, int *fd_out);
639 void anv_bo_cache_release(struct anv_device *device,
640                           struct anv_bo_cache *cache,
641                           struct anv_bo *bo);
642
643 struct anv_memory_type {
644    /* Standard bits passed on to the client */
645    VkMemoryPropertyFlags   propertyFlags;
646    uint32_t                heapIndex;
647
648    /* Driver-internal book-keeping */
649    VkBufferUsageFlags      valid_buffer_usage;
650 };
651
652 struct anv_memory_heap {
653    /* Standard bits passed on to the client */
654    VkDeviceSize      size;
655    VkMemoryHeapFlags flags;
656
657    /* Driver-internal book-keeping */
658    bool              supports_48bit_addresses;
659 };
660
661 struct anv_physical_device {
662     VK_LOADER_DATA                              _loader_data;
663
664     struct anv_instance *                       instance;
665     uint32_t                                    chipset_id;
666     char                                        path[20];
667     const char *                                name;
668     struct gen_device_info                      info;
669     /** Amount of "GPU memory" we want to advertise
670      *
671      * Clearly, this value is bogus since Intel is a UMA architecture.  On
672      * gen7 platforms, we are limited by GTT size unless we want to implement
673      * fine-grained tracking and GTT splitting.  On Broadwell and above we are
674      * practically unlimited.  However, we will never report more than 3/4 of
675      * the total system ram to try and avoid running out of RAM.
676      */
677     bool                                        supports_48bit_addresses;
678     struct brw_compiler *                       compiler;
679     struct isl_device                           isl_dev;
680     int                                         cmd_parser_version;
681     bool                                        has_exec_async;
682
683     uint32_t                                    eu_total;
684     uint32_t                                    subslice_total;
685
686     struct {
687       uint32_t                                  type_count;
688       struct anv_memory_type                    types[VK_MAX_MEMORY_TYPES];
689       uint32_t                                  heap_count;
690       struct anv_memory_heap                    heaps[VK_MAX_MEMORY_HEAPS];
691     } memory;
692
693     uint8_t                                     pipeline_cache_uuid[VK_UUID_SIZE];
694     uint8_t                                     driver_uuid[VK_UUID_SIZE];
695     uint8_t                                     device_uuid[VK_UUID_SIZE];
696
697     struct wsi_device                       wsi_device;
698     int                                         local_fd;
699 };
700
701 struct anv_instance {
702     VK_LOADER_DATA                              _loader_data;
703
704     VkAllocationCallbacks                       alloc;
705
706     uint32_t                                    apiVersion;
707     int                                         physicalDeviceCount;
708     struct anv_physical_device                  physicalDevice;
709 };
710
711 VkResult anv_init_wsi(struct anv_physical_device *physical_device);
712 void anv_finish_wsi(struct anv_physical_device *physical_device);
713
714 struct anv_queue {
715     VK_LOADER_DATA                              _loader_data;
716
717     struct anv_device *                         device;
718
719     struct anv_state_pool *                     pool;
720 };
721
722 struct anv_pipeline_cache {
723    struct anv_device *                          device;
724    pthread_mutex_t                              mutex;
725
726    struct hash_table *                          cache;
727 };
728
729 struct anv_pipeline_bind_map;
730
731 void anv_pipeline_cache_init(struct anv_pipeline_cache *cache,
732                              struct anv_device *device,
733                              bool cache_enabled);
734 void anv_pipeline_cache_finish(struct anv_pipeline_cache *cache);
735
736 struct anv_shader_bin *
737 anv_pipeline_cache_search(struct anv_pipeline_cache *cache,
738                           const void *key, uint32_t key_size);
739 struct anv_shader_bin *
740 anv_pipeline_cache_upload_kernel(struct anv_pipeline_cache *cache,
741                                  const void *key_data, uint32_t key_size,
742                                  const void *kernel_data, uint32_t kernel_size,
743                                  const struct brw_stage_prog_data *prog_data,
744                                  uint32_t prog_data_size,
745                                  const struct anv_pipeline_bind_map *bind_map);
746
747 struct anv_device {
748     VK_LOADER_DATA                              _loader_data;
749
750     VkAllocationCallbacks                       alloc;
751
752     struct anv_instance *                       instance;
753     uint32_t                                    chipset_id;
754     struct gen_device_info                      info;
755     struct isl_device                           isl_dev;
756     int                                         context_id;
757     int                                         fd;
758     bool                                        can_chain_batches;
759     bool                                        robust_buffer_access;
760
761     struct anv_bo_pool                          batch_bo_pool;
762
763     struct anv_bo_cache                         bo_cache;
764
765     struct anv_state_pool                       dynamic_state_pool;
766     struct anv_state_pool                       instruction_state_pool;
767     struct anv_state_pool                       surface_state_pool;
768
769     struct anv_bo                               workaround_bo;
770
771     struct anv_pipeline_cache                   blorp_shader_cache;
772     struct blorp_context                        blorp;
773
774     struct anv_state                            border_colors;
775
776     struct anv_queue                            queue;
777
778     struct anv_scratch_pool                     scratch_pool;
779
780     uint32_t                                    default_mocs;
781
782     pthread_mutex_t                             mutex;
783     pthread_cond_t                              queue_submit;
784     bool                                        lost;
785 };
786
787 static void inline
788 anv_state_flush(struct anv_device *device, struct anv_state state)
789 {
790    if (device->info.has_llc)
791       return;
792
793    anv_flush_range(state.map, state.alloc_size);
794 }
795
796 void anv_device_init_blorp(struct anv_device *device);
797 void anv_device_finish_blorp(struct anv_device *device);
798
799 VkResult anv_device_execbuf(struct anv_device *device,
800                             struct drm_i915_gem_execbuffer2 *execbuf,
801                             struct anv_bo **execbuf_bos);
802 VkResult anv_device_query_status(struct anv_device *device);
803 VkResult anv_device_bo_busy(struct anv_device *device, struct anv_bo *bo);
804 VkResult anv_device_wait(struct anv_device *device, struct anv_bo *bo,
805                          int64_t timeout);
806
807 void* anv_gem_mmap(struct anv_device *device,
808                    uint32_t gem_handle, uint64_t offset, uint64_t size, uint32_t flags);
809 void anv_gem_munmap(void *p, uint64_t size);
810 uint32_t anv_gem_create(struct anv_device *device, uint64_t size);
811 void anv_gem_close(struct anv_device *device, uint32_t gem_handle);
812 uint32_t anv_gem_userptr(struct anv_device *device, void *mem, size_t size);
813 int anv_gem_busy(struct anv_device *device, uint32_t gem_handle);
814 int anv_gem_wait(struct anv_device *device, uint32_t gem_handle, int64_t *timeout_ns);
815 int anv_gem_execbuffer(struct anv_device *device,
816                        struct drm_i915_gem_execbuffer2 *execbuf);
817 int anv_gem_set_tiling(struct anv_device *device, uint32_t gem_handle,
818                        uint32_t stride, uint32_t tiling);
819 int anv_gem_create_context(struct anv_device *device);
820 int anv_gem_destroy_context(struct anv_device *device, int context);
821 int anv_gem_get_context_param(int fd, int context, uint32_t param,
822                               uint64_t *value);
823 int anv_gem_get_param(int fd, uint32_t param);
824 bool anv_gem_get_bit6_swizzle(int fd, uint32_t tiling);
825 int anv_gem_get_aperture(int fd, uint64_t *size);
826 bool anv_gem_supports_48b_addresses(int fd);
827 int anv_gem_gpu_get_reset_stats(struct anv_device *device,
828                                 uint32_t *active, uint32_t *pending);
829 int anv_gem_handle_to_fd(struct anv_device *device, uint32_t gem_handle);
830 uint32_t anv_gem_fd_to_handle(struct anv_device *device, int fd);
831 int anv_gem_set_caching(struct anv_device *device, uint32_t gem_handle, uint32_t caching);
832 int anv_gem_set_domain(struct anv_device *device, uint32_t gem_handle,
833                        uint32_t read_domains, uint32_t write_domain);
834
835 VkResult anv_bo_init_new(struct anv_bo *bo, struct anv_device *device, uint64_t size);
836
837 struct anv_reloc_list {
838    uint32_t                                     num_relocs;
839    uint32_t                                     array_length;
840    struct drm_i915_gem_relocation_entry *       relocs;
841    struct anv_bo **                             reloc_bos;
842 };
843
844 VkResult anv_reloc_list_init(struct anv_reloc_list *list,
845                              const VkAllocationCallbacks *alloc);
846 void anv_reloc_list_finish(struct anv_reloc_list *list,
847                            const VkAllocationCallbacks *alloc);
848
849 VkResult anv_reloc_list_add(struct anv_reloc_list *list,
850                             const VkAllocationCallbacks *alloc,
851                             uint32_t offset, struct anv_bo *target_bo,
852                             uint32_t delta);
853
854 struct anv_batch_bo {
855    /* Link in the anv_cmd_buffer.owned_batch_bos list */
856    struct list_head                             link;
857
858    struct anv_bo                                bo;
859
860    /* Bytes actually consumed in this batch BO */
861    uint32_t                                     length;
862
863    struct anv_reloc_list                        relocs;
864 };
865
866 struct anv_batch {
867    const VkAllocationCallbacks *                alloc;
868
869    void *                                       start;
870    void *                                       end;
871    void *                                       next;
872
873    struct anv_reloc_list *                      relocs;
874
875    /* This callback is called (with the associated user data) in the event
876     * that the batch runs out of space.
877     */
878    VkResult (*extend_cb)(struct anv_batch *, void *);
879    void *                                       user_data;
880
881    /**
882     * Current error status of the command buffer. Used to track inconsistent
883     * or incomplete command buffer states that are the consequence of run-time
884     * errors such as out of memory scenarios. We want to track this in the
885     * batch because the command buffer object is not visible to some parts
886     * of the driver.
887     */
888    VkResult                                     status;
889 };
890
891 void *anv_batch_emit_dwords(struct anv_batch *batch, int num_dwords);
892 void anv_batch_emit_batch(struct anv_batch *batch, struct anv_batch *other);
893 uint64_t anv_batch_emit_reloc(struct anv_batch *batch,
894                               void *location, struct anv_bo *bo, uint32_t offset);
895 VkResult anv_device_submit_simple_batch(struct anv_device *device,
896                                         struct anv_batch *batch);
897
898 static inline VkResult
899 anv_batch_set_error(struct anv_batch *batch, VkResult error)
900 {
901    assert(error != VK_SUCCESS);
902    if (batch->status == VK_SUCCESS)
903       batch->status = error;
904    return batch->status;
905 }
906
907 static inline bool
908 anv_batch_has_error(struct anv_batch *batch)
909 {
910    return batch->status != VK_SUCCESS;
911 }
912
913 struct anv_address {
914    struct anv_bo *bo;
915    uint32_t offset;
916 };
917
918 static inline uint64_t
919 _anv_combine_address(struct anv_batch *batch, void *location,
920                      const struct anv_address address, uint32_t delta)
921 {
922    if (address.bo == NULL) {
923       return address.offset + delta;
924    } else {
925       assert(batch->start <= location && location < batch->end);
926
927       return anv_batch_emit_reloc(batch, location, address.bo, address.offset + delta);
928    }
929 }
930
931 #define __gen_address_type struct anv_address
932 #define __gen_user_data struct anv_batch
933 #define __gen_combine_address _anv_combine_address
934
935 /* Wrapper macros needed to work around preprocessor argument issues.  In
936  * particular, arguments don't get pre-evaluated if they are concatenated.
937  * This means that, if you pass GENX(3DSTATE_PS) into the emit macro, the
938  * GENX macro won't get evaluated if the emit macro contains "cmd ## foo".
939  * We can work around this easily enough with these helpers.
940  */
941 #define __anv_cmd_length(cmd) cmd ## _length
942 #define __anv_cmd_length_bias(cmd) cmd ## _length_bias
943 #define __anv_cmd_header(cmd) cmd ## _header
944 #define __anv_cmd_pack(cmd) cmd ## _pack
945 #define __anv_reg_num(reg) reg ## _num
946
947 #define anv_pack_struct(dst, struc, ...) do {                              \
948       struct struc __template = {                                          \
949          __VA_ARGS__                                                       \
950       };                                                                   \
951       __anv_cmd_pack(struc)(NULL, dst, &__template);                       \
952       VG(VALGRIND_CHECK_MEM_IS_DEFINED(dst, __anv_cmd_length(struc) * 4)); \
953    } while (0)
954
955 #define anv_batch_emitn(batch, n, cmd, ...) ({             \
956       void *__dst = anv_batch_emit_dwords(batch, n);       \
957       if (__dst) {                                         \
958          struct cmd __template = {                         \
959             __anv_cmd_header(cmd),                         \
960            .DWordLength = n - __anv_cmd_length_bias(cmd),  \
961             __VA_ARGS__                                    \
962          };                                                \
963          __anv_cmd_pack(cmd)(batch, __dst, &__template);   \
964       }                                                    \
965       __dst;                                               \
966    })
967
968 #define anv_batch_emit_merge(batch, dwords0, dwords1)                   \
969    do {                                                                 \
970       uint32_t *dw;                                                     \
971                                                                         \
972       STATIC_ASSERT(ARRAY_SIZE(dwords0) == ARRAY_SIZE(dwords1));        \
973       dw = anv_batch_emit_dwords((batch), ARRAY_SIZE(dwords0));         \
974       if (!dw)                                                          \
975          break;                                                         \
976       for (uint32_t i = 0; i < ARRAY_SIZE(dwords0); i++)                \
977          dw[i] = (dwords0)[i] | (dwords1)[i];                           \
978       VG(VALGRIND_CHECK_MEM_IS_DEFINED(dw, ARRAY_SIZE(dwords0) * 4));\
979    } while (0)
980
981 #define anv_batch_emit(batch, cmd, name)                            \
982    for (struct cmd name = { __anv_cmd_header(cmd) },                    \
983         *_dst = anv_batch_emit_dwords(batch, __anv_cmd_length(cmd));    \
984         __builtin_expect(_dst != NULL, 1);                              \
985         ({ __anv_cmd_pack(cmd)(batch, _dst, &name);                     \
986            VG(VALGRIND_CHECK_MEM_IS_DEFINED(_dst, __anv_cmd_length(cmd) * 4)); \
987            _dst = NULL;                                                 \
988          }))
989
990 #define GEN7_MOCS (struct GEN7_MEMORY_OBJECT_CONTROL_STATE) {  \
991    .GraphicsDataTypeGFDT                        = 0,           \
992    .LLCCacheabilityControlLLCCC                 = 0,           \
993    .L3CacheabilityControlL3CC                   = 1,           \
994 }
995
996 #define GEN75_MOCS (struct GEN75_MEMORY_OBJECT_CONTROL_STATE) {  \
997    .LLCeLLCCacheabilityControlLLCCC             = 0,           \
998    .L3CacheabilityControlL3CC                   = 1,           \
999 }
1000
1001 #define GEN8_MOCS (struct GEN8_MEMORY_OBJECT_CONTROL_STATE) {  \
1002       .MemoryTypeLLCeLLCCacheabilityControl = WB,              \
1003       .TargetCache = L3DefertoPATforLLCeLLCselection,          \
1004       .AgeforQUADLRU = 0                                       \
1005    }
1006
1007 /* Skylake: MOCS is now an index into an array of 62 different caching
1008  * configurations programmed by the kernel.
1009  */
1010
1011 #define GEN9_MOCS (struct GEN9_MEMORY_OBJECT_CONTROL_STATE) {  \
1012       /* TC=LLC/eLLC, LeCC=WB, LRUM=3, L3CC=WB */              \
1013       .IndextoMOCSTables                           = 2         \
1014    }
1015
1016 #define GEN9_MOCS_PTE {                                 \
1017       /* TC=LLC/eLLC, LeCC=WB, LRUM=3, L3CC=WB */       \
1018       .IndextoMOCSTables                           = 1  \
1019    }
1020
1021 struct anv_device_memory {
1022    struct anv_bo *                              bo;
1023    struct anv_memory_type *                     type;
1024    VkDeviceSize                                 map_size;
1025    void *                                       map;
1026 };
1027
1028 /**
1029  * Header for Vertex URB Entry (VUE)
1030  */
1031 struct anv_vue_header {
1032    uint32_t Reserved;
1033    uint32_t RTAIndex; /* RenderTargetArrayIndex */
1034    uint32_t ViewportIndex;
1035    float PointWidth;
1036 };
1037
1038 struct anv_descriptor_set_binding_layout {
1039 #ifndef NDEBUG
1040    /* The type of the descriptors in this binding */
1041    VkDescriptorType type;
1042 #endif
1043
1044    /* Number of array elements in this binding */
1045    uint16_t array_size;
1046
1047    /* Index into the flattend descriptor set */
1048    uint16_t descriptor_index;
1049
1050    /* Index into the dynamic state array for a dynamic buffer */
1051    int16_t dynamic_offset_index;
1052
1053    /* Index into the descriptor set buffer views */
1054    int16_t buffer_index;
1055
1056    struct {
1057       /* Index into the binding table for the associated surface */
1058       int16_t surface_index;
1059
1060       /* Index into the sampler table for the associated sampler */
1061       int16_t sampler_index;
1062
1063       /* Index into the image table for the associated image */
1064       int16_t image_index;
1065    } stage[MESA_SHADER_STAGES];
1066
1067    /* Immutable samplers (or NULL if no immutable samplers) */
1068    struct anv_sampler **immutable_samplers;
1069 };
1070
1071 struct anv_descriptor_set_layout {
1072    /* Number of bindings in this descriptor set */
1073    uint16_t binding_count;
1074
1075    /* Total size of the descriptor set with room for all array entries */
1076    uint16_t size;
1077
1078    /* Shader stages affected by this descriptor set */
1079    uint16_t shader_stages;
1080
1081    /* Number of buffers in this descriptor set */
1082    uint16_t buffer_count;
1083
1084    /* Number of dynamic offsets used by this descriptor set */
1085    uint16_t dynamic_offset_count;
1086
1087    /* Bindings in this descriptor set */
1088    struct anv_descriptor_set_binding_layout binding[0];
1089 };
1090
1091 struct anv_descriptor {
1092    VkDescriptorType type;
1093
1094    union {
1095       struct {
1096          struct anv_image_view *image_view;
1097          struct anv_sampler *sampler;
1098
1099          /* Used to determine whether or not we need the surface state to have
1100           * the auxiliary buffer enabled.
1101           */
1102          enum isl_aux_usage aux_usage;
1103       };
1104
1105       struct {
1106          struct anv_buffer *buffer;
1107          uint64_t offset;
1108          uint64_t range;
1109       };
1110
1111       struct anv_buffer_view *buffer_view;
1112    };
1113 };
1114
1115 struct anv_descriptor_set {
1116    const struct anv_descriptor_set_layout *layout;
1117    uint32_t size;
1118    uint32_t buffer_count;
1119    struct anv_buffer_view *buffer_views;
1120    struct anv_descriptor descriptors[0];
1121 };
1122
1123 struct anv_buffer_view {
1124    enum isl_format format; /**< VkBufferViewCreateInfo::format */
1125    struct anv_bo *bo;
1126    uint32_t offset; /**< Offset into bo. */
1127    uint64_t range; /**< VkBufferViewCreateInfo::range */
1128
1129    struct anv_state surface_state;
1130    struct anv_state storage_surface_state;
1131    struct anv_state writeonly_storage_surface_state;
1132
1133    struct brw_image_param storage_image_param;
1134 };
1135
1136 struct anv_push_descriptor_set {
1137    struct anv_descriptor_set set;
1138
1139    /* Put this field right behind anv_descriptor_set so it fills up the
1140     * descriptors[0] field. */
1141    struct anv_descriptor descriptors[MAX_PUSH_DESCRIPTORS];
1142
1143    struct anv_buffer_view buffer_views[MAX_PUSH_DESCRIPTORS];
1144 };
1145
1146 struct anv_descriptor_pool {
1147    uint32_t size;
1148    uint32_t next;
1149    uint32_t free_list;
1150
1151    struct anv_state_stream surface_state_stream;
1152    void *surface_state_free_list;
1153
1154    char data[0];
1155 };
1156
1157 enum anv_descriptor_template_entry_type {
1158    ANV_DESCRIPTOR_TEMPLATE_ENTRY_TYPE_IMAGE,
1159    ANV_DESCRIPTOR_TEMPLATE_ENTRY_TYPE_BUFFER,
1160    ANV_DESCRIPTOR_TEMPLATE_ENTRY_TYPE_BUFFER_VIEW
1161 };
1162
1163 struct anv_descriptor_template_entry {
1164    /* The type of descriptor in this entry */
1165    VkDescriptorType type;
1166
1167    /* Binding in the descriptor set */
1168    uint32_t binding;
1169
1170    /* Offset at which to write into the descriptor set binding */
1171    uint32_t array_element;
1172
1173    /* Number of elements to write into the descriptor set binding */
1174    uint32_t array_count;
1175
1176    /* Offset into the user provided data */
1177    size_t offset;
1178
1179    /* Stride between elements into the user provided data */
1180    size_t stride;
1181 };
1182
1183 struct anv_descriptor_update_template {
1184    /* The descriptor set this template corresponds to. This value is only
1185     * valid if the template was created with the templateType
1186     * VK_DESCRIPTOR_UPDATE_TEMPLATE_TYPE_DESCRIPTOR_SET_KHR.
1187     */
1188    uint8_t set;
1189
1190    /* Number of entries in this template */
1191    uint32_t entry_count;
1192
1193    /* Entries of the template */
1194    struct anv_descriptor_template_entry entries[0];
1195 };
1196
1197 size_t
1198 anv_descriptor_set_layout_size(const struct anv_descriptor_set_layout *layout);
1199
1200 void
1201 anv_descriptor_set_write_image_view(struct anv_descriptor_set *set,
1202                                     const struct gen_device_info * const devinfo,
1203                                     const VkDescriptorImageInfo * const info,
1204                                     VkDescriptorType type,
1205                                     uint32_t binding,
1206                                     uint32_t element);
1207
1208 void
1209 anv_descriptor_set_write_buffer_view(struct anv_descriptor_set *set,
1210                                      VkDescriptorType type,
1211                                      struct anv_buffer_view *buffer_view,
1212                                      uint32_t binding,
1213                                      uint32_t element);
1214
1215 void
1216 anv_descriptor_set_write_buffer(struct anv_descriptor_set *set,
1217                                 struct anv_device *device,
1218                                 struct anv_state_stream *alloc_stream,
1219                                 VkDescriptorType type,
1220                                 struct anv_buffer *buffer,
1221                                 uint32_t binding,
1222                                 uint32_t element,
1223                                 VkDeviceSize offset,
1224                                 VkDeviceSize range);
1225
1226 void
1227 anv_descriptor_set_write_template(struct anv_descriptor_set *set,
1228                                   struct anv_device *device,
1229                                   struct anv_state_stream *alloc_stream,
1230                                   const struct anv_descriptor_update_template *template,
1231                                   const void *data);
1232
1233 VkResult
1234 anv_descriptor_set_create(struct anv_device *device,
1235                           struct anv_descriptor_pool *pool,
1236                           const struct anv_descriptor_set_layout *layout,
1237                           struct anv_descriptor_set **out_set);
1238
1239 void
1240 anv_descriptor_set_destroy(struct anv_device *device,
1241                            struct anv_descriptor_pool *pool,
1242                            struct anv_descriptor_set *set);
1243
1244 #define ANV_DESCRIPTOR_SET_COLOR_ATTACHMENTS UINT8_MAX
1245
1246 struct anv_pipeline_binding {
1247    /* The descriptor set this surface corresponds to.  The special value of
1248     * ANV_DESCRIPTOR_SET_COLOR_ATTACHMENTS indicates that the offset refers
1249     * to a color attachment and not a regular descriptor.
1250     */
1251    uint8_t set;
1252
1253    /* Binding in the descriptor set */
1254    uint8_t binding;
1255
1256    /* Index in the binding */
1257    uint8_t index;
1258
1259    /* Input attachment index (relative to the subpass) */
1260    uint8_t input_attachment_index;
1261
1262    /* For a storage image, whether it is write-only */
1263    bool write_only;
1264 };
1265
1266 struct anv_pipeline_layout {
1267    struct {
1268       struct anv_descriptor_set_layout *layout;
1269       uint32_t dynamic_offset_start;
1270    } set[MAX_SETS];
1271
1272    uint32_t num_sets;
1273
1274    struct {
1275       bool has_dynamic_offsets;
1276    } stage[MESA_SHADER_STAGES];
1277
1278    unsigned char sha1[20];
1279 };
1280
1281 struct anv_buffer {
1282    struct anv_device *                          device;
1283    VkDeviceSize                                 size;
1284
1285    VkBufferUsageFlags                           usage;
1286
1287    /* Set when bound */
1288    struct anv_bo *                              bo;
1289    VkDeviceSize                                 offset;
1290 };
1291
1292 static inline uint64_t
1293 anv_buffer_get_range(struct anv_buffer *buffer, uint64_t offset, uint64_t range)
1294 {
1295    assert(offset <= buffer->size);
1296    if (range == VK_WHOLE_SIZE) {
1297       return buffer->size - offset;
1298    } else {
1299       assert(range <= buffer->size);
1300       return range;
1301    }
1302 }
1303
1304 enum anv_cmd_dirty_bits {
1305    ANV_CMD_DIRTY_DYNAMIC_VIEWPORT                  = 1 << 0, /* VK_DYNAMIC_STATE_VIEWPORT */
1306    ANV_CMD_DIRTY_DYNAMIC_SCISSOR                   = 1 << 1, /* VK_DYNAMIC_STATE_SCISSOR */
1307    ANV_CMD_DIRTY_DYNAMIC_LINE_WIDTH                = 1 << 2, /* VK_DYNAMIC_STATE_LINE_WIDTH */
1308    ANV_CMD_DIRTY_DYNAMIC_DEPTH_BIAS                = 1 << 3, /* VK_DYNAMIC_STATE_DEPTH_BIAS */
1309    ANV_CMD_DIRTY_DYNAMIC_BLEND_CONSTANTS           = 1 << 4, /* VK_DYNAMIC_STATE_BLEND_CONSTANTS */
1310    ANV_CMD_DIRTY_DYNAMIC_DEPTH_BOUNDS              = 1 << 5, /* VK_DYNAMIC_STATE_DEPTH_BOUNDS */
1311    ANV_CMD_DIRTY_DYNAMIC_STENCIL_COMPARE_MASK      = 1 << 6, /* VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK */
1312    ANV_CMD_DIRTY_DYNAMIC_STENCIL_WRITE_MASK        = 1 << 7, /* VK_DYNAMIC_STATE_STENCIL_WRITE_MASK */
1313    ANV_CMD_DIRTY_DYNAMIC_STENCIL_REFERENCE         = 1 << 8, /* VK_DYNAMIC_STATE_STENCIL_REFERENCE */
1314    ANV_CMD_DIRTY_DYNAMIC_ALL                       = (1 << 9) - 1,
1315    ANV_CMD_DIRTY_PIPELINE                          = 1 << 9,
1316    ANV_CMD_DIRTY_INDEX_BUFFER                      = 1 << 10,
1317    ANV_CMD_DIRTY_RENDER_TARGETS                    = 1 << 11,
1318 };
1319 typedef uint32_t anv_cmd_dirty_mask_t;
1320
1321 enum anv_pipe_bits {
1322    ANV_PIPE_DEPTH_CACHE_FLUSH_BIT            = (1 << 0),
1323    ANV_PIPE_STALL_AT_SCOREBOARD_BIT          = (1 << 1),
1324    ANV_PIPE_STATE_CACHE_INVALIDATE_BIT       = (1 << 2),
1325    ANV_PIPE_CONSTANT_CACHE_INVALIDATE_BIT    = (1 << 3),
1326    ANV_PIPE_VF_CACHE_INVALIDATE_BIT          = (1 << 4),
1327    ANV_PIPE_DATA_CACHE_FLUSH_BIT             = (1 << 5),
1328    ANV_PIPE_TEXTURE_CACHE_INVALIDATE_BIT     = (1 << 10),
1329    ANV_PIPE_INSTRUCTION_CACHE_INVALIDATE_BIT = (1 << 11),
1330    ANV_PIPE_RENDER_TARGET_CACHE_FLUSH_BIT    = (1 << 12),
1331    ANV_PIPE_DEPTH_STALL_BIT                  = (1 << 13),
1332    ANV_PIPE_CS_STALL_BIT                     = (1 << 20),
1333
1334    /* This bit does not exist directly in PIPE_CONTROL.  Instead it means that
1335     * a flush has happened but not a CS stall.  The next time we do any sort
1336     * of invalidation we need to insert a CS stall at that time.  Otherwise,
1337     * we would have to CS stall on every flush which could be bad.
1338     */
1339    ANV_PIPE_NEEDS_CS_STALL_BIT               = (1 << 21),
1340 };
1341
1342 #define ANV_PIPE_FLUSH_BITS ( \
1343    ANV_PIPE_DEPTH_CACHE_FLUSH_BIT | \
1344    ANV_PIPE_DATA_CACHE_FLUSH_BIT | \
1345    ANV_PIPE_RENDER_TARGET_CACHE_FLUSH_BIT)
1346
1347 #define ANV_PIPE_STALL_BITS ( \
1348    ANV_PIPE_STALL_AT_SCOREBOARD_BIT | \
1349    ANV_PIPE_DEPTH_STALL_BIT | \
1350    ANV_PIPE_CS_STALL_BIT)
1351
1352 #define ANV_PIPE_INVALIDATE_BITS ( \
1353    ANV_PIPE_STATE_CACHE_INVALIDATE_BIT | \
1354    ANV_PIPE_CONSTANT_CACHE_INVALIDATE_BIT | \
1355    ANV_PIPE_VF_CACHE_INVALIDATE_BIT | \
1356    ANV_PIPE_DATA_CACHE_FLUSH_BIT | \
1357    ANV_PIPE_TEXTURE_CACHE_INVALIDATE_BIT | \
1358    ANV_PIPE_INSTRUCTION_CACHE_INVALIDATE_BIT)
1359
1360 static inline enum anv_pipe_bits
1361 anv_pipe_flush_bits_for_access_flags(VkAccessFlags flags)
1362 {
1363    enum anv_pipe_bits pipe_bits = 0;
1364
1365    unsigned b;
1366    for_each_bit(b, flags) {
1367       switch ((VkAccessFlagBits)(1 << b)) {
1368       case VK_ACCESS_SHADER_WRITE_BIT:
1369          pipe_bits |= ANV_PIPE_DATA_CACHE_FLUSH_BIT;
1370          break;
1371       case VK_ACCESS_COLOR_ATTACHMENT_WRITE_BIT:
1372          pipe_bits |= ANV_PIPE_RENDER_TARGET_CACHE_FLUSH_BIT;
1373          break;
1374       case VK_ACCESS_DEPTH_STENCIL_ATTACHMENT_WRITE_BIT:
1375          pipe_bits |= ANV_PIPE_DEPTH_CACHE_FLUSH_BIT;
1376          break;
1377       case VK_ACCESS_TRANSFER_WRITE_BIT:
1378          pipe_bits |= ANV_PIPE_RENDER_TARGET_CACHE_FLUSH_BIT;
1379          pipe_bits |= ANV_PIPE_DEPTH_CACHE_FLUSH_BIT;
1380          break;
1381       default:
1382          break; /* Nothing to do */
1383       }
1384    }
1385
1386    return pipe_bits;
1387 }
1388
1389 static inline enum anv_pipe_bits
1390 anv_pipe_invalidate_bits_for_access_flags(VkAccessFlags flags)
1391 {
1392    enum anv_pipe_bits pipe_bits = 0;
1393
1394    unsigned b;
1395    for_each_bit(b, flags) {
1396       switch ((VkAccessFlagBits)(1 << b)) {
1397       case VK_ACCESS_INDIRECT_COMMAND_READ_BIT:
1398       case VK_ACCESS_INDEX_READ_BIT:
1399       case VK_ACCESS_VERTEX_ATTRIBUTE_READ_BIT:
1400          pipe_bits |= ANV_PIPE_VF_CACHE_INVALIDATE_BIT;
1401          break;
1402       case VK_ACCESS_UNIFORM_READ_BIT:
1403          pipe_bits |= ANV_PIPE_CONSTANT_CACHE_INVALIDATE_BIT;
1404          pipe_bits |= ANV_PIPE_TEXTURE_CACHE_INVALIDATE_BIT;
1405          break;
1406       case VK_ACCESS_SHADER_READ_BIT:
1407       case VK_ACCESS_INPUT_ATTACHMENT_READ_BIT:
1408       case VK_ACCESS_TRANSFER_READ_BIT:
1409          pipe_bits |= ANV_PIPE_TEXTURE_CACHE_INVALIDATE_BIT;
1410          break;
1411       default:
1412          break; /* Nothing to do */
1413       }
1414    }
1415
1416    return pipe_bits;
1417 }
1418
1419 struct anv_vertex_binding {
1420    struct anv_buffer *                          buffer;
1421    VkDeviceSize                                 offset;
1422 };
1423
1424 struct anv_push_constants {
1425    /* Current allocated size of this push constants data structure.
1426     * Because a decent chunk of it may not be used (images on SKL, for
1427     * instance), we won't actually allocate the entire structure up-front.
1428     */
1429    uint32_t size;
1430
1431    /* Push constant data provided by the client through vkPushConstants */
1432    uint8_t client_data[MAX_PUSH_CONSTANTS_SIZE];
1433
1434    /* Our hardware only provides zero-based vertex and instance id so, in
1435     * order to satisfy the vulkan requirements, we may have to push one or
1436     * both of these into the shader.
1437     */
1438    uint32_t base_vertex;
1439    uint32_t base_instance;
1440
1441    /* Image data for image_load_store on pre-SKL */
1442    struct brw_image_param images[MAX_IMAGES];
1443 };
1444
1445 struct anv_dynamic_state {
1446    struct {
1447       uint32_t                                  count;
1448       VkViewport                                viewports[MAX_VIEWPORTS];
1449    } viewport;
1450
1451    struct {
1452       uint32_t                                  count;
1453       VkRect2D                                  scissors[MAX_SCISSORS];
1454    } scissor;
1455
1456    float                                        line_width;
1457
1458    struct {
1459       float                                     bias;
1460       float                                     clamp;
1461       float                                     slope;
1462    } depth_bias;
1463
1464    float                                        blend_constants[4];
1465
1466    struct {
1467       float                                     min;
1468       float                                     max;
1469    } depth_bounds;
1470
1471    struct {
1472       uint32_t                                  front;
1473       uint32_t                                  back;
1474    } stencil_compare_mask;
1475
1476    struct {
1477       uint32_t                                  front;
1478       uint32_t                                  back;
1479    } stencil_write_mask;
1480
1481    struct {
1482       uint32_t                                  front;
1483       uint32_t                                  back;
1484    } stencil_reference;
1485 };
1486
1487 extern const struct anv_dynamic_state default_dynamic_state;
1488
1489 void anv_dynamic_state_copy(struct anv_dynamic_state *dest,
1490                             const struct anv_dynamic_state *src,
1491                             uint32_t copy_mask);
1492
1493 /**
1494  * Attachment state when recording a renderpass instance.
1495  *
1496  * The clear value is valid only if there exists a pending clear.
1497  */
1498 struct anv_attachment_state {
1499    enum isl_aux_usage                           aux_usage;
1500    enum isl_aux_usage                           input_aux_usage;
1501    struct anv_state                             color_rt_state;
1502    struct anv_state                             input_att_state;
1503
1504    VkImageLayout                                current_layout;
1505    VkImageAspectFlags                           pending_clear_aspects;
1506    bool                                         fast_clear;
1507    VkClearValue                                 clear_value;
1508    bool                                         clear_color_is_zero_one;
1509 };
1510
1511 /** State required while building cmd buffer */
1512 struct anv_cmd_state {
1513    /* PIPELINE_SELECT.PipelineSelection */
1514    uint32_t                                     current_pipeline;
1515    const struct gen_l3_config *                 current_l3_config;
1516    uint32_t                                     vb_dirty;
1517    anv_cmd_dirty_mask_t                         dirty;
1518    anv_cmd_dirty_mask_t                         compute_dirty;
1519    enum anv_pipe_bits                           pending_pipe_bits;
1520    uint32_t                                     num_workgroups_offset;
1521    struct anv_bo                                *num_workgroups_bo;
1522    VkShaderStageFlags                           descriptors_dirty;
1523    VkShaderStageFlags                           push_constants_dirty;
1524    uint32_t                                     scratch_size;
1525    struct anv_pipeline *                        pipeline;
1526    struct anv_pipeline *                        compute_pipeline;
1527    struct anv_framebuffer *                     framebuffer;
1528    struct anv_render_pass *                     pass;
1529    struct anv_subpass *                         subpass;
1530    VkRect2D                                     render_area;
1531    uint32_t                                     restart_index;
1532    struct anv_vertex_binding                    vertex_bindings[MAX_VBS];
1533    struct anv_descriptor_set *                  descriptors[MAX_SETS];
1534    uint32_t                                     dynamic_offsets[MAX_DYNAMIC_BUFFERS];
1535    VkShaderStageFlags                           push_constant_stages;
1536    struct anv_push_constants *                  push_constants[MESA_SHADER_STAGES];
1537    struct anv_state                             binding_tables[MESA_SHADER_STAGES];
1538    struct anv_state                             samplers[MESA_SHADER_STAGES];
1539    struct anv_dynamic_state                     dynamic;
1540    bool                                         need_query_wa;
1541
1542    struct anv_push_descriptor_set               push_descriptor;
1543
1544    /**
1545     * Whether or not the gen8 PMA fix is enabled.  We ensure that, at the top
1546     * of any command buffer it is disabled by disabling it in EndCommandBuffer
1547     * and before invoking the secondary in ExecuteCommands.
1548     */
1549    bool                                         pma_fix_enabled;
1550
1551    /**
1552     * Whether or not we know for certain that HiZ is enabled for the current
1553     * subpass.  If, for whatever reason, we are unsure as to whether HiZ is
1554     * enabled or not, this will be false.
1555     */
1556    bool                                         hiz_enabled;
1557
1558    /**
1559     * Array length is anv_cmd_state::pass::attachment_count. Array content is
1560     * valid only when recording a render pass instance.
1561     */
1562    struct anv_attachment_state *                attachments;
1563
1564    /**
1565     * Surface states for color render targets.  These are stored in a single
1566     * flat array.  For depth-stencil attachments, the surface state is simply
1567     * left blank.
1568     */
1569    struct anv_state                             render_pass_states;
1570
1571    /**
1572     * A null surface state of the right size to match the framebuffer.  This
1573     * is one of the states in render_pass_states.
1574     */
1575    struct anv_state                             null_surface_state;
1576
1577    struct {
1578       struct anv_buffer *                       index_buffer;
1579       uint32_t                                  index_type; /**< 3DSTATE_INDEX_BUFFER.IndexFormat */
1580       uint32_t                                  index_offset;
1581    } gen7;
1582 };
1583
1584 struct anv_cmd_pool {
1585    VkAllocationCallbacks                        alloc;
1586    struct list_head                             cmd_buffers;
1587 };
1588
1589 #define ANV_CMD_BUFFER_BATCH_SIZE 8192
1590
1591 enum anv_cmd_buffer_exec_mode {
1592    ANV_CMD_BUFFER_EXEC_MODE_PRIMARY,
1593    ANV_CMD_BUFFER_EXEC_MODE_EMIT,
1594    ANV_CMD_BUFFER_EXEC_MODE_GROW_AND_EMIT,
1595    ANV_CMD_BUFFER_EXEC_MODE_CHAIN,
1596    ANV_CMD_BUFFER_EXEC_MODE_COPY_AND_CHAIN,
1597 };
1598
1599 struct anv_cmd_buffer {
1600    VK_LOADER_DATA                               _loader_data;
1601
1602    struct anv_device *                          device;
1603
1604    struct anv_cmd_pool *                        pool;
1605    struct list_head                             pool_link;
1606
1607    struct anv_batch                             batch;
1608
1609    /* Fields required for the actual chain of anv_batch_bo's.
1610     *
1611     * These fields are initialized by anv_cmd_buffer_init_batch_bo_chain().
1612     */
1613    struct list_head                             batch_bos;
1614    enum anv_cmd_buffer_exec_mode                exec_mode;
1615
1616    /* A vector of anv_batch_bo pointers for every batch or surface buffer
1617     * referenced by this command buffer
1618     *
1619     * initialized by anv_cmd_buffer_init_batch_bo_chain()
1620     */
1621    struct u_vector                            seen_bbos;
1622
1623    /* A vector of int32_t's for every block of binding tables.
1624     *
1625     * initialized by anv_cmd_buffer_init_batch_bo_chain()
1626     */
1627    struct u_vector                              bt_block_states;
1628    uint32_t                                     bt_next;
1629
1630    struct anv_reloc_list                        surface_relocs;
1631    /** Last seen surface state block pool center bo offset */
1632    uint32_t                                     last_ss_pool_center;
1633
1634    /* Serial for tracking buffer completion */
1635    uint32_t                                     serial;
1636
1637    /* Stream objects for storing temporary data */
1638    struct anv_state_stream                      surface_state_stream;
1639    struct anv_state_stream                      dynamic_state_stream;
1640
1641    VkCommandBufferUsageFlags                    usage_flags;
1642    VkCommandBufferLevel                         level;
1643
1644    struct anv_cmd_state                         state;
1645 };
1646
1647 VkResult anv_cmd_buffer_init_batch_bo_chain(struct anv_cmd_buffer *cmd_buffer);
1648 void anv_cmd_buffer_fini_batch_bo_chain(struct anv_cmd_buffer *cmd_buffer);
1649 void anv_cmd_buffer_reset_batch_bo_chain(struct anv_cmd_buffer *cmd_buffer);
1650 void anv_cmd_buffer_end_batch_buffer(struct anv_cmd_buffer *cmd_buffer);
1651 void anv_cmd_buffer_add_secondary(struct anv_cmd_buffer *primary,
1652                                   struct anv_cmd_buffer *secondary);
1653 void anv_cmd_buffer_prepare_execbuf(struct anv_cmd_buffer *cmd_buffer);
1654 VkResult anv_cmd_buffer_execbuf(struct anv_device *device,
1655                                 struct anv_cmd_buffer *cmd_buffer,
1656                                 const VkSemaphore *in_semaphores,
1657                                 uint32_t num_in_semaphores,
1658                                 const VkSemaphore *out_semaphores,
1659                                 uint32_t num_out_semaphores);
1660
1661 VkResult anv_cmd_buffer_reset(struct anv_cmd_buffer *cmd_buffer);
1662
1663 VkResult
1664 anv_cmd_buffer_ensure_push_constants_size(struct anv_cmd_buffer *cmd_buffer,
1665                                           gl_shader_stage stage, uint32_t size);
1666 #define anv_cmd_buffer_ensure_push_constant_field(cmd_buffer, stage, field) \
1667    anv_cmd_buffer_ensure_push_constants_size(cmd_buffer, stage, \
1668       (offsetof(struct anv_push_constants, field) + \
1669        sizeof(cmd_buffer->state.push_constants[0]->field)))
1670
1671 struct anv_state anv_cmd_buffer_emit_dynamic(struct anv_cmd_buffer *cmd_buffer,
1672                                              const void *data, uint32_t size, uint32_t alignment);
1673 struct anv_state anv_cmd_buffer_merge_dynamic(struct anv_cmd_buffer *cmd_buffer,
1674                                               uint32_t *a, uint32_t *b,
1675                                               uint32_t dwords, uint32_t alignment);
1676
1677 struct anv_address
1678 anv_cmd_buffer_surface_base_address(struct anv_cmd_buffer *cmd_buffer);
1679 struct anv_state
1680 anv_cmd_buffer_alloc_binding_table(struct anv_cmd_buffer *cmd_buffer,
1681                                    uint32_t entries, uint32_t *state_offset);
1682 struct anv_state
1683 anv_cmd_buffer_alloc_surface_state(struct anv_cmd_buffer *cmd_buffer);
1684 struct anv_state
1685 anv_cmd_buffer_alloc_dynamic_state(struct anv_cmd_buffer *cmd_buffer,
1686                                    uint32_t size, uint32_t alignment);
1687
1688 VkResult
1689 anv_cmd_buffer_new_binding_table_block(struct anv_cmd_buffer *cmd_buffer);
1690
1691 void gen8_cmd_buffer_emit_viewport(struct anv_cmd_buffer *cmd_buffer);
1692 void gen8_cmd_buffer_emit_depth_viewport(struct anv_cmd_buffer *cmd_buffer,
1693                                          bool depth_clamp_enable);
1694 void gen7_cmd_buffer_emit_scissor(struct anv_cmd_buffer *cmd_buffer);
1695
1696 void anv_cmd_buffer_setup_attachments(struct anv_cmd_buffer *cmd_buffer,
1697                                       struct anv_render_pass *pass,
1698                                       struct anv_framebuffer *framebuffer,
1699                                       const VkClearValue *clear_values);
1700
1701 void anv_cmd_buffer_emit_state_base_address(struct anv_cmd_buffer *cmd_buffer);
1702
1703 struct anv_state
1704 anv_cmd_buffer_push_constants(struct anv_cmd_buffer *cmd_buffer,
1705                               gl_shader_stage stage);
1706 struct anv_state
1707 anv_cmd_buffer_cs_push_constants(struct anv_cmd_buffer *cmd_buffer);
1708
1709 void anv_cmd_buffer_clear_subpass(struct anv_cmd_buffer *cmd_buffer);
1710 void anv_cmd_buffer_resolve_subpass(struct anv_cmd_buffer *cmd_buffer);
1711
1712 const struct anv_image_view *
1713 anv_cmd_buffer_get_depth_stencil_view(const struct anv_cmd_buffer *cmd_buffer);
1714
1715 VkResult
1716 anv_cmd_buffer_alloc_blorp_binding_table(struct anv_cmd_buffer *cmd_buffer,
1717                                          uint32_t num_entries,
1718                                          uint32_t *state_offset,
1719                                          struct anv_state *bt_state);
1720
1721 void anv_cmd_buffer_dump(struct anv_cmd_buffer *cmd_buffer);
1722
1723 enum anv_fence_state {
1724    /** Indicates that this is a new (or newly reset fence) */
1725    ANV_FENCE_STATE_RESET,
1726
1727    /** Indicates that this fence has been submitted to the GPU but is still
1728     * (as far as we know) in use by the GPU.
1729     */
1730    ANV_FENCE_STATE_SUBMITTED,
1731
1732    ANV_FENCE_STATE_SIGNALED,
1733 };
1734
1735 struct anv_fence {
1736    struct anv_bo bo;
1737    struct drm_i915_gem_execbuffer2 execbuf;
1738    struct drm_i915_gem_exec_object2 exec2_objects[1];
1739    enum anv_fence_state state;
1740 };
1741
1742 struct anv_event {
1743    uint64_t                                     semaphore;
1744    struct anv_state                             state;
1745 };
1746
1747 enum anv_semaphore_type {
1748    ANV_SEMAPHORE_TYPE_NONE = 0,
1749    ANV_SEMAPHORE_TYPE_DUMMY,
1750    ANV_SEMAPHORE_TYPE_BO,
1751 };
1752
1753 struct anv_semaphore_impl {
1754    enum anv_semaphore_type type;
1755
1756    /* A BO representing this semaphore when type == ANV_SEMAPHORE_TYPE_BO.
1757     * This BO will be added to the object list on any execbuf2 calls for
1758     * which this semaphore is used as a wait or signal fence.  When used as
1759     * a signal fence, the EXEC_OBJECT_WRITE flag will be set.
1760     */
1761    struct anv_bo *bo;
1762 };
1763
1764 struct anv_semaphore {
1765    /* Permanent semaphore state.  Every semaphore has some form of permanent
1766     * state (type != ANV_SEMAPHORE_TYPE_NONE).  This may be a BO to fence on
1767     * (for cross-process semaphores0 or it could just be a dummy for use
1768     * internally.
1769     */
1770    struct anv_semaphore_impl permanent;
1771
1772    /* Temporary semaphore state.  A semaphore *may* have temporary state.
1773     * That state is added to the semaphore by an import operation and is reset
1774     * back to ANV_SEMAPHORE_TYPE_NONE when the semaphore is waited on.  A
1775     * semaphore with temporary state cannot be signaled because the semaphore
1776     * must already be signaled before the temporary state can be exported from
1777     * the semaphore in the other process and imported here.
1778     */
1779    struct anv_semaphore_impl temporary;
1780 };
1781
1782 struct anv_shader_module {
1783    unsigned char                                sha1[20];
1784    uint32_t                                     size;
1785    char                                         data[0];
1786 };
1787
1788 static inline gl_shader_stage
1789 vk_to_mesa_shader_stage(VkShaderStageFlagBits vk_stage)
1790 {
1791    assert(__builtin_popcount(vk_stage) == 1);
1792    return ffs(vk_stage) - 1;
1793 }
1794
1795 static inline VkShaderStageFlagBits
1796 mesa_to_vk_shader_stage(gl_shader_stage mesa_stage)
1797 {
1798    return (1 << mesa_stage);
1799 }
1800
1801 #define ANV_STAGE_MASK ((1 << MESA_SHADER_STAGES) - 1)
1802
1803 #define anv_foreach_stage(stage, stage_bits)                         \
1804    for (gl_shader_stage stage,                                       \
1805         __tmp = (gl_shader_stage)((stage_bits) & ANV_STAGE_MASK);    \
1806         stage = __builtin_ffs(__tmp) - 1, __tmp;                     \
1807         __tmp &= ~(1 << (stage)))
1808
1809 struct anv_pipeline_bind_map {
1810    uint32_t surface_count;
1811    uint32_t sampler_count;
1812    uint32_t image_count;
1813
1814    struct anv_pipeline_binding *                surface_to_descriptor;
1815    struct anv_pipeline_binding *                sampler_to_descriptor;
1816 };
1817
1818 struct anv_shader_bin_key {
1819    uint32_t size;
1820    uint8_t data[0];
1821 };
1822
1823 struct anv_shader_bin {
1824    uint32_t ref_cnt;
1825
1826    const struct anv_shader_bin_key *key;
1827
1828    struct anv_state kernel;
1829    uint32_t kernel_size;
1830
1831    const struct brw_stage_prog_data *prog_data;
1832    uint32_t prog_data_size;
1833
1834    struct anv_pipeline_bind_map bind_map;
1835
1836    /* Prog data follows, then params, then the key, all aligned to 8-bytes */
1837 };
1838
1839 struct anv_shader_bin *
1840 anv_shader_bin_create(struct anv_device *device,
1841                       const void *key, uint32_t key_size,
1842                       const void *kernel, uint32_t kernel_size,
1843                       const struct brw_stage_prog_data *prog_data,
1844                       uint32_t prog_data_size, const void *prog_data_param,
1845                       const struct anv_pipeline_bind_map *bind_map);
1846
1847 void
1848 anv_shader_bin_destroy(struct anv_device *device, struct anv_shader_bin *shader);
1849
1850 static inline void
1851 anv_shader_bin_ref(struct anv_shader_bin *shader)
1852 {
1853    assert(shader && shader->ref_cnt >= 1);
1854    __sync_fetch_and_add(&shader->ref_cnt, 1);
1855 }
1856
1857 static inline void
1858 anv_shader_bin_unref(struct anv_device *device, struct anv_shader_bin *shader)
1859 {
1860    assert(shader && shader->ref_cnt >= 1);
1861    if (__sync_fetch_and_add(&shader->ref_cnt, -1) == 1)
1862       anv_shader_bin_destroy(device, shader);
1863 }
1864
1865 struct anv_pipeline {
1866    struct anv_device *                          device;
1867    struct anv_batch                             batch;
1868    uint32_t                                     batch_data[512];
1869    struct anv_reloc_list                        batch_relocs;
1870    uint32_t                                     dynamic_state_mask;
1871    struct anv_dynamic_state                     dynamic_state;
1872
1873    struct anv_subpass *                         subpass;
1874    struct anv_pipeline_layout *                 layout;
1875
1876    bool                                         needs_data_cache;
1877
1878    struct anv_shader_bin *                      shaders[MESA_SHADER_STAGES];
1879
1880    struct {
1881       const struct gen_l3_config *              l3_config;
1882       uint32_t                                  total_size;
1883    } urb;
1884
1885    VkShaderStageFlags                           active_stages;
1886    struct anv_state                             blend_state;
1887
1888    uint32_t                                     vb_used;
1889    uint32_t                                     binding_stride[MAX_VBS];
1890    bool                                         instancing_enable[MAX_VBS];
1891    bool                                         primitive_restart;
1892    uint32_t                                     topology;
1893
1894    uint32_t                                     cs_right_mask;
1895
1896    bool                                         writes_depth;
1897    bool                                         depth_test_enable;
1898    bool                                         writes_stencil;
1899    bool                                         stencil_test_enable;
1900    bool                                         depth_clamp_enable;
1901    bool                                         sample_shading_enable;
1902    bool                                         kill_pixel;
1903
1904    struct {
1905       uint32_t                                  sf[7];
1906       uint32_t                                  depth_stencil_state[3];
1907    } gen7;
1908
1909    struct {
1910       uint32_t                                  sf[4];
1911       uint32_t                                  raster[5];
1912       uint32_t                                  wm_depth_stencil[3];
1913    } gen8;
1914
1915    struct {
1916       uint32_t                                  wm_depth_stencil[4];
1917    } gen9;
1918
1919    uint32_t                                     interface_descriptor_data[8];
1920 };
1921
1922 static inline bool
1923 anv_pipeline_has_stage(const struct anv_pipeline *pipeline,
1924                        gl_shader_stage stage)
1925 {
1926    return (pipeline->active_stages & mesa_to_vk_shader_stage(stage)) != 0;
1927 }
1928
1929 #define ANV_DECL_GET_PROG_DATA_FUNC(prefix, stage)                   \
1930 static inline const struct brw_##prefix##_prog_data *                \
1931 get_##prefix##_prog_data(const struct anv_pipeline *pipeline)        \
1932 {                                                                    \
1933    if (anv_pipeline_has_stage(pipeline, stage)) {                    \
1934       return (const struct brw_##prefix##_prog_data *)               \
1935              pipeline->shaders[stage]->prog_data;                    \
1936    } else {                                                          \
1937       return NULL;                                                   \
1938    }                                                                 \
1939 }
1940
1941 ANV_DECL_GET_PROG_DATA_FUNC(vs, MESA_SHADER_VERTEX)
1942 ANV_DECL_GET_PROG_DATA_FUNC(tcs, MESA_SHADER_TESS_CTRL)
1943 ANV_DECL_GET_PROG_DATA_FUNC(tes, MESA_SHADER_TESS_EVAL)
1944 ANV_DECL_GET_PROG_DATA_FUNC(gs, MESA_SHADER_GEOMETRY)
1945 ANV_DECL_GET_PROG_DATA_FUNC(wm, MESA_SHADER_FRAGMENT)
1946 ANV_DECL_GET_PROG_DATA_FUNC(cs, MESA_SHADER_COMPUTE)
1947
1948 static inline const struct brw_vue_prog_data *
1949 anv_pipeline_get_last_vue_prog_data(const struct anv_pipeline *pipeline)
1950 {
1951    if (anv_pipeline_has_stage(pipeline, MESA_SHADER_GEOMETRY))
1952       return &get_gs_prog_data(pipeline)->base;
1953    else if (anv_pipeline_has_stage(pipeline, MESA_SHADER_TESS_EVAL))
1954       return &get_tes_prog_data(pipeline)->base;
1955    else
1956       return &get_vs_prog_data(pipeline)->base;
1957 }
1958
1959 VkResult
1960 anv_pipeline_init(struct anv_pipeline *pipeline, struct anv_device *device,
1961                   struct anv_pipeline_cache *cache,
1962                   const VkGraphicsPipelineCreateInfo *pCreateInfo,
1963                   const VkAllocationCallbacks *alloc);
1964
1965 VkResult
1966 anv_pipeline_compile_cs(struct anv_pipeline *pipeline,
1967                         struct anv_pipeline_cache *cache,
1968                         const VkComputePipelineCreateInfo *info,
1969                         struct anv_shader_module *module,
1970                         const char *entrypoint,
1971                         const VkSpecializationInfo *spec_info);
1972
1973 struct anv_format {
1974    enum isl_format isl_format:16;
1975    struct isl_swizzle swizzle;
1976 };
1977
1978 struct anv_format
1979 anv_get_format(const struct gen_device_info *devinfo, VkFormat format,
1980                VkImageAspectFlags aspect, VkImageTiling tiling);
1981
1982 static inline enum isl_format
1983 anv_get_isl_format(const struct gen_device_info *devinfo, VkFormat vk_format,
1984                    VkImageAspectFlags aspect, VkImageTiling tiling)
1985 {
1986    return anv_get_format(devinfo, vk_format, aspect, tiling).isl_format;
1987 }
1988
1989 static inline struct isl_swizzle
1990 anv_swizzle_for_render(struct isl_swizzle swizzle)
1991 {
1992    /* Sometimes the swizzle will have alpha map to one.  We do this to fake
1993     * RGB as RGBA for texturing
1994     */
1995    assert(swizzle.a == ISL_CHANNEL_SELECT_ONE ||
1996           swizzle.a == ISL_CHANNEL_SELECT_ALPHA);
1997
1998    /* But it doesn't matter what we render to that channel */
1999    swizzle.a = ISL_CHANNEL_SELECT_ALPHA;
2000
2001    return swizzle;
2002 }
2003
2004 void
2005 anv_pipeline_setup_l3_config(struct anv_pipeline *pipeline, bool needs_slm);
2006
2007 /**
2008  * Subsurface of an anv_image.
2009  */
2010 struct anv_surface {
2011    /** Valid only if isl_surf::size > 0. */
2012    struct isl_surf isl;
2013
2014    /**
2015     * Offset from VkImage's base address, as bound by vkBindImageMemory().
2016     */
2017    uint32_t offset;
2018 };
2019
2020 struct anv_image {
2021    VkImageType type;
2022    /* The original VkFormat provided by the client.  This may not match any
2023     * of the actual surface formats.
2024     */
2025    VkFormat vk_format;
2026    VkImageAspectFlags aspects;
2027    VkExtent3D extent;
2028    uint32_t levels;
2029    uint32_t array_size;
2030    uint32_t samples; /**< VkImageCreateInfo::samples */
2031    VkImageUsageFlags usage; /**< Superset of VkImageCreateInfo::usage. */
2032    VkImageTiling tiling; /** VkImageCreateInfo::tiling */
2033
2034    VkDeviceSize size;
2035    uint32_t alignment;
2036
2037    /* Set when bound */
2038    struct anv_bo *bo;
2039    VkDeviceSize offset;
2040
2041    /**
2042     * Image subsurfaces
2043     *
2044     * For each foo, anv_image::foo_surface is valid if and only if
2045     * anv_image::aspects has a foo aspect.
2046     *
2047     * The hardware requires that the depth buffer and stencil buffer be
2048     * separate surfaces.  From Vulkan's perspective, though, depth and stencil
2049     * reside in the same VkImage.  To satisfy both the hardware and Vulkan, we
2050     * allocate the depth and stencil buffers as separate surfaces in the same
2051     * bo.
2052     */
2053    union {
2054       struct anv_surface color_surface;
2055
2056       struct {
2057          struct anv_surface depth_surface;
2058          struct anv_surface stencil_surface;
2059       };
2060    };
2061
2062    /**
2063     * For color images, this is the aux usage for this image when not used as a
2064     * color attachment.
2065     *
2066     * For depth/stencil images, this is set to ISL_AUX_USAGE_HIZ if the image
2067     * has a HiZ buffer.
2068     */
2069    enum isl_aux_usage aux_usage;
2070
2071    struct anv_surface aux_surface;
2072 };
2073
2074 /* Returns true if a HiZ-enabled depth buffer can be sampled from. */
2075 static inline bool
2076 anv_can_sample_with_hiz(const struct gen_device_info * const devinfo,
2077                         const VkImageAspectFlags aspect_mask,
2078                         const uint32_t samples)
2079 {
2080    /* Validate the inputs. */
2081    assert(devinfo && aspect_mask && samples);
2082    return devinfo->gen >= 8 && (aspect_mask & VK_IMAGE_ASPECT_DEPTH_BIT) &&
2083           samples == 1;
2084 }
2085
2086 void
2087 anv_gen8_hiz_op_resolve(struct anv_cmd_buffer *cmd_buffer,
2088                         const struct anv_image *image,
2089                         enum blorp_hiz_op op);
2090
2091 void
2092 anv_image_ccs_clear(struct anv_cmd_buffer *cmd_buffer,
2093                     const struct anv_image *image,
2094                     const struct isl_view *view,
2095                     const VkImageSubresourceRange *subresourceRange);
2096
2097 enum isl_aux_usage
2098 anv_layout_to_aux_usage(const struct gen_device_info * const devinfo,
2099                         const struct anv_image *image,
2100                         const VkImageAspectFlags aspects,
2101                         const VkImageLayout layout);
2102
2103 /* This is defined as a macro so that it works for both
2104  * VkImageSubresourceRange and VkImageSubresourceLayers
2105  */
2106 #define anv_get_layerCount(_image, _range) \
2107    ((_range)->layerCount == VK_REMAINING_ARRAY_LAYERS ? \
2108     (_image)->array_size - (_range)->baseArrayLayer : (_range)->layerCount)
2109
2110 static inline uint32_t
2111 anv_get_levelCount(const struct anv_image *image,
2112                    const VkImageSubresourceRange *range)
2113 {
2114    return range->levelCount == VK_REMAINING_MIP_LEVELS ?
2115           image->levels - range->baseMipLevel : range->levelCount;
2116 }
2117
2118
2119 struct anv_image_view {
2120    const struct anv_image *image; /**< VkImageViewCreateInfo::image */
2121    struct anv_bo *bo;
2122    uint32_t offset; /**< Offset into bo. */
2123
2124    struct isl_view isl;
2125
2126    VkImageAspectFlags aspect_mask;
2127    VkFormat vk_format;
2128    VkExtent3D extent; /**< Extent of VkImageViewCreateInfo::baseMipLevel. */
2129
2130    /** RENDER_SURFACE_STATE when using image as a sampler surface. */
2131    struct anv_state sampler_surface_state;
2132
2133    /**
2134     * RENDER_SURFACE_STATE when using image as a sampler surface with the
2135     * auxiliary buffer disabled.
2136     */
2137    struct anv_state no_aux_sampler_surface_state;
2138
2139    /**
2140     * RENDER_SURFACE_STATE when using image as a storage image. Separate states
2141     * for write-only and readable, using the real format for write-only and the
2142     * lowered format for readable.
2143     */
2144    struct anv_state storage_surface_state;
2145    struct anv_state writeonly_storage_surface_state;
2146
2147    struct brw_image_param storage_image_param;
2148 };
2149
2150 struct anv_image_create_info {
2151    const VkImageCreateInfo *vk_info;
2152
2153    /** An opt-in bitmask which filters an ISL-mapping of the Vulkan tiling. */
2154    isl_tiling_flags_t isl_tiling_flags;
2155
2156    uint32_t stride;
2157 };
2158
2159 VkResult anv_image_create(VkDevice _device,
2160                           const struct anv_image_create_info *info,
2161                           const VkAllocationCallbacks* alloc,
2162                           VkImage *pImage);
2163
2164 const struct anv_surface *
2165 anv_image_get_surface_for_aspect_mask(const struct anv_image *image,
2166                                       VkImageAspectFlags aspect_mask);
2167
2168 enum isl_format
2169 anv_isl_format_for_descriptor_type(VkDescriptorType type);
2170
2171 static inline struct VkExtent3D
2172 anv_sanitize_image_extent(const VkImageType imageType,
2173                           const struct VkExtent3D imageExtent)
2174 {
2175    switch (imageType) {
2176    case VK_IMAGE_TYPE_1D:
2177       return (VkExtent3D) { imageExtent.width, 1, 1 };
2178    case VK_IMAGE_TYPE_2D:
2179       return (VkExtent3D) { imageExtent.width, imageExtent.height, 1 };
2180    case VK_IMAGE_TYPE_3D:
2181       return imageExtent;
2182    default:
2183       unreachable("invalid image type");
2184    }
2185 }
2186
2187 static inline struct VkOffset3D
2188 anv_sanitize_image_offset(const VkImageType imageType,
2189                           const struct VkOffset3D imageOffset)
2190 {
2191    switch (imageType) {
2192    case VK_IMAGE_TYPE_1D:
2193       return (VkOffset3D) { imageOffset.x, 0, 0 };
2194    case VK_IMAGE_TYPE_2D:
2195       return (VkOffset3D) { imageOffset.x, imageOffset.y, 0 };
2196    case VK_IMAGE_TYPE_3D:
2197       return imageOffset;
2198    default:
2199       unreachable("invalid image type");
2200    }
2201 }
2202
2203
2204 void anv_fill_buffer_surface_state(struct anv_device *device,
2205                                    struct anv_state state,
2206                                    enum isl_format format,
2207                                    uint32_t offset, uint32_t range,
2208                                    uint32_t stride);
2209
2210 void anv_image_view_fill_image_param(struct anv_device *device,
2211                                      struct anv_image_view *view,
2212                                      struct brw_image_param *param);
2213 void anv_buffer_view_fill_image_param(struct anv_device *device,
2214                                       struct anv_buffer_view *view,
2215                                       struct brw_image_param *param);
2216
2217 struct anv_sampler {
2218    uint32_t state[4];
2219 };
2220
2221 struct anv_framebuffer {
2222    uint32_t                                     width;
2223    uint32_t                                     height;
2224    uint32_t                                     layers;
2225
2226    uint32_t                                     attachment_count;
2227    struct anv_image_view *                      attachments[0];
2228 };
2229
2230 struct anv_subpass {
2231    uint32_t                                     attachment_count;
2232
2233    /**
2234     * A pointer to all attachment references used in this subpass.
2235     * Only valid if ::attachment_count > 0.
2236     */
2237    VkAttachmentReference *                      attachments;
2238    uint32_t                                     input_count;
2239    VkAttachmentReference *                      input_attachments;
2240    uint32_t                                     color_count;
2241    VkAttachmentReference *                      color_attachments;
2242    VkAttachmentReference *                      resolve_attachments;
2243
2244    VkAttachmentReference                        depth_stencil_attachment;
2245
2246    uint32_t                                     view_mask;
2247
2248    /** Subpass has a depth/stencil self-dependency */
2249    bool                                         has_ds_self_dep;
2250
2251    /** Subpass has at least one resolve attachment */
2252    bool                                         has_resolve;
2253 };
2254
2255 static inline unsigned
2256 anv_subpass_view_count(const struct anv_subpass *subpass)
2257 {
2258    return MAX2(1, _mesa_bitcount(subpass->view_mask));
2259 }
2260
2261 enum anv_subpass_usage {
2262    ANV_SUBPASS_USAGE_DRAW =         (1 << 0),
2263    ANV_SUBPASS_USAGE_INPUT =        (1 << 1),
2264    ANV_SUBPASS_USAGE_RESOLVE_SRC =  (1 << 2),
2265    ANV_SUBPASS_USAGE_RESOLVE_DST =  (1 << 3),
2266 };
2267
2268 struct anv_render_pass_attachment {
2269    /* TODO: Consider using VkAttachmentDescription instead of storing each of
2270     * its members individually.
2271     */
2272    VkFormat                                     format;
2273    uint32_t                                     samples;
2274    VkImageUsageFlags                            usage;
2275    VkAttachmentLoadOp                           load_op;
2276    VkAttachmentStoreOp                          store_op;
2277    VkAttachmentLoadOp                           stencil_load_op;
2278    VkImageLayout                                initial_layout;
2279    VkImageLayout                                final_layout;
2280
2281    /* An array, indexed by subpass id, of how the attachment will be used. */
2282    enum anv_subpass_usage *                     subpass_usage;
2283
2284    /* The subpass id in which the attachment will be used last. */
2285    uint32_t                                     last_subpass_idx;
2286 };
2287
2288 struct anv_render_pass {
2289    uint32_t                                     attachment_count;
2290    uint32_t                                     subpass_count;
2291    /* An array of subpass_count+1 flushes, one per subpass boundary */
2292    enum anv_pipe_bits *                         subpass_flushes;
2293    struct anv_render_pass_attachment *          attachments;
2294    struct anv_subpass                           subpasses[0];
2295 };
2296
2297 #define ANV_PIPELINE_STATISTICS_MASK 0x000007ff
2298
2299 struct anv_query_pool {
2300    VkQueryType                                  type;
2301    VkQueryPipelineStatisticFlags                pipeline_statistics;
2302    /** Stride between slots, in bytes */
2303    uint32_t                                     stride;
2304    /** Number of slots in this query pool */
2305    uint32_t                                     slots;
2306    struct anv_bo                                bo;
2307 };
2308
2309 void *anv_lookup_entrypoint(const struct gen_device_info *devinfo,
2310                             const char *name);
2311
2312 void anv_dump_image_to_ppm(struct anv_device *device,
2313                            struct anv_image *image, unsigned miplevel,
2314                            unsigned array_layer, VkImageAspectFlagBits aspect,
2315                            const char *filename);
2316
2317 enum anv_dump_action {
2318    ANV_DUMP_FRAMEBUFFERS_BIT = 0x1,
2319 };
2320
2321 void anv_dump_start(struct anv_device *device, enum anv_dump_action actions);
2322 void anv_dump_finish(void);
2323
2324 void anv_dump_add_framebuffer(struct anv_cmd_buffer *cmd_buffer,
2325                               struct anv_framebuffer *fb);
2326
2327 static inline uint32_t
2328 anv_get_subpass_id(const struct anv_cmd_state * const cmd_state)
2329 {
2330    /* This function must be called from within a subpass. */
2331    assert(cmd_state->pass && cmd_state->subpass);
2332
2333    const uint32_t subpass_id = cmd_state->subpass - cmd_state->pass->subpasses;
2334
2335    /* The id of this subpass shouldn't exceed the number of subpasses in this
2336     * render pass minus 1.
2337     */
2338    assert(subpass_id < cmd_state->pass->subpass_count);
2339    return subpass_id;
2340 }
2341
2342 #define ANV_DEFINE_HANDLE_CASTS(__anv_type, __VkType)                      \
2343                                                                            \
2344    static inline struct __anv_type *                                       \
2345    __anv_type ## _from_handle(__VkType _handle)                            \
2346    {                                                                       \
2347       return (struct __anv_type *) _handle;                                \
2348    }                                                                       \
2349                                                                            \
2350    static inline __VkType                                                  \
2351    __anv_type ## _to_handle(struct __anv_type *_obj)                       \
2352    {                                                                       \
2353       return (__VkType) _obj;                                              \
2354    }
2355
2356 #define ANV_DEFINE_NONDISP_HANDLE_CASTS(__anv_type, __VkType)              \
2357                                                                            \
2358    static inline struct __anv_type *                                       \
2359    __anv_type ## _from_handle(__VkType _handle)                            \
2360    {                                                                       \
2361       return (struct __anv_type *)(uintptr_t) _handle;                     \
2362    }                                                                       \
2363                                                                            \
2364    static inline __VkType                                                  \
2365    __anv_type ## _to_handle(struct __anv_type *_obj)                       \
2366    {                                                                       \
2367       return (__VkType)(uintptr_t) _obj;                                   \
2368    }
2369
2370 #define ANV_FROM_HANDLE(__anv_type, __name, __handle) \
2371    struct __anv_type *__name = __anv_type ## _from_handle(__handle)
2372
2373 ANV_DEFINE_HANDLE_CASTS(anv_cmd_buffer, VkCommandBuffer)
2374 ANV_DEFINE_HANDLE_CASTS(anv_device, VkDevice)
2375 ANV_DEFINE_HANDLE_CASTS(anv_instance, VkInstance)
2376 ANV_DEFINE_HANDLE_CASTS(anv_physical_device, VkPhysicalDevice)
2377 ANV_DEFINE_HANDLE_CASTS(anv_queue, VkQueue)
2378
2379 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_cmd_pool, VkCommandPool)
2380 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_buffer, VkBuffer)
2381 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_buffer_view, VkBufferView)
2382 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_pool, VkDescriptorPool)
2383 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_set, VkDescriptorSet)
2384 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_set_layout, VkDescriptorSetLayout)
2385 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_update_template, VkDescriptorUpdateTemplateKHR)
2386 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_device_memory, VkDeviceMemory)
2387 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_fence, VkFence)
2388 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_event, VkEvent)
2389 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_framebuffer, VkFramebuffer)
2390 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_image, VkImage)
2391 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_image_view, VkImageView);
2392 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_pipeline_cache, VkPipelineCache)
2393 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_pipeline, VkPipeline)
2394 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_pipeline_layout, VkPipelineLayout)
2395 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_query_pool, VkQueryPool)
2396 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_render_pass, VkRenderPass)
2397 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_sampler, VkSampler)
2398 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_semaphore, VkSemaphore)
2399 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_shader_module, VkShaderModule)
2400
2401 /* Gen-specific function declarations */
2402 #ifdef genX
2403 #  include "anv_genX.h"
2404 #else
2405 #  define genX(x) gen7_##x
2406 #  include "anv_genX.h"
2407 #  undef genX
2408 #  define genX(x) gen75_##x
2409 #  include "anv_genX.h"
2410 #  undef genX
2411 #  define genX(x) gen8_##x
2412 #  include "anv_genX.h"
2413 #  undef genX
2414 #  define genX(x) gen9_##x
2415 #  include "anv_genX.h"
2416 #  undef genX
2417 #endif
2418
2419 #endif /* ANV_PRIVATE_H */