Skip to content

Commit

Permalink
Generic signature reconstruction for methods
Browse files Browse the repository at this point in the history 
The algorithm for reconstructing generic signature for methods
in `AsmUtil` had some unimplemented parts, which are now completed.

Gizmo is also updated to the latest version that has complete
support for generating annotations.

Finally, RestClient Reactive now properly copies the method
generic signature when building RestClient interface implementation.
  • Loading branch information
@Ladicek
Ladicek committed Jun 18, 2021
1 parent 05b3caa commit 0948e42
Show file tree
Hide file tree
Showing 8 changed files with 694 additions and 95 deletions.
2 changes: 1 addition & 1 deletion bom/application/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
<plexus-component-annotations.version>2.1.0</plexus-component-annotations.version>
<!-- What we actually depend on for the annotations, as latest Graal is not available in Maven fast enough: -->
<graal-sdk.version>21.1.0</graal-sdk.version>
<gizmo.version>1.0.8.Final</gizmo.version>
<gizmo.version>1.0.9.Final</gizmo.version>
<jackson.version>2.12.3</jackson.version>
<commons-logging-jboss-logging.version>1.0.0.Final</commons-logging-jboss-logging.version>
<commons-lang3.version>3.12.0</commons-lang3.version>
Expand Down
228 changes: 187 additions & 41 deletions core/deployment/src/main/java/io/quarkus/deployment/util/AsmUtil.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,20 +12,24 @@
import static org.objectweb.asm.Type.VOID_TYPE;
import static org.objectweb.asm.Type.getType;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.function.Function;

import org.jboss.jandex.ArrayType;
import org.jboss.jandex.ClassType;
import org.jboss.jandex.DotName;
import org.jboss.jandex.MethodInfo;
import org.jboss.jandex.ParameterizedType;
import org.jboss.jandex.PrimitiveType.Primitive;
import org.jboss.jandex.Type;
import org.jboss.jandex.Type.Kind;
import org.jboss.jandex.TypeVariable;
import org.jboss.jandex.UnresolvedTypeVariable;
import org.jboss.jandex.WildcardType;
import org.objectweb.asm.MethodVisitor;
import org.objectweb.asm.Opcodes;

Expand Down Expand Up @@ -68,49 +72,168 @@ public static org.objectweb.asm.Type autobox(org.objectweb.asm.Type primitive) {
return WRAPPERS.get(primitive.getSort());
}

/**
* Returns the Java bytecode signature of a given Jandex MethodInfo.
* If the Java compiler doesn't have to emit a signature for the method, {@code null} is returned instead.
*
* @param method the method you want the signature for
* @return a bytecode signature for that method, or {@code null} if signature is not required
*/
public static String getSignatureIfRequired(MethodInfo method) {
return getSignatureIfRequired(method, ignored -> null);
}

/**
* Returns the Java bytecode signature of a given Jandex MethodInfo using the given type argument mappings.
* If the Java compiler doesn't have to emit a signature for the method, {@code null} is returned instead.
*
* @param method the method you want the signature for
* @param typeArgMapper a mapping between type argument names and their bytecode signatures
* @return a bytecode signature for that method, or {@code null} if signature is not required
*/
public static String getSignatureIfRequired(MethodInfo method, Function<String, String> typeArgMapper) {
if (!hasSignature(method)) {
return null;
}

return getSignature(method, typeArgMapper);
}

private static boolean hasSignature(MethodInfo method) {
// JVMS 16, chapter 4.7.9.1. Signatures:
//
// Java compiler must emit ...
//
// A method signature for any method or constructor declaration which is either generic,
// or has a type variable or parameterized type as the return type or a formal parameter type,
// or has a type variable in a throws clause, or any combination thereof.

if (!method.typeParameters().isEmpty()) {
return true;
}

{
Type type = method.returnType();
if (type.kind() == Kind.TYPE_VARIABLE
|| type.kind() == Kind.UNRESOLVED_TYPE_VARIABLE
|| type.kind() == Kind.PARAMETERIZED_TYPE) {
return true;
}
}

for (Type type : method.parameters()) {
if (type.kind() == Kind.TYPE_VARIABLE
|| type.kind() == Kind.UNRESOLVED_TYPE_VARIABLE
|| type.kind() == Kind.PARAMETERIZED_TYPE) {
return true;
}
}

if (hasThrowsSignature(method)) {
return true;
}

return false;
}

