2 * Copyright (C) 2016 Rob Clark <robclark@freedesktop.org>
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:
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
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 FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
24 * Rob Clark <robclark@freedesktop.org>
27 #ifndef FREEDRENO_BATCH_H_
28 #define FREEDRENO_BATCH_H_
30 #include "util/u_inlines.h"
31 #include "util/u_queue.h"
32 #include "util/list.h"
34 #include "freedreno_util.h"
37 # define BATCH_DEBUG (fd_mesa_debug & FD_DBG_MSGS)
39 # define BATCH_DEBUG 0
44 enum fd_resource_status
;
46 /* Bitmask of stages in rendering that a particular query query is
47 * active. Queries will be automatically started/stopped (generating
48 * additional fd_hw_sample_period's) on entrance/exit from stages that
49 * are applicable to the query.
51 * NOTE: set the stage to NULL at end of IB to ensure no query is still
52 * active. Things aren't going to work out the way you want if a query
53 * is active across IB's (or between tile IB and draw IB)
55 enum fd_render_stage
{
58 FD_STAGE_CLEAR
= 0x02,
59 /* used for driver internal draws (ie. util_blitter_blit()): */
64 #define MAX_HW_SAMPLE_PROVIDERS 7
65 struct fd_hw_sample_provider
;
68 /* A batch tracks everything about a cmdstream batch/submit, including the
69 * ringbuffers used for binning, draw, and gmem cmds, list of associated
73 struct pipe_reference reference
;
75 unsigned idx
; /* index into cache->batches[] */
78 bool needs_out_fence_fd
;
79 struct pipe_fence_handle
*fence
;
81 struct fd_context
*ctx
;
83 /* do we need to mem2gmem before rendering. We don't, if for example,
84 * there was a glClear() that invalidated the entire previous buffer
85 * contents. Keep track of which buffer(s) are cleared, or needs
86 * restore. Masks of PIPE_CLEAR_*
88 * The 'cleared' bits will be set for buffers which are *entirely*
89 * cleared, and 'partial_cleared' bits will be set if you must
90 * check cleared_scissor.
92 * The 'invalidated' bits are set for cleared buffers, and buffers
93 * where the contents are undefined, ie. what we don't need to restore
97 /* align bitmask values w/ PIPE_CLEAR_*.. since that is convenient.. */
98 FD_BUFFER_COLOR
= PIPE_CLEAR_COLOR
,
99 FD_BUFFER_DEPTH
= PIPE_CLEAR_DEPTH
,
100 FD_BUFFER_STENCIL
= PIPE_CLEAR_STENCIL
,
101 FD_BUFFER_ALL
= FD_BUFFER_COLOR
| FD_BUFFER_DEPTH
| FD_BUFFER_STENCIL
,
102 } invalidated
, cleared
, fast_cleared
, restore
, resolve
;
104 /* is this a non-draw batch (ie compute/blit which has no pfb state)? */
106 bool needs_flush
: 1;
109 bool back_blit
: 1; /* only blit so far is resource shadowing back-blit */
110 bool tessellation
: 1; /* tessellation used in batch */
112 /* Keep track if WAIT_FOR_IDLE is needed for registers we need
117 /* To decide whether to render to system memory, keep track of the
118 * number of draws, and whether any of them require multisample,
119 * depth_test (or depth write), stencil_test, blending, and
120 * color_logic_Op (since those functions are disabled when by-
124 FD_GMEM_CLEARS_DEPTH_STENCIL
= 0x01,
125 FD_GMEM_DEPTH_ENABLED
= 0x02,
126 FD_GMEM_STENCIL_ENABLED
= 0x04,
128 FD_GMEM_BLEND_ENABLED
= 0x10,
129 FD_GMEM_LOGICOP_ENABLED
= 0x20,
130 FD_GMEM_FB_READ
= 0x40,
133 /* At submit time, once we've decided that this batch will use GMEM
134 * rendering, the appropriate gmem state is looked up:
136 const struct fd_gmem_stateobj
*gmem_state
;
138 unsigned num_draws
; /* number of draws in current batch */
139 unsigned num_vertices
; /* number of vertices in current batch */
141 /* Currently only used on a6xx, to calculate vsc prim/draw stream
144 unsigned num_bins_per_pipe
;
145 unsigned prim_strm_bits
;
146 unsigned draw_strm_bits
;
148 /* Track the maximal bounds of the scissor of all the draws within a
149 * batch. Used at the tile rendering step (fd_gmem_render_tiles(),
150 * mem2gmem/gmem2mem) to avoid needlessly moving data in/out of gmem.
152 struct pipe_scissor_state max_scissor
;
154 /* Keep track of DRAW initiators that need to be patched up depending
155 * on whether we using binning or not:
157 struct util_dynarray draw_patches
;
159 /* texture state that needs patching for fb_read: */
160 struct util_dynarray fb_read_patches
;
162 /* Keep track of writes to RB_RENDER_CONTROL which need to be patched
163 * once we know whether or not to use GMEM, and GMEM tile pitch.
165 * (only for a3xx.. but having gen specific subclasses of fd_batch
166 * seemed overkill for now)
168 struct util_dynarray rbrc_patches
;
170 /* Keep track of GMEM related values that need to be patched up once we
171 * know the gmem layout:
173 struct util_dynarray gmem_patches
;
175 /* Keep track of pointer to start of MEM exports for a20x binning shaders
177 * this is so the end of the shader can be cut off at the right point
178 * depending on the GMEM configuration
180 struct util_dynarray shader_patches
;
182 struct pipe_framebuffer_state framebuffer
;
184 struct fd_submit
*submit
;
186 /** draw pass cmdstream: */
187 struct fd_ringbuffer
*draw
;
188 /** binning pass cmdstream: */
189 struct fd_ringbuffer
*binning
;
190 /** tiling/gmem (IB0) cmdstream: */
191 struct fd_ringbuffer
*gmem
;
193 /** epilogue cmdstream: */
194 struct fd_ringbuffer
*epilogue
;
196 // TODO maybe more generically split out clear and clear_binning rings?
197 struct fd_ringbuffer
*lrz_clear
;
198 struct fd_ringbuffer
*tile_setup
;
199 struct fd_ringbuffer
*tile_fini
;
201 union pipe_color_union clear_color
[MAX_RENDER_TARGETS
];
203 unsigned clear_stencil
;
206 * hw query related state:
209 /* next sample offset.. incremented for each sample in the batch/
210 * submit, reset to zero on next submit.
212 uint32_t next_sample_offset
;
214 /* cached samples (in case multiple queries need to reference
215 * the same sample snapshot)
217 struct fd_hw_sample
*sample_cache
[MAX_HW_SAMPLE_PROVIDERS
];
219 /* which sample providers were active in the current batch: */
220 uint32_t active_providers
;
222 /* tracking for current stage, to know when to start/stop
223 * any active queries:
225 enum fd_render_stage stage
;
227 /* list of samples in current batch: */
228 struct util_dynarray samples
;
230 /* current query result bo and tile stride: */
231 struct pipe_resource
*query_buf
;
232 uint32_t query_tile_stride
;
236 /* Set of resources used by currently-unsubmitted batch (read or
237 * write).. does not hold a reference to the resource.
239 struct set
*resources
;
241 /** key in batch-cache (if not null): */
245 /** set of dependent batches.. holds refs to dependent batches: */
246 uint32_t dependents_mask
;
248 /* Buffer for tessellation engine input
250 struct fd_bo
*tessfactor_bo
;
251 uint32_t tessfactor_size
;
253 /* Buffer for passing parameters between TCS and TES
255 struct fd_bo
*tessparam_bo
;
256 uint32_t tessparam_size
;
258 struct fd_ringbuffer
*tess_addrs_constobj
;
260 struct list_head log_chunks
; /* list of unflushed log chunks in fifo order */
263 struct fd_batch
* fd_batch_create(struct fd_context
*ctx
, bool nondraw
);
265 void fd_batch_reset(struct fd_batch
*batch
);
266 void fd_batch_flush(struct fd_batch
*batch
);
267 void fd_batch_add_dep(struct fd_batch
*batch
, struct fd_batch
*dep
);
268 void fd_batch_resource_write(struct fd_batch
*batch
, struct fd_resource
*rsc
);
269 void fd_batch_resource_read_slowpath(struct fd_batch
*batch
, struct fd_resource
*rsc
);
270 void fd_batch_check_size(struct fd_batch
*batch
);
272 /* not called directly: */
273 void __fd_batch_describe(char* buf
, const struct fd_batch
*batch
);
274 void __fd_batch_destroy(struct fd_batch
*batch
);
277 * NOTE the rule is, you need to hold the screen->lock when destroying
278 * a batch.. so either use fd_batch_reference() (which grabs the lock
279 * for you) if you don't hold the lock, or fd_batch_reference_locked()
280 * if you do hold the lock.
282 * WARNING the _locked() version can briefly drop the lock. Without
283 * recursive mutexes, I'm not sure there is much else we can do (since
284 * __fd_batch_destroy() needs to unref resources)
286 * WARNING you must acquire the screen->lock and use the _locked()
287 * version in case that the batch being ref'd can disappear under
291 /* fwd-decl prototypes to untangle header dependency :-/ */
292 static inline void fd_context_assert_locked(struct fd_context
*ctx
);
293 static inline void fd_context_lock(struct fd_context
*ctx
);
294 static inline void fd_context_unlock(struct fd_context
*ctx
);
297 fd_batch_reference_locked(struct fd_batch
**ptr
, struct fd_batch
*batch
)
299 struct fd_batch
*old_batch
= *ptr
;
301 /* only need lock if a reference is dropped: */
303 fd_context_assert_locked(old_batch
->ctx
);
305 if (pipe_reference_described(&(*ptr
)->reference
, &batch
->reference
,
306 (debug_reference_descriptor
)__fd_batch_describe
))
307 __fd_batch_destroy(old_batch
);
313 fd_batch_reference(struct fd_batch
**ptr
, struct fd_batch
*batch
)
315 struct fd_batch
*old_batch
= *ptr
;
316 struct fd_context
*ctx
= old_batch
? old_batch
->ctx
: NULL
;
319 fd_context_lock(ctx
);
321 fd_batch_reference_locked(ptr
, batch
);
324 fd_context_unlock(ctx
);
327 #include "freedreno_context.h"
330 fd_reset_wfi(struct fd_batch
*batch
)
332 batch
->needs_wfi
= true;
335 void fd_wfi(struct fd_batch
*batch
, struct fd_ringbuffer
*ring
);
337 /* emit a CP_EVENT_WRITE:
340 fd_event_write(struct fd_batch
*batch
, struct fd_ringbuffer
*ring
,
341 enum vgt_event_type evt
)
343 OUT_PKT3(ring
, CP_EVENT_WRITE
, 1);
348 static inline struct fd_ringbuffer
*
349 fd_batch_get_epilogue(struct fd_batch
*batch
)
351 if (batch
->epilogue
== NULL
)
352 batch
->epilogue
= fd_submit_new_ringbuffer(batch
->submit
, 0x1000, 0);
354 return batch
->epilogue
;
358 #endif /* FREEDRENO_BATCH_H_ */