1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
use std::ops::Index;

use once_cell::sync::Lazy;
use RV32IInstruction::*;

use super::simulator::*;
use crate::{
    interface::assembler::Operand,
    modules::riscv::{basic::interface::parser::RISCV, rv32i::constants::*},
    utility::{enum_map::EnumMap, ptr::Ptr},
};

type InstHandler = fn(InstHandlerArg) -> Result<SimulatorStatus, String>;
pub(super) struct InstHandlerArg<'a> {
    pub sim: Ptr<RISCVSimulator>,
    pub args: &'a Vec<Operand<RISCV>>,
    pub history: Ptr<History>,
}

pub(super) static INST_HANDLER_MAP: Lazy<EnumMap<RV32IInstruction, InstHandler>> =
    Lazy::new(|| {
        EnumMap::new(
            &[
                (Add, add_handler as InstHandler),
                (Addi, addi_handler as InstHandler),
                (And, and_handler as InstHandler),
                (Andi, andi_handler as InstHandler),
                (Auipc, auipc_handler as InstHandler),
                (Beq, beq_handler as InstHandler),
                (Bge, bge_handler as InstHandler),
                (Bgeu, bgeu_handler as InstHandler),
                (Blt, blt_handler as InstHandler),
                (Bltu, bltu_handler as InstHandler),
                (Bne, bne_handler as InstHandler),
                (Csrrc, csrrc_handler as InstHandler),
                (Csrrci, csrrci_handler as InstHandler),
                (Csrrs, csrrs_handler as InstHandler),
                (Csrrsi, csrrsi_handler as InstHandler),
                (Csrrs, csrrs_handler as InstHandler),
                (Csrrsi, csrrsi_handler as InstHandler),
                (Csrrw, csrrw_handler as InstHandler),
                (Csrrwi, csrrwi_handler as InstHandler),
                (Ebreak, ebreak_handler as InstHandler),
                (Ecall, ecall_handler as InstHandler),
                (Fence, fence_handler as InstHandler),
                (FenceI, fence_i_handler as InstHandler),
                (Jal, jal_handler as InstHandler),
                (Jalr, jalr_handler as InstHandler),
                (Lb, lb_handler as InstHandler),
                (Lbu, lbu_handler as InstHandler),
                (Lh, lh_handler as InstHandler),
                (Lhu, lhu_handler as InstHandler),
                (Lui, lui_handler as InstHandler),
                (Lw, lw_handler as InstHandler),
                (Or, or_handler as InstHandler),
                (Ori, ori_handler as InstHandler),
                (Sb, sb_handler as InstHandler),
                (Sh, sh_handler as InstHandler),
                (Sll, sll_handler as InstHandler),
                (Slli, slli_handler as InstHandler),
                (Slt, slt_handler as InstHandler),
                (Slti, slti_handler as InstHandler),
                (Sltiu, sltiu_handler as InstHandler),
                (Sltu, sltu_handler as InstHandler),
                (Sra, sra_handler as InstHandler),
                (Srai, srai_handler as InstHandler),
                (Srl, srl_handler as InstHandler),
                (Srli, srli_handler as InstHandler),
                (Sub, sub_handler as InstHandler),
                (Sw, sw_handler as InstHandler),
                (Xor, xor_handler as InstHandler),
                (Xori, xori_handler as InstHandler),
            ],
            |ele| (ele.0, ele.1),
        )
    });

static FAKE_ZERO: Lazy<u32> = Lazy::new(|| 0);
static FAKE_ZERO_PTR: Lazy<Ptr<u32>> = Lazy::new(|| Ptr::new(&FAKE_ZERO));

macro_rules! load_helper {
    ($arg:expr, $size:expr, $t:ty) => {{
        let addr = $arg.reg($arg[2]) + $arg[1] as u32;
        let sim = $arg.sim.as_ref();
        if sim.in_data_segment(addr, $size) || sim.in_stack_segment(addr, $size) {
            let mut buf = [0u8; $size];
            for i in 0..$size {
                buf[i] = sim.mem[addr + i as u32];
            }
            *$arg.reg_mut($arg[0]) = unsafe { std::mem::transmute::<_, $t>(buf) as u32 };
            $arg.pc_step();
            Ok(SimulatorStatus::Running)
        } else {
            Err("Invalid memory access".to_string())
        }
    }};
}

