charm 0.0.1

ARM assembler & disassembler generated from the ARM exploration tools.
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
//! # POP
//!
//! Pop Multiple Registers from Stack loads multiple general-purpose registers from the stack, loading from consecutive memory locations starting at the address in SP, and updates SP to point just above the loaded data.

#![allow(non_snake_case)]
#![allow(unused)]
use crate::error::Result;
use crate::utils::*;
use super::super::formatter::*;
use super::super::instruction::*;
use super::super::operand::*;
use super::super::consts::*;
use super::super::config::*;
use super::super::decoder::*;

// ---------------------------------------------------------------------------
// Iclass IclassPopT1
// ---------------------------------------------------------------------------

/// Type that represents the IclassPopT1 instruction class.
pub(crate) struct IclassPopT1;

impl IclassPopT1 {
    /// Tries to decode the instruction in `data`.
    pub(crate) fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        let P = (data >> 8) & 1;
        let P_post = P;
        let field_10 = (data >> 9) & 3;
        let field_10_post = field_10;
        let field_15 = (data >> 12) & 15;
        let field_15_post = field_15;
        let L = (data >> 11) & 1;
        let L_post = L;
        let register_list = (data >> 0) & 255;
        let register_list_post = register_list;


        return PopT1::decode(data as u32, decoder);

        unreachable!()
    }
}

/// POP T1 encoding.
///
/// # Encoding
///
/// <table style="font-family: courier, monospace">
///     <tr>
///         <td style="border: none">15</td>
///         <td style="border: none">14</td>
///         <td style="border: none">13</td>
///         <td style="border: none">12</td>
///         <td style="border: none">11</td>
///         <td style="border: none">10</td>
///         <td style="border: none">9</td>
///         <td style="border: none">8</td>
///         <td style="border: none">7</td>
///         <td style="border: none">6</td>
///         <td style="border: none">5</td>
///         <td style="border: none">4</td>
///         <td style="border: none">3</td>
///         <td style="border: none">2</td>
///         <td style="border: none">1</td>
///         <td style="border: none">0</td>
///     </tr>
///     <tr>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">0</td>
///          <td style="text-align: center; border-left: none; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-right: none" colspan="1">1</td>
///          <td style="text-align: center; border-left: none" colspan="1">0</td>
/// <td style="text-align: center" colspan="1">P</td>
/// <td style="text-align: center" colspan="8">register_list</td>
///     </tr>
///     <tr>
/// <td style="text-align: center; border: none" colspan="4"></td>
/// <td style="text-align: center; border: none" colspan="1">L</td>
/// <td style="text-align: center; border: none" colspan="2"></td>
/// <td style="text-align: center; border: none" colspan="1"></td>
/// <td style="text-align: center; border: none" colspan="8"></td>
///     </tr>
/// </table>
pub struct PopT1;

impl PopT1 {
    /// Returns the instruction mnemonic.
    pub fn mnemonic(instr: &Instruction) -> Mnemonic {
        match instr.encoding {
            Encoding::Alt1 => Mnemonic::POP,
            Encoding::Alt2 => Mnemonic::LDM,
            _ => todo!()
        }
    }

    /// Returns the instruction condition information.
    pub fn condition(instr: &Instruction) -> ConditionalInstruction {
        match instr.encoding {
            Encoding::Alt1 => {
                ConditionalInstruction::Condition(0, false, false)
            }
            Encoding::Alt2 => {
                ConditionalInstruction::Condition(0, false, false)
            }
            _ => todo!()
        }
    }

    /// Returns the instruction size.
    pub fn size(instr: &Instruction) -> usize {
        match instr.encoding {
            Encoding::Alt1 =>  2 ,
            Encoding::Alt2 =>  2 ,
            _ => todo!()
        }
    }

