asmthumb.c 16.2 KB
Newer Older
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
/*
 * This file is part of the Micro Python project, http://micropython.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2013, 2014 Damien P. George
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

Damien's avatar
Damien committed
27
28
29
30
#include <stdio.h>
#include <assert.h>
#include <string.h>

31
#include "py/mpconfig.h"
Damien's avatar
Damien committed
32

33
34
35
// wrapper around everything in this file
#if MICROPY_EMIT_THUMB || MICROPY_EMIT_INLINE_THUMB

36
37
#include "py/asmthumb.h"

Damien's avatar
Damien committed
38
39
40
41
42
#define UNSIGNED_FIT8(x) (((x) & 0xffffff00) == 0)
#define UNSIGNED_FIT16(x) (((x) & 0xffff0000) == 0)
#define SIGNED_FIT8(x) (((x) & 0xffffff80) == 0) || (((x) & 0xffffff80) == 0xffffff80)
#define SIGNED_FIT9(x) (((x) & 0xffffff00) == 0) || (((x) & 0xffffff00) == 0xffffff00)
#define SIGNED_FIT12(x) (((x) & 0xfffff800) == 0) || (((x) & 0xfffff800) == 0xfffff800)
43
#define SIGNED_FIT23(x) (((x) & 0xffc00000) == 0) || (((x) & 0xffc00000) == 0xffc00000)
Damien's avatar
Damien committed
44
45

struct _asm_thumb_t {
46
47
48
    mp_uint_t pass;
    mp_uint_t code_offset;
    mp_uint_t code_size;
Damien's avatar
Damien committed
49
    byte *code_base;
50
    byte dummy_data[4];
Damien's avatar
Damien committed
51

52
53
54
55
    mp_uint_t max_num_labels;
    mp_uint_t *label_offsets;
    mp_uint_t push_reglist;
    mp_uint_t stack_adjust;
Damien's avatar
Damien committed
56
57
};

58
asm_thumb_t *asm_thumb_new(uint max_num_labels) {
Damien's avatar
Damien committed
59
60
    asm_thumb_t *as;

61
    as = m_new0(asm_thumb_t, 1);
62
    as->max_num_labels = max_num_labels;
63
    as->label_offsets = m_new(mp_uint_t, max_num_labels);
Damien's avatar
Damien committed
64
65
66
67
68
69

    return as;
}

void asm_thumb_free(asm_thumb_t *as, bool free_code) {
    if (free_code) {
70
        MP_PLAT_FREE_EXEC(as->code_base, as->code_size);
Damien's avatar
Damien committed
71
    }
72
    m_del(mp_uint_t, as->label_offsets, as->max_num_labels);
73
    m_del_obj(asm_thumb_t, as);
Damien's avatar
Damien committed
74
75
}

76
77
void asm_thumb_start_pass(asm_thumb_t *as, uint pass) {
    if (pass == ASM_THUMB_PASS_COMPUTE) {
78
        memset(as->label_offsets, -1, as->max_num_labels * sizeof(mp_uint_t));
79
80
81
    } else if (pass == ASM_THUMB_PASS_EMIT) {
        MP_PLAT_ALLOC_EXEC(as->code_offset, (void**)&as->code_base, &as->code_size);
        if (as->code_base == NULL) {
82
83
            assert(0);
        }
84
        //printf("code_size: %u\n", as->code_size);
Damien's avatar
Damien committed
85
    }
86
87
88
    as->pass = pass;
    as->code_offset = 0;
}
Damien's avatar
Damien committed
89

90
91
void asm_thumb_end_pass(asm_thumb_t *as) {
    // could check labels are resolved...
Damien's avatar
Damien committed
92
93
94
}

// all functions must go through this one to emit bytes
95
// if as->pass < ASM_THUMB_PASS_EMIT, then this function only returns a buffer of 4 bytes length
96
STATIC byte *asm_thumb_get_cur_to_write_bytes(asm_thumb_t *as, int num_bytes_to_write) {
Damien's avatar
Damien committed
97
    //printf("emit %d\n", num_bytes_to_write);
98
    if (as->pass < ASM_THUMB_PASS_EMIT) {
Damien's avatar
Damien committed
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
        as->code_offset += num_bytes_to_write;
        return as->dummy_data;
    } else {
        assert(as->code_offset + num_bytes_to_write <= as->code_size);
        byte *c = as->code_base + as->code_offset;
        as->code_offset += num_bytes_to_write;
        return c;
    }
}

uint asm_thumb_get_code_size(asm_thumb_t *as) {
    return as->code_size;
}

void *asm_thumb_get_code(asm_thumb_t *as) {
114
    return as->code_base;
Damien's avatar
Damien committed
115
116
117
}

/*
118
STATIC void asm_thumb_write_byte_1(asm_thumb_t *as, byte b1) {
Damien's avatar
Damien committed
119
120
121
122
123
124
125
126
127
128
129
    byte *c = asm_thumb_get_cur_to_write_bytes(as, 1);
    c[0] = b1;
}
*/

