From a65f674c745e47f634817ecd0c11f2d2ca010a09 Mon Sep 17 00:00:00 2001
From: Virgil Dupras <hsoft@hardcoded.net>
Date: Fri, 26 Jun 2020 22:08:45 -0400
Subject: [PATCH] emul: build from "cvm" instead of from itself

The C VM now runs the show.
---
 README.md       |   5 +--
 cvm/README.md   |  47 ++++++++++++++++++++++++++++
 emul/.gitignore |   4 +--
 emul/Makefile   |  43 ++++++++------------------
 emul/forth.bin  | Bin 6180 -> 0 bytes
 emul/stage.c    |  80 ------------------------------------------------
 runtests.sh     |   7 +++--
 7 files changed, 68 insertions(+), 118 deletions(-)
 create mode 100644 cvm/README.md
 delete mode 100644 emul/forth.bin
 delete mode 100644 emul/stage.c

diff --git a/README.md b/README.md
index 7477a70..ab2ca4d 100644
--- a/README.md
+++ b/README.md
@@ -24,9 +24,10 @@ tools.
 ## Getting started
 
 Usage documentation is in-system, so access to documentation requires you to
-run Collapse OS. Fortunately, doing so in an emulator is easy.
+run Collapse OS. Fortunately, building and running Collapse OS on a POSIX
+environment is easy.
 
-See `/emul/README.md` for getting an emulated system running.
+See `/cvm/README.md` for instructions.
 
 Then, run `0 LIST` for an introduction, follow instructions from there.
 
diff --git a/cvm/README.md b/cvm/README.md
new file mode 100644
index 0000000..f6627dd
--- /dev/null
+++ b/cvm/README.md
@@ -0,0 +1,47 @@
+# C VM
+
+This is a C implementation of Collapse OS' native words. It allows Collapse OS
+to run natively on any POSIX environment.
+
+## Requirements
+
+You need `ncurses` to build the `forth` executable. In debian-based distros,
+it's `libncurses5-dev`.
+
+## Build
+
+Running `make` will yield `forth` and `stage` executables.
+
+## Usage
+
+To play around Collapse OS, you'll want to run `./forth`. Type `0 LIST` for
+help.
+
+The program is a curses interface with a limited, fixed size so that it can
+provide a AT-XY interface.
+
+You can get a REPL by launching the program with [`rlwrap(1)`][rlwrap] like
+this:
+
+    rlwrap -e '' -m -S '> ' ./forth /dev/stdin
+
+## Problems?
+
+If the `forth` executable works badly (hangs, spew garbage, etc.),
+it's probably because you've broken your bootstrap binary. It's easy to
+mistakenly break. To verify if you've done that, look at your git status. If
+`forth.bin` is modified, try resetting it and then run `make clean all`. Things
+should go better afterwards.
+
+A modified `blkfs` can also break things (although even with a completely broken
+blkfs, you should still get to prompt), you might want to run `make pack` to
+ensure that the `blkfs` file is in sync with the contents of the `blk/` folder.
+
+If that doesn't work, there's also the nuclear option of `git reset --hard`
+and `git clean -fxd`.
+
+If that still doesn't work, it might be because the current commit you're on
+is broken, but that is rather rare: the repo on Github is plugged on Travis
+and it checks that everything is smooth.
+
+[rlwrap]: https://linux.die.net/man/1/rlwrap
diff --git a/emul/.gitignore b/emul/.gitignore
index 29d46ba..00dbdb8 100644
--- a/emul/.gitignore
+++ b/emul/.gitignore
@@ -1,4 +1,2 @@
-/stage
 /forth
