]>
git.proxmox.com Git - mirror_qemu.git/blob - target/riscv/pmp.c
2 * QEMU RISC-V PMP (Physical Memory Protection)
4 * Author: Daire McNamara, daire.mcnamara@emdalo.com
5 * Ivan Griffin, ivan.griffin@emdalo.com
7 * This provides a RISC-V Physical Memory Protection implementation
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms and conditions of the GNU General Public License,
11 * version 2 or later, as published by the Free Software Foundation.
13 * This program is distributed in the hope it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along with
19 * this program. If not, see <http://www.gnu.org/licenses/>.
22 #include "qemu/osdep.h"
24 #include "qapi/error.h"
27 #include "exec/exec-all.h"
29 static bool pmp_write_cfg(CPURISCVState
*env
, uint32_t addr_index
,
31 static uint8_t pmp_read_cfg(CPURISCVState
*env
, uint32_t addr_index
);
32 static void pmp_update_rule(CPURISCVState
*env
, uint32_t pmp_index
);
35 * Accessor method to extract address matching type 'a field' from cfg reg
37 static inline uint8_t pmp_get_a_field(uint8_t cfg
)
44 * Check whether a PMP is locked or not.
46 static inline int pmp_is_locked(CPURISCVState
*env
, uint32_t pmp_index
)
49 if (env
->pmp_state
.pmp
[pmp_index
].cfg_reg
& PMP_LOCK
) {
53 /* Top PMP has no 'next' to check */
54 if ((pmp_index
+ 1u) >= MAX_RISCV_PMPS
) {
62 * Count the number of active rules.
64 uint32_t pmp_get_num_rules(CPURISCVState
*env
)
66 return env
->pmp_state
.num_rules
;
70 * Accessor to get the cfg reg for a specific PMP/HART
72 static inline uint8_t pmp_read_cfg(CPURISCVState
*env
, uint32_t pmp_index
)
74 if (pmp_index
< MAX_RISCV_PMPS
) {
75 return env
->pmp_state
.pmp
[pmp_index
].cfg_reg
;
83 * Accessor to set the cfg reg for a specific PMP/HART
84 * Bounds checks and relevant lock bit.
86 static bool pmp_write_cfg(CPURISCVState
*env
, uint32_t pmp_index
, uint8_t val
)
88 if (pmp_index
< MAX_RISCV_PMPS
) {
91 if (riscv_cpu_cfg(env
)->epmp
) {
92 /* mseccfg.RLB is set */
93 if (MSECCFG_RLB_ISSET(env
)) {
97 /* mseccfg.MML is not set */
98 if (!MSECCFG_MML_ISSET(env
) && !pmp_is_locked(env
, pmp_index
)) {
102 /* mseccfg.MML is set */
103 if (MSECCFG_MML_ISSET(env
)) {
104 /* not adding execute bit */
105 if ((val
& PMP_LOCK
) != 0 && (val
& PMP_EXEC
) != PMP_EXEC
) {
108 /* shared region and not adding X bit */
109 if ((val
& PMP_LOCK
) != PMP_LOCK
&&
110 (val
& 0x7) != (PMP_WRITE
| PMP_EXEC
)) {
115 if (!pmp_is_locked(env
, pmp_index
)) {
121 qemu_log_mask(LOG_GUEST_ERROR
, "ignoring pmpcfg write - locked\n");
122 } else if (env
->pmp_state
.pmp
[pmp_index
].cfg_reg
!= val
) {
123 env
->pmp_state
.pmp
[pmp_index
].cfg_reg
= val
;
124 pmp_update_rule(env
, pmp_index
);
128 qemu_log_mask(LOG_GUEST_ERROR
,
129 "ignoring pmpcfg write - out of bounds\n");
135 static void pmp_decode_napot(target_ulong a
, target_ulong
*sa
,
139 * aaaa...aaa0 8-byte NAPOT range
140 * aaaa...aa01 16-byte NAPOT range
141 * aaaa...a011 32-byte NAPOT range
143 * aa01...1111 2^XLEN-byte NAPOT range
144 * a011...1111 2^(XLEN+1)-byte NAPOT range
145 * 0111...1111 2^(XLEN+2)-byte NAPOT range
146 * 1111...1111 Reserved
153 void pmp_update_rule_addr(CPURISCVState
*env
, uint32_t pmp_index
)
155 uint8_t this_cfg
= env
->pmp_state
.pmp
[pmp_index
].cfg_reg
;
156 target_ulong this_addr
= env
->pmp_state
.pmp
[pmp_index
].addr_reg
;
157 target_ulong prev_addr
= 0u;
158 target_ulong sa
= 0u;
159 target_ulong ea
= 0u;
161 if (pmp_index
>= 1u) {
162 prev_addr
= env
->pmp_state
.pmp
[pmp_index
- 1].addr_reg
;
165 switch (pmp_get_a_field(this_cfg
)) {
172 sa
= prev_addr
<< 2; /* shift up from [xx:0] to [xx+2:2] */
173 ea
= (this_addr
<< 2) - 1u;
180 sa
= this_addr
<< 2; /* shift up from [xx:0] to [xx+2:2] */
184 case PMP_AMATCH_NAPOT
:
185 pmp_decode_napot(this_addr
, &sa
, &ea
);
194 env
->pmp_state
.addr
[pmp_index
].sa
= sa
;
195 env
->pmp_state
.addr
[pmp_index
].ea
= ea
;
198 void pmp_update_rule_nums(CPURISCVState
*env
)
202 env
->pmp_state
.num_rules
= 0;
203 for (i
= 0; i
< MAX_RISCV_PMPS
; i
++) {
204 const uint8_t a_field
=
205 pmp_get_a_field(env
->pmp_state
.pmp
[i
].cfg_reg
);
206 if (PMP_AMATCH_OFF
!= a_field
) {
207 env
->pmp_state
.num_rules
++;
213 * Convert cfg/addr reg values here into simple 'sa' --> start address and 'ea'
214 * end address values.
215 * This function is called relatively infrequently whereas the check that
216 * an address is within a pmp rule is called often, so optimise that one
218 static void pmp_update_rule(CPURISCVState
*env
, uint32_t pmp_index
)
220 pmp_update_rule_addr(env
, pmp_index
);
221 pmp_update_rule_nums(env
);
224 static int pmp_is_in_range(CPURISCVState
*env
, int pmp_index
,
229 if ((addr
>= env
->pmp_state
.addr
[pmp_index
].sa
) &&
230 (addr
<= env
->pmp_state
.addr
[pmp_index
].ea
)) {
240 * Check if the address has required RWX privs when no PMP entry is matched.
242 static bool pmp_hart_has_privs_default(CPURISCVState
*env
, pmp_priv_t privs
,
243 pmp_priv_t
*allowed_privs
,
248 if (MSECCFG_MMWP_ISSET(env
)) {
250 * The Machine Mode Whitelist Policy (mseccfg.MMWP) is set
251 * so we default to deny all, even for M-mode.
255 } else if (MSECCFG_MML_ISSET(env
)) {
257 * The Machine Mode Lockdown (mseccfg.MML) bit is set
258 * so we can only execute code in M-mode with an applicable
259 * rule. Other modes are disabled.
261 if (mode
== PRV_M
&& !(privs
& PMP_EXEC
)) {
263 *allowed_privs
= PMP_READ
| PMP_WRITE
;
272 if (!riscv_cpu_cfg(env
)->pmp
|| (mode
== PRV_M
)) {
274 * Privileged spec v1.10 states if HW doesn't implement any PMP entry
275 * or no PMP entry matches an M-Mode access, the access succeeds.
278 *allowed_privs
= PMP_READ
| PMP_WRITE
| PMP_EXEC
;
281 * Other modes are not allowed to succeed if they don't * match a rule,
282 * but there are rules. We've checked for no rule earlier in this
298 * Check if the address has required RWX privs to complete desired operation
299 * Return true if a pmp rule match or default match
300 * Return false if no match
302 bool pmp_hart_has_privs(CPURISCVState
*env
, target_ulong addr
,
303 target_ulong size
, pmp_priv_t privs
,
304 pmp_priv_t
*allowed_privs
, target_ulong mode
)
312 /* Short cut if no rules */
313 if (0 == pmp_get_num_rules(env
)) {
314 return pmp_hart_has_privs_default(env
, privs
, allowed_privs
, mode
);
318 if (riscv_cpu_cfg(env
)->mmu
) {
320 * If size is unknown (0), assume that all bytes
321 * from addr to the end of the page will be accessed.
323 pmp_size
= -(addr
| TARGET_PAGE_MASK
);
325 pmp_size
= sizeof(target_ulong
);
332 * 1.10 draft priv spec states there is an implicit order
335 for (i
= 0; i
< MAX_RISCV_PMPS
; i
++) {
336 s
= pmp_is_in_range(env
, i
, addr
);
337 e
= pmp_is_in_range(env
, i
, addr
+ pmp_size
- 1);
339 /* partially inside */
341 qemu_log_mask(LOG_GUEST_ERROR
,
342 "pmp violation - access is partially inside\n");
348 const uint8_t a_field
=
349 pmp_get_a_field(env
->pmp_state
.pmp
[i
].cfg_reg
);
352 * Convert the PMP permissions to match the truth table in the
355 const uint8_t epmp_operation
=
356 ((env
->pmp_state
.pmp
[i
].cfg_reg
& PMP_LOCK
) >> 4) |
357 ((env
->pmp_state
.pmp
[i
].cfg_reg
& PMP_READ
) << 2) |
358 (env
->pmp_state
.pmp
[i
].cfg_reg
& PMP_WRITE
) |
359 ((env
->pmp_state
.pmp
[i
].cfg_reg
& PMP_EXEC
) >> 2);
361 if (((s
+ e
) == 2) && (PMP_AMATCH_OFF
!= a_field
)) {
363 * If the PMP entry is not off and the address is in range,
366 if (!MSECCFG_MML_ISSET(env
)) {
368 * If mseccfg.MML Bit is not set, do pmp priv check
369 * This will always apply to regular PMP.
371 *allowed_privs
= PMP_READ
| PMP_WRITE
| PMP_EXEC
;
372 if ((mode
!= PRV_M
) || pmp_is_locked(env
, i
)) {
373 *allowed_privs
&= env
->pmp_state
.pmp
[i
].cfg_reg
;
377 * If mseccfg.MML Bit set, do the enhanced pmp priv check
380 switch (epmp_operation
) {
393 *allowed_privs
= PMP_READ
| PMP_WRITE
;
397 *allowed_privs
= PMP_EXEC
;
401 *allowed_privs
= PMP_READ
| PMP_EXEC
;
405 *allowed_privs
= PMP_READ
;
408 g_assert_not_reached();
411 switch (epmp_operation
) {
423 *allowed_privs
= PMP_EXEC
;
428 *allowed_privs
= PMP_READ
;
432 *allowed_privs
= PMP_READ
| PMP_WRITE
;
435 *allowed_privs
= PMP_READ
| PMP_EXEC
;
438 *allowed_privs
= PMP_READ
| PMP_WRITE
| PMP_EXEC
;
441 g_assert_not_reached();
447 * If matching address range was found, the protection bits
448 * defined with PMP must be used. We shouldn't fallback on
449 * finding default privileges.
456 /* No rule matched */
458 ret
= pmp_hart_has_privs_default(env
, privs
, allowed_privs
, mode
);
465 * Handle a write to a pmpcfg CSR
467 void pmpcfg_csr_write(CPURISCVState
*env
, uint32_t reg_index
,
472 int pmpcfg_nums
= 2 << riscv_cpu_mxl(env
);
473 bool modified
= false;
475 trace_pmpcfg_csr_write(env
->mhartid
, reg_index
, val
);
477 for (i
= 0; i
< pmpcfg_nums
; i
++) {
478 cfg_val
= (val
>> 8 * i
) & 0xff;
479 modified
|= pmp_write_cfg(env
, (reg_index
* 4) + i
, cfg_val
);
482 /* If PMP permission of any addr has been changed, flush TLB pages. */
484 tlb_flush(env_cpu(env
));
490 * Handle a read from a pmpcfg CSR
492 target_ulong
pmpcfg_csr_read(CPURISCVState
*env
, uint32_t reg_index
)
495 target_ulong cfg_val
= 0;
496 target_ulong val
= 0;
497 int pmpcfg_nums
= 2 << riscv_cpu_mxl(env
);
499 for (i
= 0; i
< pmpcfg_nums
; i
++) {
500 val
= pmp_read_cfg(env
, (reg_index
* 4) + i
);
501 cfg_val
|= (val
<< (i
* 8));
503 trace_pmpcfg_csr_read(env
->mhartid
, reg_index
, cfg_val
);
510 * Handle a write to a pmpaddr CSR
512 void pmpaddr_csr_write(CPURISCVState
*env
, uint32_t addr_index
,
515 trace_pmpaddr_csr_write(env
->mhartid
, addr_index
, val
);
516 bool is_next_cfg_tor
= false;
518 if (addr_index
< MAX_RISCV_PMPS
) {
520 * In TOR mode, need to check the lock bit of the next pmp
521 * (if there is a next).
523 if (addr_index
+ 1 < MAX_RISCV_PMPS
) {
524 uint8_t pmp_cfg
= env
->pmp_state
.pmp
[addr_index
+ 1].cfg_reg
;
525 is_next_cfg_tor
= PMP_AMATCH_TOR
== pmp_get_a_field(pmp_cfg
);
527 if (pmp_cfg
& PMP_LOCK
&& is_next_cfg_tor
) {
528 qemu_log_mask(LOG_GUEST_ERROR
,
529 "ignoring pmpaddr write - pmpcfg + 1 locked\n");
534 if (!pmp_is_locked(env
, addr_index
)) {
535 if (env
->pmp_state
.pmp
[addr_index
].addr_reg
!= val
) {
536 env
->pmp_state
.pmp
[addr_index
].addr_reg
= val
;
537 pmp_update_rule_addr(env
, addr_index
);
538 if (is_next_cfg_tor
) {
539 pmp_update_rule_addr(env
, addr_index
+ 1);
541 tlb_flush(env_cpu(env
));
544 qemu_log_mask(LOG_GUEST_ERROR
,
545 "ignoring pmpaddr write - locked\n");
548 qemu_log_mask(LOG_GUEST_ERROR
,
549 "ignoring pmpaddr write - out of bounds\n");
555 * Handle a read from a pmpaddr CSR
557 target_ulong
pmpaddr_csr_read(CPURISCVState
*env
, uint32_t addr_index
)
559 target_ulong val
= 0;
561 if (addr_index
< MAX_RISCV_PMPS
) {
562 val
= env
->pmp_state
.pmp
[addr_index
].addr_reg
;
563 trace_pmpaddr_csr_read(env
->mhartid
, addr_index
, val
);
565 qemu_log_mask(LOG_GUEST_ERROR
,
566 "ignoring pmpaddr read - out of bounds\n");
573 * Handle a write to a mseccfg CSR
575 void mseccfg_csr_write(CPURISCVState
*env
, target_ulong val
)
579 trace_mseccfg_csr_write(env
->mhartid
, val
);
581 /* RLB cannot be enabled if it's already 0 and if any regions are locked */
582 if (!MSECCFG_RLB_ISSET(env
)) {
583 for (i
= 0; i
< MAX_RISCV_PMPS
; i
++) {
584 if (pmp_is_locked(env
, i
)) {
591 if (riscv_cpu_cfg(env
)->epmp
) {
593 val
|= (env
->mseccfg
& (MSECCFG_MMWP
| MSECCFG_MML
));
594 if ((val
^ env
->mseccfg
) & (MSECCFG_MMWP
| MSECCFG_MML
)) {
595 tlb_flush(env_cpu(env
));
598 val
&= ~(MSECCFG_MMWP
| MSECCFG_MML
| MSECCFG_RLB
);
605 * Handle a read from a mseccfg CSR
607 target_ulong
mseccfg_csr_read(CPURISCVState
*env
)
609 trace_mseccfg_csr_read(env
->mhartid
, env
->mseccfg
);
614 * Calculate the TLB size.
615 * It's possible that PMP regions only cover partial of the TLB page, and
616 * this may split the page into regions with different permissions.
617 * For example if PMP0 is (0x80000008~0x8000000F, R) and PMP1 is (0x80000000
618 * ~0x80000FFF, RWX), then region 0x80000008~0x8000000F has R permission, and
619 * the other regions in this page have RWX permissions.
620 * A write access to 0x80000000 will match PMP1. However we cannot cache the
621 * translation result in the TLB since this will make the write access to
622 * 0x80000008 bypass the check of PMP0.
623 * To avoid this we return a size of 1 (which means no caching) if the PMP
624 * region only covers partial of the TLB page.
626 target_ulong
pmp_get_tlb_size(CPURISCVState
*env
, target_ulong addr
)
630 target_ulong tlb_sa
= addr
& ~(TARGET_PAGE_SIZE
- 1);
631 target_ulong tlb_ea
= tlb_sa
+ TARGET_PAGE_SIZE
- 1;
635 * If PMP is not supported or there are no PMP rules, the TLB page will not
636 * be split into regions with different permissions by PMP so we set the
637 * size to TARGET_PAGE_SIZE.
639 if (!riscv_cpu_cfg(env
)->pmp
|| !pmp_get_num_rules(env
)) {
640 return TARGET_PAGE_SIZE
;
643 for (i
= 0; i
< MAX_RISCV_PMPS
; i
++) {
644 if (pmp_get_a_field(env
->pmp_state
.pmp
[i
].cfg_reg
) == PMP_AMATCH_OFF
) {
648 pmp_sa
= env
->pmp_state
.addr
[i
].sa
;
649 pmp_ea
= env
->pmp_state
.addr
[i
].ea
;
652 * Only the first PMP entry that covers (whole or partial of) the TLB
653 * page really matters:
654 * If it covers the whole TLB page, set the size to TARGET_PAGE_SIZE,
655 * since the following PMP entries have lower priority and will not
656 * affect the permissions of the page.
657 * If it only covers partial of the TLB page, set the size to 1 since
658 * the allowed permissions of the region may be different from other
659 * region of the page.
661 if (pmp_sa
<= tlb_sa
&& pmp_ea
>= tlb_ea
) {
662 return TARGET_PAGE_SIZE
;
663 } else if ((pmp_sa
>= tlb_sa
&& pmp_sa
<= tlb_ea
) ||
664 (pmp_ea
>= tlb_sa
&& pmp_ea
<= tlb_ea
)) {
670 * If no PMP entry matches the TLB page, the TLB page will also not be
671 * split into regions with different permissions by PMP so we set the size
672 * to TARGET_PAGE_SIZE.
674 return TARGET_PAGE_SIZE
;
678 * Convert PMP privilege to TLB page privilege.
680 int pmp_priv_to_page_prot(pmp_priv_t pmp_priv
)
684 if (pmp_priv
& PMP_READ
) {
687 if (pmp_priv
& PMP_WRITE
) {
690 if (pmp_priv
& PMP_EXEC
) {