iris: add iris_flush_and_dirty_for_history
[mesa.git] / src / gallium / drivers / iris / iris_resource.h
1 /*
2 * Copyright 2017 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 * on the rights to use, copy, modify, merge, publish, distribute, sub
8 * license, and/or sell copies of the Software, and to permit persons to whom
9 * the 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 NON-INFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHOR(S) AND/OR THEIR SUPPLIERS BE LIABLE FOR ANY CLAIM,
19 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
20 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
21 * USE OR OTHER DEALINGS IN THE SOFTWARE.
22 */
23 #ifndef IRIS_RESOURCE_H
24 #define IRIS_RESOURCE_H
25
26 #include "pipe/p_state.h"
27 #include "util/u_inlines.h"
28 #include "intel/isl/isl.h"
29
30 struct iris_context;
31
32 struct iris_format_info {
33 enum isl_format fmt;
34 struct isl_swizzle swizzle;
35 };
36
37 #define IRIS_RESOURCE_FLAG_SHADER_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 0)
38 #define IRIS_RESOURCE_FLAG_SURFACE_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 1)
39 #define IRIS_RESOURCE_FLAG_DYNAMIC_MEMZONE (PIPE_RESOURCE_FLAG_DRV_PRIV << 2)
40
41 /**
42 * Resources represent a GPU buffer object or image (mipmap tree).
43 *
44 * They contain the storage (BO) and layout information (ISL surface).
45 */
46 struct iris_resource {
47 struct pipe_resource base;
48 enum pipe_format internal_format;
49 struct isl_surf surf;
50 struct iris_bo *bo;
51
52 /**
53 * A bitfield of PIPE_BIND_* indicating how this resource was bound
54 * in the past. Only meaningful for PIPE_BUFFER; used for flushing.
55 */
56 unsigned bind_history;
57 };
58
59 /**
60 * A simple <resource, offset> tuple for storing a reference to a
61 * piece of state stored in a GPU buffer object.
62 */
63 struct iris_state_ref {
64 struct pipe_resource *res;
65 uint32_t offset;
66 };
67
68 /**
69 * Gallium CSO for sampler views (texture views).
70 *
71 * In addition to the normal pipe_resource, this adds an ISL view
72 * which may reinterpret the format or restrict levels/layers.
73 *
74 * These can also be linear texture buffers.
75 */
76 struct iris_sampler_view {
77 struct pipe_sampler_view base;
78 struct isl_view view;
79
80 /* A short-cut (not a reference) to the actual resource being viewed.
81 * Multi-planar (or depth+stencil) images may have multiple resources
82 * chained together; this skips having to traverse base->texture->*.
83 */
84 struct iris_resource *res;
85
86 /** The resource (BO) holding our SURFACE_STATE. */
87 struct iris_state_ref surface_state;
88 };
89
90 /**
91 * Gallium CSO for surfaces (framebuffer attachments).
92 *
93 * A view of a surface that can be bound to a color render target or
94 * depth/stencil attachment.
95 */
96 struct iris_surface {
97 struct pipe_surface base;
98 struct isl_view view;
99
100 /** The resource (BO) holding our SURFACE_STATE. */
101 struct iris_state_ref surface_state;
102 };
103
104 /**
105 * Transfer object - information about a buffer mapping.
106 */
107 struct iris_transfer {
108 struct pipe_transfer base;
109 struct pipe_debug_callback *dbg;
110 void *buffer;
111 void *ptr;
112
113 void (*unmap)(struct iris_transfer *);
114 };
115
116 /**
117 * Unwrap a pipe_resource to get the underlying iris_bo (for convenience).
118 */
119 static inline struct iris_bo *
120 iris_resource_bo(struct pipe_resource *p_res)
121 {
122 struct iris_resource *res = (void *) p_res;
123 return res->bo;
124 }
125
126 struct iris_format_info iris_format_for_usage(const struct gen_device_info *,
127 enum pipe_format pf,
128 isl_surf_usage_flags_t usage);
129
130 struct pipe_resource *iris_resource_get_separate_stencil(struct pipe_resource *);
131
132 void iris_get_depth_stencil_resources(struct pipe_resource *res,
133 struct iris_resource **out_z,
134 struct iris_resource **out_s);
135
136 void iris_init_screen_resource_functions(struct pipe_screen *pscreen);
137
138 void iris_flush_and_dirty_for_history(struct iris_context *ice,
139 struct iris_resource *res);
140
141 #endif