/*
#define IMM32_L0(x) ((x) & 0xff)
#define IMM32_L1(x) (((x) >> 8) & 0xff)
#define IMM32_L2(x) (((x) >> 16) & 0xff)
#define IMM32_L3(x) (((x) >> 24) & 0xff)

130
STATIC void asm_thumb_write_word32(asm_thumb_t *as, int w32) {
Damien's avatar
Damien committed
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
    byte *c = asm_thumb_get_cur_to_write_bytes(as, 4);
    c[0] = IMM32_L0(w32);
    c[1] = IMM32_L1(w32);
    c[2] = IMM32_L2(w32);
    c[3] = IMM32_L3(w32);
}
*/

// rlolist is a bit map indicating desired lo-registers
#define OP_PUSH_RLIST(rlolist)      (0xb400 | (rlolist))
#define OP_PUSH_RLIST_LR(rlolist)   (0xb400 | 0x0100 | (rlolist))
#define OP_POP_RLIST(rlolist)       (0xbc00 | (rlolist))
#define OP_POP_RLIST_PC(rlolist)    (0xbc00 | 0x0100 | (rlolist))

#define OP_ADD_SP(num_words) (0xb000 | (num_words))
#define OP_SUB_SP(num_words) (0xb080 | (num_words))

148
149
// locals:
//  - stored on the stack in ascending order
150
//  - numbered 0 through num_locals-1
151
152
153
154
155
156
157
158
//  - SP points to first local
//
//  | SP
//  v
//  l0  l1  l2  ...  l(n-1)
//  ^                ^
//  | low address    | high address in RAM

Damien's avatar
Damien committed
159
void asm_thumb_entry(asm_thumb_t *as, int num_locals) {
160
    // work out what to push and how many extra spaces to reserve on stack
Damien's avatar
Damien committed
161
    // so that we have enough for all locals and it's aligned an 8-byte boundary
162
163
164
    // we push extra regs (r1, r2, r3) to help do the stack adjustment
    // we probably should just always subtract from sp, since this would be more efficient
    // for push rlist, lowest numbered register at the lowest address
Damien's avatar
Damien committed
165
166
167
168
169
    uint reglist;
    uint stack_adjust;
    if (num_locals < 0) {
        num_locals = 0;
    }
170
    // don't pop r0 because it's used for return value
Damien's avatar
Damien committed
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
    switch (num_locals) {
        case 0:
            reglist = 0xf2;
            stack_adjust = 0;
            break;

        case 1:
            reglist = 0xf2;
            stack_adjust = 0;
            break;

        case 2:
            reglist = 0xfe;
            stack_adjust = 0;
            break;

        case 3:
            reglist = 0xfe;
            stack_adjust = 0;
            break;

        default:
            reglist = 0xfe;
            stack_adjust = ((num_locals - 3) + 1) & (~1);
            break;
    }
197
    asm_thumb_op16(as, OP_PUSH_RLIST_LR(reglist));
Damien's avatar
Damien committed
198
    if (stack_adjust > 0) {
199
        asm_thumb_op16(as, OP_SUB_SP(stack_adjust));
Damien's avatar
Damien committed
200
201
202
203
204
205
206
    }
    as->push_reglist = reglist;
    as->stack_adjust = stack_adjust;
}

