1 /*
2  * Copyright (C) 2013 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_COLLECTOR_TYPE_H_
18 #define ART_RUNTIME_GC_COLLECTOR_TYPE_H_
19 
20 #include <iosfwd>
21 
22 namespace art {
23 namespace gc {
24 
25 // Which types of collections are able to be performed.
26 enum CollectorType {
27   // No collector selected.
28   kCollectorTypeNone,
29   // Non concurrent mark-sweep.
30   kCollectorTypeMS,
31   // Concurrent mark-sweep.
32   kCollectorTypeCMS,
33   // Semi-space / mark-sweep hybrid, enables compaction.
34   kCollectorTypeSS,
35   // Heap trimming collector, doesn't do any actual collecting.
36   kCollectorTypeHeapTrim,
37   // A (mostly) concurrent copying collector.
38   kCollectorTypeCC,
39   // The background compaction of the concurrent copying collector.
40   kCollectorTypeCCBackground,
41   // Instrumentation critical section fake collector.
42   kCollectorTypeInstrumentation,
43   // Fake collector for adding or removing application image spaces.
44   kCollectorTypeAddRemoveAppImageSpace,
45   // Fake collector used to implement exclusion between GC and debugger.
46   kCollectorTypeDebugger,
47   // A homogeneous space compaction collector used in background transition
48   // when both foreground and background collector are CMS.
49   kCollectorTypeHomogeneousSpaceCompact,
50   // Class linker fake collector.
51   kCollectorTypeClassLinker,
52   // JIT Code cache fake collector.
53   kCollectorTypeJitCodeCache,
54   // Hprof fake collector.
55   kCollectorTypeHprof,
56   // Fake collector for installing/removing a system-weak holder.
57   kCollectorTypeAddRemoveSystemWeakHolder,
58   // Fake collector type for GetObjectsAllocated
59   kCollectorTypeGetObjectsAllocated,
60   // Fake collector type for ScopedGCCriticalSection
61   kCollectorTypeCriticalSection,
62 };
63 std::ostream& operator<<(std::ostream& os, const CollectorType& collector_type);
64 
65 static constexpr CollectorType kCollectorTypeDefault =
66 #if ART_DEFAULT_GC_TYPE_IS_CMS
67     kCollectorTypeCMS
68 #elif ART_DEFAULT_GC_TYPE_IS_SS
69     kCollectorTypeSS
70 #else
71     kCollectorTypeCMS
72 #error "ART default GC type must be set"
73 #endif
74     ;  // NOLINT [whitespace/semicolon] [5]
75 
76 }  // namespace gc
77 }  // namespace art
78 
79 #endif  // ART_RUNTIME_GC_COLLECTOR_TYPE_H_
80