ysr@777: /*
tonyp@3416:  * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
ysr@777:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ysr@777:  *
ysr@777:  * This code is free software; you can redistribute it and/or modify it
ysr@777:  * under the terms of the GNU General Public License version 2 only, as
ysr@777:  * published by the Free Software Foundation.
ysr@777:  *
ysr@777:  * This code is distributed in the hope that it will be useful, but WITHOUT
ysr@777:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ysr@777:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ysr@777:  * version 2 for more details (a copy is included in the LICENSE file that
ysr@777:  * accompanied this code).
ysr@777:  *
ysr@777:  * You should have received a copy of the GNU General Public License version
ysr@777:  * 2 along with this work; if not, write to the Free Software Foundation,
ysr@777:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ysr@777:  *
trims@1907:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
trims@1907:  * or visit www.oracle.com if you need additional information or have any
trims@1907:  * questions.
ysr@777:  *
ysr@777:  */
ysr@777: 
stefank@2314: #ifndef SHARE_VM_GC_IMPLEMENTATION_G1_SATBQUEUE_HPP
stefank@2314: #define SHARE_VM_GC_IMPLEMENTATION_G1_SATBQUEUE_HPP
stefank@2314: 
stefank@2314: #include "gc_implementation/g1/ptrQueue.hpp"
stefank@2314: 
ysr@777: class ObjectClosure;
ysr@777: class JavaThread;
tonyp@3416: class SATBMarkQueueSet;
ysr@777: 
ysr@777: // A ptrQueue whose elements are "oops", pointers to object heads.
ysr@777: class ObjPtrQueue: public PtrQueue {
tonyp@3416:   friend class SATBMarkQueueSet;
tonyp@3416: 
tonyp@3416: private:
tonyp@3416:   // Filter out unwanted entries from the buffer.
tonyp@3416:   void filter();
tonyp@3416: 
tonyp@3416:   // Apply the closure to all elements.
tonyp@3416:   void apply_closure(ObjectClosure* cl);
tonyp@3416: 
tonyp@3416:   // Apply the closure to all elements and empty the buffer;
tonyp@3416:   void apply_closure_and_empty(ObjectClosure* cl);
tonyp@3416: 
tonyp@3416:   // Apply the closure to all elements of "buf", down to "index" (inclusive.)
tonyp@3416:   static void apply_closure_to_buffer(ObjectClosure* cl,
tonyp@3416:                                       void** buf, size_t index, size_t sz);
tonyp@3416: 
ysr@777: public:
tonyp@2469:   ObjPtrQueue(PtrQueueSet* qset, bool perm = false) :
tonyp@2197:     // SATB queues are only active during marking cycles. We create
tonyp@2197:     // them with their active field set to false. If a thread is
tonyp@2197:     // created during a cycle and its SATB queue needs to be activated
tonyp@2197:     // before the thread starts running, we'll need to set its active
tonyp@2197:     // field to true. This is done in JavaThread::initialize_queues().
tonyp@2469:     PtrQueue(qset, perm, false /* active */) { }
tonyp@2469: 
tonyp@3416:   // Overrides PtrQueue::flush() so that it can filter the buffer
tonyp@3416:   // before it is flushed.
tonyp@3416:   virtual void flush();
tonyp@3416: 
tonyp@2469:   // Overrides PtrQueue::should_enqueue_buffer(). See the method's
tonyp@2469:   // definition for more information.
tonyp@2469:   virtual bool should_enqueue_buffer();
tonyp@2469: 
tonyp@3416: #ifndef PRODUCT
tonyp@3416:   // Helpful for debugging
tonyp@3416:   void print(const char* name);
tonyp@3416:   static void print(const char* name, void** buf, size_t index, size_t sz);
tonyp@3416: #endif // PRODUCT
ysr@777: 
ysr@1280:   void verify_oops_in_buffer() NOT_DEBUG_RETURN;
ysr@777: };
ysr@777: 
ysr@777: class SATBMarkQueueSet: public PtrQueueSet {
ysr@777:   ObjectClosure* _closure;
ysr@777:   ObjectClosure** _par_closures;  // One per ParGCThread.
ysr@777: 
ysr@777:   ObjPtrQueue _shared_satb_queue;
ysr@777: 
ysr@777:   // Utility function to support sequential and parallel versions.  If
ysr@777:   // "par" is true, then "worker" is the par thread id; if "false", worker
ysr@777:   // is ignored.
ysr@777:   bool apply_closure_to_completed_buffer_work(bool par, int worker);
ysr@777: 
tonyp@1752: #ifdef ASSERT
pliden@6396:   void dump_active_states(bool expected_active);
pliden@6396:   void verify_active_states(bool expected_active);
tonyp@1752: #endif // ASSERT
ysr@777: 
ysr@777: public:
ysr@777:   SATBMarkQueueSet();
ysr@777: 
ysr@777:   void initialize(Monitor* cbl_mon, Mutex* fl_lock,
iveresov@1546:                   int process_completed_threshold,
iveresov@1546:                   Mutex* lock);
ysr@777: 
ysr@777:   static void handle_zero_index_for_thread(JavaThread* t);
ysr@777: 
pliden@6396:   // Apply "set_active(active)" to all SATB queues in the set. It should be
tonyp@1752:   // called only with the world stopped. The method will assert that the
tonyp@1752:   // SATB queues of all threads it visits, as well as the SATB queue
tonyp@1752:   // set itself, has an active value same as expected_active.
pliden@6396:   void set_active_all_threads(bool active, bool expected_active);
ysr@777: 
tonyp@3416:   // Filter all the currently-active SATB buffers.
tonyp@3416:   void filter_thread_buffers();
tonyp@3416: 
ysr@777:   // Register "blk" as "the closure" for all queues.  Only one such closure
ysr@777:   // is allowed.  The "apply_closure_to_completed_buffer" method will apply
ysr@777:   // this closure to a completed buffer, and "iterate_closure_all_threads"
ysr@777:   // applies it to partially-filled buffers (the latter should only be done
ysr@777:   // with the world stopped).
ysr@777:   void set_closure(ObjectClosure* closure);
ysr@777:   // Set the parallel closures: pointer is an array of pointers to
ysr@777:   // closures, one for each parallel GC thread.
ysr@777:   void set_par_closure(int i, ObjectClosure* closure);
ysr@777: 
tonyp@3416:   // Apply the registered closure to all entries on each
tonyp@3416:   // currently-active buffer and then empty the buffer. It should only
tonyp@3416:   // be called serially and at a safepoint.
ysr@777:   void iterate_closure_all_threads();
ysr@777:   // Parallel version of the above.
ysr@777:   void par_iterate_closure_all_threads(int worker);
ysr@777: 
ysr@777:   // If there exists some completed buffer, pop it, then apply the
ysr@777:   // registered closure to all its elements, and return true.  If no
ysr@777:   // completed buffers exist, return false.
ysr@777:   bool apply_closure_to_completed_buffer() {
ysr@777:     return apply_closure_to_completed_buffer_work(false, 0);
ysr@777:   }
ysr@777:   // Parallel version of the above.
ysr@777:   bool par_apply_closure_to_completed_buffer(int worker) {
ysr@777:     return apply_closure_to_completed_buffer_work(true, worker);
ysr@777:   }
ysr@777: 
tonyp@3416:   // Apply the given closure on enqueued and currently-active buffers
tonyp@3416:   // respectively. Both methods are read-only, i.e., they do not
tonyp@3416:   // modify any of the buffers.
tonyp@3416:   void iterate_completed_buffers_read_only(ObjectClosure* cl);
tonyp@3416:   void iterate_thread_buffers_read_only(ObjectClosure* cl);
tonyp@3416: 
tonyp@3416: #ifndef PRODUCT
tonyp@3416:   // Helpful for debugging
tonyp@3416:   void print_all(const char* msg);
tonyp@3416: #endif // PRODUCT
tonyp@3416: 
ysr@777:   ObjPtrQueue* shared_satb_queue() { return &_shared_satb_queue; }
ysr@777: 
ysr@777:   // If a marking is being abandoned, reset any unprocessed log buffers.
ysr@777:   void abandon_partial_marking();
ysr@777: };
stefank@2314: 
stefank@2314: #endif // SHARE_VM_GC_IMPLEMENTATION_G1_SATBQUEUE_HPP