1 /*
2 * Copyright (c) 2016, 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 * @test TestPLABPromotion
26 * @bug 8141278
27 * @summary Test PLAB promotion
28 * @requires vm.gc=="G1" | vm.gc=="null"
29 * @library /testlibrary /../../test/lib /
30 * @modules java.management
31 * @build ClassFileInstaller
32 * sun.hotspot.WhiteBox
33 * gc.g1.plab.lib.MemoryConsumer
34 * gc.g1.plab.lib.LogParser
35 * gc.g1.plab.lib.AppPLABPromotion
36 * @run main ClassFileInstaller sun.hotspot.WhiteBox
37 * sun.hotspot.WhiteBox$WhiteBoxPermission
38 * @run main gc.g1.plab.TestPLABPromotion
39 */
40 package gc.g1.plab;
41
42 import java.util.List;
43 import java.util.Map;
44 import java.util.Arrays;
45 import java.io.PrintStream;
46
47 import gc.g1.plab.lib.AppPLABPromotion;
48 import gc.g1.plab.lib.LogParser;
49 import gc.g1.plab.lib.PLABUtils;
50
51 import jdk.test.lib.OutputAnalyzer;
52 import jdk.test.lib.ProcessTools;
53 import jdk.test.lib.Platform;
54
55 /**
56 * Test checks PLAB promotion of different size objects.
57 */
58 public class TestPLABPromotion {
59
60 // GC ID with survivor PLAB statistics
61 private final static long GC_ID_SURVIVOR_STATS = 1l;
62 // GC ID with old PLAB statistics
63 private final static long GC_ID_OLD_STATS = 2l;
64
65 // Threshold to determine whether the correct amount of objects were promoted.
66 // This is only an approximate threshold for these checks.
67 private final static long MEM_CONSUMPTION_THRESHOLD = 256l * 1024l;
68
69 private static final int PLAB_SIZE_SMALL = 1024;
70 private static final int PLAB_SIZE_MEDIUM = 4096;
71 private static final int PLAB_SIZE_HIGH = 65536;
72 private static final int OBJECT_SIZE_SMALL = 10;
73 private static final int OBJECT_SIZE_MEDIUM = 100;
74 private static final int OBJECT_SIZE_HIGH = 1000;
75 private static final int GC_NUM_SMALL = 1;
76 private static final int GC_NUM_MEDIUM = 3;
77 private static final int GC_NUM_HIGH = 7;
78 private static final int WASTE_PCT_SMALL = 10;
79 private static final int WASTE_PCT_MEDIUM = 20;
80 private static final int WASTE_PCT_HIGH = 30;
81 private static final int YOUNG_SIZE_LOW = 16;
82 private static final int YOUNG_SIZE_HIGH = 64;
83 private static final boolean PLAB_FIXED = true;
84 private static final boolean PLAB_DYNAMIC = false;
85
86 private final static TestCase[] TEST_CASES = {
87 // Test cases for unreachable object, PLAB size is fixed
88 new TestCase(WASTE_PCT_SMALL, PLAB_SIZE_SMALL, OBJECT_SIZE_MEDIUM, GC_NUM_SMALL, YOUNG_SIZE_LOW, PLAB_FIXED, false, false),
89 new TestCase(WASTE_PCT_HIGH, PLAB_SIZE_MEDIUM, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_HIGH, PLAB_FIXED, false, false),
90 // Test cases for reachable objects, PLAB size is fixed
91 new TestCase(WASTE_PCT_SMALL, PLAB_SIZE_SMALL, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_HIGH, PLAB_FIXED, true, true),
92 new TestCase(WASTE_PCT_SMALL, PLAB_SIZE_MEDIUM, OBJECT_SIZE_MEDIUM, GC_NUM_SMALL, YOUNG_SIZE_LOW, PLAB_FIXED, true, true),
93 new TestCase(WASTE_PCT_SMALL, PLAB_SIZE_SMALL, OBJECT_SIZE_HIGH, GC_NUM_MEDIUM, YOUNG_SIZE_LOW, PLAB_FIXED, true, false),
94 new TestCase(WASTE_PCT_MEDIUM, PLAB_SIZE_HIGH, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_HIGH, PLAB_FIXED, true, true),
95 new TestCase(WASTE_PCT_MEDIUM, PLAB_SIZE_SMALL, OBJECT_SIZE_MEDIUM, GC_NUM_SMALL, YOUNG_SIZE_LOW, PLAB_FIXED, true, true),
96 new TestCase(WASTE_PCT_MEDIUM, PLAB_SIZE_MEDIUM, OBJECT_SIZE_HIGH, GC_NUM_MEDIUM, YOUNG_SIZE_LOW, PLAB_FIXED, true, true),
97 new TestCase(WASTE_PCT_HIGH, PLAB_SIZE_SMALL, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_HIGH, PLAB_FIXED, true, true),
98 new TestCase(WASTE_PCT_HIGH, PLAB_SIZE_HIGH, OBJECT_SIZE_MEDIUM, GC_NUM_SMALL, YOUNG_SIZE_LOW, PLAB_FIXED, true, true),
99 new TestCase(WASTE_PCT_HIGH, PLAB_SIZE_SMALL, OBJECT_SIZE_HIGH, GC_NUM_MEDIUM, YOUNG_SIZE_HIGH, PLAB_FIXED, true, false),
100 // Test cases for unreachable object, PLAB size is not fixed
101 new TestCase(WASTE_PCT_MEDIUM, PLAB_SIZE_MEDIUM, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_LOW, PLAB_DYNAMIC, false, false),
102 // Test cases for reachable objects, PLAB size is not fixed
103 new TestCase(WASTE_PCT_SMALL, PLAB_SIZE_HIGH, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_HIGH, PLAB_DYNAMIC, true, true),
104 new TestCase(WASTE_PCT_MEDIUM, PLAB_SIZE_MEDIUM, OBJECT_SIZE_SMALL, GC_NUM_SMALL, YOUNG_SIZE_LOW, PLAB_DYNAMIC, true, true),
105 new TestCase(WASTE_PCT_SMALL, PLAB_SIZE_MEDIUM, OBJECT_SIZE_HIGH, GC_NUM_HIGH, YOUNG_SIZE_HIGH, PLAB_DYNAMIC, true, false),
106 new TestCase(WASTE_PCT_MEDIUM, PLAB_SIZE_SMALL, OBJECT_SIZE_MEDIUM, GC_NUM_MEDIUM, YOUNG_SIZE_LOW, PLAB_DYNAMIC, true, true),
107 new TestCase(WASTE_PCT_HIGH, PLAB_SIZE_HIGH, OBJECT_SIZE_MEDIUM, GC_NUM_SMALL, YOUNG_SIZE_HIGH, PLAB_DYNAMIC, true, true),
108 new TestCase(WASTE_PCT_HIGH, PLAB_SIZE_HIGH, OBJECT_SIZE_SMALL, GC_NUM_HIGH, YOUNG_SIZE_LOW, PLAB_DYNAMIC, true, true)
109 };
110
111 public static void main(String[] args) throws Throwable {
112
113 for (TestCase testCase : TEST_CASES) {
114 // What we going to check.
115 testCase.print(System.out);
116 List<String> options = PLABUtils.prepareOptions(testCase.toOptions());
117 options.add(AppPLABPromotion.class.getName());
118 OutputAnalyzer out = ProcessTools.executeTestJvm(options.toArray(new String[options.size()]));
119 if (out.getExitValue() != 0) {
120 System.out.println(out.getOutput());
121 throw new RuntimeException("Expect exit code 0.");
122 }
123 checkResults(out.getOutput(), testCase);
124 }
125 }
126
127 private static void checkResults(String output, TestCase testCase) {
128 long plabAllocatedSurvivor;
129 long directAllocatedSurvivor;
130 long plabAllocatedOld;
131 long directAllocatedOld;
132 long memAllocated = testCase.getMemToFill();
133 long wordSize = Platform.is32bit() ? 4l : 8l;
134 LogParser logParser = new LogParser(output);
135
136 Map<String, Long> survivorStats = getPlabStats(logParser, LogParser.ReportType.SURVIVOR_STATS, GC_ID_SURVIVOR_STATS);
137 Map<String, Long> oldStats = getPlabStats(logParser, LogParser.ReportType.OLD_STATS, GC_ID_OLD_STATS);
138
139 plabAllocatedSurvivor = wordSize * survivorStats.get("used");
140 directAllocatedSurvivor = wordSize * survivorStats.get("direct_allocated");
141 plabAllocatedOld = wordSize * oldStats.get("used");
142 directAllocatedOld = wordSize * oldStats.get("direct_allocated");
143
144 System.out.printf("Survivor PLAB allocated:%17d Direct allocated: %17d Mem consumed:%17d%n", plabAllocatedSurvivor, directAllocatedSurvivor, memAllocated);
145 System.out.printf("Old PLAB allocated:%17d Direct allocated: %17d Mem consumed:%17d%n", plabAllocatedOld, directAllocatedOld, memAllocated);
146
147 // Unreachable objects case
148 if (testCase.isDeadObjectCase()) {
149 // No dead objects should be promoted
150 if (plabAllocatedSurvivor > MEM_CONSUMPTION_THRESHOLD || directAllocatedSurvivor > MEM_CONSUMPTION_THRESHOLD) {
151 System.out.println(output);
152 throw new RuntimeException("Unreachable objects should not be allocated using PLAB or direct allocated to Survivor");
153 }
154 if (plabAllocatedOld > MEM_CONSUMPTION_THRESHOLD || directAllocatedOld > MEM_CONSUMPTION_THRESHOLD) {
155 System.out.println(output);
156 throw new RuntimeException("Unreachable objects should not be allocated using PLAB or direct allocated to Old");
157 }
158 } else {
159 // Live objects case
160 if (testCase.isPromotedByPLAB()) {
161 // All live small objects should be promoted using PLAB
162 if (Math.abs(plabAllocatedSurvivor - memAllocated) > MEM_CONSUMPTION_THRESHOLD) {
163 System.out.println(output);
164 throw new RuntimeException("Expect that Survivor PLAB allocation are similar to all mem consumed");
165 }
166 if (Math.abs(plabAllocatedOld - memAllocated) > MEM_CONSUMPTION_THRESHOLD) {
167 System.out.println(output);
168 throw new RuntimeException("Expect that Old PLAB allocation are similar to all mem consumed");
169 }
170 } else {
171 // All big objects should be directly allocated
172 if (Math.abs(directAllocatedSurvivor - memAllocated) > MEM_CONSUMPTION_THRESHOLD) {
173 System.out.println(output);
174 throw new RuntimeException("Test fails. Expect that Survivor direct allocation are similar to all mem consumed");
175 }
176 if (Math.abs(directAllocatedOld - memAllocated) > MEM_CONSUMPTION_THRESHOLD) {
177 System.out.println(output);
178 throw new RuntimeException("Test fails. Expect that Old direct allocation are similar to all mem consumed");
179 }
180 }
181
182 // All promoted objects size should be similar to all consumed memory
183 if (Math.abs(plabAllocatedSurvivor + directAllocatedSurvivor - memAllocated) > MEM_CONSUMPTION_THRESHOLD) {
184 System.out.println(output);
185 throw new RuntimeException("Test fails. Expect that Survivor gen total allocation are similar to all mem consumed");
186 }
187 if (Math.abs(plabAllocatedOld + directAllocatedOld - memAllocated) > MEM_CONSUMPTION_THRESHOLD) {
188 System.out.println(output);
189 throw new RuntimeException("Test fails. Expect that Old gen total allocation are similar to all mem consumed");
190 }
191 }
192 System.out.println("Test passed!");
193 }
194
195 private static Map<String, Long> getPlabStats(LogParser logParser, LogParser.ReportType type, long gc_id) {
196
197 Map<String, Long> survivorStats = logParser.getEntries()
198 .get(gc_id)
199 .get(type);
200 return survivorStats;
201 }
202
203 /**
204 * Description of one test case.
205 */
206 private static class TestCase {
207
208 private final int wastePct;
209 private final int plabSize;
210 private final int chunkSize;
211 private final int parGCThreads;
212 private final int edenSize;
213 private final boolean plabIsFixed;
214 private final boolean objectsAreReachable;
215 private final boolean promotedByPLAB;
216
217 /**
218 * @param wastePct
219 * ParallelGCBufferWastePct
220 * @param plabSize
221 * -XX:OldPLABSize and -XX:YoungPLABSize
222 * @param chunkSize
223 * requested object size for memory consumption
224 * @param parGCThreads
225 * -XX:ParallelGCThreads
226 * @param edenSize
227 * NewSize and MaxNewSize
228 * @param plabIsFixed
229 * Use dynamic PLAB or fixed size PLAB
230 * @param objectsAreReachable
231 * true - allocate live objects
232 * false - allocate unreachable objects
233 * @param promotedByPLAB
234 * true - we expect to see PLAB allocation during promotion
235 * false - objects will be directly allocated during promotion
236 */
237 public TestCase(int wastePct,
238 int plabSize,
239 int chunkSize,
240 int parGCThreads,
241 int edenSize,
242 boolean plabIsFixed,
243 boolean objectsAreReachable,
244 boolean promotedByPLAB
245 ) {
246 if (wastePct == 0 || plabSize == 0 || chunkSize == 0 || parGCThreads == 0 || edenSize == 0) {
247 throw new IllegalArgumentException("Parameters should not be 0");
248 }
249 this.wastePct = wastePct;
250 this.plabSize = plabSize;
251 this.chunkSize = chunkSize;
252 this.parGCThreads = parGCThreads;
253 this.edenSize = edenSize;
254 this.plabIsFixed = plabIsFixed;
255 this.objectsAreReachable = objectsAreReachable;
256 this.promotedByPLAB = promotedByPLAB;
257 }
258
259 /**
260 * Convert current TestCase to List of options.
261 * Assume test will fill half of existed eden.
262 *
263 * @return
264 * List of options
265 */
266 public List<String> toOptions() {
267 return Arrays.asList("-XX:ParallelGCThreads=" + parGCThreads,
268 "-XX:ParallelGCBufferWastePct=" + wastePct,
269 "-XX:OldPLABSize=" + plabSize,
270 "-XX:YoungPLABSize=" + plabSize,
271 "-XX:" + (plabIsFixed ? "-" : "+") + "ResizePLAB",
272 "-Dchunk.size=" + chunkSize,
273 "-Dreachable=" + objectsAreReachable,
274 "-XX:NewSize=" + edenSize + "m",
275 "-XX:MaxNewSize=" + edenSize + "m",
276 "-Dmem.to.fill=" + getMemToFill()
277 );
278 }
279
280 /**
281 * Print details about test case.
282 */
283 public void print(PrintStream out) {
284 boolean expectPLABAllocation = promotedByPLAB && objectsAreReachable;
285 boolean expectDirectAllocation = (!promotedByPLAB) && objectsAreReachable;
286
287 out.println("Test case details:");
288 out.println(" Young gen size : " + edenSize + "M");
289 out.println(" Predefined PLAB size : " + plabSize);
290 out.println(" Parallel GC buffer waste pct : " + wastePct);
291 out.println(" Chunk size : " + chunkSize);
292 out.println(" Parallel GC threads : " + parGCThreads);
293 out.println(" Objects are created : " + (objectsAreReachable ? "reachable" : "unreachable"));
294 out.println(" PLAB size is fixed: " + (plabIsFixed ? "yes" : "no"));
295 out.println("Test expectations:");
296 out.println(" PLAB allocation : " + (expectPLABAllocation ? "expected" : "unexpected"));
297 out.println(" Direct allocation : " + (expectDirectAllocation ? "expected" : "unexpected"));
298 }
299
300 /**
301 * @return
302 * true if we expect PLAB allocation
303 * false if no
304 */
305 public boolean isPromotedByPLAB() {
306 return promotedByPLAB;
307 }
308
309 /**
310 * @return
311 * true if it is test case for unreachable objects
312 * false for live objects
313 */
314 public boolean isDeadObjectCase() {
315 return !objectsAreReachable;
316 }
317
318 /**
319 * Returns amount of memory to fill
320 *
321 * @return amount of memory
322 */
323 public long getMemToFill() {
324 return (long) (edenSize) * 1024l * 1024l / 2;
325 }
326 }
327 }