Merge pull request #40392 from Sanne/ClassLoaderImprovements

Classloader improvements: introducing quarkus-classloader-commons and benchmarking infrastructure
quarkusio · May 3, 2024 · 096f6a2 · 096f6a2
2 parents 8832fa8 + ce4471f
commit 096f6a2
Show file tree

Hide file tree

Showing 46 changed files with 369 additions and 42 deletions.
diff --git a/core/deployment/pom.xml b/core/deployment/pom.xml
@@ -14,6 +14,10 @@
     <name>Quarkus - Core - Deployment</name>
 
     <dependencies>
+        <dependency>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-classloader-commons</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.aesh</groupId>
             <artifactId>readline</artifactId>

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/CodeGenerator.java b/core/deployment/src/main/java/io/quarkus/deployment/CodeGenerator.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.BufferedWriter;
 import java.io.IOException;
 import java.io.UncheckedIOException;
@@ -381,7 +383,7 @@ private static Map<String, List<String>> getUnavailableConfigServices(ResolvedDe
                                 .map(String::trim)
                                 // skip comments and empty lines
                                 .filter(line -> !line.startsWith("#") && !line.isEmpty())
-                                .filter(className -> classLoader.getResource(className.replace('.', '/') + ".class") == null)
+                                .filter(className -> classLoader.getResource(fromClassNameToResourceName(className)) == null)
                                 .forEach(unavailableList::add);
                     } catch (IOException e) {
                         throw new UncheckedIOException("Failed to read " + serviceFile, e);

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/GeneratedClassGizmoAdaptor.java b/core/deployment/src/main/java/io/quarkus/deployment/GeneratedClassGizmoAdaptor.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.StringWriter;
 import java.io.Writer;
 import java.util.List;
@@ -77,7 +79,7 @@ public static boolean isApplicationClass(String className) {
                 .getContextClassLoader();
         //if the class file is present in this (and not the parent) CL then it is an application class
         List<ClassPathElement> res = cl
-                .getElementsWithResource(className.replace('.', '/') + ".class", true);
+                .getElementsWithResource(fromClassNameToResourceName(className), true);
         return !res.isEmpty();
     }
 

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/dev/IsolatedDevModeMain.java b/core/deployment/src/main/java/io/quarkus/deployment/dev/IsolatedDevModeMain.java
@@ -36,6 +36,7 @@
 import io.quarkus.builder.BuildChainBuilder;
 import io.quarkus.builder.BuildContext;
 import io.quarkus.builder.BuildStep;
+import io.quarkus.commons.classloading.ClassloadHelper;
 import io.quarkus.deployment.builditem.ApplicationClassPredicateBuildItem;
 import io.quarkus.deployment.console.ConsoleCommand;
 import io.quarkus.deployment.console.ConsoleStateManager;
@@ -408,9 +409,10 @@ public void execute(BuildContext context) {
                                         public boolean test(String s) {
                                             QuarkusClassLoader cl = (QuarkusClassLoader) Thread.currentThread()
                                                     .getContextClassLoader();
+                                            String resourceName = ClassloadHelper.fromClassNameToResourceName(s);
                                             //if the class file is present in this (and not the parent) CL then it is an application class
                                             List<ClassPathElement> res = cl
-                                                    .getElementsWithResource(s.replace('.', '/') + ".class", true);
+                                                    .getElementsWithResource(resourceName, true);
                                             return !res.isEmpty();
                                         }
                                     }));

diff --git a/.../deployment/src/main/java/io/quarkus/deployment/dev/filesystem/ReloadableFileManager.java b/.../deployment/src/main/java/io/quarkus/deployment/dev/filesystem/ReloadableFileManager.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment.dev.filesystem;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
@@ -296,7 +298,7 @@ protected Class<?> findClass(String name) throws ClassNotFoundException {
             // It would be easier to call the loadClass() methods of the delegateClassLoaders
             // here, but we have to load the class from the bytecode ourselves, because we
             // need it to be associated with our class loader.
-            String path = name.replace('.', '/') + ".class";
+            String path = fromClassNameToResourceName(name);
             URL url = findResource(path);
             if (url == null) {
                 throw new ClassNotFoundException(name);
@@ -376,4 +378,4 @@ private static byte[] read(InputStream source, int initialSize) throws IOExcepti
             return (capacity == nread) ? buf : Arrays.copyOf(buf, nread);
         }
     }
