Implement reference counting (#592)

Author: dcodeIO

.travis.yml

@@ -3,19 +3,15 @@ notifications:
   email: false
 before_install: npm config set progress=false && npm i -g npm@latest --no-audit
 install: npm ci --no-audit
-cache:
-  directories:
-  - node_modules
 jobs:
   include:
   - node_js: lts/*
     script:
-    - if [ "$TRAVIS_PULL_REQUEST" != "false" ]; then ./scripts/check-pr.sh; fi
+    - if [ "$TRAVIS_PULL_REQUEST" != "false" ] && [ "$TRAVIS_PULL_REQUEST_BRANCH" != "dev" ]; then ./scripts/check-pr.sh; fi
     - npm run all
     - if [ "$TRAVIS_PULL_REQUEST" == "false" ]; then
-        cd $TRAVIS_BUILD_DIR/tests/allocators/arena && npm run build && cd .. && npm test arena &&
-        cd $TRAVIS_BUILD_DIR/tests/allocators/buddy && npm run build && cd .. && npm test buddy &&
-        cd $TRAVIS_BUILD_DIR/tests/allocators/tlsf  && npm run build && cd .. && npm test tlsf;
+        cd $TRAVIS_BUILD_DIR/tests/allocators/rt-full && npm run build && cd .. && npm test rt-full &&
+        cd $TRAVIS_BUILD_DIR/tests/allocators/rt-stub && npm run build && cd .. && npm test rt-stub;
       fi
     env: Runs the tests on node.js LTS, also tests allocators
   - node_js: node
@@ -24,7 +20,7 @@ jobs:
     env: Runs the tests on node.js stable
   - node_js: node
     script:
-    - npm run clean && npm run test:compiler
+    - npm run clean && npm run test:compiler rt/flags threads
     env:
     - Runs experimental tests on node.js v8-canary using
     - ASC_FEATURES="simd,threads"

README.md

@@ -3,9 +3,9 @@
 
 [![Build Status](https://travis-ci.org/AssemblyScript/assemblyscript.svg?branch=master)](https://travis-ci.org/AssemblyScript/assemblyscript)
 
-**AssemblyScript** compiles strictly typed [TypeScript](http://www.typescriptlang.org) (basically JavaScript with types) to [WebAssembly](http://webassembly.org) using [Binaryen](https://github.com/WebAssembly/binaryen). It generates lean and mean WebAssembly modules while being just an `npm install` away.
+**AssemblyScript** compiles a strict subset of [TypeScript](http://www.typescriptlang.org) (basically JavaScript with types) to [WebAssembly](http://webassembly.org) using [Binaryen](https://github.com/WebAssembly/binaryen). It generates lean and mean WebAssembly modules while being just an `npm install` away.
 
-Try it out in [WebAssembly Studio](https://webassembly.studio)!
+Check out the [documentation](https://docs.assemblyscript.org) or try it out in [WebAssembly Studio](https://webassembly.studio)!
 
 ---
 
@@ -43,60 +43,20 @@ Motivation
 
 > I do think [compiling TypeScript into WASM] is tremendously useful. It allows JavaScript developers to create WASM modules without having to learn C. – Colin Eberhardt, [Exploring different approaches to building WebAssembly modules](http://blog.scottlogic.com/2017/10/17/wasm-mandelbrot.html) (Oct 17, 2017)
 
-Getting started
----------------
+Instructions
+------------
 
-All the details are provided in the [AssemblyScript wiki](https://github.com/AssemblyScript/assemblyscript/wiki) - make sure to pay it a visit. With that being said, the easiest way to get started with AssemblyScript is to point npm at the GitHub repository (for now)
-
-```
-$> npm install --save-dev AssemblyScript/assemblyscript
-```
-
-followed by [scaffolding](https://github.com/AssemblyScript/assemblyscript/wiki/Using-the-CLI#scaffolding-with-asinit) a new project including the necessary configuration files, for example in the current directory:
-
-```
-$> npx asinit .
-```
-
-Once the project is set up, it's just a matter of using your existing [TypeScript tooling](https://code.visualstudio.com) while coding, and [using the CLI](https://github.com/AssemblyScript/assemblyscript/wiki/Using-the-CLI) to build to WebAssembly, either manually, or using (and maybe modifying) the generated build task in the generated `package.json`:
-
-```
-$> npm run asbuild
-```
-
-The CLI API can also [be used programmatically](./cli).
-
-If you rather prefer an installation suitable for development, pretty much the same can be achieved by cloning the GitHub repository instead:
+For general usage instructions, please refer to the [documentation](https://docs.assemblyscript.org) instead. The following sets up a *development environment* of the compiler, for example if you plan to make a pull request:
 
 ```
 $> git clone https://github.com/AssemblyScript/assemblyscript.git
 $> cd assemblyscript
 $> npm install
 $> npm link
+$> npm clean
 ```
 
-**Note** that a fresh clone of the compiler will use the distribution files in `dist/`, but it can also run [the sources](./src) directly through ts-node after an `npm run clean`, which is useful in development. This condition can also be checked by running `asc -v` (it is running the sources if it states `-dev`).
-
-Examples
---------
-
-* **[Conway's Game of Life](./examples/game-of-life)** [ [demo](https://assemblyscript.github.io/assemblyscript/examples/game-of-life) | [fiddle](https://webassembly.studio/?f=gvuw4enb3qk) ]<br />
-  Continuously updates the cellular automaton and visualizes its state on a canvas.
-
-* **[Mandelbrot Set](./examples/mandelbrot)** [ [demo](https://assemblyscript.github.io/assemblyscript/examples/mandelbrot) | [fiddle](https://webassembly.studio/?f=m6hbiw9wyq) ]<br />
-  Renders the Mandelbrot set to a canvas.
-
-* **[i64 polyfill](./examples/i64-polyfill)**<br />
-  Exposes WebAssembly's i64 operations to JavaScript using 32-bit integers (low and high bits).
-
-* **[PSON decoder](./examples/pson)**<br />
-  A simple decoder for the PSON binary format.
-
-* **[WASM parser](./lib/parse)**<br />
-  A WebAssembly binary parser in WebAssembly.
-
-* **[N-body system](./examples/n-body)** [ [demo](https://assemblyscript.github.io/assemblyscript/examples/n-body) ]<br />
-  An implementation of the N-body system from the [Computer Language Benchmarks Game](https://benchmarksgame-team.pages.debian.net/benchmarksgame/).
+Note that a fresh clone of the compiler will use the distribution files in `dist/`, but after an `npm clean` it will run [the sources](./src) directly through ts-node, which is useful in development. This condition can also be checked by running `asc -v` (it is running the sources if it states `-dev`). Also please see our [contribution guidelines](./CONTRIBUTING.md) before making your first pull request.
 
 Building
 --------

cli/asc.js

@@ -22,6 +22,8 @@ const optionsUtil = require("./util/options");
 const mkdirp = require("./util/mkdirp");
 const EOL = process.platform === "win32" ? "\r\n" : "\n";
 
+// global.Binaryen = require("../lib/binaryen");
+
 // Emscripten adds an `uncaughtException` listener to Binaryen that results in an additional
 // useless code fragment on top of an actual error. suppress this:
 if (process.removeAllListeners) process.removeAllListeners("uncaughtException");
@@ -68,7 +70,7 @@ exports.sourceMapRoot = "assemblyscript:///";
 exports.libraryPrefix = assemblyscript.LIBRARY_PREFIX;
 
 /** Default Binaryen optimization level. */
-exports.defaultOptimizeLevel = 2;
+exports.defaultOptimizeLevel = 3;
 
 /** Default Binaryen shrink level. */
 exports.defaultShrinkLevel = 1;
@@ -228,30 +230,18 @@ exports.main = function main(argv, options, callback) {
   var parser = null;
 
   // Include library files
-  if (!args.noLib) {
-    Object.keys(exports.libraryFiles).forEach(libPath => {
-      if (libPath.indexOf("/") >= 0) return; // in sub-directory: imported on demand
-      stats.parseCount++;
-      stats.parseTime += measure(() => {
-        parser = assemblyscript.parseFile(
-          exports.libraryFiles[libPath],
-          exports.libraryPrefix + libPath + ".ts",
-          false,
-          parser
-        );
-      });
-    });
-  } else { // always include builtins
+  Object.keys(exports.libraryFiles).forEach(libPath => {
+    if (libPath.indexOf("/") >= 0) return; // in sub-directory: imported on demand
     stats.parseCount++;
     stats.parseTime += measure(() => {
       parser = assemblyscript.parseFile(
-        exports.libraryFiles["builtins"],
-        exports.libraryPrefix + "builtins.ts",
+        exports.libraryFiles[libPath],
+        exports.libraryPrefix + libPath + ".ts",
         false,
         parser
       );
     });
-  }
+  });
   const customLibDirs = [];
   if (args.lib) {
     let lib = args.lib;
@@ -287,6 +277,7 @@ exports.main = function main(argv, options, callback) {
   function parseBacklog() {
     var sourcePath, sourceText;
     while ((sourcePath = parser.nextFile()) != null) {
+      sourceText = null;
 
       // Load library file if explicitly requested
       if (sourcePath.startsWith(exports.libraryPrefix)) {
@@ -335,12 +326,12 @@ exports.main = function main(argv, options, callback) {
             } else {
               for (let i = 0, k = customLibDirs.length; i < k; ++i) {
                 const dir = customLibDirs[i];
-                sourceText = readFile(plainName + ".ts", customLibDirs[i]);
+                sourceText = readFile(plainName + ".ts", dir);
                 if (sourceText !== null) {
                   sourcePath = exports.libraryPrefix + plainName + ".ts";
                   break;
                 } else {
-                  sourceText = readFile(indexName + ".ts", customLibDirs[i]);
+                  sourceText = readFile(indexName + ".ts", dir);
                   if (sourceText !== null) {
                     sourcePath = exports.libraryPrefix + indexName + ".ts";
                     break;
@@ -364,6 +355,26 @@ exports.main = function main(argv, options, callback) {
     }
   }
 
+  // Include runtime template before entry files so its setup runs first
+  {
+    let runtimeName = String(args.runtime);
+    let runtimePath = "rt/index-" + runtimeName;
+    let runtimeText = exports.libraryFiles[runtimePath];
+    if (runtimeText == null) {
+      runtimePath = runtimeName;
+      runtimeText = readFile(runtimePath + ".ts", baseDir);
+      if (runtimeText == null) {
+        return callback(Error("Runtime '" + runtimeName + "' not found."));
+      }
+    } else {
+      runtimePath = "~lib/" + runtimePath;
+    }
+    stats.parseCount++;
+    stats.parseTime += measure(() => {
+      parser = assemblyscript.parseFile(runtimeText, runtimePath, true, parser);
+    });
+  }
+
   // Include entry files
   for (let i = 0, k = argv.length; i < k; ++i) {
     const filename = argv[i];
@@ -387,11 +398,18 @@ exports.main = function main(argv, options, callback) {
     stats.parseTime += measure(() => {
       parser = assemblyscript.parseFile(sourceText, sourcePath, true, parser);
     });
+  }
+
+  // Parse entry files
+  {
     let code = parseBacklog();
     if (code) return code;
   }
 
+  // Call afterParse transform hook
   applyTransform("afterParse", parser);
+
+  // Parse additional files, if any
   {
     let code = parseBacklog();
     if (code) return code;
@@ -423,17 +441,16 @@ exports.main = function main(argv, options, callback) {
   assemblyscript.setImportMemory(compilerOptions, args.importMemory);
   assemblyscript.setSharedMemory(compilerOptions, args.sharedMemory);
   assemblyscript.setImportTable(compilerOptions, args.importTable);
+  assemblyscript.setExplicitStart(compilerOptions, args.explicitStart);
   assemblyscript.setMemoryBase(compilerOptions, args.memoryBase >>> 0);
   assemblyscript.setSourceMap(compilerOptions, args.sourceMap != null);
   assemblyscript.setOptimizeLevelHints(compilerOptions, optimizeLevel, shrinkLevel);
 
-  if (!args.noLib) {
-    // Initialize default aliases
-    assemblyscript.setGlobalAlias(compilerOptions, "Math", "NativeMath");
-    assemblyscript.setGlobalAlias(compilerOptions, "Mathf", "NativeMathf");
-    assemblyscript.setGlobalAlias(compilerOptions, "abort", "~lib/env/abort");
-    assemblyscript.setGlobalAlias(compilerOptions, "trace", "~lib/env/trace");
-  }
+  // Initialize default aliases
+  assemblyscript.setGlobalAlias(compilerOptions, "Math", "NativeMath");
+  assemblyscript.setGlobalAlias(compilerOptions, "Mathf", "NativeMathf");
+  assemblyscript.setGlobalAlias(compilerOptions, "abort", "~lib/builtins/abort");
+  assemblyscript.setGlobalAlias(compilerOptions, "trace", "~lib/builtins/trace");
 
   // Add or override aliases if specified
   if (args.use) {
@@ -463,15 +480,13 @@ exports.main = function main(argv, options, callback) {
 
   var module;
   stats.compileCount++;
-  (() => {
-    try {
-      stats.compileTime += measure(() => {
-        module = assemblyscript.compileProgram(program, compilerOptions);
-      });
-    } catch (e) {
-      return callback(e);
-    }
-  })();
+  try {
+    stats.compileTime += measure(() => {
+      module = assemblyscript.compileProgram(program, compilerOptions);
+    });
+  } catch (e) {
+    return callback(e);
+  }
   if (checkDiagnostics(parser, stderr)) {
     if (module) module.dispose();
     return callback(Error("Compile error"));
@@ -697,6 +712,9 @@ exports.main = function main(argv, options, callback) {
   if (args.measure) {
     printStats(stats, stderr);
   }
+  if (args.printrtti) {
+    printRTTI(program, stderr);
+  }
   return callback(null);
 
   function readFileNode(filename, baseDir) {
@@ -833,6 +851,15 @@ function printStats(stats, output) {
 
 exports.printStats = printStats;
 
+/** Prints runtime type information. */
+function printRTTI(program, output) {
+  if (!output) output = process.stderr;
+  output.write("# Runtime type information (RTTI)\n");
+  output.write(assemblyscript.buildRTTI(program));
+}
+
+exports.printRTTI = printRTTI;
+
 var allocBuffer = typeof global !== "undefined" && global.Buffer
   ? global.Buffer.allocUnsafe || function(len) { return new global.Buffer(len); }
   : function(len) { return new Uint8Array(len) };

cli/asc.json

@@ -13,7 +13,7 @@
     "description": [
       "Optimizes the module. Also has the usual shorthands:",
       "",
-      " -O     Uses defaults. Equivalent to -O2s",
+      " -O     Uses defaults. Equivalent to -O3s",
       " -O0    Equivalent to --optimizeLevel 0",
       " -O1    Equivalent to --optimizeLevel 1",
       " -O2    Equivalent to --optimizeLevel 2",
@@ -81,6 +81,19 @@
     ],
     "type": "s"
   },
+  "runtime": {
+    "description": [
+      "Specifies the runtime implementation to include in the program.",
+      "",
+      " full  Default runtime based on TLSF and reference counting.",
+      " half  Same as 'full', but not exported to the host.",
+      " stub  Minimal stub implementation without free/GC support.",
+      " none  Same as 'stub', but not exported to the host.",
+      ""
+    ],
+    "type": "s",
+    "default": "full"
+  },
   "debug": {
     "description": "Enables debug information in emitted binaries.",
     "type": "b",
@@ -116,8 +129,8 @@
     "type": "b",
     "default": false
   },
-  "noLib": {
-    "description": "Does not include the shipped standard library.",
+  "explicitStart": {
+    "description": "Exports an explicit start function to be called manually.",
     "type": "b",
     "default": false
   },
@@ -177,6 +190,11 @@
     "type": "b",
     "default": false
   },
+  "printrtti": {
+    "description": "Prints the module's runtime type information to stderr.",
+    "type": "b",
+    "default": false
+  },
   "noColors": {
     "description": "Disables terminal colors.",
     "type": "b",