machine.asm

   1 ;;; This file define/describes the "machine"
   2 ;;;
   3 ;;; Abstract Machine:
   4 ;;; https://en.wikibooks.org/wiki/X86_Assembly/X86_Architecture
   5 ;;;
   6 ;;; General Purpose Registers ( * marks those used in syscalls )
   7 ;;;  *rax = ( -, eax = ( -, ax = ( ah, al) )) "accumulator"
   8 ;;;   rbx = ( -, ebx = ( -, bx = ( bh, bl) )) "base"
   9 ;;;  *rcx = ( -, ecx = ( -, cx = ( ch, cl) )) "counter"
  10 ;;;  *rdx = ( -, edx = ( -, dx = ( dh, dl) )) "data"
  11 ;;;   rsp = ( -, esp = ( -, sp = ( -, spl) )) "stack pointer"
  12 ;;;   rbp = ( -, ebp = ( -, bp = ( -, bpl) )) "stack base pointer"
  13 ;;;  *rsi = ( -, esi = ( -, si = ( -, sil) )) "source"
  14 ;;;  *rdi = ( -, edi = ( -, di = ( -, dil) )) "destination"
  15 ;;;  *r8
  16 ;;;  *r9
  17 ;;;   r10
  18 ;;;  *r11
  19 ;;;   r12
  20 ;;;   r13
  21 ;;;   r14
  22 ;;;   r15
  23 ;;; clobbers rdi rsi rdx rcx r8 r9 r11
  24 ;;; rax = syscall id
  25 ;;;
  26 ;;; Segment Registers
  27 ;;;   SS "Stack Segment"
  28 ;;;   CS "Code Segment"
  29 ;;;   DS "Data Segment"
  30 ;;;   ES "Extra Segment"
  31 ;;;   FS "more Extra Segment"
  32 ;;;   GS "more more Extra Segment"
  33 ;;;
  34 ;;; EFLAGS Register
  35 ;;;   0,0,0,0,0,0,0,0,0,0,ID,VIP,VIF,AC,VM,RF,
  36 ;;;   0,NT,[IOPL,IOPL],OF,DF,IF,TF,SF,ZF,0,AF,0,PF,1,CF
  37 ;;;
  38 ;;; Instruction pointer
  39 ;;;   EIP
  40 ;;;
  41 ;;; Syscall allocations
  42 ;;; clobbers rdi rsi rdx rcx r8 r9 r11
  43 ;;; rax = syscall id
  44 ;;;
  45
  46 ;;; ######################################################################
  47
  48 ;;; ============================================================
  49 ;;; FORTH machine model
  50 ;;; rsp = data stack pointer
  51 ;;; rbp = return stack pointer
  52 ;;; rsi = instruction pointer
  53
  54 ;;; ========================================
  55 ;;; The pushr macro pushes x onto the return stack
  56 ;;; The popr macro pops x from the return stack
  57 macro pushr x {
  58         sub rbp, 8
  59         mov [rbp], x
  60 }
  61
  62 macro popr x {
  63         mov x, [rbp]
  64         add rbp, 8
  65 }
  66
  67 ;;; ========================================
  68 ;;; The next macro "moves" execution to the next FORTH instruction,
  69 ;;; using rsi as instruction pointer. It points to the doer field of a
  70 ;;; word, which points to the assembly code that implements the
  71 ;;; execution effect of the word. That doer code is entered with rsi
  72 ;;; referring to the subsequent address in the colling word, and rax
  73 ;;; referring to the doer field of the called word.
  74
  75 macro next {
  76         lodsq                   ; mov rax, [rsi] + add rsi,8
  77         jmp qword [rax]         ; goto code of that FORTH word (64 bit jump)
  78 }
  79
  80 ;;; ========================================
  81 ;;; The FORTH macro transitions to inline FORTH execution.
  82 macro FORTH {
  83         local forthcode
  84         mov rsi,forthcode
  85         next
  86         ;; align 8
  87 forthcode:
  88 }
  89
  90 ;;; ========================================
  91 ;;; The ENDFORTH macro transitions back to inline assembler after FORTH
  92
  93 macro ENDFORTH {
  94         dq inline_code
  95 }
  96
  97 ;;; ========================================
  98 ;;; The DOFORTH lays out a single FORTH call
  99
 100 macro DOFORTH label {
 101         FORTH
 102         dq label
 103         ENDFORTH
 104 }
 105
 106 ;;; ========================================
 107 ;;; Macro WORD starts a FORTH word definition in this code.
 108 ;;; The layout of a word is as follows:
 109 ;;; TFA: [8 bytes] pointer to previous word in the word list
 110 ;;;      [8 bytes] pointer to the word's CFA
 111 ;;;      [8 bytes] a flags field
 112 ;;;      [8 bytes] the length of the word's pname
 113 ;;;      [varying] the word's pname
 114 ;;;      [1 byte]  NUL -- making an asciiz of the pname
 115 ;;;      ;;[? bytes] 0-7 bytes for address alignment to [disabled]
 116 ;;;      [8 bytes] pointer to the word's TFA
 117 ;;; OFF: [8 bytes] the DOES offset for the word
 118 ;;; CFA: [8 bytes] pointer to the word's "doer" code
 119 ;;; DFA: [? bytes] the word's data field
 120
 121 IMMEDIATE = 1           ; optional flag (symbol)
 122
 123 macro WORD label, name, doer, flags, previous, offset {
 124         local pname
 125         ;; align 8
 126 label#_TFA:
 127         ;; TFA
 128         if previous eq
 129             dq previous_word
 130         else
 131             dq previous
 132         end if
 133         previous_word = label#_TFA
 134         ;; PFA
 135 label#_pCFA:
 136         dq label#_CFA           ; link to CFA of word
 137         dq flags + 0
 138 label#_PFA:
 139         dq pname - $ - 8
 140         db name
 141 pname:  db 0                    ; extra NUL byte
 142         ;; align 8
 143 label#_pTFA:
 144         dq label#_TFA           ; link to TFA of word
 145 label#_OFF:
 146         dq offset + 0           ; The DOES offset. Defaults to 0.
 147         ;; also CFA = pointer to "doer"
 148 label#_CFA:
 149 label:
 150         if doer eq
 151             dq doforth
 152         else
 153             if doer in <fasm>
 154                 dq dofasm ; label#_DFA
 155             else
 156                 dq doer
 157             end if
 158         end if
 159         ;; DFA
 160 label#_DFA:
 161 }
 162
 163 macro tfa2cfa reg {
 164         mov reg,qword [reg+8]
 165 }
 166 macro tfa2does reg {
 167         tfa2cfa reg
 168         sub reg,8
 169 }
 170 macro tfa2dfa reg {
 171         tfa2cfa reg
 172         add reg,8
 173 }
 174 macro tfa2flags reg {
 175         add reg,16
 176 }
 177 macro tfa2pfa reg {
 178         add reg,24
 179 }
 180 macro tfa2pname reg {
 181         add reg,32
 182 }
 183 macro cfa2tfa reg {
 184         sub reg,16
 185         mov reg,qword [reg]
 186 }
 187 macro cfa2dfa reg {
 188         add reg,8
 189 }
 190 macro dfa2cfa reg {
 191         sub reg,8
 192 }
 193 macro dfa2tfa reg {
 194         sub reg,24
 195         mov reg,qword [reg]
 196 }
 197 ;;; Code snippet to push a pname string with address and 64-bit length field.
 198 ;;; The register is advanced to point at the text part.
 199 macro pushpname reg {
 200         add reg,8
 201         push reg
 202         push qword [reg-8]
 203 }
 204 ;;; ========================================
 205 ;;; The BLOCK macro lays out the length for a subsequent block to the
 206 ;;; given label.
 207 macro BLOCK endlabel {
 208         local datastart
 209         dq endlabel - datastart
 210 datastart:
 211         }
 212
 213 ;;; ========================================
 214 ;;; The STRING macro lays out length cell and data for several string
 215 ;;; components.
 216 macro STRING [data] {
 217 common
 218         local datastart, dataend
 219         dq dataend - datastart
 220 datastart:
 221 forward
 222         db data
 223 common
 224 dataend:
 225         }
 226
 227 ;;; ========================================
 228 ;;; The BRANCH macro lays out FORTH words BRANCH and 0BRANCH with offset
 229 macro BRANCH zero,label {
 230         if zero in <0>
 231             dq p_zero_branch
 232         else
 233             dq p_branch
 234         end if
 235         dq label - $ - 8
 236 }
 237
 238 ;;; ========================================
 239 ;;; The STREAM macro starts an in-core FORTH STREAM area. See WORD
 240 ;;; STREAM for details.
 241         macro STREAM endlabel {
 242         local datastart
 243         dq $+32
 244         dq -1
 245         dq endlabel - datastart
 246         dq 0
 247 datastart:
 248         }