    /// Decodes the instruction in `data`.
    pub fn decode(data: u32, decoder: &mut Decoder) -> Result<Instruction> {
        let P = (data >> 8) & 1;
        let P_post = P;
        let register_list = (data >> 0) & 255;
        let register_list_post = register_list;
        let P_register_list_post = (P << 8) | register_list;
        let P_post = P;
        let register_list_post = register_list;

        // Checks if preferred encodings have been configured.
        if let Some(encoding) = decoder.config.instructions.pop_t1.encodings {
            match encoding {
                PopT1Encodings::Alt1 => {
                    // Operand values are computed from the base fields.
                    let op_0 = MnemonicCondition::Al;
                    let P_register_list_post = (P << 8) | register_list;
                    let register_list_post = register_list;
                    let P_post = P;
                    let op_1 = RegisterList::decode((P_post << 15) | (0 << 14) | register_list_post);

                    // The instruction is then created from the operands.
                    let mut instr = Instruction::builder_multi(Code::POP_T1, Encoding::Alt1)
                        .operand(0, op_0)?
                        .operand(1, op_1)?
                        .build();
                    
                    return Ok(instr);
                }
                PopT1Encodings::Alt2 => {
                    // Operand values are computed from the base fields.
                    let op_0 = MnemonicCondition::Al;
                    let op_1 = Register::SP;
                    let P_register_list_post = (P << 8) | register_list;
                    let register_list_post = register_list;
                    let P_post = P;
                    let op_2 = RegisterList::decode((P_post << 15) | (0 << 14) | register_list_post);

                    // The instruction is then created from the operands.
                    let mut instr = Instruction::builder_multi(Code::POP_T1, Encoding::Alt2)
                        .operand(0, op_0)?
                        .operand(1, op_1)?
                        .operand(2, op_2)?
                        .build();
                    
                    return Ok(instr);
                }
            }
        }
        
        // Operand values are computed from the base fields.
        let op_0 = MnemonicCondition::Al;
        let P_register_list_post = (P << 8) | register_list;
        let register_list_post = register_list;
        let P_post = P;
        let op_1 = RegisterList::decode((P_post << 15) | (0 << 14) | register_list_post);
        // The instruction is then created from the operands.
        let mut instr = Instruction::builder_multi(Code::POP_T1, Encoding::Alt1)
            .operand(0, op_0)?
            .operand(1, op_1)?
            .build();
        
        return Ok(instr);
        
        // Operand values are computed from the base fields.
        let op_0 = MnemonicCondition::Al;
        let op_1 = Register::SP;
        let P_register_list_post = (P << 8) | register_list;
        let register_list_post = register_list;
        let P_post = P;
        let op_2 = RegisterList::decode((P_post << 15) | (0 << 14) | register_list_post);
        // The instruction is then created from the operands.
        let mut instr = Instruction::builder_multi(Code::POP_T1, Encoding::Alt2)
            .operand(0, op_0)?
            .operand(1, op_1)?
            .operand(2, op_2)?
            .build();
        
        return Ok(instr);
        
        unreachable!()
    }

    /// Encodes the instruction into `buf`.
    pub fn encode(instr: &Instruction, buf: &mut Vec<u8>) -> Result<usize> {
        match instr.encoding {
            Encoding::Alt1 => {
                // Retrieve all operand values.
                let (P_pre, _, register_list_pre) = {
    let value = instr.op1().as_register_list()?.encode();
    ((value >> 15) & 1, (value >> 14) & 1, value & 0x3fff)
};

                // Compute all instruction fields from the operand values.
                let register_list = (register_list_pre & 255);
                let P = (P_pre & 1);

                // Add all field values to the base instruction encoding.
                let mut instr: u32 = 0b1011110000000000;
                instr |= (register_list & 255) << 0;
                instr |= (P & 1) << 8;

                let instr = instr as u16;
                buf.extend(instr.to_le_bytes());
                return Ok(2);
            }
            Encoding::Alt2 => {
                // Retrieve all operand values.
                let (P_pre, _, register_list_pre) = {
    let value = instr.op2().as_register_list()?.encode();
    ((value >> 15) & 1, (value >> 14) & 1, value & 0x3fff)
};

                // Compute all instruction fields from the operand values.
                let register_list = (register_list_pre & 255);
                let P = (P_pre & 1);

                // Add all field values to the base instruction encoding.
                let mut instr: u32 = 0b1011110000000000;
                instr |= (register_list & 255) << 0;
                instr |= (P & 1) << 8;

                let instr = instr as u16;
                buf.extend(instr.to_le_bytes());
                return Ok(2);
            }
            _ => todo!()
        }
        unreachable!()
    }

