annotate src/share/vm/utilities/yieldingWorkgroup.hpp @ 6862:8a5ea0a9ccc4

7127708: G1: change task num types from int to uint in concurrent mark Summary: Change the type of various task num fields, parameters etc to unsigned and rename them to be more consistent with the other collectors. Code changes were also reviewed by Vitaly Davidovich. Reviewed-by: johnc Contributed-by: Kaushik Srenevasan <kaushik@twitter.com>
author johnc
date Sat, 06 Oct 2012 01:17:44 -0700
parents 441e946dc1af
children 32164d89fe9c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
a61af66fc99e Initial load
duke
parents:
diff changeset
1 /*
1837
c99c53f07c14 6692906: CMS: parallel concurrent marking may be prone to hanging or stalling mutators for periods of time
ysr
parents: 1833
diff changeset
2 * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
a61af66fc99e Initial load
duke
parents:
diff changeset
4 *
a61af66fc99e Initial load
duke
parents:
diff changeset
5 * This code is free software; you can redistribute it and/or modify it
a61af66fc99e Initial load
duke
parents:
diff changeset
6 * under the terms of the GNU General Public License version 2 only, as
a61af66fc99e Initial load
duke
parents:
diff changeset
7 * published by the Free Software Foundation.
a61af66fc99e Initial load
duke
parents:
diff changeset
8 *
a61af66fc99e Initial load
duke
parents:
diff changeset
9 * This code is distributed in the hope that it will be useful, but WITHOUT
a61af66fc99e Initial load
duke
parents:
diff changeset
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a61af66fc99e Initial load
duke
parents:
diff changeset
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
a61af66fc99e Initial load
duke
parents:
diff changeset
12 * version 2 for more details (a copy is included in the LICENSE file that
a61af66fc99e Initial load
duke
parents:
diff changeset
13 * accompanied this code).
a61af66fc99e Initial load
duke
parents:
diff changeset
14 *
a61af66fc99e Initial load
duke
parents:
diff changeset
15 * You should have received a copy of the GNU General Public License version
a61af66fc99e Initial load
duke
parents:
diff changeset
16 * 2 along with this work; if not, write to the Free Software Foundation,
a61af66fc99e Initial load
duke
parents:
diff changeset
17 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
a61af66fc99e Initial load
duke
parents:
diff changeset
18 *
1552
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 342
diff changeset
19 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 342
diff changeset
20 * or visit www.oracle.com if you need additional information or have any
c18cbe5936b8 6941466: Oracle rebranding changes for Hotspot repositories
trims
parents: 342
diff changeset
21 * questions.
0
a61af66fc99e Initial load
duke
parents:
diff changeset
22 *
a61af66fc99e Initial load
duke
parents:
diff changeset
23 */
a61af66fc99e Initial load
duke
parents:
diff changeset
24
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
25 #ifndef SHARE_VM_UTILITIES_YIELDINGWORKGROUP_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
26 #define SHARE_VM_UTILITIES_YIELDINGWORKGROUP_HPP
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
27
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
28 #ifndef SERIALGC
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
29 #include "utilities/workgroup.hpp"
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
30 #endif
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
31
0
a61af66fc99e Initial load
duke
parents:
diff changeset
32
a61af66fc99e Initial load
duke
parents:
diff changeset
33 // Forward declarations
a61af66fc99e Initial load
duke
parents:
diff changeset
34 class YieldingFlexibleWorkGang;
a61af66fc99e Initial load
duke
parents:
diff changeset
35
a61af66fc99e Initial load
duke
parents:
diff changeset
36 // Status of tasks
a61af66fc99e Initial load
duke
parents:
diff changeset
37 enum Status {
a61af66fc99e Initial load
duke
parents:
diff changeset
38 INACTIVE,
a61af66fc99e Initial load
duke
parents:
diff changeset
39 ACTIVE,
a61af66fc99e Initial load
duke
parents:
diff changeset
40 YIELDING,
a61af66fc99e Initial load
duke
parents:
diff changeset
41 YIELDED,
a61af66fc99e Initial load
duke
parents:
diff changeset
42 ABORTING,
a61af66fc99e Initial load
duke
parents:
diff changeset
43 ABORTED,
a61af66fc99e Initial load
duke
parents:
diff changeset
44 COMPLETING,
a61af66fc99e Initial load
duke
parents:
diff changeset
45 COMPLETED
a61af66fc99e Initial load
duke
parents:
diff changeset
46 };
a61af66fc99e Initial load
duke
parents:
diff changeset
47
a61af66fc99e Initial load
duke
parents:
diff changeset
48 // Class YieldingFlexibleGangWorker:
a61af66fc99e Initial load
duke
parents:
diff changeset
49 // Several instances of this class run in parallel as workers for a gang.
a61af66fc99e Initial load
duke
parents:
diff changeset
50 class YieldingFlexibleGangWorker: public GangWorker {
a61af66fc99e Initial load
duke
parents:
diff changeset
51 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
52 // Ctor
a61af66fc99e Initial load
duke
parents:
diff changeset
53 YieldingFlexibleGangWorker(AbstractWorkGang* gang, int id) :
a61af66fc99e Initial load
duke
parents:
diff changeset
54 GangWorker(gang, id) { }
a61af66fc99e Initial load
duke
parents:
diff changeset
55
a61af66fc99e Initial load
duke
parents:
diff changeset
56 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
57 YieldingFlexibleWorkGang* yf_gang() const
a61af66fc99e Initial load
duke
parents:
diff changeset
58 { return (YieldingFlexibleWorkGang*)gang(); }
a61af66fc99e Initial load
duke
parents:
diff changeset
59
a61af66fc99e Initial load
duke
parents:
diff changeset
60 protected: // Override from parent class
a61af66fc99e Initial load
duke
parents:
diff changeset
61 virtual void loop();
a61af66fc99e Initial load
duke
parents:
diff changeset
62 };
a61af66fc99e Initial load
duke
parents:
diff changeset
63
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
64 class FlexibleGangTask: public AbstractGangTask {
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
65 int _actual_size; // size of gang obtained
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
66 protected:
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
67 int _requested_size; // size of gang requested
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
68 public:
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
69 FlexibleGangTask(const char* name): AbstractGangTask(name),
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
70 _requested_size(0) {}
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
71
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
72 // The abstract work method.
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
73 // The argument tells you which member of the gang you are.
4728
441e946dc1af 7121618: Change type of number of GC workers to unsigned int.
jmasa
parents: 4095
diff changeset
74 virtual void work(uint worker_id) = 0;
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
75
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
76 int requested_size() const { return _requested_size; }
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
77 int actual_size() const { return _actual_size; }
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
78
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
79 void set_requested_size(int sz) { _requested_size = sz; }
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
80 void set_actual_size(int sz) { _actual_size = sz; }
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
81 };
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
82
0
a61af66fc99e Initial load
duke
parents:
diff changeset
83 // An abstract task to be worked on by a flexible work gang,
a61af66fc99e Initial load
duke
parents:
diff changeset
84 // and where the workers will periodically yield, usually
a61af66fc99e Initial load
duke
parents:
diff changeset
85 // in response to some condition that is signalled by means
a61af66fc99e Initial load
duke
parents:
diff changeset
86 // that are specific to the task at hand.
a61af66fc99e Initial load
duke
parents:
diff changeset
87 // You subclass this to supply your own work() method.
a61af66fc99e Initial load
duke
parents:
diff changeset
88 // A second feature of this kind of work gang is that
a61af66fc99e Initial load
duke
parents:
diff changeset
89 // it allows for the signalling of certain exceptional
a61af66fc99e Initial load
duke
parents:
diff changeset
90 // conditions that may be encountered during the performance
a61af66fc99e Initial load
duke
parents:
diff changeset
91 // of the task and that may require the task at hand to be
a61af66fc99e Initial load
duke
parents:
diff changeset
92 // `aborted' forthwith. Finally, these gangs are `flexible'
a61af66fc99e Initial load
duke
parents:
diff changeset
93 // in that they can operate at partial capacity with some
a61af66fc99e Initial load
duke
parents:
diff changeset
94 // gang workers waiting on the bench; in other words, the
a61af66fc99e Initial load
duke
parents:
diff changeset
95 // size of the active worker pool can flex (up to an apriori
a61af66fc99e Initial load
duke
parents:
diff changeset
96 // maximum) in response to task requests at certain points.
a61af66fc99e Initial load
duke
parents:
diff changeset
97 // The last part (the flexible part) has not yet been fully
a61af66fc99e Initial load
duke
parents:
diff changeset
98 // fleshed out and is a work in progress.
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
99 class YieldingFlexibleGangTask: public FlexibleGangTask {
0
a61af66fc99e Initial load
duke
parents:
diff changeset
100 Status _status;
a61af66fc99e Initial load
duke
parents:
diff changeset
101 YieldingFlexibleWorkGang* _gang;
a61af66fc99e Initial load
duke
parents:
diff changeset
102
a61af66fc99e Initial load
duke
parents:
diff changeset
103 protected:
a61af66fc99e Initial load
duke
parents:
diff changeset
104 // Constructor and desctructor: only construct subclasses.
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
105 YieldingFlexibleGangTask(const char* name): FlexibleGangTask(name),
0
a61af66fc99e Initial load
duke
parents:
diff changeset
106 _status(INACTIVE),
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
107 _gang(NULL) { }
0
a61af66fc99e Initial load
duke
parents:
diff changeset
108
a61af66fc99e Initial load
duke
parents:
diff changeset
109 virtual ~YieldingFlexibleGangTask() { }
a61af66fc99e Initial load
duke
parents:
diff changeset
110
a61af66fc99e Initial load
duke
parents:
diff changeset
111 friend class YieldingFlexibleWorkGang;
a61af66fc99e Initial load
duke
parents:
diff changeset
112 friend class YieldingFlexibleGangWorker;
a61af66fc99e Initial load
duke
parents:
diff changeset
113 NOT_PRODUCT(virtual bool is_YieldingFlexibleGang_task() const {
a61af66fc99e Initial load
duke
parents:
diff changeset
114 return true;
a61af66fc99e Initial load
duke
parents:
diff changeset
115 })
a61af66fc99e Initial load
duke
parents:
diff changeset
116
a61af66fc99e Initial load
duke
parents:
diff changeset
117 void set_status(Status s) {
a61af66fc99e Initial load
duke
parents:
diff changeset
118 _status = s;
a61af66fc99e Initial load
duke
parents:
diff changeset
119 }
a61af66fc99e Initial load
duke
parents:
diff changeset
120 YieldingFlexibleWorkGang* gang() {
a61af66fc99e Initial load
duke
parents:
diff changeset
121 return _gang;
a61af66fc99e Initial load
duke
parents:
diff changeset
122 }
a61af66fc99e Initial load
duke
parents:
diff changeset
123 void set_gang(YieldingFlexibleWorkGang* gang) {
a61af66fc99e Initial load
duke
parents:
diff changeset
124 assert(_gang == NULL || gang == NULL, "Clobber without intermediate reset?");
a61af66fc99e Initial load
duke
parents:
diff changeset
125 _gang = gang;
a61af66fc99e Initial load
duke
parents:
diff changeset
126 }
a61af66fc99e Initial load
duke
parents:
diff changeset
127
a61af66fc99e Initial load
duke
parents:
diff changeset
128 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
129 // The abstract work method.
a61af66fc99e Initial load
duke
parents:
diff changeset
130 // The argument tells you which member of the gang you are.
4728
441e946dc1af 7121618: Change type of number of GC workers to unsigned int.
jmasa
parents: 4095
diff changeset
131 virtual void work(uint worker_id) = 0;
0
a61af66fc99e Initial load
duke
parents:
diff changeset
132
a61af66fc99e Initial load
duke
parents:
diff changeset
133 // Subclasses should call the parent's yield() method
a61af66fc99e Initial load
duke
parents:
diff changeset
134 // after having done any work specific to the subclass.
a61af66fc99e Initial load
duke
parents:
diff changeset
135 virtual void yield();
a61af66fc99e Initial load
duke
parents:
diff changeset
136
a61af66fc99e Initial load
duke
parents:
diff changeset
137 // An abstract method supplied by
a61af66fc99e Initial load
duke
parents:
diff changeset
138 // a concrete sub-class which is used by the coordinator
a61af66fc99e Initial load
duke
parents:
diff changeset
139 // to do any "central yielding" work.
a61af66fc99e Initial load
duke
parents:
diff changeset
140 virtual void coordinator_yield() = 0;
a61af66fc99e Initial load
duke
parents:
diff changeset
141
a61af66fc99e Initial load
duke
parents:
diff changeset
142 // Subclasses should call the parent's abort() method
a61af66fc99e Initial load
duke
parents:
diff changeset
143 // after having done any work specific to the sunbclass.
a61af66fc99e Initial load
duke
parents:
diff changeset
144 virtual void abort();
a61af66fc99e Initial load
duke
parents:
diff changeset
145
a61af66fc99e Initial load
duke
parents:
diff changeset
146 Status status() const { return _status; }
1837
c99c53f07c14 6692906: CMS: parallel concurrent marking may be prone to hanging or stalling mutators for periods of time
ysr
parents: 1833
diff changeset
147 bool yielding() const { return _status == YIELDING; }
0
a61af66fc99e Initial load
duke
parents:
diff changeset
148 bool yielded() const { return _status == YIELDED; }
a61af66fc99e Initial load
duke
parents:
diff changeset
149 bool completed() const { return _status == COMPLETED; }
a61af66fc99e Initial load
duke
parents:
diff changeset
150 bool aborted() const { return _status == ABORTED; }
a61af66fc99e Initial load
duke
parents:
diff changeset
151 bool active() const { return _status == ACTIVE; }
a61af66fc99e Initial load
duke
parents:
diff changeset
152 };
a61af66fc99e Initial load
duke
parents:
diff changeset
153 // Class YieldingWorkGang: A subclass of WorkGang.
a61af66fc99e Initial load
duke
parents:
diff changeset
154 // In particular, a YieldingWorkGang is made up of
a61af66fc99e Initial load
duke
parents:
diff changeset
155 // YieldingGangWorkers, and provides infrastructure
a61af66fc99e Initial load
duke
parents:
diff changeset
156 // supporting yielding to the "GangOverseer",
a61af66fc99e Initial load
duke
parents:
diff changeset
157 // being the thread that orchestrates the WorkGang via run_task().
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
158 class YieldingFlexibleWorkGang: public FlexibleWorkGang {
0
a61af66fc99e Initial load
duke
parents:
diff changeset
159 // Here's the public interface to this class.
a61af66fc99e Initial load
duke
parents:
diff changeset
160 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
161 // Constructor and destructor.
4728
441e946dc1af 7121618: Change type of number of GC workers to unsigned int.
jmasa
parents: 4095
diff changeset
162 YieldingFlexibleWorkGang(const char* name, uint workers,
342
37f87013dfd8 6711316: Open source the Garbage-First garbage collector
ysr
parents: 0
diff changeset
163 bool are_GC_task_threads);
0
a61af66fc99e Initial load
duke
parents:
diff changeset
164
a61af66fc99e Initial load
duke
parents:
diff changeset
165 YieldingFlexibleGangTask* yielding_task() const {
a61af66fc99e Initial load
duke
parents:
diff changeset
166 assert(task() == NULL || task()->is_YieldingFlexibleGang_task(),
a61af66fc99e Initial load
duke
parents:
diff changeset
167 "Incorrect cast");
a61af66fc99e Initial load
duke
parents:
diff changeset
168 return (YieldingFlexibleGangTask*)task();
a61af66fc99e Initial load
duke
parents:
diff changeset
169 }
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
170 // Allocate a worker and return a pointer to it.
4728
441e946dc1af 7121618: Change type of number of GC workers to unsigned int.
jmasa
parents: 4095
diff changeset
171 GangWorker* allocate_worker(uint which);
1833
8b10f48633dc 6984287: Regularize how GC parallel workers are specified.
jmasa
parents: 1552
diff changeset
172
0
a61af66fc99e Initial load
duke
parents:
diff changeset
173 // Run a task; returns when the task is done, or the workers yield,
a61af66fc99e Initial load
duke
parents:
diff changeset
174 // or the task is aborted, or the work gang is terminated via stop().
a61af66fc99e Initial load
duke
parents:
diff changeset
175 // A task that has been yielded can be continued via this same interface
a61af66fc99e Initial load
duke
parents:
diff changeset
176 // by using the same task repeatedly as the argument to the call.
a61af66fc99e Initial load
duke
parents:
diff changeset
177 // It is expected that the YieldingFlexibleGangTask carries the appropriate
a61af66fc99e Initial load
duke
parents:
diff changeset
178 // continuation information used by workers to continue the task
a61af66fc99e Initial load
duke
parents:
diff changeset
179 // from its last yield point. Thus, a completed task will return
a61af66fc99e Initial load
duke
parents:
diff changeset
180 // immediately with no actual work having been done by the workers.
a61af66fc99e Initial load
duke
parents:
diff changeset
181 void run_task(AbstractGangTask* task) {
a61af66fc99e Initial load
duke
parents:
diff changeset
182 guarantee(false, "Use start_task instead");
a61af66fc99e Initial load
duke
parents:
diff changeset
183 }
a61af66fc99e Initial load
duke
parents:
diff changeset
184 void start_task(YieldingFlexibleGangTask* new_task);
a61af66fc99e Initial load
duke
parents:
diff changeset
185 void continue_task(YieldingFlexibleGangTask* gang_task);
a61af66fc99e Initial load
duke
parents:
diff changeset
186
a61af66fc99e Initial load
duke
parents:
diff changeset
187 // Abort a currently running task, if any; returns when all the workers
a61af66fc99e Initial load
duke
parents:
diff changeset
188 // have stopped working on the current task and have returned to their
a61af66fc99e Initial load
duke
parents:
diff changeset
189 // waiting stations.
a61af66fc99e Initial load
duke
parents:
diff changeset
190 void abort_task();
a61af66fc99e Initial load
duke
parents:
diff changeset
191
a61af66fc99e Initial load
duke
parents:
diff changeset
192 // Yield: workers wait at their current working stations
a61af66fc99e Initial load
duke
parents:
diff changeset
193 // until signalled to proceed by the overseer.
a61af66fc99e Initial load
duke
parents:
diff changeset
194 void yield();
a61af66fc99e Initial load
duke
parents:
diff changeset
195
a61af66fc99e Initial load
duke
parents:
diff changeset
196 // Abort: workers are expected to return to their waiting
a61af66fc99e Initial load
duke
parents:
diff changeset
197 // stations, whence they are ready for the next task dispatched
a61af66fc99e Initial load
duke
parents:
diff changeset
198 // by the overseer.
a61af66fc99e Initial load
duke
parents:
diff changeset
199 void abort();
a61af66fc99e Initial load
duke
parents:
diff changeset
200
a61af66fc99e Initial load
duke
parents:
diff changeset
201 private:
4728
441e946dc1af 7121618: Change type of number of GC workers to unsigned int.
jmasa
parents: 4095
diff changeset
202 uint _yielded_workers;
0
a61af66fc99e Initial load
duke
parents:
diff changeset
203 void wait_for_gang();
a61af66fc99e Initial load
duke
parents:
diff changeset
204
a61af66fc99e Initial load
duke
parents:
diff changeset
205 public:
a61af66fc99e Initial load
duke
parents:
diff changeset
206 // Accessors for fields
4728
441e946dc1af 7121618: Change type of number of GC workers to unsigned int.
jmasa
parents: 4095
diff changeset
207 uint yielded_workers() const {
0
a61af66fc99e Initial load
duke
parents:
diff changeset
208 return _yielded_workers;
a61af66fc99e Initial load
duke
parents:
diff changeset
209 }
a61af66fc99e Initial load
duke
parents:
diff changeset
210
a61af66fc99e Initial load
duke
parents:
diff changeset
211 private:
a61af66fc99e Initial load
duke
parents:
diff changeset
212 friend class YieldingFlexibleGangWorker;
a61af66fc99e Initial load
duke
parents:
diff changeset
213 void reset(); // NYI
a61af66fc99e Initial load
duke
parents:
diff changeset
214 };
1972
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
215
f95d63e2154a 6989984: Use standard include model for Hospot
stefank
parents: 1837
diff changeset
216 #endif // SHARE_VM_UTILITIES_YIELDINGWORKGROUP_HPP