private static boolean hasThrowsSignature(MethodInfo method) {
// JVMS 16, chapter 4.7.9.1. Signatures:
//
// If the throws clause of a method or constructor declaration does not involve type variables,
// then a compiler may treat the declaration as having no throws clause for the purpose of
// emitting a method signature.

// also, no need to check if an exception type is of kind PARAMETERIZED_TYPE, because
//
// JLS 16, chapter 8.1.2. Generic Classes and Type Parameters:
//
// It is a compile-time error if a generic class is a direct or indirect subclass of Throwable.

for (Type type : method.exceptions()) {
if (type.kind() == Kind.TYPE_VARIABLE
|| type.kind() == Kind.UNRESOLVED_TYPE_VARIABLE) {
return true;
}
}
return false;
}

/**
* Returns the Java bytecode signature of a given Jandex MethodInfo using the given type argument mappings.
* For example, given this method:
*
*
* <pre>
* {@code
* public class Foo<T> {
* public <R> List<R> method(int a, T t){...}
* public <R> List<R> method(int a, T t){...}
* }
* }
* </pre>
*
*
* This will return <tt>&lt;R:Ljava/lang/Object;>(ILjava/lang/Integer;)Ljava/util/List&lt;TR;>;</tt> if
* your {@code typeArgMapper} contains {@code T=Ljava/lang/Integer;}.
*
*
* @param method the method you want the signature for.
* @param typeArgMapper a mapping between type argument names and their bytecode signature.
* @return a bytecode signature for that method.
*/
public static String getSignature(MethodInfo method, Function<String, String> typeArgMapper) {
List<Type> parameters = method.parameters();
// for grammar, see JVMS 16, chapter 4.7.9.1. Signatures

StringBuilder signature = new StringBuilder("");
for (TypeVariable typeVariable : method.typeParameters()) {
if (signature.length() == 0)
signature.append("<");
else
signature.append(",");
signature.append(typeVariable.identifier()).append(":");
// FIXME: only use the first bound
toSignature(signature, typeVariable.bounds().get(0), typeArgMapper, false);
StringBuilder signature = new StringBuilder();

if (!method.typeParameters().isEmpty()) {
signature.append('<');
for (TypeVariable typeParameter : method.typeParameters()) {
typeParameter(typeParameter, signature, typeArgMapper);
}
signature.append('>');
}
if (signature.length() > 0)
signature.append(">");
signature.append("(");
for (Type type : parameters) {

signature.append('(');
for (Type type : method.parameters()) {
toSignature(signature, type, typeArgMapper, false);
}
signature.append(")");
signature.append(')');

toSignature(signature, method.returnType(), typeArgMapper, false);

if (hasThrowsSignature(method)) {
for (Type exception : method.exceptions()) {
signature.append('^');
toSignature(signature, exception, typeArgMapper, false);
}
}

return signature.toString();
}

private static void typeParameter(TypeVariable typeParameter, StringBuilder result,
Function<String, String> typeArgMapper) {
result.append(typeParameter.identifier());

if (hasImplicitObjectBound(typeParameter)) {
result.append(':');
}
for (Type bound : typeParameter.bounds()) {
result.append(':');
toSignature(result, bound, typeArgMapper, false);
}
}

private static boolean hasImplicitObjectBound(TypeVariable typeParameter) {
// TODO is there a better way? :-/
boolean result = false;
try {
Method method = TypeVariable.class.getDeclaredMethod("hasImplicitObjectBound");
method.setAccessible(true);
result = (Boolean) method.invoke(typeParameter);
} catch (ReflectiveOperationException e) {
throw new RuntimeException(e);
}
return result;
}

/**
* Returns the Java bytecode descriptor of a given Jandex MethodInfo using the given type argument mappings.
* For example, given this method:
Expand Down Expand Up @@ -176,30 +299,35 @@ private static void toSignature(StringBuilder sb, Type type, Function<String, St
switch (type.kind()) {
case ARRAY:
ArrayType arrayType = type.asArrayType();
for (int i = 0; i < arrayType.dimensions(); i++)
sb.append("[");
for (int i = 0; i < arrayType.dimensions(); i++) {
sb.append('[');
}
toSignature(sb, arrayType.component(), typeArgMapper, erased);
break;
case CLASS:
sb.append("L");
sb.append(type.asClassType().name().toString().replace('.', '/'));
sb.append(";");
sb.append('L').append(type.asClassType().name().toString('/')).append(';');
break;
case PARAMETERIZED_TYPE:
ParameterizedType parameterizedType = type.asParameterizedType();
sb.append("L");
// FIXME: support owner type
sb.append(parameterizedType.name().toString().replace('.', '/'));
Type owner = parameterizedType.owner();
if (owner != null && owner.kind() == Kind.PARAMETERIZED_TYPE) {
toSignature(sb, owner, typeArgMapper, erased);
// the typeSignature call on previous line always takes the PARAMETERIZED_TYPE branch,
// so at this point, result ends with a ';', which we just replace with '.'
assert sb.charAt(sb.length() - 1) == ';';
sb.setCharAt(sb.length() - 1, '.');
sb.append(parameterizedType.name().local());
} else {
sb.append('L').append(parameterizedType.name().toString('/'));
}
if (!erased && !parameterizedType.arguments().isEmpty()) {
sb.append("<");
List<Type> arguments = parameterizedType.arguments();
for (int i = 0; i < arguments.size(); i++) {
Type argType = arguments.get(i);
toSignature(sb, argType, typeArgMapper, erased);
sb.append('<');
for (Type argument : parameterizedType.arguments()) {
toSignature(sb, argument, typeArgMapper, erased);
}
sb.append(">");
sb.append('>');
}
sb.append(";");
sb.append(';');
break;
case PRIMITIVE:
Primitive primitive = type.asPrimitiveType().primitive();
Expand Down Expand Up @@ -233,22 +361,40 @@ private static void toSignature(StringBuilder sb, Type type, Function<String, St
case TYPE_VARIABLE:
TypeVariable typeVariable = type.asTypeVariable();
String mappedSignature = typeArgMapper.apply(typeVariable.identifier());
if (mappedSignature != null)
if (mappedSignature != null) {
sb.append(mappedSignature);
else if (erased)
} else if (erased) {
toSignature(sb, typeVariable.bounds().get(0), typeArgMapper, erased);
else
sb.append("T").append(typeVariable.identifier()).append(";");
} else {
sb.append('T').append(typeVariable.identifier()).append(';');
}
break;
case UNRESOLVED_TYPE_VARIABLE:
// FIXME: ??
UnresolvedTypeVariable unresolvedTypeVariable = type.asUnresolvedTypeVariable();
String mappedSignature2 = typeArgMapper.apply(unresolvedTypeVariable.identifier());
if (mappedSignature2 != null) {
sb.append(mappedSignature2);
} else if (erased) {
// TODO ???
} else {
sb.append("T").append(unresolvedTypeVariable.identifier()).append(";");
}
break;
case VOID:
sb.append("V");
sb.append('V');
break;
case WILDCARD_TYPE:
if (!erased) {
sb.append("*");
WildcardType wildcardType = type.asWildcardType();
if (wildcardType.superBound() != null) {
sb.append('-');
toSignature(sb, wildcardType.superBound(), typeArgMapper, erased);
} else if (ClassType.OBJECT_TYPE.equals(wildcardType.extendsBound())) {
sb.append('*');
} else {
sb.append('+');
toSignature(sb, wildcardType.extendsBound(), typeArgMapper, erased);
}
}
break;
default:
Expand Down
Loading

0 comments on commit 0948e42

Please sign in to comment.