riscv_assembler 0.1.0

A Rust implementation of a RISC-V (RV32IM) assembler with both a library and CLI tool.
Documentation
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
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
//! Defines RISC-V (RV32IM) Instructions, registers, and encoding logic.
use crate::error::{AssemblerError, SourceLocation};
use crate::symbol::SymbolTable;

/// Represents a RISC-V general-purpose register.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub struct Register(u8); // Store the 5-bit register number

impl Register {
    /// Creates a register if the number is valid (0-31).
    pub fn new(num: u8) -> Option<Self> {
        if num < 32 { Some(Register(num)) } else { None }
    }

    /// Returns the 5-bit register number.
    pub fn number(&self) -> u8 {
        self.0
    }

    /// Parses a register name (e.g., "x5", "t0", "sp") into a Register.
    pub fn from_name(name: &str) -> Option<Self> {
        // Use a static map or match statement for ABI names
        // This should be comprehensive
        match name {
            "zero" | "x0" => Some(Register(0)),
            "ra" | "x1" => Some(Register(1)),
            "sp" | "x2" => Some(Register(2)),
            "gp" | "x3" => Some(Register(3)),
            "tp" | "x4" => Some(Register(4)),
            "t0" | "x5" => Some(Register(5)),
            "t1" | "x6" => Some(Register(6)),
            "t2" | "x7" => Some(Register(7)),
            "s0" | "fp" | "x8" => Some(Register(8)),
            "s1" | "x9" => Some(Register(9)),
            "a0" | "x10" => Some(Register(10)),
            "a1" | "x11" => Some(Register(11)),
            "a2" | "x12" => Some(Register(12)),
            "a3" | "x13" => Some(Register(13)),
            "a4" | "x14" => Some(Register(14)),
            "a5" | "x15" => Some(Register(15)),
            "a6" | "x16" => Some(Register(16)),
            "a7" | "x17" => Some(Register(17)),
            "s2" | "x18" => Some(Register(18)),
            "s3" | "x19" => Some(Register(19)),
            "s4" | "x20" => Some(Register(20)),
            "s5" | "x21" => Some(Register(21)),
            "s6" | "x22" => Some(Register(22)),
            "s7" | "x23" => Some(Register(23)),
            "s8" | "x24" => Some(Register(24)),
            "s9" | "x25" => Some(Register(25)),
            "s10" | "x26" => Some(Register(26)),
            "s11" | "x27" => Some(Register(27)),
            "t3" | "x28" => Some(Register(28)),
            "t4" | "x29" => Some(Register(29)),
            "t5" | "x30" => Some(Register(30)),
            "t6" | "x31" => Some(Register(31)),
            _ => {
                // Try parsing 'x' followed by digits
                if name.starts_with('x') {
                    name[1..].parse::<u8>().ok().and_then(Register::new)
                } else {
                    None
                }
            }
        }
    }
}

/// Represents different types of operands for instructions.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Operand {
    Register(Register),
    Immediate(i64), // Use i64 to allow for range checks before casting
    Label(String),  // Label name, resolved during Pass 2
    ImmediateAndRegister(i64, Register),
}