-/*-bin.h
-/blkfs
+/forth.bin
diff --git a/emul/Makefile b/emul/Makefile
index 4138245..b90b584 100644
--- a/emul/Makefile
+++ b/emul/Makefile
@@ -1,47 +1,30 @@
-TARGETS = forth stage 
+TARGETS = forth 
 OBJS = emul.o libz80/libz80.o
-BLKPACK = ../tools/blkpack
-BLKUNPACK = ../tools/blkunpack
+CDIR = ../cvm
+STAGE = $(CDIR)/stage
+BLKFS = $(CDIR)/blkfs
 
 .PHONY: all
 all: $(TARGETS)
 
-$(BLKPACK):
-	$(MAKE) -C ../tools
-
-.PHONY: $(BLKUNPACK)
-$(BLKUNPACK): $(BLKPACK)
-
-stage: stage.c $(OBJS) blkfs
-	$(CC) stage.c $(OBJS) -o $@
-
-blkfs: $(BLKPACK)
-	$(BLKPACK) ../blk > $@
-
-forth: forth.c $(OBJS) blkfs
+forth: forth.c $(OBJS) $(CDIR)/blkfs
 	$(CC) forth.c $(OBJS) -lncurses -o $@
 
 libz80/libz80.o: libz80/z80.c
 	$(MAKE) -C libz80/codegen opcodes
 	$(CC) -Wall -ansi -g -c -o libz80/libz80.o libz80/z80.c
 
-emul.o: emul.c
-	$(CC) -DFBIN_PATH=\"`pwd`/forth.bin\" -DBLKFS_PATH=\"`pwd`/blkfs\" -c -o emul.o emul.c
+emul.o: emul.c forth.bin $(BLKFS)
+	$(CC) -DFBIN_PATH=\"`pwd`/forth.bin\" -DBLKFS_PATH=\"`pwd`/$(BLKFS)\" -c -o emul.o emul.c
 
+forth.bin: xcomp.fs $(STAGE)
+	$(CDIR)/stage < xcomp.fs > $@
 
-.PHONY: updatebootstrap
-updatebootstrap: stage xcomp.fs pack
-	./stage < xcomp.fs > new.bin
-	mv new.bin forth.bin
+$(BLKFS): $(STAGE)
 
-.PHONY: pack
-pack:
-	rm blkfs && $(MAKE) blkfs
-
-.PHONY: unpack
-unpack:
-	$(BLKUNPACK) ../blk < blkfs
+$(STAGE):
+	$(MAKE) -C $(CDIR) all
 
 .PHONY: clean
 clean:
-	rm -f $(TARGETS) emul.o *-bin.h blkfs libz80/libz80.o
+	rm -f $(TARGETS) emul.o *.bin libz80/libz80.o
diff --git a/emul/forth.bin b/emul/forth.bin
deleted file mode 100644
index af165211c0cece7de50633dbc85e55367e897770..0000000000000000000000000000000000000000
GIT binary patch
literal 0
HcmV?d00001

literal 6180
zcma)AZA_b2mcFmw*ESe~%{L+auyJB+2!SAWO1p#)8<V;*Hnj~Q8>J{8kS3uJLE5w#
zl(3tbu8?-OlOMAZ(X9F-X{t(DZALRyGuka|6*W=GW;aoZI?N7Ly%m#m2|H42RZ(^_
z-sid3ZkU}v0|MW3?m6e4?|ZJV4r^kre24S5l|ubo4Qp4E8rD}&@qg~;YId>iGc*`Z
z3So$wWn$$~>T0#{?Vs=$0rBW1@n}GMw1KD&;EIJ=q^92Y-F@VF<N*>tzR~gVWBv+Z
z5z8&Yr7yQ=%csQh-0xjimrrTSa~an^FW0Nzs)gqExL4@ncIsxaSjAsf!kE7l*z8#l
ze22$P`b&shNxf7dN*`@l0j@pn6edAt0P%Jk0BQ`NIo@6XYCx;RP{7Km4}9BV7Lo5+
zxwEnQH>ZE$D%iNOYh!)&oXg~Va69FzSlPI7<DJ!)JOindKlABp@zs=T@t@jKpDcUu
z`>I$zu6?pRCYDDus{hH_9*d~@-nNICWw*$<r|;Dm_v-RQjp^Rn9z#?;>3*2`U~Qsx
zX?Z18EU=8X{`+Hts!Km`nO48r?z7$5?z^+<@!(Kcb~CK;cn^GD_3I_~14>xBRrTZ0
zU?|w14E=|&irY8mwW@!O$C5Ufm%9BCz&k4+BcR>=eNLi)SXlww0R$r^5r~jRWOqE)
zS3)G#iCtZN`CL;ZJakHn4TR#39OjNh^@W2wokZQ(e535ysHbOD+7<uRkj6uO6XT<!
z{-+S@RCn*Qp5)&8`n4;-H}jw}<_1q{hAOsoa;Zt8$$@A=7=hXZL+2LaSwdaWZo4!N
zdVT+$@sk%05gUt_FxFJ|`|ppR{JBI9#^THrh5g6zlb0km8cRwnNT=RMrn@x#V@Rkk
z5t<@J@|@Bd>;RE@^BRIfL|qXP^e8lGclvLX-Y97@@|(2M?XIs$(AXR6cEb)y^SZ?e
zvS)4-SFRmdi#M4z6gt1&AtT{-Lr&`Uq-O#=oi+lHiMZ0oL3fcfW0LF6e6F!M=0(<?
z()xmK2h8~>wRTuSoy=h><P~c#lORkLRSrt9wh#iA$9}&&BK`ORO<ErN-SWsIZU=UU
ziXh-MEPWHhlZigR9T|j-%_8Cn)U;JFe}PGCXAq=AP!jn&Jf*5K9y>7D+vm!88$QE^
z&#bqa3JN|3`_RbYv4c-A<P6bGhvv&$0R^}2Xqx==9e!n--vyGjf&T@%DG%CaNw(#4
zt;ia-$!y3-leX0pppQH>X&a)Zz<Pqs^*PWZx0@U25K`C6{dnT}a8I%r`S}r%U543b
zxzTpxN#{dyN969tKioy0tKE24Z~X>gX!AncE7Joa5RTRtDp(MHJ`@ir*bqJDfC%=-
z<DqD>u2|%O=f(9nr?6@#%`;?T$h8r<?g>Y`3n1`s0eMZY837TFwj*HRZj#*Ls1Jnz
zuo)n^!%+l`h)!|cOdWiO$3{lcge}?y<GMMmT`^DTQ^3F2A4UlnTCH)xm=}3qpVIG}
z7lp<5%D%&6{&&sQrbR6vx&pCya<edN6^6+Y5TSS+T}4|IR^PFS!(+!mcL?desMTR}
zdllld%gC4lq78w=@<SsIJi0D{%Mxg6D}Z_PB6Io(x3&}7Ymq$LY4{PjZfZxW>DucO
zXm8`jJi@lqbi|U<QXrbcA=}&AwpU7bbLUOD^QPSC4M!`${v(i6J+G-6<h@;kxE_Gq
zyABx*quc44qDb}!chcQnQ!D5jUgEJ{lLy`kb|T4iEv;Qd92N{OwuA0^bW^RudQM+J
zV1k{<yBx(*mZBj?u>^`psA~Y#X4cXoEvikQ=}X34aaROHe>4({^;IH7X&iXQMBLD^
zgZmB~VA#^I+%2ec9=I+;5QFd0iMIitF{zyovEwxn*P@r{7XbN=?VFe!KIji3-5RZ}
zri;LmqCv!^2Nn=|dh<Qe3T?{ti~4!%Az{ZUOW1kK8W7XsHyJPZay%As!KkrP2POM}
ze>Y^OwFQGTwUFBi`8tw62hW+PANc~}9;nDW)Qo(f`b{w9S@AKHv1N@42;%nv8u<>t
z3&sYZ6b)3zzU=SF9y^0$n_iDgC#XXhBAU5?tk%V2(@y54kxo46j7b?sR~VuWRWdDp
zmC2K44GpYQZQFM$(BFTk!hV14dKLEnDJqob|FH^}4W+=ZvkE8!{eOXW5Xxij2E@N)
zKRfaj{1t*k{Gu@XPK=Gn63i2eT7uS~rh;u9ZOFuVcwO~`U>jN<U>5m|Zk7?D!|f7g
zm2Y_pX3wGn%$n~RBlv`rEyZA(HJ<}+A&U!ylb!4tECRcE9{reQ2&|h}`cp#+)|pcp
z(})T8sVO0fa8yQog_^pk&zZcYbCA9((a|JzWM-qS#F8DkM#+u=cuNj;*#aUN+ZBs<
zJ7g29Hm$;sr)?Pse9QJJvg>~`$f*<ipO6BJU=+aN@#9K>X56w(>9-(+B8s8sE!%?e
zQ(Ibl%f`YvWBLMnt<Y-0Sj}hpZiNIU@@XlY1#rveL9yPlozoT17dHBuGQ+*Sq3&>3
zGBhCaWtUzun1J)BoKLf+N|KHzq5G1ol4<F*dR*fsG>;k7o!3N%H{#;f2K79Y9fk;Y
zn?apzt1A+TCGBV%Bj(cu0a4q*u9UXD3oC2cWv>*l!kp{UL3QqUEE0JV=BjuzVHTj<
zPH4qW+M<t|cvLedx=oPIYT1b`{s)?)AEq;j{<47RFL8J;s2OTAPAox9zlU%)T2orU
zIxW7<oB<;#8gPM260fMRmcer=h+&IXYqGrvrh`_mX+7JP7O>5lTTPb=yryUD0nrx^
z4KQFlo&9b`XBF-l9y>nq#@-54NTapFde%N`=Jn{&?KYQ<YdX^>iTpJnO55fjD;N(U
zN`;8Rmv$<{tQzQwhr0q1Sd^!IBe9oYBh$p^gevK5z)mAzRG~~B-xG`P2qhWLs|9K8
zi9%M(J9c$ysJAb<y9%s}!Wf!-W0IGn9UYA{ilRFfO0+)>3JRp!=di&hM)4#|3p+Fm
z#-fR2S2W2U^NrnZd!vwd`<`&mUJTzTE>-@PJ;~=o(Y<My*kT+K4>C*_h1&%EP??dP
zop^BYv=&(wK)5l(67jtpqFvQVYYy&C?q;FQi|29}pQ303Of?|HPc`a_F!va8?uqQ&
zM9eID0;#58kT5P4yluN+R2NO@9~yc1FFD<tL6=uFqd$O2i<n8c9}qo}{>1b2Ts5|6
z-)lumea1g68F*(|a18{+*&<@5^t)1o66^MY`Epj8Z}^qN$Dt!<o-2^<J39OZ23s@0
zYXCz%35?AK$m#bhR2H?CTN5Kq`+qpe=l(PBF@JK@e;Q{n7D+rKIr~tDk#IDWpgQxy
z1+XjGFt}TR7O9OH|8ZKc8qnrNLOPx`muvH1z&qIi%q8o9HPvW6@0b=3WflYy<=K{h
z-hl&q)XZfQgo1Ge6=tDG599mLaUXk$z92gf6(eahl4Ddi$72m_PH6Dz$mj|G({S^m
za7-TGci^b&)v<%a6C<PJC!RqUm$wt<eeIf~(zz&#PK-|+bd8N4ca4mLjucyJo`9O{
z=kuaQP9-YBE;QKxMpuu7lQmC^A7FP8bunwcV7P2Qbf%GLHCE18yh^r$;;*!Ko%7<F
zgS8_k)|z7RruGSNbr#}=@aln(yJ)p(Bmq+?4<T%V_j9m1nB&tRsJO?*oDg3?jje59
zS9iA^Yz^?uhenHjADVE0;gG4=&pQ(0J{UT-f?-ClFUHaA(WJ|lbS2=op__5YDbo{K
zHCRMjU$2!R6WTwZ-#Vejq2lun{$X!$Lw0XaKU;j3VtHFo>~l~it(`5dgt3Nf$!wG=
zrM)H+S32(*({N`stjd!VjaG8HpvozXIJp6mHy<<TzcQN<-0uF~zJ17x`wn^|PkM!g
z$)WK*F;_e-e#dKf|6~pF<q8_ZbzGXNGZ9)c_|W(qf&U!(2NE5dK*m!~Bg{%--0~@k
zd1nY6lNs0lM_K+`X8FXy(Xj(~5?bXUzm$h?c(I`@3^7wenKqd^9FONkAtE|f!hq~3
zVRY#oDl~=B^9pWI(ieW0YI02G5&j{h@qP29l6gEnIc$HMx$n4crV#-V?~X*<o<bs1
z&_&!tZ0kxKl_)Az_zT7ni<-J}Oq-g)#IDHa*_8fE^L4XFzf^D^n8s2yfKji<Ok0~9
z5ol$TdZtu5nMILsBFU%DJLtJi8N<&oul#)}quwb#(_7H8%H)%vQ|9e^z;O(5iEk{7
z>DP$qwD>nfEF4XS;<#Cp5lk#;j6qBmO_qep;djj{A%2oi+ZMI|%qLtZSi+|9qt_gp
zoe6Orl6?Ee$B(!9LkNu;nr5H?N5jjw6cmPjh{U@1m5A)&cM&)>g>t3lQ?592&FFW<
zJ4Niggm{JQC{xtyU6d(JXX$xY<{bAKsFhsiV3B-Zr6DZ=XOT)hZ~5v{`qcj&;=)^~
zOg~ztQ23tEjCYLJMAxOY`r^&bqh-?~4MS-`yq;ISV)2@CpN?|$o6b6w!0k|*AY0}O
z<-FYhx$D&Xyi;wuxp^qJ$zh4Nu^Ob(8XsYU<tdDXT)kS(s^w6np5(PqAX93^D<}|)
zC3%7IBI+@pgtOETp&a-4J<k;{k14!}RDr3LP2!Y;`3Ru1FX}Ip^Yfg32%nF0GE;i6
zG&|1B*%yT^h_CbZ9h)4EC7219;eet22VOq<H!wq$H)EfXy^b@fb^k=e_-iAh*BpGB
zbjLQMSI^^F#%@l}#`+wxzfVhyNAIm*zeeAWmP-RsBsOC3HOF7#n$i4f*7+7;dCrLz
z_@(_a?gWm*heQR+{gr~pca$Bsh(-J)|Lux|_?)TV(<o0z_2P6okMka9sB-9_Zk65&
zHI0WN3CxAOc@m&jv;~#3<_B;;v}@b&-L1qLx`<*tizzb@+7XUci65fo5&Ioo;iwIO
zk}-?YSJw4Mli^5(+)%3IHujXj$V_Pf4T#-crfV?P+ZT=?P5v4K=i3!If9%QPF$d3J
zgD(2>JaEtBO0(M(>z>-ZPH{%Ese35<{gbQH#c!ruZWl(mO|DuO2O_RJ>wuG>+;S5%
F{tu396X^f|

diff --git a/emul/stage.c b/emul/stage.c
deleted file mode 100644
index 0920616..0000000
--- a/emul/stage.c
+++ /dev/null
@@ -1,80 +0,0 @@
-#include <stdint.h>
-#include <stdio.h>
-#include <unistd.h>
-#include "emul.h"
-
-/* Staging binaries
-
-The role of a stage executable is to compile definitions in a dictionary and
-then spit the difference between the starting binary and the new binary.
-
-That binary can then be grafted to an exiting Forth binary to augment its
-dictionary.
-
-We could, if we wanted, run only with the bootstrap binary and compile core
-defs at runtime, but that would mean that those defs live in RAM. In may system,
-RAM is much more constrained than ROM, so it's worth it to give ourselves the
-trouble of compiling defs to binary.
-
-*/
-
-#define RAMSTART 0
-#define STDIO_PORT 0x00
-// To know which part of RAM to dump, we listen to port 2, which at the end of
-// its compilation process, spits its HERE addr to port 2 (MSB first)
-#define HERE_PORT 0x02
-
-static int running;
-// We support double-pokes, that is, a first poke to tell where to start the
-// dump and a second one to tell where to stop. If there is only one poke, it's
-// then ending HERE and we start at sizeof(KERNEL).
-static uint16_t start_here = 0;
-static uint16_t end_here = 0;
-
-static uint8_t iord_stdio()
-{
-    int c = getc(stdin);
-    if (c == EOF) {
-        running = 0;
-    }
-    return (uint8_t)c;
-}
-
-static void iowr_stdio(uint8_t val)
-{
-    // comment if you don't like verbose staging output 
-    putc(val, stderr);
-}
-
-static void iowr_here(uint8_t val)
-{
-    start_here <<=8;
-    start_here |= (end_here >> 8);
-    end_here <<= 8;
-    end_here |= val;
-}
-
-int main(int argc, char *argv[])
-{
-    Machine *m = emul_init();
-    if (m == NULL) {
-        return 1;
-    }
-    m->ramstart = RAMSTART;
-    m->iord[STDIO_PORT] = iord_stdio;
-    m->iowr[STDIO_PORT] = iowr_stdio;
-    m->iowr[HERE_PORT] = iowr_here;
-    // Run!
-    running = 1;
-
-    while (running && emul_step());
-
-    // We're done, now let's spit dict data
-    for (int i=start_here; i<end_here; i++) {
-        putchar(m->mem[i]);
-    }
-    emul_deinit();
-    emul_printdebug();
-    return 0;
-}
-
diff --git a/runtests.sh b/runtests.sh
index d78add1..b4334e8 100755
--- a/runtests.sh
+++ b/runtests.sh
@@ -4,11 +4,12 @@ git submodule init
 git submodule update
 git clean -fxd
 
+make -C cvm
 make -C emul
 make -C tests
 
 # verify that forth.bin is stable
-cp emul/forth.bin ref.bin
-make -C emul updatebootstrap
-cmp emul/forth.bin ref.bin
+cp cvm/forth.bin ref.bin
+make -C cvm updatebootstrap
+cmp cvm/forth.bin ref.bin
 rm ref.bin