1 /* 2 * Copyright (c) 2001, 2014, 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_IMPLEMENTATION_G1_SATBQUEUE_HPP 26 #define SHARE_VM_GC_IMPLEMENTATION_G1_SATBQUEUE_HPP 27 28 #include "gc_implementation/g1/ptrQueue.hpp" 29 30 class ObjectClosure; 31 class JavaThread; 32 class SATBMarkQueueSet; 33 34 // A ptrQueue whose elements are "oops", pointers to object heads. 35 class ObjPtrQueue: public PtrQueue { 36 friend class Threads; 37 friend class SATBMarkQueueSet; 38 friend class G1RemarkThreadsClosure; 39 40 private: 41 // Filter out unwanted entries from the buffer. 42 void filter(); 43 44 // Apply the closure to all elements. 45 void apply_closure(ObjectClosure* cl); 46 47 // Apply the closure to all elements and empty the buffer; 48 void apply_closure_and_empty(ObjectClosure* cl); 49 50 // Apply the closure to all elements of "buf", down to "index" (inclusive.) 51 static void apply_closure_to_buffer(ObjectClosure* cl, 52 void** buf, size_t index, size_t sz); 53 54 public: 55 ObjPtrQueue(PtrQueueSet* qset, bool perm = false) : 56 // SATB queues are only active during marking cycles. We create 57 // them with their active field set to false. If a thread is 58 // created during a cycle and its SATB queue needs to be activated 59 // before the thread starts running, we'll need to set its active 60 // field to true. This is done in JavaThread::initialize_queues(). 61 PtrQueue(qset, perm, false /* active */) { } 62 63 // Process queue entries and free resources. 64 void flush(); 65 66 // Overrides PtrQueue::should_enqueue_buffer(). See the method's 67 // definition for more information. 68 virtual bool should_enqueue_buffer(); 69 70 #ifndef PRODUCT 71 // Helpful for debugging 72 void print(const char* name); 73 static void print(const char* name, void** buf, size_t index, size_t sz); 74 #endif // PRODUCT 75 76 void verify_oops_in_buffer() NOT_DEBUG_RETURN; 77 }; 78 79 class SATBMarkQueueSet: public PtrQueueSet { 80 ObjectClosure** _closures; // One per ParGCThread. 81 82 ObjPtrQueue _shared_satb_queue; 83 84 #ifdef ASSERT 85 void dump_active_states(bool expected_active); 86 void verify_active_states(bool expected_active); 87 #endif // ASSERT 88 89 public: 90 SATBMarkQueueSet(); 91 92 void initialize(Monitor* cbl_mon, Mutex* fl_lock, 93 int process_completed_threshold, 94 Mutex* lock); 95 96 static void handle_zero_index_for_thread(JavaThread* t); 97 98 // Apply "set_active(active)" to all SATB queues in the set. It should be 99 // called only with the world stopped. The method will assert that the 100 // SATB queues of all threads it visits, as well as the SATB queue 101 // set itself, has an active value same as expected_active. 102 void set_active_all_threads(bool active, bool expected_active); 103 104 // Filter all the currently-active SATB buffers. 105 void filter_thread_buffers(); 106 107 // Register closure for the given worker thread. The "apply_closure_to_completed_buffer" 108 // method will apply this closure to a completed buffer, and "iterate_closure_all_threads" 109 // applies it to partially-filled buffers (the latter should only be done 110 // with the world stopped). 111 void set_closure(uint worker, ObjectClosure* closure); 112 113 // If there exists some completed buffer, pop it, then apply the 114 // registered closure to all its elements, and return true. If no 115 // completed buffers exist, return false. 116 bool apply_closure_to_completed_buffer(uint worker); 117 118 // Apply the given closure on enqueued and currently-active buffers 119 // respectively. Both methods are read-only, i.e., they do not 120 // modify any of the buffers. 121 void iterate_completed_buffers_read_only(ObjectClosure* cl); 122 void iterate_thread_buffers_read_only(ObjectClosure* cl); 123 124 #ifndef PRODUCT 125 // Helpful for debugging 126 void print_all(const char* msg); 127 #endif // PRODUCT 128 129 ObjPtrQueue* shared_satb_queue() { return &_shared_satb_queue; } 130 131 // If a marking is being abandoned, reset any unprocessed log buffers. 132 void abandon_partial_marking(); 133 }; 134 135 #endif // SHARE_VM_GC_IMPLEMENTATION_G1_SATBQUEUE_HPP