porffor 0.58.0 → 0.58.2

package/README.md

@@ -5,8 +5,8 @@ A from-scratch experimental **AOT** optimizing JS/TS -> Wasm/C engine/compiler/r
 
 ## Design
 Porffor is a very unique JS engine, due many wildly different approaches. It is seriously limited, but what it can do, it does pretty well. Key differences:
-- 100% AOT compiled (no JIT)
-- No constant runtime/preluded code
+- 100% AOT compiled (no JIT or interpreter)
+- Zero constant runtime/preluded code
 - Least Wasm imports possible (only I/O)
 
 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.
@@ -50,11 +50,11 @@ Expect nothing to work! Only very limited JS is currently supported. See files i
 
 **`porf debug path/to/script.js`**
 
-### Debugging the compiled Wasm of a JS file
+<!-- ### Debugging the compiled Wasm of a JS file
 > [!WARNING]
 > Very experimental WIP feature!
 
-**`porf dissect path/to/script.js`**
+**`porf dissect path/to/script.js`** -->
 
 
 ### Options
@@ -73,8 +73,8 @@ Expect nothing to work! Only very limited JS is currently supported. See files i
 
 ## 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.
+<!-- ### 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. -->
 
 ### 2c
 2c is Porffor's own Wasm -> C compiler, using generated Wasm bytecode and internal info to generate specific and efficient C code. Little boilerplate/preluded code or required external files, just for CLI binaries (not like wasm2c very much).
@@ -88,11 +88,6 @@ Porffor uses a unique versioning system, here's an example: `0.48.7`. Let's brea
 ## Performance
 *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.
 