void asm_thumb_exit(asm_thumb_t *as) {
    if (as->stack_adjust > 0) {
207
        asm_thumb_op16(as, OP_ADD_SP(as->stack_adjust));
Damien's avatar
Damien committed
208
    }
209
    asm_thumb_op16(as, OP_POP_RLIST_PC(as->push_reglist));
Damien's avatar
Damien committed
210
211
}

212
void asm_thumb_label_assign(asm_thumb_t *as, uint label) {
213
    assert(label < as->max_num_labels);
214
    if (as->pass < ASM_THUMB_PASS_EMIT) {
215
216
217
        // assign label offset
        assert(as->label_offsets[label] == -1);
        as->label_offsets[label] = as->code_offset;
218
219
    } else {
        // ensure label offset has not changed from PASS_COMPUTE to PASS_EMIT
220
221
        //printf("l%d: (at %d=%ld)\n", label, as->label_offsets[label], as->code_offset);
        assert(as->label_offsets[label] == as->code_offset);
Damien's avatar
Damien committed
222
223
224
    }
}

225
226
227
228
229
230
231
void asm_thumb_align(asm_thumb_t* as, uint align) {
    // TODO fill unused data with NOPs?
    as->code_offset = (as->code_offset + align - 1) & (~(align - 1));
}

void asm_thumb_data(asm_thumb_t* as, uint bytesize, uint val) {
    byte *c = asm_thumb_get_cur_to_write_bytes(as, bytesize);
232
233
234
235
236
237
238
    // only write to the buffer in the emit pass (otherwise we overflow dummy_data)
    if (as->pass == ASM_THUMB_PASS_EMIT) {
        // little endian
        for (uint i = 0; i < bytesize; i++) {
            *c++ = val;
            val >>= 8;
        }
239
240
241
    }
}

242
STATIC mp_uint_t get_label_dest(asm_thumb_t *as, uint label) {
243
244
245
246
    assert(label < as->max_num_labels);
    return as->label_offsets[label];
}

247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
void asm_thumb_op16(asm_thumb_t *as, uint op) {
    byte *c = asm_thumb_get_cur_to_write_bytes(as, 2);
    // little endian
    c[0] = op;
    c[1] = op >> 8;
}

void asm_thumb_op32(asm_thumb_t *as, uint op1, uint op2) {
    byte *c = asm_thumb_get_cur_to_write_bytes(as, 4);
    // little endian, op1 then op2
    c[0] = op1;
    c[1] = op1 >> 8;
    c[2] = op2;
    c[3] = op2 >> 8;
}

263
264
265
#define OP_FORMAT_4(op, rlo_dest, rlo_src) ((op) | ((rlo_src) << 3) | (rlo_dest))

void asm_thumb_format_4(asm_thumb_t *as, uint op, uint rlo_dest, uint rlo_src) {
266
267
    assert(rlo_dest < ASM_THUMB_REG_R8);
    assert(rlo_src < ASM_THUMB_REG_R8);
268
    asm_thumb_op16(as, OP_FORMAT_4(op, rlo_dest, rlo_src));
Damien's avatar
Damien committed
269
270
271
272
273
274
275
276
277
278
279
280
281
282
}

void asm_thumb_mov_reg_reg(asm_thumb_t *as, uint reg_dest, uint reg_src) {
    uint op_lo;
    if (reg_src < 8) {
        op_lo = reg_src << 3;
    } else {
        op_lo = 0x40 | ((reg_src - 8) << 3);
    }
    if (reg_dest < 8) {
        op_lo |= reg_dest;
    } else {
        op_lo |= 0x80 | (reg_dest - 8);
    }
283
    // mov reg_dest, reg_src
284
    asm_thumb_op16(as, 0x4600 | op_lo);
Damien's avatar
Damien committed
285
286
}

