-
-
Notifications
You must be signed in to change notification settings - Fork 20
Replace Unsafe classpath lookup #232
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
DerMistkaefer
wants to merge
1
commit into
vectrix-space:main/1.0.0
Choose a base branch
from
DerMistkaefer:fix/unsafe-classpath-lookup
base: main/1.0.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -24,11 +24,14 @@ | |
| */ | ||
| package space.vectrix.ignite.util; | ||
|
|
||
| import java.lang.reflect.Field; | ||
| import java.lang.reflect.Method; | ||
| import java.io.File; | ||
| import java.net.MalformedURLException; | ||
| import java.net.URL; | ||
| import java.net.URLClassLoader; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.jetbrains.annotations.NotNull; | ||
| import org.tinylog.Logger; | ||
|
|
||
|
|
@@ -45,47 +48,33 @@ public final class ClassLoaders { | |
| * @return the system class path urls | ||
| * @since 1.0.0 | ||
| */ | ||
| @SuppressWarnings({"restriction", "unchecked"}) | ||
| public static URL@NotNull [] systemClassPaths() { | ||
| final ClassLoader classLoader = ClassLoaders.class.getClassLoader(); | ||
| if(classLoader instanceof URLClassLoader) { | ||
| return ((URLClassLoader) classLoader).getURLs(); | ||
| } | ||
|
|
||
| if(classLoader.getClass().getName().startsWith("jdk.internal.loader.ClassLoaders$")) { | ||
| try { | ||
| final Class<?> unsafeClass = Class.forName("sun.misc.Unsafe"); | ||
| final Method objectFieldOffsetMethod = unsafeClass.getDeclaredMethod("objectFieldOffset", Field.class); | ||
| final Method getObjectMethod = unsafeClass.getDeclaredMethod("getObject", Object.class, long.class); | ||
|
|
||
| final Field unsafeField = unsafeClass.getDeclaredField("theUnsafe"); | ||
| unsafeField.setAccessible(true); | ||
| final Object unsafe = unsafeField.get(null); | ||
|
|
||
| // jdk.internal.loader.ClassLoaders.AppClassLoader.ucp | ||
| Field ucpField; | ||
| try { | ||
| ucpField = classLoader.getClass().getDeclaredField("ucp"); | ||
| } catch(final NoSuchFieldException | SecurityException e) { | ||
| ucpField = classLoader.getClass().getSuperclass().getDeclaredField("ucp"); | ||
| } | ||
|
|
||
| final long ucpFieldOffset = (long) objectFieldOffsetMethod.invoke(unsafe, ucpField); | ||
| final Object ucpObject = getObjectMethod.invoke(unsafe, classLoader, ucpFieldOffset); | ||
| final String classPath = System.getProperty("java.class.path", ""); | ||
| if(classPath.isEmpty()) { | ||
| return new URL[0]; | ||
| } | ||
|
|
||
| // jdk.internal.loader.URLClassPath.path | ||
| final Field pathField = ucpField.getType().getDeclaredField("path"); | ||
| final long pathFieldOffset = (long) objectFieldOffsetMethod.invoke(unsafe, pathField); | ||
| final ArrayList<URL> path = (ArrayList<URL>) getObjectMethod.invoke(unsafe, ucpObject, pathFieldOffset); | ||
| final String separator = System.getProperty("path.separator", File.pathSeparator); | ||
| final List<URL> urls = new ArrayList<>(); | ||
| for(final String entry : classPath.split(java.util.regex.Pattern.quote(separator))) { | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Lets not use regex here. We can simply do |
||
| if(entry.isEmpty()) { | ||
| continue; | ||
| } | ||
|
|
||
| return path.toArray(new URL[0]); | ||
| } catch(final Exception exception) { | ||
| Logger.error(exception, "Failed to retrieve system classloader paths!"); | ||
| return new URL[0]; | ||
| try { | ||
| final Path path = Paths.get(entry); | ||
| urls.add(path.toUri().toURL()); | ||
| } catch(final MalformedURLException exception) { | ||
| Logger.warn(exception, "Skipping malformed class path entry: {}", entry); | ||
| } | ||
| } | ||
|
|
||
| return new URL[0]; | ||
| return urls.toArray(new URL[0]); | ||
| } | ||
|
|
||
| private ClassLoaders() { | ||
|
|
||
127 changes: 127 additions & 0 deletions
127
launcher/src/test/java/space/vectrix/ignite/util/ClassLoadersTest.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /* | ||
| * This file is part of Ignite, licensed under the MIT License (MIT). | ||
| * | ||
| * Copyright (c) vectrix.space <https://vectrix.space/> | ||
| * Copyright (c) contributors | ||
| * | ||
| * Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| * of this software and associated documentation files (the "Software"), to deal | ||
| * in the Software without restriction, including without limitation the rights | ||
| * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| * copies of the Software, and to permit persons to whom the Software is | ||
| * furnished to do so, subject to the following conditions: | ||
| * | ||
| * The above copyright notice and this permission notice shall be included in | ||
| * all copies or substantial portions of the Software. | ||
| * | ||
| * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN | ||
| * THE SOFTWARE. | ||
| */ | ||
| package space.vectrix.ignite.util; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertArrayEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
|
|
||
| import java.io.File; | ||
| import java.lang.reflect.Field; | ||
| import java.lang.reflect.Method; | ||
| import java.net.URL; | ||
| import java.net.URLClassLoader; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| class ClassLoadersTest { | ||
| @Test | ||
| void systemClassPathsMatchesJavaClassPathProperty() { | ||
| final URL[] expected = this.classPathPropertyUrls(); | ||
| final URL[] actual = ClassLoaders.systemClassPaths(); | ||
|
|
||
| assertArrayEquals(expected, actual); | ||
| } | ||
|
|
||
| @Test | ||
| void systemClassPathsMatchesLegacyUnsafeLookupOnJdkInternalClassLoader() throws Exception { | ||
| final ClassLoader classLoader = ClassLoaders.class.getClassLoader(); | ||
| if(classLoader instanceof URLClassLoader || !classLoader.getClass().getName().startsWith("jdk.internal.loader.ClassLoaders$")) { | ||
| return; | ||
| } | ||
|
|
||
| final URL[] expected = this.legacyUnsafeSystemClassPaths(classLoader); | ||
| final URL[] actual = ClassLoaders.systemClassPaths(); | ||
|
|
||
| assertArrayEquals(expected, actual); | ||
| } | ||
|
|
||
| @Test | ||
| void javaClassPathPropertyExpansionIsStable() { | ||
| final String classPath = System.getProperty("java.class.path", ""); | ||
| final String separator = System.getProperty("path.separator", File.pathSeparator); | ||
|
|
||
| final long nonEmptyEntries = classPath.isEmpty() | ||
| ? 0 | ||
| : java.util.regex.Pattern.compile(java.util.regex.Pattern.quote(separator)) | ||
| .splitAsStream(classPath) | ||
| .filter(entry -> !entry.isEmpty()) | ||
| .count(); | ||
|
|
||
| assertEquals(nonEmptyEntries, ClassLoaders.systemClassPaths().length); | ||
| } | ||
|
|
||
| private URL[] classPathPropertyUrls() { | ||
| final String classPath = System.getProperty("java.class.path", ""); | ||
| if(classPath.isEmpty()) { | ||
| return new URL[0]; | ||
| } | ||
|
|
||
| final String separator = System.getProperty("path.separator", File.pathSeparator); | ||
| final List<URL> urls = new ArrayList<>(); | ||
| for(final String entry : classPath.split(java.util.regex.Pattern.quote(separator))) { | ||
| if(entry.isEmpty()) { | ||
| continue; | ||
| } | ||
|
|
||
| final Path path = Paths.get(entry); | ||
| try { | ||
| urls.add(path.toUri().toURL()); | ||
| } catch(final Exception exception) { | ||
| throw new AssertionError("Failed to convert class path entry to URL: " + entry, exception); | ||
| } | ||
| } | ||
|
|
||
| return urls.toArray(new URL[0]); | ||
| } | ||
|
|
||
| @SuppressWarnings({"restriction", "unchecked"}) | ||
| private URL[] legacyUnsafeSystemClassPaths(final ClassLoader classLoader) throws Exception { | ||
| final Class<?> unsafeClass = Class.forName("sun.misc.Unsafe"); | ||
| final Method objectFieldOffsetMethod = unsafeClass.getDeclaredMethod("objectFieldOffset", Field.class); | ||
| final Method getObjectMethod = unsafeClass.getDeclaredMethod("getObject", Object.class, long.class); | ||
|
|
||
| final Field unsafeField = unsafeClass.getDeclaredField("theUnsafe"); | ||
| unsafeField.setAccessible(true); | ||
| final Object unsafe = unsafeField.get(null); | ||
|
|
||
| Field ucpField; | ||
| try { | ||
| ucpField = classLoader.getClass().getDeclaredField("ucp"); | ||
| } catch(final NoSuchFieldException | SecurityException exception) { | ||
| ucpField = classLoader.getClass().getSuperclass().getDeclaredField("ucp"); | ||
| } | ||
|
|
||
| final long ucpFieldOffset = (long) objectFieldOffsetMethod.invoke(unsafe, ucpField); | ||
| final Object ucpObject = getObjectMethod.invoke(unsafe, classLoader, ucpFieldOffset); | ||
|
|
||
| final Field pathField = ucpField.getType().getDeclaredField("path"); | ||
| final long pathFieldOffset = (long) objectFieldOffsetMethod.invoke(unsafe, pathField); | ||
| final ArrayList<URL> path = (ArrayList<URL>) getObjectMethod.invoke(unsafe, ucpObject, pathFieldOffset); | ||
| return path.toArray(new URL[0]); | ||
| } | ||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just using
File.pathSeparatorwould be good enough, don't need to grab it from the system property.