macro_rules! store_helper {
    ($arg:expr, $size:expr, $t:ty) => {{
        let addr = $arg.reg($arg[2]) + $arg[1] as u32;
        let sim = $arg.sim.as_mut();
        if sim.in_data_segment(addr, $size) || sim.in_stack_segment(addr, $size) {
            let history = $arg.history.as_mut();
            history.mem_addr = addr;
            history.mem_len = $size;
            let mut buf = ($arg.reg($arg[0]) as $t).to_le_bytes();
            for i in 0..$size {
                history.mem[i] = sim.mem[addr + i as u32];
                sim.mem[addr + i as u32] = buf[i];
            }
            $arg.pc_step();
            Ok(SimulatorStatus::Running)
        } else {
            Err("Invalid memory access".to_string())
        }
    }};
}

pub(super) fn add_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) + arg.reg(arg[2]);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn addi_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) + arg[2] as u32;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn and_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) & arg.reg(arg[2]);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn andi_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) & arg[2] as u32;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn auipc_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.pc() + ((arg[1] as u32) << 12);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn beq_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    if arg.reg(arg[0]) == arg.reg(arg[1]) {
        jump_offset_helper(&arg, arg[2] as u32)?;
    } else {
        arg.pc_step();
    }
    Ok(SimulatorStatus::Running)
}

pub(super) fn bge_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    if arg.reg(arg[0]) as i32 >= arg.reg(arg[1]) as i32 {
        jump_offset_helper(&arg, arg[2] as u32)?;
    } else {
        arg.pc_step();
    }
    Ok(SimulatorStatus::Running)
}

pub(super) fn bgeu_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    if arg.reg(arg[0]) >= arg.reg(arg[1]) {
        jump_offset_helper(&arg, arg[2] as u32)?;
    } else {
        arg.pc_step();
    }
    Ok(SimulatorStatus::Running)
}

pub(super) fn blt_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    if (arg.reg(arg[0]) as i32) < (arg.reg(arg[1]) as i32) {
        jump_offset_helper(&arg, arg[2] as u32)?;
    } else {
        arg.pc_step();
    }
    Ok(SimulatorStatus::Running)
}

pub(super) fn bltu_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    if arg.reg(arg[0]) < arg.reg(arg[1]) {
        jump_offset_helper(&arg, arg[2] as u32)?;
    } else {
        arg.pc_step();
    }
    Ok(SimulatorStatus::Running)
}

pub(super) fn bne_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    if arg.reg(arg[0]) != arg.reg(arg[1]) {
        jump_offset_helper(&arg, arg[2] as u32)?;
    } else {
        arg.pc_step();
    }
    Ok(SimulatorStatus::Running)
}

pub(super) fn csrrc_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    unimplemented!();
}

pub(super) fn csrrci_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    unimplemented!();
}

pub(super) fn csrrs_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    unimplemented!();
}

pub(super) fn csrrsi_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    unimplemented!();
}

pub(super) fn csrrw_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    unimplemented!();
}

pub(super) fn csrrwi_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    unimplemented!();
}

pub(super) fn ebreak_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    arg.pc_step();
    Ok(SimulatorStatus::Paused)
}

pub(super) fn ecall_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    match arg.reg(RV32IRegister::A7 as i32) {
        1 => {
            arg.output(&((arg.reg(RV32IRegister::A0 as i32) as i32).to_string()))?;
            arg.pc_step();
            Ok(SimulatorStatus::Running)
        }
        4 => {
            let addr = arg.reg(RV32IRegister::A0 as i32);
            let sim = arg.sim.as_ref();
            let mut buf = Vec::new();
            for i in 0.. {
                let byte = sim.mem[addr + i as u32];
                if byte == 0 {
                    break;
                }
                buf.push(byte);
            }
            let s = String::from_utf8(buf).unwrap();
            arg.output(&s)?;
            arg.pc_step();
            Ok(SimulatorStatus::Running)
        }
        5 => {
            arg.request_input(WaitStatus::Int)?;
            Ok(SimulatorStatus::Paused)
        }
        8 => {
            arg.request_input(WaitStatus::String)?;
            Ok(SimulatorStatus::Paused)
        }
        10 => Ok(SimulatorStatus::Stopped),
        11 => {
            arg.output(&((arg.reg(RV32IRegister::A0 as i32) as u8 as char).to_string()))?;
            arg.pc_step();
            Ok(SimulatorStatus::Running)
        }
        12 => {
            arg.request_input(WaitStatus::Char)?;
            Ok(SimulatorStatus::Paused)
        }
        34 => {
            arg.output(&format!(
                "0x{:08x}",
                arg.sim.as_ref().reg[RV32IRegister::A0 as usize]
            ))?;
            arg.pc_step();
            Ok(SimulatorStatus::Running)
        }
        35 => {
            arg.output(&format!(
                "0b{:032b}",
                arg.sim.as_ref().reg[RV32IRegister::A0 as usize]
            ))?;
            arg.pc_step();
            Ok(SimulatorStatus::Running)
        }
        36 => {
            arg.output(&((arg.reg(RV32IRegister::A0 as i32)).to_string()))?;
            arg.pc_step();
            Ok(SimulatorStatus::Running)
        }
        _ => Err("Invalid ecall number".to_string()),
    }
}

