4 ms·

Selfie – A tiny RISC-V C compiler, emulator and hypervisor

jay-barronville 4y ago
From the project’s README [1]: > Selfie is implemented in a single (!) file and kept minimal for simplicity. There is also a simple in-memory linker, a RISC-U disassembler, a garbage collector, L1 instruction and data caches, a profiler, and a debugger with replay as well as minimal operating system support in the form of RISC-V system calls built into the emulator and hypervisor. The garbage collector is conservative and even self-collecting. It may operate as library in the same address space as the mutator and/or as part of the emulator in the address space of the kernel. I was a bit skeptical reading that, but I’m very impressed right now [2] . . . [1]: https://github.com/cksystemsteaching/selfie/blob/5de675a0f08613adab2315d50ce7c2db2079005d/README.md https://github.com/cksystemsteaching/selfie/blob/5de675a0f08... [2]: https://github.com/cksystemsteaching/selfie/blob/5de675a0f08613adab2315d50ce7c2db2079005d/selfie.c https://github.com/cksystemsteaching/selfie/blob/5de675a0f08...
- flik 4y ago
  Checking out further... Related course (https://cksystemsteaching.github.io/CS4All/ https://cksystemsteaching.github.io/CS4All/) and book (https://github.com/ckirsch/book https://github.com/ckirsch/book)
  - wrycoder 4y ago
    The design of the selfie compiler is inspired by the Oberon compiler of Professor Niklaus Wirth from ETH Zurich. RISC-U, the target language of the selfie compiler, is inspired by the RISC-V community around Professor David Patterson from UC Berkeley. The selfie garbage collector is inspired by the conservative garbage collector of Hans Boehm. The design of the selfie microkernel is inspired by microkernels of Professor Jochen Liedtke from University of Karlsruhe. That's quite the pedigree! This is a very interesting project to dig into, starting with the book.
- boberoni 4y ago
  This part of the README explains what exactly Selfie can be used for: > a self-compiling compiler called starc that compiles a tiny but still fast subset of C called C Star (*) to a tiny and easy-to-teach subset of RISC-V called RISC-U, > a self-executing emulator called mipster that executes RISC-U code including itself when compiled with starc, > a self-hosting hypervisor called hypster that provides RISC-U virtual machines that can host all of selfie, that is, starc, mipster, and hypster itself, and a tiny C* library called libcstar utilized by selfie.
tromp 4y ago
Why do they need both > uint64_t SIZEOFUINT64 = 8; // in bytes and > SIZEOFUINT64 = (uint64_t) ((uint64_t*) SELFIE_URL + 1) - (uint64_t) SELFIE_URL; in init_library() ?
- forkerenok 4y ago
  The first one looks like a declaration in the global scope with a sane default, the latter is determining the actual size. Haven't done C in a long long time, so I may be talking out of my ass.
  - pkphilip 4y ago
    Your take seems accurate. That is my reading as well
  - sph 4y ago
    I don't believe it one bit that you haven't done C in 2^64 seconds. EDIT: technically 2^63-1 seconds.
    - jay-barronville 4y ago
      Lol! I actually chuckled at this. I completely missed that.
  - Someone 4y ago
    I think it’s more likely this is a minor/latent bug. Initializing the value and later assigning it a new value runs the risk of having some code that uses the value of one expression and other code that uses the value (presumedly/hopefully identical to the former) of another expression. That’s not a risk you want to take. The name also doesn’t give me an indication they considered making the code agnostic as to the size of that variable.
- jay-barronville 4y ago
  From reading the code [1], both aren't needed; the `SIZEOFUINT64 = (uint64_t) ((uint64_t*) SELFIE_URL + 1) - (uint64_t) SELFIE_URL;` statement is the value that always ends up being used (once the library is initialized). An optimizing compiler would likely optimize the calculation away anyway. My guess is that it's predefined at the top simply for clarity and verbosity's sake (remember that this is built for educational purposes). [1]: https://github.com/cksystemsteaching/selfie/blob/5de675a0f08613adab2315d50ce7c2db2079005d/selfie.c#L308 https://github.com/cksystemsteaching/selfie/blob/5de675a0f08...
boberoni 4y ago
According to the GitHub README, selfie's emulator and hypervisor can only support programs in RISC-U, "a tiny and easy-to-teach subset of RISC-V".[1] So... not the full RISC-V ISA. For what it's worth, the selfie compiler can build RISC-U programs for you. Still a really cool project! I've been meaning to learn more about compiler backend development. I usually spend time on the frontend. [1] https://github.com/cksystemsteaching/selfie https://github.com/cksystemsteaching/selfie
piragi 4y ago
Wow really happy for this project to get so much attention. It was my favorite of all the courses there!

From the project’s README [1]: > Selfie is implemented in a single (!) file and kept minimal for simplicity. There is also a simple in-memory linker, a RISC-U disassembler, a garbage collector, L1 instruction and data caches, a profiler, and a debugger with replay as well as minimal operating system support in the form of RISC-V system calls built into the emulator and hypervisor. The garbage collector is conservative and even self-collecting. It may operate as library in the same address space as the mutator and/or as part of the emulator in the address space of the kernel. I was a bit skeptical reading that, but I’m very impressed right now [2] . . . [1]: https://github.com/cksystemsteaching/selfie/blob/5de675a0f08613adab2315d50ce7c2db2079005d/README.md https://github.com/cksystemsteaching/selfie/blob/5de675a0f08... [2]: https://github.com/cksystemsteaching/selfie/blob/5de675a0f08613adab2315d50ce7c2db2079005d/selfie.c https://github.com/cksystemsteaching/selfie/blob/5de675a0f08...

flik 4y ago
Checking out further... Related course (https://cksystemsteaching.github.io/CS4All/ https://cksystemsteaching.github.io/CS4All/) and book (https://github.com/ckirsch/book https://github.com/ckirsch/book)
- wrycoder 4y ago
  The design of the selfie compiler is inspired by the Oberon compiler of Professor Niklaus Wirth from ETH Zurich. RISC-U, the target language of the selfie compiler, is inspired by the RISC-V community around Professor David Patterson from UC Berkeley. The selfie garbage collector is inspired by the conservative garbage collector of Hans Boehm. The design of the selfie microkernel is inspired by microkernels of Professor Jochen Liedtke from University of Karlsruhe. That's quite the pedigree! This is a very interesting project to dig into, starting with the book.
boberoni 4y ago
This part of the README explains what exactly Selfie can be used for: > a self-compiling compiler called starc that compiles a tiny but still fast subset of C called C Star (*) to a tiny and easy-to-teach subset of RISC-V called RISC-U, > a self-executing emulator called mipster that executes RISC-U code including itself when compiled with starc, > a self-hosting hypervisor called hypster that provides RISC-U virtual machines that can host all of selfie, that is, starc, mipster, and hypster itself, and a tiny C* library called libcstar utilized by selfie.

tromp 4y ago

Why do they need both > uint64_t SIZEOFUINT64 = 8; // in bytes and > SIZEOFUINT64 = (uint64_t) ((uint64_t*) SELFIE_URL + 1) - (uint64_t) SELFIE_URL; in init_library() ?

forkerenok 4y ago
The first one looks like a declaration in the global scope with a sane default, the latter is determining the actual size. Haven't done C in a long long time, so I may be talking out of my ass.
- pkphilip 4y ago
  Your take seems accurate. That is my reading as well
- sph 4y ago
  I don't believe it one bit that you haven't done C in 2^64 seconds. EDIT: technically 2^63-1 seconds.
  - jay-barronville 4y ago
    Lol! I actually chuckled at this. I completely missed that.
- Someone 4y ago
  I think it’s more likely this is a minor/latent bug. Initializing the value and later assigning it a new value runs the risk of having some code that uses the value of one expression and other code that uses the value (presumedly/hopefully identical to the former) of another expression. That’s not a risk you want to take. The name also doesn’t give me an indication they considered making the code agnostic as to the size of that variable.
jay-barronville 4y ago
From reading the code [1], both aren't needed; the `SIZEOFUINT64 = (uint64_t) ((uint64_t*) SELFIE_URL + 1) - (uint64_t) SELFIE_URL;` statement is the value that always ends up being used (once the library is initialized). An optimizing compiler would likely optimize the calculation away anyway. My guess is that it's predefined at the top simply for clarity and verbosity's sake (remember that this is built for educational purposes). [1]: https://github.com/cksystemsteaching/selfie/blob/5de675a0f08613adab2315d50ce7c2db2079005d/selfie.c#L308 https://github.com/cksystemsteaching/selfie/blob/5de675a0f08...

boberoni 4y ago

According to the GitHub README, selfie's emulator and hypervisor can only support programs in RISC-U, "a tiny and easy-to-teach subset of RISC-V".[1] So... not the full RISC-V ISA. For what it's worth, the selfie compiler can build RISC-U programs for you. Still a really cool project! I've been meaning to learn more about compiler backend development. I usually spend time on the frontend. [1] https://github.com/cksystemsteaching/selfie https://github.com/cksystemsteaching/selfie

piragi 4y ago

Wow really happy for this project to get so much attention. It was my favorite of all the courses there!