Report the reason for a garbage collection when verbose GC is enabled.

runtime/vm/heap.cc

 // Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
 #include "vm/heap.h"
 
 #include "platform/assert.h"
 #include "platform/utils.h"
 #include "vm/compiler_stats.h"
 #include "vm/flags.h"
@@ skipping 160 matching lines @@
   ASSERT((raw_obj == Object::null()) ||
          (raw_obj->GetClassId() == kInstructionsCid));
   return reinterpret_cast<RawInstructions*>(raw_obj);
 }
 
 
 void Heap::CollectGarbage(Space space, ApiCallbacks api_callbacks) {
   bool invoke_api_callbacks = (api_callbacks == kInvokeApiCallbacks);
   switch (space) {
     case kNew:
-      new_space_->Scavenge(invoke_api_callbacks);
+      new_space_->Scavenge(invoke_api_callbacks, "new space");
       if (new_space_->HadPromotionFailure()) {
-        old_space_->MarkSweep(true);
+        old_space_->MarkSweep(true, "promotion failure");
       }
       break;
     case kOld:
-      old_space_->MarkSweep(invoke_api_callbacks);
+      old_space_->MarkSweep(invoke_api_callbacks, "old space");
       break;
     case kCode:
       UNIMPLEMENTED();
-      code_space_->MarkSweep(invoke_api_callbacks);
+      code_space_->MarkSweep(invoke_api_callbacks, "code space");

[siva, 2012/08/27 16:54:49]

Can we list these reasons in heap.h as static const char* fields. That way we
would have one spot to look for all reasons and people would not put some random
strings (lower case/upper case/missing spaces etc).

e.g:
static const char* new_space_full_ = "new space full";

and use Heap::new_space_full() in the code.

I think the strings could be a little more verbose
e.g "new space exhausted" instead of just "new space"

[Ivan Posva, 2012/08/27 22:04:23]

I like the suggestion of having the different reasons be collected in a central
place, but I am not sure they need to be more verbose.

       break;
     default:
       UNREACHABLE();
   }
   if (FLAG_verbose_gc) {
     PrintSizes();
   }
 }
 
 
 void Heap::CollectGarbage(Space space) {
   ApiCallbacks api_callbacks;
   if (space == kOld) {
     api_callbacks = kInvokeApiCallbacks;
   } else {
     api_callbacks = kIgnoreApiCallbacks;
   }
   CollectGarbage(space, api_callbacks);
 }
 
 
 void Heap::CollectAllGarbage() {
-  new_space_->Scavenge(kInvokeApiCallbacks);
-  old_space_->MarkSweep(kInvokeApiCallbacks);
+  new_space_->Scavenge(kInvokeApiCallbacks, "full");
+  old_space_->MarkSweep(kInvokeApiCallbacks, "full");
   // TODO(iposva): Merge old and code space.
-  // code_space_->MarkSweep(kInvokeApiCallbacks);
+  // code_space_->MarkSweep(kInvokeApiCallbacks, "full");
   if (FLAG_verbose_gc) {
     PrintSizes();
   }
 }
 
 
 void Heap::EnableGrowthControl() {
   old_space_->EnableGrowthControl();
 }
 
@@ skipping 110 matching lines @@
   isolate()->IncrementNoGCScopeDepth();
 }
 
 
 NoGCScope::~NoGCScope() {
   isolate()->DecrementNoGCScopeDepth();
 }
 #endif  // defined(DEBUG)
 
 }  // namespace dart