287
// if loading lo half with movw, the i16 value will be zero extended into the r32 register!
288
void asm_thumb_mov_reg_i16(asm_thumb_t *as, uint mov_op, uint reg_dest, int i16_src) {
289
    assert(reg_dest < ASM_THUMB_REG_R15);
290
    // mov[wt] reg_dest, #i16_src
291
    asm_thumb_op32(as, mov_op | ((i16_src >> 1) & 0x0400) | ((i16_src >> 12) & 0xf), ((i16_src << 4) & 0x7000) | (reg_dest << 8) | (i16_src & 0xff));
292
293
}

Damien's avatar
Damien committed
294
295
#define OP_B_N(byte_offset) (0xe000 | (((byte_offset) >> 1) & 0x07ff))

296
bool asm_thumb_b_n_label(asm_thumb_t *as, uint label) {
297
298
    mp_uint_t dest = get_label_dest(as, label);
    mp_int_t rel = dest - as->code_offset;
Damien's avatar
Damien committed
299
300
    rel -= 4; // account for instruction prefetch, PC is 4 bytes ahead of this instruction
    if (SIGNED_FIT12(rel)) {
301
        asm_thumb_op16(as, OP_B_N(rel));
302
        return true;
Damien's avatar
Damien committed
303
    } else {
304
        return false;
Damien's avatar
Damien committed
305
306
307
    }
}

308
309
#define OP_BCC_N(cond, byte_offset) (0xd000 | ((cond) << 8) | (((byte_offset) >> 1) & 0x00ff))

310
311
312
313
314
// all these bit arithmetics need coverage testing!
#define OP_BCC_W_HI(cond, byte_offset) (0xf000 | ((cond) << 6) | (((byte_offset) >> 10) & 0x0400) | (((byte_offset) >> 14) & 0x003f))
#define OP_BCC_W_LO(byte_offset) (0x8000 | ((byte_offset) & 0x2000) | (((byte_offset) >> 1) & 0x0fff))

bool asm_thumb_bcc_nw_label(asm_thumb_t *as, int cond, uint label, bool wide) {
315
316
    mp_uint_t dest = get_label_dest(as, label);
    mp_int_t rel = dest - as->code_offset;
317
    rel -= 4; // account for instruction prefetch, PC is 4 bytes ahead of this instruction
318
319
320
321
322
323
324
    if (!wide) {
        if (SIGNED_FIT9(rel)) {
            asm_thumb_op16(as, OP_BCC_N(cond, rel));
            return true;
        } else {
            return false;
        }
325
    } else {
326
327
        asm_thumb_op32(as, OP_BCC_W_HI(cond, rel), OP_BCC_W_LO(rel));
        return true;
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
    }
}

#define OP_BL_HI(byte_offset) (0xf000 | (((byte_offset) >> 12) & 0x07ff))
#define OP_BL_LO(byte_offset) (0xf800 | (((byte_offset) >> 1) & 0x07ff))

bool asm_thumb_bl_label(asm_thumb_t *as, uint label) {
    mp_uint_t dest = get_label_dest(as, label);
    mp_int_t rel = dest - as->code_offset;
    rel -= 4; // account for instruction prefetch, PC is 4 bytes ahead of this instruction
    if (SIGNED_FIT23(rel)) {
        asm_thumb_op32(as, OP_BL_HI(rel), OP_BL_LO(rel));
        return true;
    } else {
        return false;
343
344
345
    }
}

346
void asm_thumb_mov_reg_i32(asm_thumb_t *as, uint reg_dest, mp_uint_t i32) {
347
348
349
    // movw, movt does it in 8 bytes
    // ldr [pc, #], dw does it in 6 bytes, but we might not reach to end of code for dw

350
351
    asm_thumb_mov_reg_i16(as, ASM_THUMB_OP_MOVW, reg_dest, i32);
    asm_thumb_mov_reg_i16(as, ASM_THUMB_OP_MOVT, reg_dest, i32 >> 16);
352
353
354
355
}

