2271-profile-inline-cache/src/Main.java

/*
 * Copyright (C) 2023 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import java.io.File;
import java.io.IOException;
import java.lang.reflect.Method;
import java.util.Arrays;
import java.util.stream.Collectors;

public class Main {
    private static File sFile = null;
    private static Method sMethod1 = null;
    private static Method sMethod2 = null;
    private static Method sMethod3 = null;
    private static Method sMethod4 = null;
    private static Method sMethod5 = null;

    public static void main(String[] args) throws Exception {
        System.loadLibrary(args[0]);

        if (!hasJit()) {
            // Test requires JIT for creating profiling infos.
            return;
        }

        sMethod1 = Main.class.getDeclaredMethod("$noinline$method1", Base.class);
        sMethod2 = Main.class.getDeclaredMethod("$noinline$method2", Base.class);
        sMethod3 = Main.class.getDeclaredMethod("$noinline$method3", Base.class);
        sMethod4 = Main.class.getDeclaredMethod("$noinline$method4", Base.class);
        sMethod5 = Main.class.getDeclaredMethod("$noinline$method5", Base.class);

        sFile = createTempFile();
        sFile.deleteOnExit();
        String codePath = System.getenv("DEX_LOCATION") + "/2271-profile-inline-cache.jar";
        VMRuntime.registerAppInfo("test.app", sFile.getPath(), sFile.getPath(),
                new String[] {codePath}, VMRuntime.CODE_PATH_TYPE_PRIMARY_APK);

        for (int i = 0; i < 10; i++) {
            try {
                test();
                return;
            } catch (ScopedAssertNoGc.NoGcAssertionFailure e) {
                // This should rarely happen. When it happens, reset the state, delete the profile,
                // and try again.
                reset();
                sFile.delete();
            }
        }

        // The possibility of hitting this line only exists in theory, unless the test is wrong.
        throw new RuntimeException("NoGcAssertionFailure occurred 10 times");
    }

    private static void test() throws Exception {
        Derived1 derived1 = new Derived1();
        Derived2 derived2 = new Derived2();

        // This method is below the inline cache threshold.
        ensureJitBaselineCompiled(sMethod1);
        try (ScopedAssertNoGc noGc = new ScopedAssertNoGc()) {
            $noinline$method1(derived1);
            for (int i = 0; i < 2998; i++) {
                $noinline$method1(derived2);
            }
        }
        checkMethodHasNoInlineCache(sFile, sMethod1);

        // This method is right on the inline cache threshold.
        ensureJitBaselineCompiled(sMethod2);
        try (ScopedAssertNoGc noGc = new ScopedAssertNoGc()) {
            $noinline$method2(derived1);
            for (int i = 0; i < 2999; i++) {
                $noinline$method2(derived2);
            }
        }
        checkMethodHasInlineCache(sFile, sMethod2, Derived1.class, Derived2.class);

        // This method is above the inline cache threshold.
        ensureJitBaselineCompiled(sMethod3);
        try (ScopedAssertNoGc noGc = new ScopedAssertNoGc()) {
            for (int i = 0; i < 10000; i++) {
                $noinline$method3(derived1);
            }
            for (int i = 0; i < 10000; i++) {
                $noinline$method3(derived2);
            }
        }
        checkMethodHasInlineCache(sFile, sMethod3, Derived1.class, Derived2.class);

        // This method is above the JIT threshold.
        ensureJitBaselineCompiled(sMethod4);
        try (ScopedAssertNoGc noGc = new ScopedAssertNoGc()) {
            $noinline$method4(derived1);
            $noinline$method4(derived2);
        }
        ensureMethodJitCompiled(sMethod4);
        checkMethodHasInlineCache(sFile, sMethod4, Derived1.class, Derived2.class);

        // This method is above the JIT threshold.
        ensureJitBaselineCompiled(sMethod5);
        try (ScopedAssertNoGc noGc = new ScopedAssertNoGc()) {
            $noinline$method5(derived1);
            $noinline$method5(derived2);
        }
        ensureMethodJitCompiled(sMethod5);
        // We currently do not encode inlined inline caches.
        checkMethodHasNoInlineCache(sFile, sMethod5);
    }

    private static void reset() {
        removeJitCompiledMethod(sMethod1, false /* releaseMemory */);
        removeJitCompiledMethod(sMethod2, false /* releaseMemory */);
        removeJitCompiledMethod(sMethod3, false /* releaseMemory */);
        removeJitCompiledMethod(sMethod4, false /* releaseMemory */);
    }

    public static void $noinline$method1(Base obj) {
        obj.f();
    }

    public static void $noinline$method2(Base obj) {
        obj.f();
    }

    public static void $noinline$method3(Base obj) {
        obj.f();
    }

    public static void $noinline$method4(Base obj) {
        obj.f();
    }

    public static void $noinline$method5(Base obj) {
        $inline$callF(obj);
    }

    public static void $inline$callF(Base obj) {
      obj.f();
    }

    public static class Base {
        public void f() {}
    }

    public static class Derived1 extends Base {
        @Override
        public void f() {}
    }

    public static class Derived2 extends Base {
        @Override
        public void f() {}
    }

    private static void checkMethodHasInlineCache(File file, Method m, Class<?>... targetTypes) {
        ensureProfileProcessing();
        if (!hasInlineCacheInProfile(file.getPath(), m, targetTypes)) {
            throw new RuntimeException("Expected method " + m
                    + " to have inline cache in the profile with target types "
                    + Arrays.stream(targetTypes)
                              .map(Class::getName)
                              .collect(Collectors.joining(", ")));
        }
    }

    private static void checkMethodHasNoInlineCache(File file, Method m) {
        ensureProfileProcessing();
        if (hasInlineCacheInProfile(file.getPath(), m)) {
            throw new RuntimeException(
                    "Expected method " + m + " not to have inline cache in the profile");
        }
    }

    public static void ensureJitBaselineCompiled(Method method) {
        ensureJitBaselineCompiled(method.getDeclaringClass(), method.getName());
    }
    public static native void ensureMethodJitCompiled(Method method);
    public static native void ensureJitBaselineCompiled(Class<?> cls, String methodName);
    public static native void ensureProfileProcessing();
    public static native boolean hasInlineCacheInProfile(
            String profile, Method method, Class<?>... targetTypes);
    public static native boolean hasJit();
    public static native int getCurrentGcNum();
    public static native boolean removeJitCompiledMethod(Method method, boolean releaseMemory);

    private static final String TEMP_FILE_NAME_PREFIX = "temp";
    private static final String TEMP_FILE_NAME_SUFFIX = "-file";

    private static File createTempFile() throws Exception {
        try {
            return File.createTempFile(TEMP_FILE_NAME_PREFIX, TEMP_FILE_NAME_SUFFIX);
        } catch (IOException e) {
            System.setProperty("java.io.tmpdir", "/data/local/tmp");
            try {
                return File.createTempFile(TEMP_FILE_NAME_PREFIX, TEMP_FILE_NAME_SUFFIX);
            } catch (IOException e2) {
                System.setProperty("java.io.tmpdir", "/sdcard");
                return File.createTempFile(TEMP_FILE_NAME_PREFIX, TEMP_FILE_NAME_SUFFIX);
            }
        }
    }

    private static class VMRuntime {
        public static final int CODE_PATH_TYPE_PRIMARY_APK = 1 << 0;
        private static final Method registerAppInfoMethod;

        static {
            try {
                Class<? extends Object> c = Class.forName("dalvik.system.VMRuntime");
                registerAppInfoMethod = c.getDeclaredMethod("registerAppInfo", String.class,
                        String.class, String.class, String[].class, int.class);
            } catch (Exception e) {
                throw new RuntimeException(e);
            }
        }

        public static void registerAppInfo(String packageName, String curProfile, String refProfile,
                String[] codePaths, int codePathsType) throws Exception {
            registerAppInfoMethod.invoke(
                    null, packageName, curProfile, refProfile, codePaths, codePathsType);
        }
    }

    // This scope is intended to guard code that doesn't expect GC to take place. Because we can't
    // really prevent GC in Java code (calling a native method that enters a GCCriticalSection will
    // cause the runtime to hang forever when transitioning from native back to Java), this is a
    // workaround that forces a GC at the beginning so that GC will unlikely take place within the
    // scope. If a GC still takes place within the scope, this will throw NoGcAssertionFailure.
    //
    // The baseline code doesn't update the inline cache if we are marking, so we use this scope to
    // guard calls to virtual methods for which we want inline cache to be updated.
    private static class ScopedAssertNoGc implements AutoCloseable {
        private final int mLastGcNum;

        public ScopedAssertNoGc() {
            System.gc();
            mLastGcNum = getCurrentGcNum();
        }

        @Override
        public void close() throws NoGcAssertionFailure {
            int currentGcNum = getCurrentGcNum();
            if (currentGcNum != mLastGcNum) {
                throw new NoGcAssertionFailure(
                        String.format("GC happened within the scope (before: %d, after: %d)",
                                mLastGcNum, currentGcNum));
            }
        }

        public static class NoGcAssertionFailure extends Exception {
            public NoGcAssertionFailure(String message) {
                super(message);
            }
        }
    }
}