-}
+}
diff --git a/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/JunitTestRunner.java b/core/deployment/src/main/java/io/quarkus/deployment/dev/testing/JunitTestRunner.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment.dev.testing;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.lang.reflect.Modifier;
@@ -654,13 +656,14 @@ public String apply(Class<?> aClass) {
             Map<String, byte[]> transformedClasses = new HashMap<>();
             for (String i : classesToTransform) {
                 try {
+                    String resourceName = fromClassNameToResourceName(i);
                     byte[] classData = IoUtil
-                            .readBytes(deploymentClassLoader.getResourceAsStream(i.replace('.', '/') + ".class"));
+                            .readBytes(deploymentClassLoader.getResourceAsStream(resourceName));
                     ClassReader cr = new ClassReader(classData);
                     ClassWriter writer = new QuarkusClassWriter(cr,
                             ClassWriter.COMPUTE_FRAMES | ClassWriter.COMPUTE_MAXS);
                     cr.accept(new TestTracingProcessor.TracingClassVisitor(writer, i), 0);
-                    transformedClasses.put(i.replace('.', '/') + ".class", writer.toByteArray());
+                    transformedClasses.put(resourceName, writer.toByteArray());
                 } catch (Exception e) {
                     log.error("Failed to instrument " + i + " for usage tracking", e);
                 }

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/index/IndexWrapper.java b/core/deployment/src/main/java/io/quarkus/deployment/index/IndexWrapper.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment.index;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.lang.reflect.Modifier;
@@ -313,7 +315,7 @@ static boolean index(Indexer indexer, String className, ClassLoader classLoader)
             return false;
         }
         try (InputStream stream = classLoader
-                .getResourceAsStream(className.replace('.', '/') + ".class")) {
+                .getResourceAsStream(fromClassNameToResourceName(className))) {
             if (stream != null) {
                 indexer.index(stream);
                 result = true;

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JarResultBuildStep.java b/core/deployment/src/main/java/io/quarkus/deployment/pkg/steps/JarResultBuildStep.java
@@ -1,5 +1,6 @@
 package io.quarkus.deployment.pkg.steps;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
 import static io.quarkus.deployment.pkg.PackageConfig.JarConfig.JarType.*;
 
 import java.io.BufferedInputStream;
@@ -649,7 +650,7 @@ private JarBuildItem buildThinJar(CurateOutcomeBuildItem curateOutcomeBuildItem,
         fastJarJarsBuilder.setGenerated(generatedZip);
         try (FileSystem out = createNewZip(generatedZip, packageConfig)) {
             for (GeneratedClassBuildItem i : generatedClasses) {
-                String fileName = i.getName().replace('.', '/') + ".class";
+                String fileName = fromClassNameToResourceName(i.getName());
                 Path target = out.getPath(fileName);
                 if (target.getParent() != null) {
                     Files.createDirectories(target.getParent());
@@ -1181,7 +1182,7 @@ private void copyCommonContent(FileSystem runnerZipFs, Map<String, List<byte[]>>
             }
         }
         for (GeneratedClassBuildItem i : generatedClasses) {
-            String fileName = i.getName().replace('.', '/') + ".class";
+            String fileName = fromClassNameToResourceName(i.getName());
             seen.put(fileName, "Current Application");
             Path target = runnerZipFs.getPath(fileName);
             handleParent(runnerZipFs, fileName, seen);

diff --git a/...nt/src/main/java/io/quarkus/deployment/steps/AdditionalClassLoaderResourcesBuildStep.java b/...nt/src/main/java/io/quarkus/deployment/steps/AdditionalClassLoaderResourcesBuildStep.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment.steps;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.LinkedHashMap;
@@ -31,7 +33,7 @@ void appendAdditionalClassloaderResources(BuildProducer<AdditionalIndexedClasses
 
                     collected.put(entry.getKey(), entry.getValue());
                     // add it also as resources to allow index to work properly
-                    collected.put(entry.getKey().replace('.', '/') + ".class", entry.getValue());
+                    collected.put(fromClassNameToResourceName(entry.getKey()), entry.getValue());
 
                 }
             }

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/steps/BannerProcessor.java b/core/deployment/src/main/java/io/quarkus/deployment/steps/BannerProcessor.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment.steps;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.IOException;
 import java.io.UncheckedIOException;
 import java.net.URL;
@@ -113,7 +115,7 @@ protected boolean isQuarkusCoreBanner(URL url) {
                 // We determine whether the banner is the default by checking to see if the jar that contains it also
                 // contains this class. This way although somewhat complicated guarantees that any rename of artifacts
                 // won't affect the check
-                Path resolved = p.resolve("/" + thisClassName.replace('.', '/') + ".class");
+                Path resolved = p.resolve("/" + fromClassNameToResourceName(thisClassName));
                 return Files.exists(resolved);
             });
         } catch (UncheckedIOException ex) {

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/steps/ClassTransformingBuildStep.java b/core/deployment/src/main/java/io/quarkus/deployment/steps/ClassTransformingBuildStep.java
@@ -1,5 +1,7 @@
 package io.quarkus.deployment.steps;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.File;
 import java.io.FileOutputStream;
 import java.io.IOException;
@@ -145,7 +147,7 @@ public byte[] apply(String className, byte[] originalBytes) {
                 ClassLoader old = Thread.currentThread().getContextClassLoader();
                 try {
                     Thread.currentThread().setContextClassLoader(transformCl);
-                    String classFileName = className.replace('.', '/') + ".class";
+                    String classFileName = fromClassNameToResourceName(className);
                     List<ClassPathElement> archives = cl.getElementsWithResource(classFileName);
                     if (!archives.isEmpty()) {
                         ClassPathElement classPathElement = archives.get(0);
@@ -195,7 +197,7 @@ public byte[] apply(String className, byte[] originalBytes) {
                     }
                 }
             }
-            String classFileName = className.replace('.', '/') + ".class";
+            String classFileName = fromClassNameToResourceName(className);
             List<ClassPathElement> archives = cl.getElementsWithResource(classFileName);
             if (!archives.isEmpty()) {
                 ClassPathElement classPathElement = archives.get(0);
@@ -372,7 +374,7 @@ private byte[] transformClass(String className, List<BiFunction<String, ClassVis
             if (!debugPath.exists()) {
                 debugPath.mkdir();
             }
-            File classFile = new File(debugPath, className.replace('.', '/') + ".class");
+            File classFile = new File(debugPath, fromClassNameToResourceName(className));
             classFile.getParentFile().mkdirs();
             try (FileOutputStream classWriter = new FileOutputStream(classFile)) {
                 classWriter.write(data);

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/util/IoUtil.java b/core/deployment/src/main/java/io/quarkus/deployment/util/IoUtil.java
@@ -1,11 +1,13 @@
 package io.quarkus.deployment.util;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.IOException;
 import java.io.InputStream;
 
 public class IoUtil {
     public static InputStream readClass(ClassLoader classLoader, String className) {
-        return classLoader.getResourceAsStream(className.replace('.', '/') + ".class");
+        return classLoader.getResourceAsStream(fromClassNameToResourceName(className));
     }
 
     public static byte[] readClassAsBytes(ClassLoader classLoader, String className) throws IOException {

diff --git a/core/deployment/src/main/java/io/quarkus/runner/bootstrap/StartupActionImpl.java b/core/deployment/src/main/java/io/quarkus/runner/bootstrap/StartupActionImpl.java
@@ -1,5 +1,7 @@
 package io.quarkus.runner.bootstrap;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.Closeable;
 import java.io.File;
 import java.io.FileOutputStream;
@@ -362,7 +364,7 @@ private static Map<String, byte[]> extractGeneratedResources(BuildResult buildRe
         Map<String, byte[]> data = new HashMap<>();
         for (GeneratedClassBuildItem i : buildResult.consumeMulti(GeneratedClassBuildItem.class)) {
             if (i.isApplicationClass() == applicationClasses) {
-                data.put(i.getName().replace('.', '/') + ".class", i.getClassData());
+                data.put(fromClassNameToResourceName(i.getName()), i.getClassData());
                 if (BootstrapDebug.DEBUG_CLASSES_DIR != null) {
                     try {
                         File debugPath = new File(BootstrapDebug.DEBUG_CLASSES_DIR);

diff --git a/core/deployment/src/test/java/io/quarkus/deployment/pkg/steps/BannerProcessorTest.java b/core/deployment/src/test/java/io/quarkus/deployment/pkg/steps/BannerProcessorTest.java
@@ -1,5 +1,6 @@
 package io.quarkus.deployment.pkg.steps;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
@@ -40,7 +41,7 @@ public void checkQuarkusCoreBannerOnFilesystemWithSpecialCharacters(@TempDir Pat
             }
 
             try (final FileSystem fs = ZipUtils.newFileSystem(zipPath)) {
-                Path classFile = fs.getPath(MyBannerProcessor.class.getName().replace('.', '/') + ".class");
+                Path classFile = fs.getPath(fromClassNameToResourceName(MyBannerProcessor.class.getName()));
                 Files.createDirectories(classFile.getParent());
                 Files.write(classFile, "".getBytes(StandardCharsets.UTF_8));
             }

diff --git a/core/deployment/src/test/java/io/quarkus/deployment/util/JandexUtilTest.java b/core/deployment/src/test/java/io/quarkus/deployment/util/JandexUtilTest.java
@@ -16,6 +16,8 @@
 import org.jboss.jandex.Type.Kind;
 import org.junit.jupiter.api.Test;
 
+import io.quarkus.commons.classloading.ClassloadHelper;
+
 public class JandexUtilTest {
 
     private static final DotName SIMPLE = DotName.createSimple(Single.class.getName());
@@ -307,7 +309,7 @@ private static Index index(Class<?>... classes) {
         for (Class<?> clazz : classes) {
             try {
                 try (InputStream stream = JandexUtilTest.class.getClassLoader()
-                        .getResourceAsStream(clazz.getName().replace('.', '/') + ".class")) {
+                        .getResourceAsStream(ClassloadHelper.fromClassNameToResourceName(clazz.getName()))) {
                     indexer.index(stream);
                 }
             } catch (IOException e) {

diff --git a/core/runtime/pom.xml b/core/runtime/pom.xml
@@ -148,6 +148,7 @@
                     </lesserPriorityArtifacts>
                     <parentFirstArtifacts>
                         <parentFirstArtifact>io.quarkus:quarkus-bootstrap-runner</parentFirstArtifact>
+                        <parentFirstArtifact>io.quarkus:quarkus-classloader-commons</parentFirstArtifact>
                         <parentFirstArtifact>io.smallrye.common:smallrye-common-constraint</parentFirstArtifact>
                         <parentFirstArtifact>io.smallrye.common:smallrye-common-cpu</parentFirstArtifact>
                         <parentFirstArtifact>io.smallrye.common:smallrye-common-expression</parentFirstArtifact>
@@ -237,6 +238,7 @@
                         <runnerParentFirstArtifact>org.graalvm.sdk:native-bridge</runnerParentFirstArtifact>
                         <!-- /support for GraalVM js -->
                         <runnerParentFirstArtifact>io.quarkus:quarkus-bootstrap-runner</runnerParentFirstArtifact>
+                        <runnerParentFirstArtifact>io.quarkus:quarkus-classloader-commons</runnerParentFirstArtifact>
                         <runnerParentFirstArtifact>io.quarkus:quarkus-development-mode-spi</runnerParentFirstArtifact>
                         <!-- logging dependencies always need to be loaded by the JDK ClassLoader -->
                         <runnerParentFirstArtifact>org.jboss.logging:jboss-logging</runnerParentFirstArtifact>

diff --git a/...-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/boot/scan/QuarkusScanner.java b/...-orm/runtime/src/main/java/io/quarkus/hibernate/orm/runtime/boot/scan/QuarkusScanner.java
@@ -1,5 +1,7 @@
 package io.quarkus.hibernate.orm.runtime.boot.scan;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.util.Collections;
 import java.util.HashSet;
 import java.util.Set;
@@ -149,8 +151,9 @@ public Categorization getCategorization() {
 
         @Override
         public InputStreamAccess getStreamAccess() {
+            final String resourceName = fromClassNameToResourceName(name);
             return new UrlInputStreamAccess(
-                    Thread.currentThread().getContextClassLoader().getResource(name.replace('.', '/') + ".class"));
+                    Thread.currentThread().getContextClassLoader().getResource(resourceName));
         }
     }
 }
diff --git a/extensions/qute/deployment/src/test/java/io/quarkus/qute/deployment/TypeInfosTest.java b/extensions/qute/deployment/src/test/java/io/quarkus/qute/deployment/TypeInfosTest.java
@@ -19,6 +19,7 @@
 import org.jboss.jandex.ParameterizedType;
 import org.junit.jupiter.api.Test;
 
+import io.quarkus.commons.classloading.ClassloadHelper;
 import io.quarkus.qute.Engine;
 import io.quarkus.qute.Expression;
 import io.quarkus.qute.deployment.TypeInfos.Info;
@@ -94,8 +95,9 @@ private void assertHints(String hintStr, String... expectedHints) {
     private static Index index(Class<?>... classes) throws IOException {
         Indexer indexer = new Indexer();
         for (Class<?> clazz : classes) {
+            final String resourceName = ClassloadHelper.fromClassNameToResourceName(clazz.getName());
             try (InputStream stream = TypeInfosTest.class.getClassLoader()
-                    .getResourceAsStream(clazz.getName().replace('.', '/') + ".class")) {
+                    .getResourceAsStream(resourceName)) {
                 indexer.index(stream);
             }
         }

diff --git a/extensions/qute/deployment/src/test/java/io/quarkus/qute/deployment/TypesTest.java b/extensions/qute/deployment/src/test/java/io/quarkus/qute/deployment/TypesTest.java
@@ -19,6 +19,7 @@
 import org.jboss.jandex.Type;
 import org.junit.jupiter.api.Test;
 
+import io.quarkus.commons.classloading.ClassloadHelper;
 import io.quarkus.qute.EvalContext;
 import io.quarkus.qute.ValueResolver;
 import io.quarkus.qute.deployment.Types.AssignabilityCheck;
@@ -78,8 +79,9 @@ public void testIsImplementorOf() throws IOException {
     private static Index index(Class<?>... classes) throws IOException {
         Indexer indexer = new Indexer();
         for (Class<?> clazz : classes) {
+            final String resourceName = ClassloadHelper.fromClassNameToResourceName(clazz.getName());
             try (InputStream stream = TypesTest.class.getClassLoader()
-                    .getResourceAsStream(clazz.getName().replace('.', '/') + ".class")) {
+                    .getResourceAsStream(resourceName)) {
                 indexer.index(stream);
             }
         }

diff --git a/...src/main/java/io/quarkus/resteasy/reactive/server/deployment/FilterClassIntrospector.java b/...src/main/java/io/quarkus/resteasy/reactive/server/deployment/FilterClassIntrospector.java
@@ -1,5 +1,7 @@
 package io.quarkus.resteasy.reactive.server.deployment;
 
+import static io.quarkus.commons.classloading.ClassloadHelper.fromClassNameToResourceName;
+
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.UncheckedIOException;
@@ -24,7 +26,8 @@ public FilterClassIntrospector(ClassLoader classLoader) {
 
     public boolean usesGetResourceMethod(MethodInfo methodInfo) {
         String className = methodInfo.declaringClass().name().toString();
-        try (InputStream is = classLoader.getResourceAsStream(className.replace('.', '/') + ".class")) {
+        final String resourceName = fromClassNameToResourceName(className);
+        try (InputStream is = classLoader.getResourceAsStream(resourceName)) {
             ClassReader configClassReader = new ClassReader(is);
             FilterClassVisitor classVisitor = new FilterClassVisitor(methodInfo.descriptor());
             configClassReader.accept(classVisitor, 0);