8250627: Use -XX:+/-UseContainerSupport for enabling/disabling Java container metrics

jerboaa · jerboaa · commit e6517d1ae262 · 2020-07-24T19:57:06.000+02:00
Reviewed-by: aph, dholmes, bobv
diff --git a/make/hotspot/symbols/symbols-linux b/make/hotspot/symbols/symbols-linux
@@ -22,6 +22,7 @@
 #
 
 JVM_handle_linux_signal
+JVM_IsUseContainerSupport
 numa_error
 numa_warn
 sysThreadAvailableStackWithSlack
diff --git a/src/hotspot/share/include/jvm.h b/src/hotspot/share/include/jvm.h
@@ -158,6 +158,9 @@ JVM_MaxMemory(void);
 JNIEXPORT jint JNICALL
 JVM_ActiveProcessorCount(void);
 
+JNIEXPORT jboolean JNICALL
+JVM_IsUseContainerSupport(void);
+
 JNIEXPORT void * JNICALL
 JVM_LoadLibrary(const char *name);
 
diff --git a/src/hotspot/share/prims/jvm.cpp b/src/hotspot/share/prims/jvm.cpp
@@ -538,7 +538,15 @@ JVM_ENTRY_NO_ENV(jint, JVM_ActiveProcessorCount(void))
   return os::active_processor_count();
 JVM_END
 
-
+JVM_ENTRY_NO_ENV(jboolean, JVM_IsUseContainerSupport(void))
+  JVMWrapper("JVM_IsUseContainerSupport");
+#ifdef LINUX
+  if (UseContainerSupport) {
+    return JNI_TRUE;
+  }
+#endif
+  return JNI_FALSE;
+JVM_END
 
 // java.lang.Throwable //////////////////////////////////////////////////////
 
diff --git a/src/java.base/linux/classes/jdk/internal/platform/CgroupMetrics.java b/src/java.base/linux/classes/jdk/internal/platform/CgroupMetrics.java
@@ -160,7 +160,13 @@ public long getBlkIOServiced() {
     }
 
     public static Metrics getInstance() {
+        if (!isUseContainerSupport()) {
+            // Return null on -XX:-UseContainerSupport
+            return null;
+        }
         return CgroupSubsystemFactory.create();
     }
 
-}
+    private static native boolean isUseContainerSupport();
+
+}
diff --git a/src/java.base/linux/native/libjava/CgroupMetrics.c b/src/java.base/linux/native/libjava/CgroupMetrics.c
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2020, Red Hat, Inc.
+ * 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.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * 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.
+ */
+
+#include "jni.h"
+#include "jvm.h"
+
+#include "jdk_internal_platform_CgroupMetrics.h"
+
+JNIEXPORT jboolean JNICALL
+Java_jdk_internal_platform_CgroupMetrics_isUseContainerSupport(JNIEnv *env, jclass ignored)
+{
+    return JVM_IsUseContainerSupport();
+}
diff --git a/test/jdk/jdk/internal/platform/docker/CheckUseContainerSupport.java b/test/jdk/jdk/internal/platform/docker/CheckUseContainerSupport.java
@@ -0,0 +1,46 @@
+/*
+ * Copyright (c) 2020, Red Hat, Inc.
+ * 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 jdk.internal.platform.Metrics;
+
+public class CheckUseContainerSupport {
+
+    // Usage: boolean value of -XX:+/-UseContainerSupport
+    //        passed as the only argument
+    public static void main(String[] args) throws Exception {
+        if (args.length != 1) {
+            throw new RuntimeException("Expected only one boolean argument");
+        }
+        boolean expectedContainerSupport = Boolean.parseBoolean(args[0]);
+        boolean actualContainerSupport = (Metrics.systemMetrics() != null);
+        if (expectedContainerSupport != actualContainerSupport) {
+            String msg = "-XX:" + ( expectedContainerSupport ? "+" : "-") + "UseContainerSupport, but got " +
+                         "Metrics.systemMetrics() == " + (Metrics.systemMetrics() == null ? "null" : "non-null");
+            System.out.println(msg);
+            System.out.println("TEST FAILED!!!");
+            return;
+        }
+        System.out.println("TEST PASSED!!!");
+    }
+
+}
diff --git a/test/jdk/jdk/internal/platform/docker/TestUseContainerSupport.java b/test/jdk/jdk/internal/platform/docker/TestUseContainerSupport.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright (c) 2020, Red Hat, Inc.
+ * 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.
+ */
+
+/*
+ * @test
+ * @summary UseContainerSupport flag should reflect Metrics being available
+ * @requires docker.support
+ * @library /test/lib
+ * @modules java.base/jdk.internal.platform
+ * @build CheckUseContainerSupport
+ * @run main/timeout=360 TestUseContainerSupport
+ */
+
+import jdk.test.lib.Utils;
+import jdk.test.lib.containers.docker.Common;
+import jdk.test.lib.containers.docker.DockerRunOptions;
+import jdk.test.lib.containers.docker.DockerTestUtils;
+
+public class TestUseContainerSupport {
+    private static final String imageName = Common.imageName("useContainerSupport");
+
+    public static void main(String[] args) throws Exception {
+        if (!DockerTestUtils.canTestDocker()) {
+            return;
+        }
+
+        DockerTestUtils.buildJdkDockerImage(imageName, "Dockerfile-BasicTest", "jdk-docker");
+
+        try {
+            testUseContainerSupport(true);
+            testUseContainerSupport(false);
+        } finally {
+            DockerTestUtils.removeDockerImage(imageName);
+        }
+    }
+
+    private static void testUseContainerSupport(boolean useContainerSupport) throws Exception {
+        String testMsg = " with -XX:" + (useContainerSupport ? "+" : "-") + "UseContainerSupport";
+        Common.logNewTestCase("Test TestUseContainerSupport" + testMsg);
+        DockerRunOptions opts =
+                new DockerRunOptions(imageName, "/jdk/bin/java", "CheckUseContainerSupport");
+        opts.addClassOptions(Boolean.valueOf(useContainerSupport).toString());
+        opts.addDockerOpts("--memory", "200m")
+            .addDockerOpts("--volume", Utils.TEST_CLASSES + ":/test-classes/");
+        if (useContainerSupport) {
+            opts.addJavaOpts("-XX:+UseContainerSupport");
+        } else {
+            opts.addJavaOpts("-XX:-UseContainerSupport");
+        }
+        opts.addJavaOpts("-cp", "/test-classes/");
+        opts.addJavaOpts("--add-exports", "java.base/jdk.internal.platform=ALL-UNNAMED");
+        DockerTestUtils.dockerRunJava(opts).shouldHaveExitValue(0).shouldContain("TEST PASSED!!!");
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@`
`22`	`22`	`#`
`23`	`23`
`24`	`24`	`JVM_handle_linux_signal`
	`25`	`+JVM_IsUseContainerSupport`
`25`	`26`	`numa_error`
`26`	`27`	`numa_warn`
`27`	`28`	`sysThreadAvailableStackWithSlack`
Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,13 @@ public long getBlkIOServiced() {`
`160`	`160`	`}`
`161`	`161`
`162`	`162`	`public static Metrics getInstance() {`
	`163`	`+ if (!isUseContainerSupport()) {`
	`164`	`+ // Return null on -XX:-UseContainerSupport`
	`165`	`+ return null;`
	`166`	`+ }`
`163`	`167`	`return CgroupSubsystemFactory.create();`
`164`	`168`	`}`
`165`	`169`
`166`		`-}`
	`170`	`+ private static native boolean isUseContainerSupport();`
	`171`	`+`
	`172`	`+}`