mu/linux/README.md

43 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

2021-03-09 05:24:45 +00:00
This directory contains Mu programs and infrastructure that require a Linux
kernel. To run programs under this directory, you must first `cd` into it.
7842 - new directory organization Baremetal is now the default build target and therefore has its sources at the top-level. Baremetal programs build using the phase-2 Mu toolchain that requires a Linux kernel. This phase-2 codebase which used to be at the top-level is now under the linux/ directory. Finally, the phase-2 toolchain, while self-hosting, has a way to bootstrap from a C implementation, which is now stored in linux/bootstrap. The bootstrap C implementation uses some literate programming tools that are now in linux/bootstrap/tools. So the whole thing has gotten inverted. Each directory should build one artifact and include the main sources (along with standard library). Tools used for building it are relegated to sub-directories, even though those tools are often useful in their own right, and have had lots of interesting programs written using them. A couple of things have gotten dropped in this process: - I had old ways to run on just a Linux kernel, or with a Soso kernel. No more. - I had some old tooling for running a single test at the cursor. I haven't used that lately. Maybe I'll bring it back one day. The reorg isn't done yet. Still to do: - redo documentation everywhere. All the README files, all other markdown, particularly vocabulary.md. - clean up how-to-run comments at the start of programs everywhere - rethink what to do with the html/ directory. Do we even want to keep supporting it? In spite of these shortcomings, all the scripts at the top-level, linux/ and linux/bootstrap are working. The names of the scripts also feel reasonable. This is a good milestone to take stock at.
2021-03-04 06:09:50 +00:00
2021-03-09 05:24:45 +00:00
```sh
$ cd linux/
2021-07-16 15:09:42 +00:00
$ ./translate apps/hello.mu # generates a.elf
2021-03-09 05:24:45 +00:00
$ ./a.elf
Hello world!
```
See the [shared vocabulary](vocabulary.md) of data types and functions shared
by Mu programs running on Linux. Mu programs can transparently call low-level
functions written in SubX.
2021-03-09 05:24:45 +00:00
Some programs to try out:
2020-09-27 03:05:12 +00:00
2020-12-26 21:09:16 +00:00
* `tile`: [An experimental live-updating postfix shell environment](https://mastodon.social/@akkartik/105108305362341204)
that updates as you type. Prototype. Look at this to see what is currently
possible, not how I recommend building software.
2020-09-27 03:05:12 +00:00
2020-09-27 03:14:06 +00:00
<img alt='tile app' src='../html/rpn5.png' width='500px'>
2020-01-02 01:23:29 +00:00
2020-09-27 03:07:58 +00:00
* `browse`: [A text-mode browser for a tiny subset of Markdown](https://mastodon.social/@akkartik/104845344081779025).
2021-07-16 15:09:42 +00:00
* `apps/ex*`: small stand-alone examples that don't need any of the shared code at
2020-12-26 21:09:16 +00:00
the top-level. They each have a simple pedagogical goal. Read these first.
2020-01-02 01:23:29 +00:00
2021-07-16 15:09:42 +00:00
* `apps/factorial*`: A simple program to compute factorials in 5 versions,
showing all the different syntax sugars and what they expand to.
2020-09-27 03:15:45 +00:00
2021-03-09 05:24:45 +00:00
The Mu compiler toolchain is also here in the following phases:
* Bare SubX: `hex`, `survey_elf`, `pack`, `dquotes`, `assort`, `tests`
* Syntax sugar for SubX: `sigils`, `calls`, `braces`
* Mu-&gt;SubX compiler: `mu`. Compiles [most statements](http://akkartik.github.io/mu/html/mu_instructions.html)
to a single instruction of machine code.
2020-07-05 22:28:37 +00:00
The toolchain includes binaries in the repo. At any commit, the binary should
be identical bit for bit with the result of translating the corresponding
`.subx` file. The binary should also be natively runnable on a Linux system
running on Intel x86 processors, either 32- or 64-bit. If either of these
invariants is violated, it's a bug.