doc: Add gdb assembly debugging info.
[mes.git] / HACKING
1 -*-mode:org-*-
2
3 * Fully source-based bootstrapping
4
5 ** R6RS-like scheme interpreter
6 This first part is prototyped in C by the mes.c core and Scheme
7 bootstrap code in module/.  Of course, while mes.c is pretty small it
8 cannot serve as a fully source-based solution.
9
10 The initial idea was to have the minimal core support LISP-1.5 (or
11 something very close to that as a tribute to John McCarthy) and extend
12 eval/apply from LISP-1.5 source with define, define-macro etc. and
13 metamorphose into R6RS.  It seemed to work but performance of the
14 LISP-intepreted RRS was so bad (~1000x slower than initial LISP-1.5)
15 that this track was abandoned after the initial ANNOUNCE.
16
17 The route changed, trying to strike a balance between core size and
18 performance: still writing as much as possible in Scheme but having a
19 mescc compiler that takes not more than some seconds to run.
20
21 Now that we have [[https://github.com/schemeway/lalr-scm][Dominique Boucher's LALR]], a [[https://www.cs.indiana.edu/chezscheme/syntax-case/old-psyntax.html][Pre-R6RS portable
22 syntax-case]] with R7RS ellipsis, [[http://www.nongnu.org/nyacc/][Nyacc]] and [[https://www.gnu.org/software/guile/docs/master/guile.html/PEG-Parsing.html][Guile's PEG]] parsers, it's
23 time to start doing something useful.
24
25 * Bugs
26 ** The Scheme reader is very slow.
27 ** Catch/throw are a syntax only hack for Nyacc.
28 ** Fluids are a hack for Nyacc.
29 ** Prototype mes.c depends on a C compiler.
30 *** Translate C-prototype mes.c into annotated hex?
31 One idea is to use OriansJ's amazing self-hosting [[https://github.com/oriansj/stage0][stage0]] hex assembler
32 and minimal bootstrap binaries and rewrite the mes.c core to directly
33 bootstrap into Scheme.
34
35 *** Rewrite mes.c in Schemy/Sexp-C and generate annotated hex?
36 Another idea (thanks Rutger!) is to rewrite the mes.c core in a s-exp
37 C/Assembly variant and thave mescc produce the simple, annotated
38 bootstrap binary.
39
40 ** Actually do something useful
41 *** Rewrite the mescc compiler to work on the Nyacc AST.
42 The proof-of-concept mescc compiler uses a simple, whoefully
43 incomplete AST produced by a simplistic LALR-based C-parser.
44 *** Implement more bits of the compiler.
45 As Mes now runs Nyacc, and Guile runs the mescc compiler, this
46 compiler can be developed using Guile.
47 *** Compile mes.c using mescc.
48 A first milestone, next up is...
49 *** Compile the [[https://en.wikipedia.org/wiki/Tiny_C_Compiler][Tiny C Compiler]]
50
51 * OLD: Booting from LISP-1.5 into Mes
52
53 Mes started out experimenting with booting from a hex-coded minimal
54 LISP-1.5 (prototype in mes.c), into an almost-RRS Scheme.
55
56 When EOF is read, the LISP-1.5 machine calls loop2 from loop2.mes,
57 which reads the rest of stdin and takes over control.  The functions
58 readenv, eval and apply-env in mes.mes introduced define, define-macro
59 quasiquote and macro expansion.
60
61 While this works, it's amazingly slow.  We implemented a full reader
62 in mes.c, which makes running mes:apply-env mes:eval somewhat
63 bearable, still over 1000x slower than running mes.c.
64
65 Bootstrapping has been removed and mes.c implements enough of RRS to
66 run a macro-based define-syntax and syntax-rules.
67
68 loop.mes and mes.mes are unused and lagging behind.  Probably it's not
69 worth considering this route without a VM.  GNU Epsilon is taking the
70 more usual VM-route to provide multiple personas.  While that sounds
71 neat, Lisp/Scheme, bootstrapping and trusted binaries are probably not
72 in scope as there is no mention of such things; only ML is mentioned
73 while Guile is used for bootstrapping.
74
75 * Assorted ideas and info 
76 ** Using GDB on assembly/a.out
77 info registers
78 p/x $eax
79 p/x $edx
80 set disassemble-next-line
81 gdb-display-disassembly-buffer
82 b *0x804a79d
83 ** Create memory dump with 32 bit Gcc compiled Mes
84 guix environment --ad-hoc --system=i686-linux gcc-toolchain -- bash -c 'make mes CC=i686-unknown-linux-gnu-gcc LIBRARY_PATH=${PATH%%/bin:*}/lib'
85 MES_HACK=1 ./mes-32 --dump < module/mes/read-0.mes > module/mes/read-0-32.mo
86 ** C parser/compiler
87 *** [[https://savannah.gnu.org/projects/nyacc][nyacc]]
88 *** PEG: [[http://piumarta.com/software/peg/][parse C using PEG]]
89 *** [[https://en.wikipedia.org/wiki/Tiny_C_Compiler][Tiny C Compiler]]
90 *** [[http://www.t3x.org/subc/index.html][Sub C]]
91 *** [[https://groups.google.com/forum/#!topic/comp.lang.lisp/VPuX0VsjTTE][C intepreter in LISP/Scheme/Python]]
92
93 ** C assembler/linker
94 *** [[http://www.tldp.org/HOWTO/Assembly-HOWTO/linux.html][Assembly HOWTO]]
95 *** System call clue bat
96 Basically, you issue an int 0x80, with the __NR_syscallname number
97 (from asm/unistd.h) in eax, and parameters (up to six) in ebx, ecx,
98 edx, esi, edi, ebp respectively.
99 *** ELF
100 7f 45 4c 46
101 *** [[http://www.muppetlabs.com/~breadbox/software/tiny/][Small ELF programs]]
102 *** [[http://www.cirosantilli.com/elf-hello-world/][Elf hello world]]
103
104 ** SC - c as s-expressions
105 sc: http://sph.mn/content/3d3
106 ** RNRS
107 *** [[http://www.scheme-reports.org/][Scheme Reports]] 
108 *** [[ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-349.pdf][Scheme - Report on Scheme]]
109 *** [[ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-452.pdf][RRS - Revised Report on Scheme]]