HACKING

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