1 /*
   2  * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.
   8  *
   9  * This code is distributed in the hope that it will be useful, but WITHOUT
  10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12  * version 2 for more details (a copy is included in the LICENSE file that
  13  * accompanied this code).
  14  *
  15  * You should have received a copy of the GNU General Public License version
  16  * 2 along with this work; if not, write to the Free Software Foundation,
  17  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  18  *
  19  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  20  * or visit www.oracle.com if you need additional information or have any
  21  * questions.
  22  */
  23 
  24 #ifndef SHARE_GC_Z_ZCOLLECTEDHEAP_HPP
  25 #define SHARE_GC_Z_ZCOLLECTEDHEAP_HPP
  26 
  27 #include "gc/shared/collectedHeap.hpp"
  28 #include "gc/shared/softRefPolicy.hpp"
  29 #include "gc/z/zBarrierSet.hpp"
  30 #include "gc/z/zCollectorPolicy.hpp"
  31 #include "gc/z/zDirector.hpp"
  32 #include "gc/z/zDriver.hpp"
  33 #include "gc/z/zInitialize.hpp"
  34 #include "gc/z/zHeap.hpp"
  35 #include "gc/z/zStat.hpp"
  36 
  37 class ZCollectedHeap : public CollectedHeap {
  38   friend class VMStructs;
  39 
  40 private:
  41   ZCollectorPolicy* _collector_policy;
  42   SoftRefPolicy     _soft_ref_policy;
  43   ZBarrierSet       _barrier_set;
  44   ZInitialize       _initialize;
  45   ZHeap             _heap;
  46   ZDirector*        _director;
  47   ZDriver*          _driver;
  48   ZStat*            _stat;
  49 
  50   virtual HeapWord* allocate_new_tlab(size_t min_size,
  51                                       size_t requested_size,
  52                                       size_t* actual_size);
  53 
  54 public:
  55   static ZCollectedHeap* heap();
  56 
  57   using CollectedHeap::ensure_parsability;
  58   using CollectedHeap::accumulate_statistics_all_tlabs;
  59   using CollectedHeap::resize_all_tlabs;
  60 
  61   ZCollectedHeap(ZCollectorPolicy* policy);
  62   virtual Name kind() const;
  63   virtual const char* name() const;
  64   virtual jint initialize();
  65   virtual void initialize_serviceability();
  66   virtual void stop();
  67 
  68   virtual CollectorPolicy* collector_policy() const;
  69   virtual SoftRefPolicy* soft_ref_policy();
  70 
  71   virtual size_t max_capacity() const;
  72   virtual size_t capacity() const;
  73   virtual size_t used() const;
  74 
  75   virtual bool is_maximal_no_gc() const;
  76   virtual bool is_scavengable(oop obj);
  77   virtual bool is_in(const void* p) const;
  78   virtual bool is_in_closed_subset(const void* p) const;
  79 
  80   virtual HeapWord* mem_allocate(size_t size, bool* gc_overhead_limit_was_exceeded);
  81   virtual MetaWord* satisfy_failed_metadata_allocation(ClassLoaderData* loader_data,
  82                                                        size_t size,
  83                                                        Metaspace::MetadataType mdtype);
  84   virtual void collect(GCCause::Cause cause);
  85   virtual void collect_as_vm_thread(GCCause::Cause cause);
  86   virtual void do_full_collection(bool clear_all_soft_refs);
  87 
  88   virtual bool supports_tlab_allocation() const;
  89   virtual size_t tlab_capacity(Thread* thr) const;
  90   virtual size_t tlab_used(Thread* thr) const;
  91   virtual size_t max_tlab_size() const;
  92   virtual size_t unsafe_max_tlab_alloc(Thread* thr) const;
  93 
  94   virtual bool can_elide_tlab_store_barriers() const;
  95   virtual bool can_elide_initializing_store_barrier(oop new_obj);
  96   virtual bool card_mark_must_follow_store() const;
  97 
  98   virtual GrowableArray<GCMemoryManager*> memory_managers();
  99   virtual GrowableArray<MemoryPool*> memory_pools();
 100 
 101   virtual void object_iterate(ObjectClosure* cl);
 102   virtual void safe_object_iterate(ObjectClosure* cl);
 103 
 104   virtual HeapWord* block_start(const void* addr) const;
 105   virtual size_t block_size(const HeapWord* addr) const;
 106   virtual bool block_is_obj(const HeapWord* addr) const;
 107 
 108   virtual void register_nmethod(nmethod* nm);
 109   virtual void unregister_nmethod(nmethod* nm);
 110   virtual void verify_nmethod(nmethod* nmethod);
 111 
 112   virtual jlong millis_since_last_gc();
 113 
 114   virtual void gc_threads_do(ThreadClosure* tc) const;
 115 
 116   virtual VirtualSpaceSummary create_heap_space_summary();
 117 
 118   virtual void print_on(outputStream* st) const;
 119   virtual void print_on_error(outputStream* st) const;
 120   virtual void print_extended_on(outputStream* st) const;
 121   virtual void print_gc_threads_on(outputStream* st) const;
 122   virtual void print_tracing_info() const;
 123 
 124   virtual void prepare_for_verify();
 125   virtual void verify(VerifyOption option /* ignored */);
 126   virtual bool is_oop(oop object) const;
 127 };
 128 
 129 #endif // SHARE_GC_Z_ZCOLLECTEDHEAP_HPP