8287834: Add SymbolLookup::or method

Reviewed-by: psandoz
This commit is contained in:
Maurizio Cimadamore 2023-05-22 14:51:09 +00:00
parent 4f88437b7f
commit 91aeb5de58
2 changed files with 167 additions and 0 deletions

View File

@ -129,6 +129,28 @@ public interface SymbolLookup {
*/
Optional<MemorySegment> find(String name);
/**
* {@return a composed symbol lookup that returns result of finding the symbol with this lookup if found,
* otherwise returns the result of finding the symbol with the other lookup}
*
* @apiNote This method could be used to chain multiple symbol lookups together, e.g. so that symbols could
* be retrieved, in order, from multiple libraries:
* {@snippet lang = java:
* var lookup = SymbolLookup.libraryLookup("foo", arena)
* .or(SymbolLookup.libraryLookup("bar", arena))
* .or(SymbolLookup.loaderLookup());
*}
* The above code creates a symbol lookup that first searches for symbols in the "foo" library. If no symbol is found
* in "foo" then "bar" is searched. Finally, if a symbol is not found in neither "foo" nor "bar", the {@linkplain
* SymbolLookup#loaderLookup() loader lookup} is used.
*
* @param other the symbol lookup that should be used to look for symbols not found in this lookup.
*/
default SymbolLookup or(SymbolLookup other) {
Objects.requireNonNull(other);
return name -> find(name).or(() -> other.find(name));
}
/**
* Returns a symbol lookup for symbols in the libraries associated with the caller's class loader.
* <p>

View File

@ -0,0 +1,145 @@
/*
* Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
import org.testng.annotations.Test;
import java.lang.foreign.*;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import org.testng.annotations.*;
import static org.testng.Assert.*;
/*
* @test
* @enablePreview
* @run testng CompositeLookupTest
*/
public class CompositeLookupTest {
@Test(dataProvider = "testCases")
public void testLookups(SymbolLookup lookup, List<Result> results) {
for (Result result : results) {
switch (result) {
case Success(String name, long expectedLookupId) -> {
Optional<MemorySegment> symbol = lookup.find(name);
assertTrue(symbol.isPresent());
assertEquals(symbol.get().address(), expectedLookupId);
}
case Failure(String name) -> {
Optional<MemorySegment> symbol = lookup.find(name);
assertFalse(symbol.isPresent());
}
}
}
}
static class TestLookup implements SymbolLookup {
private Set<String> symbols;
private long id;
public TestLookup(long id, String... symbols) {
this.id = id;
this.symbols = Set.of(symbols);
}
@Override
public Optional<MemorySegment> find(String name) {
return symbols.contains(name) ?
Optional.of(MemorySegment.ofAddress(id)) : Optional.empty();
}
}
sealed interface Result { }
record Success(String name, long expectedLookupId) implements Result { }
record Failure(String name) implements Result { }
@DataProvider(name = "testCases")
public Object[][] testCases() {
return new Object[][]{
{
new TestLookup(1, "a", "b", "c")
.or(new TestLookup(2,"d", "e", "f"))
.or(new TestLookup(3,"g", "h", "i")),
List.of(
new Success("a", 1),
new Success("b", 1),
new Success("c", 1),
new Success("d", 2),
new Success("e", 2),
new Success("f", 2),
new Success("g", 3),
new Success("h", 3),
new Success("i", 3),
new Failure("j")
)
},
{
new TestLookup(1, "a", "b", "c")
.or(new TestLookup(2,"a", "b", "c"))
.or(new TestLookup(3,"a", "b", "c")),
List.of(
new Success("a", 1),
new Success("b", 1),
new Success("c", 1),
new Failure("d")
)
},
{
new TestLookup(1 )
.or(new TestLookup(2))
.or(new TestLookup(3,"a", "b", "c")),
List.of(
new Success("a", 3),
new Success("b", 3),
new Success("c", 3),
new Failure("d")
)
},
{
new TestLookup(1, "a", "b", "c")
.or(new TestLookup(2,"d")
.or(new TestLookup(3,"e"))
.or(new TestLookup(4,"f")))
.or(new TestLookup(5,"g")
.or(new TestLookup(6,"h"))
.or(new TestLookup(7,"i"))),
List.of(
new Success("a", 1),
new Success("b", 1),
new Success("c", 1),
new Success("d", 2),
new Success("e", 3),
new Success("f", 4),
new Success("g", 5),
new Success("h", 6),
new Success("i", 7),
new Failure("j")
)
},
};
}
}