OSDN Git Service

2d5d673dbb4e07a3d1f3958c14877300c576f50a
[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 "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 gen_l3_config;
60
61 #include <vulkan/vulkan.h>
62 #include <vulkan/vulkan_intel.h>
63 #include <vulkan/vk_icd.h>
64
65 #include "anv_entrypoints.h"
66 #include "brw_context.h"
67 #include "isl/isl.h"
68
69 #include "wsi_common.h"
70
71 #ifdef __cplusplus
72 extern "C" {
73 #endif
74
75 #define MAX_VBS         32
76 #define MAX_SETS         8
77 #define MAX_RTS          8
78 #define MAX_VIEWPORTS   16
79 #define MAX_SCISSORS    16
80 #define MAX_PUSH_CONSTANTS_SIZE 128
81 #define MAX_DYNAMIC_BUFFERS 16
82 #define MAX_IMAGES 8
83 #define MAX_SAMPLES_LOG2 4 /* SKL supports 16 samples */
84
85 #define anv_noreturn __attribute__((__noreturn__))
86 #define anv_printflike(a, b) __attribute__((__format__(__printf__, a, b)))
87
88 static inline uint32_t
89 align_down_npot_u32(uint32_t v, uint32_t a)
90 {
91    return v - (v % a);
92 }
93
94 static inline uint32_t
95 align_u32(uint32_t v, uint32_t a)
96 {
97    assert(a != 0 && a == (a & -a));
98    return (v + a - 1) & ~(a - 1);
99 }
100
101 static inline uint64_t
102 align_u64(uint64_t v, uint64_t a)
103 {
104    assert(a != 0 && a == (a & -a));
105    return (v + a - 1) & ~(a - 1);
106 }
107
108 static inline int32_t
109 align_i32(int32_t v, int32_t a)
110 {
111    assert(a != 0 && a == (a & -a));
112    return (v + a - 1) & ~(a - 1);
113 }
114
115 /** Alignment must be a power of 2. */
116 static inline bool
117 anv_is_aligned(uintmax_t n, uintmax_t a)
118 {
119    assert(a == (a & -a));
120    return (n & (a - 1)) == 0;
121 }
122
123 static inline uint32_t
124 anv_minify(uint32_t n, uint32_t levels)
125 {
126    if (unlikely(n == 0))
127       return 0;
128    else
129       return MAX2(n >> levels, 1);
130 }
131
132 static inline float
133 anv_clamp_f(float f, float min, float max)
134 {
135    assert(min < max);
136
137    if (f > max)
138       return max;
139    else if (f < min)
140       return min;
141    else
142       return f;
143 }
144
145 static inline bool
146 anv_clear_mask(uint32_t *inout_mask, uint32_t clear_mask)
147 {
148    if (*inout_mask & clear_mask) {
149       *inout_mask &= ~clear_mask;
150       return true;
151    } else {
152       return false;
153    }
154 }
155
156 #define for_each_bit(b, dword)                          \
157    for (uint32_t __dword = (dword);                     \
158         (b) = __builtin_ffs(__dword) - 1, __dword;      \
159         __dword &= ~(1 << (b)))
160
161 #define typed_memcpy(dest, src, count) ({ \
162    static_assert(sizeof(*src) == sizeof(*dest), ""); \
163    memcpy((dest), (src), (count) * sizeof(*(src))); \
164 })
165
166 #define zero(x) (memset(&(x), 0, sizeof(x)))
167
168 /* Define no kernel as 1, since that's an illegal offset for a kernel */
169 #define NO_KERNEL 1
170
171 struct anv_common {
172     VkStructureType                             sType;
173     const void*                                 pNext;
174 };
175
176 /* Whenever we generate an error, pass it through this function. Useful for
177  * debugging, where we can break on it. Only call at error site, not when
178  * propagating errors. Might be useful to plug in a stack trace here.
179  */
180
181 VkResult __vk_errorf(VkResult error, const char *file, int line, const char *format, ...);
182
183 #ifdef DEBUG
184 #define vk_error(error) __vk_errorf(error, __FILE__, __LINE__, NULL);
185 #define vk_errorf(error, format, ...) __vk_errorf(error, __FILE__, __LINE__, format, ## __VA_ARGS__);
186 #else
187 #define vk_error(error) error
188 #define vk_errorf(error, format, ...) error
189 #endif
190
191 void __anv_finishme(const char *file, int line, const char *format, ...)
192    anv_printflike(3, 4);
193 void anv_loge(const char *format, ...) anv_printflike(1, 2);
194 void anv_loge_v(const char *format, va_list va);
195
196 /**
197  * Print a FINISHME message, including its source location.
198  */
199 #define anv_finishme(format, ...) \
200    __anv_finishme(__FILE__, __LINE__, format, ##__VA_ARGS__);
201
202 /* A non-fatal assert.  Useful for debugging. */
203 #ifdef DEBUG
204 #define anv_assert(x) ({ \
205    if (unlikely(!(x))) \
206       fprintf(stderr, "%s:%d ASSERT: %s\n", __FILE__, __LINE__, #x); \
207 })
208 #else
209 #define anv_assert(x)
210 #endif
211
212 /**
213  * If a block of code is annotated with anv_validate, then the block runs only
214  * in debug builds.
215  */
216 #ifdef DEBUG
217 #define anv_validate if (1)
218 #else
219 #define anv_validate if (0)
220 #endif
221
222 void anv_abortf(const char *format, ...) anv_noreturn anv_printflike(1, 2);
223 void anv_abortfv(const char *format, va_list va) anv_noreturn;
224
225 #define stub_return(v) \
226    do { \
227       anv_finishme("stub %s", __func__); \
228       return (v); \
229    } while (0)
230
231 #define stub() \
232    do { \
233       anv_finishme("stub %s", __func__); \
234       return; \
235    } while (0)
236
237 /**
238  * A dynamically growable, circular buffer.  Elements are added at head and
239  * removed from tail. head and tail are free-running uint32_t indices and we
240  * only compute the modulo with size when accessing the array.  This way,
241  * number of bytes in the queue is always head - tail, even in case of
242  * wraparound.
243  */
244
245 struct anv_bo {
246    uint32_t gem_handle;
247
248    /* Index into the current validation list.  This is used by the
249     * validation list building alrogithm to track which buffers are already
250     * in the validation list so that we can ensure uniqueness.
251     */
252    uint32_t index;
253
254    /* Last known offset.  This value is provided by the kernel when we
255     * execbuf and is used as the presumed offset for the next bunch of
256     * relocations.
257     */
258    uint64_t offset;
259
260    uint64_t size;
261    void *map;
262
263    /* We need to set the WRITE flag on winsys bos so GEM will know we're
264     * writing to them and synchronize uses on other rings (eg if the display
265     * server uses the blitter ring).
266     */
267    bool is_winsys_bo;
268 };
269
270 static inline void
271 anv_bo_init(struct anv_bo *bo, uint32_t gem_handle, uint64_t size)
272 {
273    bo->gem_handle = gem_handle;
274    bo->index = 0;
275    bo->offset = -1;
276    bo->size = size;
277    bo->map = NULL;
278    bo->is_winsys_bo = false;
279 }
280
281 /* Represents a lock-free linked list of "free" things.  This is used by
282  * both the block pool and the state pools.  Unfortunately, in order to
283  * solve the ABA problem, we can't use a single uint32_t head.
284  */
285 union anv_free_list {
286    struct {
287       int32_t offset;
288
289       /* A simple count that is incremented every time the head changes. */
290       uint32_t count;
291    };
292    uint64_t u64;
293 };
294
295 #define ANV_FREE_LIST_EMPTY ((union anv_free_list) { { 1, 0 } })
296
297 struct anv_block_state {
298    union {
299       struct {
300          uint32_t next;
301          uint32_t end;
302       };
303       uint64_t u64;
304    };
305 };
306
307 struct anv_block_pool {
308    struct anv_device *device;
309
310    struct anv_bo bo;
311
312    /* The offset from the start of the bo to the "center" of the block
313     * pool.  Pointers to allocated blocks are given by
314     * bo.map + center_bo_offset + offsets.
315     */
316    uint32_t center_bo_offset;
317
318    /* Current memory map of the block pool.  This pointer may or may not
319     * point to the actual beginning of the block pool memory.  If
320     * anv_block_pool_alloc_back has ever been called, then this pointer
321     * will point to the "center" position of the buffer and all offsets
322     * (negative or positive) given out by the block pool alloc functions
323     * will be valid relative to this pointer.
324     *
325     * In particular, map == bo.map + center_offset
326     */
327    void *map;
328    int fd;
329
330    /**
331     * Array of mmaps and gem handles owned by the block pool, reclaimed when
332     * the block pool is destroyed.
333     */
334    struct u_vector mmap_cleanups;
335
336    uint32_t block_size;
337
338    union anv_free_list free_list;
339    struct anv_block_state state;
340
341    union anv_free_list back_free_list;
342    struct anv_block_state back_state;
343 };
344
345 /* Block pools are backed by a fixed-size 2GB memfd */
346 #define BLOCK_POOL_MEMFD_SIZE (1ull << 32)
347
348 /* The center of the block pool is also the middle of the memfd.  This may
349  * change in the future if we decide differently for some reason.
350  */
351 #define BLOCK_POOL_MEMFD_CENTER (BLOCK_POOL_MEMFD_SIZE / 2)
352
353 static inline uint32_t
354 anv_block_pool_size(struct anv_block_pool *pool)
355 {
356    return pool->state.end + pool->back_state.end;
357 }
358
359 struct anv_state {
360    int32_t offset;
361    uint32_t alloc_size;
362    void *map;
363 };
364
365 struct anv_fixed_size_state_pool {
366    size_t state_size;
367    union anv_free_list free_list;
368    struct anv_block_state block;
369 };
370
371 #define ANV_MIN_STATE_SIZE_LOG2 6
372 #define ANV_MAX_STATE_SIZE_LOG2 17
373
374 #define ANV_STATE_BUCKETS (ANV_MAX_STATE_SIZE_LOG2 - ANV_MIN_STATE_SIZE_LOG2 + 1)
375
376 struct anv_state_pool {
377    struct anv_block_pool *block_pool;
378    struct anv_fixed_size_state_pool buckets[ANV_STATE_BUCKETS];
379 };
380
381 struct anv_state_stream_block;
382
383 struct anv_state_stream {
384    struct anv_block_pool *block_pool;
385
386    /* The current working block */
387    struct anv_state_stream_block *block;
388
389    /* Offset at which the current block starts */
390    uint32_t start;
391    /* Offset at which to allocate the next state */
392    uint32_t next;
393    /* Offset at which the current block ends */
394    uint32_t end;
395 };
396
397 #define CACHELINE_SIZE 64
398 #define CACHELINE_MASK 63
399
400 static inline void
401 anv_clflush_range(void *start, size_t size)
402 {
403    void *p = (void *) (((uintptr_t) start) & ~CACHELINE_MASK);
404    void *end = start + size;
405
406    __builtin_ia32_mfence();
407    while (p < end) {
408       __builtin_ia32_clflush(p);
409       p += CACHELINE_SIZE;
410    }
411 }
412
413 static void inline
414 anv_state_clflush(struct anv_state state)
415 {
416    anv_clflush_range(state.map, state.alloc_size);
417 }
418
419 void anv_block_pool_init(struct anv_block_pool *pool,
420                          struct anv_device *device, uint32_t block_size);
421 void anv_block_pool_finish(struct anv_block_pool *pool);
422 int32_t anv_block_pool_alloc(struct anv_block_pool *pool);
423 int32_t anv_block_pool_alloc_back(struct anv_block_pool *pool);
424 void anv_block_pool_free(struct anv_block_pool *pool, int32_t offset);
425 void anv_state_pool_init(struct anv_state_pool *pool,
426                          struct anv_block_pool *block_pool);
427 void anv_state_pool_finish(struct anv_state_pool *pool);
428 struct anv_state anv_state_pool_alloc(struct anv_state_pool *pool,
429                                       size_t state_size, size_t alignment);
430 void anv_state_pool_free(struct anv_state_pool *pool, struct anv_state state);
431 void anv_state_stream_init(struct anv_state_stream *stream,
432                            struct anv_block_pool *block_pool);
433 void anv_state_stream_finish(struct anv_state_stream *stream);
434 struct anv_state anv_state_stream_alloc(struct anv_state_stream *stream,
435                                         uint32_t size, uint32_t alignment);
436
437 /**
438  * Implements a pool of re-usable BOs.  The interface is identical to that
439  * of block_pool except that each block is its own BO.
440  */
441 struct anv_bo_pool {
442    struct anv_device *device;
443
444    void *free_list[16];
445 };
446
447 void anv_bo_pool_init(struct anv_bo_pool *pool, struct anv_device *device);
448 void anv_bo_pool_finish(struct anv_bo_pool *pool);
449 VkResult anv_bo_pool_alloc(struct anv_bo_pool *pool, struct anv_bo *bo,
450                            uint32_t size);
451 void anv_bo_pool_free(struct anv_bo_pool *pool, const struct anv_bo *bo);
452
453 struct anv_scratch_bo {
454    bool exists;
455    struct anv_bo bo;
456 };
457
458 struct anv_scratch_pool {
459    /* Indexed by Per-Thread Scratch Space number (the hardware value) and stage */
460    struct anv_scratch_bo bos[16][MESA_SHADER_STAGES];
461 };
462
463 void anv_scratch_pool_init(struct anv_device *device,
464                            struct anv_scratch_pool *pool);
465 void anv_scratch_pool_finish(struct anv_device *device,
466                              struct anv_scratch_pool *pool);
467 struct anv_bo *anv_scratch_pool_alloc(struct anv_device *device,
468                                       struct anv_scratch_pool *pool,
469                                       gl_shader_stage stage,
470                                       unsigned per_thread_scratch);
471
472 extern struct anv_dispatch_table dtable;
473
474 #define VK_ICD_WSI_PLATFORM_MAX 5
475
476 struct anv_physical_device {
477     VK_LOADER_DATA                              _loader_data;
478
479     struct anv_instance *                       instance;
480     uint32_t                                    chipset_id;
481     char                                        path[20];
482     const char *                                name;
483     struct gen_device_info                      info;
484     uint64_t                                    aperture_size;
485     struct brw_compiler *                       compiler;
486     struct isl_device                           isl_dev;
487     int                                         cmd_parser_version;
488
489     uint32_t                                    eu_total;
490     uint32_t                                    subslice_total;
491
492     struct wsi_device                       wsi_device;
493 };
494
495 struct anv_instance {
496     VK_LOADER_DATA                              _loader_data;
497
498     VkAllocationCallbacks                       alloc;
499
500     uint32_t                                    apiVersion;
501     int                                         physicalDeviceCount;
502     struct anv_physical_device                  physicalDevice;
503 };
504
505 VkResult anv_init_wsi(struct anv_physical_device *physical_device);
506 void anv_finish_wsi(struct anv_physical_device *physical_device);
507
508 struct anv_queue {
509     VK_LOADER_DATA                              _loader_data;
510
511     struct anv_device *                         device;
512
513     struct anv_state_pool *                     pool;
514 };
515
516 struct anv_pipeline_cache {
517    struct anv_device *                          device;
518    pthread_mutex_t                              mutex;
519
520    struct hash_table *                          cache;
521 };
522
523 struct anv_pipeline_bind_map;
524
525 void anv_pipeline_cache_init(struct anv_pipeline_cache *cache,
526                              struct anv_device *device,
527                              bool cache_enabled);
528 void anv_pipeline_cache_finish(struct anv_pipeline_cache *cache);
529
530 struct anv_shader_bin *
531 anv_pipeline_cache_search(struct anv_pipeline_cache *cache,
532                           const void *key, uint32_t key_size);
533 struct anv_shader_bin *
534 anv_pipeline_cache_upload_kernel(struct anv_pipeline_cache *cache,
535                                  const void *key_data, uint32_t key_size,
536                                  const void *kernel_data, uint32_t kernel_size,
537                                  const struct brw_stage_prog_data *prog_data,
538                                  uint32_t prog_data_size,
539                                  const struct anv_pipeline_bind_map *bind_map);
540
541 struct anv_device {
542     VK_LOADER_DATA                              _loader_data;
543
544     VkAllocationCallbacks                       alloc;
545
546     struct anv_instance *                       instance;
547     uint32_t                                    chipset_id;
548     struct gen_device_info                      info;
549     struct isl_device                           isl_dev;
550     int                                         context_id;
551     int                                         fd;
552     bool                                        can_chain_batches;
553     bool                                        robust_buffer_access;
554
555     struct anv_bo_pool                          batch_bo_pool;
556
557     struct anv_block_pool                       dynamic_state_block_pool;
558     struct anv_state_pool                       dynamic_state_pool;
559
560     struct anv_block_pool                       instruction_block_pool;
561     struct anv_state_pool                       instruction_state_pool;
562
563     struct anv_block_pool                       surface_state_block_pool;
564     struct anv_state_pool                       surface_state_pool;
565
566     struct anv_bo                               workaround_bo;
567
568     struct anv_pipeline_cache                   blorp_shader_cache;
569     struct blorp_context                        blorp;
570
571     struct anv_state                            border_colors;
572
573     struct anv_queue                            queue;
574
575     struct anv_scratch_pool                     scratch_pool;
576
577     uint32_t                                    default_mocs;
578
579     pthread_mutex_t                             mutex;
580 };
581
582 void anv_device_get_cache_uuid(void *uuid);
583
584 void anv_device_init_blorp(struct anv_device *device);
585 void anv_device_finish_blorp(struct anv_device *device);
586
587 VkResult anv_device_execbuf(struct anv_device *device,
588                             struct drm_i915_gem_execbuffer2 *execbuf,
589                             struct anv_bo **execbuf_bos);
590
591 void* anv_gem_mmap(struct anv_device *device,
592                    uint32_t gem_handle, uint64_t offset, uint64_t size, uint32_t flags);
593 void anv_gem_munmap(void *p, uint64_t size);
594 uint32_t anv_gem_create(struct anv_device *device, size_t size);
595 void anv_gem_close(struct anv_device *device, uint32_t gem_handle);
596 uint32_t anv_gem_userptr(struct anv_device *device, void *mem, size_t size);
597 int anv_gem_wait(struct anv_device *device, uint32_t gem_handle, int64_t *timeout_ns);
598 int anv_gem_execbuffer(struct anv_device *device,
599                        struct drm_i915_gem_execbuffer2 *execbuf);
600 int anv_gem_set_tiling(struct anv_device *device, uint32_t gem_handle,
601                        uint32_t stride, uint32_t tiling);
602 int anv_gem_create_context(struct anv_device *device);
603 int anv_gem_destroy_context(struct anv_device *device, int context);
604 int anv_gem_get_param(int fd, uint32_t param);
605 bool anv_gem_get_bit6_swizzle(int fd, uint32_t tiling);
606 int anv_gem_get_aperture(int fd, uint64_t *size);
607 int anv_gem_handle_to_fd(struct anv_device *device, uint32_t gem_handle);
608 uint32_t anv_gem_fd_to_handle(struct anv_device *device, int fd);
609 int anv_gem_set_caching(struct anv_device *device, uint32_t gem_handle, uint32_t caching);
610 int anv_gem_set_domain(struct anv_device *device, uint32_t gem_handle,
611                        uint32_t read_domains, uint32_t write_domain);
612
613 VkResult anv_bo_init_new(struct anv_bo *bo, struct anv_device *device, uint64_t size);
614
615 struct anv_reloc_list {
616    size_t                                       num_relocs;
617    size_t                                       array_length;
618    struct drm_i915_gem_relocation_entry *       relocs;
619    struct anv_bo **                             reloc_bos;
620 };
621
622 VkResult anv_reloc_list_init(struct anv_reloc_list *list,
623                              const VkAllocationCallbacks *alloc);
624 void anv_reloc_list_finish(struct anv_reloc_list *list,
625                            const VkAllocationCallbacks *alloc);
626
627 uint64_t anv_reloc_list_add(struct anv_reloc_list *list,
628                             const VkAllocationCallbacks *alloc,
629                             uint32_t offset, struct anv_bo *target_bo,
630                             uint32_t delta);
631
632 struct anv_batch_bo {
633    /* Link in the anv_cmd_buffer.owned_batch_bos list */
634    struct list_head                             link;
635
636    struct anv_bo                                bo;
637
638    /* Bytes actually consumed in this batch BO */
639    size_t                                       length;
640
641    struct anv_reloc_list                        relocs;
642 };
643
644 struct anv_batch {
645    const VkAllocationCallbacks *                alloc;
646
647    void *                                       start;
648    void *                                       end;
649    void *                                       next;
650
651    struct anv_reloc_list *                      relocs;
652
653    /* This callback is called (with the associated user data) in the event
654     * that the batch runs out of space.
655     */
656    VkResult (*extend_cb)(struct anv_batch *, void *);
657    void *                                       user_data;
658 };
659
660 void *anv_batch_emit_dwords(struct anv_batch *batch, int num_dwords);
661 void anv_batch_emit_batch(struct anv_batch *batch, struct anv_batch *other);
662 uint64_t anv_batch_emit_reloc(struct anv_batch *batch,
663                               void *location, struct anv_bo *bo, uint32_t offset);
664 VkResult anv_device_submit_simple_batch(struct anv_device *device,
665                                         struct anv_batch *batch);
666
667 struct anv_address {
668    struct anv_bo *bo;
669    uint32_t offset;
670 };
671
672 static inline uint64_t
673 _anv_combine_address(struct anv_batch *batch, void *location,
674                      const struct anv_address address, uint32_t delta)
675 {
676    if (address.bo == NULL) {
677       return address.offset + delta;
678    } else {
679       assert(batch->start <= location && location < batch->end);
680
681       return anv_batch_emit_reloc(batch, location, address.bo, address.offset + delta);
682    }
683 }
684
685 #define __gen_address_type struct anv_address
686 #define __gen_user_data struct anv_batch
687 #define __gen_combine_address _anv_combine_address
688
689 /* Wrapper macros needed to work around preprocessor argument issues.  In
690  * particular, arguments don't get pre-evaluated if they are concatenated.
691  * This means that, if you pass GENX(3DSTATE_PS) into the emit macro, the
692  * GENX macro won't get evaluated if the emit macro contains "cmd ## foo".
693  * We can work around this easily enough with these helpers.
694  */
695 #define __anv_cmd_length(cmd) cmd ## _length
696 #define __anv_cmd_length_bias(cmd) cmd ## _length_bias
697 #define __anv_cmd_header(cmd) cmd ## _header
698 #define __anv_cmd_pack(cmd) cmd ## _pack
699 #define __anv_reg_num(reg) reg ## _num
700
701 #define anv_pack_struct(dst, struc, ...) do {                              \
702       struct struc __template = {                                          \
703          __VA_ARGS__                                                       \
704       };                                                                   \
705       __anv_cmd_pack(struc)(NULL, dst, &__template);                       \
706       VG(VALGRIND_CHECK_MEM_IS_DEFINED(dst, __anv_cmd_length(struc) * 4)); \
707    } while (0)
708
709 #define anv_batch_emitn(batch, n, cmd, ...) ({          \
710       void *__dst = anv_batch_emit_dwords(batch, n);    \
711       struct cmd __template = {                         \
712          __anv_cmd_header(cmd),                         \
713         .DWordLength = n - __anv_cmd_length_bias(cmd),  \
714          __VA_ARGS__                                    \
715       };                                                \
716       __anv_cmd_pack(cmd)(batch, __dst, &__template);   \
717       __dst;                                            \
718    })
719
720 #define anv_batch_emit_merge(batch, dwords0, dwords1)                   \
721    do {                                                                 \
722       uint32_t *dw;                                                     \
723                                                                         \
724       static_assert(ARRAY_SIZE(dwords0) == ARRAY_SIZE(dwords1), "mismatch merge"); \
725       dw = anv_batch_emit_dwords((batch), ARRAY_SIZE(dwords0));         \
726       for (uint32_t i = 0; i < ARRAY_SIZE(dwords0); i++)                \
727          dw[i] = (dwords0)[i] | (dwords1)[i];                           \
728       VG(VALGRIND_CHECK_MEM_IS_DEFINED(dw, ARRAY_SIZE(dwords0) * 4));\
729    } while (0)
730
731 #define anv_batch_emit(batch, cmd, name)                            \
732    for (struct cmd name = { __anv_cmd_header(cmd) },                    \
733         *_dst = anv_batch_emit_dwords(batch, __anv_cmd_length(cmd));    \
734         __builtin_expect(_dst != NULL, 1);                              \
735         ({ __anv_cmd_pack(cmd)(batch, _dst, &name);                     \
736            VG(VALGRIND_CHECK_MEM_IS_DEFINED(_dst, __anv_cmd_length(cmd) * 4)); \
737            _dst = NULL;                                                 \
738          }))
739
740 #define anv_state_pool_emit(pool, cmd, align, ...) ({                   \
741       const uint32_t __size = __anv_cmd_length(cmd) * 4;                \
742       struct anv_state __state =                                        \
743          anv_state_pool_alloc((pool), __size, align);                   \
744       struct cmd __template = {                                         \
745          __VA_ARGS__                                                    \
746       };                                                                \
747       __anv_cmd_pack(cmd)(NULL, __state.map, &__template);              \
748       VG(VALGRIND_CHECK_MEM_IS_DEFINED(__state.map, __anv_cmd_length(cmd) * 4)); \
749       if (!(pool)->block_pool->device->info.has_llc)                    \
750          anv_state_clflush(__state);                                    \
751       __state;                                                          \
752    })
753
754 #define GEN7_MOCS (struct GEN7_MEMORY_OBJECT_CONTROL_STATE) {  \
755    .GraphicsDataTypeGFDT                        = 0,           \
756    .LLCCacheabilityControlLLCCC                 = 0,           \
757    .L3CacheabilityControlL3CC                   = 1,           \
758 }
759
760 #define GEN75_MOCS (struct GEN75_MEMORY_OBJECT_CONTROL_STATE) {  \
761    .LLCeLLCCacheabilityControlLLCCC             = 0,           \
762    .L3CacheabilityControlL3CC                   = 1,           \
763 }
764
765 #define GEN8_MOCS (struct GEN8_MEMORY_OBJECT_CONTROL_STATE) {  \
766       .MemoryTypeLLCeLLCCacheabilityControl = WB,              \
767       .TargetCache = L3DefertoPATforLLCeLLCselection,          \
768       .AgeforQUADLRU = 0                                       \
769    }
770
771 /* Skylake: MOCS is now an index into an array of 62 different caching
772  * configurations programmed by the kernel.
773  */
774
775 #define GEN9_MOCS (struct GEN9_MEMORY_OBJECT_CONTROL_STATE) {  \
776       /* TC=LLC/eLLC, LeCC=WB, LRUM=3, L3CC=WB */              \
777       .IndextoMOCSTables                           = 2         \
778    }
779
780 #define GEN9_MOCS_PTE {                                 \
781       /* TC=LLC/eLLC, LeCC=WB, LRUM=3, L3CC=WB */       \
782       .IndextoMOCSTables                           = 1  \
783    }
784
785 struct anv_device_memory {
786    struct anv_bo                                bo;
787    uint32_t                                     type_index;
788    VkDeviceSize                                 map_size;
789    void *                                       map;
790 };
791
792 /**
793  * Header for Vertex URB Entry (VUE)
794  */
795 struct anv_vue_header {
796    uint32_t Reserved;
797    uint32_t RTAIndex; /* RenderTargetArrayIndex */
798    uint32_t ViewportIndex;
799    float PointWidth;
800 };
801
802 struct anv_descriptor_set_binding_layout {
803 #ifndef NDEBUG
804    /* The type of the descriptors in this binding */
805    VkDescriptorType type;
806 #endif
807
808    /* Number of array elements in this binding */
809    uint16_t array_size;
810
811    /* Index into the flattend descriptor set */
812    uint16_t descriptor_index;
813
814    /* Index into the dynamic state array for a dynamic buffer */
815    int16_t dynamic_offset_index;
816
817    /* Index into the descriptor set buffer views */
818    int16_t buffer_index;
819
820    struct {
821       /* Index into the binding table for the associated surface */
822       int16_t surface_index;
823
824       /* Index into the sampler table for the associated sampler */
825       int16_t sampler_index;
826
827       /* Index into the image table for the associated image */
828       int16_t image_index;
829    } stage[MESA_SHADER_STAGES];
830
831    /* Immutable samplers (or NULL if no immutable samplers) */
832    struct anv_sampler **immutable_samplers;
833 };
834
835 struct anv_descriptor_set_layout {
836    /* Number of bindings in this descriptor set */
837    uint16_t binding_count;
838
839    /* Total size of the descriptor set with room for all array entries */
840    uint16_t size;
841
842    /* Shader stages affected by this descriptor set */
843    uint16_t shader_stages;
844
845    /* Number of buffers in this descriptor set */
846    uint16_t buffer_count;
847
848    /* Number of dynamic offsets used by this descriptor set */
849    uint16_t dynamic_offset_count;
850
851    /* Bindings in this descriptor set */
852    struct anv_descriptor_set_binding_layout binding[0];
853 };
854
855 struct anv_descriptor {
856    VkDescriptorType type;
857
858    union {
859       struct {
860          struct anv_image_view *image_view;
861          struct anv_sampler *sampler;
862       };
863
864       struct anv_buffer_view *buffer_view;
865    };
866 };
867
868 struct anv_descriptor_set {
869    const struct anv_descriptor_set_layout *layout;
870    uint32_t size;
871    uint32_t buffer_count;
872    struct anv_buffer_view *buffer_views;
873    struct anv_descriptor descriptors[0];
874 };
875
876 struct anv_descriptor_pool {
877    uint32_t size;
878    uint32_t next;
879    uint32_t free_list;
880
881    struct anv_state_stream surface_state_stream;
882    void *surface_state_free_list;
883
884    char data[0];
885 };
886
887 VkResult
888 anv_descriptor_set_create(struct anv_device *device,
889                           struct anv_descriptor_pool *pool,
890                           const struct anv_descriptor_set_layout *layout,
891                           struct anv_descriptor_set **out_set);
892
893 void
894 anv_descriptor_set_destroy(struct anv_device *device,
895                            struct anv_descriptor_pool *pool,
896                            struct anv_descriptor_set *set);
897
898 #define ANV_DESCRIPTOR_SET_COLOR_ATTACHMENTS UINT8_MAX
899
900 struct anv_pipeline_binding {
901    /* The descriptor set this surface corresponds to.  The special value of
902     * ANV_DESCRIPTOR_SET_COLOR_ATTACHMENTS indicates that the offset refers
903     * to a color attachment and not a regular descriptor.
904     */
905    uint8_t set;
906
907    /* Binding in the descriptor set */
908    uint8_t binding;
909
910    /* Index in the binding */
911    uint8_t index;
912 };
913
914 struct anv_pipeline_layout {
915    struct {
916       struct anv_descriptor_set_layout *layout;
917       uint32_t dynamic_offset_start;
918    } set[MAX_SETS];
919
920    uint32_t num_sets;
921
922    struct {
923       bool has_dynamic_offsets;
924    } stage[MESA_SHADER_STAGES];
925
926    unsigned char sha1[20];
927 };
928
929 struct anv_buffer {
930    struct anv_device *                          device;
931    VkDeviceSize                                 size;
932
933    VkBufferUsageFlags                           usage;
934
935    /* Set when bound */
936    struct anv_bo *                              bo;
937    VkDeviceSize                                 offset;
938 };
939
940 enum anv_cmd_dirty_bits {
941    ANV_CMD_DIRTY_DYNAMIC_VIEWPORT                  = 1 << 0, /* VK_DYNAMIC_STATE_VIEWPORT */
942    ANV_CMD_DIRTY_DYNAMIC_SCISSOR                   = 1 << 1, /* VK_DYNAMIC_STATE_SCISSOR */
943    ANV_CMD_DIRTY_DYNAMIC_LINE_WIDTH                = 1 << 2, /* VK_DYNAMIC_STATE_LINE_WIDTH */
944    ANV_CMD_DIRTY_DYNAMIC_DEPTH_BIAS                = 1 << 3, /* VK_DYNAMIC_STATE_DEPTH_BIAS */
945    ANV_CMD_DIRTY_DYNAMIC_BLEND_CONSTANTS           = 1 << 4, /* VK_DYNAMIC_STATE_BLEND_CONSTANTS */
946    ANV_CMD_DIRTY_DYNAMIC_DEPTH_BOUNDS              = 1 << 5, /* VK_DYNAMIC_STATE_DEPTH_BOUNDS */
947    ANV_CMD_DIRTY_DYNAMIC_STENCIL_COMPARE_MASK      = 1 << 6, /* VK_DYNAMIC_STATE_STENCIL_COMPARE_MASK */
948    ANV_CMD_DIRTY_DYNAMIC_STENCIL_WRITE_MASK        = 1 << 7, /* VK_DYNAMIC_STATE_STENCIL_WRITE_MASK */
949    ANV_CMD_DIRTY_DYNAMIC_STENCIL_REFERENCE         = 1 << 8, /* VK_DYNAMIC_STATE_STENCIL_REFERENCE */
950    ANV_CMD_DIRTY_DYNAMIC_ALL                       = (1 << 9) - 1,
951    ANV_CMD_DIRTY_PIPELINE                          = 1 << 9,
952    ANV_CMD_DIRTY_INDEX_BUFFER                      = 1 << 10,
953    ANV_CMD_DIRTY_RENDER_TARGETS                    = 1 << 11,
954 };
955 typedef uint32_t anv_cmd_dirty_mask_t;
956
957 enum anv_pipe_bits {
958    ANV_PIPE_DEPTH_CACHE_FLUSH_BIT            = (1 << 0),
959    ANV_PIPE_STALL_AT_SCOREBOARD_BIT          = (1 << 1),
960    ANV_PIPE_STATE_CACHE_INVALIDATE_BIT       = (1 << 2),
961    ANV_PIPE_CONSTANT_CACHE_INVALIDATE_BIT    = (1 << 3),
962    ANV_PIPE_VF_CACHE_INVALIDATE_BIT          = (1 << 4),
963    ANV_PIPE_DATA_CACHE_FLUSH_BIT             = (1 << 5),
964    ANV_PIPE_TEXTURE_CACHE_INVALIDATE_BIT     = (1 << 10),
965    ANV_PIPE_INSTRUCTION_CACHE_INVALIDATE_BIT = (1 << 11),
966    ANV_PIPE_RENDER_TARGET_CACHE_FLUSH_BIT    = (1 << 12),
967    ANV_PIPE_DEPTH_STALL_BIT                  = (1 << 13),
968    ANV_PIPE_CS_STALL_BIT                     = (1 << 20),
969
970    /* This bit does not exist directly in PIPE_CONTROL.  Instead it means that
971     * a flush has happened but not a CS stall.  The next time we do any sort
972     * of invalidation we need to insert a CS stall at that time.  Otherwise,
973     * we would have to CS stall on every flush which could be bad.
974     */
975    ANV_PIPE_NEEDS_CS_STALL_BIT               = (1 << 21),
976 };
977
978 #define ANV_PIPE_FLUSH_BITS ( \
979    ANV_PIPE_DEPTH_CACHE_FLUSH_BIT | \
980    ANV_PIPE_DATA_CACHE_FLUSH_BIT | \
981    ANV_PIPE_RENDER_TARGET_CACHE_FLUSH_BIT)
982
983 #define ANV_PIPE_STALL_BITS ( \
984    ANV_PIPE_STALL_AT_SCOREBOARD_BIT | \
985    ANV_PIPE_DEPTH_STALL_BIT | \
986    ANV_PIPE_CS_STALL_BIT)
987
988 #define ANV_PIPE_INVALIDATE_BITS ( \
989    ANV_PIPE_STATE_CACHE_INVALIDATE_BIT | \
990    ANV_PIPE_CONSTANT_CACHE_INVALIDATE_BIT | \
991    ANV_PIPE_VF_CACHE_INVALIDATE_BIT | \
992    ANV_PIPE_DATA_CACHE_FLUSH_BIT | \
993    ANV_PIPE_TEXTURE_CACHE_INVALIDATE_BIT | \
994    ANV_PIPE_INSTRUCTION_CACHE_INVALIDATE_BIT)
995
996 struct anv_vertex_binding {
997    struct anv_buffer *                          buffer;
998    VkDeviceSize                                 offset;
999 };
1000
1001 struct anv_push_constants {
1002    /* Current allocated size of this push constants data structure.
1003     * Because a decent chunk of it may not be used (images on SKL, for
1004     * instance), we won't actually allocate the entire structure up-front.
1005     */
1006    uint32_t size;
1007
1008    /* Push constant data provided by the client through vkPushConstants */
1009    uint8_t client_data[MAX_PUSH_CONSTANTS_SIZE];
1010
1011    /* Our hardware only provides zero-based vertex and instance id so, in
1012     * order to satisfy the vulkan requirements, we may have to push one or
1013     * both of these into the shader.
1014     */
1015    uint32_t base_vertex;
1016    uint32_t base_instance;
1017
1018    /* Offsets and ranges for dynamically bound buffers */
1019    struct {
1020       uint32_t offset;
1021       uint32_t range;
1022    } dynamic[MAX_DYNAMIC_BUFFERS];
1023
1024    /* Image data for image_load_store on pre-SKL */
1025    struct brw_image_param images[MAX_IMAGES];
1026 };
1027
1028 struct anv_dynamic_state {
1029    struct {
1030       uint32_t                                  count;
1031       VkViewport                                viewports[MAX_VIEWPORTS];
1032    } viewport;
1033
1034    struct {
1035       uint32_t                                  count;
1036       VkRect2D                                  scissors[MAX_SCISSORS];
1037    } scissor;
1038
1039    float                                        line_width;
1040
1041    struct {
1042       float                                     bias;
1043       float                                     clamp;
1044       float                                     slope;
1045    } depth_bias;
1046
1047    float                                        blend_constants[4];
1048
1049    struct {
1050       float                                     min;
1051       float                                     max;
1052    } depth_bounds;
1053
1054    struct {
1055       uint32_t                                  front;
1056       uint32_t                                  back;
1057    } stencil_compare_mask;
1058
1059    struct {
1060       uint32_t                                  front;
1061       uint32_t                                  back;
1062    } stencil_write_mask;
1063
1064    struct {
1065       uint32_t                                  front;
1066       uint32_t                                  back;
1067    } stencil_reference;
1068 };
1069
1070 extern const struct anv_dynamic_state default_dynamic_state;
1071
1072 void anv_dynamic_state_copy(struct anv_dynamic_state *dest,
1073                             const struct anv_dynamic_state *src,
1074                             uint32_t copy_mask);
1075
1076 /**
1077  * Attachment state when recording a renderpass instance.
1078  *
1079  * The clear value is valid only if there exists a pending clear.
1080  */
1081 struct anv_attachment_state {
1082    VkImageAspectFlags                           pending_clear_aspects;
1083    VkClearValue                                 clear_value;
1084 };
1085
1086 /** State required while building cmd buffer */
1087 struct anv_cmd_state {
1088    /* PIPELINE_SELECT.PipelineSelection */
1089    uint32_t                                     current_pipeline;
1090    const struct gen_l3_config *                 current_l3_config;
1091    uint32_t                                     vb_dirty;
1092    anv_cmd_dirty_mask_t                         dirty;
1093    anv_cmd_dirty_mask_t                         compute_dirty;
1094    enum anv_pipe_bits                           pending_pipe_bits;
1095    uint32_t                                     num_workgroups_offset;
1096    struct anv_bo                                *num_workgroups_bo;
1097    VkShaderStageFlags                           descriptors_dirty;
1098    VkShaderStageFlags                           push_constants_dirty;
1099    uint32_t                                     scratch_size;
1100    struct anv_pipeline *                        pipeline;
1101    struct anv_pipeline *                        compute_pipeline;
1102    struct anv_framebuffer *                     framebuffer;
1103    struct anv_render_pass *                     pass;
1104    struct anv_subpass *                         subpass;
1105    VkRect2D                                     render_area;
1106    uint32_t                                     restart_index;
1107    struct anv_vertex_binding                    vertex_bindings[MAX_VBS];
1108    struct anv_descriptor_set *                  descriptors[MAX_SETS];
1109    VkShaderStageFlags                           push_constant_stages;
1110    struct anv_push_constants *                  push_constants[MESA_SHADER_STAGES];
1111    struct anv_state                             binding_tables[MESA_SHADER_STAGES];
1112    struct anv_state                             samplers[MESA_SHADER_STAGES];
1113    struct anv_dynamic_state                     dynamic;
1114    bool                                         need_query_wa;
1115
1116    /**
1117     * Array length is anv_cmd_state::pass::attachment_count. Array content is
1118     * valid only when recording a render pass instance.
1119     */
1120    struct anv_attachment_state *                attachments;
1121
1122    struct {
1123       struct anv_buffer *                       index_buffer;
1124       uint32_t                                  index_type; /**< 3DSTATE_INDEX_BUFFER.IndexFormat */
1125       uint32_t                                  index_offset;
1126    } gen7;
1127 };
1128
1129 struct anv_cmd_pool {
1130    VkAllocationCallbacks                        alloc;
1131    struct list_head                             cmd_buffers;
1132 };
1133
1134 #define ANV_CMD_BUFFER_BATCH_SIZE 8192
1135
1136 enum anv_cmd_buffer_exec_mode {
1137    ANV_CMD_BUFFER_EXEC_MODE_PRIMARY,
1138    ANV_CMD_BUFFER_EXEC_MODE_EMIT,
1139    ANV_CMD_BUFFER_EXEC_MODE_GROW_AND_EMIT,
1140    ANV_CMD_BUFFER_EXEC_MODE_CHAIN,
1141    ANV_CMD_BUFFER_EXEC_MODE_COPY_AND_CHAIN,
1142 };
1143
1144 struct anv_execbuf {
1145    struct drm_i915_gem_execbuffer2           execbuf;
1146
1147    struct drm_i915_gem_exec_object2 *        objects;
1148    uint32_t                                  bo_count;
1149    struct anv_bo **                          bos;
1150
1151    /* Allocated length of the 'objects' and 'bos' arrays */
1152    uint32_t                                  array_length;
1153 };
1154
1155 struct anv_cmd_buffer {
1156    VK_LOADER_DATA                               _loader_data;
1157
1158    struct anv_device *                          device;
1159
1160    struct anv_cmd_pool *                        pool;
1161    struct list_head                             pool_link;
1162
1163    struct anv_batch                             batch;
1164
1165    /* Fields required for the actual chain of anv_batch_bo's.
1166     *
1167     * These fields are initialized by anv_cmd_buffer_init_batch_bo_chain().
1168     */
1169    struct list_head                             batch_bos;
1170    enum anv_cmd_buffer_exec_mode                exec_mode;
1171
1172    /* A vector of anv_batch_bo pointers for every batch or surface buffer
1173     * referenced by this command buffer
1174     *
1175     * initialized by anv_cmd_buffer_init_batch_bo_chain()
1176     */
1177    struct u_vector                            seen_bbos;
1178
1179    /* A vector of int32_t's for every block of binding tables.
1180     *
1181     * initialized by anv_cmd_buffer_init_batch_bo_chain()
1182     */
1183    struct u_vector                            bt_blocks;
1184    uint32_t                                     bt_next;
1185
1186    struct anv_reloc_list                        surface_relocs;
1187    /** Last seen surface state block pool center bo offset */
1188    uint32_t                                     last_ss_pool_center;
1189
1190    struct anv_execbuf                           execbuf2;
1191
1192    /* Serial for tracking buffer completion */
1193    uint32_t                                     serial;
1194
1195    /* Stream objects for storing temporary data */
1196    struct anv_state_stream                      surface_state_stream;
1197    struct anv_state_stream                      dynamic_state_stream;
1198
1199    VkCommandBufferUsageFlags                    usage_flags;
1200    VkCommandBufferLevel                         level;
1201
1202    struct anv_cmd_state                         state;
1203 };
1204
1205 VkResult anv_cmd_buffer_init_batch_bo_chain(struct anv_cmd_buffer *cmd_buffer);
1206 void anv_cmd_buffer_fini_batch_bo_chain(struct anv_cmd_buffer *cmd_buffer);
1207 void anv_cmd_buffer_reset_batch_bo_chain(struct anv_cmd_buffer *cmd_buffer);
1208 void anv_cmd_buffer_end_batch_buffer(struct anv_cmd_buffer *cmd_buffer);
1209 void anv_cmd_buffer_add_secondary(struct anv_cmd_buffer *primary,
1210                                   struct anv_cmd_buffer *secondary);
1211 void anv_cmd_buffer_prepare_execbuf(struct anv_cmd_buffer *cmd_buffer);
1212 VkResult anv_cmd_buffer_execbuf(struct anv_device *device,
1213                                 struct anv_cmd_buffer *cmd_buffer);
1214
1215 VkResult anv_cmd_buffer_reset(struct anv_cmd_buffer *cmd_buffer);
1216
1217 VkResult
1218 anv_cmd_buffer_ensure_push_constants_size(struct anv_cmd_buffer *cmd_buffer,
1219                                           gl_shader_stage stage, uint32_t size);
1220 #define anv_cmd_buffer_ensure_push_constant_field(cmd_buffer, stage, field) \
1221    anv_cmd_buffer_ensure_push_constants_size(cmd_buffer, stage, \
1222       (offsetof(struct anv_push_constants, field) + \
1223        sizeof(cmd_buffer->state.push_constants[0]->field)))
1224
1225 struct anv_state anv_cmd_buffer_emit_dynamic(struct anv_cmd_buffer *cmd_buffer,
1226                                              const void *data, uint32_t size, uint32_t alignment);
1227 struct anv_state anv_cmd_buffer_merge_dynamic(struct anv_cmd_buffer *cmd_buffer,
1228                                               uint32_t *a, uint32_t *b,
1229                                               uint32_t dwords, uint32_t alignment);
1230
1231 struct anv_address
1232 anv_cmd_buffer_surface_base_address(struct anv_cmd_buffer *cmd_buffer);
1233 struct anv_state
1234 anv_cmd_buffer_alloc_binding_table(struct anv_cmd_buffer *cmd_buffer,
1235                                    uint32_t entries, uint32_t *state_offset);
1236 struct anv_state
1237 anv_cmd_buffer_alloc_surface_state(struct anv_cmd_buffer *cmd_buffer);
1238 struct anv_state
1239 anv_cmd_buffer_alloc_dynamic_state(struct anv_cmd_buffer *cmd_buffer,
1240                                    uint32_t size, uint32_t alignment);
1241
1242 VkResult
1243 anv_cmd_buffer_new_binding_table_block(struct anv_cmd_buffer *cmd_buffer);
1244
1245 void gen8_cmd_buffer_emit_viewport(struct anv_cmd_buffer *cmd_buffer);
1246 void gen8_cmd_buffer_emit_depth_viewport(struct anv_cmd_buffer *cmd_buffer,
1247                                          bool depth_clamp_enable);
1248 void gen7_cmd_buffer_emit_scissor(struct anv_cmd_buffer *cmd_buffer);
1249
1250 void anv_cmd_state_setup_attachments(struct anv_cmd_buffer *cmd_buffer,
1251                                      const VkRenderPassBeginInfo *info);
1252
1253 struct anv_state
1254 anv_cmd_buffer_push_constants(struct anv_cmd_buffer *cmd_buffer,
1255                               gl_shader_stage stage);
1256 struct anv_state
1257 anv_cmd_buffer_cs_push_constants(struct anv_cmd_buffer *cmd_buffer);
1258
1259 void anv_cmd_buffer_clear_subpass(struct anv_cmd_buffer *cmd_buffer);
1260 void anv_cmd_buffer_resolve_subpass(struct anv_cmd_buffer *cmd_buffer);
1261
1262 const struct anv_image_view *
1263 anv_cmd_buffer_get_depth_stencil_view(const struct anv_cmd_buffer *cmd_buffer);
1264
1265 void anv_cmd_buffer_dump(struct anv_cmd_buffer *cmd_buffer);
1266
1267 struct anv_fence {
1268    struct anv_bo bo;
1269    struct drm_i915_gem_execbuffer2 execbuf;
1270    struct drm_i915_gem_exec_object2 exec2_objects[1];
1271    bool ready;
1272 };
1273
1274 struct anv_event {
1275    uint64_t                                     semaphore;
1276    struct anv_state                             state;
1277 };
1278
1279 struct anv_shader_module {
1280    unsigned char                                sha1[20];
1281    uint32_t                                     size;
1282    char                                         data[0];
1283 };
1284
1285 void anv_hash_shader(unsigned char *hash, const void *key, size_t key_size,
1286                      struct anv_shader_module *module,
1287                      const char *entrypoint,
1288                      const struct anv_pipeline_layout *pipeline_layout,
1289                      const VkSpecializationInfo *spec_info);
1290
1291 static inline gl_shader_stage
1292 vk_to_mesa_shader_stage(VkShaderStageFlagBits vk_stage)
1293 {
1294    assert(__builtin_popcount(vk_stage) == 1);
1295    return ffs(vk_stage) - 1;
1296 }
1297
1298 static inline VkShaderStageFlagBits
1299 mesa_to_vk_shader_stage(gl_shader_stage mesa_stage)
1300 {
1301    return (1 << mesa_stage);
1302 }
1303
1304 #define ANV_STAGE_MASK ((1 << MESA_SHADER_STAGES) - 1)
1305
1306 #define anv_foreach_stage(stage, stage_bits)                         \
1307    for (gl_shader_stage stage,                                       \
1308         __tmp = (gl_shader_stage)((stage_bits) & ANV_STAGE_MASK);    \
1309         stage = __builtin_ffs(__tmp) - 1, __tmp;                     \
1310         __tmp &= ~(1 << (stage)))
1311
1312 struct anv_pipeline_bind_map {
1313    uint32_t surface_count;
1314    uint32_t sampler_count;
1315    uint32_t image_count;
1316
1317    struct anv_pipeline_binding *                surface_to_descriptor;
1318    struct anv_pipeline_binding *                sampler_to_descriptor;
1319 };
1320
1321 struct anv_shader_bin_key {
1322    uint32_t size;
1323    uint8_t data[0];
1324 };
1325
1326 struct anv_shader_bin {
1327    uint32_t ref_cnt;
1328
1329    const struct anv_shader_bin_key *key;
1330
1331    struct anv_state kernel;
1332    uint32_t kernel_size;
1333
1334    const struct brw_stage_prog_data *prog_data;
1335    uint32_t prog_data_size;
1336
1337    struct anv_pipeline_bind_map bind_map;
1338
1339    /* Prog data follows, then params, then the key, all aligned to 8-bytes */
1340 };
1341
1342 struct anv_shader_bin *
1343 anv_shader_bin_create(struct anv_device *device,
1344                       const void *key, uint32_t key_size,
1345                       const void *kernel, uint32_t kernel_size,
1346                       const struct brw_stage_prog_data *prog_data,
1347                       uint32_t prog_data_size, const void *prog_data_param,
1348                       const struct anv_pipeline_bind_map *bind_map);
1349
1350 void
1351 anv_shader_bin_destroy(struct anv_device *device, struct anv_shader_bin *shader);
1352
1353 static inline void
1354 anv_shader_bin_ref(struct anv_shader_bin *shader)
1355 {
1356    assert(shader->ref_cnt >= 1);
1357    __sync_fetch_and_add(&shader->ref_cnt, 1);
1358 }
1359
1360 static inline void
1361 anv_shader_bin_unref(struct anv_device *device, struct anv_shader_bin *shader)
1362 {
1363    assert(shader->ref_cnt >= 1);
1364    if (__sync_fetch_and_add(&shader->ref_cnt, -1) == 1)
1365       anv_shader_bin_destroy(device, shader);
1366 }
1367
1368 struct anv_pipeline {
1369    struct anv_device *                          device;
1370    struct anv_batch                             batch;
1371    uint32_t                                     batch_data[512];
1372    struct anv_reloc_list                        batch_relocs;
1373    uint32_t                                     dynamic_state_mask;
1374    struct anv_dynamic_state                     dynamic_state;
1375
1376    struct anv_pipeline_layout *                 layout;
1377
1378    bool                                         needs_data_cache;
1379
1380    struct anv_shader_bin *                      shaders[MESA_SHADER_STAGES];
1381
1382    struct {
1383       const struct gen_l3_config *              l3_config;
1384       uint32_t                                  total_size;
1385    } urb;
1386
1387    VkShaderStageFlags                           active_stages;
1388    struct anv_state                             blend_state;
1389    uint32_t                                     vs_simd8;
1390    uint32_t                                     vs_vec4;
1391    uint32_t                                     ps_ksp0;
1392    uint32_t                                     gs_kernel;
1393    uint32_t                                     cs_simd;
1394
1395    uint32_t                                     vb_used;
1396    uint32_t                                     binding_stride[MAX_VBS];
1397    bool                                         instancing_enable[MAX_VBS];
1398    bool                                         primitive_restart;
1399    uint32_t                                     topology;
1400
1401    uint32_t                                     cs_right_mask;
1402
1403    bool                                         depth_clamp_enable;
1404
1405    struct {
1406       uint32_t                                  sf[7];
1407       uint32_t                                  depth_stencil_state[3];
1408    } gen7;
1409
1410    struct {
1411       uint32_t                                  sf[4];
1412       uint32_t                                  raster[5];
1413       uint32_t                                  wm_depth_stencil[3];
1414    } gen8;
1415
1416    struct {
1417       uint32_t                                  wm_depth_stencil[4];
1418    } gen9;
1419 };
1420
1421 static inline bool
1422 anv_pipeline_has_stage(const struct anv_pipeline *pipeline,
1423                        gl_shader_stage stage)
1424 {
1425    return (pipeline->active_stages & mesa_to_vk_shader_stage(stage)) != 0;
1426 }
1427
1428 #define ANV_DECL_GET_PROG_DATA_FUNC(prefix, stage)                   \
1429 static inline const struct brw_##prefix##_prog_data *                \
1430 get_##prefix##_prog_data(struct anv_pipeline *pipeline)              \
1431 {                                                                    \
1432    if (anv_pipeline_has_stage(pipeline, stage)) {                    \
1433       return (const struct brw_##prefix##_prog_data *)               \
1434              pipeline->shaders[stage]->prog_data;                    \
1435    } else {                                                          \
1436       return NULL;                                                   \
1437    }                                                                 \
1438 }
1439
1440 ANV_DECL_GET_PROG_DATA_FUNC(vs, MESA_SHADER_VERTEX)
1441 ANV_DECL_GET_PROG_DATA_FUNC(gs, MESA_SHADER_GEOMETRY)
1442 ANV_DECL_GET_PROG_DATA_FUNC(wm, MESA_SHADER_FRAGMENT)
1443 ANV_DECL_GET_PROG_DATA_FUNC(cs, MESA_SHADER_COMPUTE)
1444
1445 VkResult
1446 anv_pipeline_init(struct anv_pipeline *pipeline, struct anv_device *device,
1447                   struct anv_pipeline_cache *cache,
1448                   const VkGraphicsPipelineCreateInfo *pCreateInfo,
1449                   const VkAllocationCallbacks *alloc);
1450
1451 VkResult
1452 anv_pipeline_compile_cs(struct anv_pipeline *pipeline,
1453                         struct anv_pipeline_cache *cache,
1454                         const VkComputePipelineCreateInfo *info,
1455                         struct anv_shader_module *module,
1456                         const char *entrypoint,
1457                         const VkSpecializationInfo *spec_info);
1458
1459 struct anv_format {
1460    enum isl_format isl_format:16;
1461    struct isl_swizzle swizzle;
1462 };
1463
1464 struct anv_format
1465 anv_get_format(const struct gen_device_info *devinfo, VkFormat format,
1466                VkImageAspectFlags aspect, VkImageTiling tiling);
1467
1468 static inline enum isl_format
1469 anv_get_isl_format(const struct gen_device_info *devinfo, VkFormat vk_format,
1470                    VkImageAspectFlags aspect, VkImageTiling tiling)
1471 {
1472    return anv_get_format(devinfo, vk_format, aspect, tiling).isl_format;
1473 }
1474
1475 void
1476 anv_pipeline_setup_l3_config(struct anv_pipeline *pipeline, bool needs_slm);
1477
1478 /**
1479  * Subsurface of an anv_image.
1480  */
1481 struct anv_surface {
1482    /** Valid only if isl_surf::size > 0. */
1483    struct isl_surf isl;
1484
1485    /**
1486     * Offset from VkImage's base address, as bound by vkBindImageMemory().
1487     */
1488    uint32_t offset;
1489 };
1490
1491 struct anv_image {
1492    VkImageType type;
1493    /* The original VkFormat provided by the client.  This may not match any
1494     * of the actual surface formats.
1495     */
1496    VkFormat vk_format;
1497    VkImageAspectFlags aspects;
1498    VkExtent3D extent;
1499    uint32_t levels;
1500    uint32_t array_size;
1501    uint32_t samples; /**< VkImageCreateInfo::samples */
1502    VkImageUsageFlags usage; /**< Superset of VkImageCreateInfo::usage. */
1503    VkImageTiling tiling; /** VkImageCreateInfo::tiling */
1504
1505    VkDeviceSize size;
1506    uint32_t alignment;
1507
1508    /* Set when bound */
1509    struct anv_bo *bo;
1510    VkDeviceSize offset;
1511
1512    /**
1513     * Image subsurfaces
1514     *
1515     * For each foo, anv_image::foo_surface is valid if and only if
1516     * anv_image::aspects has a foo aspect.
1517     *
1518     * The hardware requires that the depth buffer and stencil buffer be
1519     * separate surfaces.  From Vulkan's perspective, though, depth and stencil
1520     * reside in the same VkImage.  To satisfy both the hardware and Vulkan, we
1521     * allocate the depth and stencil buffers as separate surfaces in the same
1522     * bo.
1523     */
1524    union {
1525       struct anv_surface color_surface;
1526
1527       struct {
1528          struct anv_surface depth_surface;
1529          struct anv_surface hiz_surface;
1530          struct anv_surface stencil_surface;
1531       };
1532    };
1533 };
1534
1535 static inline uint32_t
1536 anv_get_layerCount(const struct anv_image *image,
1537                    const VkImageSubresourceRange *range)
1538 {
1539    return range->layerCount == VK_REMAINING_ARRAY_LAYERS ?
1540           image->array_size - range->baseArrayLayer : range->layerCount;
1541 }
1542
1543 static inline uint32_t
1544 anv_get_levelCount(const struct anv_image *image,
1545                    const VkImageSubresourceRange *range)
1546 {
1547    return range->levelCount == VK_REMAINING_MIP_LEVELS ?
1548           image->levels - range->baseMipLevel : range->levelCount;
1549 }
1550
1551
1552 struct anv_image_view {
1553    const struct anv_image *image; /**< VkImageViewCreateInfo::image */
1554    struct anv_bo *bo;
1555    uint32_t offset; /**< Offset into bo. */
1556
1557    struct isl_view isl;
1558
1559    VkImageAspectFlags aspect_mask;
1560    VkFormat vk_format;
1561    VkExtent3D extent; /**< Extent of VkImageViewCreateInfo::baseMipLevel. */
1562
1563    /** RENDER_SURFACE_STATE when using image as a color render target. */
1564    struct anv_state color_rt_surface_state;
1565
1566    /** RENDER_SURFACE_STATE when using image as a sampler surface. */
1567    struct anv_state sampler_surface_state;
1568
1569    /** RENDER_SURFACE_STATE when using image as a storage image. */
1570    struct anv_state storage_surface_state;
1571
1572    struct brw_image_param storage_image_param;
1573 };
1574
1575 struct anv_image_create_info {
1576    const VkImageCreateInfo *vk_info;
1577
1578    /** An opt-in bitmask which filters an ISL-mapping of the Vulkan tiling. */
1579    isl_tiling_flags_t isl_tiling_flags;
1580
1581    uint32_t stride;
1582 };
1583
1584 VkResult anv_image_create(VkDevice _device,
1585                           const struct anv_image_create_info *info,
1586                           const VkAllocationCallbacks* alloc,
1587                           VkImage *pImage);
1588
1589 const struct anv_surface *
1590 anv_image_get_surface_for_aspect_mask(const struct anv_image *image,
1591                                       VkImageAspectFlags aspect_mask);
1592
1593 static inline bool
1594 anv_image_has_hiz(const struct anv_image *image)
1595 {
1596    /* We must check the aspect because anv_image::hiz_surface belongs to
1597     * a union.
1598     */
1599    return (image->aspects & VK_IMAGE_ASPECT_DEPTH_BIT) &&
1600           image->hiz_surface.isl.size > 0;
1601 }
1602
1603 struct anv_buffer_view {
1604    enum isl_format format; /**< VkBufferViewCreateInfo::format */
1605    struct anv_bo *bo;
1606    uint32_t offset; /**< Offset into bo. */
1607    uint64_t range; /**< VkBufferViewCreateInfo::range */
1608
1609    struct anv_state surface_state;
1610    struct anv_state storage_surface_state;
1611
1612    struct brw_image_param storage_image_param;
1613 };
1614
1615 enum isl_format
1616 anv_isl_format_for_descriptor_type(VkDescriptorType type);
1617
1618 static inline struct VkExtent3D
1619 anv_sanitize_image_extent(const VkImageType imageType,
1620                           const struct VkExtent3D imageExtent)
1621 {
1622    switch (imageType) {
1623    case VK_IMAGE_TYPE_1D:
1624       return (VkExtent3D) { imageExtent.width, 1, 1 };
1625    case VK_IMAGE_TYPE_2D:
1626       return (VkExtent3D) { imageExtent.width, imageExtent.height, 1 };
1627    case VK_IMAGE_TYPE_3D:
1628       return imageExtent;
1629    default:
1630       unreachable("invalid image type");
1631    }
1632 }
1633
1634 static inline struct VkOffset3D
1635 anv_sanitize_image_offset(const VkImageType imageType,
1636                           const struct VkOffset3D imageOffset)
1637 {
1638    switch (imageType) {
1639    case VK_IMAGE_TYPE_1D:
1640       return (VkOffset3D) { imageOffset.x, 0, 0 };
1641    case VK_IMAGE_TYPE_2D:
1642       return (VkOffset3D) { imageOffset.x, imageOffset.y, 0 };
1643    case VK_IMAGE_TYPE_3D:
1644       return imageOffset;
1645    default:
1646       unreachable("invalid image type");
1647    }
1648 }
1649
1650
1651 void anv_fill_buffer_surface_state(struct anv_device *device,
1652                                    struct anv_state state,
1653                                    enum isl_format format,
1654                                    uint32_t offset, uint32_t range,
1655                                    uint32_t stride);
1656
1657 void anv_image_view_fill_image_param(struct anv_device *device,
1658                                      struct anv_image_view *view,
1659                                      struct brw_image_param *param);
1660 void anv_buffer_view_fill_image_param(struct anv_device *device,
1661                                       struct anv_buffer_view *view,
1662                                       struct brw_image_param *param);
1663
1664 struct anv_sampler {
1665    uint32_t state[4];
1666 };
1667
1668 struct anv_framebuffer {
1669    uint32_t                                     width;
1670    uint32_t                                     height;
1671    uint32_t                                     layers;
1672
1673    uint32_t                                     attachment_count;
1674    struct anv_image_view *                      attachments[0];
1675 };
1676
1677 struct anv_subpass {
1678    uint32_t                                     input_count;
1679    uint32_t *                                   input_attachments;
1680    uint32_t                                     color_count;
1681    uint32_t *                                   color_attachments;
1682    uint32_t *                                   resolve_attachments;
1683    uint32_t                                     depth_stencil_attachment;
1684
1685    /** Subpass has at least one resolve attachment */
1686    bool                                         has_resolve;
1687 };
1688
1689 struct anv_render_pass_attachment {
1690    VkFormat                                     format;
1691    uint32_t                                     samples;
1692    VkAttachmentLoadOp                           load_op;
1693    VkAttachmentStoreOp                          store_op;
1694    VkAttachmentLoadOp                           stencil_load_op;
1695 };
1696
1697 struct anv_render_pass {
1698    uint32_t                                     attachment_count;
1699    uint32_t                                     subpass_count;
1700    uint32_t *                                   subpass_attachments;
1701    struct anv_render_pass_attachment *          attachments;
1702    struct anv_subpass                           subpasses[0];
1703 };
1704
1705 struct anv_query_pool_slot {
1706    uint64_t begin;
1707    uint64_t end;
1708    uint64_t available;
1709 };
1710
1711 struct anv_query_pool {
1712    VkQueryType                                  type;
1713    uint32_t                                     slots;
1714    struct anv_bo                                bo;
1715 };
1716
1717 void *anv_lookup_entrypoint(const struct gen_device_info *devinfo,
1718                             const char *name);
1719
1720 void anv_dump_image_to_ppm(struct anv_device *device,
1721                            struct anv_image *image, unsigned miplevel,
1722                            unsigned array_layer, VkImageAspectFlagBits aspect,
1723                            const char *filename);
1724
1725 enum anv_dump_action {
1726    ANV_DUMP_FRAMEBUFFERS_BIT = 0x1,
1727 };
1728
1729 void anv_dump_start(struct anv_device *device, enum anv_dump_action actions);
1730 void anv_dump_finish(void);
1731
1732 void anv_dump_add_framebuffer(struct anv_cmd_buffer *cmd_buffer,
1733                               struct anv_framebuffer *fb);
1734
1735 #define ANV_DEFINE_HANDLE_CASTS(__anv_type, __VkType)                      \
1736                                                                            \
1737    static inline struct __anv_type *                                       \
1738    __anv_type ## _from_handle(__VkType _handle)                            \
1739    {                                                                       \
1740       return (struct __anv_type *) _handle;                                \
1741    }                                                                       \
1742                                                                            \
1743    static inline __VkType                                                  \
1744    __anv_type ## _to_handle(struct __anv_type *_obj)                       \
1745    {                                                                       \
1746       return (__VkType) _obj;                                              \
1747    }
1748
1749 #define ANV_DEFINE_NONDISP_HANDLE_CASTS(__anv_type, __VkType)              \
1750                                                                            \
1751    static inline struct __anv_type *                                       \
1752    __anv_type ## _from_handle(__VkType _handle)                            \
1753    {                                                                       \
1754       return (struct __anv_type *)(uintptr_t) _handle;                     \
1755    }                                                                       \
1756                                                                            \
1757    static inline __VkType                                                  \
1758    __anv_type ## _to_handle(struct __anv_type *_obj)                       \
1759    {                                                                       \
1760       return (__VkType)(uintptr_t) _obj;                                   \
1761    }
1762
1763 #define ANV_FROM_HANDLE(__anv_type, __name, __handle) \
1764    struct __anv_type *__name = __anv_type ## _from_handle(__handle)
1765
1766 ANV_DEFINE_HANDLE_CASTS(anv_cmd_buffer, VkCommandBuffer)
1767 ANV_DEFINE_HANDLE_CASTS(anv_device, VkDevice)
1768 ANV_DEFINE_HANDLE_CASTS(anv_instance, VkInstance)
1769 ANV_DEFINE_HANDLE_CASTS(anv_physical_device, VkPhysicalDevice)
1770 ANV_DEFINE_HANDLE_CASTS(anv_queue, VkQueue)
1771
1772 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_cmd_pool, VkCommandPool)
1773 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_buffer, VkBuffer)
1774 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_buffer_view, VkBufferView)
1775 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_pool, VkDescriptorPool)
1776 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_set, VkDescriptorSet)
1777 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_descriptor_set_layout, VkDescriptorSetLayout)
1778 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_device_memory, VkDeviceMemory)
1779 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_fence, VkFence)
1780 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_event, VkEvent)
1781 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_framebuffer, VkFramebuffer)
1782 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_image, VkImage)
1783 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_image_view, VkImageView);
1784 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_pipeline_cache, VkPipelineCache)
1785 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_pipeline, VkPipeline)
1786 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_pipeline_layout, VkPipelineLayout)
1787 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_query_pool, VkQueryPool)
1788 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_render_pass, VkRenderPass)
1789 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_sampler, VkSampler)
1790 ANV_DEFINE_NONDISP_HANDLE_CASTS(anv_shader_module, VkShaderModule)
1791
1792 #define ANV_DEFINE_STRUCT_CASTS(__anv_type, __VkType) \
1793    \
1794    static inline const __VkType * \
1795    __anv_type ## _to_ ## __VkType(const struct __anv_type *__anv_obj) \
1796    { \
1797       return (const __VkType *) __anv_obj; \
1798    }
1799
1800 #define ANV_COMMON_TO_STRUCT(__VkType, __vk_name, __common_name) \
1801    const __VkType *__vk_name = anv_common_to_ ## __VkType(__common_name)
1802
1803 ANV_DEFINE_STRUCT_CASTS(anv_common, VkMemoryBarrier)
1804 ANV_DEFINE_STRUCT_CASTS(anv_common, VkBufferMemoryBarrier)
1805 ANV_DEFINE_STRUCT_CASTS(anv_common, VkImageMemoryBarrier)
1806
1807 /* Gen-specific function declarations */
1808 #ifdef genX
1809 #  include "anv_genX.h"
1810 #else
1811 #  define genX(x) gen7_##x
1812 #  include "anv_genX.h"
1813 #  undef genX
1814 #  define genX(x) gen75_##x
1815 #  include "anv_genX.h"
1816 #  undef genX
1817 #  define genX(x) gen8_##x
1818 #  include "anv_genX.h"
1819 #  undef genX
1820 #  define genX(x) gen9_##x
1821 #  include "anv_genX.h"
1822 #  undef genX
1823 #endif
1824
1825 #ifdef __cplusplus
1826 }
1827 #endif
1828
1829 #endif /* ANV_PRIVATE_H */