Mercurial > hg > graal-compiler
annotate src/share/vm/utilities/yieldingWorkgroup.hpp @ 1833:8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
Summary: Associate number of GC workers with the workgang as opposed to the task.
Reviewed-by: johnc, ysr
| author | jmasa |
|---|---|
| date | Mon, 20 Sep 2010 14:38:38 -0700 |
| parents | c18cbe5936b8 |
| children | c99c53f07c14 |
| rev | line source |
|---|---|
| 0 | 1 /* |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
2 * Copyright (c) 2005, 2010 Oracle and/or its affiliates. All rights reserved. |
| 0 | 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 * | |
|
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 | 22 * |
| 23 */ | |
| 24 | |
| 25 | |
| 26 // Forward declarations | |
| 27 class YieldingFlexibleWorkGang; | |
| 28 | |
| 29 // Status of tasks | |
| 30 enum Status { | |
| 31 INACTIVE, | |
| 32 ACTIVE, | |
| 33 YIELDING, | |
| 34 YIELDED, | |
| 35 ABORTING, | |
| 36 ABORTED, | |
| 37 COMPLETING, | |
| 38 COMPLETED | |
| 39 }; | |
| 40 | |
| 41 // Class YieldingFlexibleGangWorker: | |
| 42 // Several instances of this class run in parallel as workers for a gang. | |
| 43 class YieldingFlexibleGangWorker: public GangWorker { | |
| 44 public: | |
| 45 // Ctor | |
| 46 YieldingFlexibleGangWorker(AbstractWorkGang* gang, int id) : | |
| 47 GangWorker(gang, id) { } | |
| 48 | |
| 49 public: | |
| 50 YieldingFlexibleWorkGang* yf_gang() const | |
| 51 { return (YieldingFlexibleWorkGang*)gang(); } | |
| 52 | |
| 53 protected: // Override from parent class | |
| 54 virtual void loop(); | |
| 55 }; | |
| 56 | |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
57 class FlexibleGangTask: public AbstractGangTask { |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
58 int _actual_size; // size of gang obtained |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
59 protected: |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
60 int _requested_size; // size of gang requested |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
61 public: |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
62 FlexibleGangTask(const char* name): AbstractGangTask(name), |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
63 _requested_size(0) {} |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
64 |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
65 // The abstract work method. |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
66 // The argument tells you which member of the gang you are. |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
67 virtual void work(int i) = 0; |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
68 |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
69 int requested_size() const { return _requested_size; } |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
70 int actual_size() const { return _actual_size; } |
|
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 void set_requested_size(int sz) { _requested_size = sz; } |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
73 void set_actual_size(int sz) { _actual_size = sz; } |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
74 }; |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
75 |
| 0 | 76 // An abstract task to be worked on by a flexible work gang, |
| 77 // and where the workers will periodically yield, usually | |
| 78 // in response to some condition that is signalled by means | |
| 79 // that are specific to the task at hand. | |
| 80 // You subclass this to supply your own work() method. | |
| 81 // A second feature of this kind of work gang is that | |
| 82 // it allows for the signalling of certain exceptional | |
| 83 // conditions that may be encountered during the performance | |
| 84 // of the task and that may require the task at hand to be | |
| 85 // `aborted' forthwith. Finally, these gangs are `flexible' | |
| 86 // in that they can operate at partial capacity with some | |
| 87 // gang workers waiting on the bench; in other words, the | |
| 88 // size of the active worker pool can flex (up to an apriori | |
| 89 // maximum) in response to task requests at certain points. | |
| 90 // The last part (the flexible part) has not yet been fully | |
| 91 // fleshed out and is a work in progress. | |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
92 class YieldingFlexibleGangTask: public FlexibleGangTask { |
| 0 | 93 Status _status; |
| 94 YieldingFlexibleWorkGang* _gang; | |
| 95 | |
| 96 protected: | |
| 97 // Constructor and desctructor: only construct subclasses. | |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
98 YieldingFlexibleGangTask(const char* name): FlexibleGangTask(name), |
| 0 | 99 _status(INACTIVE), |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
100 _gang(NULL) { } |
| 0 | 101 |
| 102 virtual ~YieldingFlexibleGangTask() { } | |
| 103 | |
| 104 friend class YieldingFlexibleWorkGang; | |
| 105 friend class YieldingFlexibleGangWorker; | |
| 106 NOT_PRODUCT(virtual bool is_YieldingFlexibleGang_task() const { | |
| 107 return true; | |
| 108 }) | |
| 109 | |
| 110 void set_status(Status s) { | |
| 111 _status = s; | |
| 112 } | |
| 113 YieldingFlexibleWorkGang* gang() { | |
| 114 return _gang; | |
| 115 } | |
| 116 void set_gang(YieldingFlexibleWorkGang* gang) { | |
| 117 assert(_gang == NULL || gang == NULL, "Clobber without intermediate reset?"); | |
| 118 _gang = gang; | |
| 119 } | |
| 120 | |
| 121 public: | |
| 122 // The abstract work method. | |
| 123 // The argument tells you which member of the gang you are. | |
| 124 virtual void work(int i) = 0; | |
| 125 | |
| 126 // Subclasses should call the parent's yield() method | |
| 127 // after having done any work specific to the subclass. | |
| 128 virtual void yield(); | |
| 129 | |
| 130 // An abstract method supplied by | |
| 131 // a concrete sub-class which is used by the coordinator | |
| 132 // to do any "central yielding" work. | |
| 133 virtual void coordinator_yield() = 0; | |
| 134 | |
| 135 // Subclasses should call the parent's abort() method | |
| 136 // after having done any work specific to the sunbclass. | |
| 137 virtual void abort(); | |
| 138 | |
| 139 Status status() const { return _status; } | |
| 140 bool yielded() const { return _status == YIELDED; } | |
| 141 bool completed() const { return _status == COMPLETED; } | |
| 142 bool aborted() const { return _status == ABORTED; } | |
| 143 bool active() const { return _status == ACTIVE; } | |
| 144 }; | |
| 145 // Class YieldingWorkGang: A subclass of WorkGang. | |
| 146 // In particular, a YieldingWorkGang is made up of | |
| 147 // YieldingGangWorkers, and provides infrastructure | |
| 148 // supporting yielding to the "GangOverseer", | |
| 149 // 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
|
150 class YieldingFlexibleWorkGang: public FlexibleWorkGang { |
| 0 | 151 // Here's the public interface to this class. |
| 152 public: | |
| 153 // Constructor and destructor. | |
| 342 | 154 YieldingFlexibleWorkGang(const char* name, int workers, |
| 155 bool are_GC_task_threads); | |
| 0 | 156 |
| 157 YieldingFlexibleGangTask* yielding_task() const { | |
| 158 assert(task() == NULL || task()->is_YieldingFlexibleGang_task(), | |
| 159 "Incorrect cast"); | |
| 160 return (YieldingFlexibleGangTask*)task(); | |
| 161 } | |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
162 // Allocate a worker and return a pointer to it. |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
163 GangWorker* allocate_worker(int which); |
|
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
164 |
| 0 | 165 // Run a task; returns when the task is done, or the workers yield, |
| 166 // or the task is aborted, or the work gang is terminated via stop(). | |
| 167 // A task that has been yielded can be continued via this same interface | |
| 168 // by using the same task repeatedly as the argument to the call. | |
| 169 // It is expected that the YieldingFlexibleGangTask carries the appropriate | |
| 170 // continuation information used by workers to continue the task | |
| 171 // from its last yield point. Thus, a completed task will return | |
| 172 // immediately with no actual work having been done by the workers. | |
| 173 void run_task(AbstractGangTask* task) { | |
| 174 guarantee(false, "Use start_task instead"); | |
| 175 } | |
| 176 void start_task(YieldingFlexibleGangTask* new_task); | |
| 177 void continue_task(YieldingFlexibleGangTask* gang_task); | |
| 178 | |
| 179 // Abort a currently running task, if any; returns when all the workers | |
| 180 // have stopped working on the current task and have returned to their | |
| 181 // waiting stations. | |
| 182 void abort_task(); | |
| 183 | |
| 184 // Yield: workers wait at their current working stations | |
| 185 // until signalled to proceed by the overseer. | |
| 186 void yield(); | |
| 187 | |
| 188 // Abort: workers are expected to return to their waiting | |
| 189 // stations, whence they are ready for the next task dispatched | |
| 190 // by the overseer. | |
| 191 void abort(); | |
| 192 | |
| 193 private: | |
| 194 int _active_workers; | |
| 195 int _yielded_workers; | |
| 196 void wait_for_gang(); | |
| 197 | |
| 198 public: | |
| 199 // Accessors for fields | |
| 200 int active_workers() const { | |
| 201 return _active_workers; | |
| 202 } | |
| 203 | |
|
1833
8b10f48633dc
6984287: Regularize how GC parallel workers are specified.
jmasa
parents:
1552
diff
changeset
|
204 // Accessors for fields |
| 0 | 205 int yielded_workers() const { |
| 206 return _yielded_workers; | |
| 207 } | |
| 208 | |
| 209 private: | |
| 210 friend class YieldingFlexibleGangWorker; | |
| 211 void reset(); // NYI | |
| 212 }; |