-## 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 >14% (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.
-
-![image](https://github.com/CanadaHonk/porffor/assets/19228318/5320da7d-e945-4d16-857b-499f3a6c1180)
-
 ## Codebase
 - `compiler`: contains the compiler itself
   - `builtins`: built-in apis written in typescript

package/compiler/builtins.js

@@ -8,6 +8,15 @@ import './prefs.js';
 export const importedFuncs = {};
 Object.defineProperty(importedFuncs, 'length', { configurable: true, writable: true, value: 0 });
 
+/**
+ * Create an import function for the Porffor world to use.
+ *
+ * @param {string} name - Name of the import
+ * @param {number} params - Number of parameters
+ * @param {number} results - Number of results
+ * @param {function} js - Native (your world) function to call as import implementation
+ * @param {string} c - C source code to compile as import implementation
+ */
 export const createImport = (name, params, returns, js = null, c = null) => {
   const lazy = () => {
     if (typeof params === 'function') params = params();

package/compiler/codegen.js

@@ -1760,7 +1760,7 @@ const getNodeType = (scope, node) => {
   const out = typeof ret === 'number' ? [ number(ret, Valtype.i32) ] : ret;
   if (guess != null) out.guess = typeof guess === 'number' ? [ number(guess, Valtype.i32) ] : guess;
 
-  if (!node._doNotMarkTypeUsed) typeUsed(scope, knownType(scope, out));
+  typeUsed(scope, knownType(scope, out));
   return out;
 };
 
@@ -2595,8 +2595,7 @@ const generateCall = (scope, decl, _global, _name, unusedValue = false) => {
       args = args.slice(0, paramCount - 1);
       args.push({
         type: 'ArrayExpression',
-        elements: restArgs,
-        _doNotMarkTypeUsed: true
+        elements: restArgs
       });
     }
   }

package/compiler/index.js

@@ -19,7 +19,7 @@ const logFuncs = (funcs, globals, exceptions) => {
   if (typeof wanted !== 'string') wanted = null;
 
   for (const f of funcs) {
-    if ((wanted && f.name !== wanted) || (!wanted && f.internal)) continue;
+    if ((wanted && (f.name !== wanted && wanted !== '!')) || (!wanted && f.internal)) continue;
     console.log(disassemble(f.wasm, f.name, f.index, f.locals, f.params, f.returns, funcs, globals, exceptions));
   }
 

package/compiler/pgo.js

@@ -2,7 +2,7 @@ import { Opcodes, Valtype } from './wasmSpec.js';
 import { number } from './encoding.js';
 import { createImport, importedFuncs } from './builtins.js';
 import assemble from './assemble.js';
-import wrap, { writeByteStr } from './wrap.js';
+import wrap from './wrap.js';
 import * as Havoc from './havoc.js';
 import './prefs.js';
 
@@ -95,18 +95,19 @@ export const run = obj => {
 
     const { exports } = wrap(obj, undefined, {
       readArgv: (ind, outPtr) => {
-        const pgoInd = process.argv.indexOf('--pgo');
-        let args = process.argv.slice(pgoInd);
-        args = args.slice(args.findIndex(x => !x.startsWith('-')) + 1);
-
-        const str = args[ind - 1];
-        if (pgoInd === -1 || !str) {
-          if (Prefs.pgoLog) console.log('\nPGO warning: script was expecting arguments, please specify args to use for PGO after --pgo arg');
-          return -1;
-        }
-
-        writeByteStr(exports.$, outPtr, str);
-        return str.length;
+        // const pgoInd = process.argv.indexOf('--pgo');
+        // let args = process.argv.slice(pgoInd);
+        // args = args.slice(args.findIndex(x => !x.startsWith('-')) + 1);
+
+        // const str = args[ind - 1];
+        // if (pgoInd === -1 || !str) {
+        //   if (Prefs.pgoLog) console.log('\nPGO warning: script was expecting arguments, please specify args to use for PGO after --pgo arg');
+        //   return -1;
+        // }
+
+        // writeByteStr(exports.$, outPtr, str);
+        // return str.length;
+        return -1;
       },
       readFile: (pathPtr, outPtr) => {
         return -1;

package/compiler/wrap.js

@@ -1,4 +1,3 @@
-import { encodeVector } from './encoding.js';
 import { importedFuncs, createImport } from './builtins.js';
 import compile from './index.js';
 import disassemble from './disassemble.js';
@@ -15,12 +14,12 @@ const read = (ta, memory, ptr, length) => {
   return new ta(memory.buffer.slice(ptr, ptr + length * ta.BYTES_PER_ELEMENT), 0, length);
 };
 
-export const readByteStr = (memory, ptr) => {
+const readByteStr = (memory, ptr) => {
   const length = read(Uint32Array, memory, ptr, 1)[0];
   return Array.from(read(Uint8Array, memory, ptr + 4, length)).map(x => String.fromCharCode(x)).join('');
 };
 
-export const writeByteStr = (memory, ptr, str) => {
+const writeByteStr = (memory, ptr, str) => {
   const length = str.length;
 
   if (dv?.memory !== memory) dv = new DataView(memory.buffer);
@@ -361,6 +360,15 @@ ${flags & 0b0001 ? `    get func idx: ${get}
 };
 
 export { createImport };
+
+/**
+ * Compile given JavaScript source code. // todo: more docs here (sorry)
+ *
+ * @param {string} source - JavaScript source code to compile
+ * @param {boolean} module - If the source is a module or not (default: false)
+ * @param {object} customImports - Custom imports
+ * @param {(str: string) => void} print - Function to use for printing (used by console.log etc)
+ */
 export default (source, module = undefined, customImports = {}, print = str => process.stdout.write(str)) => {
   createImport('print', 1, 0, i => print(i.toString()));
   createImport('printChar', 1, 0, i => print(String.fromCharCode(i)));

package/jsr.json

@@ -0,0 +1,28 @@
+{
+  "name": "@honk/porffor",
+  "version": "0.58.2",
+  "exports": "./compiler/wrap.js",
+  "publish": {
+    "exclude": [
+      ".github",
+      "bench",
+      "demos",
+      "test262",
+      "envoy",
+
+      "logo.png",
+      "index.html",
+      "CNAME",
+      "publish.js",
+
+      ".repl_history",
+      "*.wasm",
+      "*.csv",
+      "*.txt",
+      "*.exe",
+
+      ".npmignore",
+      ".editorconfig"
+    ]
+  }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "porffor",
   "description": "An ahead-of-time JavaScript compiler",
-  "version": "0.58.0",
+  "version": "0.58.2",
   "author": "Oliver Medhurst <honk@goose.icu>",
   "license": "MIT",
   "scripts": {},

package/runtime/index.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 import fs from 'node:fs';
-globalThis.version = '0.58.0';
+globalThis.version = '0.58.2';
 
 // deno compat
 if (typeof process === 'undefined' && typeof Deno !== 'undefined') {
@@ -27,7 +27,7 @@ if (process.argv.includes('--help') || process.argv.includes('-h')) {
     'Analyze': [],
     profile: [ 93, 'foo.js', 'View detailed func-by-func performance' ],
     debug: [ 33, 'foo.js', 'Debug the source of a file' ],
-    dissect: [ 33, 'foo.js', 'Debug the compiled Wasm of a file' ],
+    // dissect: [ 33, 'foo.js', 'Debug the compiled Wasm of a file' ],
   })) {
     if (color == null) {
       // header
@@ -113,9 +113,9 @@ if (['precompile', 'run', 'wasm', 'native', 'c', 'profile', 'debug', 'dissect'].
     process.argv.push(`--target=${file}`);
   }
 
-  if (file === 'dissect') {
-    process.argv.push('--asur', '--wasm-debug');
-  }
+  // if (file === 'dissect') {
+  //   process.argv.push('--asur', '--wasm-debug');
+  // }
 
   file = process.argv.slice(2).find(x => x[0] !== '-');
 

package/.editorconfig

@@ -1,12 +0,0 @@
-# EditorConfig is awesome: https://EditorConfig.org
-
-# top-most EditorConfig file
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = false

package/asur/README.md

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