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   // A generational variant of kCollectorTypeSS.
36   kCollectorTypeGSS,
37   // Mark compact collector.
38   kCollectorTypeMC,
39   // Heap trimming collector, doesn't do any actual collecting.
40   kCollectorTypeHeapTrim,
41   // A (mostly) concurrent copying collector.
42   kCollectorTypeCC,
43   // Instrumentation critical section fake collector.
44   kCollectorTypeInstrumentation,
45   // Fake collector for adding or removing application image spaces.
46   kCollectorTypeAddRemoveAppImageSpace,
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 };
53 std::ostream& operator<<(std::ostream& os, const CollectorType& collector_type);
54 
55 static constexpr CollectorType kCollectorTypeDefault =
56 #if ART_DEFAULT_GC_TYPE_IS_CMS
57     kCollectorTypeCMS
58 #elif ART_DEFAULT_GC_TYPE_IS_SS
59     kCollectorTypeSS
60 #elif ART_DEFAULT_GC_TYPE_IS_GSS
61     kCollectorTypeGSS
62 #else
63     kCollectorTypeCMS
64 #error "ART default GC type must be set"
65 #endif
66     ;  // NOLINT [whitespace/semicolon] [5]
67 
68 }  // namespace gc
69 }  // namespace art
70 
71 #endif  // ART_RUNTIME_GC_COLLECTOR_TYPE_H_
72