void asm_thumb_mov_reg_i32_optimised(asm_thumb_t *as, uint reg_dest, int i32) {
    if (reg_dest < 8 && UNSIGNED_FIT8(i32)) {
356
        asm_thumb_mov_rlo_i8(as, reg_dest, i32);
357
    } else if (UNSIGNED_FIT16(i32)) {
358
        asm_thumb_mov_reg_i16(as, ASM_THUMB_OP_MOVW, reg_dest, i32);
359
360
361
362
363
    } else {
        asm_thumb_mov_reg_i32(as, reg_dest, i32);
    }
}

364
365
366
367
368
369
370
// i32 is stored as a full word in the code, and aligned to machine-word boundary
// TODO this is very inefficient, improve it!
void asm_thumb_mov_reg_i32_aligned(asm_thumb_t *as, uint reg_dest, int i32) {
    // align on machine-word + 2
    if ((as->code_offset & 3) == 0) {
        asm_thumb_op16(as, ASM_THUMB_OP_NOP);
    }
371
372
    // jump over the i32 value (instruction prefetch adds 2 to PC)
    asm_thumb_op16(as, OP_B_N(2));
373
374
375
376
377
378
    // store i32 on machine-word aligned boundary
    asm_thumb_data(as, 4, i32);
    // do the actual load of the i32 value
    asm_thumb_mov_reg_i32_optimised(as, reg_dest, i32);
}

Damien's avatar
Damien committed
379
380
381
382
#define OP_STR_TO_SP_OFFSET(rlo_dest, word_offset) (0x9000 | ((rlo_dest) << 8) | ((word_offset) & 0x00ff))
#define OP_LDR_FROM_SP_OFFSET(rlo_dest, word_offset) (0x9800 | ((rlo_dest) << 8) | ((word_offset) & 0x00ff))

void asm_thumb_mov_local_reg(asm_thumb_t *as, int local_num, uint rlo_src) {
383
    assert(rlo_src < ASM_THUMB_REG_R8);
384
    int word_offset = local_num;
385
    assert(as->pass < ASM_THUMB_PASS_EMIT || word_offset >= 0);
386
    asm_thumb_op16(as, OP_STR_TO_SP_OFFSET(rlo_src, word_offset));
Damien's avatar
Damien committed
387
388
389
}

void asm_thumb_mov_reg_local(asm_thumb_t *as, uint rlo_dest, int local_num) {
390
    assert(rlo_dest < ASM_THUMB_REG_R8);
391
    int word_offset = local_num;
392
    assert(as->pass < ASM_THUMB_PASS_EMIT || word_offset >= 0);
393
    asm_thumb_op16(as, OP_LDR_FROM_SP_OFFSET(rlo_dest, word_offset));
Damien's avatar
Damien committed
394
395
}

Damien's avatar
Damien committed
396
397
398
#define OP_ADD_REG_SP_OFFSET(rlo_dest, word_offset) (0xa800 | ((rlo_dest) << 8) | ((word_offset) & 0x00ff))

void asm_thumb_mov_reg_local_addr(asm_thumb_t *as, uint rlo_dest, int local_num) {
399
    assert(rlo_dest < ASM_THUMB_REG_R8);
400
    int word_offset = local_num;
401
    assert(as->pass < ASM_THUMB_PASS_EMIT || word_offset >= 0);
402
    asm_thumb_op16(as, OP_ADD_REG_SP_OFFSET(rlo_dest, word_offset));
Damien's avatar
Damien committed
403
404
405
406
407
408
}

// this could be wrong, because it should have a range of +/- 16MiB...
#define OP_BW_HI(byte_offset) (0xf000 | (((byte_offset) >> 12) & 0x07ff))
#define OP_BW_LO(byte_offset) (0xb800 | (((byte_offset) >> 1) & 0x07ff))

