src/test/java/com/android/tools/r8/ir/optimize/instanceofremoval/InstanceOfRemovalTest.java

// Copyright (c) 2018, the R8 project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

package com.android.tools.r8.ir.optimize.instanceofremoval;

import static org.junit.Assert.assertEquals;

import com.android.tools.r8.NeverInline;
import com.android.tools.r8.TestBase;
import com.android.tools.r8.TestParameters;
import com.android.tools.r8.utils.StringUtils;
import com.android.tools.r8.utils.codeinspector.ClassSubject;
import com.android.tools.r8.utils.codeinspector.CodeInspector;
import com.android.tools.r8.utils.codeinspector.InstructionSubject;
import com.android.tools.r8.utils.codeinspector.MethodSubject;
import com.google.common.collect.Streams;
import java.util.Iterator;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;

@RunWith(Parameterized.class)
public class InstanceOfRemovalTest extends TestBase {

  static class A {}

  static class B extends A {}

  static class TestClass {

    public static void main(String[] args) {
      foo();
      bar();
    }

    @NeverInline
    private static void foo() {
      System.out.println("A instanceof A: " + (getAForFoo() instanceof A));
      System.out.println("A instanceof B: " + (getAForFoo() instanceof B));
      System.out.println("B instanceof A: " + (getBForFoo() instanceof A));
      System.out.println("B instanceof B: " + (getBForFoo() instanceof B));
      System.out.println("null instanceof A: " + (getNullForFoo() instanceof A));
      System.out.println("null instanceof B: " + (getNullForFoo() instanceof B));
      System.out.println("A[] instanceof A[]: " + (getAarrayForFoo() instanceof A[]));
      System.out.println("A[] instanceof B[]: " + (getAarrayForFoo() instanceof B[]));
      System.out.println("B[] instanceof A[]: " + (getBarrayForFoo() instanceof A[]));
      System.out.println("B[] instanceof B[]: " + (getBarrayForFoo() instanceof B[]));
    }

    public static A getAForFoo() {
      return new A();
    }

    public static A[] getAarrayForFoo() {
      return new A[] { };
    }

    public static A getBForFoo() {
      return new B();
    }

    public static A[] getBarrayForFoo() {
      return new B[0];
    }

    public static A getNullForFoo() { return null; }

    @NeverInline
    private static void bar() {
      System.out.println("A instanceof A: " + (getAForBar() instanceof A));
      System.out.println("A instanceof B: " + (getAForBar() instanceof B));
      System.out.println("B instanceof A: " + (getBForBar() instanceof A));
      System.out.println("B instanceof B: " + (getBForBar() instanceof B));
      System.out.println("null instanceof A: " + (getNullForBar(true) instanceof A));
      System.out.println("null instanceof B: " + (getNullForBar(true) instanceof B));
      System.out.println("A[] instanceof A[]: " + (getAarrayForBar() instanceof A[]));
      System.out.println("A[] instanceof B[]: " + (getAarrayForBar() instanceof B[]));
      System.out.println("B[] instanceof A[]: " + (getBarrayForBar() instanceof A[]));
      System.out.println("B[] instanceof B[]: " + (getBarrayForBar() instanceof B[]));
    }

    @NeverInline
    public static A getAForBar() {
      return new A();
    }

    @NeverInline
    public static A[] getAarrayForBar() {
      return new A[] { new A(), new B() };
    }

    @NeverInline
    public static A getBForBar() {
      return new B();
    }

    @NeverInline
    public static A[] getBarrayForBar() {
      return new B[0];
    }

    @NeverInline
    public static A getNullForBar(boolean returnNull) {
      // Avoid `return null` since we will then use the fact that getNullForBar() always returns
      // null at the call site.
      return returnNull ? null : new A();
    }
  }

  @Parameters(name = "{0}")
  public static List<Object[]> data() {
    return buildParameters(getTestParameters().withAllRuntimesAndApiLevels().build());
  }

  private final TestParameters parameters;

  public InstanceOfRemovalTest(TestParameters parameters) {
    this.parameters = parameters;
  }

  @Test
  public void test() throws Exception {
    String expected =
        StringUtils.joinLines(
            "A instanceof A: true",
            "A instanceof B: false",
            "B instanceof A: true",
            "B instanceof B: true",
            "null instanceof A: false",
            "null instanceof B: false",
            "A[] instanceof A[]: true",
            "A[] instanceof B[]: false",
            "B[] instanceof A[]: true",
            "B[] instanceof B[]: true",
            "A instanceof A: true",
            "A instanceof B: false",
            "B instanceof A: true",
            "B instanceof B: true",
            "null instanceof A: false",
            "null instanceof B: false",
            "A[] instanceof A[]: true",
            "A[] instanceof B[]: false",
            "B[] instanceof A[]: true",
            "B[] instanceof B[]: true",
            "");

    if (parameters.isCfRuntime()) {
      testForJvm()
          .addTestClasspath()
          .run(parameters.getRuntime(), TestClass.class)
          .assertSuccessWithOutput(expected);
    }

    CodeInspector inspector =
        testForR8(parameters.getBackend())
            .addProgramClasses(A.class, B.class, TestClass.class)
            .addKeepMainRule(TestClass.class)
            .enableInliningAnnotations()
            .setMinApi(parameters.getApiLevel())
            .run(parameters.getRuntime(), TestClass.class)
            .assertSuccessWithOutput(expected)
            .inspector();

    ClassSubject testClass = inspector.clazz(TestClass.class);

    // With inlining we can prove that all instance-of checks succeed or fail.
    MethodSubject fooMethodSubject = testClass.uniqueMethodWithName("foo");
    Iterator<InstructionSubject> fooInstructionIterator =
        fooMethodSubject.iterateInstructions(InstructionSubject::isInstanceOf);
    assertEquals(0, Streams.stream(fooInstructionIterator).count());

    // Without inlining we cannot prove any of the instance-of checks to be trivial, but the dynamic
    // type optimization allows us to prove that some are safe.
    MethodSubject barMethodSubject = testClass.uniqueMethodWithName("bar");
    Iterator<InstructionSubject> barInstructionIterator =
        barMethodSubject.iterateInstructions(InstructionSubject::isInstanceOf);
    assertEquals(4, Streams.stream(barInstructionIterator).count());
  }
}