Changeset 263290 in webkit

Timestamp:

Jun 19, 2020, 3:13:47 PM (6 years ago)

Author:

sbarati@apple.com

Message:

Have a memory monitor thread in jsc shell when running tests using --memory-limited
​https://bugs.webkit.org/show_bug.cgi?id=213389

Reviewed by Mark Lam.

Source/JavaScriptCore:

When testing on iOS, there are times high memory usage from a JSC test
will jetsam our entire test runner. This makes it so we don't get any test
results from that test run, which can make it difficult to track testing
results.

This patch introduces an optional memory monitoring thread to the JSC
shell. It's a best effort approach. If memory usage exceeds the passed
in threshold, we crash the process. Similar to how the timeout mechanism
works. On Cocoa platforms, we also perform this check in the low memory
warning handler.

Currently, we use this feature when running JSC stress tests in
"--memory-limited" mode.

• jsc.cpp:

(crashIfExceedingMemoryLimit):
(startMemoryMonitoringThreadIfNeeded):
(jscmain):

Tools:

• Scripts/run-jsc-stress-tests:
• Scripts/webkitruby/jsc-stress-test-writer-default.rb:
• Scripts/webkitruby/jsc-stress-test-writer-ruby.rb:

Location:

trunk

Files:

• Source/JavaScriptCore/ChangeLog (modified) (1 diff)
• Source/JavaScriptCore/jsc.cpp (modified) (3 diffs)
• Tools/ChangeLog (modified) (1 diff)
• Tools/Scripts/run-jsc-stress-tests (modified) (2 diffs)
• Tools/Scripts/webkitruby/jsc-stress-test-writer-default.rb (modified) (1 diff)
• Tools/Scripts/webkitruby/jsc-stress-test-writer-ruby.rb (modified) (1 diff)

trunk/Source/JavaScriptCore/ChangeLog

@@ +1 @@
+2020-06-19  Saam Barati  <sbarati@apple.com>
+
+        Have a memory monitor thread in jsc shell when running tests using --memory-limited
+        https://bugs.webkit.org/show_bug.cgi?id=213389
+
+        Reviewed by Mark Lam.
+
+        When testing on iOS, there are times high memory usage from a JSC test
+        will jetsam our entire test runner. This makes it so we don't get any test
+        results from that test run, which can make it difficult to track testing
+        results.
+        
+        This patch introduces an optional memory monitoring thread to the JSC
+        shell. It's a best effort approach. If memory usage exceeds the passed
+        in threshold, we crash the process. Similar to how the timeout mechanism
+        works. On Cocoa platforms, we also perform this check in the low memory 
+        warning handler.
+        
+        Currently, we use this feature when running JSC stress tests in
+        "--memory-limited" mode.
+
+        * jsc.cpp:
+        (crashIfExceedingMemoryLimit):
+        (startMemoryMonitoringThreadIfNeeded):
+        (jscmain):
+
 2020-06-19  Mark Lam  <mark.lam@apple.com>
 

trunk/Source/JavaScriptCore/jsc.cpp

@@ -2497 +2497 @@
 int jscmain(int argc, char** argv);
 
+#if OS(DARWIN) || OS(LINUX)
+static size_t memoryLimit;
+
+static void crashIfExceedingMemoryLimit()
+{
+    if (!memoryLimit)
+        return;
+    MemoryFootprint footprint = MemoryFootprint::now();
+    if (footprint.current > memoryLimit) {
+        dataLogLn("Crashing because current footprint: ", footprint.current, " exceeds limit: ", memoryLimit);
+        CRASH();
+    }
+}
+
+static void startMemoryMonitoringThreadIfNeeded()
+{
+    char* memoryLimitString = getenv("JSCTEST_memoryLimit");
+    if (!memoryLimitString)
+        return;
+
+    if (sscanf(memoryLimitString, "%zu", &memoryLimit) != 1) {
+        dataLogLn("WARNING: malformed JSCTEST_memoryLimit environment variable");
+        return;
+    }
+
+    if (!memoryLimit)
+        return;
+
+    Thread::create("jsc Memory Monitor", [=] {
+        while (true) {
+            sleep(Seconds::fromMilliseconds(5));
+            crashIfExceedingMemoryLimit();
+        }
+    });
+}
+#endif // OS(DARWIN) || OS(LINUX)
+
 static double s_desiredTimeout;
 static double s_timeoutMultiplier = 1.0;
