HACKING

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