archive/jdk
1
0
Fork 0
mirror of https://github.com/openjdk/jdk.git synced 2025-08-27 14:54:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

8314592: Add shortcut to SymbolLookup::find

Browse source 
Reviewed-by: jvernee, prr
This commit is contained in:
Per Minborg 2024-04-24 11:56:44 +00:00
parent 15190816f7
commit e923dfe4c5
22 changed files with 151 additions and 63 deletions
Download patch file Download diff file Expand all files Collapse all files

38
src/java.base/share/classes/java/lang/foreign/SymbolLookup.java
View file

@ -39,6 +39,7 @@ import jdk.internal.reflect.Reflection;
import java.lang.invoke.MethodHandles;
import java.nio.file.FileSystems;
import java.nio.file.Path;
import java.util.NoSuchElementException;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiFunction;
@ -79,7 +80,7 @@ import java.util.function.BiFunction;
* {@snippet lang = java:
* try (Arena arena = Arena.ofConfined()) {
* SymbolLookup libGL = SymbolLookup.libraryLookup("libGL.so", arena); // libGL.so loaded here
* MemorySegment glGetString = libGL.find("glGetString").orElseThrow();
* MemorySegment glGetString = libGL.findOrThrow("glGetString");
* ...
* } // libGL.so unloaded here
*}
@ -93,7 +94,7 @@ import java.util.function.BiFunction;
* System.loadLibrary("GL"); // libGL.so loaded here
* ...
* SymbolLookup libGL = SymbolLookup.loaderLookup();
* MemorySegment glGetString = libGL.find("glGetString").orElseThrow();
* MemorySegment glGetString = libGL.findOrThrow("glGetString");
* }
*
* This symbol lookup, which is known as a <em>loader lookup</em>, is dynamic with
@ -130,7 +131,7 @@ import java.util.function.BiFunction;
* {@snippet lang = java:
* Linker nativeLinker = Linker.nativeLinker();
* SymbolLookup stdlib = nativeLinker.defaultLookup();
* MemorySegment malloc = stdlib.find("malloc").orElseThrow();
* MemorySegment malloc = stdlib.findOrThrow("malloc");
*}
*
* @since 22
@ -144,9 +145,40 @@ public interface SymbolLookup {
* @param name the symbol name
* @return a zero-length memory segment whose address indicates the address of
* the symbol, if found
* @see #findOrThrow(String)
*/
Optional<MemorySegment> find(String name);
/**
* Returns the address of the symbol with the given name or throws an exception.
*<p>
* This is equivalent to the following code, but is more efficient:
* to:
* {@snippet lang= java :
* String name = ...
* MemorySegment address = lookup.find(name)
* .orElseThrow(() -> new NoSuchElementException("Symbol not found: " + name));
* }
*
* @param name the symbol name
* @return a zero-length memory segment whose address indicates the address of
* the symbol
* @throws NoSuchElementException if no symbol address can be found for the
* given name
* @see #find(String)
*
* @since 23
*/
default MemorySegment findOrThrow(String name) {
Objects.requireNonNull(name);
Optional<MemorySegment> address = find(name);
// Avoid lambda capturing
if (address.isPresent()) {
return address.get();
}
throw new NoSuchElementException("Symbol not found: " + name);
}
/**
* {@return a composed symbol lookup that returns the result of finding the symbol
* with this lookup if found, otherwise returns the result of finding