Home | History | Annotate | Download | only in gc
      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   // Heap trimming collector, doesn't do any actual collecting.
     38   kCollectorTypeHeapTrim,
     39   // A (mostly) concurrent copying collector.
     40   kCollectorTypeCC,
     41   // The background compaction of the concurrent copying collector.
     42   kCollectorTypeCCBackground,
     43   // Instrumentation critical section fake collector.
     44   kCollectorTypeInstrumentation,
     45   // Fake collector for adding or removing application image spaces.
     46   kCollectorTypeAddRemoveAppImageSpace,
     47   // Fake collector used to implement exclusion between GC and debugger.
     48   kCollectorTypeDebugger,
     49   // A homogeneous space compaction collector used in background transition
     50   // when both foreground and background collector are CMS.
     51   kCollectorTypeHomogeneousSpaceCompact,
     52   // Class linker fake collector.
     53   kCollectorTypeClassLinker,
     54   // JIT Code cache fake collector.
     55   kCollectorTypeJitCodeCache,
     56   // Hprof fake collector.
     57   kCollectorTypeHprof,
     58   // Fake collector for installing/removing a system-weak holder.
     59   kCollectorTypeAddRemoveSystemWeakHolder,
     60   // Fake collector type for GetObjectsAllocated
     61   kCollectorTypeGetObjectsAllocated,
     62   // Fake collector type for ScopedGCCriticalSection
     63   kCollectorTypeCriticalSection,
     64 };
     65 std::ostream& operator<<(std::ostream& os, const CollectorType& collector_type);
     66 
     67 static constexpr CollectorType kCollectorTypeDefault =
     68 #if ART_DEFAULT_GC_TYPE_IS_CMS
     69     kCollectorTypeCMS
     70 #elif ART_DEFAULT_GC_TYPE_IS_SS
     71     kCollectorTypeSS
     72 #elif ART_DEFAULT_GC_TYPE_IS_GSS
     73     kCollectorTypeGSS
     74 #else
     75     kCollectorTypeCMS
     76 #error "ART default GC type must be set"
     77 #endif
     78     ;  // NOLINT [whitespace/semicolon] [5]
     79 
     80 }  // namespace gc
     81 }  // namespace art
     82 
     83 #endif  // ART_RUNTIME_GC_COLLECTOR_TYPE_H_
     84