Improved diagnostic message for JS heap out of memory

rnchamberlain · Commit bot · commit 1ef7487b657e · 2016-04-13T08:27:37.000Z
This patch replaces the unused 'take_snapshot' parameter on FatalProcessOutOfMemory() with a 'is_heap_oom' parameter. The parameter is set to true on error paths where the JS heap is out of memory, as distinct from a malloc() failure i.e. process out of memory. The message output to stderr or passed to embedding applications via FatalErrorCallback is 'Javascript heap out of memory' rather than 'process out of memory'. BUG= R=jochen@chromium.org, verwaest@chromium.org, michael_dawson@ca.ibm.com Review URL: https://codereview.chromium.org/1873443002 Cr-Commit-Position: refs/heads/master@{#35431}
diff --git a/src/api.cc b/src/api.cc
@@ -241,7 +241,7 @@ void i::FatalProcessOutOfMemory(const char* location) {
 
 // When V8 cannot allocated memory FatalProcessOutOfMemory is called.
 // The default fatal error handler is called and execution is stopped.
-void i::V8::FatalProcessOutOfMemory(const char* location, bool take_snapshot) {
+void i::V8::FatalProcessOutOfMemory(const char* location, bool is_heap_oom) {
   i::Isolate* isolate = i::Isolate::Current();
   char last_few_messages[Heap::kTraceRingBufferSize + 1];
   char js_stacktrace[Heap::kStacktraceBufferSize + 1];
@@ -303,7 +303,9 @@ void i::V8::FatalProcessOutOfMemory(const char* location, bool take_snapshot) {
     PrintF("\n<--- Last few GCs --->\n%s\n", first_newline);
     PrintF("\n<--- JS stacktrace --->\n%s\n", js_stacktrace);
   }
-  Utils::ApiCheck(false, location, "Allocation failed - process out of memory");
+  Utils::ApiCheck(false, location, is_heap_oom
+                  ? "Allocation failed - JavaScript heap out of memory"
+                  : "Allocation failed - process out of memory");
   // If the fatal error handler returns, we stop execution.
   FATAL("API fatal error handler returned after process out of memory");
 }
diff --git a/src/heap/heap.cc b/src/heap/heap.cc
@@ -3977,8 +3977,7 @@ AllocationResult Heap::AllocateUninitializedFixedDoubleArray(
 AllocationResult Heap::AllocateRawFixedDoubleArray(int length,
                                                    PretenureFlag pretenure) {
   if (length < 0 || length > FixedDoubleArray::kMaxLength) {
-    v8::internal::Heap::FatalProcessOutOfMemory("invalid array length",
-                                                kDoubleAligned);
+    v8::internal::Heap::FatalProcessOutOfMemory("invalid array length", true);
   }
   int size = FixedDoubleArray::SizeFor(length);
   AllocationSpace space = SelectSpace(pretenure);
@@ -5611,9 +5610,8 @@ void Heap::CompactRetainedMaps(ArrayList* retained_maps) {
   if (new_length != length) retained_maps->SetLength(new_length);
 }
 
-
-void Heap::FatalProcessOutOfMemory(const char* location, bool take_snapshot) {
-  v8::internal::V8::FatalProcessOutOfMemory(location, take_snapshot);
+void Heap::FatalProcessOutOfMemory(const char* location, bool is_heap_oom) {
+  v8::internal::V8::FatalProcessOutOfMemory(location, is_heap_oom);
 }
 
 #ifdef DEBUG
diff --git a/src/heap/heap.h b/src/heap/heap.h
@@ -566,7 +566,7 @@ class Heap {
   static inline bool IsOneByte(T t, int chars);
 
   static void FatalProcessOutOfMemory(const char* location,
-                                      bool take_snapshot = false);
+                                      bool is_heap_oom = false);
 
   static bool RootIsImmortalImmovable(int root_index);
 
diff --git a/src/heap/mark-compact.cc b/src/heap/mark-compact.cc
@@ -1728,8 +1728,8 @@ class MarkCompactCollector::EvacuateNewSpaceVisitor final
         compaction_spaces_->Get(OLD_SPACE)->AllocateRaw(size_in_bytes,
                                                         alignment);
     if (allocation.IsRetry()) {
-      FatalProcessOutOfMemory(
-          "MarkCompactCollector: semi-space copy, fallback in old gen\n");
+      v8::internal::Heap::FatalProcessOutOfMemory(
+          "MarkCompactCollector: semi-space copy, fallback in old gen", true);
     }
     return allocation;
   }
diff --git a/src/v8.h b/src/v8.h
@@ -21,7 +21,7 @@ class V8 : public AllStatic {
   // Report process out of memory. Implementation found in api.cc.
   // This function will not return, but will terminate the execution.
   static void FatalProcessOutOfMemory(const char* location,
-                                      bool take_snapshot = false);
+                                      bool is_heap_oom = false);
 
   static void InitializePlatform(v8::Platform* platform);
   static void ShutdownPlatform();

Original file line number	Diff line number	Diff line change
`@@ -3977,8 +3977,7 @@ AllocationResult Heap::AllocateUninitializedFixedDoubleArray(`
`3977`	`3977`	`AllocationResult Heap::AllocateRawFixedDoubleArray(int length,`
`3978`	`3978`	`PretenureFlag pretenure) {`
`3979`	`3979`	`if (length < 0 \|\| length > FixedDoubleArray::kMaxLength) {`
`3980`		`- v8::internal::Heap::FatalProcessOutOfMemory("invalid array length",`
`3981`		`- kDoubleAligned);`
	`3980`	`+ v8::internal::Heap::FatalProcessOutOfMemory("invalid array length", true);`
`3982`	`3981`	`}`
`3983`	`3982`	`int size = FixedDoubleArray::SizeFor(length);`
`3984`	`3983`	`AllocationSpace space = SelectSpace(pretenure);`
`@@ -5611,9 +5610,8 @@ void Heap::CompactRetainedMaps(ArrayList* retained_maps) {`
`5611`	`5610`	`if (new_length != length) retained_maps->SetLength(new_length);`
`5612`	`5611`	`}`
`5613`	`5612`
`5614`		`-`
`5615`		`-void Heap::FatalProcessOutOfMemory(const char* location, bool take_snapshot) {`
`5616`		`- v8::internal::V8::FatalProcessOutOfMemory(location, take_snapshot);`
	`5613`	`+void Heap::FatalProcessOutOfMemory(const char* location, bool is_heap_oom) {`
	`5614`	`+ v8::internal::V8::FatalProcessOutOfMemory(location, is_heap_oom);`
`5617`	`5615`	`}`
`5618`	`5616`
`5619`	`5617`	`#ifdef DEBUG`
Original file line number	Diff line number	Diff line change
`@@ -1728,8 +1728,8 @@ class MarkCompactCollector::EvacuateNewSpaceVisitor final`
`1728`	`1728`	`compaction_spaces_->Get(OLD_SPACE)->AllocateRaw(size_in_bytes,`
`1729`	`1729`	`alignment);`
`1730`	`1730`	`if (allocation.IsRetry()) {`
`1731`		`- FatalProcessOutOfMemory(`
`1732`		`- "MarkCompactCollector: semi-space copy, fallback in old gen\n");`
	`1731`	`+ v8::internal::Heap::FatalProcessOutOfMemory(`
	`1732`	`+ "MarkCompactCollector: semi-space copy, fallback in old gen", true);`
`1733`	`1733`	`}`
`1734`	`1734`	`return allocation;`
`1735`	`1735`	`}`