Tracer ysyx

abstract-machine/.gitignore

@@ -0,0 +1,19 @@
+*
+!*/
+!*.h
+!*.c
+!*.cc
+!*.S
+!*.ld
+!*.sh
+!*.py
+!*.mk
+!Makefile
+!README
+!LICENSE
+.*
+_*
+*~
+build/
+!.gitignore
+.vscode

abstract-machine/LICENSE

@@ -0,0 +1,22 @@
+The AbstractMachine software is:
+
+Copyright (c) 2018-2021 Yanyan Jiang and Zihao Yu
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

abstract-machine/Makefile

@@ -0,0 +1,170 @@
+# Makefile for AbstractMachine Kernels and Libraries
+
+### *Get a more readable version of this Makefile* by `make html` (requires python-markdown)
+html:
+	cat Makefile | sed 's/^\([^#]\)/    \1/g' | markdown_py > Makefile.html
+.PHONY: html
+
+## 1. Basic Setup and Checks
+
+### Default to create a bare-metal kernel image
+ifeq ($(MAKECMDGOALS),)
+  MAKECMDGOALS  = image
+  .DEFAULT_GOAL = image
+endif
+
+### Override checks when `make clean/clean-all/html`
+ifeq ($(findstring $(MAKECMDGOALS),clean|clean-all|html),)
+
+### Print build info message
+$(info # Building $(NAME)-$(MAKECMDGOALS) [$(ARCH)])
+
+### Check: environment variable `$AM_HOME` looks sane
+ifeq ($(wildcard $(AM_HOME)/am/include/am.h),)
+  $(error $$AM_HOME must be an AbstractMachine repo)
+endif
+
+### Check: environment variable `$ARCH` must be in the supported list
+ARCHS = $(basename $(notdir $(shell ls $(AM_HOME)/scripts/*.mk)))
+ifeq ($(filter $(ARCHS), $(ARCH)), )
+  $(error Expected $$ARCH in {$(ARCHS)}, Got "$(ARCH)")
+endif
+
+### Extract instruction set architecture (`ISA`) and platform from `$ARCH`. Example: `ARCH=x86_64-qemu -> ISA=x86_64; PLATFORM=qemu`
+ARCH_SPLIT = $(subst -, ,$(ARCH))
+ISA        = $(word 1,$(ARCH_SPLIT))
+PLATFORM   = $(word 2,$(ARCH_SPLIT))
+
+### Check if there is something to build
+ifeq ($(flavor SRCS), undefined)
+  $(error Nothing to build)
+endif
+
+### Checks end here
+endif
+
+## 2. General Compilation Targets
+
+### Create the destination directory (`build/$ARCH`)
+WORK_DIR  = $(shell pwd)
+DST_DIR   = $(WORK_DIR)/build/$(ARCH)
+$(shell mkdir -p $(DST_DIR))
+
+### Compilation targets (a binary image or archive)
+IMAGE_REL = build/$(NAME)-$(ARCH)
+IMAGE     = $(abspath $(IMAGE_REL))
+ARCHIVE   = $(WORK_DIR)/build/$(NAME)-$(ARCH).a
+
+### Collect the files to be linked: object files (`.o`) and libraries (`.a`)
+OBJS      = $(addprefix $(DST_DIR)/, $(addsuffix .o, $(basename $(SRCS))))
+LIBS     := $(sort $(LIBS) am klib) # lazy evaluation ("=") causes infinite recursions
+LINKAGE   = $(OBJS)  # library archives are added by LIB_TEMPLATE below
+
+## 3. General Compilation Flags
+
+### (Cross) compilers, e.g., mips-linux-gnu-g++
+AS        = $(CROSS_COMPILE)gcc
+CC        = $(CROSS_COMPILE)gcc
+CXX       = $(CROSS_COMPILE)g++
+LD        = $(CROSS_COMPILE)ld
+AR        = $(CROSS_COMPILE)ar
+OBJDUMP   = $(CROSS_COMPILE)objdump
+OBJCOPY   = $(CROSS_COMPILE)objcopy
+READELF   = $(CROSS_COMPILE)readelf
+
+### Compilation flags
+INC_PATH += $(WORK_DIR)/include $(addsuffix /include/, $(addprefix $(AM_HOME)/, $(LIBS)))
+INCFLAGS += $(addprefix -I, $(INC_PATH))
+
+ARCH_H := arch/$(ARCH).h
+CFLAGS   += -O2 -MMD -Wall -Werror $(INCFLAGS) \
+            -D__ISA__=\"$(ISA)\" -D__ISA_$(shell echo $(ISA) | tr a-z A-Z)__ \
+            -D__ARCH__=$(ARCH) -D__ARCH_$(shell echo $(ARCH) | tr a-z A-Z | tr - _) \
+            -D__PLATFORM__=$(PLATFORM) -D__PLATFORM_$(shell echo $(PLATFORM) | tr a-z A-Z | tr - _) \
+            -DARCH_H=\"$(ARCH_H)\" \
+            -fno-asynchronous-unwind-tables -fno-builtin -fno-stack-protector \
+            -Wno-main -U_FORTIFY_SOURCE -fvisibility=hidden
+CXXFLAGS +=  $(CFLAGS) -ffreestanding -fno-rtti -fno-exceptions
+ASFLAGS  += -MMD $(INCFLAGS)
+LDFLAGS  += -z noexecstack $(addprefix -T, $(LDSCRIPTS))
+
+## 4. Arch-Specific Configurations
+
+### Paste in arch-specific configurations (e.g., from `scripts/x86_64-qemu.mk`)
+-include $(AM_HOME)/scripts/$(ARCH).mk
+
+## 5. Compilation Rules
+
+### Rule (compile): a single `.c` -> `.o` (gcc)
+$(DST_DIR)/%.o: %.c
+	@mkdir -p $(dir $@) && echo + CC $<
+	@$(CC) -std=gnu11 $(CFLAGS) -c -o $@ $(realpath $<)
+
+### Rule (compile): a single `.cc` -> `.o` (g++)
+$(DST_DIR)/%.o: %.cc
+	@mkdir -p $(dir $@) && echo + CXX $<
+	@$(CXX) -std=c++17 $(CXXFLAGS) -c -o $@ $(realpath $<)
+
+### Rule (compile): a single `.cpp` -> `.o` (g++)
+$(DST_DIR)/%.o: %.cpp
+	@mkdir -p $(dir $@) && echo + CXX $<
+	@$(CXX) -std=c++17 $(CXXFLAGS) -c -o $@ $(realpath $<)
+
+### Rule (compile): a single `.S` -> `.o` (gcc, which preprocesses and calls as)
+$(DST_DIR)/%.o: %.S
+	@mkdir -p $(dir $@) && echo + AS $<
+	@$(AS) $(ASFLAGS) -c -o $@ $(realpath $<)
+
+ifeq ($(MAKECMDGOALS),archive)
+### Rule (archive): objects (`*.o`) -> `ARCHIVE.a` (ar)
+$(ARCHIVE): $(OBJS)
+	@echo + AR "->" $(shell realpath $@ --relative-to .)
+	@$(AR) rcs $@ $^
+else
+# $(1): library name
+define LIB_TEMPLATE =
+$$(AM_HOME)/$(1)/build/$(1)-$$(ARCH).a: force
+	@$$(MAKE) -s -C $$(AM_HOME)/$(1) archive
+LINKAGE += $$(AM_HOME)/$(1)/build/$(1)-$$(ARCH).a
+endef
+
+### Rule (recursive make): build a dependent library (am, klib, ...)
+$(foreach lib, $(LIBS), $(eval $(call LIB_TEMPLATE,$(lib))))
+endif
+
+### Rule (link): objects (`*.o`) and libraries (`*.a`) -> `IMAGE.elf`, the final ELF binary to be packed into image (ld)
+$(IMAGE).elf: $(LINKAGE) $(LDSCRIPTS)
+	@echo \# Creating image [$(ARCH)]
+	@echo + LD "->" $(IMAGE_REL).elf
+ifneq ($(filter $(ARCH),native),)
+	@$(CXX) -o $@ -Wl,--whole-archive $(LINKAGE) -Wl,-no-whole-archive $(LDFLAGS_CXX)
+else
+	@$(LD) $(LDFLAGS) -o $@ --start-group $(LINKAGE) --end-group
+endif
+
+### Rule (`#include` dependencies): paste in `.d` files generated by gcc on `-MMD`
+-include $(addprefix $(DST_DIR)/, $(addsuffix .d, $(basename $(SRCS))))
+
+## 6. Miscellaneous
+
+### Build order control
+image: image-dep
+archive: $(ARCHIVE)
+image-dep: $(IMAGE).elf
+.PHONY: image image-dep archive run
+
+### Force to rebuild a rule
+force:
+.PHONY: force
+
+### Clean a single project (remove `build/`)
+clean:
+	rm -rf Makefile.html $(WORK_DIR)/build/
+.PHONY: clean
+
+### Clean all sub-projects within depth 2 (and ignore errors)
+CLEAN_ALL = $(dir $(shell find . -mindepth 2 -name Makefile))
+clean-all: $(CLEAN_ALL) clean
+$(CLEAN_ALL):
+	-@$(MAKE) -s -C $@ clean
+.PHONY: clean-all $(CLEAN_ALL)

abstract-machine/README

@@ -0,0 +1,13 @@
+AbstractMachine is a minimal, modularized, and machine-independent 
+abstraction layer of the computer hardware:
+
+* physical memory and direct execution (The "Turing Machine");
+* basic model for input and output devices (I/O Extension);
+* interrupt/exception and processor context management (Context Extension);
+* virtual memory and protection (Virtual Memory Extension);
+* multiprocessing (Multiprocessing Extension).
+
+CONTACTS
+
+Bug reports and suggestions go to Yanyan Jiang ([email protected]) and Zihao 
+Yu ([email protected]).

abstract-machine/am/Makefile

@@ -0,0 +1,5 @@
+NAME     := am
+SRCS      = $(addprefix src/, $(AM_SRCS))
+INC_PATH += $(AM_HOME)/am/src
+
+include $(AM_HOME)/Makefile

abstract-machine/am/include/am.h

@@ -0,0 +1,81 @@
+#ifndef AM_H__
+#define AM_H__
+
+#include <stdint.h>
+#include <stddef.h>
+#include <stdbool.h>
+#include ARCH_H // this macro is defined in $CFLAGS
+                // examples: "arch/x86-qemu.h", "arch/native.h", ...
+
+// Memory protection flags
+#define MMAP_NONE  0x00000000 // no access
+#define MMAP_READ  0x00000001 // can read
+#define MMAP_WRITE 0x00000002 // can write
+
+// Memory area for [@start, @end)
+typedef struct {
+  void *start, *end;
+} Area;
+
+// Arch-dependent processor context
+typedef struct Context Context;
+
+// An event of type @event, caused by @cause of pointer @ref
+typedef struct {
+  enum {
+    EVENT_NULL = 0,
+    EVENT_YIELD, EVENT_SYSCALL, EVENT_PAGEFAULT, EVENT_ERROR,
+    EVENT_IRQ_TIMER, EVENT_IRQ_IODEV,
+  } event;
+  uintptr_t cause, ref;
+  const char *msg;
+} Event;
+
+// A protected address space with user memory @area
+// and arch-dependent @ptr
+typedef struct {
+  int pgsize;
+  Area area;
+  void *ptr;
+} AddrSpace;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+// ----------------------- TRM: Turing Machine -----------------------
+extern   Area        heap;
+void     putch       (char ch);
+void     halt        (int code) __attribute__((__noreturn__));
+
+// -------------------- IOE: Input/Output Devices --------------------
+bool     ioe_init    (void);
+void     ioe_read    (int reg, void *buf);
+void     ioe_write   (int reg, void *buf);
+#include "amdev.h"
+
+// ---------- CTE: Interrupt Handling and Context Switching ----------
+bool     cte_init    (Context *(*handler)(Event ev, Context *ctx));
+void     yield       (void);
+bool     ienabled    (void);
+void     iset        (bool enable);
+Context *kcontext    (Area kstack, void (*entry)(void *), void *arg);
+
+// ----------------------- VME: Virtual Memory -----------------------
+bool     vme_init    (void *(*pgalloc)(int), void (*pgfree)(void *));
+void     protect     (AddrSpace *as);
+void     unprotect   (AddrSpace *as);
+void     map         (AddrSpace *as, void *vaddr, void *paddr, int prot);
+Context *ucontext    (AddrSpace *as, Area kstack, void *entry);
+
+// ---------------------- MPE: Multi-Processing ----------------------
+bool     mpe_init    (void (*entry)());
+int      cpu_count   (void);
+int      cpu_current (void);
+int      atomic_xchg (int *addr, int newval);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

abstract-machine/am/include/amdev.h

@@ -0,0 +1,74 @@
+#ifndef __AMDEV_H__
+#define __AMDEV_H__
+
+// **MAY SUBJECT TO CHANGE IN THE FUTURE**
+
+#define AM_DEVREG(id, reg, perm, ...) \
+  enum { AM_##reg = (id) }; \
+  typedef struct { __VA_ARGS__; } AM_##reg##_T;
+
+AM_DEVREG( 1, UART_CONFIG,  RD, bool present);
+AM_DEVREG( 2, UART_TX,      WR, char data);
+AM_DEVREG( 3, UART_RX,      RD, char data);
+AM_DEVREG( 4, TIMER_CONFIG, RD, bool present, has_rtc);
+AM_DEVREG( 5, TIMER_RTC,    RD, int year, month, day, hour, minute, second);
+AM_DEVREG( 6, TIMER_UPTIME, RD, uint64_t us);
+AM_DEVREG( 7, INPUT_CONFIG, RD, bool present);
+AM_DEVREG( 8, INPUT_KEYBRD, RD, bool keydown; int keycode);
+AM_DEVREG( 9, GPU_CONFIG,   RD, bool present, has_accel; int width, height, vmemsz);
+AM_DEVREG(10, GPU_STATUS,   RD, bool ready);
+AM_DEVREG(11, GPU_FBDRAW,   WR, int x, y; void *pixels; int w, h; bool sync);
+AM_DEVREG(12, GPU_MEMCPY,   WR, uint32_t dest; void *src; int size);
+AM_DEVREG(13, GPU_RENDER,   WR, uint32_t root);
+AM_DEVREG(14, AUDIO_CONFIG, RD, bool present; int bufsize);
+AM_DEVREG(15, AUDIO_CTRL,   WR, int freq, channels, samples);
+AM_DEVREG(16, AUDIO_STATUS, RD, int count);
+AM_DEVREG(17, AUDIO_PLAY,   WR, Area buf);
+AM_DEVREG(18, DISK_CONFIG,  RD, bool present; int blksz, blkcnt);
+AM_DEVREG(19, DISK_STATUS,  RD, bool ready);
+AM_DEVREG(20, DISK_BLKIO,   WR, bool write; void *buf; int blkno, blkcnt);
+AM_DEVREG(21, NET_CONFIG,   RD, bool present);
+AM_DEVREG(22, NET_STATUS,   RD, int rx_len, tx_len);
+AM_DEVREG(23, NET_TX,       WR, Area buf);
+AM_DEVREG(24, NET_RX,       WR, Area buf);
+
+// Input
+
+#define AM_KEYS(_) \
+  _(ESCAPE) _(F1) _(F2) _(F3) _(F4) _(F5) _(F6) _(F7) _(F8) _(F9) _(F10) _(F11) _(F12) \
+  _(GRAVE) _(1) _(2) _(3) _(4) _(5) _(6) _(7) _(8) _(9) _(0) _(MINUS) _(EQUALS) _(BACKSPACE) \
+  _(TAB) _(Q) _(W) _(E) _(R) _(T) _(Y) _(U) _(I) _(O) _(P) _(LEFTBRACKET) _(RIGHTBRACKET) _(BACKSLASH) \
+  _(CAPSLOCK) _(A) _(S) _(D) _(F) _(G) _(H) _(J) _(K) _(L) _(SEMICOLON) _(APOSTROPHE) _(RETURN) \
+  _(LSHIFT) _(Z) _(X) _(C) _(V) _(B) _(N) _(M) _(COMMA) _(PERIOD) _(SLASH) _(RSHIFT) \
+  _(LCTRL) _(APPLICATION) _(LALT) _(SPACE) _(RALT) _(RCTRL) \
+  _(UP) _(DOWN) _(LEFT) _(RIGHT) _(INSERT) _(DELETE) _(HOME) _(END) _(PAGEUP) _(PAGEDOWN)
+
+#define AM_KEY_NAMES(key) AM_KEY_##key,
+enum {
+  AM_KEY_NONE = 0,
+  AM_KEYS(AM_KEY_NAMES)
+};
+
+// GPU
+
+#define AM_GPU_TEXTURE  1
+#define AM_GPU_SUBTREE  2
+#define AM_GPU_NULL     0xffffffff
+
+typedef uint32_t gpuptr_t;
+
+struct gpu_texturedesc {
+  uint16_t w, h;
+  gpuptr_t pixels;
+} __attribute__((packed));
+
+struct gpu_canvas {
+  uint16_t type, w, h, x1, y1, w1, h1;
+  gpuptr_t sibling;
+  union {
+    gpuptr_t child;
+    struct gpu_texturedesc texture;
+  };
+} __attribute__((packed));
+
+#endif