2 * Copyright © 2013 Intel Corporation
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
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * Brad Volkin <bradley.d.volkin@intel.com>
31 * DOC: batch buffer command parser
34 * Certain OpenGL features (e.g. transform feedback, performance monitoring)
35 * require userspace code to submit batches containing commands such as
36 * MI_LOAD_REGISTER_IMM to access various registers. Unfortunately, some
37 * generations of the hardware will noop these commands in "unsecure" batches
38 * (which includes all userspace batches submitted via i915) even though the
39 * commands may be safe and represent the intended programming model of the
42 * The software command parser is similar in operation to the command parsing
43 * done in hardware for unsecure batches. However, the software parser allows
44 * some operations that would be noop'd by hardware, if the parser determines
45 * the operation is safe, and submits the batch as "secure" to prevent hardware
49 * At a high level, the hardware (and software) checks attempt to prevent
50 * granting userspace undue privileges. There are three categories of privilege.
52 * First, commands which are explicitly defined as privileged or which should
53 * only be used by the kernel driver. The parser generally rejects such
54 * commands, though it may allow some from the drm master process.
56 * Second, commands which access registers. To support correct/enhanced
57 * userspace functionality, particularly certain OpenGL extensions, the parser
58 * provides a whitelist of registers which userspace may safely access (for both
59 * normal and drm master processes).
61 * Third, commands which access privileged memory (i.e. GGTT, HWS page, etc).
62 * The parser always rejects such commands.
64 * The majority of the problematic commands fall in the MI_* range, with only a
65 * few specific commands on each ring (e.g. PIPE_CONTROL and MI_FLUSH_DW).
68 * Each ring maintains tables of commands and registers which the parser uses in
69 * scanning batch buffers submitted to that ring.
71 * Since the set of commands that the parser must check for is significantly
72 * smaller than the number of commands supported, the parser tables contain only
73 * those commands required by the parser. This generally works because command
74 * opcode ranges have standard command length encodings. So for commands that
75 * the parser does not need to check, it can easily skip them. This is
76 * implemented via a per-ring length decoding vfunc.
78 * Unfortunately, there are a number of commands that do not follow the standard
79 * length encoding for their opcode range, primarily amongst the MI_* commands.
80 * To handle this, the parser provides a way to define explicit "skip" entries
81 * in the per-ring command tables.
83 * Other command table entries map fairly directly to high level categories
84 * mentioned above: rejected, master-only, register whitelist. The parser
85 * implements a number of checks, including the privileged memory checks, via a
86 * general bitmasking mechanism.
89 #define STD_MI_OPCODE_MASK 0xFF800000
90 #define STD_3D_OPCODE_MASK 0xFFFF0000
91 #define STD_2D_OPCODE_MASK 0xFFC00000
92 #define STD_MFX_OPCODE_MASK 0xFFFF0000
94 #define CMD(op, opm, f, lm, fl, ...) \
96 .flags = (fl) | ((f) ? CMD_DESC_FIXED : 0), \
97 .cmd = { (op), (opm) }, \
102 /* Convenience macros to compress the tables */
103 #define SMI STD_MI_OPCODE_MASK
104 #define S3D STD_3D_OPCODE_MASK
105 #define S2D STD_2D_OPCODE_MASK
106 #define SMFX STD_MFX_OPCODE_MASK
108 #define S CMD_DESC_SKIP
109 #define R CMD_DESC_REJECT
110 #define W CMD_DESC_REGISTER
111 #define B CMD_DESC_BITMASK
112 #define M CMD_DESC_MASTER
114 /* Command Mask Fixed Len Action
115 ---------------------------------------------------------- */
116 static const struct drm_i915_cmd_descriptor common_cmds
[] = {
117 CMD( MI_NOOP
, SMI
, F
, 1, S
),
118 CMD( MI_USER_INTERRUPT
, SMI
, F
, 1, R
),
119 CMD( MI_WAIT_FOR_EVENT
, SMI
, F
, 1, M
),
120 CMD( MI_ARB_CHECK
, SMI
, F
, 1, S
),
121 CMD( MI_REPORT_HEAD
, SMI
, F
, 1, S
),
122 CMD( MI_SUSPEND_FLUSH
, SMI
, F
, 1, S
),
123 CMD( MI_SEMAPHORE_MBOX
, SMI
, !F
, 0xFF, R
),
124 CMD( MI_STORE_DWORD_INDEX
, SMI
, !F
, 0xFF, R
),
125 CMD( MI_LOAD_REGISTER_IMM(1), SMI
, !F
, 0xFF, W
,
126 .reg
= { .offset
= 1, .mask
= 0x007FFFFC } ),
127 CMD( MI_STORE_REGISTER_MEM(1), SMI
, !F
, 0xFF, W
| B
,
128 .reg
= { .offset
= 1, .mask
= 0x007FFFFC },
131 .mask
= MI_GLOBAL_GTT
,
134 CMD( MI_LOAD_REGISTER_MEM
, SMI
, !F
, 0xFF, W
| B
,
135 .reg
= { .offset
= 1, .mask
= 0x007FFFFC },
138 .mask
= MI_GLOBAL_GTT
,
142 * MI_BATCH_BUFFER_START requires some special handling. It's not
143 * really a 'skip' action but it doesn't seem like it's worth adding
144 * a new action. See i915_parse_cmds().
146 CMD( MI_BATCH_BUFFER_START
, SMI
, !F
, 0xFF, S
),
149 static const struct drm_i915_cmd_descriptor render_cmds
[] = {
150 CMD( MI_FLUSH
, SMI
, F
, 1, S
),
151 CMD( MI_ARB_ON_OFF
, SMI
, F
, 1, R
),
152 CMD( MI_PREDICATE
, SMI
, F
, 1, S
),
153 CMD( MI_TOPOLOGY_FILTER
, SMI
, F
, 1, S
),
154 CMD( MI_DISPLAY_FLIP
, SMI
, !F
, 0xFF, R
),
155 CMD( MI_SET_CONTEXT
, SMI
, !F
, 0xFF, R
),
156 CMD( MI_URB_CLEAR
, SMI
, !F
, 0xFF, S
),
157 CMD( MI_STORE_DWORD_IMM
, SMI
, !F
, 0x3F, B
,
160 .mask
= MI_GLOBAL_GTT
,
163 CMD( MI_UPDATE_GTT
, SMI
, !F
, 0xFF, R
),
164 CMD( MI_CLFLUSH
, SMI
, !F
, 0x3FF, B
,
167 .mask
= MI_GLOBAL_GTT
,
170 CMD( MI_REPORT_PERF_COUNT
, SMI
, !F
, 0x3F, B
,
173 .mask
= MI_REPORT_PERF_COUNT_GGTT
,
176 CMD( MI_CONDITIONAL_BATCH_BUFFER_END
, SMI
, !F
, 0xFF, B
,
179 .mask
= MI_GLOBAL_GTT
,
182 CMD( GFX_OP_3DSTATE_VF_STATISTICS
, S3D
, F
, 1, S
),
183 CMD( PIPELINE_SELECT
, S3D
, F
, 1, S
),
184 CMD( MEDIA_VFE_STATE
, S3D
, !F
, 0xFFFF, B
,
187 .mask
= MEDIA_VFE_STATE_MMIO_ACCESS_MASK
,
190 CMD( GPGPU_OBJECT
, S3D
, !F
, 0xFF, S
),
191 CMD( GPGPU_WALKER
, S3D
, !F
, 0xFF, S
),
192 CMD( GFX_OP_3DSTATE_SO_DECL_LIST
, S3D
, !F
, 0x1FF, S
),
193 CMD( GFX_OP_PIPE_CONTROL(5), S3D
, !F
, 0xFF, B
,
196 .mask
= (PIPE_CONTROL_MMIO_WRITE
| PIPE_CONTROL_NOTIFY
),
201 .mask
= (PIPE_CONTROL_GLOBAL_GTT_IVB
|
202 PIPE_CONTROL_STORE_DATA_INDEX
),
204 .condition_offset
= 1,
205 .condition_mask
= PIPE_CONTROL_POST_SYNC_OP_MASK
,
209 static const struct drm_i915_cmd_descriptor hsw_render_cmds
[] = {
210 CMD( MI_SET_PREDICATE
, SMI
, F
, 1, S
),
211 CMD( MI_RS_CONTROL
, SMI
, F
, 1, S
),
212 CMD( MI_URB_ATOMIC_ALLOC
, SMI
, F
, 1, S
),
213 CMD( MI_RS_CONTEXT
, SMI
, F
, 1, S
),
214 CMD( MI_LOAD_SCAN_LINES_INCL
, SMI
, !F
, 0x3F, M
),
215 CMD( MI_LOAD_SCAN_LINES_EXCL
, SMI
, !F
, 0x3F, R
),
216 CMD( MI_LOAD_REGISTER_REG
, SMI
, !F
, 0xFF, R
),
217 CMD( MI_RS_STORE_DATA_IMM
, SMI
, !F
, 0xFF, S
),
218 CMD( MI_LOAD_URB_MEM
, SMI
, !F
, 0xFF, S
),
219 CMD( MI_STORE_URB_MEM
, SMI
, !F
, 0xFF, S
),
220 CMD( GFX_OP_3DSTATE_DX9_CONSTANTF_VS
, S3D
, !F
, 0x7FF, S
),
221 CMD( GFX_OP_3DSTATE_DX9_CONSTANTF_PS
, S3D
, !F
, 0x7FF, S
),
223 CMD( GFX_OP_3DSTATE_BINDING_TABLE_EDIT_VS
, S3D
, !F
, 0x1FF, S
),
224 CMD( GFX_OP_3DSTATE_BINDING_TABLE_EDIT_GS
, S3D
, !F
, 0x1FF, S
),
225 CMD( GFX_OP_3DSTATE_BINDING_TABLE_EDIT_HS
, S3D
, !F
, 0x1FF, S
),
226 CMD( GFX_OP_3DSTATE_BINDING_TABLE_EDIT_DS
, S3D
, !F
, 0x1FF, S
),
227 CMD( GFX_OP_3DSTATE_BINDING_TABLE_EDIT_PS
, S3D
, !F
, 0x1FF, S
),
230 static const struct drm_i915_cmd_descriptor video_cmds
[] = {
231 CMD( MI_ARB_ON_OFF
, SMI
, F
, 1, R
),
232 CMD( MI_STORE_DWORD_IMM
, SMI
, !F
, 0xFF, B
,
235 .mask
= MI_GLOBAL_GTT
,
238 CMD( MI_UPDATE_GTT
, SMI
, !F
, 0x3F, R
),
239 CMD( MI_FLUSH_DW
, SMI
, !F
, 0x3F, B
,
242 .mask
= MI_FLUSH_DW_NOTIFY
,
247 .mask
= MI_FLUSH_DW_USE_GTT
,
249 .condition_offset
= 0,
250 .condition_mask
= MI_FLUSH_DW_OP_MASK
,
254 .mask
= MI_FLUSH_DW_STORE_INDEX
,
256 .condition_offset
= 0,
257 .condition_mask
= MI_FLUSH_DW_OP_MASK
,
259 CMD( MI_CONDITIONAL_BATCH_BUFFER_END
, SMI
, !F
, 0xFF, B
,
262 .mask
= MI_GLOBAL_GTT
,
266 * MFX_WAIT doesn't fit the way we handle length for most commands.
267 * It has a length field but it uses a non-standard length bias.
268 * It is always 1 dword though, so just treat it as fixed length.
270 CMD( MFX_WAIT
, SMFX
, F
, 1, S
),
273 static const struct drm_i915_cmd_descriptor vecs_cmds
[] = {
274 CMD( MI_ARB_ON_OFF
, SMI
, F
, 1, R
),
275 CMD( MI_STORE_DWORD_IMM
, SMI
, !F
, 0xFF, B
,
278 .mask
= MI_GLOBAL_GTT
,
281 CMD( MI_UPDATE_GTT
, SMI
, !F
, 0x3F, R
),
282 CMD( MI_FLUSH_DW
, SMI
, !F
, 0x3F, B
,
285 .mask
= MI_FLUSH_DW_NOTIFY
,
290 .mask
= MI_FLUSH_DW_USE_GTT
,
292 .condition_offset
= 0,
293 .condition_mask
= MI_FLUSH_DW_OP_MASK
,
297 .mask
= MI_FLUSH_DW_STORE_INDEX
,
299 .condition_offset
= 0,
300 .condition_mask
= MI_FLUSH_DW_OP_MASK
,
302 CMD( MI_CONDITIONAL_BATCH_BUFFER_END
, SMI
, !F
, 0xFF, B
,
305 .mask
= MI_GLOBAL_GTT
,
310 static const struct drm_i915_cmd_descriptor blt_cmds
[] = {
311 CMD( MI_DISPLAY_FLIP
, SMI
, !F
, 0xFF, R
),
312 CMD( MI_STORE_DWORD_IMM
, SMI
, !F
, 0x3FF, B
,
315 .mask
= MI_GLOBAL_GTT
,
318 CMD( MI_UPDATE_GTT
, SMI
, !F
, 0x3F, R
),
319 CMD( MI_FLUSH_DW
, SMI
, !F
, 0x3F, B
,
322 .mask
= MI_FLUSH_DW_NOTIFY
,
327 .mask
= MI_FLUSH_DW_USE_GTT
,
329 .condition_offset
= 0,
330 .condition_mask
= MI_FLUSH_DW_OP_MASK
,
334 .mask
= MI_FLUSH_DW_STORE_INDEX
,
336 .condition_offset
= 0,
337 .condition_mask
= MI_FLUSH_DW_OP_MASK
,
339 CMD( COLOR_BLT
, S2D
, !F
, 0x3F, S
),
340 CMD( SRC_COPY_BLT
, S2D
, !F
, 0x3F, S
),
343 static const struct drm_i915_cmd_descriptor hsw_blt_cmds
[] = {
344 CMD( MI_LOAD_SCAN_LINES_INCL
, SMI
, !F
, 0x3F, M
),
345 CMD( MI_LOAD_SCAN_LINES_EXCL
, SMI
, !F
, 0x3F, R
),
360 static const struct drm_i915_cmd_table gen7_render_cmds
[] = {
361 { common_cmds
, ARRAY_SIZE(common_cmds
) },
362 { render_cmds
, ARRAY_SIZE(render_cmds
) },
365 static const struct drm_i915_cmd_table hsw_render_ring_cmds
[] = {
366 { common_cmds
, ARRAY_SIZE(common_cmds
) },
367 { render_cmds
, ARRAY_SIZE(render_cmds
) },
368 { hsw_render_cmds
, ARRAY_SIZE(hsw_render_cmds
) },
371 static const struct drm_i915_cmd_table gen7_video_cmds
[] = {
372 { common_cmds
, ARRAY_SIZE(common_cmds
) },
373 { video_cmds
, ARRAY_SIZE(video_cmds
) },
376 static const struct drm_i915_cmd_table hsw_vebox_cmds
[] = {
377 { common_cmds
, ARRAY_SIZE(common_cmds
) },
378 { vecs_cmds
, ARRAY_SIZE(vecs_cmds
) },
381 static const struct drm_i915_cmd_table gen7_blt_cmds
[] = {
382 { common_cmds
, ARRAY_SIZE(common_cmds
) },
383 { blt_cmds
, ARRAY_SIZE(blt_cmds
) },
386 static const struct drm_i915_cmd_table hsw_blt_ring_cmds
[] = {
387 { common_cmds
, ARRAY_SIZE(common_cmds
) },
388 { blt_cmds
, ARRAY_SIZE(blt_cmds
) },
389 { hsw_blt_cmds
, ARRAY_SIZE(hsw_blt_cmds
) },
393 * Register whitelists, sorted by increasing register offset.
395 * Some registers that userspace accesses are 64 bits. The register
396 * access commands only allow 32-bit accesses. Hence, we have to include
397 * entries for both halves of the 64-bit registers.
400 /* Convenience macro for adding 64-bit registers */
401 #define REG64(addr) (addr), (addr + sizeof(u32))
403 static const u32 gen7_render_regs
[] = {
404 REG64(HS_INVOCATION_COUNT
),
405 REG64(DS_INVOCATION_COUNT
),
406 REG64(IA_VERTICES_COUNT
),
407 REG64(IA_PRIMITIVES_COUNT
),
408 REG64(VS_INVOCATION_COUNT
),
409 REG64(GS_INVOCATION_COUNT
),
410 REG64(GS_PRIMITIVES_COUNT
),
411 REG64(CL_INVOCATION_COUNT
),
412 REG64(CL_PRIMITIVES_COUNT
),
413 REG64(PS_INVOCATION_COUNT
),
414 REG64(PS_DEPTH_COUNT
),
415 OACONTROL
, /* Only allowed for LRI and SRM. See below. */
416 GEN7_3DPRIM_END_OFFSET
,
417 GEN7_3DPRIM_START_VERTEX
,
418 GEN7_3DPRIM_VERTEX_COUNT
,
419 GEN7_3DPRIM_INSTANCE_COUNT
,
420 GEN7_3DPRIM_START_INSTANCE
,
421 GEN7_3DPRIM_BASE_VERTEX
,
422 REG64(GEN7_SO_NUM_PRIMS_WRITTEN(0)),
423 REG64(GEN7_SO_NUM_PRIMS_WRITTEN(1)),
424 REG64(GEN7_SO_NUM_PRIMS_WRITTEN(2)),
425 REG64(GEN7_SO_NUM_PRIMS_WRITTEN(3)),
426 REG64(GEN7_SO_PRIM_STORAGE_NEEDED(0)),
427 REG64(GEN7_SO_PRIM_STORAGE_NEEDED(1)),
428 REG64(GEN7_SO_PRIM_STORAGE_NEEDED(2)),
429 REG64(GEN7_SO_PRIM_STORAGE_NEEDED(3)),
430 GEN7_SO_WRITE_OFFSET(0),
431 GEN7_SO_WRITE_OFFSET(1),
432 GEN7_SO_WRITE_OFFSET(2),
433 GEN7_SO_WRITE_OFFSET(3),
439 static const u32 gen7_blt_regs
[] = {
443 static const u32 ivb_master_regs
[] = {
446 GEN7_PIPE_DE_LOAD_SL(PIPE_A
),
447 GEN7_PIPE_DE_LOAD_SL(PIPE_B
),
448 GEN7_PIPE_DE_LOAD_SL(PIPE_C
),
451 static const u32 hsw_master_regs
[] = {
458 static u32
gen7_render_get_cmd_length_mask(u32 cmd_header
)
460 u32 client
= (cmd_header
& INSTR_CLIENT_MASK
) >> INSTR_CLIENT_SHIFT
;
462 (cmd_header
& INSTR_SUBCLIENT_MASK
) >> INSTR_SUBCLIENT_SHIFT
;
464 if (client
== INSTR_MI_CLIENT
)
466 else if (client
== INSTR_RC_CLIENT
) {
467 if (subclient
== INSTR_MEDIA_SUBCLIENT
)
473 DRM_DEBUG_DRIVER("CMD: Abnormal rcs cmd length! 0x%08X\n", cmd_header
);
477 static u32
gen7_bsd_get_cmd_length_mask(u32 cmd_header
)
479 u32 client
= (cmd_header
& INSTR_CLIENT_MASK
) >> INSTR_CLIENT_SHIFT
;
481 (cmd_header
& INSTR_SUBCLIENT_MASK
) >> INSTR_SUBCLIENT_SHIFT
;
483 if (client
== INSTR_MI_CLIENT
)
485 else if (client
== INSTR_RC_CLIENT
) {
486 if (subclient
== INSTR_MEDIA_SUBCLIENT
)
492 DRM_DEBUG_DRIVER("CMD: Abnormal bsd cmd length! 0x%08X\n", cmd_header
);
496 static u32
gen7_blt_get_cmd_length_mask(u32 cmd_header
)
498 u32 client
= (cmd_header
& INSTR_CLIENT_MASK
) >> INSTR_CLIENT_SHIFT
;
500 if (client
== INSTR_MI_CLIENT
)
502 else if (client
== INSTR_BC_CLIENT
)
505 DRM_DEBUG_DRIVER("CMD: Abnormal blt cmd length! 0x%08X\n", cmd_header
);
509 static bool validate_cmds_sorted(struct intel_engine_cs
*ring
,
510 const struct drm_i915_cmd_table
*cmd_tables
,
516 if (!cmd_tables
|| cmd_table_count
== 0)
519 for (i
= 0; i
< cmd_table_count
; i
++) {
520 const struct drm_i915_cmd_table
*table
= &cmd_tables
[i
];
524 for (j
= 0; j
< table
->count
; j
++) {
525 const struct drm_i915_cmd_descriptor
*desc
=
527 u32 curr
= desc
->cmd
.value
& desc
->cmd
.mask
;
529 if (curr
< previous
) {
530 DRM_ERROR("CMD: table not sorted ring=%d table=%d entry=%d cmd=0x%08X prev=0x%08X\n",
531 ring
->id
, i
, j
, curr
, previous
);
542 static bool check_sorted(int ring_id
, const u32
*reg_table
, int reg_count
)
548 for (i
= 0; i
< reg_count
; i
++) {
549 u32 curr
= reg_table
[i
];
551 if (curr
< previous
) {
552 DRM_ERROR("CMD: table not sorted ring=%d entry=%d reg=0x%08X prev=0x%08X\n",
553 ring_id
, i
, curr
, previous
);
563 static bool validate_regs_sorted(struct intel_engine_cs
*ring
)
565 return check_sorted(ring
->id
, ring
->reg_table
, ring
->reg_count
) &&
566 check_sorted(ring
->id
, ring
->master_reg_table
,
567 ring
->master_reg_count
);
571 const struct drm_i915_cmd_descriptor
*desc
;
572 struct hlist_node node
;
576 * Different command ranges have different numbers of bits for the opcode. For
577 * example, MI commands use bits 31:23 while 3D commands use bits 31:16. The
578 * problem is that, for example, MI commands use bits 22:16 for other fields
579 * such as GGTT vs PPGTT bits. If we include those bits in the mask then when
580 * we mask a command from a batch it could hash to the wrong bucket due to
581 * non-opcode bits being set. But if we don't include those bits, some 3D
582 * commands may hash to the same bucket due to not including opcode bits that
583 * make the command unique. For now, we will risk hashing to the same bucket.
585 * If we attempt to generate a perfect hash, we should be able to look at bits
586 * 31:29 of a command from a batch buffer and use the full mask for that
587 * client. The existing INSTR_CLIENT_MASK/SHIFT defines can be used for this.
589 #define CMD_HASH_MASK STD_MI_OPCODE_MASK
591 static int init_hash_table(struct intel_engine_cs
*ring
,
592 const struct drm_i915_cmd_table
*cmd_tables
,
597 hash_init(ring
->cmd_hash
);
599 for (i
= 0; i
< cmd_table_count
; i
++) {
600 const struct drm_i915_cmd_table
*table
= &cmd_tables
[i
];
602 for (j
= 0; j
< table
->count
; j
++) {
603 const struct drm_i915_cmd_descriptor
*desc
=
605 struct cmd_node
*desc_node
=
606 kmalloc(sizeof(*desc_node
), GFP_KERNEL
);
611 desc_node
->desc
= desc
;
612 hash_add(ring
->cmd_hash
, &desc_node
->node
,
613 desc
->cmd
.value
& CMD_HASH_MASK
);
620 static void fini_hash_table(struct intel_engine_cs
*ring
)
622 struct hlist_node
*tmp
;
623 struct cmd_node
*desc_node
;
626 hash_for_each_safe(ring
->cmd_hash
, i
, tmp
, desc_node
, node
) {
627 hash_del(&desc_node
->node
);
633 * i915_cmd_parser_init_ring() - set cmd parser related fields for a ringbuffer
634 * @ring: the ringbuffer to initialize
636 * Optionally initializes fields related to batch buffer command parsing in the
637 * struct intel_engine_cs based on whether the platform requires software
640 * Return: non-zero if initialization fails
642 int i915_cmd_parser_init_ring(struct intel_engine_cs
*ring
)
644 const struct drm_i915_cmd_table
*cmd_tables
;
648 if (!IS_GEN7(ring
->dev
))
653 if (IS_HASWELL(ring
->dev
)) {
654 cmd_tables
= hsw_render_ring_cmds
;
656 ARRAY_SIZE(hsw_render_ring_cmds
);
658 cmd_tables
= gen7_render_cmds
;
659 cmd_table_count
= ARRAY_SIZE(gen7_render_cmds
);
662 ring
->reg_table
= gen7_render_regs
;
663 ring
->reg_count
= ARRAY_SIZE(gen7_render_regs
);
665 if (IS_HASWELL(ring
->dev
)) {
666 ring
->master_reg_table
= hsw_master_regs
;
667 ring
->master_reg_count
= ARRAY_SIZE(hsw_master_regs
);
669 ring
->master_reg_table
= ivb_master_regs
;
670 ring
->master_reg_count
= ARRAY_SIZE(ivb_master_regs
);
673 ring
->get_cmd_length_mask
= gen7_render_get_cmd_length_mask
;
676 cmd_tables
= gen7_video_cmds
;
677 cmd_table_count
= ARRAY_SIZE(gen7_video_cmds
);
678 ring
->get_cmd_length_mask
= gen7_bsd_get_cmd_length_mask
;
681 if (IS_HASWELL(ring
->dev
)) {
682 cmd_tables
= hsw_blt_ring_cmds
;
683 cmd_table_count
= ARRAY_SIZE(hsw_blt_ring_cmds
);
685 cmd_tables
= gen7_blt_cmds
;
686 cmd_table_count
= ARRAY_SIZE(gen7_blt_cmds
);
689 ring
->reg_table
= gen7_blt_regs
;
690 ring
->reg_count
= ARRAY_SIZE(gen7_blt_regs
);
692 if (IS_HASWELL(ring
->dev
)) {
693 ring
->master_reg_table
= hsw_master_regs
;
694 ring
->master_reg_count
= ARRAY_SIZE(hsw_master_regs
);
696 ring
->master_reg_table
= ivb_master_regs
;
697 ring
->master_reg_count
= ARRAY_SIZE(ivb_master_regs
);
700 ring
->get_cmd_length_mask
= gen7_blt_get_cmd_length_mask
;
703 cmd_tables
= hsw_vebox_cmds
;
704 cmd_table_count
= ARRAY_SIZE(hsw_vebox_cmds
);
705 /* VECS can use the same length_mask function as VCS */
706 ring
->get_cmd_length_mask
= gen7_bsd_get_cmd_length_mask
;
709 DRM_ERROR("CMD: cmd_parser_init with unknown ring: %d\n",
714 BUG_ON(!validate_cmds_sorted(ring
, cmd_tables
, cmd_table_count
));
715 BUG_ON(!validate_regs_sorted(ring
));
717 if (hash_empty(ring
->cmd_hash
)) {
718 ret
= init_hash_table(ring
, cmd_tables
, cmd_table_count
);
720 DRM_ERROR("CMD: cmd_parser_init failed!\n");
721 fini_hash_table(ring
);
726 ring
->needs_cmd_parser
= true;
732 * i915_cmd_parser_fini_ring() - clean up cmd parser related fields
733 * @ring: the ringbuffer to clean up
735 * Releases any resources related to command parsing that may have been
736 * initialized for the specified ring.
738 void i915_cmd_parser_fini_ring(struct intel_engine_cs
*ring
)
740 if (!ring
->needs_cmd_parser
)
743 fini_hash_table(ring
);
746 static const struct drm_i915_cmd_descriptor
*
747 find_cmd_in_table(struct intel_engine_cs
*ring
,
750 struct cmd_node
*desc_node
;
752 hash_for_each_possible(ring
->cmd_hash
, desc_node
, node
,
753 cmd_header
& CMD_HASH_MASK
) {
754 const struct drm_i915_cmd_descriptor
*desc
= desc_node
->desc
;
755 u32 masked_cmd
= desc
->cmd
.mask
& cmd_header
;
756 u32 masked_value
= desc
->cmd
.value
& desc
->cmd
.mask
;
758 if (masked_cmd
== masked_value
)
766 * Returns a pointer to a descriptor for the command specified by cmd_header.
768 * The caller must supply space for a default descriptor via the default_desc
769 * parameter. If no descriptor for the specified command exists in the ring's
770 * command parser tables, this function fills in default_desc based on the
771 * ring's default length encoding and returns default_desc.
773 static const struct drm_i915_cmd_descriptor
*
774 find_cmd(struct intel_engine_cs
*ring
,
776 struct drm_i915_cmd_descriptor
*default_desc
)
778 const struct drm_i915_cmd_descriptor
*desc
;
781 desc
= find_cmd_in_table(ring
, cmd_header
);
785 mask
= ring
->get_cmd_length_mask(cmd_header
);
789 BUG_ON(!default_desc
);
790 default_desc
->flags
= CMD_DESC_SKIP
;
791 default_desc
->length
.mask
= mask
;
796 static bool valid_reg(const u32
*table
, int count
, u32 addr
)
798 if (table
&& count
!= 0) {
801 for (i
= 0; i
< count
; i
++) {
802 if (table
[i
] == addr
)
810 static u32
*vmap_batch(struct drm_i915_gem_object
*obj
)
814 struct sg_page_iter sg_iter
;
817 pages
= drm_malloc_ab(obj
->base
.size
>> PAGE_SHIFT
, sizeof(*pages
));
819 DRM_DEBUG_DRIVER("Failed to get space for pages\n");
824 for_each_sg_page(obj
->pages
->sgl
, &sg_iter
, obj
->pages
->nents
, 0) {
825 pages
[i
] = sg_page_iter_page(&sg_iter
);
829 addr
= vmap(pages
, i
, 0, PAGE_KERNEL
);
831 DRM_DEBUG_DRIVER("Failed to vmap pages\n");
837 drm_free_large(pages
);
842 * i915_needs_cmd_parser() - should a given ring use software command parsing?
843 * @ring: the ring in question
845 * Only certain platforms require software batch buffer command parsing, and
846 * only when enabled via module parameter.
848 * Return: true if the ring requires software command parsing
850 bool i915_needs_cmd_parser(struct intel_engine_cs
*ring
)
852 if (!ring
->needs_cmd_parser
)
855 if (!USES_PPGTT(ring
->dev
))
858 return (i915
.enable_cmd_parser
== 1);
861 static bool check_cmd(const struct intel_engine_cs
*ring
,
862 const struct drm_i915_cmd_descriptor
*desc
,
864 const bool is_master
,
867 if (desc
->flags
& CMD_DESC_REJECT
) {
868 DRM_DEBUG_DRIVER("CMD: Rejected command: 0x%08X\n", *cmd
);
872 if ((desc
->flags
& CMD_DESC_MASTER
) && !is_master
) {
873 DRM_DEBUG_DRIVER("CMD: Rejected master-only command: 0x%08X\n",
878 if (desc
->flags
& CMD_DESC_REGISTER
) {
879 u32 reg_addr
= cmd
[desc
->reg
.offset
] & desc
->reg
.mask
;
882 * OACONTROL requires some special handling for writes. We
883 * want to make sure that any batch which enables OA also
884 * disables it before the end of the batch. The goal is to
885 * prevent one process from snooping on the perf data from
886 * another process. To do that, we need to check the value
887 * that will be written to the register. Hence, limit
888 * OACONTROL writes to only MI_LOAD_REGISTER_IMM commands.
890 if (reg_addr
== OACONTROL
) {
891 if (desc
->cmd
.value
== MI_LOAD_REGISTER_MEM
) {
892 DRM_DEBUG_DRIVER("CMD: Rejected LRM to OACONTROL\n");
896 if (desc
->cmd
.value
== MI_LOAD_REGISTER_IMM(1))
897 *oacontrol_set
= (cmd
[2] != 0);
900 if (!valid_reg(ring
->reg_table
,
901 ring
->reg_count
, reg_addr
)) {
903 !valid_reg(ring
->master_reg_table
,
904 ring
->master_reg_count
,
906 DRM_DEBUG_DRIVER("CMD: Rejected register 0x%08X in command: 0x%08X (ring=%d)\n",
915 if (desc
->flags
& CMD_DESC_BITMASK
) {
918 for (i
= 0; i
< MAX_CMD_DESC_BITMASKS
; i
++) {
921 if (desc
->bits
[i
].mask
== 0)
924 if (desc
->bits
[i
].condition_mask
!= 0) {
926 desc
->bits
[i
].condition_offset
;
927 u32 condition
= cmd
[offset
] &
928 desc
->bits
[i
].condition_mask
;
934 dword
= cmd
[desc
->bits
[i
].offset
] &
937 if (dword
!= desc
->bits
[i
].expected
) {
938 DRM_DEBUG_DRIVER("CMD: Rejected command 0x%08X for bitmask 0x%08X (exp=0x%08X act=0x%08X) (ring=%d)\n",
941 desc
->bits
[i
].expected
,
951 #define LENGTH_BIAS 2
954 * i915_parse_cmds() - parse a submitted batch buffer for privilege violations
955 * @ring: the ring on which the batch is to execute
956 * @batch_obj: the batch buffer in question
957 * @batch_start_offset: byte offset in the batch at which execution starts
958 * @is_master: is the submitting process the drm master?
960 * Parses the specified batch buffer looking for privilege violations as
961 * described in the overview.
963 * Return: non-zero if the parser finds violations or otherwise fails; -EACCES
964 * if the batch appears legal but should use hardware parsing
966 int i915_parse_cmds(struct intel_engine_cs
*ring
,
967 struct drm_i915_gem_object
*batch_obj
,
968 u32 batch_start_offset
,
972 u32
*cmd
, *batch_base
, *batch_end
;
973 struct drm_i915_cmd_descriptor default_desc
= { 0 };
974 int needs_clflush
= 0;
975 bool oacontrol_set
= false; /* OACONTROL tracking. See check_cmd() */
977 ret
= i915_gem_obj_prepare_shmem_read(batch_obj
, &needs_clflush
);
979 DRM_DEBUG_DRIVER("CMD: failed to prep read\n");
983 batch_base
= vmap_batch(batch_obj
);
985 DRM_DEBUG_DRIVER("CMD: Failed to vmap batch\n");
986 i915_gem_object_unpin_pages(batch_obj
);
991 drm_clflush_virt_range((char *)batch_base
, batch_obj
->base
.size
);
993 cmd
= batch_base
+ (batch_start_offset
/ sizeof(*cmd
));
994 batch_end
= cmd
+ (batch_obj
->base
.size
/ sizeof(*batch_end
));
996 while (cmd
< batch_end
) {
997 const struct drm_i915_cmd_descriptor
*desc
;
1000 if (*cmd
== MI_BATCH_BUFFER_END
)
1003 desc
= find_cmd(ring
, *cmd
, &default_desc
);
1005 DRM_DEBUG_DRIVER("CMD: Unrecognized command: 0x%08X\n",
1012 * If the batch buffer contains a chained batch, return an
1013 * error that tells the caller to abort and dispatch the
1014 * workload as a non-secure batch.
1016 if (desc
->cmd
.value
== MI_BATCH_BUFFER_START
) {
1021 if (desc
->flags
& CMD_DESC_FIXED
)
1022 length
= desc
->length
.fixed
;
1024 length
= ((*cmd
& desc
->length
.mask
) + LENGTH_BIAS
);
1026 if ((batch_end
- cmd
) < length
) {
1027 DRM_DEBUG_DRIVER("CMD: Command length exceeds batch length: 0x%08X length=%u batchlen=%td\n",
1035 if (!check_cmd(ring
, desc
, cmd
, is_master
, &oacontrol_set
)) {
1043 if (oacontrol_set
) {
1044 DRM_DEBUG_DRIVER("CMD: batch set OACONTROL but did not clear it\n");
1048 if (cmd
>= batch_end
) {
1049 DRM_DEBUG_DRIVER("CMD: Got to the end of the buffer w/o a BBE cmd!\n");
1055 i915_gem_object_unpin_pages(batch_obj
);
1061 * i915_cmd_parser_get_version() - get the cmd parser version number
1063 * The cmd parser maintains a simple increasing integer version number suitable
1064 * for passing to userspace clients to determine what operations are permitted.
1066 * Return: the current version number of the cmd parser
1068 int i915_cmd_parser_get_version(void)
1071 * Command parser version history
1073 * 1. Initial version. Checks batches and reports violations, but leaves
1074 * hardware parsing enabled (so does not allow new use cases).