pub(super) fn fence_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn fence_i_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn jal_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    let pc = arg.pc();
    jump_helper(&arg, pc + arg[1] as u32)?;
    *arg.reg_mut(arg[0]) = pc + 4;
    Ok(SimulatorStatus::Running)
}

pub(super) fn jalr_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.pc() + 4;
    jump_helper(&arg, (arg.reg(arg[1]) + arg[2] as u32) & !1)?;
    Ok(SimulatorStatus::Running)
}

pub(super) fn lb_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    load_helper!(arg, 1, i8)
}

pub(super) fn lbu_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    load_helper!(arg, 1, u8)
}

pub(super) fn lh_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    load_helper!(arg, 2, i16)
}

pub(super) fn lhu_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    load_helper!(arg, 2, u16)
}

pub(super) fn lui_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = (arg[1] as u32) << 12;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn lw_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    load_helper!(arg, 4, u32)
}

pub(super) fn or_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) | arg.reg(arg[2]);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn ori_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) | arg[2] as u32;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn sb_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    store_helper!(arg, 1, u8)
}

pub(super) fn sh_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    store_helper!(arg, 2, u16)
}

pub(super) fn sll_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) << (arg.reg(arg[2]) & 0x1f);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn slli_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) << arg[2];
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn slt_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = if (arg.reg(arg[1]) as i32) < (arg.reg(arg[2]) as i32) {
        1
    } else {
        0
    };
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn slti_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = if (arg.reg(arg[1]) as i32) < arg[2] as i32 {
        1
    } else {
        0
    };
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn sltiu_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = if arg.reg(arg[1]) < arg[2] as u32 {
        1
    } else {
        0
    };
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn sltu_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = if arg.reg(arg[1]) < arg.reg(arg[2]) {
        1
    } else {
        0
    };
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn sra_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = (arg.reg(arg[1]) as i32 >> (arg.reg(arg[2]) & 0x1f)) as u32;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn srai_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = (arg.reg(arg[1]) as i32 >> arg[2] as i32) as u32;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn srl_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) >> (arg.reg(arg[2]) & 0x1f);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn srli_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) >> arg[2];
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn sub_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) - arg.reg(arg[2]);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn sw_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    store_helper!(arg, 4, u32)
}

pub(super) fn xor_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) ^ arg.reg(arg[2]);
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

pub(super) fn xori_handler(arg: InstHandlerArg) -> Result<SimulatorStatus, String> {
    *arg.reg_mut(arg[0]) = arg.reg(arg[1]) ^ arg[2] as u32;
    arg.pc_step();
    Ok(SimulatorStatus::Running)
}

fn jump_helper(arg: &InstHandlerArg, addr: u32) -> Result<(), String> {
    if arg.set_pc(addr) {
        Ok(())
    } else {
        Err("Invalid aim pc".to_string())
    }
}

fn jump_offset_helper(arg: &InstHandlerArg, offset: u32) -> Result<(), String> {
    jump_helper(arg, arg.pc() + offset)
}

impl<'a> Index<usize> for InstHandlerArg<'a> {
    type Output = Operand<RISCV>;

    fn index(&self, index: usize) -> &Self::Output {
        &self.args[index]
    }
}

impl<'a> InstHandlerArg<'a> {
    fn reg(&self, index: Operand<RISCV>) -> u32 {
        self.sim.as_ref().reg[index as usize]
    }

    fn reg_mut(&self, index: Operand<RISCV>) -> &mut u32 {
        if index == 0 {
            return FAKE_ZERO_PTR.as_mut();
        }
        let sim = self.sim.as_mut();
        let history = self.history.as_mut();
        history.reg_idx = index as i32;
        history.reg_val = sim.reg[index as usize];
        &mut sim.reg[index as usize]
    }

    fn pc(&self) -> u32 {
        self.sim.as_ref().to_text_addr(self.sim.as_ref().pc_idx)
    }

    fn set_pc(&self, addr: u32) -> bool {
        let sim = self.sim.as_mut();
        match sim.to_text_idx(addr) {
            Some(idx) => {
                sim.pc_idx = idx;
                true
            }
            None => false,
        }
    }

    fn pc_step(&self) {
        self.sim.as_mut().pc_idx += 1;
    }

    fn request_input(&self, wait_status: WaitStatus) -> Result<(), String> {
        self.sim.as_mut().request_input(wait_status)
    }

    fn output(&self, output: &str) -> Result<(), String> {
        self.sim.as_mut().output(output)
    }
}