Skip to content

Commit 35279f0

Browse files
msridharmsridhar
authored
Fix JarInfer handling of generic types (#1078)
In particular, fix cases where the type of a method parameter either contains generic type arguments or is itself a type variable. These fixes are needed for #1072. We take advantage of the fact that even though `javac` erases generics, it stores full generic type signatures in class file attributes, which WALA is able to read. So we can recover generic type information from these attributes. We needed a bug fix from WALA for this to work, hence the WALA version bump. Not every case is supported here (e.g., we haven't tested generic methods). But these changes are enough to enable #1072 to move forward, after which we will have a single place to add features and fix bugs.
1 parent 933b1af commit 35279f0

File tree

6 files changed

+111
-36
lines changed

6 files changed

+111
-36
lines changed

‎gradle/dependencies.gradle‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ def versions = [
4848
// The version of Error Prone that NullAway is compiled and tested against
4949
errorProneApi : errorProneVersionToCompileAgainst,
5050
support : "27.1.1",
51-
wala : "1.6.7",
51+
wala : "1.6.9",
5252
commonscli : "1.4",
5353
autoValue : "1.10.2",
5454
autoService : "1.1.1",

‎jar-infer/jar-infer-lib/src/main/java/com/uber/nullaway/jarinfer/DefinitelyDerefedParamsDriver.java‎

Lines changed: 77 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@
4242
import com.ibm.wala.ssa.SSAInstruction;
4343
import com.ibm.wala.types.ClassLoaderReference;
4444
import com.ibm.wala.types.TypeReference;
45+
import com.ibm.wala.types.generics.MethodTypeSignature;
46+
import com.ibm.wala.types.generics.TypeSignature;
47+
import com.ibm.wala.types.generics.TypeVariableSignature;
4548
import com.ibm.wala.util.collections.Iterator2Iterable;
4649
import com.ibm.wala.util.config.FileOfClasses;
4750
import com.uber.nullaway.libmodel.MethodAnnotationsRecord;
@@ -505,36 +508,94 @@ private String getSignature(IMethod mtd) {
505508
* @param mtd Method reference.
506509
* @return String Method signature.
507510
*/
508-
// TODO: handle generics and inner classes
509511
private static String getAstubxSignature(IMethod mtd) {
510-
String classType =
511-
mtd.getDeclaringClass().getName().toString().replaceAll("/", "\\.").substring(1);
512-
classType = classType.replaceAll("\\$", "\\."); // handle inner class
513-
String returnType = mtd.isInit() ? null : getSimpleTypeName(mtd.getReturnType());
514-
String strArgTypes = "";
515-
int argi = mtd.isStatic() ? 0 : 1; // Skip 'this' parameter
516-
for (; argi < mtd.getNumberOfParameters(); argi++) {
517-
strArgTypes += getSimpleTypeName(mtd.getParameterType(argi));
518-
if (argi < mtd.getNumberOfParameters() - 1) {
519-
strArgTypes += ", ";
512+
Preconditions.checkArgument(
513+
mtd instanceof ShrikeCTMethod, "Method is not a ShrikeCTMethod from bytecodes");
514+
String classType = getSourceLevelQualifiedTypeName(mtd.getDeclaringClass().getReference());
515+
MethodTypeSignature genericSignature = null;
516+
try {
517+
genericSignature = ((ShrikeCTMethod) mtd).getMethodTypeSignature();
518+
} catch (InvalidClassFileException e) {
519+
// don't fail, just proceed without the generic signature
520+
LOG(DEBUG, "DEBUG", "Invalid class file exception: " + e.getMessage());
521+
}
522+
String returnType;
523+
int numParams = mtd.isStatic() ? mtd.getNumberOfParameters() : mtd.getNumberOfParameters() - 1;
524+
String[] argTypes = new String[numParams];
525+
if (genericSignature != null) {
526+
// get types that include generic type arguments
527+
returnType = getSourceLevelQualifiedTypeName(genericSignature.getReturnType().toString());
528+
TypeSignature[] argTypeSigs = genericSignature.getArguments();
529+
for (int i = 0; i < argTypeSigs.length; i++) {
530+
argTypes[i] = getSourceLevelQualifiedTypeName(argTypeSigs[i].toString());
531+
}
532+
} else { // no generics
533+
returnType = mtd.isInit() ? null : getSourceLevelQualifiedTypeName(mtd.getReturnType());
534+
int argi = mtd.isStatic() ? 0 : 1; // Skip 'this' parameter
535+
for (int i = 0; i < numParams; i++) {
536+
argTypes[i] = getSourceLevelQualifiedTypeName(mtd.getParameterType(argi++));
520537
}
521538
}
522539
return classType
523540
+ ":"
524541
+ (returnType == null ? "void " : returnType + " ")
525542
+ mtd.getName().toString()
526543
+ "("
527-
+ strArgTypes
544+
+ String.join(", ", argTypes)
528545
+ ")";
529546
}
530547

531548
/**
532-
* Get simple unqualified type name.
549+
* Get the source-level qualified type name for a TypeReference.
533550
*
534551
* @param typ Type Reference.
535-
* @return String Unqualified type name.
552+
* @return source-level qualified type name.
553+
* @see #getSourceLevelQualifiedTypeName(String)
554+
*/
555+
private static String getSourceLevelQualifiedTypeName(TypeReference typ) {
556+
String typeName = typ.getName().toString();
557+
return getSourceLevelQualifiedTypeName(typeName);
558+
}
559+
560+
/**
561+
* Converts a JVM-level qualified type (e.g., {@code Lcom/example/Foo$Baz;}) to a source-level
562+
* qualified type (e.g., {@code com.example.Foo.Baz}). Nested types like generic type arguments
563+
* are converted recursively.
564+
*
565+
* @param typeName JVM-level qualified type name.
566+
* @return source-level qualified type name.
536567
*/
537-
private static String getSimpleTypeName(TypeReference typ) {
538-
return StringStuff.jvmToBinaryName(typ.getName().toString());
568+
private static String getSourceLevelQualifiedTypeName(String typeName) {
569+
if (!typeName.endsWith(";")) {
570+
// we need the semicolon since some of WALA's TypeSignature APIs expect it
571+
typeName = typeName + ";";
572+
}
573+
boolean isGeneric = typeName.contains("<");
574+
if (!isGeneric) { // base case
575+
TypeSignature ts = TypeSignature.make(typeName);
576+
if (ts.isTypeVariable()) {
577+
// TypeVariableSignature's toString() returns more than just the identifier
578+
return ((TypeVariableSignature) ts).getIdentifier();
579+
} else {
580+
String tsStr = ts.toString();
581+
if (tsStr.endsWith(";")) {
582+
// remove trailing semicolon
583+
tsStr = tsStr.substring(0, tsStr.length() - 1);
584+
}
585+
return StringStuff.jvmToReadableType(tsStr);
586+
}
587+
} else { // generic type
588+
int idx = typeName.indexOf("<");
589+
String baseType = typeName.substring(0, idx);
590+
// generic type args are separated by semicolons in signature stored in bytecodes
591+
String[] genericTypeArgs = typeName.substring(idx + 1, typeName.length() - 2).split(";");
592+
for (int i = 0; i < genericTypeArgs.length; i++) {
593+
genericTypeArgs[i] = getSourceLevelQualifiedTypeName(genericTypeArgs[i]);
594+
}
595+
return getSourceLevelQualifiedTypeName(baseType)
596+
+ "<"
597+
+ String.join(",", genericTypeArgs)
598+
+ ">";
599+
}
539600
}
540601
}

‎jar-infer/jar-infer-lib/src/test/java/com/uber/nullaway/jarinfer/JarInferTest.java‎

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -448,8 +448,7 @@ public void testGenericMethod() throws Exception {
448448
"testGenericMethod",
449449
"generic",
450450
"TestGeneric",
451-
ImmutableMap.of(
452-
"generic.TestGeneric:java.lang.String foo(java.lang.Object)", Sets.newHashSet(0)),
451+
ImmutableMap.of("generic.TestGeneric:java.lang.String foo(T)", Sets.newHashSet(0)),
453452
"public class TestGeneric<T> {",
454453
" public String foo(T t) {",
455454
" return t.toString();",
@@ -461,6 +460,27 @@ public void testGenericMethod() throws Exception {
461460
"}");
462461
}
463462

463+
@Test
464+
public void testMethodWithGenericParameter() throws Exception {
465+
testTemplate(
466+
"testMethodWithGenericParameter",
467+
"generic",
468+
"TestGeneric",
469+
ImmutableMap.of(
470+
"generic.TestGeneric:java.lang.String getString(generic.TestGeneric.Generic<java.lang.String,java.lang.String>)",
471+
Sets.newHashSet(0)),
472+
"public class TestGeneric {",
473+
" static class Generic<T,U> {",
474+
" public String foo(T t) {",
475+
" return \"hi\";",
476+
" }",
477+
" }",
478+
" public String getString(Generic<String,String> g) {",
479+
" return g.foo(\"test\");",
480+
" }",
481+
"}");
482+
}
483+
464484
@Test
465485
public void toyJARAnnotatingClasses() throws Exception {
466486
testAnnotationInJarTemplate(

‎jar-infer/nullaway-integration-test/src/test/java/com/uber/nullaway/jarinfer/JarInferIntegrationTest.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ public void genericsTest() {
8888
" Toys.Generic<String> g = new Toys.Generic<>();",
8989
" // BUG: Diagnostic contains: passing @Nullable parameter 'null'",
9090
" g.getString(null);",
91+
" // BUG: Diagnostic contains: passing @Nullable parameter 'null'",
92+
" Toys.genericParam(null);",
9193
" }",
9294
"}")
9395
.doTest();

‎jar-infer/test-java-lib-jarinfer/src/main/java/com/uber/nullaway/jarinfer/toys/unannotated/Toys.java‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,10 @@ public String getString(T t) {
4343
}
4444
}
4545

46+
public static void genericParam(Generic<String> g) {
47+
g.getString("hello");
48+
}
49+
4650
public static void main(String arg[]) throws java.io.IOException {
4751
String s = "test string...";
4852
Foo f = new Foo("let's");

‎nullaway/src/main/java/com/uber/nullaway/handlers/InferredJARModelsHandler.java‎

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,6 @@
2727
import com.sun.source.tree.ExpressionTree;
2828
import com.sun.source.tree.Tree;
2929
import com.sun.tools.javac.code.Symbol;
30-
import com.sun.tools.javac.code.Type;
3130
import com.sun.tools.javac.util.Context;
3231
import com.uber.nullaway.NullAway;
3332
import com.uber.nullaway.Nullness;
@@ -38,7 +37,6 @@
3837
import java.util.Map;
3938
import java.util.Set;
4039
import javax.lang.model.element.Modifier;
41-
import javax.lang.model.type.TypeKind;
4240
import org.checkerframework.nullaway.dataflow.cfg.node.MethodInvocationNode;
4341
import org.jspecify.annotations.Nullable;
4442

@@ -230,27 +228,17 @@ private String getMethodSignature(Symbol.MethodSymbol method) {
230228
String methodSign =
231229
method.enclClass().getQualifiedName().toString()
232230
+ ":"
233-
+ (method.isStaticOrInstanceInit()
234-
? ""
235-
: getSimpleTypeName(method.getReturnType()) + " ")
231+
+ (method.isStaticOrInstanceInit() ? "" : method.getReturnType() + " ")
236232
+ method.getSimpleName()
237233
+ "(";
238234
if (!method.getParameters().isEmpty()) {
239-
for (Symbol.VarSymbol var : method.getParameters()) {
240-
methodSign += getSimpleTypeName(var.type) + ", ";
241-
}
242-
methodSign = methodSign.substring(0, methodSign.lastIndexOf(','));
235+
methodSign +=
236+
String.join(
237+
", ",
238+
method.getParameters().stream().map(p -> p.type.toString()).toArray(String[]::new));
243239
}
244240
methodSign += ")";
245241
LOG(DEBUG, "DEBUG", "@ method sign: " + methodSign);
246242
return methodSign;
247243
}
248-
249-
private String getSimpleTypeName(Type typ) {
250-
if (typ.getKind() == TypeKind.TYPEVAR) {
251-
return typ.getUpperBound().tsym.getQualifiedName().toString();
252-
} else {
253-
return typ.toString();
254-
}
255-
}
256244
}

0 commit comments

Comments
 (0)