porffor 0.2.0-77e30e8 → 0.2.0-812b38c

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 CanadaHonk
-
-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
+MIT License
+
+Copyright (c) 2023 CanadaHonk
+
+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.

package/README.md

@@ -1,5 +1,5 @@
 # Porffor &nbsp;<sup><sub>/ˈpɔrfɔr/ &nbsp;*(poor-for)*</sup></sub>
-A from-scratch experimental *AOT* optimizing JS -> Wasm/C engine/compiler/runtime in JS. Not serious/intended for (real) use. (this is a straight forward, honest readme)<br>
+A from-scratch experimental **AOT** optimizing JS/TS -> Wasm/C engine/compiler/runtime in JS. Not serious/intended for (real) use. (this is a straight forward, honest readme)<br>
 Age: ~6 months (very on and off)
 
 ## Design
@@ -10,6 +10,80 @@ Porffor is a very unique JS engine, due many wildly different approaches. It is
 
 Porffor is primarily built from scratch, the only thing that is not is the parser (using [Acorn](https://github.com/acornjs/acorn)). Binaryen/etc is not used, we make final wasm binaries ourself. You could imagine it as compiling a language which is a sub (some things unsupported) and super (new/custom apis) set of javascript. Not based on any particular spec version, focusing on function/working over spec compliance.
 
+## Usage
+Expect nothing to work! Only very limited JS is currently supported. See files in `bench` for examples.
+
+### Setup
+**`npm install -g porffor`**. It's that easy (hopefully) :)
+
+### Trying a REPL
+**`porf`**. Just run it with no script file argument.
+
+### Running a JS file
+**`porf path/to/script.js`**
+
+### Compiling to Wasm
+**`porf wasm path/to/script.js out.wasm`**. Currently it does not use an import standard like WASI, so it is mostly unusable on its own.
+
+### Compiling to native binaries
+> [!WARNING]
+> Compiling to native binaries uses [2c](#2c), Porffor's own Wasm -> C compiler, which is experimental.
+
+**`porf native path/to/script.js out(.exe)`**. You can specify the compiler with `--compiler=clang/zig/gcc`, and which opt level to use with `--cO=O3` (`Ofast` by default). Output binaries are also stripped by default.
+
+### Compiling to C
+> [!WARNING]
+> Compiling to C uses [2c](#2c), Porffor's own Wasm -> C compiler, which is experimental.
+
+**`porf c path/to/script.js (out.c)`**. When not including an output file, it will be printed to stdout instead.
+
+### Profiling a JS file
+> [!WARNING]
+> Very experimental WIP feature!
+
+**`porf profile path/to/script.js`**
+
+### Debugging a JS file
+> [!WARNING]
+> Very experimental WIP feature!
+
+**`porf debug path/to/script.js`**
+
+### Profiling the generated Wasm of a JS file
+> [!WARNING]
+> Very experimental WIP feature!
+
+**`porf debug-wasm path/to/script.js`**
+
+
+### Options
+- `--parser=acorn|@babel/parser|meriyah|hermes-parser` (default: `acorn`) to set which parser to use
+- `--parse-types` to enable parsing type annotations/typescript. if `-parser` is unset, changes default to `@babel/parser`. does not type check
+- `--opt-types` to perform optimizations using type annotations as compiler hints. does not type check
+- `--valtype=i32|i64|f64` (default: `f64`) to set valtype
+- `-O0` to disable opt
+- `-O1` (default) to enable basic opt (simplify insts, treeshake wasm imports)
+- `-O2` to enable advanced opt (inlining). unstable
+- `-O3` to enable advanceder opt (precompute const math). unstable
+- `--no-run` to not run wasm output, just compile
+- `--opt-log` to log some opts
+- `--code-log` to log some codegen (you probably want `-funcs`)
+- `--regex-log` to log some regex
+- `--funcs` to log funcs
+- `--ast-log` to log AST
+- `--opt-funcs` to log funcs after opt
+- `--sections` to log sections as hex
+- `--opt-no-inline` to not inline any funcs
+- `--tail-call` to enable tail calls (experimental + not widely implemented)
+- `--compile-hints` to enable V8 compilation hints (experimental + doesn't seem to do much?)
+
+### Running in the repo
+The repo comes with easy alias files for Unix and Windows, which you can use like so:
+- Unix: `./porf path/to/script.js`
+- Windows: `.\porf path/to/script.js`
+
+Please note that further examples below will just use `./porf`, you need to use `.\porf` on Windows. You can also swap out `node` in the alias to use another runtime like Deno (`deno run -A`) or Bun (`bun ...`), or just use it yourself (eg `node runner/index.js ...`, `bun runner/index.js ...`). Node and Bun should work great, Deno support is WIP.
+
 ## Limitations
 - No full object support yet
 - Little built-ins/prototype
@@ -18,10 +92,15 @@ Porffor is primarily built from scratch, the only thing that is not is the parse
 - Literal callees only in calls (eg `print()` works, `a = print; a()` does not)
 - No `eval()` etc (since it is AOT)
 
-## Rhemyn
+## Sub-engines
+
+### Asur
+Asur is Porffor's own Wasm engine; it is an intentionally simple interpreter written in JS. It is very WIP. See [its readme](asur/README.md) for more details.
+
+### Rhemyn
 Rhemyn is Porffor's own regex engine; it compiles literal regex to Wasm bytecode AOT (remind you of anything?). It is quite basic and WIP. See [its readme](rhemyn/README.md) for more details.
 
-## 2c
+### 2c
 2c is Porffor's own Wasm -> C compiler, using generated Wasm bytecode and internal info to generate specific and efficient/fast C code. Little boilerplate/preluded code or required external files, just for CLI binaries (not like wasm2c very much).
 
 ## Supported
@@ -86,20 +165,29 @@ These include some early (stage 1/0) and/or dead (last commit years ago) proposa
 - `for...of` (arrays and strings)
 - Array member setting (`arr[0] = 2`, `arr[0] += 2`, etc)
 - Array constructor (`Array(5)`, `new Array(1, 2, 3)`)
+- Labelled statements (`foo: while (...)`)
+- `do...while` loops
 
 ### Built-ins
 
-- `NaN` and `Infinity` (f64 only)
-- `isNaN()` and `isFinite()` (f64 only)
-- Most of `Number` (`MAX_VALUE`, `MIN_VALUE`, `MAX_SAFE_INTEGER`, `MIN_SAFE_INTEGER`, `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, `EPSILON`, `NaN`, `isNaN`, `isFinite`, `isInteger`, `isSafeInteger`) (some f64 only)
-- Some `Math` funcs (`Math.sqrt`, `Math.abs`, `Math.floor`, `Math.sign`, `Math.round`, `Math.trunc`, `Math.clz32`, `Math.fround`, `Math.random`) (f64 only)
+- `NaN` and `Infinity`
+- `isNaN()` and `isFinite()`
+- Most of `Number` (`MAX_VALUE`, `MIN_VALUE`, `MAX_SAFE_INTEGER`, `MIN_SAFE_INTEGER`, `POSITIVE_INFINITY`, `NEGATIVE_INFINITY`, `EPSILON`, `NaN`, `isNaN`, `isFinite`, `isInteger`, `isSafeInteger`)
+- Some `Math` funcs (`sqrt`, `abs`, `floor`, `sign`, `round`, `trunc`, `clz32`, `fround`, `random`)
 - Basic `globalThis` support
 - Basic `Boolean` and `Number`
 - Basic `eval` for literals
 - `Math.random()` using self-made xorshift128+ PRNG
-- Some of `performance` (`now()`)
-- Some of `Array.prototype` (`at`, `push`, `pop`, `shift`, `fill`)
-- Some of `String.prototype` (`at`, `charAt`, `charCodeAt`)
+- Some of `performance` (`now()`, `timeOrigin`)
+- Some of `Array.prototype` (`at`, `push`, `pop`, `shift`, `fill`, `slice`, `indexOf`, `lastIndexOf`, `includes`, `with`, `reverse`, `toReversed`)
+- Some of `Array` (`of`, `isArray`)
+- Most of `String.prototype` (`at`, `charAt`, `charCodeAt`, `toUpperCase`, `toLowerCase`, `startsWith`, `endsWith`, `indexOf`, `lastIndexOf`, `includes`, `padStart`, `padEnd`, `substring`, `substr`, `slice`, `trimStart`, `trimEnd`, `trim`, `toString`, `big`, `blink`, `bold`, `fixed`, `italics`, `small`, `strike`, `sub`, `sup`,  `trimLeft`, `trimRight`, )
+- Some of `crypto` (`randomUUID`)
+- `escape`
+- `btoa`
+- Most of `Number.prototype` (`toString`, `toFixed`, `toExponential`)
+- `parseInt`
+- Spec-compliant `Date`
 
 ### Custom
 
@@ -108,34 +196,8 @@ These include some early (stage 1/0) and/or dead (last commit years ago) proposa
 - Intrinsic functions (see below)
 - Inlining wasm via ``asm`...``\` "macro"
 
-## Todo
-No particular order and no guarentees, just what could happen soon™
-
-- Arrays
-  - More of `Array` prototype
-  - Arrays/strings inside arrays
-  - Destructuring
-- Objects
-  - Basic object expressions (eg `{}`, `{ a: 0 }`)
-- Wasm
-  - *Basic* Wasm engine (interpreter) in js
-- More math operators (`**`, etc)
-- `do { ... } while (...)`
-- Rewrite `console.log` to work with strings/arrays
-- Exceptions
-  - Rewrite to use actual strings (optional?)
-  - `try { } finally { }`
-  - Rethrowing inside catch
-- Optimizations
-  - Rewrite local indexes per func for smallest local header and remove unused idxs
-  - Smarter inline selection (snapshots?)
-  - Remove const ifs (`if (true)`, etc)
-  - Use type(script) information to remove unneeded typechecker code
-
 ## Performance
-*For the things it supports most of the time*, Porffor is blazingly fast compared to most interpreters, and common engines running without JIT. For those with JIT, it is not that much slower like a traditional interpreter would be; mostly the same or a bit faster/slower depending on what.
-
-![Screenshot of comparison chart](https://github.com/CanadaHonk/porffor/assets/19228318/76c75264-cc68-4be1-8891-c06dc389d97a)
+*For the features it supports most of the time*, Porffor is *blazingly fast* compared to most interpreters and common engines running without JIT. For those with JIT, it is usually slower by default, but can catch up with compiler arguments and typed input, even more so when compiling to native binaries.
 
 ## Optimizations
 Mostly for reducing size. I do not really care about compiler perf/time as long as it is reasonable. We do not use/rely on external opt tools (`wasm-opt`, etc), instead doing optimization inside the compiler itself creating even smaller code sizes than `wasm-opt` itself can produce as we have more internal information.
@@ -143,7 +205,7 @@ Mostly for reducing size. I do not really care about compiler perf/time as long
 ### Traditional opts
 - Inlining functions (WIP, limited)
 - Inline const math ops
-- Tail calls (behind flag `-tail-call`)
+- Tail calls (behind flag `--tail-call`)
 
 ### Wasm transforms
 - `local.set`, `local.get` -> `local.tee`
@@ -157,10 +219,12 @@ Mostly for reducing size. I do not really care about compiler perf/time as long
 - Remove unneeded blocks (no `br`s inside)
 - Remove unused imports
 - Use data segments for initing arrays/strings
+- (Likely more not documented yet, todo)
 
 ### Wasm module
 - Type cache/index (no repeated types)
 - No main func if empty (and other exports)
+- No tags if unused/optimized out
 
 ## Test262
 Porffor can run Test262 via some hacks/transforms which remove unsupported features whilst still doing the same asserts (eg simpler error messages using literals only). It currently passes >10% (see latest commit desc for latest and details). Use `node test262` to test, it will also show a difference of overall results between the last commit and current results.
@@ -168,7 +232,7 @@ Porffor can run Test262 via some hacks/transforms which remove unsupported featu
 ## Codebase
 - `compiler`: contains the compiler itself
   - `builtins.js`: all built-ins of the engine (spec, custom. vars, funcs)
-  - `codeGen.js`: code (wasm) generation, ast -> wasm. The bulk of the effort
+  - `codegen.js`: code (wasm) generation, ast -> wasm. The bulk of the effort
   - `decompile.js`: basic wasm decompiler for debug info
   - `embedding.js`: utils for embedding consts
   - `encoding.js`: utils for encoding things as bytes as wasm expects
@@ -176,11 +240,11 @@ Porffor can run Test262 via some hacks/transforms which remove unsupported featu
   - `index.js`: doing all the compiler steps, takes code in, wasm out
   - `opt.js`: self-made wasm bytecode optimizer
   - `parse.js`: parser simply wrapping acorn
-  - `sections.js`: assembles wasm ops and metadata into a wasm module/file
+  - `assemble.js`: assembles wasm ops and metadata into a wasm module/file
   - `wasmSpec.js`: "enums"/info from wasm spec
   - `wrap.js`: wrapper for compiler which instantiates and produces nice exports
 
-- `runner`: contains utils for running js with the compiler
+- `runner`: contains utils for running JS with the compiler
   - `index.js`: the main file, you probably want to use this
   - `info.js`: runs with extra info printed
   - `repl.js`: basic repl (uses `node:repl`)
@@ -193,57 +257,80 @@ Porffor can run Test262 via some hacks/transforms which remove unsupported featu
 - `test262`: test262 runner and utils
 
 ## Usecases
-Basically none (other than giving people headaches). Potential ideas to come?
+Basically none right now (other than giving people headaches). Potential ideas:
+- Safety. As Porffor is written in JS, a memory-safe language\*, and compiles JS to Wasm, a fully sandboxed environment\*, it is quite safe. (\* These rely on the underlying implementations being secure. You could also run Wasm, or even Porffor itself, with an interpreter instead of a JIT for bonus security points too.)
+- Compiling JS to native binaries. This is still very early!
+- More in future probably?
 
-## Usage
-Basically nothing will work :). See files in `test` for examples.
+## Todo
+No particular order and no guarentees, just what could happen soon™
 
-1. Clone repo
-2. `npm install`
-3. `node test` to run tests (some will fail)
-4. `node runner path/to/code.js` to run a file (or `node runner` to use wip repl)
+- Arrays
+  - More of `Array` prototype
+  - Arrays/strings inside arrays
+  - Destructuring
+- Objects
+  - Basic object expressions (eg `{}`, `{ a: 0 }`)
+- Asur
+  - Support memory
+  - Support exceptions
+- More math operators (`**`, etc)
+- Typed export inputs (array)
+- Exceptions
+  - Rewrite to use actual strings (optional?)
+  - `try { } finally { }`
+  - Rethrowing inside catch
+- Optimizations
+  - Rewrite local indexes per func for smallest local header and remove unused idxs
+  - Smarter inline selection (snapshots?)
+  - Remove const ifs (`if (true)`, etc)
+  - Memory alignment
+  - Add general pref for always using "fast" (non-short circuiting) or/and
+- Runtime
+  - WASI target
+  - Run precompiled Wasm file if given
+- Docs
+  - Update codebase readme section
+- Cool proposals
+  - [Optional Chaining Assignment](https://github.com/tc39/proposal-optional-chaining-assignment)
+  - [Modulus and Additional Integer Math](https://github.com/tc39/proposal-integer-and-modulus-math)
+  - [Array Equality](https://github.com/tc39/proposal-array-equality)
+  - [Declarations in Conditionals](https://github.com/tc39/proposal-Declarations-in-Conditionals)
+  - [Seeded Pseudo-Random Numbers](https://github.com/tc39/proposal-seeded-random)
+  - [`do` expressions](https://github.com/tc39/proposal-do-expressions)
+  - [String Trim Characters](https://github.com/Kingwl/proposal-string-trim-characters)
+- Posts
+  - Inlining investigation
+  - JS -> Native
+  - Precompiled TS built-ins
+  - Asur
+  - `escape()` optimization
+- Self hosted testing?
 
-You can also use Deno (`deno run -A ...` instead of `node ...`), or Bun (`bun ...` instead of `node ...`).
+## VSCode extension
+There is a vscode extension in `vscode-ext` which tweaks JS syntax highlighting to be nicer with porffor features (eg highlighting wasm inside of inline asm).
 
-### Options
-- `-target=wasm|c|native` (default: `wasm`) to set target output (native compiles c output to binary, see args below)
-- `-target=c|native` only:
-  - `-o=out.c|out.exe|out` to set file to output c or binary
-- `-target=native` only:
-  - `-compiler=clang` to set compiler binary (path/name) to use to compile
-  - `-cO=O3` to set compiler opt argument
-- `-valtype=i32|i64|f64` (default: `f64`) to set valtype
-- `-O0` to disable opt
-- `-O1` (default) to enable basic opt (simplify insts, treeshake wasm imports)
-- `-O2` to enable advanced opt (inlining)
-- `-O3` to enable advanceder opt (precompute const math)
-- `-no-run` to not run wasm output, just compile
-- `-opt-log` to log some opts
-- `-code-log` to log some codegen (you probably want `-funcs`)
-- `-regex-log` to log some regex
-- `-funcs` to log funcs
-- `-ast-log` to log AST
-- `-opt-funcs` to log funcs after opt
-- `-sections` to log sections as hex
-- `-opt-no-inline` to not inline any funcs
-- `-tail-call` to enable tail calls (experimental + not widely implemented)
-- `-compile-hints` to enable V8 compilation hints (experimental + doesn't seem to do much?)
+## Wasm proposals used
+Porffor intentionally does not use Wasm proposals which are not commonly implemented yet (eg GC) so it can be used in as many places as possible.
 
-## VSCode extension
-There is a vscode extension in `porffor-for-vscode` which tweaks js syntax highlighting to be nicer with porffor features (eg highlighting wasm inside of inline asm).
+- Multi-value **(required)**
+- Non-trapping float-to-int conversions **(required)**
+- Bulk memory operations (required, but uncommonly used)
+- Exception handling (optional, for errors)
+- Tail calls (opt-in, off by default)
 
 ## Isn't this the same as AssemblyScript/other Wasm langs?
 No. they are not alike at all internally and have very different goals/ideals:
 - Porffor is made as a generic JS engine, not for Wasm stuff specifically
-- Porffor takes in JS, not a different language or typescript
-- Porffor is made in pure JS and compiles itself, not using Binaryen/etc
+- Porffor primarily consumes JS
+- Porffor is written in pure JS and compiles itself, not using Binaryen/etc
 - (Also I didn't know it existed when I started this, lol)
 
 ## FAQ
 
 ### 1. Why the name?
 `purple` in Welsh is `porffor`. Why purple?
-- No other js engine is purple colored
+- No other JS engine is purple colored
 - Purple is pretty cool
 - Purple apparently represents "ambition", which is.. one word to describe this project
 - The hard to speak name is also the noise your brain makes in reaction to this idea!

package/asur/README.md

@@ -0,0 +1,2 @@
+# asur
+a basic experimental wip wasm engine/interpreter in js. wasm engine for porffor. not serious/intended for (real) use