1 /*
2  * Copyright (c) 2014, 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 
25 #ifndef SHARE_VM_GC_G1_G1PARSCANTHREADSTATE_HPP
26 #define SHARE_VM_GC_G1_G1PARSCANTHREADSTATE_HPP
27 
28 #include "gc/g1/dirtyCardQueue.hpp"
29 #include "gc/g1/g1CardTable.hpp"
30 #include "gc/g1/g1CollectedHeap.hpp"
31 #include "gc/g1/g1OopClosures.hpp"
32 #include "gc/g1/g1Policy.hpp"
33 #include "gc/g1/g1RemSet.hpp"
34 #include "gc/g1/heapRegionRemSet.hpp"
35 #include "gc/shared/ageTable.hpp"
36 #include "memory/allocation.hpp"
37 #include "oops/oop.hpp"
38 #include "utilities/ticks.hpp"
39 
40 class G1OopStarChunkedList;
41 class G1PLABAllocator;
42 class G1EvacuationRootClosures;
43 class HeapRegion;
44 class outputStream;
45 
46 class G1ParScanThreadState : public CHeapObj<mtGC> {
47   G1CollectedHeap* _g1h;
48   RefToScanQueue*  _refs;
49   DirtyCardQueue   _dcq;
50   G1CardTable*     _ct;
51   G1EvacuationRootClosures* _closures;
52 
53   G1PLABAllocator*  _plab_allocator;
54 
55   AgeTable          _age_table;
56   InCSetState       _dest[InCSetState::Num];
57   // Local tenuring threshold.
58   uint              _tenuring_threshold;
59   G1ScanEvacuatedObjClosure  _scanner;
60 
61   uint _worker_id;
62 
63   // Upper and lower threshold to start and end work queue draining.
64   uint const _stack_trim_upper_threshold;
65   uint const _stack_trim_lower_threshold;
66 
67   Tickspan _trim_ticks;
68   // Map from young-age-index (0 == not young, 1 is youngest) to
69   // surviving words. base is what we get back from the malloc call
70   size_t* _surviving_young_words_base;
71   // this points into the array, as we use the first few entries for padding
72   size_t* _surviving_young_words;
73 
74   // Indicates whether in the last generation (old) there is no more space
75   // available for allocation.
76   bool _old_gen_is_full;
77 
78 #define PADDING_ELEM_NUM (DEFAULT_CACHE_LINE_SIZE / sizeof(size_t))
79 
dirty_card_queue()80   DirtyCardQueue& dirty_card_queue()             { return _dcq;  }
ct()81   G1CardTable* ct()                              { return _ct; }
82 
dest(InCSetState original) const83   InCSetState dest(InCSetState original) const {
84     assert(original.is_valid(),
85            "Original state invalid: " CSETSTATE_FORMAT, original.value());
86     assert(_dest[original.value()].is_valid_gen(),
87            "Dest state is invalid: " CSETSTATE_FORMAT, _dest[original.value()].value());
88     return _dest[original.value()];
89   }
90 
91   size_t _num_optional_regions;
92   G1OopStarChunkedList* _oops_into_optional_regions;
93 
94 public:
95   G1ParScanThreadState(G1CollectedHeap* g1h,
96                        uint worker_id,
97                        size_t young_cset_length,
98                        size_t optional_cset_length);
99   virtual ~G1ParScanThreadState();
100 
set_ref_discoverer(ReferenceDiscoverer * rd)101   void set_ref_discoverer(ReferenceDiscoverer* rd) { _scanner.set_ref_discoverer(rd); }
102 
103 #ifdef ASSERT
queue_is_empty() const104   bool queue_is_empty() const { return _refs->is_empty(); }
105 
106   bool verify_ref(narrowOop* ref) const;
107   bool verify_ref(oop* ref) const;
108   bool verify_task(StarTask ref) const;
109 #endif // ASSERT
110 
111   template <class T> void do_oop_ext(T* ref);
112   template <class T> void push_on_queue(T* ref);
113 
enqueue_card_if_tracked(T * p,oop o)114   template <class T> void enqueue_card_if_tracked(T* p, oop o) {
115     assert(!HeapRegion::is_in_same_region(p, o), "Should have filtered out cross-region references already.");
116     assert(!_g1h->heap_region_containing(p)->is_young(), "Should have filtered out from-young references already.");
117     if (!_g1h->heap_region_containing((HeapWord*)o)->rem_set()->is_tracked()) {
118       return;
119     }
120     size_t card_index = ct()->index_for(p);
121     // If the card hasn't been added to the buffer, do it.
122     if (ct()->mark_card_deferred(card_index)) {
123       dirty_card_queue().enqueue((jbyte*)ct()->byte_for_index(card_index));
124     }
125   }
126 
closures()127   G1EvacuationRootClosures* closures() { return _closures; }
worker_id()128   uint worker_id() { return _worker_id; }
129 
130   // Returns the current amount of waste due to alignment or not being able to fit
131   // objects within LABs and the undo waste.
132   virtual void waste(size_t& wasted, size_t& undo_wasted);
133 
surviving_young_words()134   size_t* surviving_young_words() {
135     // We add one to hide entry 0 which accumulates surviving words for
136     // age -1 regions (i.e. non-young ones)
137     return _surviving_young_words + 1;
138   }
139 
140   void flush(size_t* surviving_young_words);
141 
142 private:
143   #define G1_PARTIAL_ARRAY_MASK 0x2
144 
has_partial_array_mask(oop * ref) const145   inline bool has_partial_array_mask(oop* ref) const {
146     return ((uintptr_t)ref & G1_PARTIAL_ARRAY_MASK) == G1_PARTIAL_ARRAY_MASK;
147   }
148 
149   // We never encode partial array oops as narrowOop*, so return false immediately.
150   // This allows the compiler to create optimized code when popping references from
151   // the work queue.
has_partial_array_mask(narrowOop * ref) const152   inline bool has_partial_array_mask(narrowOop* ref) const {
153     assert(((uintptr_t)ref & G1_PARTIAL_ARRAY_MASK) != G1_PARTIAL_ARRAY_MASK, "Partial array oop reference encoded as narrowOop*");
154     return false;
155   }
156 
157   // Only implement set_partial_array_mask() for regular oops, not for narrowOops.
158   // We always encode partial arrays as regular oop, to allow the
159   // specialization for has_partial_array_mask() for narrowOops above.
160   // This means that unintentional use of this method with narrowOops are caught
161   // by the compiler.
set_partial_array_mask(oop obj) const162   inline oop* set_partial_array_mask(oop obj) const {
163     assert(((uintptr_t)(void *)obj & G1_PARTIAL_ARRAY_MASK) == 0, "Information loss!");
164     return (oop*) ((uintptr_t)(void *)obj | G1_PARTIAL_ARRAY_MASK);
165   }
166 
clear_partial_array_mask(oop * ref) const167   inline oop clear_partial_array_mask(oop* ref) const {
168     return cast_to_oop((intptr_t)ref & ~G1_PARTIAL_ARRAY_MASK);
169   }
170 
171   inline void do_oop_partial_array(oop* p);
172 
173   // This method is applied to the fields of the objects that have just been copied.
174   template <class T> inline void do_oop_evac(T* p);
175 
176   inline void deal_with_reference(oop* ref_to_scan);
177   inline void deal_with_reference(narrowOop* ref_to_scan);
178 
179   inline void dispatch_reference(StarTask ref);
180 
181   // Tries to allocate word_sz in the PLAB of the next "generation" after trying to
182   // allocate into dest. State is the original (source) cset state for the object
183   // that is allocated for. Previous_plab_refill_failed indicates whether previously
184   // a PLAB refill into "state" failed.
185   // Returns a non-NULL pointer if successful, and updates dest if required.
186   // Also determines whether we should continue to try to allocate into the various
187   // generations or just end trying to allocate.
188   HeapWord* allocate_in_next_plab(InCSetState const state,
189                                   InCSetState* dest,
190                                   size_t word_sz,
191                                   bool previous_plab_refill_failed);
192 
193   inline InCSetState next_state(InCSetState const state, markOop const m, uint& age);
194 
195   void report_promotion_event(InCSetState const dest_state,
196                               oop const old, size_t word_sz, uint age,
197                               HeapWord * const obj_ptr) const;
198 
199   inline bool needs_partial_trimming() const;
200   inline bool is_partially_trimmed() const;
201 
202   inline void trim_queue_to_threshold(uint threshold);
203 public:
204   oop copy_to_survivor_space(InCSetState const state, oop const obj, markOop const old_mark);
205 
206   void trim_queue();
207   void trim_queue_partially();
208 
209   Tickspan trim_ticks() const;
210   void reset_trim_ticks();
211 
212   inline void steal_and_trim_queue(RefToScanQueueSet *task_queues);
213 
214   // An attempt to evacuate "obj" has failed; take necessary steps.
215   oop handle_evacuation_failure_par(oop obj, markOop m);
216 
217   template <typename T>
218   inline void remember_root_into_optional_region(T* p);
219   template <typename T>
220   inline void remember_reference_into_optional_region(T* p);
221 
222   inline G1OopStarChunkedList* oops_into_optional_region(const HeapRegion* hr);
223 };
224 
225 class G1ParScanThreadStateSet : public StackObj {
226   G1CollectedHeap* _g1h;
227   G1ParScanThreadState** _states;
228   size_t* _surviving_young_words_total;
229   size_t _young_cset_length;
230   size_t _optional_cset_length;
231   uint _n_workers;
232   bool _flushed;
233 
234  public:
235   G1ParScanThreadStateSet(G1CollectedHeap* g1h,
236                           uint n_workers,
237                           size_t young_cset_length,
238                           size_t optional_cset_length);
239   ~G1ParScanThreadStateSet();
240 
241   void flush();
242   void record_unused_optional_region(HeapRegion* hr);
243 
244   G1ParScanThreadState* state_for_worker(uint worker_id);
245 
246   const size_t* surviving_young_words() const;
247 
248  private:
249   G1ParScanThreadState* new_par_scan_state(uint worker_id, size_t young_cset_length);
250 };
251 
252 #endif // SHARE_VM_GC_G1_G1PARSCANTHREADSTATE_HPP
253