com.oracle.truffle.polyglot.OptionValuesImpl Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-api Show documentation
Show all versions of truffle-api Show documentation
Truffle is a multi-language framework for executing dynamic languages
that achieves high performance when combined with Graal.
/*
* Copyright (c) 2017, 2020, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* The Universal Permissive License (UPL), Version 1.0
*
* Subject to the condition set forth below, permission is hereby granted to any
* person obtaining a copy of this software, associated documentation and/or
* data (collectively the "Software"), free of charge and under any and all
* copyright rights in the Software, and any and all patent rights owned or
* freely licensable by each licensor hereunder covering either (i) the
* unmodified Software as contributed to or provided by such licensor, or (ii)
* the Larger Works (as defined below), to deal in both
*
* (a) the Software, and
*
* (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
* one is included with the Software each a "Larger Work" to which the Software
* is contributed by such licensors),
*
* without restriction, including without limitation the rights to copy, create
* derivative works of, display, perform, and distribute the Software and make,
* use, sell, offer for sale, import, export, have made, and have sold the
* Software and the Larger Work(s), and to sublicense the foregoing rights on
* either these or other terms.
*
* This license is subject to the following condition:
*
* The above copyright notice and either this complete permission notice or at a
* minimum a reference to the UPL must 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 com.oracle.truffle.polyglot;
import java.util.ArrayList;
import java.util.Formatter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import org.graalvm.options.OptionDescriptor;
import org.graalvm.options.OptionDescriptors;
import org.graalvm.options.OptionKey;
import org.graalvm.options.OptionStability;
import org.graalvm.options.OptionValues;
final class OptionValuesImpl implements OptionValues {
private static final float FUZZY_MATCH_THRESHOLD = 0.7F;
// TODO is this too long? Make sure to update Engine#setUseSystemProperties javadoc.
// Just using graalvm as prefix is not good enough as it is ambiguous with host compilation
// For example the property graalvm.compiler is an option for which compiler. The java compiler?
// or the truffle compiler?
static final String SYSTEM_PROPERTY_PREFIX = "polyglot.";
private final PolyglotEngineImpl engine;
private final OptionDescriptors descriptors;
private final Map, Object> values;
private final Map, String> unparsedValues;
OptionValuesImpl(PolyglotEngineImpl engine, OptionDescriptors descriptors, boolean preserveUnparsedValues) {
Objects.requireNonNull(descriptors);
this.engine = engine;
this.descriptors = descriptors;
this.values = new HashMap<>();
this.unparsedValues = preserveUnparsedValues ? new HashMap<>() : null;
}
@Override
public int hashCode() {
int result = 31 + descriptors.hashCode();
result = 31 * result + Objects.hashCode(engine);
result = 31 * result + values.hashCode();
return result;
}
@Override
public boolean equals(Object obj) {
if (!(obj instanceof OptionValues)) {
return super.equals(obj);
} else {
if (this == obj) {
return true;
}
OptionValues other = ((OptionValues) obj);
if (getDescriptors().equals(other.getDescriptors())) {
if (!hasSetOptions() && !other.hasSetOptions()) {
return true;
}
if (other instanceof OptionValuesImpl) {
// faster comparison that only depends on the set values
for (OptionKey key : values.keySet()) {
if (hasBeenSet(key) || other.hasBeenSet(key)) {
if (!get(key).equals(other.get(key))) {
return false;
}
}
}
for (OptionKey key : ((OptionValuesImpl) other).values.keySet()) {
if (hasBeenSet(key) || other.hasBeenSet(key)) {
if (!get(key).equals(other.get(key))) {
return false;
}
}
}
return true;
} else {
// slow comparison for arbitrary option values
for (OptionDescriptor descriptor : getDescriptors()) {
OptionKey key = descriptor.getKey();
if (hasBeenSet(key) || other.hasBeenSet(key)) {
if (!get(key).equals(other.get(key))) {
return false;
}
}
}
return true;
}
}
return false;
}
}
public void putAll(Map providedValues, boolean allowExperimentalOptions) {
for (String key : providedValues.keySet()) {
put(key, providedValues.get(key), allowExperimentalOptions);
}
}
public void put(String key, String value, boolean allowExperimentalOptions) {
OptionDescriptor descriptor = findDescriptor(key, allowExperimentalOptions);
OptionKey optionKey = descriptor.getKey();
Object previousValue;
if (values.containsKey(optionKey)) {
previousValue = values.get(optionKey);
} else {
previousValue = optionKey.getDefaultValue();
}
String name = descriptor.getName();
String suffix = null;
if (descriptor.isOptionMap()) {
suffix = key.substring(name.length());
assert suffix.isEmpty() || suffix.startsWith(".");
if (suffix.startsWith(".")) {
suffix = suffix.substring(1);
}
}
Object convertedValue;
try {
convertedValue = optionKey.getType().convert(previousValue, suffix, value);
} catch (IllegalArgumentException e) {
throw PolyglotEngineException.illegalArgument(e);
}
values.put(descriptor.getKey(), convertedValue);
if (unparsedValues != null) {
unparsedValues.put(descriptor.getKey(), value);
}
}
private OptionValuesImpl(OptionValuesImpl copy) {
this.engine = copy.engine;
this.values = new HashMap<>(copy.values);
this.descriptors = copy.descriptors;
this.unparsedValues = copy.unparsedValues;
}
private boolean contains(OptionKey optionKey) {
for (OptionDescriptor descriptor : descriptors) {
if (descriptor.getKey() == optionKey) {
return true;
}
}
return false;
}
@Override
public boolean hasBeenSet(OptionKey optionKey) {
assert contains(optionKey);
return values.containsKey(optionKey);
}
OptionValuesImpl copy() {
return new OptionValuesImpl(this);
}
void copyInto(OptionValuesImpl target) {
if (!target.values.isEmpty()) {
throw new IllegalStateException("Values must be empty.");
}
target.values.putAll(values);
}
public OptionDescriptors getDescriptors() {
return descriptors;
}
@SuppressWarnings("unchecked")
@Override
public T get(OptionKey optionKey) {
assert contains(optionKey);
Object value = values.get(optionKey);
if (value == null) {
return optionKey.getDefaultValue();
}
return (T) value;
}
@SuppressWarnings("deprecation")
@Override
public void set(OptionKey optionKey, T value) {
throw new UnsupportedOperationException("OptionValues#set() is no longer supported");
}
@Override
public boolean hasSetOptions() {
return !values.isEmpty();
}
String getUnparsedOptionValue(OptionKey key) {
if (unparsedValues == null) {
throw new IllegalStateException("Unparsed values are not supported");
}
return unparsedValues.get(key);
}
private OptionDescriptor findDescriptor(String key, boolean allowExperimentalOptions) {
OptionDescriptor descriptor = descriptors.get(key);
if (descriptor == null) {
throw failNotFound(key);
}
if (!allowExperimentalOptions && descriptor.getStability() == OptionStability.EXPERIMENTAL) {
throw failExperimental(key);
}
return descriptor;
}
private static RuntimeException failExperimental(String key) {
final String message = String.format("Option '%s' is experimental and must be enabled with allowExperimentalOptions(boolean) in Context.Builder or Engine.Builder. ", key) +
"Do not use experimental options in production environments.";
return PolyglotEngineException.illegalArgument(message);
}
private RuntimeException failNotFound(String key) {
OptionDescriptors allOptions;
Exception errorOptions = null;
try {
allOptions = engine == null ? this.descriptors : this.engine.getAllOptions();
} catch (Exception e) {
errorOptions = e;
allOptions = this.descriptors;
}
RuntimeException error = failNotFound(allOptions, key);
if (errorOptions != null) {
error.addSuppressed(errorOptions);
}
throw error;
}
static RuntimeException failNotFound(OptionDescriptors allOptions, String key) {
Iterable matches = fuzzyMatch(allOptions, key);
Formatter msg = new Formatter();
msg.format("Could not find option with name %s.", key);
Iterator iterator = matches.iterator();
if (iterator.hasNext()) {
msg.format("%nDid you mean one of the following?");
for (OptionDescriptor match : matches) {
msg.format("%n %s=<%s>", match.getName(), match.getKey().getType().getName());
}
}
throw PolyglotEngineException.illegalArgument(msg.toString());
}
/**
* Returns the set of options that fuzzy match a given option name.
*/
static List fuzzyMatch(OptionDescriptors descriptors, String optionKey) {
List matches = new ArrayList<>();
for (org.graalvm.options.OptionDescriptor option : descriptors) {
float score = stringSimiliarity(option.getName(), optionKey);
if (score >= FUZZY_MATCH_THRESHOLD) {
matches.add(option);
}
}
return matches;
}
/**
* Compute string similarity based on Dice's coefficient.
*
* Ported from str_similar() in globals.cpp.
*/
private static float stringSimiliarity(String str1, String str2) {
int hit = 0;
for (int i = 0; i < str1.length() - 1; ++i) {
for (int j = 0; j < str2.length() - 1; ++j) {
if ((str1.charAt(i) == str2.charAt(j)) && (str1.charAt(i + 1) == str2.charAt(j + 1))) {
++hit;
break;
}
}
}
return 2.0f * hit / (str1.length() + str2.length());
}
@Override
public String toString() {
if (unparsedValues != null) {
return unparsedValues.toString();
} else {
return values.toString();
}
}
}