    /// Encode an instruction part of an instruction block into `buf`.
    pub fn encode_block(instr: &mut Instruction, buf: &mut Vec<u8>, labels: &std::collections::HashMap<u64, u64>) -> Result<usize> {
        match instr.encoding {
            Encoding::Alt1 => {
                Self::encode(instr, buf)
            }
            Encoding::Alt2 => {
                Self::encode(instr, buf)
            }
            _ => todo!()
        }
    }
    
    /// Verifies that operand #0 is valid.
    pub fn check_op0(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                if let Operand::MnemonicCondition(r) = op {
                    return Ok(())
                }
                todo!()
            }
            Encoding::Alt2 => {
                if let Operand::MnemonicCondition(r) = op {
                    return Ok(())
                }
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }
    
    /// Verifies that operand #1 is valid.
    pub fn check_op1(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                if let Operand::RegisterList(_) = op {
                    return Ok(())
                }
                todo!()
            }
            Encoding::Alt2 => {
                if let Operand::Register(Register::SP) = op {
                    return Ok(())
                }
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }
    
    /// Verifies that operand #2 is valid.
    pub fn check_op2(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                todo!()
            }
            Encoding::Alt2 => {
                if let Operand::RegisterList(_) = op {
                    return Ok(())
                }
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }
    
    /// Verifies that operand #3 is valid.
    pub fn check_op3(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                todo!()
            }
            Encoding::Alt2 => {
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }
    
    /// Verifies that operand #4 is valid.
    pub fn check_op4(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                todo!()
            }
            Encoding::Alt2 => {
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }
    
    /// Verifies that operand #5 is valid.
    pub fn check_op5(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                todo!()
            }
            Encoding::Alt2 => {
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }
    
    /// Verifies that operand #6 is valid.
    pub fn check_op6(instr: &Instruction, op: &Operand) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                todo!()
            }
            Encoding::Alt2 => {
                todo!()
            }
            _ => todo!()
        }
        unreachable!()
    }

    /// Formats the instruction.
    pub fn format(instr: &Instruction, fmt: &mut impl Formatter, output: &mut impl FormatterOutput, config: &Config) -> Result<()> {
        match instr.encoding {
            Encoding::Alt1 => {
                fmt.format_mnemonic(output, &config.global, &config.instructions.pop_t1, &instr)?;
                fmt.format_operand(output, &config.global, &config.instructions.pop_t1, &instr, 0)?;
                fmt.format_qualifier(output, &config.global, &config.instructions.pop_t1, &instr, FormatterQualifier::Narrow, false, false)?;
                fmt.format_punctuation(output, &config.global, &config.instructions.pop_t1, &instr, FormatterTextKind::Space)?;
                fmt.format_operand(output, &config.global, &config.instructions.pop_t1, &instr, 1)?;
                return Ok(());
            }
            Encoding::Alt2 => {
                fmt.format_mnemonic(output, &config.global, &config.instructions.pop_t1, &instr)?;
                fmt.format_operand(output, &config.global, &config.instructions.pop_t1, &instr, 0)?;
                fmt.format_qualifier(output, &config.global, &config.instructions.pop_t1, &instr, FormatterQualifier::Narrow, false, false)?;
                fmt.format_punctuation(output, &config.global, &config.instructions.pop_t1, &instr, FormatterTextKind::Space)?;
                fmt.format_operand(output, &config.global, &config.instructions.pop_t1, &instr, 1)?;
                fmt.format_punctuation(output, &config.global, &config.instructions.pop_t1, &instr, FormatterTextKind::ExclamationMark)?;
                fmt.format_punctuation(output, &config.global, &config.instructions.pop_t1, &instr, FormatterTextKind::Comma)?;
                fmt.format_operand(output, &config.global, &config.instructions.pop_t1, &instr, 2)?;
                return Ok(());
            }
            _ => todo!()
        }
        unreachable!()
    }
}

/// Type that represents alias identifiers for [`PopT1`].
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
pub enum PopT1Aliases {
    None,
}

/// Type that represents encoding identifiers for [`PopT1`].
#[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Debug, Hash)]
pub enum PopT1Encodings {
    Alt1,
    Alt2,
}