Add initial support for Ubuntu-provided GCC that uses glibc

Author: fwsGonzo

.gitignore

@@ -2,6 +2,7 @@
 **/build_*/
 **/riscv32-unknown-elf/
 **/riscv64-unknown-elf/
+**/riscv64-linux-gnu/
 *.elf
 .vscode/
 engine/engine

README.md

@@ -39,7 +39,21 @@ This project has no external dependencies outside of libriscv and libfmt. libris
 
 Running the engine is only half the equation as you will also want to be able to modify the scripts themselves. To do that you need a RISC-V compiler.
 
-## Getting a RISC-V compiler
+## Using a RISC-V toolchain from system package
+
+This is the simplest option. Run [build.sh](/engine/build.sh) with `--glibc`. Right now it assumes you have installed `gcc-12-riscv64-linux-gnu`, however it may be possible to auto-detect this in the future.
+
+```sh
+sudo apt install gcc-12-riscv64-linux-gnu
+cd engine
+./build.sh --glibc
+```
+
+The C-library that is used by this toolchain, glibc, will use its own POSIX multi-threading, and it will be required that it works in order for C++ exceptions to work. So, be careful with mixing microthread and C++ exceptions.
+
+The GCC compiler is built using the C-extension (compressed instructions), which is now default enabled in the build script. It has a known minor performance impact.
+
+## Getting a newlib RISC-V compiler
 
 There are several ways to do this. However for now one requirement is to build the newlib variant in the riscv-gnu-toolchain for RISC-V. Install it like this:
 
