From 23fd294d85959c6b476bcdc35ed6ad508cc99b8f Mon Sep 17 00:00:00 2001 From: Kartik Agaram Date: Wed, 1 Jan 2020 16:45:30 -0800 Subject: 5851 Rename a few scripts to be more consistent. I'm also starting to feel the urge to bud off `subx run` into its own program, say tools/emulate_x86. It doesn't really rely on the SubX notation at all. And then I could rename `subx translate` to `translate_subx_bootstrap`. Only problem: the commands in the Readme get verbose. But the Readme is gonna need surgery soon anyway to put translate_mu front and center. --- 079emit.subx | 7 ++++--- Readme.md | 9 ++++----- debug_translate | 31 ----------------------------- gen_linux_iso | 2 +- gen_soso_iso | 2 +- mu-init-test.subx | 2 +- ntranslate | 53 ------------------------------------------------- test_apps | 8 ++++---- translate | 50 ---------------------------------------------- translate_mu | 4 +++- translate_subx | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ translate_subx_debug | 31 +++++++++++++++++++++++++++++ translate_subx_emulated | 50 ++++++++++++++++++++++++++++++++++++++++++++++ 13 files changed, 152 insertions(+), 150 deletions(-) delete mode 100755 debug_translate delete mode 100755 ntranslate delete mode 100755 translate create mode 100755 translate_subx create mode 100755 translate_subx_debug create mode 100755 translate_subx_emulated diff --git a/079emit.subx b/079emit.subx index abf11dce..0db46bdf 100644 --- a/079emit.subx +++ b/079emit.subx @@ -63,9 +63,10 @@ $emit:name: eb/jump $emit:end/disp8 # otherwise emit-hex(out, parse-hex-int(datum), width) # (Weird shit can happen here if the datum of 'word' isn't either a valid - # name or a hex number. `emit` is mostly used by ntranslate, which is - # currently designed to only receive legal SubX programs. We just want to - # make sure that valid names aren't treated as (valid) hex numbers.) + # name or a hex number. `emit` is mostly used by translate_subx, which + # is currently designed to only receive legal SubX programs. We just + # want to make sure that valid names aren't treated as (valid) hex + # numbers.) $emit:hex-int: # . var value/eax : int = parse-hex-int(datum) # . . push args diff --git a/Readme.md b/Readme.md index 326d9134..1d0329de 100644 --- a/Readme.md +++ b/Readme.md @@ -118,16 +118,16 @@ You can use SubX to translate itself. For example, running natively on Linux: 42 # or, automating the above steps - $ ./ntranslate init.linux examples/ex1.subx + $ ./translate_subx init.linux examples/ex1.subx $ ./a.elf $ echo $? 42 ``` -Or, running in a VM on other platforms: +Or, running in a VM on other platforms (much slower): ```sh - $ ./translate init.linux ex1.subx # generates identical a.elf to above + $ ./translate_subx_emulated init.linux ex1.subx # generates identical a.elf to above $ ./subx run a.elf $ echo $? 42 @@ -433,8 +433,7 @@ runnable on a Linux system running on Intel x86 processors, either 32- or files into an executable ELF binary. * `subx run `: simulates running the ELF binaries emitted by `subx - translate`. Useful for debugging, and also enables more thorough testing of - `translate`. + translate`. Useful for testing and debugging. Remember, not all 32-bit Linux binaries are guaranteed to run. I'm not building general infrastructure here for all of the x86 instruction set. diff --git a/debug_translate b/debug_translate deleted file mode 100755 index c1991abe..00000000 --- a/debug_translate +++ /dev/null @@ -1,31 +0,0 @@ -#!/bin/sh -# Translate SubX files with debug information on Linux. -# -# Mu's core tooling has a gap: -# 0. The C++ translator 'subx translate' can generate debug information on -# Linux or BSD or Mac, but doesn't support any syntax sugar. -# 1. The self-hosted translator 'translate' runs in emulated mode and can -# run on Linux or BSD or Mac. However, syntax sugar passes (sigils and -# calls) can be very slow to run emulated. -# 2. The self-hosted translator 'ntranslate' runs natively on Linux. It is -# fast, but you get no trace for runs and zero error-checking on the code -# emitted by sigils and calls. Which could still be buggy. -# -# This script is a hack to get the best of all worlds. We run natively what we -# must, and leverage as much debug information as possible. This arrangement -# is snappy but requires Linux just like 'ntranslate'. You also are on your -# own to mentally map desugared instructions in traces and error messages back -# to the original sources. - -set -e - -echo " braces" -cat $* |apps/braces > a.braces -echo " calls" -cat a.braces |apps/calls > a.calls -echo " sigils" -cat a.calls |apps/sigils > a.sigils - -subx --debug translate a.sigils -o a.elf - -chmod +x a.elf diff --git a/gen_linux_iso b/gen_linux_iso index f6769ec9..6a3d6b10 100755 --- a/gen_linux_iso +++ b/gen_linux_iso @@ -18,7 +18,7 @@ then fi echo "=== building SubX binary" -./ntranslate $* +./translate_subx $* mv a.elf init chmod +x init diff --git a/gen_soso_iso b/gen_soso_iso index 734bc7f5..2d446ad1 100755 --- a/gen_soso_iso +++ b/gen_soso_iso @@ -15,7 +15,7 @@ then fi echo "=== building SubX binary" -./ntranslate $* +./translate_subx $* mv a.elf init chmod +x init diff --git a/mu-init-test.subx b/mu-init-test.subx index 6b08b113..977147fa 100644 --- a/mu-init-test.subx +++ b/mu-init-test.subx @@ -1,7 +1,7 @@ # Just a test stub for mu-init.subx # # Try it out like this: -# $ ./ntranslate init.linux 0*.subx mu-init.subx mu-init-test.subx +# $ ./translate_subx init.linux 0*.subx mu-init.subx mu-init-test.subx # $ ./a.elf # should run all tests main: # args : (address array kernel-string) -> result/ebx : int diff --git a/ntranslate b/ntranslate deleted file mode 100755 index e1c6f99b..00000000 --- a/ntranslate +++ /dev/null @@ -1,53 +0,0 @@ -#!/bin/sh -# Translate SubX by running the self-hosted translator natively on Linux. -# -# Possible knobs: -# Whether to run a phase natively or in emulated mode. -# This script is for running natively. -# Whether to stop after a phase. -# This script assumes inputs are already working so doesn't easily show -# which phase an error happens in. -# Whether to trace a phase. Whether to always trace or rerun with tracing -# enabled after an error. -# Leave tracing to other scripts. We save intermediate files so it's easy -# to rerun a single phase afterwards. -# Whether to run a phase with debug information. (Need to juggle multiple -# sets of debug files.) -# Again, that's for subsequent scripts. - -set -e - -./build - -cat $* |apps/braces > a.braces - -cat a.braces |apps/calls > a.calls - -cat a.calls |apps/sigils > a.sigils - -cat a.sigils |apps/tests > a.tests - -cat a.tests |apps/assort > a.assort - -cat a.assort |apps/dquotes > a.dquotes - -# A little hack. We want ntranslate to always emit identical binaries to the -# C++ translator. The C++ translator assorts segments before it processes -# string literals, so we follow the same order above. -# -# However, dquotes currently emits a separate data segment for string literals. -# So we need to run assort a second time to clean up after it. -# -# Potential solutions: -# a) modify C++ translator to process string literals before assorting. -# b) clean up dquotes to assume assorted segments, and append to the -# existing data segment. -cat a.dquotes |apps/assort > a.assort2 - -cat a.assort2 |apps/pack > a.pack - -cat a.pack |apps/survey > a.survey - -cat a.survey |apps/hex > a.elf - -chmod +x a.elf diff --git a/test_apps b/test_apps index 9d32fc6b..b9b22db1 100755 --- a/test_apps +++ b/test_apps @@ -304,7 +304,7 @@ echo "== translating using SubX (native only)" for n in `seq 1 12` do echo ex$n - ./ntranslate init.$OS examples/ex$n.subx + ./translate_subx init.$OS examples/ex$n.subx diff examples/ex$n a.elf done @@ -313,7 +313,7 @@ done for app in factorial crenshaw2-1 crenshaw2-1b handle do echo $app - ./ntranslate init.$OS 0*.subx apps/$app.subx + ./translate_subx init.$OS 0*.subx apps/$app.subx diff apps/$app a.elf done @@ -322,13 +322,13 @@ done for app in hex survey pack assort dquotes tests sigils calls braces do echo $app - ./ntranslate init.$OS 0*.subx apps/subx-params.subx apps/$app.subx + ./translate_subx init.$OS 0*.subx apps/subx-params.subx apps/$app.subx diff apps/$app a.elf done # Mu translator echo mu -./ntranslate init.$OS 0*.subx apps/mu.subx +./translate_subx init.$OS 0*.subx apps/mu.subx diff apps/mu a.elf exit 0 diff --git a/translate b/translate deleted file mode 100755 index 639d924e..00000000 --- a/translate +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/sh -# Translate SubX by running the self-hosted translator in emulated mode on -# Linux or BSD or Mac. -# -# Possible knobs: -# Whether to run a phase natively or in emulated mode. -# Just always emulate for now since we debug on non-Linux. -# Whether to stop after a phase. -# Just always run all phases, but print out phases so it's clear where an -# error happens. -# Whether to trace a phase. Whether to always trace or rerun with tracing -# enabled after an error. -# Leave tracing to other scripts. We save intermediate files so it's easy -# to rerun a single phase afterwards. -# Whether to run a phase with debug information. (Need to juggle multiple -# sets of debug files.) -# Again, that's for subsequent scripts. - -set -e - -./build - -echo " braces" -cat $* |./subx_bin run apps/braces > a.braces - -echo " calls" -cat a.braces |./subx_bin run apps/calls > a.calls - -echo " sigils" -cat a.calls |./subx_bin run apps/sigils > a.sigils - -echo " tests" -cat a.sigils |./subx_bin run apps/tests > a.tests - -echo " dquotes" -cat a.tests |./subx_bin run apps/dquotes > a.dquotes - -echo " assort" -cat a.dquotes |./subx_bin run apps/assort > a.assort - -echo " pack" -cat a.assort |./subx_bin run apps/pack > a.pack - -echo " survey" -cat a.pack |./subx_bin run apps/survey > a.survey - -echo " hex" -cat a.survey |./subx_bin run apps/hex > a.elf - -chmod +x a.elf diff --git a/translate_mu b/translate_mu index d3029433..d6e6bfa9 100755 --- a/translate_mu +++ b/translate_mu @@ -1,7 +1,9 @@ #!/bin/sh +# Translate given Mu programs into ELF binaries. +# Linux only for now. set -e cat $* |apps/mu > a.subx -./ntranslate init.linux 0*.subx mu-init.subx a.subx +./translate_subx init.linux 0*.subx mu-init.subx a.subx diff --git a/translate_subx b/translate_subx new file mode 100755 index 00000000..ba36986a --- /dev/null +++ b/translate_subx @@ -0,0 +1,53 @@ +#!/bin/sh +# Translate SubX by running the self-hosted translator natively on Linux. +# +# Possible knobs: +# Whether to run a phase natively or in emulated mode. +# This script is for running natively. +# Whether to stop after a phase. +# This script assumes inputs are already working so doesn't easily show +# which phase an error happens in. +# Whether to trace a phase. Whether to always trace or rerun with tracing +# enabled after an error. +# Leave tracing to other scripts. We save intermediate files so it's easy +# to rerun a single phase afterwards. +# Whether to run a phase with debug information. (Need to juggle multiple +# sets of debug files.) +# Again, that's for subsequent scripts. + +set -e + +./build + +cat $* |apps/braces > a.braces + +cat a.braces |apps/calls > a.calls + +cat a.calls |apps/sigils > a.sigils + +cat a.sigils |apps/tests > a.tests + +cat a.tests |apps/assort > a.assort + +cat a.assort |apps/dquotes > a.dquotes + +# A little hack. We want translate_subx to always emit identical binaries to +# the C++ translator. The C++ translator assorts segments before it processes +# string literals, so we follow the same order above. +# +# However, dquotes currently emits a separate data segment for string literals. +# So we need to run assort a second time to clean up after it. +# +# Potential solutions: +# a) modify C++ translator to process string literals before assorting. +# b) clean up dquotes to assume assorted segments, and append to the +# existing data segment. +cat a.dquotes |apps/assort > a.assort2 + +cat a.assort2 |apps/pack > a.pack + +cat a.pack |apps/survey > a.survey + +cat a.survey |apps/hex > a.elf + +chmod +x a.elf diff --git a/translate_subx_debug b/translate_subx_debug new file mode 100755 index 00000000..f5754f37 --- /dev/null +++ b/translate_subx_debug @@ -0,0 +1,31 @@ +#!/bin/sh +# Translate SubX files with debug information on Linux. +# +# Mu's core tooling has a gap: +# 0. The C++ translator 'subx translate' can generate debug information on +# Linux or BSD or Mac, but doesn't support any syntax sugar. +# 1. The self-hosted translator 'translate' runs in emulated mode and can +# run on Linux or BSD or Mac. However, syntax sugar passes (sigils and +# calls) can be very slow to run emulated. +# 2. The self-hosted translator 'translate_subx' runs natively on Linux. It is +# fast, but you get no trace for runs and zero error-checking on the code +# emitted by sigils and calls. Which could still be buggy. +# +# This script is a hack to get the best of all worlds. We run natively what we +# must, and leverage as much debug information as possible. This arrangement +# is snappy but requires Linux just like 'translate_subx'. You also are on your +# own to mentally map desugared instructions in traces and error messages back +# to the original sources. + +set -e + +echo " braces" +cat $* |apps/braces > a.braces +echo " calls" +cat a.braces |apps/calls > a.calls +echo " sigils" +cat a.calls |apps/sigils > a.sigils + +subx --debug translate a.sigils -o a.elf + +chmod +x a.elf diff --git a/translate_subx_emulated b/translate_subx_emulated new file mode 100755 index 00000000..639d924e --- /dev/null +++ b/translate_subx_emulated @@ -0,0 +1,50 @@ +#!/bin/sh +# Translate SubX by running the self-hosted translator in emulated mode on +# Linux or BSD or Mac. +# +# Possible knobs: +# Whether to run a phase natively or in emulated mode. +# Just always emulate for now since we debug on non-Linux. +# Whether to stop after a phase. +# Just always run all phases, but print out phases so it's clear where an +# error happens. +# Whether to trace a phase. Whether to always trace or rerun with tracing +# enabled after an error. +# Leave tracing to other scripts. We save intermediate files so it's easy +# to rerun a single phase afterwards. +# Whether to run a phase with debug information. (Need to juggle multiple +# sets of debug files.) +# Again, that's for subsequent scripts. + +set -e + +./build + +echo " braces" +cat $* |./subx_bin run apps/braces > a.braces + +echo " calls" +cat a.braces |./subx_bin run apps/calls > a.calls + +echo " sigils" +cat a.calls |./subx_bin run apps/sigils > a.sigils + +echo " tests" +cat a.sigils |./subx_bin run apps/tests > a.tests + +echo " dquotes" +cat a.tests |./subx_bin run apps/dquotes > a.dquotes + +echo " assort" +cat a.dquotes |./subx_bin run apps/assort > a.assort + +echo " pack" +cat a.assort |./subx_bin run apps/pack > a.pack + +echo " survey" +cat a.pack |./subx_bin run apps/survey > a.survey + +echo " hex" +cat a.survey |./subx_bin run apps/hex > a.elf + +chmod +x a.elf -- cgit 1.4.1-2-gfad0