@@ -3254 +3291 @@
     initializeTimeoutIfNeeded();
 
+#if OS(DARWIN) || OS(LINUX)
+    startMemoryMonitoringThreadIfNeeded();
+#endif
+
     if (Options::useSuperSampler())
         enableSuperSampler();
@@ -3277 +3318 @@
     Box<Synchronous> memoryPressureSynchronousState = Box<Synchronous>::create(Synchronous::No);
     memoryPressureHandler.setLowMemoryHandler([=] (Critical critical, Synchronous synchronous) {
+        crashIfExceedingMemoryLimit();
+
         // We set these racily with respect to reading them from the JS execution thread.
         *memoryPressureCriticalState = critical;

trunk/Tools/ChangeLog

@@ +1 @@
+2020-06-19  Saam Barati  <sbarati@apple.com>
+
+        Have a memory monitor thread in jsc shell when running tests using --memory-limited
+        https://bugs.webkit.org/show_bug.cgi?id=213389
+
+        Reviewed by Mark Lam.
+
+        * Scripts/run-jsc-stress-tests:
+        * Scripts/webkitruby/jsc-stress-test-writer-default.rb:
+        * Scripts/webkitruby/jsc-stress-test-writer-ruby.rb:
+
 2020-06-19  Chris Fleizach  <cfleizach@apple.com>
 

trunk/Tools/Scripts/run-jsc-stress-tests

@@ -2092 +2092 @@
         remoteScript += "export LD_LIBRARY_PATH=#{remoteHost.remoteDirectory}/#{$outputDir.basename}/#{$jscPath.dirname} && "
         remoteScript += "export JSCTEST_timeout=#{Shellwords.shellescape(ENV['JSCTEST_timeout'])} && "
+        remoteScript += "export JSCTEST_memoryLimit=#{Shellwords.shellescape(ENV['JSCTEST_memoryLimit'])} && "
         remoteScript += "export TZ=#{Shellwords.shellescape(ENV['TZ'])} && "
         $envVars.each { |var| remoteScript += "export " << var << "\n" }
@@ -2224 +2225 @@
 end
 
+if !ENV["JSCTEST_memoryLimit"] && $memoryLimited
+    ENV["JSCTEST_memoryLimit"] = (600 * 1024 * 1024).to_s
+end
+
 # Some tests fail if the time zone is not set to US/Pacific
 # https://webkit.org/b/136363

trunk/Tools/Scripts/webkitruby/jsc-stress-test-writer-default.rb

@@ -257 +257 @@
         script += "export DYLD_FRAMEWORK_PATH=$(cd #{$testingFrameworkPath.dirname}; pwd)\n"
         script += "export JSCTEST_timeout=#{Shellwords.shellescape(ENV['JSCTEST_timeout'])}\n"
+        script += "export JSCTEST_memoryLimit=#{Shellwords.shellescape(ENV['JSCTEST_memoryLimit'])}\n"
         $envVars.each { |var| script += "export " << var << "\n" }
         script += "#{shellCommand} || exit 1"

trunk/Tools/Scripts/webkitruby/jsc-stress-test-writer-ruby.rb

@@ -314 +314 @@
         script += "            ENV[\"DYLD_FRAMEWORK_PATH\"] = \"#{$testingFrameworkPath.dirname}\"\n"
         script += "            ENV[\"JSCTEST_timeout\"] = \"#{ENV['JSCTEST_timeout']}\"\n"
+        script += "            ENV[\"JSCTEST_memoryLimit\"] = \"#{ENV['JSCTEST_memoryLimit']}\"\n"
 
         script += "            #{shellCommand}"