1 /*
 2  * Copyright (c) 2021, Red Hat, Inc. 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_SHENANDOAH_SHENANDOAHMARK_HPP
26 #define SHARE_GC_SHENANDOAH_SHENANDOAHMARK_HPP
27 
28 #include "gc/shared/stringdedup/stringDedup.hpp"
29 #include "gc/shared/taskTerminator.hpp"
30 #include "gc/shenandoah/shenandoahOopClosures.hpp"
31 #include "gc/shenandoah/shenandoahTaskqueue.hpp"
32 
33 class ShenandoahCMDrainMarkingStackClosure;
34 
35 // Base class for mark
36 // Mark class does not maintain states. Instead, mark states are
37 // maintained by task queues, mark bitmap and SATB buffers (concurrent mark)
38 class ShenandoahMark: public StackObj {
39   friend class ShenandoahCMDrainMarkingStackClosure;
40 
41 protected:
42   ShenandoahObjToScanQueueSet* const _task_queues;
43 
44 protected:
45   ShenandoahMark();
46 
47 public:
48   template<class T>
49   static inline void mark_through_ref(T* p, ShenandoahObjToScanQueue* q, ShenandoahMarkingContext* const mark_context, bool weak);
50 
51   static void clear();
52 
53   // Helpers
54   inline ShenandoahObjToScanQueueSet* task_queues() const;
55   inline ShenandoahObjToScanQueue* get_queue(uint index) const;
56 
57 // ---------- Marking loop and tasks
58 private:
59   template <class T, StringDedupMode STRING_DEDUP>
60   inline void do_task(ShenandoahObjToScanQueue* q, T* cl, ShenandoahLiveData* live_data, StringDedup::Requests* const req, ShenandoahMarkTask* task);
61 
62   template <class T>
63   inline void do_chunked_array_start(ShenandoahObjToScanQueue* q, T* cl, oop array, bool weak);
64 
65   template <class T>
66   inline void do_chunked_array(ShenandoahObjToScanQueue* q, T* cl, oop array, int chunk, int pow, bool weak);
67 
68   inline void count_liveness(ShenandoahLiveData* live_data, oop obj);
69 
70   template <class T, bool CANCELLABLE,StringDedupMode STRING_DEDUP>
71   void mark_loop_work(T* cl, ShenandoahLiveData* live_data, uint worker_id, TaskTerminator *t, StringDedup::Requests* const req);
72 
73   template <bool CANCELLABLE, StringDedupMode STRING_DEDUP>
74   void mark_loop_prework(uint worker_id, TaskTerminator *terminator, ShenandoahReferenceProcessor *rp, StringDedup::Requests* const req);
75 
76   template <StringDedupMode STRING_DEDUP>
77   inline void dedup_string(oop obj, StringDedup::Requests* const req);
78 protected:
79   void mark_loop(uint worker_id, TaskTerminator* terminator, ShenandoahReferenceProcessor *rp,
80                  bool cancellable, StringDedupMode dedup_mode, StringDedup::Requests* const req);
81 };
82 
83 #endif // SHARE_GC_SHENANDOAH_SHENANDOAHMARK_HPP
84