add wasm.Module Builders to conveniently run the parser

dylibso · Jul 26, 2024 · ef2ea6f · ef2ea6f
1 parent 3405d0a
commit ef2ea6f
Show file tree

Hide file tree

Showing 8 changed files with 175 additions and 14 deletions.
diff --git a/aot/src/test/java/com/dylibso/chicory/testing/TestModule.java b/aot/src/test/java/com/dylibso/chicory/testing/TestModule.java
@@ -4,8 +4,8 @@
 import com.dylibso.chicory.runtime.HostImports;
 import com.dylibso.chicory.runtime.Instance;
 import com.dylibso.chicory.runtime.Module;
-import com.dylibso.chicory.runtime.ModuleType;
 import com.dylibso.chicory.wabt.Wat2Wasm;
+import com.dylibso.chicory.wasm.ModuleType;
 import com.dylibso.chicory.wasm.exceptions.MalformedException;
 import java.io.File;
 

diff --git a/runtime-tests/src/test/java/com/dylibso/chicory/testing/TestModule.java b/runtime-tests/src/test/java/com/dylibso/chicory/testing/TestModule.java
@@ -3,8 +3,8 @@
 import com.dylibso.chicory.runtime.HostImports;
 import com.dylibso.chicory.runtime.Instance;
 import com.dylibso.chicory.runtime.Module;
-import com.dylibso.chicory.runtime.ModuleType;
 import com.dylibso.chicory.wabt.Wat2Wasm;
+import com.dylibso.chicory.wasm.ModuleType;
 import com.dylibso.chicory.wasm.exceptions.MalformedException;
 import java.io.File;
 

diff --git a/runtime/src/main/java/com/dylibso/chicory/runtime/Module.java b/runtime/src/main/java/com/dylibso/chicory/runtime/Module.java
@@ -1,8 +1,11 @@
 package com.dylibso.chicory.runtime;
 
+import static com.dylibso.chicory.wasm.ModuleType.BINARY;
+
 import com.dylibso.chicory.log.Logger;
 import com.dylibso.chicory.log.SystemLogger;
 import com.dylibso.chicory.runtime.exceptions.WASMRuntimeException;
+import com.dylibso.chicory.wasm.ModuleType;
 import com.dylibso.chicory.wasm.Parser;
 import com.dylibso.chicory.wasm.exceptions.InvalidException;
 import com.dylibso.chicory.wasm.exceptions.MalformedException;

diff --git a/test-gen-plugin/src/main/java/com/dylibso/chicory/maven/JavaTestGen.java b/test-gen-plugin/src/main/java/com/dylibso/chicory/maven/JavaTestGen.java
@@ -99,11 +99,11 @@ public CompilationUnit generate(
         cu.addImport("com.dylibso.chicory.testing.TestModule");
 
         // runtime imports
+        cu.addImport("com.dylibso.chicory.wasm.ModuleType");
         cu.addImport("com.dylibso.chicory.wasm.exceptions.ChicoryException");
         cu.addImport("com.dylibso.chicory.runtime.ExportFunction");
         cu.addImport("com.dylibso.chicory.runtime.Instance");
         cu.addImport("com.dylibso.chicory.runtime.Module");
-        cu.addImport("com.dylibso.chicory.runtime.ModuleType");
 
         // base imports
         cu.addImport("com.dylibso.chicory.wasm.exceptions.InvalidException");

diff --git a/wabt/src/main/java/com/dylibso/chicory/wabt/Wast2Json.java b/wabt/src/main/java/com/dylibso/chicory/wabt/Wast2Json.java
@@ -34,11 +34,10 @@ public boolean isLoggable(Logger.Level level) {
                 }
             };
     private static final com.dylibso.chicory.wasm.Module wasmModule =
-            Module.builder(Wast2Json.class.getResourceAsStream("/wast2json"))
-                    .withInitialize(false)
-                    .withStart(false)
-                    .build()
-                    .wasmModule();
+            com.dylibso.chicory.wasm.Module.builder(
+                            Wast2Json.class.getResourceAsStream("/wast2json"))
+                    .withLogger(logger)
+                    .build();
 
     private final File input;
     private final File output;

