• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2014 The Android Open Source Project
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *      http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef ART_RUNTIME_GC_GC_CAUSE_H_
18 #define ART_RUNTIME_GC_GC_CAUSE_H_
19 
20 #include <iosfwd>
21 
22 #include "base/macros.h"
23 
24 namespace art HIDDEN {
25 namespace gc {
26 
27 // What caused the GC?
28 enum GcCause {
29   // Invalid GC cause used as a placeholder.
30   kGcCauseNone,
31   // GC triggered by a failed allocation. Thread doing allocation is blocked waiting for GC before
32   // retrying allocation.
33   kGcCauseForAlloc,
34   // A background GC trying to ensure there is free memory ahead of allocations.
35   kGcCauseBackground,
36   // An explicit System.gc() call.
37   kGcCauseExplicit,
38   // GC triggered for a native allocation when NativeAllocationGcWatermark is exceeded.
39   // (This may be a blocking GC depending on whether we run a non-concurrent collector).
40   kGcCauseForNativeAlloc,
41   // GC triggered for a collector transition.
42   kGcCauseCollectorTransition,
43   // Not a real GC cause, used when we disable moving GC (currently for GetPrimitiveArrayCritical).
44   kGcCauseDisableMovingGc,
45   // Not a real GC cause, used when we trim the heap.
46   kGcCauseTrim,
47   // Not a real GC cause, used to implement exclusion between GC and instrumentation.
48   kGcCauseInstrumentation,
49   // Not a real GC cause, used to add or remove app image spaces.
50   kGcCauseAddRemoveAppImageSpace,
51   // Not a real GC cause, used to implement exclusion between GC and debugger.
52   kGcCauseDebugger,
53   // GC triggered for background transition when both foreground and background collector are CMS.
54   kGcCauseHomogeneousSpaceCompact,
55   // Class linker cause, used to guard filling art methods with special values.
56   kGcCauseClassLinker,
57   // Not a real GC cause, used to implement exclusion between code cache metadata and GC.
58   kGcCauseJitCodeCache,
59   // Not a real GC cause, used to add or remove system-weak holders.
60   kGcCauseAddRemoveSystemWeakHolder,
61   // Not a real GC cause, used to prevent hprof running in the middle of GC.
62   kGcCauseHprof,
63   // Not a real GC cause, used to prevent GetObjectsAllocated running in the middle of GC.
64   kGcCauseGetObjectsAllocated,
65   // GC cause for the profile saver.
66   kGcCauseProfileSaver,
67   // GC cause for deleting dex cache arrays at startup.
68   kGcCauseDeletingDexCacheArrays,
69 };
70 
71 const char* PrettyCause(GcCause cause);
72 std::ostream& operator<<(std::ostream& os, const GcCause& gc_cause);
73 
74 }  // namespace gc
75 }  // namespace art
76 
77 #endif  // ART_RUNTIME_GC_GC_CAUSE_H_
78