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_SATBMARKQUEUE_HPP
26 #define SHARE_GC_SHARED_SATBMARKQUEUE_HPP
27
28 #include "gc/shared/ptrQueue.hpp"
29 #include "memory/allocation.hpp"
30
31 class Thread;
32 class Monitor;
33 class SATBMarkQueueSet;
34
35 // Base class for processing the contents of a SATB buffer.
36 class SATBBufferClosure : public StackObj {
37 protected:
38 ~SATBBufferClosure() { }
39
40 public:
41 // Process the SATB entries in the designated buffer range.
42 virtual void do_buffer(void** buffer, size_t size) = 0;
43 };
44
45 // A PtrQueue whose elements are (possibly stale) pointers to object heads.
46 class SATBMarkQueue: public PtrQueue {
47 friend class SATBMarkQueueSet;
48
49 private:
76
77 // Compiler support.
78 static ByteSize byte_offset_of_index() {
79 return PtrQueue::byte_offset_of_index<SATBMarkQueue>();
80 }
81 using PtrQueue::byte_width_of_index;
82
83 static ByteSize byte_offset_of_buf() {
84 return PtrQueue::byte_offset_of_buf<SATBMarkQueue>();
85 }
86 using PtrQueue::byte_width_of_buf;
87
88 static ByteSize byte_offset_of_active() {
89 return PtrQueue::byte_offset_of_active<SATBMarkQueue>();
90 }
91 using PtrQueue::byte_width_of_active;
92
93 };
94
95 class SATBMarkQueueSet: public PtrQueueSet {
96 size_t _buffer_enqueue_threshold;
97
98 #ifdef ASSERT
99 void dump_active_states(bool expected_active);
100 void verify_active_states(bool expected_active);
101 #endif // ASSERT
102
103 protected:
104 SATBMarkQueueSet();
105 ~SATBMarkQueueSet() {}
106
107 template<typename Filter>
108 void apply_filter(Filter filter, SATBMarkQueue* queue) {
109 queue->apply_filter(filter);
110 }
111
112 void initialize(Monitor* cbl_mon,
113 BufferNode::Allocator* allocator,
114 size_t process_completed_buffers_threshold,
115 uint buffer_enqueue_threshold_percentage);
116
117 public:
118 virtual SATBMarkQueue& satb_queue_for_thread(Thread* const t) const = 0;
119
120 // Apply "set_active(active)" to all SATB queues in the set. It should be
121 // called only with the world stopped. The method will assert that the
122 // SATB queues of all threads it visits, as well as the SATB queue
123 // set itself, has an active value same as expected_active.
124 void set_active_all_threads(bool active, bool expected_active);
125
126 size_t buffer_enqueue_threshold() const { return _buffer_enqueue_threshold; }
127 virtual void filter(SATBMarkQueue* queue) = 0;
128
129 // If there exists some completed buffer, pop and process it, and
130 // return true. Otherwise return false. Processing a buffer
131 // consists of applying the closure to the active range of the
132 // buffer; the leading entries may be excluded due to filtering.
133 bool apply_closure_to_completed_buffer(SATBBufferClosure* cl);
134
135 #ifndef PRODUCT
136 // Helpful for debugging
137 void print_all(const char* msg);
138 #endif // PRODUCT
139
140 // If a marking is being abandoned, reset any unprocessed log buffers.
141 void abandon_partial_marking();
142 };
143
144 inline SATBMarkQueueSet* SATBMarkQueue::satb_qset() const {
145 return static_cast<SATBMarkQueueSet*>(qset());
146 }
147
148 inline void SATBMarkQueue::filter() {
149 satb_qset()->filter(this);
150 }
151
152 // Removes entries from the buffer that are no longer needed, as
153 // determined by filter. If e is a void* entry in the buffer,
|
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_SATBMARKQUEUE_HPP
26 #define SHARE_GC_SHARED_SATBMARKQUEUE_HPP
27
28 #include "gc/shared/ptrQueue.hpp"
29 #include "memory/allocation.hpp"
30 #include "memory/padded.hpp"
31
32 class Thread;
33 class Monitor;
34 class SATBMarkQueueSet;
35
36 // Base class for processing the contents of a SATB buffer.
37 class SATBBufferClosure : public StackObj {
38 protected:
39 ~SATBBufferClosure() { }
40
41 public:
42 // Process the SATB entries in the designated buffer range.
43 virtual void do_buffer(void** buffer, size_t size) = 0;
44 };
45
46 // A PtrQueue whose elements are (possibly stale) pointers to object heads.
47 class SATBMarkQueue: public PtrQueue {
48 friend class SATBMarkQueueSet;
49
50 private:
77
78 // Compiler support.
79 static ByteSize byte_offset_of_index() {
80 return PtrQueue::byte_offset_of_index<SATBMarkQueue>();
81 }
82 using PtrQueue::byte_width_of_index;
83
84 static ByteSize byte_offset_of_buf() {
85 return PtrQueue::byte_offset_of_buf<SATBMarkQueue>();
86 }
87 using PtrQueue::byte_width_of_buf;
88
89 static ByteSize byte_offset_of_active() {
90 return PtrQueue::byte_offset_of_active<SATBMarkQueue>();
91 }
92 using PtrQueue::byte_width_of_active;
93
94 };
95
96 class SATBMarkQueueSet: public PtrQueueSet {
97
98 DEFINE_PAD_MINUS_SIZE(1, DEFAULT_CACHE_LINE_SIZE, 0);
99 PaddedEnd<BufferNode::Stack> _list;
100 volatile size_t _count_and_process_flag;
101 // These are rarely (if ever) changed, so same cache line as count.
102 size_t _process_completed_buffers_threshold;
103 size_t _buffer_enqueue_threshold;
104 DEFINE_PAD_MINUS_SIZE(2, DEFAULT_CACHE_LINE_SIZE, 3 * sizeof(size_t));
105
106 BufferNode* get_completed_buffer();
107 void abandon_completed_buffers();
108
109 #ifdef ASSERT
110 void dump_active_states(bool expected_active);
111 void verify_active_states(bool expected_active);
112 #endif // ASSERT
113
114 protected:
115 SATBMarkQueueSet();
116 ~SATBMarkQueueSet();
117
118 template<typename Filter>
119 void apply_filter(Filter filter, SATBMarkQueue* queue) {
120 queue->apply_filter(filter);
121 }
122
123 void initialize(BufferNode::Allocator* allocator,
124 size_t process_completed_buffers_threshold,
125 uint buffer_enqueue_threshold_percentage);
126
127 public:
128 virtual SATBMarkQueue& satb_queue_for_thread(Thread* const t) const = 0;
129
130 // Apply "set_active(active)" to all SATB queues in the set. It should be
131 // called only with the world stopped. The method will assert that the
132 // SATB queues of all threads it visits, as well as the SATB queue
133 // set itself, has an active value same as expected_active.
134 void set_active_all_threads(bool active, bool expected_active);
135
136 size_t buffer_enqueue_threshold() const { return _buffer_enqueue_threshold; }
137 virtual void filter(SATBMarkQueue* queue) = 0;
138
139 // If there exists some completed buffer, pop and process it, and
140 // return true. Otherwise return false. Processing a buffer
141 // consists of applying the closure to the active range of the
142 // buffer; the leading entries may be excluded due to filtering.
143 bool apply_closure_to_completed_buffer(SATBBufferClosure* cl);
144
145 virtual void enqueue_completed_buffer(BufferNode* node);
146
147 // The number of buffers in the list. Racy and not updated atomically
148 // with the set of completed buffers.
149 size_t completed_buffers_num() const {
150 return _count_and_process_flag >> 1;
151 }
152
153 // Return true if completed buffers should be processed.
154 bool process_completed_buffers() const {
155 return (_count_and_process_flag & 1) != 0;
156 }
157
158 #ifndef PRODUCT
159 // Helpful for debugging
160 void print_all(const char* msg);
161 #endif // PRODUCT
162
163 // If a marking is being abandoned, reset any unprocessed log buffers.
164 void abandon_partial_marking();
165 };
166
167 inline SATBMarkQueueSet* SATBMarkQueue::satb_qset() const {
168 return static_cast<SATBMarkQueueSet*>(qset());
169 }
170
171 inline void SATBMarkQueue::filter() {
172 satb_qset()->filter(this);
173 }
174
175 // Removes entries from the buffer that are no longer needed, as
176 // determined by filter. If e is a void* entry in the buffer,
|