jdk-24/test/jdk/java/lang/instrument/NativeMethodPrefixApp.java

/*
 * Copyright (c) 2005, 2024, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */


import java.io.File;
import java.nio.file.Path;
import java.lang.management.*;
import java.util.zip.CRC32;

import bootreporter.*;
import jdk.test.lib.helpers.ClassFileInstaller;
import jdk.test.lib.process.OutputAnalyzer;
import jdk.test.lib.process.ProcessTools;

/*
 * @test
 * @bug 6263319
 * @summary test setNativeMethodPrefix
 * @requires ((vm.opt.StartFlightRecording == null) | (vm.opt.StartFlightRecording == false)) & ((vm.opt.FlightRecorder == null) | (vm.opt.FlightRecorder == false))
 * @modules java.management
 *          java.instrument
 * @library /test/lib
 * @build bootreporter.StringIdCallback bootreporter.StringIdCallbackReporter
 *        asmlib.Instrumentor NativeMethodPrefixAgent
 * @enablePreview
 * @comment The test uses asmlib/Instrumentor.java which relies on ClassFile API PreviewFeature.
 * @run driver/timeout=240 NativeMethodPrefixApp roleDriver
 * @comment The test uses a higher timeout to prevent test timeouts noted in JDK-6528548
 */
public class NativeMethodPrefixApp implements StringIdCallback {

    // This test is fragile like a golden file test.
    // It assumes that a specific non-native library method will call a specific
    // native method.  The below may need to be updated based on library changes.
    static String goldenNativeMethodName = "getStartupTime";

    static boolean[] gotIt = {false, false, false};

    public static void main(String[] args) throws Exception {
        if (args.length == 1) {
            if (!"roleDriver".equals(args[0])) {
                throw new Exception("unexpected program argument: " + args[0]);
            }
            // launch the NativeMethodPrefixApp java process after creating the necessary
            // infrastructure
            System.out.println("creating agent jar");
            final Path agentJar = createAgentJar();
            System.out.println("launching app, with javaagent jar: " + agentJar);
            launchApp(agentJar);
        } else {
            System.err.println("running app");
            new NativeMethodPrefixApp().run();
        }
    }

    private static Path createAgentJar() throws Exception {
        final String testClassesDir = System.getProperty("test.classes");
        final Path agentJar = Path.of("NativeMethodPrefixAgent.jar");
        final String manifest = """
                Manifest-Version: 1.0
                Premain-Class: NativeMethodPrefixAgent
                Can-Retransform-Classes: true
                Can-Set-Native-Method-Prefix: true
                """
                + "Boot-Class-Path: " + testClassesDir.replace(File.separatorChar, '/') + "/"
                + "\n";
        System.out.println("Manifest is:\n" + manifest);
        // create the agent jar
        ClassFileInstaller.writeJar(agentJar.getFileName().toString(),
                ClassFileInstaller.Manifest.fromString(manifest),
                "NativeMethodPrefixAgent",
                "asmlib.Instrumentor");
        return agentJar;
    }

    private static void launchApp(final Path agentJar) throws Exception {
        final OutputAnalyzer oa = ProcessTools.executeTestJava(
                "--enable-preview", // due to usage of ClassFile API PreviewFeature in the agent
                "-javaagent:" + agentJar.toString(),
                // We disable CheckIntrinsic because the NativeMethodPrefixAgent modifies
                // the native method names, which then causes a failure in the VM check
                // for the presence of an intrinsic on a @IntrinsicCandidate native method.
                "-XX:+UnlockDiagnosticVMOptions", "-XX:-CheckIntrinsics",
                NativeMethodPrefixApp.class.getName());
        oa.shouldHaveExitValue(0);
        // make available stdout/stderr in the logs, even in case of successful completion
        oa.reportDiagnosticSummary();
    }

    private void run() throws Exception {
        StringIdCallbackReporter.registerCallback(this);
        System.err.println("start");

        java.lang.reflect.Array.getLength(new short[5]);
        RuntimeMXBean mxbean = ManagementFactory.getRuntimeMXBean();
        System.err.println(mxbean.getVmVendor());
        // Simply load a class containing an @IntrinsicCandidate on a native method
        // to exercise the VM code which verifies the presence of the intrinsic
        // implementation for that method.
        System.err.println(new CRC32());

        NativeMethodPrefixAgent.checkErrors();

        for (int i = 0; i < gotIt.length; ++i) {
            if (!gotIt[i]) {
                throw new Exception("ERROR: Missing callback for transform " + i);
            }
        }
    }

    @Override
    public void tracker(String name, int id) {
        if (name.endsWith(goldenNativeMethodName)) {
            System.err.println("Tracked #" + id + ": MATCHED -- " + name);
            gotIt[id] = true;
        } else {
            System.err.println("Tracked #" + id + ": " + name);
        }
    }
}