summaryrefslogtreecommitdiff
path: root/twasm/README.md
blob: 7d0309d5743f480acd1849ca3d9cf8b241c4ebbe (plain)
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
# twasm

this will be a self hosted, very minimal subset of nasm-style 64 bit asm

### goals

I want to compile Bootler and Twasm with the Twasm assembler

### reading

- [instructions](https://www.felixcloutier.com/x86/)
- [opcodes,ModR/M,SIB](http://ref.x86asm.net/coder64.html) (no secure site available)
- [calling conventions](https://wiki.osdev.org/Calling_Conventions); I try to use System V

### memory map

```
+------ 0x00100000 ------+
| hardware, bios stuff   |
+------ 0x00080000 ------+
| output binary          |
+------ 0x00070000 ------+
| token table            |
+------ 0x00060000 ------+
| test arena             |
+------ 0x00050000 ------+
| stack (rsp)            |
+------------------------+
| input                  |
+------------------------+
| assembler              |
+------ 0x00010000 ------+
| bootloader, bios, etc. |
+------------------------+
```

each word represents a token on the token table.

#### token table (TT)

each token gets loaded into the token table with the following form:

```
+----------+
| 15     0 |
+----------+
| token id |
+----------+
```

### token IDs

supported tokens are listed below

| token | id     | notes |
|-------|--------|-|
| rax   | 0x0000 | |
| rbx   | 0x0001 | |
| rcx   | 0x0002 | |
| rdx   | 0x0003 | |
| rsi   | 0x0004 | |
| rdi   | 0x0005 | |
| rsp   | 0x0006 | |
| rbp   | 0x0007 | |
| r8    | 0x0008 | |
| r9    | 0x0009 | |
| r10   | 0x000A | |
| r11   | 0x000B | |
| r12   | 0x000C | |
| r13   | 0x000D | |
| r14   | 0x000E | |
| r15   | 0x000F | |
| eax   | 0x0010 | |
| ebx   | 0x0011 | |
| ecx   | 0x0012 | |
| edx   | 0x0013 | |
| esi   | 0x0014 | |
| edi   | 0x0015 | |
| esp   | 0x0016 | |
| ebp   | 0x0017 | |
| r8d   | 0x0018 | |
| r9d   | 0x0019 | |
| r10d  | 0x001A | |
| r11d  | 0x001B | |
| r12d  | 0x001C | |
| r13d  | 0x001D | |
| r14d  | 0x001E | |
| r15d  | 0x001F | |
| ax    | 0x0020 | |
| bx    | 0x0021 | |
| cx    | 0x0022 | |
| dx    | 0x0023 | |
| si    | 0x0024 | |
| di    | 0x0025 | |
| sp    | 0x0026 | |
| bp    | 0x0027 | |
| r8w   | 0x0028 | |
| r9w   | 0x0029 | |
| r10w  | 0x002A | |
| r11w  | 0x002B | |
| r12w  | 0x002C | |
| r13w  | 0x002D | |
| r14w  | 0x002E | |
| r15w  | 0x002F | |
| al    | 0x0030 | |
| bl    | 0x0031 | |
| cl    | 0x0032 | |
| dl    | 0x0033 | |
| sil   | 0x0034 | |
| dil   | 0x0035 | |
| spl   | 0x0036 | |
| bpl   | 0x0037 | |
| r8b   | 0x0038 | |
| r9b   | 0x0039 | |
| r10b  | 0x003A | |
| r11b  | 0x003B | |
| r12b  | 0x003C | |
| r13b  | 0x003D | |
| r14b  | 0x003E | |
| r15b  | 0x003F | |
| ah    | 0x0040 | |
| bh    | 0x0041 | |
| ch    | 0x0042 | |
| dh    | 0x0043 | |
| cs    | 0x0044 | |
| ds    | 0x0045 | |
| es    | 0x0046 | |
| fs    | 0x0047 | |
| gs    | 0x0048 | |
| ss    | 0x0049 | |
| cr0   | 0x004A | |
| cr2   | 0x004B | |
| cr3   | 0x004C | |
| cr4   | 0x004D | |
| cr8   | 0x004E | |
| hlt   | 0x004F | |
| int3  | 0x0050 | |
| [     | 0x0051 | open bracket placeholder; 0x10XX should be used in contexts where the surrounding tokens can be known |
| ]     | 0x0052 | |
| xor   | 0x0053 | |
| inc   | 0x0054 | |
| dec   | 0x0055 | |
| mov   | 0x0056 | |
| add   | 0x0057 | |
| sub   | 0x0058 | |
| call  | 0x0059 | |
| ret   | 0x005A | |
| cmp   | 0x005B | |
| je    | 0x005C | |
| jne   | 0x005D | |
| jge   | 0x005E | |
| jg    | 0x005F | |
| jle   | 0x0060 | |
| jl    | 0x0061 | |
| +     | 0x0062 | |
| -     | 0x0063 | |
| *     | 0x0064 | |
| /     | 0x0065 | |
| [     | 0x10XX | open bracket with `XX` bytes until the closing bracket |
|       | 0xFEXX | token terminator byte as token, where `XX` is the byte |
|       | 0xFFFF | unrecognised token |

### example program

#### program in assembly

this program doesn't do anything useful, it's just a test

```nasm
xor eax, eax
inc rax
mov [ rax ], rdx
hlt

```

#### tokenization

```nasm
0x0053 ; xor
0xFE20 ; space
0x0010 ; eax
0xFE2C ; comma
0xFE20 ; space
0x0010 ; eax
0xFE0A ; newline
0x0054 ; inc
0xFE20 ; space
0x0000 ; rax
0xFE0A ; newline
0x0056 ; mov
0xFE20 ; space
0x1004 ; open bracket (4)
0xFE20 ; space         |1
0x0000 ; rax           |2
0xFE20 ; space         |3
0x0052 ; close bracket |4
0xFE2C ; comma
0xFE20 ; space
0x0003 ; rdx
0xFE0A ; newline
0x004F ; hlt
0xFE0A ; newline
0xFE00 ; null terminator
```

#### nasm output with the above example program, bits 64

```nasm
0x31 ; XOR r/m16/32/64 r16/32/64
0xC0 ; ModR/M byte
     ; mod 11b  ; directly address the following:
     ; reg 000b ; EAX
     ; r/m 000b ; EAX

0x48 ; 64 Bit Operand Size prefix
0xFF ; with `reg` from ModR/M byte 000b:
     ; INC r/m16/32/64
0xC0 ; ModR/M byte
     ; mod 11b  ; direct addressing
     ; reg 000b ; RAX
     ; r/m 000b ; RAX

0x48 ; 64 Bit Operand Size prefix
0x89 ; MOV r/m16/32/64 r16/32/64
0x10 ; ModR/M byte
     ; mod 00b  ; indirect addressing, no displacement
     ; reg 010b ; RDX
     ; r/m 000b ; [RAX]

0xF4 ; HLT
```