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