@@ -65,7 +79,7 @@ $ riscv64-unknown-elf-g++ --version
 riscv64-unknown-elf-g++ (g5964b5cd7) 11.1.0
 ```
 
-While 32-bit RISC-V is faster to emulate than 64-bit, I prefer it when the sizes match between the address spaces.
+While 32-bit RISC-V is faster to emulate than 64-bit, I prefer it when the sizes match between the address spaces. It makes passing objects and structs very easy.
 
 ## Building script files
 
@@ -245,5 +259,3 @@ See `libriscv/memory.hpp` for a list of helper functions, each with a specific p
 	- Definitely. I already support a few 256-bit operations, but it is not near completion.
 - I have real-time requirements.
 	- As long as pausing the script to continue later is an option, you will not have any trouble. Just don't pause the script while it's in a thread and then accidentally vmcall into it from somewhere else. This will clobber all registers and you will have trouble later. You can use preempt provided that it returns to the same thread again (although you are able to yield back to a thread manually). There are many options where things will be OK. In my own engine all long-running tasks are running on separate machines to simplify things.
-- My program is jumping to a misaligned instruction. Something is very wrong!
-	- Try enabling the RISCV_EXT_C CMake option and see if perhaps your RISC-V programs are built with compressed instructions enabled. They are the most performant in libriscv, but they are pretty standard. For example the standard 64-bit RISC-V architecture is RV64GC, while the most performant in libriscv is RV64G.

engine/build.sh

@@ -6,13 +6,13 @@ export CC="ccache $CC"
 # Build the game
 mkdir -p build
 pushd build
-cmake .. -DCMAKE_BUILD_TYPE=Release -DFLTO=ON -DSANITIZE=OFF
+cmake .. -DCMAKE_BUILD_TYPE=Release -DFLTO=ON -DSANITIZE=OFF -DRISCV_EXT_C=ON
 make -j4
 popd
 
 # Build the script
 pushd ../programs
-source build.sh
+source build.sh $@
 popd
 
 # gsettings set org.gnome.mutter center-new-windows true 

engine/scripts/src/gameplay.cpp

@@ -33,7 +33,7 @@ static void opaque_dyncall_handler()
 	sys_empty();
 	sys_empty();
 	sys_empty();
-	// return_fast();
+	return_fast();
 }
 
 static void inline_dyncall_handler()
@@ -42,7 +42,7 @@ static void inline_dyncall_handler()
 	isys_empty();
 	isys_empty();
 	isys_empty();
-	// return_fast();
+	return_fast();
 }
 
 static void opaque_dyncall_args_x4()
@@ -55,7 +55,7 @@ static void opaque_dyncall_args_x4()
 	sys_testing123(1, 2, 3);
 	sys_empty();
 	sys_testing123(1, 2, 3);
-	// return_fast();
+	return_fast();
 }
 
 static void inline_dyncall_args_x4()
@@ -68,7 +68,7 @@ static void inline_dyncall_args_x4()
 	isys_testing123(1, 2, 3);
 	isys_empty();
 	isys_testing123(1, 2, 3);
-	// return_fast();
+	return_fast();
 }
 
 PUBLIC(void public_donothing())
@@ -94,7 +94,7 @@ PUBLIC(void benchmarks())
 	   while preserving registers, and then prints some statistics. */
 	measure("VM function call overhead",
 		[] {
-			//return_fast();
+			return_fast();
 		});
 	measure("Full thread creation overhead", full_thread_function);
 	measure("Oneshot thread creation overhead", oneshot_thread_function);

engine/scripts/src/level1_threads.cpp

@@ -77,7 +77,7 @@ void do_threads_stuff()
 		[](std::string mt)
 		{
 			print("Hello ", mt, " World!\n");
-			sleep(1.0);
+			Timer::sleep(1.0);
 			print("Hello Belated Microthread World! 1 second passed.\n");
 			/* add_remote_work is implemented in events.hpp
 			   NOTE: We cannot pass "anything" we want here,

engine/src/script/script.cpp

@@ -51,7 +51,10 @@ bool Script::reset()
 		// setup system calls and traps
 		this->machine_setup();
 		// setup program argv *after* setting new stack pointer
-		machine().setup_argv({name()});
+		static const std::vector<std::string> env = {
+			"LC_CTYPE=C", "LC_ALL=C", "USER=groot"
+		};
+		machine().setup_linux({name()}, env);
 	}
 	catch (std::exception& e)
 	{
@@ -161,6 +164,10 @@ void Script::machine_setup()
 	{
 		this->m_heap_area = machine().memory.mmap_allocate(MAX_HEAP);
 	}
+
+	// Add POSIX system call interfaces
+	machine().setup_linux_syscalls();
+	machine().setup_posix_threads();
 	// Add native system call interfaces
 	machine().setup_native_heap(HEAP_SYSCALLS_BASE, heap_area(), MAX_HEAP);
 	machine().setup_native_memory(MEMORY_SYSCALLS_BASE);

ext/libriscv

@@ -2,12 +2,32 @@
 set -e
 GCC_TRIPLE="riscv64-unknown-elf"
 export CXX="ccache $GCC_TRIPLE-g++"
+CDEBUG="-DGCSECTIONS=ON -DLTO=OFF -DCMAKE_BUILD_TYPE=Release"
 
-if [[ -z "${DEBUG}" ]]; then
-	CDEBUG="-DGCSECTIONS=ON -DLTO=OFF -DCMAKE_BUILD_TYPE=Release"
-else
-	CDEBUG="-DGCSECTIONS=OFF -DLTO=OFF -DCMAKE_BUILD_TYPE=Debug"
-fi
+for i in "$@"; do
+	case $i in
+#    -e=*|--extension=*)
+#      EXTENSION="${i#*=}"
+#      shift # past argument=value
+#      ;;
+		--debug)
+			CDEBUG="-DGCSECTIONS=OFF -DLTO=OFF -DCMAKE_BUILD_TYPE=Debug"
+			shift # past argument with no value
+			;;
+		--glibc)
+			GCC_VERSION=12
+			GCC_TRIPLE="riscv64-linux-gnu"
+			export CXX="ccache $GCC_TRIPLE-g++-$GCC_VERSION"
+			shift # past argument with no value
+			;;
+		-*|--*)
+			echo "Unknown option $i"
+			exit 1
+			;;
+		*)
+		;;
+	esac
+done
 
 mkdir -p $GCC_TRIPLE
 pushd $GCC_TRIPLE

programs/build.sh

@@ -76,6 +76,9 @@ namespace api
 		static Timer periodic(float period, Callback);
 		static Timer periodic(float time, float period, Callback);
 		void stop() const;
+
+		static long sleep(float seconds);
+
 		const int id;
 	};
 

programs/micro/api/api.h

@@ -75,7 +75,7 @@ template <typename T> inline long measure(const char* testname, T testfunc)
 
 inline uint32_t Game::current_machine()
 {
-	return syscall(ECALL_MACHINE_HASH);
+	return syscall1(ECALL_MACHINE_HASH);
 }
 
 #define RUNNING_ON(mach) (api::current_machine() == crc32(mach))
@@ -107,7 +107,7 @@ inline void each_tick(const T& func, Args&&... args)
 
 inline void Game::exit()
 {
-	(void)syscall(ECALL_GAME_EXIT);
+	(void)syscall1(ECALL_GAME_EXIT);
 }
 
 inline void Game::breakpoint(std::source_location sl)
@@ -178,7 +178,7 @@ inline void Timer::stop() const
 	sys_timer_stop(this->id);
 }
 
-inline long sleep(float seconds)
+inline long Timer::sleep(float seconds)
 {
 	const int tid = microthread::gettid();
 	Timer::oneshot(
@@ -309,11 +309,13 @@ dynamic_call(const uint32_t hash, const char* name, Args&&... args)
 	{
 		if (type[i] == 0b001)
 		{
+#ifdef __OPTIMIZE__
 			if ((int64_t)gpr[i] >= -4096 && (int64_t)gpr[i] < 4096)
 			{
 				asm(".insn i 0b0001011, 0, x0, x0, %0" ::"I"(gpr[i]));
 			}
 			else
+#endif
 			{
 				a0 = gpr[i];
 				asm(".word 0b001000000001011" : : "r"(a0));

programs/micro/api/api_impl.h

@@ -14,7 +14,7 @@ inline void print(Args&&... args)
 
 inline void print_backtrace()
 {
-	syscall(SYSCALL_BACKTRACE);
+	syscall1(SYSCALL_BACKTRACE);
 }
 
 extern "C"

programs/micro/libc/assert.cpp

@@ -33,7 +33,7 @@ int fputc (int c, FILE*)
 	return sys_write(&c, 1);
 }
 extern "C"
-wint_t fputwc(wchar_t ch, FILE*)
+uint8_t fputwc(wchar_t ch, FILE*)
 {
 	char c = ch;
 	sys_write(&c, 1);

programs/micro/libc/write.cpp

@@ -60,6 +60,7 @@ function (add_micro_binary NAME ORG)
 	target_link_libraries(${NAME} -static -Wl,--whole-archive libc -Wl,--no-whole-archive)
 	target_link_libraries(${NAME} frozen::frozen)
 	target_link_libraries(${NAME} "-Wl,-Ttext-segment=${ORG}")
+	target_link_libraries(${NAME} "-Wl,--wrap=exit")
 	# place ELF into the sub-projects source folder
 	set_target_properties(${NAME}
 		PROPERTIES RUNTIME_OUTPUT_DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}"