Rework memory options (AssemblyScript#1268)

Author: dcodeIO

cli/asc.d.ts

@@ -97,8 +97,14 @@ interface CompilerOptions {
   noEmit?: boolean;
   /** Imports the memory provided as 'env.memory'. */
   importMemory?: boolean;
-  /** Declare memory as shared by settings the max shared memory. */
-  sharedMemory?: number;
+  /** Does not export the memory as 'memory'. */
+  noExportMemory?: boolean;
+  /** Sets the initial memory size in pages. */
+  initialMemory?: number;
+  /** Sets the maximum memory size in pages. */
+  maximumMemory?: number;
+  /** Declare memory as shared. Requires maximumMemory. */
+  sharedMemory?: boolean;
   /** Sets the start offset of compiler-generated static memory. */
   memoryBase?: number;
   /** Imports the function table provided as 'env.table'. */

cli/asc.js

@@ -272,7 +272,10 @@ exports.main = function main(argv, options, callback) {
   const compilerOptions = assemblyscript.newOptions();
   assemblyscript.setTarget(compilerOptions, 0);
   assemblyscript.setNoAssert(compilerOptions, args.noAssert);
+  assemblyscript.setExportMemory(compilerOptions, !args.noExportMemory);
   assemblyscript.setImportMemory(compilerOptions, args.importMemory);
+  assemblyscript.setInitialMemory(compilerOptions, args.initialMemory >>> 0);
+  assemblyscript.setMaximumMemory(compilerOptions, args.maximumMemory >>> 0);
   assemblyscript.setSharedMemory(compilerOptions, args.sharedMemory);
   assemblyscript.setImportTable(compilerOptions, args.importTable);
   assemblyscript.setExportTable(compilerOptions, args.exportTable);

cli/asc.json

@@ -128,12 +128,30 @@
     "type": "b",
     "default": false
   },
-  "sharedMemory": {
+  "noExportMemory": {
+    "category": "Features",
+    "description": "Does not export the memory as 'memory'.",
+    "type": "b",
+    "default": false
+  },
+  "initialMemory": {
+    "category": "Features",
+    "description": "Sets the initial memory size in pages.",
+    "type": "i",
+    "default": 0
+  },
+  "maximumMemory": {
     "category": "Features",
-    "description": "Declare memory as shared by settings the max shared memory.",
+    "description": "Sets the maximum memory size in pages.",
     "type": "i",
     "default": 0
   },
+  "sharedMemory": {
+    "category": "Features",
+    "description": "Declare memory as shared. Requires maximumMemory.",
+    "type": "b",
+    "default": false
+  },
   "importTable": {
     "category": "Features",
     "description": "Imports the function table provided as 'env.table'.",

src/compiler.ts

@@ -202,10 +202,16 @@ export class Options {
   target: Target = Target.WASM32;
   /** If true, replaces assertions with nops. */
   noAssert: bool = false;
+  /** It true, exports the memory to the embedder. */
+  exportMemory: bool = true;
   /** If true, imports the memory provided by the embedder. */
   importMemory: bool = false;
-  /** If greater than zero, declare memory as shared by setting max memory to sharedMemory. */
-  sharedMemory: i32 = 0;
+  /** Initial memory size, in pages. */
+  initialMemory: u32 = 0;
+  /** Maximum memory size, in pages. */
+  maximumMemory: u32 = 0;
+  /** If true, memory is declared as shared. */
+  sharedMemory: bool = false;
   /** If true, imports the function table provided by the embedder. */
   importTable: bool = false;
   /** If true, exports the function table. */
@@ -215,9 +221,9 @@ export class Options {
   /** If true, generates an explicit start function. */
   explicitStart: bool = false;
   /** Static memory start offset. */
-  memoryBase: i32 = 0;
+  memoryBase: u32 = 0;
   /** Static table start offset. */
-  tableBase: i32 = 0;
+  tableBase: u32 = 0;
   /** Global aliases, mapping alias names as the key to internal names to be aliased as the value. */
   globalAliases: Map<string,string> | null = null;
   /** Features to activate by default. These are the finished proposals. */
@@ -227,7 +233,7 @@ export class Options {
   /** If true, enables pedantic diagnostics. */
   pedantic: bool = false;
   /** Indicates a very low (<64k) memory limit. */
-  lowMemoryLimit: i32 = 0;
+  lowMemoryLimit: u32 = 0;
 
   /** Hinted optimize level. Not applied by the compiler itself. */
   optimizeLevelHint: i32 = 0;
@@ -554,15 +560,57 @@ export class Compiler extends DiagnosticEmitter {
     }
 
     // set up memory
-    var isSharedMemory = options.hasFeature(Feature.THREADS) && options.sharedMemory > 0;
+    var initialPages: u32 = 0;
+    if (this.options.memoryBase /* is specified */ || this.memorySegments.length) {
+      initialPages = u32(i64_low(i64_shr_u(i64_align(memoryOffset, 0x10000), i64_new(16))));
+    }
+    if (options.initialMemory) {
+      if (options.initialMemory < initialPages) {
+        this.error(
+          DiagnosticCode.Module_requires_at_least_0_pages_of_initial_memory,
+          null,
+          initialPages.toString()
+        );
+      } else {
+        initialPages = options.initialMemory;
+      }
+    }
+    var maximumPages = Module.UNLIMITED_MEMORY;
+    if (options.maximumMemory) {
+      if (options.maximumMemory < initialPages) {
+        this.error(
+          DiagnosticCode.Module_requires_at_least_0_pages_of_maximum_memory,
+          null,
+          initialPages.toString()
+        );
+      } else {
+        maximumPages = options.maximumMemory;
+      }
+    }
+    var isSharedMemory = false;
+    if (options.sharedMemory) {
+      isSharedMemory = true;
+      if (!options.maximumMemory) {
+        this.error(
+          DiagnosticCode.Shared_memory_requires_maximum_memory_to_be_defined,
+          null
+        );
+        isSharedMemory = false;
+      }
+      if (!options.hasFeature(Feature.THREADS)) {
+        this.error(
+          DiagnosticCode.Shared_memory_requires_feature_threads_to_be_enabled,
+          null
+        );
+        isSharedMemory = false;
+      }
+    }
     module.setMemory(
-      this.options.memoryBase /* is specified */ || this.memorySegments.length
-        ? i64_low(i64_shr_u(i64_align(memoryOffset, 0x10000), i64_new(16)))
-        : 0,
-      isSharedMemory ? options.sharedMemory : Module.UNLIMITED_MEMORY,
+      initialPages,
+      maximumPages,
       this.memorySegments,
       options.target,
-      ExportNames.memory,
+      options.exportMemory ? ExportNames.memory : null,
       isSharedMemory
     );
 

src/diagnosticMessages.generated.ts

@@ -11,8 +11,11 @@ export enum DiagnosticCode {
   Operation_is_unsafe = 101,
   User_defined_0 = 102,
   Feature_0_is_not_enabled = 103,
-  Function_0_is_possibly_called_virtually_which_is_not_yet_supported = 104,
-  Low_memory_limit_exceeded_by_static_data_0_1 = 105,
+  Low_memory_limit_exceeded_by_static_data_0_1 = 104,
+  Module_requires_at_least_0_pages_of_initial_memory = 105,
+  Module_requires_at_least_0_pages_of_maximum_memory = 106,
+  Shared_memory_requires_maximum_memory_to_be_defined = 107,
+  Shared_memory_requires_feature_threads_to_be_enabled = 108,
   Conversion_from_type_0_to_1_requires_an_explicit_cast = 200,
   Conversion_from_type_0_to_1_will_require_an_explicit_cast_when_switching_between_32_64_bit = 201,
   Type_0_cannot_be_changed_to_type_1 = 202,
@@ -181,8 +184,11 @@ export function diagnosticCodeToString(code: DiagnosticCode): string {
     case 101: return "Operation is unsafe.";
     case 102: return "User-defined: {0}";
     case 103: return "Feature '{0}' is not enabled.";
-    case 104: return "Function '{0}' is possibly called virtually, which is not yet supported.";
-    case 105: return "Low memory limit exceeded by static data: {0} > {1}";
+    case 104: return "Low memory limit exceeded by static data: {0} > {1}";
+    case 105: return "Module requires at least '{0}' pages of initial memory.";
+    case 106: return "Module requires at least '{0}' pages of maximum memory.";
+    case 107: return "Shared memory requires maximum memory to be defined.";
+    case 108: return "Shared memory requires feature 'threads' to be enabled.";
     case 200: return "Conversion from type '{0}' to '{1}' requires an explicit cast.";
     case 201: return "Conversion from type '{0}' to '{1}' will require an explicit cast when switching between 32/64-bit.";
     case 202: return "Type '{0}' cannot be changed to type '{1}'.";

src/diagnosticMessages.json

@@ -3,8 +3,11 @@
   "Operation is unsafe.": 101,
   "User-defined: {0}": 102,
   "Feature '{0}' is not enabled.": 103,
-  "Function '{0}' is possibly called virtually, which is not yet supported.": 104,
-  "Low memory limit exceeded by static data: {0} > {1}": 105,
+  "Low memory limit exceeded by static data: {0} > {1}": 104,
+  "Module requires at least '{0}' pages of initial memory.": 105,
+  "Module requires at least '{0}' pages of maximum memory.": 106,
+  "Shared memory requires maximum memory to be defined.": 107,
+  "Shared memory requires feature 'threads' to be enabled.": 108,
 
   "Conversion from type '{0}' to '{1}' requires an explicit cast.": 200,
   "Conversion from type '{0}' to '{1}' will require an explicit cast when switching between 32/64-bit.": 201,

src/index.ts

@@ -57,13 +57,28 @@ export function setNoAssert(options: Options, noAssert: bool): void {
   options.noAssert = noAssert;
 }
 
+/** Sets the `exportMemory` option. */
+export function setExportMemory(options: Options, exportMemory: bool): void {
+  options.exportMemory = exportMemory;
+}
+
 /** Sets the `importMemory` option. */
 export function setImportMemory(options: Options, importMemory: bool): void {
   options.importMemory = importMemory;
 }
 
+/** Sets the `initialMemory` option. */
+export function setInitialMemory(options: Options, initialMemory: u32): void {
+  options.initialMemory = initialMemory;
+}
+
+/** Sets the `maximumMemory` option. */
+export function setMaximumMemory(options: Options, maximumMemory: u32): void {
+  options.maximumMemory = maximumMemory;
+}
+
 /** Sets the `sharedMemory` option. */
-export function setSharedMemory(options: Options, sharedMemory: i32): void {
+export function setSharedMemory(options: Options, sharedMemory: bool): void {
   options.sharedMemory = sharedMemory;
 }
 

tests/compiler.js

@@ -165,12 +165,10 @@ function runTest(basename) {
       const stderrString = stderr.toString();
       if (typeof expectStderr === "string") expectStderr = [ expectStderr ];
       let lastIndex = 0;
-      let failed = false;
       expectStderr.forEach((substr, i) => {
         var index = stderrString.indexOf(substr, lastIndex);
         if (index < 0) {
           console.log("Missing pattern #" + (i + 1) + " '" + substr + "' in stderr at " + lastIndex + "+.");
-          failedTests.add(basename);
           failed = true;
         } else {
           lastIndex = index + substr.length;

tests/compiler/features/threads.json

@@ -5,6 +5,7 @@
   "asc_flags": [
     "--runtime none",
     "--memoryBase 8",
-    "--sharedMemory 1"
+    "--maximumMemory 10",
+    "--sharedMemory"
   ]
 }

tests/compiler/features/threads.optimized.wat

@@ -1,6 +1,6 @@
 (module
  (type $none_=>_none (func))
- (memory $0 (shared 1 1))
+ (memory $0 (shared 1 10))
  (export "memory" (memory $0))
  (start $~start)
  (func $features/threads/testAtomic

tests/compiler/features/threads.untouched.wat

@@ -1,6 +1,6 @@
 (module
  (type $none_=>_none (func))
- (memory $0 (shared 1 1))
+ (memory $0 (shared 1 10))
  (table $0 1 funcref)
  (global $~lib/ASC_FEATURE_THREADS i32 (i32.const 1))
  (export "memory" (memory $0))

tests/compiler/memory-config-errors.json

@@ -0,0 +1,10 @@
+{
+  "asc_flags": [
+    "--initialMemory 2",
+    "--maximumMemory 1"
+  ],
+  "stderr": [
+    "AS105: Module requires at least '3' pages of initial memory.",
+    "AS106: Module requires at least '3' pages of maximum memory."
+  ]
+}

tests/compiler/memory-config-errors.ts

@@ -0,0 +1 @@
+memory.data((2 << 16) + 1);

tests/compiler/memory-config-shared-errors.json

@@ -0,0 +1,9 @@
+{
+  "asc_flags": [
+    "--sharedMemory"
+  ],
+  "stderr": [
+    "AS107: Shared memory requires maximum memory to be defined.",
+    "AS108: Shared memory requires feature 'threads' to be enabled."
+  ]
+}