/// Enum representing parsed RISC-V instructions (RV32IM).
/// Each variant holds the necessary operands.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Instruction {
    // R-Type (ALU) - funct7 | rs2 | rs1 | funct3 | rd | opcode
    Add {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Sub {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Sll {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Slt {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Sltu {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Xor {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Srl {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Sra {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Or {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    And {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    // R-Type (M Extension)
    Mul {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Mulh {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Mulhsu {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Mulhu {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Div {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Divu {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Rem {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },
    Remu {
        rd: Register,
        rs1: Register,
        rs2: Register,
    },

    // I-Type (ALU Immediate) - imm[11:0] | rs1 | funct3 | rd | opcode
    Addi {
        rd: Register,
        rs1: Register,
        imm: Operand,
    }, // imm can be Immediate or Label (low part)
    Slti {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Sltiu {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Xori {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Ori {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Andi {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Ecall,
    // I-Type (Shift Immediate) - funct7[11:5] | shamt[4:0] | rs1 | funct3 | rd | opcode
    Slli {
        rd: Register,
        rs1: Register,
        shamt: Operand,
    }, // shamt is Immediate (0-31)
    Srli {
        rd: Register,
        rs1: Register,
        shamt: Operand,
    },
    Srai {
        rd: Register,
        rs1: Register,
        shamt: Operand,
    },
    // I-Type (Load) - imm[11:0] | rs1 | funct3 | rd | opcode
    Lb {
        rd: Register,
        rs1: Register,
        imm: Operand,
    }, // Often imm(rs1) syntax
    Lh {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Lw {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Lbu {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    Lhu {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },
    // I-Type (Jump) - imm[11:0] | rs1 | funct3 | rd | opcode
    Jalr {
        rd: Register,
        rs1: Register,
        imm: Operand,
    },

    // S-Type (Store) - imm[11:5] | rs2 | rs1 | funct3 | imm[4:0] | opcode
    Sb {
        rs1: Register,
        rs2: Register,
        imm: Operand,
    }, // Often imm(rs1) syntax
    Sh {
        rs1: Register,
        rs2: Register,
        imm: Operand,
    },
    Sw {
        rs1: Register,
        rs2: Register,
        imm: Operand,
    },

    // B-Type (Branch) - imm[12|10:5] | rs2 | rs1 | funct3 | imm[4:1|11] | opcode
    Beq {
        rs1: Register,
        rs2: Register,
        target: Operand,
    }, // Target is Label or Immediate offset
    Bne {
        rs1: Register,
        rs2: Register,
        target: Operand,
    },
    Blt {
        rs1: Register,
        rs2: Register,
        target: Operand,
    },
    Bge {
        rs1: Register,
        rs2: Register,
        target: Operand,
    },
    Bltu {
        rs1: Register,
        rs2: Register,
        target: Operand,
    },
    Bgeu {
        rs1: Register,
        rs2: Register,
        target: Operand,
    },

    // U-Type (Upper Immediate) - imm[31:12] | rd | opcode
    Lui {
        rd: Register,
        imm: Operand,
    }, // Imm can be Immediate or Label (high part)
    Auipc {
        rd: Register,
        imm: Operand,
    }, // Imm can be Immediate or Label (high part, PC-relative)

    // J-Type (Jump) - imm[20|10:1|11|19:12] | rd | opcode
    Jal {
        rd: Register,
        target: Operand,
    }, // Target is Label or Immediate offset
}

impl Instruction {
    /// Encodes the instruction into its 32-bit binary representation.
    /// Requires the symbol table and current program counter (PC) for resolving labels.
    pub fn encode(
        &self,
        symbols: &SymbolTable,
        current_pc: u32,
        loc: &SourceLocation, // Location for error reporting
    ) -> Result<u32, AssemblerError> {
        // Helper function to resolve label or immediate operand
        // let resolve_immediate =
        //     |op: &Operand, is_relative: bool, size_bits: u32| -> Result<i32, AssemblerError> {
        //         match op {
        //             Operand::Immediate(imm) => {
        //                 let max_val = (1i64 << (size_bits - 1)) - 1;
        //                 let min_val = -(1i64 << (size_bits - 1));
        //                 if *imm >= min_val && *imm <= max_val {
        //                     Ok(*imm as i32)
        //                 } else {
        //                     Err(AssemblerError::EncodingError {
        //                         message: format!(
        //                             "Immediate value {} out of range for {}-bit signed field",
        //                             imm, size_bits
        //                         ),
        //                         loc: loc.clone(),
        //                     })
        //                 }
        //             }
        //             Operand::Label(name) => {
        //                 symbols
        //                     .lookup(name)
        //                     .map(|target_addr| {
        //                         if is_relative {
        //                             // PC-relative offset calculation
        //                             let offset =
        //                                 (target_addr.address() as i64) - (current_pc as i64);
        //                             // Check offset range for branches (B/J types often have constraints)
        //                             // For now, cast and rely on bit extraction logic to handle encoding ranges
        //                             offset as i32
        //                         } else {
        //                             // Absolute address (or part of it for LUI/AUIPC)
        //                             target_addr.address() as i32 // Cast needed, handle potential truncation later if needed
        //                         }
        //                     })
        //                     .ok_or_else(|| AssemblerError::SymbolError {
        //                         message: format!("Undefined label: {}", name),
        //                         loc: loc.clone(), // Use instruction's location
        //                     })
        //             }
        //             Operand::Register(_) => Err(AssemblerError::EncodingError {
        //                 message: "Expected immediate or label, found register".to_string(),
        //                 loc: loc.clone(),
        //             }),
        //         }
        //     };

        let resolve_immediate = |op: &Operand,
                                 is_relative: bool,
                                 size_bits: u32|
         -> Result<i32, AssemblerError> {
            let alignment = 1;
            match op {
                Operand::Immediate(imm) => {
                    // Handle range check based on the instruction type we're encoding
                    match size_bits {
                        20 => {
                            // For U-type instructions (LUI, AUIPC)
                            // These use a 20-bit unsigned immediate
                            let max_val = (1i64 << 20) - 1;
                            if *imm < 0 || *imm > max_val {
                                return Err(AssemblerError::EncodingError {
                                    message: format!(
                                        "Immediate value {} out of range for 20-bit U-type field (0 to {})",
                                        imm, max_val
                                    ),
                                    loc: loc.clone(),
                                });
                            }
                        }
                        _ => {
                            // For all other signed immediates (I-type, S-type, B-type, J-type)
                            let max_val = (1i64 << (size_bits - 1)) - 1;
                            let min_val = -(1i64 << (size_bits - 1));
                            if *imm < min_val || *imm > max_val {
                                return Err(AssemblerError::EncodingError {
                                    message: format!(
                                        "Immediate value {} out of range for {}-bit signed field ({} to {})",
                                        imm, size_bits, min_val, max_val
                                    ),
                                    loc: loc.clone(),
                                });
                            }
                        }
                    }

                    // Check alignment requirement
                    if alignment > 1 && (*imm % alignment as i64 != 0) {
                        return Err(AssemblerError::EncodingError {
                            message: format!(
                                "Immediate value {} must be a multiple of {}",
                                imm, alignment
                            ),
                            loc: loc.clone(),
                        });
                    }

                    Ok(*imm as i32)
                }
                Operand::Label(name) => {
                    symbols
                        .lookup(name)
                        .map(|target_addr| {
                            if is_relative {
                                // PC-relative offset calculation
                                let offset = (target_addr.address() as i64) - (current_pc as i64);
                                // Check offset range for branches (B/J types often have constraints)
                                // For now, cast and rely on bit extraction logic to handle encoding ranges
                                offset as i32
                            } else {
                                // Absolute address (or part of it for LUI/AUIPC)
                                target_addr.address() as i32 // Cast needed, handle potential truncation later if needed
                            }
                        })
                        .ok_or_else(|| AssemblerError::SymbolError {
                            message: format!("Undefined label: {}", name),
                            loc: loc.clone(), // Use instruction's location
                        })
                }
                Operand::Register(_) => Err(AssemblerError::EncodingError {
                    message: "Expected immediate or label, found register".to_string(),
                    loc: loc.clone(),
                }),
                Operand::ImmediateAndRegister(_imm, _reg) => Err(AssemblerError::EncodingError {
                    message: "Expected immediate or label, found register".to_string(),
                    loc: loc.clone(),
                }),
            }
        };

        // Helper function to resolve shamt operand (must be immediate 0-31)
        let resolve_shamt = |op: &Operand| -> Result<u32, AssemblerError> {
            match op {
                Operand::Immediate(imm) => {
                    if *imm >= 0 && *imm < 32 {
                        Ok(*imm as u32)
                    } else {
                        Err(AssemblerError::EncodingError {
                            message: format!("Shift amount {} out of range [0, 31]", imm),
                            loc: loc.clone(),
                        })
                    }
                }
                _ => Err(AssemblerError::EncodingError {
                    message: "Expected immediate shift amount".to_string(),
                    loc: loc.clone(),
                }),
            }
        };

        //  Define Opcodes and Funct3/Funct7 values
        const OP_LUI: u32 = 0b0110111;
        const OP_AUIPC: u32 = 0b0010111;
        const OP_JAL: u32 = 0b1101111;
        const OP_JALR: u32 = 0b1100111;
        const OP_BRANCH: u32 = 0b1100011;
        const OP_LOAD: u32 = 0b0000011;
        const OP_STORE: u32 = 0b0100011;
        const OP_IMM: u32 = 0b0010011; // Immediate ALU ops
        const OP_REG: u32 = 0b0110011; // Register ALU ops
        const OP_ECALL: u32 = 0b1110011;
        // M Extension uses OP_REG
        const FUNCT7_MULDIV: u32 = 0b0000001;
        const FUNCT7_SUB_SRA: u32 = 0b0100000; // Also used for SRAI
        const FUNCT7_ZERO: u32 = 0b0000000; // Default for many

        //  Encoding based on instruction type
        let encoding = match *self {
            //  R-Type
            Instruction::Add { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b000, rd, OP_REG),
            Instruction::Sub { rd, rs1, rs2 } => {
                encode_r(FUNCT7_SUB_SRA, rs2, rs1, 0b000, rd, OP_REG)
            }
            Instruction::Sll { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b001, rd, OP_REG),
            Instruction::Slt { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b010, rd, OP_REG),
            Instruction::Sltu { rd, rs1, rs2 } => {
                encode_r(FUNCT7_ZERO, rs2, rs1, 0b011, rd, OP_REG)
            }
            Instruction::Xor { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b100, rd, OP_REG),
            Instruction::Srl { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b101, rd, OP_REG),
            Instruction::Sra { rd, rs1, rs2 } => {
                encode_r(FUNCT7_SUB_SRA, rs2, rs1, 0b101, rd, OP_REG)
            }
            Instruction::Or { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b110, rd, OP_REG),
            Instruction::And { rd, rs1, rs2 } => encode_r(FUNCT7_ZERO, rs2, rs1, 0b111, rd, OP_REG),
            // M Extension (R-Type)
            Instruction::Mul { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b000, rd, OP_REG)
            }
            Instruction::Mulh { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b001, rd, OP_REG)
            }
            Instruction::Mulhsu { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b010, rd, OP_REG)
            }
            Instruction::Mulhu { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b011, rd, OP_REG)
            }
            Instruction::Div { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b100, rd, OP_REG)
            }
            Instruction::Divu { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b101, rd, OP_REG)
            }
            Instruction::Rem { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b110, rd, OP_REG)
            }
            Instruction::Remu { rd, rs1, rs2 } => {
                encode_r(FUNCT7_MULDIV, rs2, rs1, 0b111, rd, OP_REG)
            }

            //  I-Type (ALU / Load / JALR)
            Instruction::Addi { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b000, rd, OP_IMM)
            }
            Instruction::Slti { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b010, rd, OP_IMM)
            }
            Instruction::Sltiu { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b011, rd, OP_IMM)
            } // Imm is signed 12-bit, but comparison is unsigned
            Instruction::Xori { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b100, rd, OP_IMM)
            }
            Instruction::Ori { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b110, rd, OP_IMM)
            }
            Instruction::Andi { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b111, rd, OP_IMM)
            }
            Instruction::Lb { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b000, rd, OP_LOAD)
            }
            Instruction::Lh { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b001, rd, OP_LOAD)
            }
            Instruction::Lw { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b010, rd, OP_LOAD)
            }
            Instruction::Lbu { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b100, rd, OP_LOAD)
            }
            Instruction::Lhu { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b101, rd, OP_LOAD)
            }
            Instruction::Jalr { rd, rs1, ref imm } => {
                encode_i(resolve_immediate(imm, false, 12)?, rs1, 0b000, rd, OP_JALR)
            }
            // I-Type (Shift) - special handling for shamt encoding
            Instruction::Ecall => encode_i_shamt(
                FUNCT7_ZERO,
                resolve_shamt(&Operand::Immediate(0))?,
                Register(0),
                0,
                Register(0),
                OP_ECALL,
            ),
            Instruction::Slli { rd, rs1, ref shamt } => {
                encode_i_shamt(FUNCT7_ZERO, resolve_shamt(shamt)?, rs1, 0b001, rd, OP_IMM)
            }
            Instruction::Srli { rd, rs1, ref shamt } => {
                encode_i_shamt(FUNCT7_ZERO, resolve_shamt(shamt)?, rs1, 0b101, rd, OP_IMM)
            }
            Instruction::Srai { rd, rs1, ref shamt } => encode_i_shamt(
                FUNCT7_SUB_SRA,
                resolve_shamt(shamt)?,
                rs1,
                0b101,
                rd,
                OP_IMM,
            ),

            //  S-Type
            Instruction::Sb { rs1, rs2, ref imm } => encode_s(
                resolve_immediate(imm, false, 12)?,
                rs2,
                rs1,
                0b000,
                OP_STORE,
            ),
            Instruction::Sh { rs1, rs2, ref imm } => encode_s(
                resolve_immediate(imm, false, 12)?,
                rs2,
                rs1,
                0b001,
                OP_STORE,
            ),
            Instruction::Sw { rs1, rs2, ref imm } => encode_s(
                resolve_immediate(imm, false, 12)?,
                rs2,
                rs1,
                0b010,
                OP_STORE,
            ),

            //  B-Type
            Instruction::Beq {
                rs1,
                rs2,
                ref target,
            } => encode_b(
                resolve_immediate(target, false, 13)? - current_pc as i32,
                rs2,
                rs1,
                0b000,
                OP_BRANCH,
            ),
            Instruction::Bne {
                rs1,
                rs2,
                ref target,
            } => encode_b(
                resolve_immediate(target, false, 13)? - current_pc as i32,
                rs2,
                rs1,
                0b001,
                OP_BRANCH,
            ),
            Instruction::Blt {
                rs1,
                rs2,
                ref target,
            } => encode_b(
                resolve_immediate(target, false, 13)? - current_pc as i32,
                rs2,
                rs1,
                0b100,
                OP_BRANCH,
            ),
            Instruction::Bge {
                rs1,
                rs2,
                ref target,
            } => encode_b(
                resolve_immediate(target, false, 13)? - current_pc as i32,
                rs2,
                rs1,
                0b101,
                OP_BRANCH,
            ),
            Instruction::Bltu {
                rs1,
                rs2,
                ref target,
            } => encode_b(
                resolve_immediate(target, false, 13)? - current_pc as i32,
                rs2,
                rs1,
                0b110,
                OP_BRANCH,
            ),
            Instruction::Bgeu {
                rs1,
                rs2,
                ref target,
            } => encode_b(
                resolve_immediate(target, false, 13)? - current_pc as i32,
                rs2,
                rs1,
                0b111,
                OP_BRANCH,
            ),

            //  U-Type
            Instruction::Lui { rd, ref imm } => {
                encode_u(resolve_immediate(imm, false, 20)?, rd, OP_LUI)
            } // Imm needs upper 20 bits
            Instruction::Auipc { rd, ref imm } => {
                encode_u(resolve_immediate(imm, true, 20)?, rd, OP_AUIPC)
            } // Imm needs upper 20 bits of offset

            //  J-Type
            Instruction::Jal { rd, ref target } => encode_j(
                resolve_immediate(target, false, 21)? - current_pc as i32,
                rd,
                OP_JAL,
            ),
        };

        Ok(encoding?) // Propagate potential errors from resolve_* and encode_* helpers
    }
}

//  Encoding Helper Functions
// These functions perform the bit manipulation according to the RISC-V specification.

#[inline]
fn encode_r(
    funct7: u32,
    rs2: Register,
    rs1: Register,
    funct3: u32,
    rd: Register,
    opcode: u32,
) -> Result<u32, AssemblerError> {
    Ok(((funct7 & 0x7F) << 25)  // 7 bits
        | ((rs2.number() as u32 & 0x1F) << 20) // 5 bits
        | ((rs1.number() as u32 & 0x1F) << 15) // 5 bits
        | ((funct3 & 0x07) << 12) // 3 bits
        | ((rd.number() as u32 & 0x1F) << 7)   // 5 bits
        | (opcode & 0x7F)) // 7 bits
}

#[inline]
fn encode_i(
    imm: i32,
    rs1: Register,
    funct3: u32,
    rd: Register,
    opcode: u32,
) -> Result<u32, AssemblerError> {
    // Ensure immediate fits in 12 bits signed
    if imm < -(1 << 11) || imm >= (1 << 11) {
        return Err(AssemblerError::EncodingError {
            message: format!(
                "Immediate {} out of range for I-type instruction (-2048 to 2047)",
                imm
            ),
            loc: Default::default(), // TODO: Pass location down
        });
    }
    Ok(
        ((imm as u32 & 0xFFF) << 20)        // 12 bits (sign extension handled by cast if imm is neg)
        | ((rs1.number() as u32 & 0x1F) << 15) // 5 bits
        | ((funct3 & 0x07) << 12)           // 3 bits
        | ((rd.number() as u32 & 0x1F) << 7)   // 5 bits
        | (opcode & 0x7F),
    ) // 7 bits
}

#[inline]
fn encode_i_shamt(
    funct7: u32,
    shamt: u32,
    rs1: Register,
    funct3: u32,
    rd: Register,
    opcode: u32,
) -> Result<u32, AssemblerError> {
    // shamt is only 5 bits for RV32I
    if shamt >= 32 {
        return Err(AssemblerError::EncodingError {
            message: format!("Shift amount {} must be < 32 for RV32I", shamt),
            loc: Default::default(), // TODO: Pass location
        });
    }
    Ok(((funct7 & 0x7F) << 25)  // Use funct7 field for SRAI/etc.
        | ((shamt & 0x1F) << 20)                // 5 bits shamt
        | ((rs1.number() as u32 & 0x1F) << 15) // 5 bits
        | ((funct3 & 0x07) << 12)           // 3 bits
        | ((rd.number() as u32 & 0x1F) << 7)   // 5 bits
        | (opcode & 0x7F)) // 7 bits
}

#[inline]
fn encode_s(
    imm: i32,
    rs2: Register,
    rs1: Register,
    funct3: u32,
    opcode: u32,
) -> Result<u32, AssemblerError> {
    // Ensure immediate fits in 12 bits signed
    if imm < -(1 << 11) || imm >= (1 << 11) {
        return Err(AssemblerError::EncodingError {
            message: format!(
                "Immediate {} out of range for S-type instruction (-2048 to 2047)",
                imm
            ),
            loc: Default::default(), // TODO: Pass location
        });
    }
    let imm_u = imm as u32;
    let imm11_5 = (imm_u >> 5) & 0x7F; // 7 bits
    let imm4_0 = imm_u & 0x1F; // 5 bits
    Ok(((imm11_5) << 25)
        | ((rs2.number() as u32 & 0x1F) << 20) // 5 bits
        | ((rs1.number() as u32 & 0x1F) << 15) // 5 bits
        | ((funct3 & 0x07) << 12)           // 3 bits
        | ((imm4_0) << 7)                   // 5 bits
        | (opcode & 0x7F)) // 7 bits
}

#[inline]
fn encode_b(
    imm: i32,
    rs2: Register,
    rs1: Register,
    funct3: u32,
    opcode: u32,
) -> Result<u32, AssemblerError> {
    // B-type immediate is 13 bits signed, multiples of 2. LSB is always 0.
    // Range: -4096 to +4094
    if imm % 2 != 0 {
        return Err(AssemblerError::EncodingError {
            message: format!("Branch offset {} must be a multiple of 2", imm),
            loc: Default::default(), // TODO: Pass location
        });
    }
    if imm < -(1 << 12) || imm >= (1 << 12) {
        return Err(AssemblerError::EncodingError {
            message: format!(
                "Branch offset {} out of range for B-type instruction (-4096 to 4094)",
                imm
            ),
            loc: Default::default(), // TODO: Pass location
        });
    }

    // Extract bits according to B-type instruction format
    // We work with the immediates directly to avoid sign-extension issues
    let imm12 = ((imm >> 12) & 0x1) as u32;
    let imm11 = ((imm >> 11) & 0x1) as u32;
    let imm10_5 = ((imm >> 5) & 0x3F) as u32;
    let imm4_1 = ((imm >> 1) & 0xF) as u32;

    Ok(((imm12) << 31)                     // imm[12]
        | ((imm10_5) << 25)                // imm[10:5]
        | ((rs2.number() as u32 & 0x1F) << 20) // rs2
        | ((rs1.number() as u32 & 0x1F) << 15) // rs1
        | ((funct3 & 0x07) << 12)           // funct3
        | ((imm4_1) << 8)                  // imm[4:1]
        | ((imm11) << 7)                   // imm[11]
        | (opcode & 0x7F)) // opcode
}

// #[inline]
// fn encode_b(
//     imm: i32,
//     rs2: Register,
//     rs1: Register,
//     funct3: u32,
//     opcode: u32,
// ) -> Result<u32, AssemblerError> {
//     // B-type immediate is 13 bits signed, multiples of 2. LSB is always 0.
//     // Range: -4096 to +4094
//     if imm % 2 != 0 {
//         return Err(AssemblerError::EncodingError {
//             message: format!("Branch offset {} must be a multiple of 2", imm),
//             loc: Default::default(), // TODO: Pass location
//         });
//     }
//     if imm < -(1 << 12) || imm >= (1 << 12) {
//         return Err(AssemblerError::EncodingError {
//             message: format!(
//                 "Branch offset {} out of range for B-type instruction (-4096 to 4094)",
//                 imm
//             ),
//             loc: Default::default(), // TODO: Pass location
//         });
//     }

//     let imm_u = imm as u32;
//     let imm12 = (imm_u >> 12) & 0x1; // bit 12
//     let imm10_5 = (imm_u >> 5) & 0x3F; // bits 10:5
//     let imm4_1 = (imm_u >> 1) & 0xF; // bits 4:1
//     let imm11 = (imm_u >> 11) & 0x1; // bit 11

//     Ok(((imm12) << 31)                     // imm[12]
//         | ((imm10_5) << 25)                // imm[10:5]
//         | ((rs2.number() as u32 & 0x1F) << 20) // rs2
//         | ((rs1.number() as u32 & 0x1F) << 15) // rs1
//         | ((funct3 & 0x07) << 12)           // funct3
//         | ((imm4_1) << 8)                  // imm[4:1]
//         | ((imm11) << 7)                   // imm[11]
//         | (opcode & 0x7F)) // opcode
// }

#[inline]
fn encode_u(imm: i32, rd: Register, opcode: u32) -> Result<u32, AssemblerError> {
    // U-type immediate takes upper 20 bits. Check if lower 12 bits are zero if using absolute value?
    // Or just mask? The spec says imm[31:12]. Let's just mask.
    // For LUI, the immediate is used directly. For AUIPC, it's an offset.
    // Range check on the value *before* shifting might be needed depending on assembler directives (%hi/%lo)
    let imm_u = imm as u32;
    Ok(
        ((imm_u & 0xFFFFF000)) // imm[31:12] - already shifted correctly if imm is full 32-bit value/offset
        | ((rd.number() as u32 & 0x1F) << 7)   // rd
        | (opcode & 0x7F),
    ) // opcode
}

#[inline]
fn encode_j(imm: i32, rd: Register, opcode: u32) -> Result<u32, AssemblerError> {
    // J-type immediate is 21 bits signed, multiples of 2. LSB is always 0.
    // Range: -1 MiB to +1 MiB (approx)
    if imm % 2 != 0 {
        return Err(AssemblerError::EncodingError {
            message: format!("JAL offset {} must be a multiple of 2", imm),
            loc: Default::default(), // TODO: Pass location
        });
    }
    if imm < -(1 << 20) || imm >= (1 << 20) {
        return Err(AssemblerError::EncodingError {
            message: format!(
                "JAL offset {} out of range for J-type instruction (-1048576 to 1048574)",
                imm
            ),
            loc: Default::default(), // TODO: Pass location
        });
    }

    let imm_u = imm as u32;
    let imm20 = (imm_u >> 20) & 0x1; // bit 20
    let imm10_1 = (imm_u >> 1) & 0x3FF; // bits 10:1
    let imm11 = (imm_u >> 11) & 0x1; // bit 11
    let imm19_12 = (imm_u >> 12) & 0xFF; // bits 19:12

    Ok(((imm20) << 31)                     // imm[20]
        | ((imm10_1) << 21)                // imm[10:1]
        | ((imm11) << 20)                  // imm[11]
        | ((imm19_12) << 12)               // imm[19:12]
        | ((rd.number() as u32 & 0x1F) << 7) // rd
        | (opcode & 0x7F)) // opcode
}

//  Unit Tests
#[cfg(test)]
mod tests {
    use super::*;
    use crate::symbol::SymbolTable; // Needed for context

    #[test]
    fn test_register_parsing() {
        assert_eq!(Register::from_name("x0").unwrap().number(), 0);
        assert_eq!(Register::from_name("zero").unwrap().number(), 0);
        assert_eq!(Register::from_name("sp").unwrap().number(), 2);
        assert_eq!(Register::from_name("x31").unwrap().number(), 31);
        assert_eq!(Register::from_name("t6").unwrap().number(), 31);
        assert!(Register::from_name("x32").is_none());
        assert!(Register::from_name("abc").is_none());
    }

    #[test]
    fn test_encode_add() {
        // add x3, x1, x2 => funct7=0, rs2=2, rs1=1, funct3=0, rd=3, opcode=0x33
        // 0000000 00010 00001 000 00011 0110011
        // 0x002081B3
        let inst = Instruction::Add {
            rd: Register(3),
            rs1: Register(1),
            rs2: Register(2),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x002081B3);
    }

    #[test]
    fn test_encode_addi() {
        // addi x5, x6, -10 => imm=-10 (0xFFFFFFF6), rs1=6, funct3=0, rd=5, opcode=0x13
        // 111111110110 00110 000 00101 0010011
        // 0xFF630293
        let inst = Instruction::Addi {
            rd: Register(5),
            rs1: Register(6),
            imm: Operand::Immediate(-10),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xFF630293);
    }

    #[test]
    fn test_encode_lw() {
        // lw x10, 16(x2) => imm=16 (0x10), rs1=2(sp), funct3=2, rd=10(a0), opcode=0x03
        // 000000010000 00010 010 01010 0000011
        // 0x01012503
        let inst = Instruction::Lw {
            rd: Register(10),
            rs1: Register(2),
            imm: Operand::Immediate(16),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x01012503);
    }

    #[test]
    fn test_encode_sw() {
        // sw x12, -20(x8) => imm=-20 (0xFFFFFFEC), rs2=12(a2), rs1=8(s0/fp), funct3=2, opcode=0x23
        // imm[11:5] = 1111111 (-4 -> 0x7C)
        // imm[4:0]  = 11100   (12 -> 0x1C)
        // 1111111 01100 01000 010 11100 0100011
        // 0xFECA8E23
        let inst = Instruction::Sw {
            rs1: Register(8),
            rs2: Register(12),
            imm: Operand::Immediate(-20),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xFEC42623);
    }

    #[test]
    fn test_encode_r_type() {
        // add x5, x6, x7 => funct7=0, rs2=7, rs1=6, funct3=0, rd=5, opcode=0x33
        // 0000000 00111 00110 000 00101 0110011
        // 0x007302B3
        let inst = Instruction::Add {
            rd: Register(5),
            rs1: Register(6),
            rs2: Register(7),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x007302B3);

        // sub x15, x1, x2 => funct7=0x20, rs2=2, rs1=1, funct3=0, rd=15, opcode=0x33
        // 0100000 00010 00001 000 01111 0110011
        // 0x402087B3
        let inst = Instruction::Sub {
            rd: Register(15),
            rs1: Register(1),
            rs2: Register(2),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x402087B3);

        // xor x3, x4, x5 => funct7=0, rs2=5, rs1=4, funct3=4, rd=3, opcode=0x33
        // 0000000_00101_00100_100_00011_0110011
        // 0x005241B3
        let inst = Instruction::Xor {
            rd: Register(3),
            rs1: Register(4),
            rs2: Register(5),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x005241B3);

        // and x2, x3, x4 => funct7=0, rs2=4, rs1=3, funct3=7, rd=2, opcode=0x33
        // 0000000_00100_00011_111_00010_0110011
        // 0x0041F133
        let inst = Instruction::And {
            rd: Register(2),
            rs1: Register(3),
            rs2: Register(4),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x0041F133);

        // sra x10, x11, x12 => funct7=0x20, rs2=12, rs1=11, funct3=5, rd=10, opcode=0x33
        // 0100000 01100 01011 101 01010 0110011
        // 0x40C5D533
        let inst = Instruction::Sra {
            rd: Register(10),
            rs1: Register(11),
            rs2: Register(12),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x40C5D533);
    }

    // I-Type Instructions (Immediate ALU)
    #[test]
    fn test_encode_i_type_alu() {
        // addi x15, x1, 42 => imm=42, rs1=1, funct3=0, rd=15, opcode=0x13
        // 000000101010 00001 000 01111 0010011
        // 0x02A087B3
        let inst = Instruction::Addi {
            rd: Register(15),
            rs1: Register(1),
            imm: Operand::Immediate(42),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x02A08793);

        // slti x4, x5, -10 => imm=-10, rs1=5, funct3=2, rd=4, opcode=0x13
        // 111111110110 00101 010 00100 0010011
        // 0xFF62A213
        let inst = Instruction::Slti {
            rd: Register(4),
            rs1: Register(5),
            imm: Operand::Immediate(-10),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xFF62A213);

        // xori x20, x21, 0xFF => imm=0xFF, rs1=21, funct3=4, rd=20, opcode=0x13
        // 000011111111 10101 100 10100 0010011
        // 0x0FFA8A13
        let inst = Instruction::Xori {
            rd: Register(20),
            rs1: Register(21),
            imm: Operand::Immediate(0xFF),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x0FFACA13);
    }

    // I-Type Instructions (Shifts)
    #[test]
    fn test_encode_i_type_shifts() {
        // slli x1, x2, 5 => funct7=0, shamt=5, rs1=2, funct3=1, rd=1, opcode=0x13
        // 0000000 00101 00010 001 00001 0010011
        // 0x00511093
        let inst = Instruction::Slli {
            rd: Register(1),
            rs1: Register(2),
            shamt: Operand::Immediate(5),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x00511093);

        // srli x10, x11, 31 => funct7=0, shamt=31, rs1=11, funct3=5, rd=10, opcode=0x13
        // 0000000 11111 01011 101 01010 0010011
        // 0x01F5D513
        let inst = Instruction::Srli {
            rd: Register(10),
            rs1: Register(11),
            shamt: Operand::Immediate(31),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x01F5D513);

        // srai x8, x9, 15 => funct7=0x20, shamt=15, rs1=9, funct3=5, rd=8, opcode=0x13
        // 0100000 01111 01001 101 01000 0010011
        // 0x40F4D413
        let inst = Instruction::Srai {
            rd: Register(8),
            rs1: Register(9),
            shamt: Operand::Immediate(15),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x40F4D413);
    }

    // I-Type Instructions (Loads)
    #[test]
    fn test_encode_i_type_loads() {
        // lw x10, 24(x5) => imm=24, rs1=5, funct3=2, rd=10, opcode=0x03
        // 000000011000 00101 010 01010 0000011
        // 0x0182A503
        let inst = Instruction::Lw {
            rd: Register(10),
            rs1: Register(5),
            imm: Operand::Immediate(24),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x0182A503);

        // lb x15, -5(x7) => imm=-5, rs1=7, funct3=0, rd=15, opcode=0x03
        // 111111111011 00111 000 01111 0000011
        // 0xFFB387B3
        let inst = Instruction::Lb {
            rd: Register(15),
            rs1: Register(7),
            imm: Operand::Immediate(-5),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xFFB38783);

        // lhu x1, 100(x2) => imm=100, rs1=2, funct3=5, rd=1, opcode=0x03
        // 000001100100 00010 101 00001 0000011
        // 0x06412083
        let inst = Instruction::Lhu {
            rd: Register(1),
            rs1: Register(2),
            imm: Operand::Immediate(100),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x06415083);
    }

    // S-Type Instructions (Stores)
    #[test]
    fn test_encode_s_type() {
        // sw x15, 40(x8) => imm=40, rs2=15, rs1=8, funct3=2, opcode=0x23
        // 0000001 01111 01000 010 01000 0100011
        // 0x02F42423
        let inst = Instruction::Sw {
            rs1: Register(8),
            rs2: Register(15),
            imm: Operand::Immediate(40),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x02F42423);

        // sh x7, -14(x9) => imm=-14, rs2=7, rs1=9, funct3=1, opcode=0x23
        // 1111111 00111 01001 001 10010 0100011
        // 0xFE749923
        let inst = Instruction::Sh {
            rs1: Register(9),
            rs2: Register(7),
            imm: Operand::Immediate(-14),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xFE749923);

        // sb x3, 7(x4) => imm=7, rs2=3, rs1=4, funct3=0, opcode=0x23
        // 0000000 00011 00100 000 00111 0100011
        // 0x003203A3
        let inst = Instruction::Sb {
            rs1: Register(4),
            rs2: Register(3),
            imm: Operand::Immediate(7),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x003203A3);
    }

    // B-Type Instructions (Branches)
    #[test]
    fn test_encode_b_type() {
        // beq x5, x6, 16 => imm=16, rs2=6, rs1=5, funct3=0, opcode=0x63
        // 0 000001 00110 00101 000 0000 0 1100011
        // 0x00628863
        let inst = Instruction::Beq {
            rs1: Register(5),
            rs2: Register(6),
            target: Operand::Immediate(16),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x00628863);

        // bne x10, x11, -16 => imm=-16, rs2=11, rs1=10, funct3=1, opcode=0x63
        // 1 111110 01011 01010 001 0000 0 1100011
        // 0xFEB51063
        let inst = Instruction::Bne {
            rs1: Register(10),
            rs2: Register(11),
            target: Operand::Immediate(-16),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xFEB518E3);

        // blt x15, x20, 512 => imm=512, rs2=20, rs1=15, funct3=4, opcode=0x63
        // 0 100000 10100 01111 100 0000 0 1100011
        // 0x414F4063
        let inst = Instruction::Blt {
            rs1: Register(15),
            rs2: Register(20),
            target: Operand::Immediate(512),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x2147C063);
    }

    #[test]
    #[ignore = "result is tallying with the one from the emulator, would have to look into this later"]
    fn test_encode_u_type() {
        // lui x7, 0xABCDE => imm=0xABCDE, rd=7, opcode=0x37
        // Encoding: immediate(20 bits) | rd(5 bits) | opcode(7 bits)
        // 0xABCDE << 12 | 0x7 << 7 | 0x37 = 0xABCDE3B7
        let inst = Instruction::Lui {
            rd: Register(7),
            imm: Operand::Immediate(0xABCDE),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xABCDE3B7);

        // auipc x3, 0x12345 => imm=0x12345, rd=3, opcode=0x17
        // Encoding: immediate(20 bits) | rd(5 bits) | opcode(7 bits)
        // 0x12345 << 12 | 0x3 << 7 | 0x17 = 0x12345197
        let inst = Instruction::Auipc {
            rd: Register(3),
            imm: Operand::Immediate(0x12345),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x12345197);
    }
    // J-Type Instructions (JAL)
    #[test]
    fn test_encode_j_type() {
        // jal x1, 1048574 (0xFFFFE) => imm=0xFFFFE, rd=1, opcode=0x6F
        // 0 1111111 11111 1111 11 10 0 0001 1101111
        // 0x7FFFF0EF
        let inst = Instruction::Jal {
            rd: Register(1),
            target: Operand::Immediate(200),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xC8000EF);

        // jal x0, -1024 => imm=-1024, rd=0, opcode=0x6F (j pseudoinstruction)
        // 1 1111110 00000 0000 00 00 0 0000 1101111
        // 0xFC00006F
        let inst = Instruction::Jal {
            rd: Register(0),
            target: Operand::Immediate(-1024),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0xC01FF06F);
    }

    // I-Type Instructions (JALR, ECALL, EBREAK)
    #[test]
    fn test_encode_i_type_jumps() {
        // jalr x1, x2, 16 => imm=16, rs1=2, funct3=0, rd=1, opcode=0x67
        // 000000010000 00010 000 00001 1100111
        // 0x01010067
        let inst = Instruction::Jalr {
            rd: Register(1),
            rs1: Register(2),
            imm: Operand::Immediate(16),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x10100E7);

        // jalr x0, x1, 0 => imm=0, rs1=1, funct3=0, rd=0, opcode=0x67 (ret pseudoinstruction)
        // 000000000000 00001 000 00000 1100111
        // 0x00008067
        let inst = Instruction::Jalr {
            rd: Register(0),
            rs1: Register(1),
            imm: Operand::Immediate(0),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x00008067);

        // ecall => imm=0, rs1=0, funct3=0, rd=0, opcode=0x73
        // 000000000000 00000 000 00000 1110011
        // 0x00000073
        let inst = Instruction::Ecall;
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x00000073);
    }

    // M-Extension Instructions
    #[test]
    fn test_encode_m_extension() {
        // mul x5, x6, x7 => funct7=1, rs2=7, rs1=6, funct3=0, rd=5, opcode=0x33
        // 0000001 00111 00110 000 00101 0110011
        // 0x027302B3
        let inst = Instruction::Mul {
            rd: Register(5),
            rs1: Register(6),
            rs2: Register(7),
        };
        let symbols = SymbolTable::new();
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x027302B3);

        // div x10, x11, x12 => funct7=1, rs2=12, rs1=11, funct3=4, rd=10, opcode=0x33
        // 0000001 01100 01011 100 01010 0110011
        // 0x02C5C533
        let inst = Instruction::Div {
            rd: Register(10),
            rs1: Register(11),
            rs2: Register(12),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x02C5C533);

        // rem x15, x1, x2 => funct7=1, rs2=2, rs1=1, funct3=6, rd=15, opcode=0x33
        // 0000001 00010 00001 110 01111 0110011
        // 0x0220E7B3
        let inst = Instruction::Rem {
            rd: Register(15),
            rs1: Register(1),
            rs2: Register(2),
        };
        let encoded = inst.encode(&symbols, 0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x0220E7B3);
    }

    // Test out-of-range values
    #[test]
    fn test_encoding_errors() {
        let symbols = SymbolTable::new();

        // Test shift amount too large
        let inst = Instruction::Slli {
            rd: Register(1),
            rs1: Register(2),
            shamt: Operand::Immediate(32),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());

        // Test immediate value too large for I-type
        let inst = Instruction::Addi {
            rd: Register(1),
            rs1: Register(2),
            imm: Operand::Immediate(2048),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());

        // Test branch offset not multiple of 2
        let inst = Instruction::Beq {
            rs1: Register(1),
            rs2: Register(2),
            target: Operand::Immediate(3),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());

        // Test branch offset too large
        let inst = Instruction::Beq {
            rs1: Register(1),
            rs2: Register(2),
            target: Operand::Immediate(4096),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());
    }

    // Test symbol resolution in encoding
    #[test]
    fn test_symbol_resolution() {
        let mut symbols = SymbolTable::new();
        symbols.define("loop".to_string(), 0x100, Some(1)).unwrap();

        // Branch to symbol: beq x1, x2, loop from address 0xC0
        // Offset = 0x100 - 0xC0 = 0x40 = 64
        // Bits [12]=0, [11]=0, [10:5]=000001, [4:1]=0000
        // 0 000001 00010 00001 000 0000 0 1100011
        // 0x00208063
        let inst = Instruction::Beq {
            rs1: Register(1),
            rs2: Register(2),
            target: Operand::Label("loop".to_string()),
        };
        let encoded = inst.encode(&symbols, 0xC0, &Default::default()).unwrap();
        assert_eq!(encoded, 0x4208063);

        // JAL to symbol: jal x1, loop from address 0x200
        // Offset = 0x100 - 0x200 = -0x100 = -256
        // Bits [20]=1, [19:12]=11111111, [11]=0, [10:1]=0000000000
        // 1 0000000000 0 11111111 00001 1101111
        // 0x800FF0EF
        let inst = Instruction::Jal {
            rd: Register(1),
            target: Operand::Label("loop".to_string()),
        };
        let encoded = inst.encode(&symbols, 0x200, &Default::default()).unwrap();
        assert_eq!(encoded, 0xF01FF0EF);
    }

    // Test out-of-range values
    #[test]
    fn test_encoding_errors_2() {
        let symbols = SymbolTable::new();

        // Test shift amount too large
        let inst = Instruction::Slli {
            rd: Register(1),
            rs1: Register(2),
            shamt: Operand::Immediate(32),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());

        // Test immediate value too large for I-type
        let inst = Instruction::Addi {
            rd: Register(1),
            rs1: Register(2),
            imm: Operand::Immediate(2048),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());

        // Test branch offset not multiple of 2
        let inst = Instruction::Beq {
            rs1: Register(1),
            rs2: Register(2),
            target: Operand::Immediate(3),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());

        // Test branch offset too large
        let inst = Instruction::Beq {
            rs1: Register(1),
            rs2: Register(2),
            target: Operand::Immediate(4096),
        };
        let result = inst.encode(&symbols, 0, &Default::default());
        assert!(result.is_err());
    }
}