409
void asm_thumb_b_label(asm_thumb_t *as, uint label) {
410
411
    mp_uint_t dest = get_label_dest(as, label);
    mp_int_t rel = dest - as->code_offset;
412
    rel -= 4; // account for instruction prefetch, PC is 4 bytes ahead of this instruction
413
    if (dest != -1 && rel <= -4) {
414
415
416
        // is a backwards jump, so we know the size of the jump on the first pass
        // calculate rel assuming 12 bit relative jump
        if (SIGNED_FIT12(rel)) {
417
            asm_thumb_op16(as, OP_B_N(rel));
Damien's avatar
Damien committed
418
        } else {
419
            goto large_jump;
Damien's avatar
Damien committed
420
        }
421
422
423
    } else {
        // is a forwards jump, so need to assume it's large
        large_jump:
424
        asm_thumb_op32(as, OP_BW_HI(rel), OP_BW_LO(rel));
Damien's avatar
Damien committed
425
426
427
    }
}

428
void asm_thumb_bcc_label(asm_thumb_t *as, int cond, uint label) {
429
430
    mp_uint_t dest = get_label_dest(as, label);
    mp_int_t rel = dest - as->code_offset;
431
    rel -= 4; // account for instruction prefetch, PC is 4 bytes ahead of this instruction
432
    if (dest != -1 && rel <= -4) {
433
        // is a backwards jump, so we know the size of the jump on the first pass
434
        // calculate rel assuming 9 bit relative jump
435
        if (SIGNED_FIT9(rel)) {
436
            asm_thumb_op16(as, OP_BCC_N(cond, rel));
Damien's avatar
Damien committed
437
        } else {
438
            goto large_jump;
Damien's avatar
Damien committed
439
        }
440
441
442
    } else {
        // is a forwards jump, so need to assume it's large
        large_jump:
443
        asm_thumb_op32(as, OP_BCC_W_HI(cond, rel), OP_BCC_W_LO(rel));
Damien's avatar
Damien committed
444
445
446
447
448
449
450
451
    }
}

#define OP_BLX(reg) (0x4780 | ((reg) << 3))
#define OP_SVC(arg) (0xdf00 | (arg))

void asm_thumb_bl_ind(asm_thumb_t *as, void *fun_ptr, uint fun_id, uint reg_temp) {
    /* TODO make this use less bytes
452
453
    uint rlo_base = ASM_THUMB_REG_R3;
    uint rlo_dest = ASM_THUMB_REG_R7;
Damien's avatar
Damien committed
454
    uint word_offset = 4;
455
456
    asm_thumb_op16(as, 0x0000);
    asm_thumb_op16(as, 0x6800 | (word_offset << 6) | (rlo_base << 3) | rlo_dest); // ldr rlo_dest, [rlo_base, #offset]
457
    asm_thumb_op16(as, 0x4780 | (ASM_THUMB_REG_R9 << 3)); // blx reg
Damien's avatar
Damien committed
458
459
    */

460
461
    if (fun_id < 32) {
        // load ptr to function from table, indexed by fun_id (must be in range 0-31); 4 bytes
462
        asm_thumb_op16(as, ASM_THUMB_FORMAT_9_10_ENCODE(ASM_THUMB_FORMAT_9_LDR | ASM_THUMB_FORMAT_9_WORD_TRANSFER, reg_temp, ASM_THUMB_REG_R7, fun_id));
463
        asm_thumb_op16(as, OP_BLX(reg_temp));
Damien's avatar
Damien committed
464
    } else {
465
466
467
        // load ptr to function into register using immediate; 6 bytes
        asm_thumb_mov_reg_i32(as, reg_temp, (mp_uint_t)fun_ptr);
        asm_thumb_op16(as, OP_BLX(reg_temp));
Damien's avatar
Damien committed
468
469
    }
}
470
471

#endif // MICROPY_EMIT_THUMB || MICROPY_EMIT_INLINE_THUMB