From 71e4f3812982dba2efb471283d310224e8db363e Mon Sep 17 00:00:00 2001
From: "Kartik K. Agaram" <vc@akkartik.com>
Date: Wed, 3 Mar 2021 22:09:50 -0800
Subject: 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.
---
 linux/400.mu | 195 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 195 insertions(+)
 create mode 100644 linux/400.mu

(limited to 'linux/400.mu')

diff --git a/linux/400.mu b/linux/400.mu
new file mode 100644
index 00000000..d766a8f6
--- /dev/null
+++ b/linux/400.mu
@@ -0,0 +1,195 @@
+# The 4xx series is for primitives implemented in Mu.
+
+# Signatures for major SubX functions defined so far.
+
+# autogenerated
+sig run-tests
+
+# init.linux
+# TODO: make this OS-specific
+# TODO: include result type at least, even if register args are too much
+sig syscall_exit  # status/ebx: int
+sig syscall_read  # fd/ebx: int, buf/ecx: addr, size/edx: int -> nbytes-or-error/eax: int
+sig syscall_write  # fd/ebx: int, buf/ecx: addr, size/edx: int -> nbytes-or-error/eax: int
+sig syscall_open  # filename/ebx: (addr kernel-string), flags/ecx: int, dummy=0x180/edx -> fd-or-error/eax: int
+sig syscall_close  # fd/ebx: int -> status/eax
+sig syscall_creat  # filename/ebx: (addr kernel-string) -> fd-or-error/eax: int
+sig syscall_unlink  # filename/ebx: (addr kernel-string) -> status/eax: int
+sig syscall_rename  # source/ebx: (addr kernel-string), dest/ecx: (addr kernel-string) -> status/eax: int
+sig syscall_mmap  # arg/ebx: (addr mmap_arg_struct) -> status/eax: int
+sig syscall_ioctl  # fd/ebx: int, cmd/ecx: int, arg/edx: (addr _)
+sig syscall_nanosleep  # req/ebx: (addr timespec)
+sig syscall_clock_gettime  # clock/ebx: int, out/ecx: (addr timespec)
+
+# Generated using:
+#   grep -h '^[a-z]' [0-9]*.subx |grep -v '^test-'
+# Functions we don't want to make accessible from Mu are commented out.
+# Many functions here may not be usable yet because of missing features
+# (global variable support, etc.)
+sig check-ints-equal a: int, b: int, msg: (addr array byte)
+sig kernel-string-equal? s: (addr kernel-string), benchmark: (addr array byte) -> _/eax: boolean
+sig new-segment len: int, ad: (addr allocation-descriptor)
+sig string-equal? s: (addr array byte), benchmark: (addr array byte) -> _/eax: boolean
+sig string-starts-with? s: (addr array byte), benchmark: (addr array byte) -> _/eax: boolean
+sig check-strings-equal s: (addr array byte), expected: (addr array byte), msg: (addr array byte)
+sig clear-stream f: (addr stream _)
+sig rewind-stream f: (addr stream _)
+sig initialize-trace-stream n: int
+sig trace line: (addr array byte)
+sig check-trace-contains line: (addr string), msg: (addr string)
+sig check-trace-scans-to line: (addr string), msg: (addr string)
+sig trace-scan line: (addr array byte) -> _/eax: boolean
+sig next-line-matches? t: (addr stream byte), line: (addr array byte) -> _/eax: boolean
+sig skip-next-line t: (addr stream byte)
+sig clear-trace-stream
+sig write f: (addr stream byte), s: (addr array byte)  # writing to file descriptor not supported; use buffered-file
+sig stream-data-equal? f: (addr stream byte), s: (addr array byte) -> _/eax: boolean
+sig check-stream-equal f: (addr stream byte), s: (addr array byte), msg: (addr array byte)
+sig next-stream-line-equal? f: (addr stream byte), s: (addr array byte) -> _/eax: boolean
+sig check-next-stream-line-equal f: (addr stream byte), s: (addr array byte), msg: (addr array byte)
+sig tailor-exit-descriptor ed: (addr exit-descriptor), nbytes: int
+sig stop ed: (addr exit-descriptor), value: int
+#sig read f: fd or (addr stream byte), s: (addr stream byte) -> _/eax: int
+sig read-byte-buffered f: (addr buffered-file) -> _/eax: byte
+sig read-byte s: (addr stream byte) -> _/eax: byte
+#sig write-stream f: fd or (addr stream byte), s: (addr stream byte)
+#sig error ed: (addr exit-descriptor), out: fd or (addr stream byte), msg: (addr array byte)
+sig write-byte-buffered f: (addr buffered-file), n: int
+sig flush f: (addr buffered-file)
+sig append-byte f: (addr stream byte), n: int
+sig write-buffered f: (addr buffered-file), msg: (addr array byte)
+#sig to-hex-char in/eax: int -> out/eax: int
+sig append-byte-hex f: (addr stream byte), n: int
+sig write-byte-hex-buffered f: (addr buffered-file), n: int
+sig write-int32-hex f: (addr stream byte), n: int
+sig write-int32-hex-bits f: (addr stream byte), n: int, bits: int
+sig write-int32-hex-buffered f: (addr buffered-file), n: int
+sig write-int32-hex-bits-buffered f: (addr buffered-file), n: int, bits: int
+sig is-hex-int? in: (addr slice) -> _/eax: boolean
+sig parse-hex-int in: (addr array byte) -> _/eax: int
+sig parse-hex-int-from-slice in: (addr slice) -> _/eax: int
+#sig parse-hex-int-helper start: (addr byte), end: (addr byte) -> _/eax: int
+sig is-hex-digit? c: byte -> _/eax: boolean
+#sig from-hex-char in/eax: byte -> out/eax: nibble
+sig parse-decimal-int in: (addr array byte) -> _/eax: int
+sig parse-decimal-int-from-slice in: (addr slice) -> _/eax: int
+sig parse-decimal-int-from-stream in: (addr stream byte) -> _/eax: int
+#sig parse-decimal-int-helper start: (addr byte), end: (addr byte) -> _/eax: int
+sig decimal-size n: int -> _/eax: int
+sig error-byte ed: (addr exit-descriptor), out: (addr buffered-file), msg: (addr array byte), n: byte
+#sig allocate ad: (addr allocation-descriptor), n: int, out: (addr handle _)
+#sig allocate-raw ad: (addr allocation-descriptor), n: int, out: (addr handle _)
+sig lookup h: (handle _T) -> _/eax: (addr _T)
+sig handle-equal? a: (handle _T), b: (handle _T) -> _/eax: boolean
+sig copy-handle src: (handle _T), dest: (addr handle _T)
+#sig allocate-region ad: (addr allocation-descriptor), n: int, out: (addr handle allocation-descriptor)
+#sig allocate-array ad: (addr allocation-descriptor), n: int, out: (addr handle _)
+sig copy-array ad: (addr allocation-descriptor), src: (addr array _T), out: (addr handle array _T)
+#sig zero-out start: (addr byte), size: int
+#sig new-stream ad: (addr allocation-descriptor), length: int, elemsize: int, out: (addr handle stream _)
+sig read-line-buffered f: (addr buffered-file), s: (addr stream byte)
+sig read-line f: (addr stream byte), s: (addr stream byte)
+sig slice-empty? s: (addr slice) -> _/eax: boolean
+sig slice-equal? s: (addr slice), p: (addr array byte) -> _/eax: boolean
+sig slice-starts-with? s: (addr slice), head: (addr array byte) -> _/eax: boolean
+sig write-slice out: (addr stream byte), s: (addr slice)
+sig write-slice-buffered out: (addr buffered-file), s: (addr slice)
+# bad name alert
+sig slice-to-string ad: (addr allocation-descriptor), in: (addr slice), out: (addr handle array byte)
+sig _slice-to-string in: (addr slice), out: (addr handle array byte)
+sig next-token in: (addr stream byte), delimiter: byte, out: (addr slice)
+sig next-token-from-slice start: (addr byte), end: (addr byte), delimiter: byte, out: (addr slice)
+sig skip-chars-matching in: (addr stream byte), delimiter: byte
+sig skip-chars-matching-whitespace in: (addr stream byte)
+sig skip-chars-not-matching in: (addr stream byte), delimiter: byte
+sig skip-chars-not-matching-whitespace in: (addr stream byte)
+#sig skip-chars-matching-in-slice curr: (addr byte), end: (addr byte), delimiter: byte -> _/eax: (addr byte)
+#sig skip-chars-matching-whitespace-in-slice curr: (addr byte), end: (addr byte) -> _/eax: (addr byte)
+#sig skip-chars-not-matching-in-slice curr: (addr byte), end: (addr byte), delimiter: byte -> _/eax: (addr byte)
+#sig skip-chars-not-matching-whitespace-in-slice curr: (addr byte), end: (addr byte) -> _/eax: (addr byte)
+sig skip-string line: (addr stream byte)
+#sig skip-string-in-slice curr: (addr byte), end: (addr byte) -> _/eax: (addr byte)
+sig skip-until-close-paren line: (addr stream byte)
+#sig skip-until-close-paren-in-slice curr: (addr byte), end: (addr byte) -> _/eax: (addr byte)
+sig write-stream-data f: (addr buffered-file), s: (addr stream byte)
+sig write-int32-decimal out: (addr stream byte), n: int
+sig is-decimal-digit? c: grapheme -> _/eax: boolean
+sig to-decimal-digit in: grapheme -> _/eax: int
+# bad name alert
+# next-word really tokenizes
+# next-raw-word really reads whitespace-separated words
+sig next-word line: (addr stream byte), out: (addr slice)  # skips '#' comments
+sig next-raw-word line: (addr stream byte), out: (addr slice)  # does not skip '#' comments
+sig has-metadata? word: (addr slice), s: (addr string) -> _/eax: boolean
+sig is-valid-name? in: (addr slice) -> _/eax: boolean
+sig is-label? word: (addr slice) -> _/eax: boolean
+sig emit-hex out: (addr buffered-file), n: int, width: int
+sig emit out: (addr buffered-file), word: (addr slice), width: int
+#sig get table: (addr stream {(handle array byte), T}), key: (addr array byte), row-size: int, abort-message-prefix: (addr array byte) -> _/eax: (addr T)
+#sig get-slice table: (addr stream {(handle array byte), T}), key: (addr slice), row-size: int, abort-message-prefix: (addr array byte) -> _/eax: (addr T)
+#sig get-or-insert table: (addr stream {(handle array byte), T}), key: (addr array byte), row-size: int, ad: (addr allocation-descriptor) -> _/eax: (addr T)
+#sig get-or-insert-handle table: (addr stream {(handle array byte), T}), key: (handle array byte), row-size: int -> _/eax: (addr T)
+#sig get-or-insert-slice table: (addr stream {(handle array byte), T}), key: (addr slice), row-size: int, ad: (addr allocation-descriptor) -> _/eax: (addr T)
+#sig get-or-stop table: (addr stream {(handle array byte), T}), key: (addr array byte), row-size: int
+#sig get-slice-or-stop table: (addr stream {(handle array byte), _}), key: (addr slice), row-size: int
+#sig maybe-get table: (addr stream {(handle array byte), T}), key: (addr array byte), row-size: int -> _/eax: (addr T)
+#sig maybe-get-slice table: (addr stream {(handle array byte), T}), key: (addr slice), row-size: int -> _/eax: (addr T)
+sig slurp f: (addr buffered-file), s: (addr stream byte)
+sig compute-width word: (addr array byte) -> _/eax: int
+sig compute-width-of-slice s: (addr slice) -> _/eax: int
+sig emit-hex-array out: (addr buffered-file), arr: (addr array byte)
+sig next-word-or-string line: (addr stream byte), out: (addr slice)
+sig write-int out: (addr stream byte), n: int
+#sig clear-stack s: (addr stack)
+#sig push s: (addr stack), n: int
+#sig pop s: (addr stack) -> _/eax: int
+#sig top s: (addr stack) -> _/eax: int
+sig array-equal? a: (addr array int), b: (addr array int) -> _/eax: boolean
+sig parse-array-of-ints s: (addr array byte), out: (addr handle array int)
+sig parse-array-of-decimal-ints s: (addr array byte), out: (addr handle array int)
+sig check-array-equal a: (addr array int), expected: (addr string), msg: (addr string)
+#sig push-n-zero-bytes n: int
+sig kernel-string-to-string ad: (addr allocation-descriptor), in: (addr kernel-string), out: (addr handle array byte)
+sig kernel-string-length in: (addr kernel-string) -> _/eax: int
+sig enable-screen-grid-mode
+sig enable-screen-type-mode
+sig real-screen-size -> _/eax: int, _/ecx: int
+sig clear-real-screen
+sig move-cursor-on-real-screen row: int, column: int
+sig print-string-to-real-screen s: (addr array byte)
+sig print-slice-to-real-screen s: (addr slice)
+sig print-stream-to-real-screen s: (addr stream byte)
+sig print-grapheme-to-real-screen c: grapheme
+sig print-int32-hex-to-real-screen n: int
+sig print-int32-hex-bits-to-real-screen n: int, bits: int
+sig print-int32-decimal-to-real-screen n: int
+sig write-int32-decimal-buffered f: (addr buffered-file), n: int
+sig reset-formatting-on-real-screen
+sig start-color-on-real-screen fg: int, bg: int
+sig start-bold-on-real-screen
+sig start-underline-on-real-screen
+sig start-reverse-video-on-real-screen
+sig start-blinking-on-real-screen
+sig hide-cursor-on-real-screen
+sig show-cursor-on-real-screen
+sig enable-keyboard-immediate-mode
+sig enable-keyboard-type-mode
+sig read-key-from-real-keyboard -> _/eax: grapheme
+sig read-line-from-real-keyboard out: (addr stream byte)
+sig open filename: (addr array byte), write?: boolean, out: (addr handle buffered-file)
+sig populate-buffered-file-containing contents: (addr array byte), out: (addr handle buffered-file)
+sig new-buffered-file out: (addr handle buffered-file)
+#sig size in: (addr array _) -> _/eax: int
+
+sig stream-empty? s: (addr stream _) -> _/eax: boolean
+sig stream-full? s: (addr stream _) -> _/eax: boolean
+sig stream-to-array in: (addr stream _), out: (addr handle array _)
+sig unquote-stream-to-array in: (addr stream _), out: (addr handle array _)
+sig stream-first s: (addr stream byte) -> _/eax: byte
+sig stream-final s: (addr stream byte) -> _/eax: byte
+
+#sig copy-bytes src: (addr byte), dest: (addr byte), n: int
+sig copy-array-object src: (addr array _), dest-ah: (addr handle array _)
+sig copy-file src: (addr buffered-file), dest-ah: (addr handle buffered-file), filename: (addr array byte)
+
+sig integer-divide a: int, b: int -> _/eax: int, _/edx: int
-- 
cgit 1.4.1-2-gfad0