MIPS: Update docs.
[luajit-2.0.git] / dynasm / dasm_arm.h
blobb770c2df33d2715a5d5d0e57c8e5bb18f2a2c483
1 /*
2 ** DynASM ARM encoding engine.
3 ** Copyright (C) 2005-2012 Mike Pall. All rights reserved.
4 ** Released under the MIT license. See dynasm.lua for full copyright notice.
5 */
7 #include <stddef.h>
8 #include <stdarg.h>
9 #include <string.h>
10 #include <stdlib.h>
12 #define DASM_ARCH "arm"
14 #ifndef DASM_EXTERN
15 #define DASM_EXTERN(a,b,c,d) 0
16 #endif
18 /* Action definitions. */
19 enum {
20 DASM_STOP, DASM_SECTION, DASM_ESC, DASM_REL_EXT,
21 /* The following actions need a buffer position. */
22 DASM_ALIGN, DASM_REL_LG, DASM_LABEL_LG,
23 /* The following actions also have an argument. */
24 DASM_REL_PC, DASM_LABEL_PC,
25 DASM_IMM, DASM_IMM12, DASM_IMM16, DASM_IMML8, DASM_IMML12,
26 DASM__MAX
29 /* Maximum number of section buffer positions for a single dasm_put() call. */
30 #define DASM_MAXSECPOS 25
32 /* DynASM encoder status codes. Action list offset or number are or'ed in. */
33 #define DASM_S_OK 0x00000000
34 #define DASM_S_NOMEM 0x01000000
35 #define DASM_S_PHASE 0x02000000
36 #define DASM_S_MATCH_SEC 0x03000000
37 #define DASM_S_RANGE_I 0x11000000
38 #define DASM_S_RANGE_SEC 0x12000000
39 #define DASM_S_RANGE_LG 0x13000000
40 #define DASM_S_RANGE_PC 0x14000000
41 #define DASM_S_RANGE_REL 0x15000000
42 #define DASM_S_UNDEF_LG 0x21000000
43 #define DASM_S_UNDEF_PC 0x22000000
45 /* Macros to convert positions (8 bit section + 24 bit index). */
46 #define DASM_POS2IDX(pos) ((pos)&0x00ffffff)
47 #define DASM_POS2BIAS(pos) ((pos)&0xff000000)
48 #define DASM_SEC2POS(sec) ((sec)<<24)
49 #define DASM_POS2SEC(pos) ((pos)>>24)
50 #define DASM_POS2PTR(D, pos) (D->sections[DASM_POS2SEC(pos)].rbuf + (pos))
52 /* Action list type. */
53 typedef const unsigned int *dasm_ActList;
55 /* Per-section structure. */
56 typedef struct dasm_Section {
57 int *rbuf; /* Biased buffer pointer (negative section bias). */
58 int *buf; /* True buffer pointer. */
59 size_t bsize; /* Buffer size in bytes. */
60 int pos; /* Biased buffer position. */
61 int epos; /* End of biased buffer position - max single put. */
62 int ofs; /* Byte offset into section. */
63 } dasm_Section;
65 /* Core structure holding the DynASM encoding state. */
66 struct dasm_State {
67 size_t psize; /* Allocated size of this structure. */
68 dasm_ActList actionlist; /* Current actionlist pointer. */
69 int *lglabels; /* Local/global chain/pos ptrs. */
70 size_t lgsize;
71 int *pclabels; /* PC label chains/pos ptrs. */
72 size_t pcsize;
73 void **globals; /* Array of globals (bias -10). */
74 dasm_Section *section; /* Pointer to active section. */
75 size_t codesize; /* Total size of all code sections. */
76 int maxsection; /* 0 <= sectionidx < maxsection. */
77 int status; /* Status code. */
78 dasm_Section sections[1]; /* All sections. Alloc-extended. */
81 /* The size of the core structure depends on the max. number of sections. */
82 #define DASM_PSZ(ms) (sizeof(dasm_State)+(ms-1)*sizeof(dasm_Section))
85 /* Initialize DynASM state. */
86 void dasm_init(Dst_DECL, int maxsection)
88 dasm_State *D;
89 size_t psz = 0;
90 int i;
91 Dst_REF = NULL;
92 DASM_M_GROW(Dst, struct dasm_State, Dst_REF, psz, DASM_PSZ(maxsection));
93 D = Dst_REF;
94 D->psize = psz;
95 D->lglabels = NULL;
96 D->lgsize = 0;
97 D->pclabels = NULL;
98 D->pcsize = 0;
99 D->globals = NULL;
100 D->maxsection = maxsection;
101 for (i = 0; i < maxsection; i++) {
102 D->sections[i].buf = NULL; /* Need this for pass3. */
103 D->sections[i].rbuf = D->sections[i].buf - DASM_SEC2POS(i);
104 D->sections[i].bsize = 0;
105 D->sections[i].epos = 0; /* Wrong, but is recalculated after resize. */
109 /* Free DynASM state. */
110 void dasm_free(Dst_DECL)
112 dasm_State *D = Dst_REF;
113 int i;
114 for (i = 0; i < D->maxsection; i++)
115 if (D->sections[i].buf)
116 DASM_M_FREE(Dst, D->sections[i].buf, D->sections[i].bsize);
117 if (D->pclabels) DASM_M_FREE(Dst, D->pclabels, D->pcsize);
118 if (D->lglabels) DASM_M_FREE(Dst, D->lglabels, D->lgsize);
119 DASM_M_FREE(Dst, D, D->psize);
122 /* Setup global label array. Must be called before dasm_setup(). */
123 void dasm_setupglobal(Dst_DECL, void **gl, unsigned int maxgl)
125 dasm_State *D = Dst_REF;
126 D->globals = gl - 10; /* Negative bias to compensate for locals. */
127 DASM_M_GROW(Dst, int, D->lglabels, D->lgsize, (10+maxgl)*sizeof(int));
130 /* Grow PC label array. Can be called after dasm_setup(), too. */
131 void dasm_growpc(Dst_DECL, unsigned int maxpc)
133 dasm_State *D = Dst_REF;
134 size_t osz = D->pcsize;
135 DASM_M_GROW(Dst, int, D->pclabels, D->pcsize, maxpc*sizeof(int));
136 memset((void *)(((unsigned char *)D->pclabels)+osz), 0, D->pcsize-osz);
139 /* Setup encoder. */
140 void dasm_setup(Dst_DECL, const void *actionlist)
142 dasm_State *D = Dst_REF;
143 int i;
144 D->actionlist = (dasm_ActList)actionlist;
145 D->status = DASM_S_OK;
146 D->section = &D->sections[0];
147 memset((void *)D->lglabels, 0, D->lgsize);
148 if (D->pclabels) memset((void *)D->pclabels, 0, D->pcsize);
149 for (i = 0; i < D->maxsection; i++) {
150 D->sections[i].pos = DASM_SEC2POS(i);
151 D->sections[i].ofs = 0;
156 #ifdef DASM_CHECKS
157 #define CK(x, st) \
158 do { if (!(x)) { \
159 D->status = DASM_S_##st|(p-D->actionlist-1); return; } } while (0)
160 #define CKPL(kind, st) \
161 do { if ((size_t)((char *)pl-(char *)D->kind##labels) >= D->kind##size) { \
162 D->status = DASM_S_RANGE_##st|(p-D->actionlist-1); return; } } while (0)
163 #else
164 #define CK(x, st) ((void)0)
165 #define CKPL(kind, st) ((void)0)
166 #endif
168 static int dasm_imm12(unsigned int n)
170 int i;
171 for (i = 0; i < 16; i++, n = (n << 2) | (n >> 30))
172 if (n <= 255) return (int)(n + (i << 8));
173 return -1;
176 /* Pass 1: Store actions and args, link branches/labels, estimate offsets. */
177 void dasm_put(Dst_DECL, int start, ...)
179 va_list ap;
180 dasm_State *D = Dst_REF;
181 dasm_ActList p = D->actionlist + start;
182 dasm_Section *sec = D->section;
183 int pos = sec->pos, ofs = sec->ofs;
184 int *b;
186 if (pos >= sec->epos) {
187 DASM_M_GROW(Dst, int, sec->buf, sec->bsize,
188 sec->bsize + 2*DASM_MAXSECPOS*sizeof(int));
189 sec->rbuf = sec->buf - DASM_POS2BIAS(pos);
190 sec->epos = (int)sec->bsize/sizeof(int) - DASM_MAXSECPOS+DASM_POS2BIAS(pos);
193 b = sec->rbuf;
194 b[pos++] = start;
196 va_start(ap, start);
197 while (1) {
198 unsigned int ins = *p++;
199 unsigned int action = (ins >> 16);
200 if (action >= DASM__MAX) {
201 ofs += 4;
202 } else {
203 int *pl, n = action >= DASM_REL_PC ? va_arg(ap, int) : 0;
204 switch (action) {
205 case DASM_STOP: goto stop;
206 case DASM_SECTION:
207 n = (ins & 255); CK(n < D->maxsection, RANGE_SEC);
208 D->section = &D->sections[n]; goto stop;
209 case DASM_ESC: p++; ofs += 4; break;
210 case DASM_REL_EXT: break;
211 case DASM_ALIGN: ofs += (ins & 255); b[pos++] = ofs; break;
212 case DASM_REL_LG:
213 n = (ins & 2047) - 10; pl = D->lglabels + n;
214 if (n >= 0) { CKPL(lg, LG); goto putrel; } /* Bkwd rel or global. */
215 pl += 10; n = *pl;
216 if (n < 0) n = 0; /* Start new chain for fwd rel if label exists. */
217 goto linkrel;
218 case DASM_REL_PC:
219 pl = D->pclabels + n; CKPL(pc, PC);
220 putrel:
221 n = *pl;
222 if (n < 0) { /* Label exists. Get label pos and store it. */
223 b[pos] = -n;
224 } else {
225 linkrel:
226 b[pos] = n; /* Else link to rel chain, anchored at label. */
227 *pl = pos;
229 pos++;
230 break;
231 case DASM_LABEL_LG:
232 pl = D->lglabels + (ins & 2047) - 10; CKPL(lg, LG); goto putlabel;
233 case DASM_LABEL_PC:
234 pl = D->pclabels + n; CKPL(pc, PC);
235 putlabel:
236 n = *pl; /* n > 0: Collapse rel chain and replace with label pos. */
237 while (n > 0) { int *pb = DASM_POS2PTR(D, n); n = *pb; *pb = pos;
239 *pl = -pos; /* Label exists now. */
240 b[pos++] = ofs; /* Store pass1 offset estimate. */
241 break;
242 case DASM_IMM:
243 case DASM_IMM16:
244 #ifdef DASM_CHECKS
245 CK((n & ((1<<((ins>>10)&31))-1)) == 0, RANGE_I);
246 if ((ins & 0x8000))
247 CK(((n + (1<<(((ins>>5)&31)-1)))>>((ins>>5)&31)) == 0, RANGE_I);
248 else
249 CK((n>>((ins>>5)&31)) == 0, RANGE_I);
250 #endif
251 b[pos++] = n;
252 break;
253 case DASM_IMML8:
254 case DASM_IMML12:
255 CK(n >= 0 ? ((n>>((ins>>5)&31)) == 0) :
256 (((-n)>>((ins>>5)&31)) == 0), RANGE_I);
257 b[pos++] = n;
258 break;
259 case DASM_IMM12:
260 CK(dasm_imm12((unsigned int)n) != -1, RANGE_I);
261 b[pos++] = n;
262 break;
266 stop:
267 va_end(ap);
268 sec->pos = pos;
269 sec->ofs = ofs;
271 #undef CK
273 /* Pass 2: Link sections, shrink aligns, fix label offsets. */
274 int dasm_link(Dst_DECL, size_t *szp)
276 dasm_State *D = Dst_REF;
277 int secnum;
278 int ofs = 0;
280 #ifdef DASM_CHECKS
281 *szp = 0;
282 if (D->status != DASM_S_OK) return D->status;
284 int pc;
285 for (pc = 0; pc*sizeof(int) < D->pcsize; pc++)
286 if (D->pclabels[pc] > 0) return DASM_S_UNDEF_PC|pc;
288 #endif
290 { /* Handle globals not defined in this translation unit. */
291 int idx;
292 for (idx = 20; idx*sizeof(int) < D->lgsize; idx++) {
293 int n = D->lglabels[idx];
294 /* Undefined label: Collapse rel chain and replace with marker (< 0). */
295 while (n > 0) { int *pb = DASM_POS2PTR(D, n); n = *pb; *pb = -idx; }
299 /* Combine all code sections. No support for data sections (yet). */
300 for (secnum = 0; secnum < D->maxsection; secnum++) {
301 dasm_Section *sec = D->sections + secnum;
302 int *b = sec->rbuf;
303 int pos = DASM_SEC2POS(secnum);
304 int lastpos = sec->pos;
306 while (pos != lastpos) {
307 dasm_ActList p = D->actionlist + b[pos++];
308 while (1) {
309 unsigned int ins = *p++;
310 unsigned int action = (ins >> 16);
311 switch (action) {
312 case DASM_STOP: case DASM_SECTION: goto stop;
313 case DASM_ESC: p++; break;
314 case DASM_REL_EXT: break;
315 case DASM_ALIGN: ofs -= (b[pos++] + ofs) & (ins & 255); break;
316 case DASM_REL_LG: case DASM_REL_PC: pos++; break;
317 case DASM_LABEL_LG: case DASM_LABEL_PC: b[pos++] += ofs; break;
318 case DASM_IMM: case DASM_IMM12: case DASM_IMM16:
319 case DASM_IMML8: case DASM_IMML12: pos++; break;
322 stop: (void)0;
324 ofs += sec->ofs; /* Next section starts right after current section. */
327 D->codesize = ofs; /* Total size of all code sections */
328 *szp = ofs;
329 return DASM_S_OK;
332 #ifdef DASM_CHECKS
333 #define CK(x, st) \
334 do { if (!(x)) return DASM_S_##st|(p-D->actionlist-1); } while (0)
335 #else
336 #define CK(x, st) ((void)0)
337 #endif
339 /* Pass 3: Encode sections. */
340 int dasm_encode(Dst_DECL, void *buffer)
342 dasm_State *D = Dst_REF;
343 char *base = (char *)buffer;
344 unsigned int *cp = (unsigned int *)buffer;
345 int secnum;
347 /* Encode all code sections. No support for data sections (yet). */
348 for (secnum = 0; secnum < D->maxsection; secnum++) {
349 dasm_Section *sec = D->sections + secnum;
350 int *b = sec->buf;
351 int *endb = sec->rbuf + sec->pos;
353 while (b != endb) {
354 dasm_ActList p = D->actionlist + *b++;
355 while (1) {
356 unsigned int ins = *p++;
357 unsigned int action = (ins >> 16);
358 int n = (action >= DASM_ALIGN && action < DASM__MAX) ? *b++ : 0;
359 switch (action) {
360 case DASM_STOP: case DASM_SECTION: goto stop;
361 case DASM_ESC: *cp++ = *p++; break;
362 case DASM_REL_EXT:
363 n = DASM_EXTERN(Dst, (unsigned char *)cp, (ins&2047), !(ins&2048));
364 goto patchrel;
365 case DASM_ALIGN:
366 ins &= 255; while ((((char *)cp - base) & ins)) *cp++ = 0xe1a00000;
367 break;
368 case DASM_REL_LG:
369 CK(n >= 0, UNDEF_LG);
370 case DASM_REL_PC:
371 CK(n >= 0, UNDEF_PC);
372 n = *DASM_POS2PTR(D, n) - (int)((char *)cp - base) - 4;
373 patchrel:
374 if ((ins & 0x800) == 0) {
375 CK((n & 3) == 0 && ((n+0x02000000) >> 26) == 0, RANGE_REL);
376 cp[-1] |= ((n >> 2) & 0x00ffffff);
377 } else if ((ins & 0x1000)) {
378 CK((n & 3) == 0 && -256 <= n && n <= 256, RANGE_REL);
379 goto patchimml8;
380 } else {
381 CK((n & 3) == 0 && -4096 <= n && n <= 4096, RANGE_REL);
382 goto patchimml12;
384 break;
385 case DASM_LABEL_LG:
386 ins &= 2047; if (ins >= 20) D->globals[ins-10] = (void *)(base + n);
387 break;
388 case DASM_LABEL_PC: break;
389 case DASM_IMM:
390 cp[-1] |= ((n>>((ins>>10)&31)) & ((1<<((ins>>5)&31))-1)) << (ins&31);
391 break;
392 case DASM_IMM12:
393 cp[-1] |= dasm_imm12((unsigned int)n);
394 break;
395 case DASM_IMM16:
396 cp[-1] |= ((n & 0xf000) << 4) | (n & 0x0fff);
397 break;
398 case DASM_IMML8: patchimml8:
399 cp[-1] |= n >= 0 ? (0x00800000 | (n & 0x0f) | ((n & 0xf0) << 4)) :
400 ((-n & 0x0f) | ((-n & 0xf0) << 4));
401 break;
402 case DASM_IMML12: patchimml12:
403 cp[-1] |= n >= 0 ? (0x00800000 | n) : (-n);
404 break;
405 default: *cp++ = ins; break;
408 stop: (void)0;
412 if (base + D->codesize != (char *)cp) /* Check for phase errors. */
413 return DASM_S_PHASE;
414 return DASM_S_OK;
416 #undef CK
418 /* Get PC label offset. */
419 int dasm_getpclabel(Dst_DECL, unsigned int pc)
421 dasm_State *D = Dst_REF;
422 if (pc*sizeof(int) < D->pcsize) {
423 int pos = D->pclabels[pc];
424 if (pos < 0) return *DASM_POS2PTR(D, -pos);
425 if (pos > 0) return -1; /* Undefined. */
427 return -2; /* Unused or out of range. */
430 #ifdef DASM_CHECKS
431 /* Optional sanity checker to call between isolated encoding steps. */
432 int dasm_checkstep(Dst_DECL, int secmatch)
434 dasm_State *D = Dst_REF;
435 if (D->status == DASM_S_OK) {
436 int i;
437 for (i = 1; i <= 9; i++) {
438 if (D->lglabels[i] > 0) { D->status = DASM_S_UNDEF_LG|i; break; }
439 D->lglabels[i] = 0;
442 if (D->status == DASM_S_OK && secmatch >= 0 &&
443 D->section != &D->sections[secmatch])
444 D->status = DASM_S_MATCH_SEC|(D->section-D->sections);
445 return D->status;
447 #endif