Make the DebugParser an interface discoverable via ServiceLoader.

Signed-off-by: Hiram Chirino <hiram@hiramchirino.com>

Author: chirino

build-time-compiler/src/main/java/com/dylibso/chicory/build/time/compiler/Config.java

@@ -1,12 +1,10 @@
 package com.dylibso.chicory.build.time.compiler;
 
 import com.dylibso.chicory.compiler.InterpreterFallback;
-import com.dylibso.chicory.runtime.Stratum;
-import com.dylibso.chicory.wasm.WasmModule;
+import com.dylibso.chicory.runtime.DebugParser;
 import java.nio.file.Path;
 import java.util.Set;
 import java.util.StringJoiner;
-import java.util.function.Function;
 
 public final class Config {
     /**
@@ -47,7 +45,7 @@ public final class Config {
     /**
      * the debug parser to use to extract debug symbols from the wasm module.
      */
-    private Function<WasmModule, Stratum> debugParser;
+    private final DebugParser debugParser;
 
     private Config(
             Path wasmFile,
@@ -57,7 +55,7 @@ private Config(
             Path targetWasmFolder,
             InterpreterFallback interpreterFallback,
             Set<Integer> interpretedFunctions,
-            Function<WasmModule, Stratum> debugParser) {
+            DebugParser debugParser) {
         this.wasmFile = wasmFile;
         this.name = name;
         this.targetClassFolder = targetClassFolder;
@@ -100,7 +98,7 @@ public static Builder builder() {
         return new Builder();
     }
 
-    public Function<WasmModule, Stratum> debugParser() {
+    public DebugParser debugParser() {
         return debugParser;
     }
 
@@ -128,7 +126,7 @@ public static final class Builder {
         private Path targetWasmFolder;
         private InterpreterFallback interpreterFallback = InterpreterFallback.FAIL;
         private Set<Integer> interpretedFunctions;
-        private Function<WasmModule, Stratum> debugParser;
+        private DebugParser debugParser;
 
         private Builder() {}
 
@@ -167,7 +165,7 @@ public Builder withInterpretedFunctions(Set<Integer> interpretedFunctions) {
             return this;
         }
 
-        public Builder withDebugParser(Function<WasmModule, Stratum> debugParser) {
+        public Builder withDebugParser(DebugParser debugParser) {
             this.debugParser = debugParser;
             return this;
         }

compiler-maven-plugin/pom.xml

@@ -26,10 +26,6 @@
       <groupId>com.dylibso.chicory</groupId>
       <artifactId>runtime</artifactId>
     </dependency>
-    <dependency>
-      <groupId>com.dylibso.chicory</groupId>
-      <artifactId>wasm</artifactId>
-    </dependency>
     <dependency>
       <groupId>org.apache.maven</groupId>
       <artifactId>maven-core</artifactId>

compiler-maven-plugin/src/main/java/com/dylibso/chicory/build/time/maven/ChicoryCompilerGenMojo.java

@@ -1,18 +1,14 @@
 package com.dylibso.chicory.build.time.maven;
 
-import static java.lang.invoke.MethodHandleProxies.asInterfaceInstance;
-import static java.lang.invoke.MethodHandles.publicLookup;
-import static java.lang.invoke.MethodType.methodType;
-
 import com.dylibso.chicory.build.time.compiler.Config;
 import com.dylibso.chicory.build.time.compiler.Generator;
 import com.dylibso.chicory.compiler.InterpreterFallback;
-import com.dylibso.chicory.runtime.Stratum;
-import com.dylibso.chicory.wasm.WasmModule;
+import com.dylibso.chicory.runtime.DebugParser;
 import java.io.File;
 import java.io.IOException;
+import java.util.ServiceConfigurationError;
+import java.util.ServiceLoader;
 import java.util.Set;
-import java.util.function.Function;
 import org.apache.maven.model.Resource;
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugin.MojoExecutionException;
@@ -84,14 +80,15 @@ public class ChicoryCompilerGenMojo extends AbstractMojo {
     @Override
     public void execute() throws MojoExecutionException {
 
-        Function<WasmModule, Stratum> debugParser;
-
+        DebugParser debugParser = null;
         // Use the DebugParser if it's on the classpath.
         try {
-            debugParser = createDebugParser("com.dylibso.chicory.dwarf.rust.DebugParser", "parse");
-            getLog().info("Debug parser enabled");
-        } catch (ClassNotFoundException | NoSuchMethodException | IllegalAccessException ignore) {
-            getLog().info("Debug parser disabled");
+            for (var service : ServiceLoader.load(DebugParser.class)) {
+                debugParser = service;
+                getLog().info("Using debug parser: " + debugParser.getClass().getName());
+                break;
+            }
+        } catch (ServiceConfigurationError ignore) {
             debugParser = null;
         }
 
@@ -124,16 +121,4 @@ public void execute() throws MojoExecutionException {
         project.addResource(resource);
         project.addCompileSourceRoot(targetSourceFolder.getPath());
     }
-
-    private Function<WasmModule, Stratum> createDebugParser(String clazzName, String method)
-            throws ClassNotFoundException, NoSuchMethodException, IllegalAccessException {
-        var classLoader = ChicoryCompilerGenMojo.class.getClassLoader();
-        var clazz = classLoader.loadClass(clazzName);
-        var handle =
-                publicLookup()
-                        .findStatic(clazz, method, methodType(Stratum.class, WasmModule.class));
-        @SuppressWarnings("unchecked")
-        Function<WasmModule, Stratum> function = asInterfaceInstance(Function.class, handle);
-        return function;
-    }
 }

compiler/src/main/java/com/dylibso/chicory/compiler/MachineFactoryCompiler.java

@@ -1,9 +1,9 @@
 package com.dylibso.chicory.compiler;
 
 import com.dylibso.chicory.compiler.internal.MachineFactory;
+import com.dylibso.chicory.runtime.DebugParser;
 import com.dylibso.chicory.runtime.Instance;
 import com.dylibso.chicory.runtime.Machine;
-import com.dylibso.chicory.runtime.Stratum;
 import com.dylibso.chicory.wasm.WasmModule;
 import java.util.Set;
 import java.util.function.Function;
@@ -102,7 +102,7 @@ public Builder withInterpretedFunctions(Set<Integer> interpretedFunctions) {
             return this;
         }
 
-        public Builder withDebugParser(Function<WasmModule, Stratum> debugParser) {
+        public Builder withDebugParser(DebugParser debugParser) {
             compilerBuilder.withDebugParser(debugParser);
             return this;
         }

compiler/src/main/java/com/dylibso/chicory/compiler/internal/Compiler.java

@@ -58,6 +58,7 @@
 import static org.objectweb.asm.commons.InstructionAdapter.OBJECT_TYPE;
 
 import com.dylibso.chicory.compiler.InterpreterFallback;
+import com.dylibso.chicory.runtime.DebugParser;
 import com.dylibso.chicory.runtime.Instance;
 import com.dylibso.chicory.runtime.Machine;
 import com.dylibso.chicory.runtime.Memory;
@@ -190,7 +191,7 @@ public static final class Builder {
         private int maxFunctionsPerClass;
         private InterpreterFallback interpreterFallback;
         private Set<Integer> interpretedFunctions;
-        private Function<WasmModule, Stratum> debugParser;
+        private DebugParser debugParser;
 
         private Builder(WasmModule module) {
             this.module = module;
@@ -201,7 +202,7 @@ public Builder withClassName(String className) {
             return this;
         }
 
-        public Builder withDebugParser(Function<WasmModule, Stratum> debugParser) {
+        public Builder withDebugParser(DebugParser debugParser) {
             this.debugParser = debugParser;
             return this;
         }

docs/docs/experimental/dwarf-debug-symbols.md

@@ -111,7 +111,7 @@ Instance instance = Instance.builder(module)
         .build();
 ```
 
-> Note: The `withDebugParser` hook accepts any implementation of `Function<WasmModule, Stratum>`, so you can plug in your own debug symbol parser if desired.
+> Note: The `withDebugParser` hook accepts any implementation of `DebugParser`, so you can plug in your own debug symbol parser if desired.
 
 ### Build Time Compiler
 

dwarf-rust-experimental/pom.xml

@@ -41,12 +41,12 @@
     </dependency>
     <dependency>
       <groupId>com.dylibso.chicory</groupId>
-      <artifactId>wasm-corpus</artifactId>
+      <artifactId>compiler</artifactId>
       <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>com.dylibso.chicory</groupId>
-      <artifactId>compiler</artifactId>
+      <artifactId>wasm-corpus</artifactId>
       <scope>test</scope>
     </dependency>
 

dwarf-rust-experimental/src/main/java/com/dylibso/chicory/dwarf/rust/DebugParser.java

@@ -24,10 +24,15 @@
 import java.util.Map;
 import java.util.Set;
 
-public final class DebugParser {
+public final class DebugParser implements com.dylibso.chicory.runtime.DebugParser {
     private static final Logger logger = new SystemLogger();
     private static final WasmModule MODULE = Wasm.load();
 
+    @Override
+    public Stratum apply(WasmModule wasmModule) {
+        return parse(wasmModule);
+    }
+
     static final class SourceResult {
         public String error;
         public List<SourceUnit> units;
@@ -64,8 +69,6 @@ public FileInfo(String path, SourceFile file) {
         }
     }
 
-    private DebugParser() {}
-
     private static byte[] toBytes(WasmModule module) {
         var writer = new WasmWriter();
         var keepers =

dwarf-rust-experimental/src/main/resources/META-INF/services/com.dylibso.chicory.runtime.DebugParser

@@ -0,0 +1 @@
+com.dylibso.chicory.dwarf.rust.DebugParser

dwarf-rust-experimental/src/test/java/com/dylibso/chicory/dwarf/rust/MachinesTest.java

@@ -1,17 +1,16 @@
 package com.dylibso.chicory.dwarf.rust;
 
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
 import com.dylibso.chicory.compiler.MachineFactoryCompiler;
 import com.dylibso.chicory.runtime.Instance;
 import com.dylibso.chicory.runtime.TrapException;
 import com.dylibso.chicory.wasm.Parser;
 import com.dylibso.chicory.wasm.WasmModule;
-import org.junit.jupiter.api.Test;
-
 import java.io.PrintWriter;
 import java.io.StringWriter;
-
-import static org.junit.jupiter.api.Assertions.assertThrows;
-import static org.junit.jupiter.api.Assertions.assertTrue;
+import org.junit.jupiter.api.Test;
 
 public final class MachinesTest {