Use enum instead of string

Fix riscv#1370 (comment)

Signed-off-by: Ariel Xiong <[email protected]>

Author: Arielfoever

c_emulator/riscv_callbacks.cpp

@@ -142,7 +142,7 @@ unit ptw_success_callback(uint64_t final_ppn, sail_int level)
   return UNIT;
 }
 
-unit ptw_fail_callback(const char *error_type, sail_int level, sbits pte_addr)
+unit ptw_fail_callback(struct zPTW_Error error_type, sail_int level, sbits pte_addr)
 {
   for (auto c : callbacks) {
     c->ptw_fail_callback(error_type, level, pte_addr);

c_emulator/riscv_callbacks.h

@@ -30,7 +30,7 @@ unit trap_callback(bool is_interrupt, fbits cause);
 unit ptw_start_callback(uint64_t vpn, struct zMemoryAccessTypezIuzK access_type,enum zPrivilege privilege);
 unit ptw_step_callback(sail_int level, sbits pte_addr, uint64_t pte);
 unit ptw_success_callback(uint64_t final_ppn, sail_int level);
-unit ptw_fail_callback(const char *error_type, sail_int level, sbits pte_addr);
+unit ptw_fail_callback(struct zPTW_Error error_type, sail_int level, sbits pte_addr);
 
 #ifdef __cplusplus
 }

c_emulator/riscv_callbacks_if.h

@@ -40,9 +40,7 @@ class callbacks_if {
   virtual void ptw_step_callback(sail_int level, sbits pte_addr, uint64_t pte)
       = 0;
   virtual void ptw_success_callback(uint64_t final_ppn, sail_int level) = 0;
-  virtual void ptw_fail_callback(const char *error_type, sail_int level,
-                                 sbits pte_addr)
-      = 0;
+  virtual void ptw_fail_callback(struct zPTW_Error error_type, sail_int level, sbits pte_addr)= 0;
 };
 
 void register_callback(callbacks_if *cb);

c_emulator/riscv_callbacks_log.cpp

@@ -154,12 +154,12 @@ void log_callbacks::ptw_success_callback(uint64_t final_ppn, sail_int /*level*/)
   }
 }
 
-void log_callbacks::ptw_fail_callback(const char *error_type,
-                                      sail_int /*level*/, sbits pte_addr)
+void log_callbacks::ptw_fail_callback(struct zPTW_Error error_type, sail_int /*level*/, sbits pte_addr)
 {
   // failed trace is always available
   if (trace_log != nullptr) {
-    fprintf(trace_log, "PTW: failed, error=%s, pte_addr=0x%" PRIX64 "\n",
-            error_type, pte_addr.bits);
+    sail_string str_et;
+    zptw_error_to_str(&str_et,error_type);
+    fprintf(trace_log, "PTW: failed, error=%s, pte_addr=0x%" PRIX64 "\n", str_et, pte_addr.bits);
   }
 }

c_emulator/riscv_callbacks_log.h

@@ -32,8 +32,7 @@ class log_callbacks : public callbacks_if {
   void ptw_start_callback(uint64_t vpn, struct zMemoryAccessTypezIuzK access_type,enum zPrivilege privilege) override;
   void ptw_step_callback(sail_int level, sbits pte_addr, uint64_t pte) override;
   void ptw_success_callback(uint64_t final_ppn, sail_int level) override;
-  void ptw_fail_callback(const char *error_type, sail_int level,
-                         sbits pte_addr) override;
+  void ptw_fail_callback(struct zPTW_Error error_type, sail_int /*level*/, sbits pte_addr) override;
 
 private:
   bool config_print_reg;

c_emulator/riscv_callbacks_rvfi.cpp

@@ -80,7 +80,7 @@ void rvfi_callbacks::trap_callback(bool is_interrupt, fbits cause)
 
 // Page table walk callback
 
-void rvfi_callbacks::ptw_start_callback(uint64_t vpn, struct zMemoryAccessTypezIuzK access_type,enum zPrivilege privilege)
+void rvfi_callbacks::ptw_start_callback(uint64_t /*vpn*/, struct zMemoryAccessTypezIuzK /*access_type*/,enum zPrivilege /*privilege*/)
 {
 }
 
@@ -94,7 +94,6 @@ void rvfi_callbacks::ptw_success_callback(uint64_t /*final_ppn*/,
 {
 }
 
-void rvfi_callbacks::ptw_fail_callback(const char * /*error_type*/,
-                                       sail_int /*level*/, sbits /*pte_addr*/)
+void rvfi_callbacks::ptw_fail_callback(struct zPTW_Error /*error_type*/, sail_int /*level*/, sbits /*pte_addr*/)
 {
 }

c_emulator/riscv_callbacks_rvfi.h

@@ -27,8 +27,7 @@ class rvfi_callbacks : public callbacks_if {
   void ptw_start_callback(uint64_t vpn, struct zMemoryAccessTypezIuzK access_type,enum zPrivilege privilege) override;
   void ptw_step_callback(sail_int level, sbits pte_addr, uint64_t pte) override;
   void ptw_success_callback(uint64_t final_ppn, sail_int level) override;
-  void ptw_fail_callback(const char *error_type, sail_int level,
-                         sbits pte_addr) override;
+  void ptw_fail_callback(struct zPTW_Error error_type, sail_int /*level*/, sbits pte_addr) override;
 };
 
 extern "C" {

model/CMakeLists.txt

@@ -118,6 +118,7 @@ add_custom_command(
         --c-preserve rvfi_mem_exception
         --c-preserve rvfi_wX
         --c-preserve rvfi_trap
+        --c-preserve ptw_error_to_str
         # Input files.
         ${SAIL_MODULES}
         ${project_file}

model/core/callbacks.sail

@@ -83,16 +83,3 @@ function long_csr_write_callback(name : string, name_high : string, value : bits
   if xlen == 32
   then csr_write_callback(name_high, value[63 .. 32]);
 }
-
-// Page table walk callback
-val ptw_start_callback = pure {c: "ptw_start_callback"} : (/* vpn */ bits(64), /* access type */ MemoryAccessType(ext_access_type), /* privilege */ Privilege) -> unit
-function ptw_start_callback(_) = ()
-
-val ptw_step_callback = pure {c: "ptw_step_callback"} : (/* level */ int, /* pte_addr */ physaddrbits, /* pte */ bits(64)) -> unit
-function ptw_step_callback(_) = ()
-
-val ptw_success_callback = pure {c: "ptw_success_callback"} : (/* final_ppn */ bits(64), /* level */ int) -> unit
-function ptw_success_callback(_) = ()
-
-val ptw_fail_callback = pure {c: "ptw_fail_callback"} : (/* error_type */ string, /* level */ int, /* pte_addr */ physaddrbits) -> unit
-function ptw_fail_callback(_) = ()

model/riscv.sail_project

@@ -64,10 +64,11 @@ sys {
     sys/inst_retire.sail,
     sys/vmem_pte.sail,
     sys/vmem_ptw.sail,
+    sys/callbacks.sail,
     sys/vmem_tlb.sail,
     sys/vmem.sail,
     sys/vmem_utils.sail,
-    sys/insts_begin.sail,
+    sys/insts_begin.sail,    
 }
 
 extensions {