GNU Mes.
[mes.git] / HACKING
1 -*-mode:org-*-
2
3 #+TITLE: Hacking GNU Mes
4
5 * SETUP
6     guix environment -l .guix.scm     #64 bit + 32bit
7
8 or
9
10     guix environment --system=i686-linux -l .guix.scm #32 bit only
11
12 or
13
14     guix package --profile=~/.config/guix/mes --manifest=build-aux/manifest.scm
15     . ~/.config/guix/mes/etc/profile
16
17 * BUILD
18 There are two major modes to build Mes: true bootstrap and
19 development.
20
21 ** DEVELOPMENT BUILD
22 To help development we assume ./configure sets these variables for make
23
24    CC     -- gcc
25    CC32   -- i686-unknown-linux-gnu-gcc (or on x86, also gcc)
26    GUILE  -- guile
27    HEX2   -- hex2
28    MES    -- unset
29    M1     -- M1
30    prefix -- ""
31
32 Mes is supposed to serve as a full equivalent for Guile, however Mes
33 ~30 times slower than Guile.  That's why we usually don't use Mes
34 during development.
35
36 Gcc is used to verify the sanity of our C sources.
37
38 i686-unknown-linux-gnu-gcc is used to compare hex/assembly, to test
39 the gcc variant of Mes-libc: lib/libc-gcc.c and steal ideas.  Target
40 prefix: mlibc-gcc.
41
42 Guile is used to develop MesCC, the C compiler in Scheme that during
43 bootstrapping will be executed by Mes.
44
45 mes is built from src/*.c and some out/src/*.h files that are snarfed from
46 src/*.c by build-aux/mes-snarf.scm.
47
48 Running ./make.scm produces a `script' file.
49
50 ** BOOTSTRAP BUILD
51
52     ./build.sh
53
54 In bootstrap mode, we don't have gcc (CC), we don't have a 32 bit gcc
55 (CC32), we have no guile (GUILE)...but we should have hex2, M1, and
56 mes.M1.  That's a bootstrap problem which is currently ignored by
57 using the mes-seed package.  mes.M1 will be produced by M2-Planet from
58 mes.c.
59
60
61 * ROADMAP
62 ** TODO
63 *** release 0.x, unsorted
64   - upstream mes-boot to GuixSD.
65   - add full source gcc-4.7 package build.
66   - replace GuixSD bootstrap for x86.
67   - replace bootstrap utils (with gash?): flex, bash, bzip2,
68     coreutils, diffutils, gawk, grep, gzip, make, sed, tar.
69   - tcc: remove or upstream patches from tcc-boot.
70   - tcc: build 0.9.27 directly instead of via 0.9.26,
71     see tinycc wip-bootstrappable@0.9.27 branch
72   - mes: prepare src/mes.c for M2-Planet transpiler,
73     Jeremiah branched-out from mes; see https://github.com/oriansj/mes-m2.
74   - mes: real module support, bonus for supporting Guile's define-module/define-public syntax.
75   - mes: we're a full Scheme now, drop .MES suffix, use .SCM.
76     + find a way to fix foo.mes/foo.scm trickery (full Guile-like module support?)
77     + how about setting `guile' or even `guile-2' cond-expand features
78       for external libraries (Nyacc) we look like Guile/Guile-2
79       internally, we could make sure to start every cond-expand with (mes)
80   - mes: use more efficient scheme continuation stack (wip-array?)
81   - mes: drop SCM stack in C / implement call/cc a la guile-1.8 setjmp?
82   - mes/mescc: bootstrap a minimal-Guile
83     + libguile/{eval,init,list,strings,values,..}.c
84     + ice-9/eval.scm
85   - mescc: have mes-tcc pass all scaffold/tests, scaffold/tinycc tests.
86   - mescc: support long long.
87   - mescc: full support for floats?
88   - mescc: some success with 8cc,pcc,guile/libguile/eval.c.
89   - build: guile/guix/make.scm: add file-types, intermediate, hash all dependencies
90   - build: make.scm: imperative->declaritive
91   - get full source syntax-case up (Andre van Tonder?) OR drop it.
92     https://srfi.schemers.org/srfi-72/srfi-72.html
93     psyntax/syntax-case and rewrite Nyacc without syntax-case+R7RS Ellipsis.
94   - mescc: split-off MesCC as as standalone Guile C compiler project.
95 *** release 1.0
96   - replace GuixSD's bootstrap binaries for x86.
97   - add x86_64, replace GuixSD's bootstrap binaries for x86_64.
98   - more architectures (does GuixSD require this, i.e. before 1.0?).
99 ** DONE
100 *** 0.16.1 Mes now has info docs and installs ootb on Debian buster/testing.
101 *** 0.16 Mes Lib C now bootstraps glibc-2.2.5, binutils-2.20.1, gcc-4.1.0.
102 *** 0.15: MesCC now has a libc+gnu that supports compiling binutils-2.14, gcc-2.95.3 and glibc-2.2.5.
103 *** 0.14: Mes+MesCC now compiles a slightly patched self-hosting tcc.
104 *** 0.13: Mes+MesCC now compiles a modified, functional tcc.c (~25,000LOC) in 1h30'.
105 *** 0.12: Mes+MesCC now compiles mes.c (~3000LOC) in ~4min.
106 *** 0.11: MesCC now compiles a mes-tcc that passes 26/69 of mescc's C tests.
107 *** 0.10: Mescc now compiles a mes-tcc that compiles a trivial C to a running a.out.
108 *** 0.9: Mescc now writes M1 macro assembly files and compiles tcc.
109 *** 0.8: Mescc now writes object files in stage0's labeled hex2 format.
110 *** 0.7: Mescc supports -E, -c, -o options, include more complete set of header files,
111 enough to work on compiling tinycc's tcc.c albeit a somewhat modified version.
112 *** 0.6: Work with unmodified, unbundled Nyacc; compile 33/55 tinycc's tests/test2 suite.
113 *** 0.5: Mutual self-hosting Scheme interpreter and C compiler: mes.c and mescc,
114          Support call-with-current-continuation, refactor catch/throw
115 *** 0.4: Support Nyacc, Gcc-compiled Mes compiles minimal main.c using nyacc
116 *** 0.3: Garbage collector
117 *** 0.2: Support psyntax
118 *** 0.1: Mes eval/apply feature complete; support syntax-rules, compile main.c using LALR, dump ELF
119
120
121 * DEBUG
122   MES_DEBUG=<level> mes
123 ** Levels
124   1) Informational:
125      - MODULEDIR
126      - included SCM modules and sources
127      - result of program
128      - gc stats at exit
129   2) opened files
130   3) runtime gc stats
131   4) detailed info
132      - parsed, expanded program
133      - list of builtins
134      - list of symbol
135      - opened input strings
136      - gc details
137   5) usage of opened input strings
138
139
140 * Bugs
141 ** mes: gcc-x86 compiled, tests/srfi-13.test number->string INT-MIN fails:
142 test: number->string INT-MIN: fail
143 expected: -2147483648
144 actual: -./,),(-*,(
145 ** tcc: tcc-built lib/libc+tcc.c segfaults with mes, with tcc.
146 ** mes: remove pmatch-car/pmatch-cdr hack.
147 ** mescc: softcode stack frame size, now hardcoded and very large
148 ** mes+mescc: parse tcc.c->tcc.E works, compile tcc.E -> tcc.M1 segfaults.
149   time GUILE_LOAD_PATH=/home/janneke/src/nyacc/module:$GUILE_LOAD_PATH ../mes/scripts/mescc -E -o tcc.E -I . -I ../mes/lib -I ../mes/include -D 'CONFIG_TCCDIR="usr/lib/tcc"' -D 'CONFIG_TCC_CRTPREFIX="usr/lib:{B}/lib:."' -D 'CONFIG_TCC_ELFINTERP="/gnu/store/70jxsnpffkl7fdb7qv398n8yi1a3w5nx-glibc-2.26.105-g0890d5379c/lib/ld-linux.so.2"' -D 'CONFIG_TCC_LIBPATHS="/home/janneke/src/tinycc/usr/lib:{B}/lib:."' -D 'CONFIG_TCC_SYSINCLUDEPATHS="../mes/include:usr/include:{B}/include"' -D CONFIG_USE_LIBGCC=1 -D 'TCC_LIBGCC="/home/janneke/src/tinycc/usr/lib/libc+tcc-gcc.mlibc-o"' -D CONFIG_TCC_STATIC=1 -D ONE_SOURCE=yes -D TCC_TARGET_I386=1 -D BOOTSTRAP=1 tcc.c
150   time GUILE_LOAD_PATH=/home/janneke/src/nyacc/module:$GUILE_LOAD_PATH MES_ARENA=200000000 ../mes/scripts/mescc -c -o tcc.M1 tcc.E
151 ** mes: with-fluids: tests/fluids.test test 7 fails with Mes.
152 ** mescc: 7n-struct-struct-array.c:  struct file f = {"first.h"};
153 ** test/match.test ("nyacc-simple"): hygiene problem in match
154 * OLD: Booting from LISP-1.5 into Mes
155
156 Mes started out experimenting with booting from a hex-coded minimal
157 LISP-1.5 (prototype in mes.c), into an almost-RRS Scheme.
158
159 When EOF is read, the LISP-1.5 machine calls loop2 from loop2.mes,
160 which reads the rest of stdin and takes over control.  The functions
161 readenv, eval and apply-env in mes.mes introduced define, define-macro
162 quasiquote and macro expansion.
163
164 While this works, it's amazingly slow.  We implemented a full reader
165 in mes.c, which makes running mes:apply-env mes:eval somewhat
166 bearable, still over 1000x slower than running mes.c.
167
168 Bootstrapping has been removed and mes.c implements enough of RRS to
169 run a macro-based define-syntax and syntax-rules.
170
171 loop.mes and mes.mes are unused and lagging behind.  Probably it's not
172 worth considering this route without a VM.  GNU Epsilon is taking the
173 more usual VM-route to provide multiple personas.  While that sounds
174 neat, Lisp/Scheme, bootstrapping and trusted binaries are probably not
175 in scope as there is no mention of such things; only ML is mentioned
176 while Guile is used for bootstrapping.
177
178 * Assorted ideas and info
179 ** Using GDB on assembly/a.out
180 info registers
181 p/x $eax
182 p/x $edx
183 set disassemble-next-line on
184 gdb-display-disassembly-buffer
185 b *0x804a79d
186 ** Create memory dump with 32 bit Gcc compiled Mes
187 make out/i686-unknown-linux-gnu-mes
188 out/i686-unknown-linux-gnu-mes --dump < module/mes/read-0.mes > module/mes/read-0-32.mo
189 ** C parser/compiler
190 *** [[https://savannah.gnu.org/projects/nyacc][nyacc]]
191 *** PEG: [[http://piumarta.com/software/peg/][parse C using PEG]]
192 *** [[https://en.wikipedia.org/wiki/Tiny_C_Compiler][Tiny C Compiler]]
193 *** [[http://www.t3x.org/subc/index.html][Sub C]]
194 *** [[https://groups.google.com/forum/#!topic/comp.lang.lisp/VPuX0VsjTTE][C intepreter in LISP/Scheme/Python]]
195
196 ** C assembler/linker
197 *** [[http://www.tldp.org/HOWTO/Assembly-HOWTO/linux.html][Assembly HOWTO]]
198 *** ELF
199 7f 45 4c 46
200 *** [[http://www.muppetlabs.com/~breadbox/software/tiny/][Small ELF programs]]
201 *** [[http://www.cirosantilli.com/elf-hello-world/][Elf hello world]]
202 ** SC - c as s-expressions
203 sc: http://sph.mn/content/3d3
204 ** RNRS
205 *** [[http://www.scheme-reports.org/][Scheme Reports]]
206 *** [[ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-349.pdf][Scheme - Report on Scheme]]
207 *** [[ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-452.pdf][RRS - Revised Report on Scheme]]
208
209 ** tiny schemes
210 http://forum.osdev.org/viewtopic.php?f=15&t=19937
211
212 http://www.stripedgazelle.org/joey/dreamos.html
213 http://armpit.sourceforge.net/
214 http://common-lisp.net/project/movitz/movitz.html
215
216 <civodul> janneke: https://github.com/namin/inc looks interesting  [15:18]
217 ** Orians Jeremiah
218 <OriansJ> janneke: also, if you look at
219           https://github.com/oriansj/stage0/tree/master/stage2/High_level_prototypes
220           [the garbage collected lisp I implemented], if there are any pieces
221           I could add to finish off your mes lisp bootstrap just let me know
222           because I would be more than happy to do that :D
223 <janneke> OriansJ: that's what I'm hoping for, that our efforts can be
224           complementary and we can work together
225 *** lfam (~lfam@2601:47:4180:2ffb:7c05:17de:cf5f:23ef) has quit: Ping timeout:
226     246 seconds  [00:22]
227 <janneke> exciting times!  [00:23]
228 <janneke> OriansJ: i looked a few times and saw 'LISP empty', so thanks for
229           the pointer!  [00:24]
230 <civodul> OriansJ, janneke: from that page, there's also:
231           https://web.archive.org/web/20160604035203fw_/http://homepage.ntlworld.com/edmund.grimley-evans/bcompiler.html
232
233 ** C4/C500
234 https://web.archive.org/web/20160604041431/http://homepage.ntlworld.com/edmund.grimley-evans/cc500/cc500.c
235 https://github.com/rswier/c4/blob/master/c4.c
236 ** Compilers for free
237 http://codon.com/compilers-for-free
238 ** Small lisps
239 *** [[https://www.mirrorservice.org/sites/www.bitsavers.org/bits/TI/Explorer/zeta-c/][ZETA-C]]
240 ** Small C compilers
241 *** tinycc
242 *** [[https://github.com/rui314/8cc][8cc]] -- a C11 compiler, but simple
243 8cc is a compiler for the C programming language. It's intended to
244 support all C11 language features while keeping the code as small and
245 simple as possible.
246 *** pcc
247 *** early GCC?
248 https://miyuki.github.io/2017/10/04/gcc-archaeology-1.html
249 *** [[http://tack.sourceforge.net/][ack]]
250 <rain1> it may be possible to compile like this:  mes |> ack |> pcc |> tcc |>
251         gcc 4.7.4 |> gcc later version... up to modern
252 *** [[https://web.archive.org/web/20160402225843/http://homepage.ntlworld.com/edmund.grimley-evans/cc500/][cc500]]
253 ** rain1's Bootstrapping Wiki: https://bootstrapping.miraheze.org/wiki/Main_Page
254 ** rain1's hex86
255 https://notabug.org/rain1/hex86/src/master/tests/hex0b3.hex86