build: Fix configure crashing when no compiler is present.
[mes.git] / HACKING
1                                                               -*- org -*-
2 #+TITLE: Hacking GNU Mes
3
4 * SETUP
5     guix shell #64 bit + 32bit
6
7     CC=i686-unknown-linux-gnu-gcc ./configure
8     CC=arm-unknown-linux-gnu-gcc ./configure
9 or
10     ./configure
11
12 The 64bit bootstrap is not supported; MesCC needs work to be able to
13 compile a functional tinycc.
14
15 * BUILD
16
17 GNU Guile can be used as a replacement for Mes.  It's faster and has
18 much better error handling.
19
20    #+BEGIN_SRC bash
21    make MES=guile
22    make check MES=guile
23    #+END_SRC
24
25 Configure to compile with Tiny CC
26
27    #+BEGIN_SRC bash
28    ./configure CC=tcc --host=i686-unknown-linux-gnu --with-courage
29    #+END_SRC
30
31 * DEBUG
32   MES_DEBUG=<level> mes
33 ** Levels
34   1) Informational:
35      - MODULEDIR
36      - included SCM modules and sources
37      - result of program
38      - gc stats at exit
39   2) opened files
40   3) runtime gc stats
41   4) detailed info
42      - parsed, expanded program
43      - list of builtins
44      - list of symbol
45      - opened input strings
46      - gc details
47   5) lots of data
48      - usage of opened input strings
49      - bytes read
50   6) globals
51
52 * TESTING
53 ** make check recheck=true TESTS="tests/base lib/tests/scaffold/t.c"
54 ** mescc
55
56 *** To skip MES tests, in "./check.sh", comment-out check-boot.sh, check-mes.sh.
57
58 *** Running individual tests
59 #+BEGIN_SRC bash
60 cd gcc-lib
61 V=2 CC=i686-unknown-linux-gnu-gcc ../pre-inst-env test-c.sh ../lib/tests/scaffold/t.c
62 #+END_SRC
63
64 #+BEGIN_SRC bash
65 cd mescc-lib
66 V=2 CC=mescc ../pre-inst-env test-c.sh ../lib/tests/scaffold/t.c
67 #+END_SRC
68
69 * Bugs
70 ** mes: performance, Mes is now 2-10x slower than Guile.
71 ** mes/mescc lack support for fork/exec on the Hurd.
72 ** mes: gcc-x86_64 compiled mes segfaults with small arena, or gc_up_arena.
73 ** mes: gcc-x86 compiled, tests/srfi-13.test number->string INT-MIN fails:
74 test: number->string INT-MIN: fail
75 expected: -2147483648
76 actual: -./,),(-*,(
77 ** tcc: tcc-built lib/libc+tcc.c segfaults with mes, with tcc.
78 ** mes: remove pmatch-car/pmatch-cdr hack.
79 ** mescc: softcode stack frame size, now hardcoded and very large
80 ** mes+mescc: parse tcc.c->tcc.E works, compile tcc.E -> tcc.M1 segfaults.
81   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
82   time GUILE_LOAD_PATH=/home/janneke/src/nyacc/module:$GUILE_LOAD_PATH MES_ARENA=200000000 ../mes/scripts/mescc -c -o tcc.M1 tcc.E
83 ** mescc: 64 bit compiled mes loses top 4 bytes
84 *** 64 bit mescc-compiled mes:
85   #x100000000 => 0
86   (modulo 1 #x100000000) => divide-by-zero
87 *** 64 bit gcc-compiled mes:
88   #x100000000 => 0
89   (modulo 1 #x100000000) => 1
90 ** mescc: 7n-struct-struct-array.c:  struct file f = {"first.h"};
91 ** test/match.test ("nyacc-simple"): hygiene problem in match
92 * OLD: Booting from LISP-1.5 into Mes
93
94 Mes started out experimenting with booting from a hex-coded minimal
95 LISP-1.5 (prototype in mes.c), into an almost-RRS Scheme.
96
97 When EOF is read, the LISP-1.5 machine calls loop2 from loop2.mes,
98 which reads the rest of stdin and takes over control.  The functions
99 readenv, eval and apply-env in mes.mes introduced define, define-macro
100 quasiquote and macro expansion.
101
102 While this works, it's amazingly slow.  We implemented a full reader
103 in mes.c, which makes running mes:apply-env mes:eval somewhat
104 bearable, still over 1000x slower than running mes.c.
105
106 Bootstrapping has been removed and mes.c implements enough of RRS to
107 run a macro-based define-syntax and syntax-rules.
108
109 loop.mes and mes.mes are unused and lagging behind.  Probably it's not
110 worth considering this route without a VM.  GNU Epsilon is taking the
111 more usual VM-route to provide multiple personas.  While that sounds
112 neat, Lisp/Scheme, bootstrapping and trusted binaries are probably not
113 in scope as there is no mention of such things; only ML is mentioned
114 while Guile is used for bootstrapping.
115
116 * Assorted ideas and info
117 ** Using GDB on assembly/a.out
118 info registers
119 p/x $eax
120 p/x $edx
121 set disassemble-next-line on
122 gdb-display-disassembly-buffer
123 b *0x804a79d
124 ** Create memory dump with 32 bit Gcc compiled Mes
125 make out/i686-unknown-linux-gnu-mes
126 out/i686-unknown-linux-gnu-mes --dump < module/mes/read-0.mes > module/mes/read-0-32.mo
127
128 x/s *((char **)($rsp+8))
129
130 ** C parser/compiler
131 *** [[https://savannah.gnu.org/projects/nyacc][nyacc]]
132 *** PEG: [[http://piumarta.com/software/peg/][parse C using PEG]]
133 *** [[https://en.wikipedia.org/wiki/Tiny_C_Compiler][Tiny C Compiler]]
134 *** [[http://www.t3x.org/subc/index.html][Sub C]]
135 *** [[https://groups.google.com/forum/#!topic/comp.lang.lisp/VPuX0VsjTTE][C intepreter in LISP/Scheme/Python]]
136
137 ** C assembler/linker
138 *** [[http://www.tldp.org/HOWTO/Assembly-HOWTO/linux.html][Assembly HOWTO]]
139 *** ELF
140 7f 45 4c 46
141 *** [[http://www.muppetlabs.com/~breadbox/software/tiny/][Small ELF programs]]
142 *** [[http://www.cirosantilli.com/elf-hello-world/][Elf hello world]]
143 ** SC - c as s-expressions
144 sc: http://sph.mn/content/3d3
145 ** RNRS
146 *** [[http://www.scheme-reports.org/][Scheme Reports]]
147 *** [[ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-349.pdf][Scheme - Report on Scheme]]
148 *** [[ftp://publications.ai.mit.edu/ai-publications/pdf/AIM-452.pdf][RRS - Revised Report on Scheme]]
149
150 ** tiny schemes
151 http://forum.osdev.org/viewtopic.php?f=15&t=19937
152
153 http://www.stripedgazelle.org/joey/dreamos.html
154 http://armpit.sourceforge.net/
155 http://common-lisp.net/project/movitz/movitz.html
156
157 <civodul> janneke: https://github.com/namin/inc looks interesting  [15:18]
158 ** Orians Jeremiah
159 <OriansJ> janneke: also, if you look at
160           https://github.com/oriansj/stage0/tree/master/stage2/High_level_prototypes
161           [the garbage collected lisp I implemented], if there are any pieces
162           I could add to finish off your mes lisp bootstrap just let me know
163           because I would be more than happy to do that :D
164 <janneke> OriansJ: that's what I'm hoping for, that our efforts can be
165           complementary and we can work together
166 *** lfam (~lfam@2601:47:4180:2ffb:7c05:17de:cf5f:23ef) has quit: Ping timeout:
167     246 seconds  [00:22]
168 <janneke> exciting times!  [00:23]
169 <janneke> OriansJ: i looked a few times and saw 'LISP empty', so thanks for
170           the pointer!  [00:24]
171 <civodul> OriansJ, janneke: from that page, there's also:
172           https://web.archive.org/web/20160604035203fw_/http://homepage.ntlworld.com/edmund.grimley-evans/bcompiler.html
173
174 ** C4/C500
175 https://web.archive.org/web/20160604041431/http://homepage.ntlworld.com/edmund.grimley-evans/cc500/cc500.c
176 https://github.com/rswier/c4/blob/master/c4.c
177 ** Compilers for free
178 http://codon.com/compilers-for-free
179 ** Small lisps
180 *** [[https://www.mirrorservice.org/sites/www.bitsavers.org/bits/TI/Explorer/zeta-c/][ZETA-C]]
181 ** Small C compilers
182 *** tinycc
183 *** [[https://github.com/rui314/8cc][8cc]] -- a C11 compiler, but simple
184 8cc is a compiler for the C programming language. It's intended to
185 support all C11 language features while keeping the code as small and
186 simple as possible.
187 *** pcc
188 *** early GCC?
189 https://miyuki.github.io/2017/10/04/gcc-archaeology-1.html
190 *** [[http://tack.sourceforge.net/][ack]]
191 <rain1> it may be possible to compile like this:  mes |> ack |> pcc |> tcc |>
192         gcc 4.7.4 |> gcc later version... up to modern
193 *** [[https://web.archive.org/web/20160402225843/http://homepage.ntlworld.com/edmund.grimley-evans/cc500/][cc500]]
194 ** rain1's Bootstrapping Wiki: https://bootstrapping.miraheze.org/wiki/Main_Page
195 ** rain1's hex86
196 https://notabug.org/rain1/hex86/src/master/tests/hex0b3.hex86
197 ** <pdewacht> janneke, have you ever tried testing mescc with csmith?  [10:55]
198 ** <pdewacht> e.g. as described here
199            https://jamey.thesharps.us/2016/07/15/testing-strategies-for-corrode/
200            ("Randomized testing with Csmith and C-Reduce")  [10:58]
201 ** linux syscalls: https://fedora.juszkiewicz.com.pl/syscalls.html
202 * legalese
203
204 Copyright © 2016,2017,2018,2019,2021,2022 Jan (janneke) Nieuwenhuizen <janneke@gnu.org>
205
206   Copying and distribution of this file, with or without modification,
207   are permitted in any medium without royalty provided the copyright
208   notice and this notice are preserved.