xref: /openbmc/qemu/target/riscv/cpu.h (revision 41f2b94e)
1 /*
2  * QEMU RISC-V CPU
3  *
4  * Copyright (c) 2016-2017 Sagar Karandikar, sagark@eecs.berkeley.edu
5  * Copyright (c) 2017-2018 SiFive, Inc.
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms and conditions of the GNU General Public License,
9  * version 2 or later, as published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
14  * more details.
15  *
16  * You should have received a copy of the GNU General Public License along with
17  * this program.  If not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef RISCV_CPU_H
21 #define RISCV_CPU_H
22 
23 #include "hw/core/cpu.h"
24 #include "hw/registerfields.h"
25 #include "hw/qdev-properties.h"
26 #include "exec/cpu-defs.h"
27 #include "qemu/cpu-float.h"
28 #include "qom/object.h"
29 #include "qemu/int128.h"
30 #include "cpu_bits.h"
31 #include "cpu_cfg.h"
32 #include "qapi/qapi-types-common.h"
33 #include "cpu-qom.h"
34 
35 typedef struct CPUArchState CPURISCVState;
36 
37 #define CPU_RESOLVING_TYPE TYPE_RISCV_CPU
38 
39 #if defined(TARGET_RISCV32)
40 # define TYPE_RISCV_CPU_BASE            TYPE_RISCV_CPU_BASE32
41 #elif defined(TARGET_RISCV64)
42 # define TYPE_RISCV_CPU_BASE            TYPE_RISCV_CPU_BASE64
43 #endif
44 
45 #define TCG_GUEST_DEFAULT_MO 0
46 
47 /*
48  * RISC-V-specific extra insn start words:
49  * 1: Original instruction opcode
50  */
51 #define TARGET_INSN_START_EXTRA_WORDS 1
52 
53 #define RV(x) ((target_ulong)1 << (x - 'A'))
54 
55 /*
56  * Update misa_bits[], misa_ext_info_arr[] and misa_ext_cfgs[]
57  * when adding new MISA bits here.
58  */
59 #define RVI RV('I')
60 #define RVE RV('E') /* E and I are mutually exclusive */
61 #define RVM RV('M')
62 #define RVA RV('A')
63 #define RVF RV('F')
64 #define RVD RV('D')
65 #define RVV RV('V')
66 #define RVC RV('C')
67 #define RVS RV('S')
68 #define RVU RV('U')
69 #define RVH RV('H')
70 #define RVJ RV('J')
71 #define RVG RV('G')
72 #define RVB RV('B')
73 
74 extern const uint32_t misa_bits[];
75 const char *riscv_get_misa_ext_name(uint32_t bit);
76 const char *riscv_get_misa_ext_description(uint32_t bit);
77 
78 #define CPU_CFG_OFFSET(_prop) offsetof(struct RISCVCPUConfig, _prop)
79 
80 typedef struct riscv_cpu_profile {
81     struct riscv_cpu_profile *parent;
82     const char *name;
83     uint32_t misa_ext;
84     bool enabled;
85     bool user_set;
86     int priv_spec;
87     int satp_mode;
88     const int32_t ext_offsets[];
89 } RISCVCPUProfile;
90 
91 #define RISCV_PROFILE_EXT_LIST_END -1
92 #define RISCV_PROFILE_ATTR_UNUSED -1
93 
94 extern RISCVCPUProfile *riscv_profiles[];
95 
96 /* Privileged specification version */
97 #define PRIV_VER_1_10_0_STR "v1.10.0"
98 #define PRIV_VER_1_11_0_STR "v1.11.0"
99 #define PRIV_VER_1_12_0_STR "v1.12.0"
100 enum {
101     PRIV_VERSION_1_10_0 = 0,
102     PRIV_VERSION_1_11_0,
103     PRIV_VERSION_1_12_0,
104 
105     PRIV_VERSION_LATEST = PRIV_VERSION_1_12_0,
106 };
107 
108 #define VEXT_VERSION_1_00_0 0x00010000
109 #define VEXT_VER_1_00_0_STR "v1.0"
110 
111 enum {
112     TRANSLATE_SUCCESS,
113     TRANSLATE_FAIL,
114     TRANSLATE_PMP_FAIL,
115     TRANSLATE_G_STAGE_FAIL
116 };
117 
118 /* Extension context status */
119 typedef enum {
120     EXT_STATUS_DISABLED = 0,
121     EXT_STATUS_INITIAL,
122     EXT_STATUS_CLEAN,
123     EXT_STATUS_DIRTY,
124 } RISCVExtStatus;
125 
126 #define MMU_USER_IDX 3
127 
128 #define MAX_RISCV_PMPS (16)
129 
130 #if !defined(CONFIG_USER_ONLY)
131 #include "pmp.h"
132 #include "debug.h"
133 #endif
134 
135 #define RV_VLEN_MAX 1024
136 #define RV_MAX_MHPMEVENTS 32
137 #define RV_MAX_MHPMCOUNTERS 32
138 
139 FIELD(VTYPE, VLMUL, 0, 3)
140 FIELD(VTYPE, VSEW, 3, 3)
141 FIELD(VTYPE, VTA, 6, 1)
142 FIELD(VTYPE, VMA, 7, 1)
143 FIELD(VTYPE, VEDIV, 8, 2)
144 FIELD(VTYPE, RESERVED, 10, sizeof(target_ulong) * 8 - 11)
145 
146 typedef struct PMUCTRState {
147     /* Current value of a counter */
148     target_ulong mhpmcounter_val;
149     /* Current value of a counter in RV32 */
150     target_ulong mhpmcounterh_val;
151     /* Snapshot values of counter */
152     target_ulong mhpmcounter_prev;
153     /* Snapshort value of a counter in RV32 */
154     target_ulong mhpmcounterh_prev;
155     bool started;
156     /* Value beyond UINT32_MAX/UINT64_MAX before overflow interrupt trigger */
157     target_ulong irq_overflow_left;
158 } PMUCTRState;
159 
160 struct CPUArchState {
161     target_ulong gpr[32];
162     target_ulong gprh[32]; /* 64 top bits of the 128-bit registers */
163 
164     /* vector coprocessor state. */
165     uint64_t vreg[32 * RV_VLEN_MAX / 64] QEMU_ALIGNED(16);
166     target_ulong vxrm;
167     target_ulong vxsat;
168     target_ulong vl;
169     target_ulong vstart;
170     target_ulong vtype;
171     bool vill;
172 
173     target_ulong pc;
174     target_ulong load_res;
175     target_ulong load_val;
176 
177     /* Floating-Point state */
178     uint64_t fpr[32]; /* assume both F and D extensions */
179     target_ulong frm;
180     float_status fp_status;
181 
182     target_ulong badaddr;
183     target_ulong bins;
184 
185     target_ulong guest_phys_fault_addr;
186 
187     target_ulong priv_ver;
188     target_ulong vext_ver;
189 
190     /* RISCVMXL, but uint32_t for vmstate migration */
191     uint32_t misa_mxl;      /* current mxl */
192     uint32_t misa_mxl_max;  /* max mxl for this cpu */
193     uint32_t misa_ext;      /* current extensions */
194     uint32_t misa_ext_mask; /* max ext for this cpu */
195     uint32_t xl;            /* current xlen */
196 
197     /* 128-bit helpers upper part return value */
198     target_ulong retxh;
199 
200     target_ulong jvt;
201 
202 #ifdef CONFIG_USER_ONLY
203     uint32_t elf_flags;
204 #endif
205 
206 #ifndef CONFIG_USER_ONLY
207     target_ulong priv;
208     /* This contains QEMU specific information about the virt state. */
209     bool virt_enabled;
210     target_ulong geilen;
211     uint64_t resetvec;
212 
213     target_ulong mhartid;
214     /*
215      * For RV32 this is 32-bit mstatus and 32-bit mstatush.
216      * For RV64 this is a 64-bit mstatus.
217      */
218     uint64_t mstatus;
219 
220     uint64_t mip;
221     /*
222      * MIP contains the software writable version of SEIP ORed with the
223      * external interrupt value. The MIP register is always up-to-date.
224      * To keep track of the current source, we also save booleans of the values
225      * here.
226      */
227     bool external_seip;
228     bool software_seip;
229 
230     uint64_t miclaim;
231 
232     uint64_t mie;
233     uint64_t mideleg;
234 
235     /*
236      * When mideleg[i]=0 and mvien[i]=1, sie[i] is no more
237      * alias of mie[i] and needs to be maintained separately.
238      */
239     uint64_t sie;
240 
241     /*
242      * When hideleg[i]=0 and hvien[i]=1, vsie[i] is no more
243      * alias of sie[i] (mie[i]) and needs to be maintained separately.
244      */
245     uint64_t vsie;
246 
247     target_ulong satp;   /* since: priv-1.10.0 */
248     target_ulong stval;
249     target_ulong medeleg;
250 
251     target_ulong stvec;
252     target_ulong sepc;
253     target_ulong scause;
254 
255     target_ulong mtvec;
256     target_ulong mepc;
257     target_ulong mcause;
258     target_ulong mtval;  /* since: priv-1.10.0 */
259 
260     /* Machine and Supervisor interrupt priorities */
261     uint8_t miprio[64];
262     uint8_t siprio[64];
263 
264     /* AIA CSRs */
265     target_ulong miselect;
266     target_ulong siselect;
267     uint64_t mvien;
268     uint64_t mvip;
269 
270     /* Hypervisor CSRs */
271     target_ulong hstatus;
272     target_ulong hedeleg;
273     uint64_t hideleg;
274     target_ulong hcounteren;
275     target_ulong htval;
276     target_ulong htinst;
277     target_ulong hgatp;
278     target_ulong hgeie;
279     target_ulong hgeip;
280     uint64_t htimedelta;
281     uint64_t hvien;
282 
283     /*
284      * Bits VSSIP, VSTIP and VSEIP in hvip are maintained in mip. Other bits
285      * from 0:12 are reserved. Bits 13:63 are not aliased and must be separately
286      * maintain in hvip.
287      */
288     uint64_t hvip;
289 
290     /* Hypervisor controlled virtual interrupt priorities */
291     target_ulong hvictl;
292     uint8_t hviprio[64];
293 
294     /* Upper 64-bits of 128-bit CSRs */
295     uint64_t mscratchh;
296     uint64_t sscratchh;
297 
298     /* Virtual CSRs */
299     /*
300      * For RV32 this is 32-bit vsstatus and 32-bit vsstatush.
301      * For RV64 this is a 64-bit vsstatus.
302      */
303     uint64_t vsstatus;
304     target_ulong vstvec;
305     target_ulong vsscratch;
306     target_ulong vsepc;
307     target_ulong vscause;
308     target_ulong vstval;
309     target_ulong vsatp;
310 
311     /* AIA VS-mode CSRs */
312     target_ulong vsiselect;
313 
314     target_ulong mtval2;
315     target_ulong mtinst;
316 
317     /* HS Backup CSRs */
318     target_ulong stvec_hs;
319     target_ulong sscratch_hs;
320     target_ulong sepc_hs;
321     target_ulong scause_hs;
322     target_ulong stval_hs;
323     target_ulong satp_hs;
324     uint64_t mstatus_hs;
325 
326     /*
327      * Signals whether the current exception occurred with two-stage address
328      * translation active.
329      */
330     bool two_stage_lookup;
331     /*
332      * Signals whether the current exception occurred while doing two-stage
333      * address translation for the VS-stage page table walk.
334      */
335     bool two_stage_indirect_lookup;
336 
337     target_ulong scounteren;
338     target_ulong mcounteren;
339 
340     target_ulong mcountinhibit;
341 
342     /* PMU counter state */
343     PMUCTRState pmu_ctrs[RV_MAX_MHPMCOUNTERS];
344 
345     /* PMU event selector configured values. First three are unused */
346     target_ulong mhpmevent_val[RV_MAX_MHPMEVENTS];
347 
348     /* PMU event selector configured values for RV32 */
349     target_ulong mhpmeventh_val[RV_MAX_MHPMEVENTS];
350 
351     target_ulong sscratch;
352     target_ulong mscratch;
353 
354     /* Sstc CSRs */
355     uint64_t stimecmp;
356 
357     uint64_t vstimecmp;
358 
359     /* physical memory protection */
360     pmp_table_t pmp_state;
361     target_ulong mseccfg;
362 
363     /* trigger module */
364     target_ulong trigger_cur;
365     target_ulong tdata1[RV_MAX_TRIGGERS];
366     target_ulong tdata2[RV_MAX_TRIGGERS];
367     target_ulong tdata3[RV_MAX_TRIGGERS];
368     struct CPUBreakpoint *cpu_breakpoint[RV_MAX_TRIGGERS];
369     struct CPUWatchpoint *cpu_watchpoint[RV_MAX_TRIGGERS];
370     QEMUTimer *itrigger_timer[RV_MAX_TRIGGERS];
371     int64_t last_icount;
372     bool itrigger_enabled;
373 
374     /* machine specific rdtime callback */
375     uint64_t (*rdtime_fn)(void *);
376     void *rdtime_fn_arg;
377 
378     /* machine specific AIA ireg read-modify-write callback */
379 #define AIA_MAKE_IREG(__isel, __priv, __virt, __vgein, __xlen) \
380     ((((__xlen) & 0xff) << 24) | \
381      (((__vgein) & 0x3f) << 20) | \
382      (((__virt) & 0x1) << 18) | \
383      (((__priv) & 0x3) << 16) | \
384      (__isel & 0xffff))
385 #define AIA_IREG_ISEL(__ireg)                  ((__ireg) & 0xffff)
386 #define AIA_IREG_PRIV(__ireg)                  (((__ireg) >> 16) & 0x3)
387 #define AIA_IREG_VIRT(__ireg)                  (((__ireg) >> 18) & 0x1)
388 #define AIA_IREG_VGEIN(__ireg)                 (((__ireg) >> 20) & 0x3f)
389 #define AIA_IREG_XLEN(__ireg)                  (((__ireg) >> 24) & 0xff)
390     int (*aia_ireg_rmw_fn[4])(void *arg, target_ulong reg,
391         target_ulong *val, target_ulong new_val, target_ulong write_mask);
392     void *aia_ireg_rmw_fn_arg[4];
393 
394     /* True if in debugger mode.  */
395     bool debugger;
396 
397     /*
398      * CSRs for PointerMasking extension
399      */
400     target_ulong mmte;
401     target_ulong mpmmask;
402     target_ulong mpmbase;
403     target_ulong spmmask;
404     target_ulong spmbase;
405     target_ulong upmmask;
406     target_ulong upmbase;
407 
408     /* CSRs for execution environment configuration */
409     uint64_t menvcfg;
410     uint64_t mstateen[SMSTATEEN_MAX_COUNT];
411     uint64_t hstateen[SMSTATEEN_MAX_COUNT];
412     uint64_t sstateen[SMSTATEEN_MAX_COUNT];
413     target_ulong senvcfg;
414     uint64_t henvcfg;
415 #endif
416     target_ulong cur_pmmask;
417     target_ulong cur_pmbase;
418 
419     /* Fields from here on are preserved across CPU reset. */
420     QEMUTimer *stimer; /* Internal timer for S-mode interrupt */
421     QEMUTimer *vstimer; /* Internal timer for VS-mode interrupt */
422     bool vstime_irq;
423 
424     hwaddr kernel_addr;
425     hwaddr fdt_addr;
426 
427 #ifdef CONFIG_KVM
428     /* kvm timer */
429     bool kvm_timer_dirty;
430     uint64_t kvm_timer_time;
431     uint64_t kvm_timer_compare;
432     uint64_t kvm_timer_state;
433     uint64_t kvm_timer_frequency;
434 #endif /* CONFIG_KVM */
435 };
436 
437 /*
438  * RISCVCPU:
439  * @env: #CPURISCVState
440  *
441  * A RISCV CPU.
442  */
443 struct ArchCPU {
444     CPUState parent_obj;
445 
446     CPURISCVState env;
447 
448     char *dyn_csr_xml;
449     char *dyn_vreg_xml;
450 
451     /* Configuration Settings */
452     RISCVCPUConfig cfg;
453 
454     QEMUTimer *pmu_timer;
455     /* A bitmask of Available programmable counters */
456     uint32_t pmu_avail_ctrs;
457     /* Mapping of events to counters */
458     GHashTable *pmu_event_ctr_map;
459 };
460 
461 /**
462  * RISCVCPUClass:
463  * @parent_realize: The parent class' realize handler.
464  * @parent_phases: The parent class' reset phase handlers.
465  *
466  * A RISCV CPU model.
467  */
468 struct RISCVCPUClass {
469     CPUClass parent_class;
470 
471     DeviceRealize parent_realize;
472     ResettablePhases parent_phases;
473 };
474 
475 static inline int riscv_has_ext(CPURISCVState *env, target_ulong ext)
476 {
477     return (env->misa_ext & ext) != 0;
478 }
479 
480 #include "cpu_user.h"
481 
482 extern const char * const riscv_int_regnames[];
483 extern const char * const riscv_int_regnamesh[];
484 extern const char * const riscv_fpr_regnames[];
485 
486 const char *riscv_cpu_get_trap_name(target_ulong cause, bool async);
487 void riscv_cpu_do_interrupt(CPUState *cpu);
488 int riscv_cpu_write_elf64_note(WriteCoreDumpFunction f, CPUState *cs,
489                                int cpuid, DumpState *s);
490 int riscv_cpu_write_elf32_note(WriteCoreDumpFunction f, CPUState *cs,
491                                int cpuid, DumpState *s);
492 int riscv_cpu_gdb_read_register(CPUState *cpu, GByteArray *buf, int reg);
493 int riscv_cpu_gdb_write_register(CPUState *cpu, uint8_t *buf, int reg);
494 int riscv_cpu_hviprio_index2irq(int index, int *out_irq, int *out_rdzero);
495 uint8_t riscv_cpu_default_priority(int irq);
496 uint64_t riscv_cpu_all_pending(CPURISCVState *env);
497 int riscv_cpu_mirq_pending(CPURISCVState *env);
498 int riscv_cpu_sirq_pending(CPURISCVState *env);
499 int riscv_cpu_vsirq_pending(CPURISCVState *env);
500 bool riscv_cpu_fp_enabled(CPURISCVState *env);
501 target_ulong riscv_cpu_get_geilen(CPURISCVState *env);
502 void riscv_cpu_set_geilen(CPURISCVState *env, target_ulong geilen);
503 bool riscv_cpu_vector_enabled(CPURISCVState *env);
504 void riscv_cpu_set_virt_enabled(CPURISCVState *env, bool enable);
505 int riscv_env_mmu_index(CPURISCVState *env, bool ifetch);
506 G_NORETURN void  riscv_cpu_do_unaligned_access(CPUState *cs, vaddr addr,
507                                                MMUAccessType access_type,
508                                                int mmu_idx, uintptr_t retaddr);
509 bool riscv_cpu_tlb_fill(CPUState *cs, vaddr address, int size,
510                         MMUAccessType access_type, int mmu_idx,
511                         bool probe, uintptr_t retaddr);
512 char *riscv_isa_string(RISCVCPU *cpu);
513 
514 #ifndef CONFIG_USER_ONLY
515 void riscv_cpu_do_transaction_failed(CPUState *cs, hwaddr physaddr,
516                                      vaddr addr, unsigned size,
517                                      MMUAccessType access_type,
518                                      int mmu_idx, MemTxAttrs attrs,
519                                      MemTxResult response, uintptr_t retaddr);
520 hwaddr riscv_cpu_get_phys_page_debug(CPUState *cpu, vaddr addr);
521 bool riscv_cpu_exec_interrupt(CPUState *cs, int interrupt_request);
522 void riscv_cpu_swap_hypervisor_regs(CPURISCVState *env);
523 int riscv_cpu_claim_interrupts(RISCVCPU *cpu, uint64_t interrupts);
524 uint64_t riscv_cpu_update_mip(CPURISCVState *env, uint64_t mask,
525                               uint64_t value);
526 void riscv_cpu_interrupt(CPURISCVState *env);
527 #define BOOL_TO_MASK(x) (-!!(x)) /* helper for riscv_cpu_update_mip value */
528 void riscv_cpu_set_rdtime_fn(CPURISCVState *env, uint64_t (*fn)(void *),
529                              void *arg);
530 void riscv_cpu_set_aia_ireg_rmw_fn(CPURISCVState *env, uint32_t priv,
531                                    int (*rmw_fn)(void *arg,
532                                                  target_ulong reg,
533                                                  target_ulong *val,
534                                                  target_ulong new_val,
535                                                  target_ulong write_mask),
536                                    void *rmw_fn_arg);
537 
538 RISCVException smstateen_acc_ok(CPURISCVState *env, int index, uint64_t bit);
539 #endif
540 void riscv_cpu_set_mode(CPURISCVState *env, target_ulong newpriv);
541 
542 void riscv_translate_init(void);
543 G_NORETURN void riscv_raise_exception(CPURISCVState *env,
544                                       uint32_t exception, uintptr_t pc);
545 
546 target_ulong riscv_cpu_get_fflags(CPURISCVState *env);
547 void riscv_cpu_set_fflags(CPURISCVState *env, target_ulong);
548 
549 #include "exec/cpu-all.h"
550 
551 FIELD(TB_FLAGS, MEM_IDX, 0, 3)
552 FIELD(TB_FLAGS, FS, 3, 2)
553 /* Vector flags */
554 FIELD(TB_FLAGS, VS, 5, 2)
555 FIELD(TB_FLAGS, LMUL, 7, 3)
556 FIELD(TB_FLAGS, SEW, 10, 3)
557 FIELD(TB_FLAGS, VL_EQ_VLMAX, 13, 1)
558 FIELD(TB_FLAGS, VILL, 14, 1)
559 FIELD(TB_FLAGS, VSTART_EQ_ZERO, 15, 1)
560 /* The combination of MXL/SXL/UXL that applies to the current cpu mode. */
561 FIELD(TB_FLAGS, XL, 16, 2)
562 /* If PointerMasking should be applied */
563 FIELD(TB_FLAGS, PM_MASK_ENABLED, 18, 1)
564 FIELD(TB_FLAGS, PM_BASE_ENABLED, 19, 1)
565 FIELD(TB_FLAGS, VTA, 20, 1)
566 FIELD(TB_FLAGS, VMA, 21, 1)
567 /* Native debug itrigger */
568 FIELD(TB_FLAGS, ITRIGGER, 22, 1)
569 /* Virtual mode enabled */
570 FIELD(TB_FLAGS, VIRT_ENABLED, 23, 1)
571 FIELD(TB_FLAGS, PRIV, 24, 2)
572 FIELD(TB_FLAGS, AXL, 26, 2)
573 
574 #ifdef TARGET_RISCV32
575 #define riscv_cpu_mxl(env)  ((void)(env), MXL_RV32)
576 #else
577 static inline RISCVMXL riscv_cpu_mxl(CPURISCVState *env)
578 {
579     return env->misa_mxl;
580 }
581 #endif
582 #define riscv_cpu_mxl_bits(env) (1UL << (4 + riscv_cpu_mxl(env)))
583 
584 static inline const RISCVCPUConfig *riscv_cpu_cfg(CPURISCVState *env)
585 {
586     return &env_archcpu(env)->cfg;
587 }
588 
589 #if !defined(CONFIG_USER_ONLY)
590 static inline int cpu_address_mode(CPURISCVState *env)
591 {
592     int mode = env->priv;
593 
594     if (mode == PRV_M && get_field(env->mstatus, MSTATUS_MPRV)) {
595         mode = get_field(env->mstatus, MSTATUS_MPP);
596     }
597     return mode;
598 }
599 
600 static inline RISCVMXL cpu_get_xl(CPURISCVState *env, target_ulong mode)
601 {
602     RISCVMXL xl = env->misa_mxl;
603     /*
604      * When emulating a 32-bit-only cpu, use RV32.
605      * When emulating a 64-bit cpu, and MXL has been reduced to RV32,
606      * MSTATUSH doesn't have UXL/SXL, therefore XLEN cannot be widened
607      * back to RV64 for lower privs.
608      */
609     if (xl != MXL_RV32) {
610         switch (mode) {
611         case PRV_M:
612             break;
613         case PRV_U:
614             xl = get_field(env->mstatus, MSTATUS64_UXL);
615             break;
616         default: /* PRV_S */
617             xl = get_field(env->mstatus, MSTATUS64_SXL);
618             break;
619         }
620     }
621     return xl;
622 }
623 #endif
624 
625 #if defined(TARGET_RISCV32)
626 #define cpu_recompute_xl(env)  ((void)(env), MXL_RV32)
627 #else
628 static inline RISCVMXL cpu_recompute_xl(CPURISCVState *env)
629 {
630 #if !defined(CONFIG_USER_ONLY)
631     return cpu_get_xl(env, env->priv);
632 #else
633     return env->misa_mxl;
634 #endif
635 }
636 #endif
637 
638 #if defined(TARGET_RISCV32)
639 #define cpu_address_xl(env)  ((void)(env), MXL_RV32)
640 #else
641 static inline RISCVMXL cpu_address_xl(CPURISCVState *env)
642 {
643 #ifdef CONFIG_USER_ONLY
644     return env->xl;
645 #else
646     int mode = cpu_address_mode(env);
647 
648     return cpu_get_xl(env, mode);
649 #endif
650 }
651 #endif
652 
653 static inline int riscv_cpu_xlen(CPURISCVState *env)
654 {
655     return 16 << env->xl;
656 }
657 
658 #ifdef TARGET_RISCV32
659 #define riscv_cpu_sxl(env)  ((void)(env), MXL_RV32)
660 #else
661 static inline RISCVMXL riscv_cpu_sxl(CPURISCVState *env)
662 {
663 #ifdef CONFIG_USER_ONLY
664     return env->misa_mxl;
665 #else
666     return get_field(env->mstatus, MSTATUS64_SXL);
667 #endif
668 }
669 #endif
670 
671 /*
672  * Encode LMUL to lmul as follows:
673  *     LMUL    vlmul    lmul
674  *      1       000       0
675  *      2       001       1
676  *      4       010       2
677  *      8       011       3
678  *      -       100       -
679  *     1/8      101      -3
680  *     1/4      110      -2
681  *     1/2      111      -1
682  *
683  * then, we can calculate VLMAX = vlen >> (vsew + 3 - lmul)
684  * e.g. vlen = 256 bits, SEW = 16, LMUL = 1/8
685  *      => VLMAX = vlen >> (1 + 3 - (-3))
686  *               = 256 >> 7
687  *               = 2
688  */
689 static inline uint32_t vext_get_vlmax(RISCVCPU *cpu, target_ulong vtype)
690 {
691     uint8_t sew = FIELD_EX64(vtype, VTYPE, VSEW);
692     int8_t lmul = sextract32(FIELD_EX64(vtype, VTYPE, VLMUL), 0, 3);
693     return cpu->cfg.vlen >> (sew + 3 - lmul);
694 }
695 
696 void cpu_get_tb_cpu_state(CPURISCVState *env, vaddr *pc,
697                           uint64_t *cs_base, uint32_t *pflags);
698 
699 void riscv_cpu_update_mask(CPURISCVState *env);
700 bool riscv_cpu_is_32bit(RISCVCPU *cpu);
701 
702 RISCVException riscv_csrrw(CPURISCVState *env, int csrno,
703                            target_ulong *ret_value,
704                            target_ulong new_value, target_ulong write_mask);
705 RISCVException riscv_csrrw_debug(CPURISCVState *env, int csrno,
706                                  target_ulong *ret_value,
707                                  target_ulong new_value,
708                                  target_ulong write_mask);
709 
710 static inline void riscv_csr_write(CPURISCVState *env, int csrno,
711                                    target_ulong val)
712 {
713     riscv_csrrw(env, csrno, NULL, val, MAKE_64BIT_MASK(0, TARGET_LONG_BITS));
714 }
715 
716 static inline target_ulong riscv_csr_read(CPURISCVState *env, int csrno)
717 {
718     target_ulong val = 0;
719     riscv_csrrw(env, csrno, &val, 0, 0);
720     return val;
721 }
722 
723 typedef RISCVException (*riscv_csr_predicate_fn)(CPURISCVState *env,
724                                                  int csrno);
725 typedef RISCVException (*riscv_csr_read_fn)(CPURISCVState *env, int csrno,
726                                             target_ulong *ret_value);
727 typedef RISCVException (*riscv_csr_write_fn)(CPURISCVState *env, int csrno,
728                                              target_ulong new_value);
729 typedef RISCVException (*riscv_csr_op_fn)(CPURISCVState *env, int csrno,
730                                           target_ulong *ret_value,
731                                           target_ulong new_value,
732                                           target_ulong write_mask);
733 
734 RISCVException riscv_csrrw_i128(CPURISCVState *env, int csrno,
735                                 Int128 *ret_value,
736                                 Int128 new_value, Int128 write_mask);
737 
738 typedef RISCVException (*riscv_csr_read128_fn)(CPURISCVState *env, int csrno,
739                                                Int128 *ret_value);
740 typedef RISCVException (*riscv_csr_write128_fn)(CPURISCVState *env, int csrno,
741                                              Int128 new_value);
742 
743 typedef struct {
744     const char *name;
745     riscv_csr_predicate_fn predicate;
746     riscv_csr_read_fn read;
747     riscv_csr_write_fn write;
748     riscv_csr_op_fn op;
749     riscv_csr_read128_fn read128;
750     riscv_csr_write128_fn write128;
751     /* The default priv spec version should be PRIV_VERSION_1_10_0 (i.e 0) */
752     uint32_t min_priv_ver;
753 } riscv_csr_operations;
754 
755 /* CSR function table constants */
756 enum {
757     CSR_TABLE_SIZE = 0x1000
758 };
759 
760 /*
761  * The event id are encoded based on the encoding specified in the
762  * SBI specification v0.3
763  */
764 
765 enum riscv_pmu_event_idx {
766     RISCV_PMU_EVENT_HW_CPU_CYCLES = 0x01,
767     RISCV_PMU_EVENT_HW_INSTRUCTIONS = 0x02,
768     RISCV_PMU_EVENT_CACHE_DTLB_READ_MISS = 0x10019,
769     RISCV_PMU_EVENT_CACHE_DTLB_WRITE_MISS = 0x1001B,
770     RISCV_PMU_EVENT_CACHE_ITLB_PREFETCH_MISS = 0x10021,
771 };
772 
773 /* used by tcg/tcg-cpu.c*/
774 void isa_ext_update_enabled(RISCVCPU *cpu, uint32_t ext_offset, bool en);
775 bool isa_ext_is_enabled(RISCVCPU *cpu, uint32_t ext_offset);
776 void riscv_cpu_set_misa(CPURISCVState *env, RISCVMXL mxl, uint32_t ext);
777 bool riscv_cpu_is_vendor(Object *cpu_obj);
778 
779 typedef struct RISCVCPUMultiExtConfig {
780     const char *name;
781     uint32_t offset;
782     bool enabled;
783 } RISCVCPUMultiExtConfig;
784 
785 extern const RISCVCPUMultiExtConfig riscv_cpu_extensions[];
786 extern const RISCVCPUMultiExtConfig riscv_cpu_vendor_exts[];
787 extern const RISCVCPUMultiExtConfig riscv_cpu_experimental_exts[];
788 extern const RISCVCPUMultiExtConfig riscv_cpu_named_features[];
789 extern const RISCVCPUMultiExtConfig riscv_cpu_deprecated_exts[];
790 extern Property riscv_cpu_options[];
791 
792 typedef struct isa_ext_data {
793     const char *name;
794     int min_version;
795     int ext_enable_offset;
796 } RISCVIsaExtData;
797 extern const RISCVIsaExtData isa_edata_arr[];
798 char *riscv_cpu_get_name(RISCVCPU *cpu);
799 
800 void riscv_cpu_finalize_features(RISCVCPU *cpu, Error **errp);
801 void riscv_add_satp_mode_properties(Object *obj);
802 bool riscv_cpu_accelerator_compatible(RISCVCPU *cpu);
803 
804 /* CSR function table */
805 extern riscv_csr_operations csr_ops[CSR_TABLE_SIZE];
806 
807 extern const bool valid_vm_1_10_32[], valid_vm_1_10_64[];
808 
809 void riscv_get_csr_ops(int csrno, riscv_csr_operations *ops);
810 void riscv_set_csr_ops(int csrno, riscv_csr_operations *ops);
811 
812 void riscv_cpu_register_gdb_regs_for_features(CPUState *cs);
813 
814 uint8_t satp_mode_max_from_map(uint32_t map);
815 const char *satp_mode_str(uint8_t satp_mode, bool is_32_bit);
816 
817 #endif /* RISCV_CPU_H */
818