wspace

README

Nebula

Nebula is an optimizing compiler for stack-oriented programming languages that targets LLVM IR.

Requirements

• Go 1.13 or later
• LLVM source
• Graphviz to render graphs

Project Goals

Compilation

• Nebula IR
  • Operations
    • Arithmetic - add, sub, mul, div, mod
    • Stack - push registers, pop length
    • Heap - load, store
    • I/O - read, print
    • Control flow - jmp, conditional jmp, call, ret
    • Assertions - zero divisor, stack underflow, ret underflow
  • Memory
    • Stack
    • Heap - partitioned
    • Call stack
  • Static single assignment form
    • Stack access converted to indexed variables
    • Connected graph of basic blocks
    • Minimize stack pointer updates to once per block
  • Interprocedural analysis
    • Constant stack folding and propagation
    • String concatenation
    • Dead code elimination
    • Call stack underflow detection
    • Trap eliding
    • Register allocation
    • Reduction of arbitrary precision integers to fixed width
    • Tail call optimization
    • Heap access analysis
      • Lifetime analysis
      • Constant folding and propagation
    • Contract assertions
      • Using an SMT solver
      • Abstract interpretation
  • Targets
    • LLVM IR
    • WebAssembly via Emscripten

Languages

• High level language
  • Abstracted away from the WS stack and heap
  • Compiles to WS instruction set
  • Memory safe
• Assembly syntax language
  • Very close to WS instruction set
  • Assembly-like syntax
  • Allows additional metadata for compiler
  • Special compiler treatment of standard library functions
• Whitespace language
  • Direct representation of WS instruction set
  • Follows WS language spec syntax

License

The Nebula project is licensed under the MIT License. Subdirectories with code under differing licenses are marked with separate license files.

Naming

Nebula's name is derived from the stellar gas clouds, nebulae. Nebulae are incredibly diffuse, yet form some of the most beautiful astronomical landscapes. Similarly, of all programming languages, Whitespace is the least dense in visible characters and despite its simplicity, is Turing complete. The name is also a call-out to the star-forming region IC 1396 that contains many nebulae including the famous Elephant's Trunk Nebula.

Documentation

Overview

Nebula is a compiler for stack-based languages targeting LLVM IR.