Skip to main content

asmkit/riscv/
operands.rs

1//! RISC-V Operands definition.
2use crate::core::{
3    arch_traits::{Arch, ArchTraits},
4    operand::{define_abstract_reg, define_final_reg, define_operand_cast, define_reg_traits, *},
5    types::TypeId,
6};
7
8macro_rules! impl_deref_for_wrapper {
9    ($wrapper:ty, $target:ty) => {
10        impl core::ops::Deref for $wrapper {
11            type Target = $target;
12
13            fn deref(&self) -> &Self::Target {
14                &self.0
15            }
16        }
17
18        impl core::ops::DerefMut for $wrapper {
19            fn deref_mut(&mut self) -> &mut Self::Target {
20                &mut self.0
21            }
22        }
23    };
24}
25
26#[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Hash)]
27pub struct Reg(pub BaseReg);
28
29impl_deref_for_wrapper!(Reg, BaseReg);
30
31define_abstract_reg!(Reg, BaseReg);
32
33define_reg_traits!(RISCV32Gp, RegGroup::Gp, 32, TypeId::Int32);
34define_reg_traits!(RISCV64Gp, RegGroup::Gp, 64, TypeId::Int64);
35define_reg_traits!(RISCVPC, RegGroup::PC, 64, TypeId::Int64);
36define_reg_traits!(RISCVVec, RegGroup::Vec, 128, TypeId::Int32x4);
37define_reg_traits!(RISCVFp, RegGroup::Vec, 64, TypeId::Float64);
38
39impl Reg {
40    pub const fn signature_of(typ: RegType) -> OperandSignature {
41        ArchTraits::by_arch(Arch::RISCV64).reg_type_to_signature(typ)
42    }
43
44    pub fn is_gp(&self) -> bool {
45        self.is_reg_group_of(RegGroup::Gp)
46    }
47
48    pub fn is_fp(&self) -> bool {
49        self.has_base_signature(RISCVFp::SIGNATURE)
50    }
51
52    pub fn is_vec(&self) -> bool {
53        self.has_base_signature(RISCVVec::SIGNATURE)
54    }
55
56    pub fn set_reg_t<T: RegTraits>(&mut self, rid: u32) {
57        self.set_signature(T::SIGNATURE.into());
58        self.set_id(rid);
59    }
60
61    pub fn set_type_and_id(&mut self, typ: RegType, id: u32) {
62        self.set_signature(Self::signature_of(typ));
63        self.set_id(id);
64    }
65    pub const SIGNATURE: u32 = BaseReg::SIGNATURE;
66}
67
68#[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Hash)]
69pub struct Gp(pub Reg);
70
71impl_deref_for_wrapper!(Gp, Reg);
72
73impl Gp {
74    pub const fn signature_of(typ: RegType) -> OperandSignature {
75        ArchTraits::by_arch(Arch::RISCV64).reg_type_to_signature(typ)
76    }
77
78    pub const X0: u32 = 0;
79    pub const X1: u32 = 1;
80    pub const X2: u32 = 2;
81    pub const X3: u32 = 3;
82    pub const X4: u32 = 4;
83    pub const X5: u32 = 5;
84    pub const X6: u32 = 6;
85    pub const X7: u32 = 7;
86    pub const X8: u32 = 8;
87    pub const X9: u32 = 9;
88    pub const X10: u32 = 10;
89    pub const X11: u32 = 11;
90    pub const X12: u32 = 12;
91    pub const X13: u32 = 13;
92    pub const X14: u32 = 14;
93    pub const X15: u32 = 15;
94    pub const X16: u32 = 16;
95    pub const X17: u32 = 17;
96    pub const X18: u32 = 18;
97    pub const X19: u32 = 19;
98    pub const X20: u32 = 20;
99    pub const X21: u32 = 21;
100    pub const X22: u32 = 22;
101    pub const X23: u32 = 23;
102    pub const X24: u32 = 24;
103    pub const X25: u32 = 25;
104    pub const X26: u32 = 26;
105    pub const X27: u32 = 27;
106    pub const X28: u32 = 28;
107    pub const X29: u32 = 29;
108    pub const X30: u32 = 30;
109    pub const X31: u32 = 31;
110}
111
112define_final_reg!(Gp, Reg, RISCV64Gp);
113
114#[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Hash)]
115pub struct Fp(pub Reg);
116
117impl_deref_for_wrapper!(Fp, Reg);
118
119define_final_reg!(Fp, Reg, RISCVFp);
120
121impl Fp {
122    pub const fn signature_of(typ: RegType) -> OperandSignature {
123        ArchTraits::by_arch(Arch::RISCV64).reg_type_to_signature(typ)
124    }
125
126    pub const F0: u32 = 0;
127    pub const F1: u32 = 1;
128    pub const F2: u32 = 2;
129    pub const F3: u32 = 3;
130    pub const F4: u32 = 4;
131    pub const F5: u32 = 5;
132    pub const F6: u32 = 6;
133    pub const F7: u32 = 7;
134    pub const F8: u32 = 8;
135    pub const F9: u32 = 9;
136    pub const F10: u32 = 10;
137    pub const F11: u32 = 11;
138    pub const F12: u32 = 12;
139    pub const F13: u32 = 13;
140    pub const F14: u32 = 14;
141    pub const F15: u32 = 15;
142    pub const F16: u32 = 16;
143    pub const F17: u32 = 17;
144    pub const F18: u32 = 18;
145    pub const F19: u32 = 19;
146    pub const F20: u32 = 20;
147    pub const F21: u32 = 21;
148    pub const F22: u32 = 22;
149    pub const F23: u32 = 23;
150    pub const F24: u32 = 24;
151    pub const F25: u32 = 25;
152    pub const F26: u32 = 26;
153    pub const F27: u32 = 27;
154    pub const F28: u32 = 28;
155    pub const F29: u32 = 29;
156    pub const F30: u32 = 30;
157    pub const F31: u32 = 31;
158}
159
160#[derive(Clone, Copy, PartialEq, PartialOrd, Eq, Ord, Hash)]
161pub struct Vp(pub Reg);
162
163impl_deref_for_wrapper!(Vp, Reg);
164
165define_final_reg!(Vp, Reg, RISCVVec);
166
167impl Vp {
168    pub const fn signature_of(typ: RegType) -> OperandSignature {
169        ArchTraits::by_arch(Arch::RISCV64).reg_type_to_signature(typ)
170    }
171
172    pub const V0: u32 = 0;
173    pub const V1: u32 = 1;
174    pub const V2: u32 = 2;
175    pub const V3: u32 = 3;
176    pub const V4: u32 = 4;
177    pub const V5: u32 = 5;
178    pub const V6: u32 = 6;
179    pub const V7: u32 = 7;
180    pub const V8: u32 = 8;
181    pub const V9: u32 = 9;
182    pub const V10: u32 = 10;
183    pub const V11: u32 = 11;
184    pub const V12: u32 = 12;
185    pub const V13: u32 = 13;
186    pub const V14: u32 = 14;
187    pub const V15: u32 = 15;
188    pub const V16: u32 = 16;
189    pub const V17: u32 = 17;
190    pub const V18: u32 = 18;
191    pub const V19: u32 = 19;
192    pub const V20: u32 = 20;
193    pub const V21: u32 = 21;
194    pub const V22: u32 = 22;
195    pub const V23: u32 = 23;
196    pub const V24: u32 = 24;
197    pub const V25: u32 = 25;
198    pub const V26: u32 = 26;
199    pub const V27: u32 = 27;
200    pub const V28: u32 = 28;
201    pub const V29: u32 = 29;
202    pub const V30: u32 = 30;
203    pub const V31: u32 = 31;
204}
205
206pub mod regs {
207    pub use super::*;
208
209    pub const fn x(id: u32) -> Gp {
210        Gp::from_id(id)
211    }
212
213    pub const fn f(id: u32) -> Fp {
214        Fp::from_id(id)
215    }
216
217    pub const fn v(id: u32) -> Vp {
218        Vp::from_id(id)
219    }
220
221    pub const X0: Gp = x(0);
222    pub const X1: Gp = x(1);
223    pub const X2: Gp = x(2);
224    pub const X3: Gp = x(3);
225    pub const X4: Gp = x(4);
226    pub const X5: Gp = x(5);
227    pub const X6: Gp = x(6);
228    pub const X7: Gp = x(7);
229    pub const X8: Gp = x(8);
230    pub const X9: Gp = x(9);
231    pub const X10: Gp = x(10);
232    pub const X11: Gp = x(11);
233    pub const X12: Gp = x(12);
234    pub const X13: Gp = x(13);
235    pub const X14: Gp = x(14);
236    pub const X15: Gp = x(15);
237    pub const X16: Gp = x(16);
238    pub const X17: Gp = x(17);
239    pub const X18: Gp = x(18);
240    pub const X19: Gp = x(19);
241    pub const X20: Gp = x(20);
242    pub const X21: Gp = x(21);
243    pub const X22: Gp = x(22);
244    pub const X23: Gp = x(23);
245    pub const X24: Gp = x(24);
246    pub const X25: Gp = x(25);
247    pub const X26: Gp = x(26);
248    pub const X27: Gp = x(27);
249    pub const X28: Gp = x(28);
250    pub const X29: Gp = x(29);
251    pub const X30: Gp = x(30);
252    pub const X31: Gp = x(31);
253
254    pub const ZERO: Gp = X0;
255    pub const RA: Gp = X1;
256    pub const SP: Gp = X2;
257    pub const GP: Gp = X3;
258    pub const TP: Gp = X4;
259    pub const T0: Gp = X5;
260    pub const T1: Gp = X6;
261    pub const T2: Gp = X7;
262    pub const S0: Gp = X8;
263    pub const S1: Gp = X9;
264    pub const A0: Gp = X10;
265    pub const A1: Gp = X11;
266    pub const A2: Gp = X12;
267    pub const A3: Gp = X13;
268    pub const A4: Gp = X14;
269    pub const A5: Gp = X15;
270    pub const A6: Gp = X16;
271    pub const A7: Gp = X17;
272    pub const S2: Gp = X18;
273    pub const S3: Gp = X19;
274    pub const S4: Gp = X20;
275    pub const S5: Gp = X21;
276    pub const S6: Gp = X22;
277    pub const S7: Gp = X23;
278    pub const S8: Gp = X24;
279    pub const S9: Gp = X25;
280    pub const S10: Gp = X26;
281    pub const S11: Gp = X27;
282    pub const T3: Gp = X28;
283    pub const T4: Gp = X29;
284    pub const T5: Gp = X30;
285    pub const T6: Gp = X31;
286
287    pub const F0: Fp = f(0);
288    pub const F1: Fp = f(1);
289    pub const F2: Fp = f(2);
290    pub const F3: Fp = f(3);
291    pub const F4: Fp = f(4);
292    pub const F5: Fp = f(5);
293    pub const F6: Fp = f(6);
294    pub const F7: Fp = f(7);
295    pub const F8: Fp = f(8);
296    pub const F9: Fp = f(9);
297    pub const F10: Fp = f(10);
298    pub const F11: Fp = f(11);
299    pub const F12: Fp = f(12);
300    pub const F13: Fp = f(13);
301    pub const F14: Fp = f(14);
302    pub const F15: Fp = f(15);
303    pub const F16: Fp = f(16);
304    pub const F17: Fp = f(17);
305    pub const F18: Fp = f(18);
306    pub const F19: Fp = f(19);
307    pub const F20: Fp = f(20);
308    pub const F21: Fp = f(21);
309    pub const F22: Fp = f(22);
310    pub const F23: Fp = f(23);
311    pub const F24: Fp = f(24);
312    pub const F25: Fp = f(25);
313    pub const F26: Fp = f(26);
314    pub const F27: Fp = f(27);
315    pub const F28: Fp = f(28);
316    pub const F29: Fp = f(29);
317    pub const F30: Fp = f(30);
318    pub const F31: Fp = f(31);
319
320    pub const V0: Vp = v(0);
321    pub const V1: Vp = v(1);
322    pub const V2: Vp = v(2);
323    pub const V3: Vp = v(3);
324    pub const V4: Vp = v(4);
325    pub const V5: Vp = v(5);
326    pub const V6: Vp = v(6);
327    pub const V7: Vp = v(7);
328    pub const V8: Vp = v(8);
329    pub const V9: Vp = v(9);
330    pub const V10: Vp = v(10);
331    pub const V11: Vp = v(11);
332    pub const V12: Vp = v(12);
333    pub const V13: Vp = v(13);
334    pub const V14: Vp = v(14);
335    pub const V15: Vp = v(15);
336    pub const V16: Vp = v(16);
337    pub const V17: Vp = v(17);
338    pub const V18: Vp = v(18);
339    pub const V19: Vp = v(19);
340    pub const V20: Vp = v(20);
341    pub const V21: Vp = v(21);
342    pub const V22: Vp = v(22);
343    pub const V23: Vp = v(23);
344    pub const V24: Vp = v(24);
345    pub const V25: Vp = v(25);
346    pub const V26: Vp = v(26);
347    pub const V27: Vp = v(27);
348    pub const V28: Vp = v(28);
349    pub const V29: Vp = v(29);
350    pub const V30: Vp = v(30);
351    pub const V31: Vp = v(31);
352}