diff --git a/wabt/src/main/java/com/dylibso/chicory/wabt/Wat2Wasm.java b/wabt/src/main/java/com/dylibso/chicory/wabt/Wat2Wasm.java
@@ -30,11 +30,9 @@
 public final class Wat2Wasm {
     private static final Logger logger = new SystemLogger();
     private static final com.dylibso.chicory.wasm.Module wasmModule =
-            Module.builder(Wat2Wasm.class.getResourceAsStream("/wat2wasm"))
-                    .withInitialize(false)
-                    .withStart(false)
-                    .build()
-                    .wasmModule();
+            com.dylibso.chicory.wasm.Module.builder(Wat2Wasm.class.getResourceAsStream("/wat2wasm"))
+                    .withLogger(logger)
+                    .build();
 
     private Wat2Wasm() {}
 

diff --git a/wasm/src/main/java/com/dylibso/chicory/wasm/Module.java b/wasm/src/main/java/com/dylibso/chicory/wasm/Module.java
@@ -2,6 +2,10 @@
 
 import static java.util.Objects.requireNonNull;
 
+import com.dylibso.chicory.log.Logger;
+import com.dylibso.chicory.log.SystemLogger;
+import com.dylibso.chicory.wasm.exceptions.ChicoryException;
+import com.dylibso.chicory.wasm.exceptions.InvalidException;
 import com.dylibso.chicory.wasm.types.CodeSection;
 import com.dylibso.chicory.wasm.types.CustomSection;
 import com.dylibso.chicory.wasm.types.DataCountSection;
@@ -16,9 +20,20 @@
 import com.dylibso.chicory.wasm.types.StartSection;
 import com.dylibso.chicory.wasm.types.TableSection;
 import com.dylibso.chicory.wasm.types.TypeSection;
+import java.io.ByteArrayInputStream;
+import java.io.File;
+import java.io.FileInputStream;
+import java.io.FileNotFoundException;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.ByteBuffer;
+import java.nio.file.Files;
+import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+import java.util.Objects;
+import java.util.function.Supplier;
 
 public class Module {
     private final HashMap<String, CustomSection> customSections;
@@ -151,4 +166,150 @@ public ElementSection elementSection() {
     public void setElementSection(ElementSection elementSection) {
         this.elementSection = requireNonNull(elementSection);
     }
+
+    /**
+     * Creates a {@link Builder} for the specified {@link InputStream}
+     *
+     * @param input the input stream
+     * @return a {@link Builder} for reading the module definition from the specified input stream
+     */
+    public static Builder builder(InputStream input) {
+        return new Builder(() -> input);
+    }
+
+    /**
+     * Creates a {@link Builder} for the specified {@link com.dylibso.chicory.wasm.Module}
+     *
+     * @param wasmModule the already parsed Wasm module
+     * @return a {@link Builder} for reading the module definition from the specified input stream
+     */
+    public static Builder builder(com.dylibso.chicory.wasm.Module wasmModule) {
+        return new Builder(wasmModule);
+    }
+
+    /**
+     * Creates a {@link Builder} for the specified {@link ByteBuffer}
+     *
+     * @param buffer the buffer
+     * @return a {@link Builder} for reading the module definition from the specified buffer
+     */
+    public static Builder builder(ByteBuffer buffer) {
+        return builder(buffer.array());
+    }
+
+    /**
+     * Creates a {@link Builder} for the specified byte array
+     *
+     * @param buffer the buffer
+     * @return a {@link Builder} for reading the module definition from the specified buffer
+     */
+    public static Builder builder(byte[] buffer) {
+        return new Builder(() -> new ByteArrayInputStream(buffer));
+    }
+
+    /**
+     * Creates a {@link Builder} for the specified {@link File} resource
+     *
+     * @param file the path of the resource
+     * @return a {@link Builder} for reading the module definition from the specified file
+     */
+    public static Builder builder(File file) {
+        return new Builder(
+                () -> {
+                    try {
+                        return new FileInputStream(file);
+                    } catch (FileNotFoundException e) {
+                        throw new IllegalArgumentException(
+                                "File not found at path: " + file.getPath(), e);
+                    }
+                });
+    }
+
+    /**
+     * Creates a {@link Builder} for the specified classpath resource
+     *
+     * @param classpathResource the name of the resource
+     * @return a {@link Builder}  for reading the module definition from the specified resource
+     */
+    public static Builder builder(String classpathResource) {
+        return new Builder(
+                () -> {
+                    InputStream is =
+                            Thread.currentThread()
+                                    .getContextClassLoader()
+                                    .getResourceAsStream(classpathResource);
+                    if (is == null) {
+                        throw new IllegalArgumentException(
+                                "Resource not found at classpath: " + classpathResource);
+                    }
+                    return is;
+                });
+    }
+
+    /**
+     * Creates a {@link Builder} for the specified {@link Path} resource
+     *
+     * @param path the path of the resource
+     * @return a {@link Builder} for reading the module definition from the specified path
+     */
+    public static Builder builder(Path path) {
+        return new Builder(
+                () -> {
+                    try {
+                        return Files.newInputStream(path);
+                    } catch (IOException e) {
+                        throw new IllegalArgumentException("Error opening file: " + path, e);
+                    }
+                });
+    }
+
+    public static class Builder {
+        private final Module parsed;
+        private final Supplier<InputStream> inputStreamSupplier;
+        private Logger logger;
+        private ModuleType moduleType = ModuleType.BINARY;
+
+        private Builder(Supplier<InputStream> inputStreamSupplier) {
+            this.inputStreamSupplier = Objects.requireNonNull(inputStreamSupplier);
+            this.parsed = null;
+        }
+
+        private Builder(Module parsed) {
+            this.parsed = Objects.requireNonNull(parsed);
+            this.inputStreamSupplier = null;
+        }
+
+        public Builder withLogger(Logger logger) {
+            this.logger = logger;
+            return this;
+        }
+
+        public Builder withType(ModuleType type) {
+            this.moduleType = type;
+            return this;
+        }
+
+        public Module build() {
+            final Logger logger = this.logger != null ? this.logger : new SystemLogger();
+            final Parser parser = new Parser(logger);
+
+            Module parsed = this.parsed;
+            if (parsed == null) {
+                try (final InputStream is = inputStreamSupplier.get()) {
+                    parsed = parser.parseModule(is);
+                } catch (IOException e) {
+                    throw new ChicoryException(e);
+                }
+            }
+
+            switch (this.moduleType) {
+                case BINARY:
+                    return parsed;
+                default:
+                    throw new InvalidException(
+                            "Text format parsing is not implemented, but you can use wat2wasm"
+                                    + " through Chicory.");
+            }
+        }
+    }
 }
diff --git a/...m/dylibso/chicory/runtime/ModuleType.java → .../com/dylibso/chicory/wasm/ModuleType.java b/...m/dylibso/chicory/runtime/ModuleType.java → .../com/dylibso/chicory/wasm/ModuleType.java
@@ -1,4 +1,4 @@
-package com.dylibso.chicory.runtime;
+package com.dylibso.chicory.wasm;
 
 public enum ModuleType {
     TEXT,