1 /*
  2  * Copyright (c) 2016, 2022, 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_GC_SHARED_PRESERVEDMARKS_HPP
 26 #define SHARE_GC_SHARED_PRESERVEDMARKS_HPP
 27 
 28 #include "memory/allocation.hpp"
 29 #include "memory/padded.hpp"
 30 #include "oops/oop.hpp"
 31 #include "utilities/stack.hpp"
 32 
 33 class WorkerTask;
 34 class PreservedMarksSet;
 35 class WorkerThreads;
 36 
 37 class PreservedMarks {
 38 private:
 39   class OopAndMarkWord {
 40   private:
 41     oop _o;
 42     markWord _m;
 43 
 44   public:
 45     OopAndMarkWord(oop obj, markWord m) : _o(obj), _m(m) { }
 46 
 47     oop get_oop() { return _o; }
 48     inline void set_mark() const;
 49     void set_oop(oop obj) { _o = obj; }
 50   };
 51   typedef Stack<OopAndMarkWord, mtGC> OopAndMarkWordStack;
 52 
 53   OopAndMarkWordStack _stack;
 54 
 55   inline bool should_preserve_mark(oop obj, markWord m) const;
 56 
 57 public:
 58   size_t size() const { return _stack.size(); }
 59   inline void push_if_necessary(oop obj, markWord m);
 60   inline void push_always(oop obj, markWord m);
 61   // Iterate over the stack, restore all preserved marks, and
 62   // reclaim the memory taken up by the stack segments.
 63   void restore();
 64   // Iterate over the stack, adjust all preserved marks according
 65   // to their forwarding location stored in the mark.
 66   void adjust_during_full_gc();
 67 
 68   void restore_and_increment(volatile size_t* const _total_size_addr);
 69 
 70   // Assert the stack is empty and has no cached segments.
 71   void assert_empty() PRODUCT_RETURN;
 72 
 73   inline PreservedMarks();
 74   ~PreservedMarks() { assert_empty(); }
 75 };
 76 
 77 class PreservedMarksSet : public CHeapObj<mtGC> {
 78 private:
 79   // true -> _stacks will be allocated in the C heap
 80   // false -> _stacks will be allocated in the resource arena
 81   const bool _in_c_heap;
 82 
 83   // Number of stacks we have allocated (typically, one stack per GC worker).
 84   // This should be >= 1 if the stacks have been initialized,
 85   // or == 0 if they have not.
 86   uint _num;
 87 
 88   // Stack array (typically, one stack per GC worker) of length _num.
 89   // This should be != NULL if the stacks have been initialized,
 90   // or == NULL if they have not.
 91   Padded<PreservedMarks>* _stacks;
 92 
 93 public:
 94   uint num() const { return _num; }
 95 
 96   // Return the i'th stack.
 97   PreservedMarks* get(uint i = 0) const {
 98     assert(_num > 0 && _stacks != NULL, "stacks should have been initialized");
 99     assert(i < _num, "pre-condition");
100     return (_stacks + i);
101   }
102 
103   // Allocate stack array.
104   void init(uint num);
105 
106   // Iterate over all stacks, restore all preserved marks, and reclaim
107   // the memory taken up by the stack segments using the given WorkerThreads. If the WorkerThreads
108   // is NULL, perform the work serially in the current thread.
109   void restore(WorkerThreads* workers);
110 
111   WorkerTask* create_task();
112 
113   // Reclaim stack array.
114   void reclaim();
115 
116   // Assert all the stacks are empty and have no cached segments.
117   void assert_empty() PRODUCT_RETURN;
118 
119   PreservedMarksSet(bool in_c_heap)
120       : _in_c_heap(in_c_heap), _num(0), _stacks(NULL) { }
121 
122   ~PreservedMarksSet() {
123     assert(_stacks == NULL && _num == 0, "stacks should have been reclaimed");
124   }
125 };
126 
127 #endif // SHARE_GC_SHARED_PRESERVEDMARKS_HPP