Skip to content

Commit 2b918d0

Browse files
fthevenetfthevenet
authored
Refactored parts of the new ZGC parsing API to improve consistency (#455)
1 parent ac3f722 commit 2b918d0

File tree

8 files changed

+108
-108
lines changed

8 files changed

+108
-108
lines changed

‎api/src/main/java/com/microsoft/gctoolkit/event/zgc/OccupancySummary.java‎

Lines changed: 0 additions & 40 deletions
This file was deleted.

‎api/src/main/java/com/microsoft/gctoolkit/event/zgc/ZGCCollection.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public class ZGCCollection extends GCEvent {
2323
private ZGCCompactedSummary compactedSummary;
2424
private ZGCCycleType type;
2525
private ZGCPhase phase;
26-
private OccupancySummary generationUsedSummary;
26+
private ZGCUsedSummary usedSummary;
2727
private long gcId;
2828
private DateTimeStamp pauseMarkStartTimeStamp;
2929
private double pauseMarkStartDuration;
@@ -59,7 +59,7 @@ public class ZGCCollection extends GCEvent {
5959
private ZGCLiveSummary liveSummary;
6060
private ZGCAllocatedSummary allocatedSummary;
6161
private ZGCGarbageSummary garbageSummary;
62-
private ZGCReclaimSummary reclaimSummary;
62+
private ZGCReclaimedSummary reclaimedSummary;
6363
private ZGCMemorySummary memorySummary;
6464
private ZGCMetaspaceSummary metaspaceSummary;
6565
private ZGCHeapCapacitySummary heapCapacitySummary;
@@ -304,12 +304,12 @@ public void setGarbageSummary(ZGCGarbageSummary summary) {
304304
this.garbageSummary = summary;
305305
}
306306

307-
public ZGCReclaimSummary getReclaimSummary() {
308-
return reclaimSummary;
307+
public ZGCReclaimedSummary getReclaimedSummary() {
308+
return reclaimedSummary;
309309
}
310310

311-
public void setReclaimSummary(ZGCReclaimSummary summary) {
312-
this.reclaimSummary = summary;
311+
public void setReclaimedSummary(ZGCReclaimedSummary summary) {
312+
this.reclaimedSummary = summary;
313313
}
314314

315315
public ZGCMemorySummary getMemorySummary() {
@@ -416,13 +416,13 @@ public void setCompactedSummary(ZGCCompactedSummary compactedSummary) {
416416
this.compactedSummary = compactedSummary;
417417
}
418418

419-
public void setGenerationUsedSummary(OccupancySummary usedOccupancySummary) {
419+
public void setUsedSummary(ZGCUsedSummary usedZGCUsedSummary) {
420420

421-
this.generationUsedSummary = usedOccupancySummary;
421+
this.usedSummary = usedZGCUsedSummary;
422422
}
423423

424-
public OccupancySummary getGenerationUsedSummary() {
425-
return generationUsedSummary;
424+
public ZGCUsedSummary getUsedSummary() {
425+
return usedSummary;
426426
}
427427

428428
public ZGCCycleType getType() {

‎api/src/main/java/com/microsoft/gctoolkit/event/zgc/ZGCReclaimSummary.java‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎api/src/main/java/com/microsoft/gctoolkit/event/zgc/ZGCReclaimedSummary.java‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
// Copyright (c) Microsoft Corporation.
2+
// Licensed under the MIT License.
3+
package com.microsoft.gctoolkit.event.zgc;
4+
5+
public class ZGCReclaimedSummary {
6+
7+
private final long relocateStart;
8+
private final long relocateEnd;
9+
10+
public ZGCReclaimedSummary(long reclaimStart, long relocateEnd) {
11+
this.relocateStart = reclaimStart;
12+
this.relocateEnd = relocateEnd;
13+
}
14+
15+
public long getRelocateStart() {
16+
return relocateStart;
17+
}
18+
19+
public long getRelocateEnd() {
20+
return relocateEnd;
21+
}
22+
23+
public ZGCReclaimedSummary sum(ZGCReclaimedSummary other) {
24+
if (other == null) {
25+
return this;
26+
}
27+
return new ZGCReclaimedSummary(relocateStart + other.relocateStart, relocateEnd + other.relocateEnd);
28+
}
29+
30+
}

‎api/src/main/java/com/microsoft/gctoolkit/event/zgc/ZGCUsedSummary.java‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// Copyright (c) Microsoft Corporation.
2+
// Licensed under the MIT License.
3+
package com.microsoft.gctoolkit.event.zgc;
4+
5+
public class ZGCUsedSummary {
6+
private final long markStart;
7+
private final long markEnd;
8+
private final long relocateStart;
9+
private final long relocateEnd;
10+
11+
public ZGCUsedSummary(long markStart, long markEnd, long relocateStart, long reclaimEnd) {
12+
this.markStart = markStart;
13+
this.markEnd = markEnd;
14+
this.relocateStart = relocateStart;
15+
this.relocateEnd = reclaimEnd;
16+
}
17+
18+
public long getMarkEnd() {
19+
return markEnd;
20+
}
21+
22+
public long getRelocateStart() {
23+
return relocateStart;
24+
}
25+
26+
public long getRelocateEnd() {
27+
return relocateEnd;
28+
}
29+
30+
public long getMarkStart() {
31+
return markStart;
32+
}
33+
34+
public ZGCUsedSummary sum(ZGCUsedSummary other) {
35+
if (other == null) {
36+
return this;
37+
}
38+
return new ZGCUsedSummary(markStart + other.markStart, markEnd + other.markEnd, relocateStart + other.relocateStart, relocateEnd + other.relocateEnd);
39+
}
40+
}

‎parser/src/main/java/com/microsoft/gctoolkit/parser/ZGCParser.java‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
import com.microsoft.gctoolkit.event.zgc.ZGCGarbageSummary;
1515
import com.microsoft.gctoolkit.event.zgc.ZGCHeapCapacitySummary;
1616
import com.microsoft.gctoolkit.event.zgc.ZGCLiveSummary;
17-
import com.microsoft.gctoolkit.event.zgc.OccupancySummary;
17+
import com.microsoft.gctoolkit.event.zgc.ZGCUsedSummary;
1818
import com.microsoft.gctoolkit.event.zgc.ZGCCompactedSummary;
1919
import com.microsoft.gctoolkit.event.zgc.ZGCFullCollection;
2020
import com.microsoft.gctoolkit.event.zgc.ZGCYoungCollection;
@@ -23,7 +23,7 @@
2323
import com.microsoft.gctoolkit.event.zgc.ZGCPageSummary;
2424
import com.microsoft.gctoolkit.event.zgc.ZGCPhase;
2525
import com.microsoft.gctoolkit.event.zgc.ZGCPromotedSummary;
26-
import com.microsoft.gctoolkit.event.zgc.ZGCReclaimSummary;
26+
import com.microsoft.gctoolkit.event.zgc.ZGCReclaimedSummary;
2727
import com.microsoft.gctoolkit.event.zgc.ZGCCycleType;
2828
import com.microsoft.gctoolkit.event.zgc.ZGCCollection;
2929
import com.microsoft.gctoolkit.event.zgc.ZGCMarkSummary;
@@ -463,12 +463,12 @@ private void sizeEntry(GCLogTrace trace, String s) {
463463

464464
if (genHeapStats) {
465465
if ("Used".equals(trace.getGroup(2))){
466-
OccupancySummary summary = new OccupancySummary(
466+
ZGCUsedSummary summary = new ZGCUsedSummary(
467467
trace.toKBytes(3),
468468
trace.toKBytes(6),
469469
trace.toKBytes(9),
470470
trace.toKBytes(12));
471-
ref.setGenerationUsedSummary(phase, summary);
471+
ref.setUsedSummary(phase, summary);
472472
} else {
473473
trace.notYetImplemented();
474474
}
@@ -520,8 +520,8 @@ private void reclaimedPromoted(GCLogTrace trace, String s) {
520520
ZGCForwardReference ref = getForwardRefForPhase(trace.getZCollectionPhase());
521521

522522
if ("Reclaimed".equals(trace.getGroup(2))) {
523-
ref.setReclaimSummary(
524-
new ZGCReclaimSummary(
523+
ref.setReclaimedSummary(
524+
new ZGCReclaimedSummary(
525525
trace.toKBytes(3),
526526
trace.toKBytes(6)
527527
)
@@ -711,7 +711,7 @@ private static class ZGCForwardReference {
711711
private ZGCLiveSummary liveSummary;
712712
private ZGCAllocatedSummary allocatedSummary;
713713
private ZGCGarbageSummary garbageSummary;
714-
private ZGCReclaimSummary reclaimSummary;
714+
private ZGCReclaimedSummary reclaimedSummary;
715715
private ZGCMemorySummary memorySummary;
716716
private ZGCMetaspaceSummary metaspaceSummary;
717717
private ZGCMarkSummary markSummary;
@@ -734,7 +734,7 @@ private static class ZGCForwardReference {
734734
private ZGCPromotedSummary promotedSummary;
735735
private ZGCCompactedSummary compactedSummary;
736736
private Double gcDuration;
737-
private OccupancySummary generationUsedSummary;
737+
private ZGCUsedSummary usedSummary;
738738
private ZGCReferenceSummary softRefSummary;
739739
private ZGCReferenceSummary weakRefSummary;
740740
private ZGCReferenceSummary finalRefSummary;
@@ -798,7 +798,7 @@ public GCEvent getGCEVent(DateTimeStamp endTime) {
798798
cycle.setConcurrentRemapRoots(concurrentRemapRootsStart, concurrentRemapRootsDuration);
799799
cycle.setPromotedSummary(promotedSummary);
800800
cycle.setCompactedSummary(compactedSummary);
801-
cycle.setGenerationUsedSummary(generationUsedSummary);
801+
cycle.setUsedSummary(usedSummary);
802802
cycle.setSoftRefSummary(softRefSummary);
803803
cycle.setWeakRefSummary(weakRefSummary);
804804
cycle.setFinalRefSummary(finalRefSummary);
@@ -813,7 +813,7 @@ public GCEvent getGCEVent(DateTimeStamp endTime) {
813813
cycle.setLiveSummary(liveSummary);
814814
cycle.setAllocatedSummary(allocatedSummary);
815815
cycle.setGarbageSummary(garbageSummary);
816-
cycle.setReclaimSummary(reclaimSummary);
816+
cycle.setReclaimedSummary(reclaimedSummary);
817817
cycle.setMemorySummary(memorySummary);
818818
cycle.setMetaspaceSummary(metaspaceSummary);
819819
cycle.setLoadAverages(load);
@@ -928,8 +928,8 @@ public void setGarbageSummary(ZGCGarbageSummary summary) {
928928
this.garbageSummary = summary;
929929
}
930930

931-
public void setReclaimSummary(ZGCReclaimSummary summary) {
932-
reclaimSummary = summary;
931+
public void setReclaimedSummary(ZGCReclaimedSummary summary) {
932+
reclaimedSummary = summary;
933933
}
934934

935935
public void setMemorySummary(ZGCMemorySummary summary) {
@@ -1034,15 +1034,15 @@ public void setGcDuration(double gcDuration) {
10341034
this.gcDuration = gcDuration;
10351035
}
10361036

1037-
public void setGenerationUsedSummary(ZGCPhase phase, OccupancySummary summary) {
1037+
public void setUsedSummary(ZGCPhase phase, ZGCUsedSummary summary) {
10381038
switch (phase) {
10391039
case FULL:
10401040
// does not apply to non generational GC
10411041
break;
10421042
case MAJOR_YOUNG:
10431043
case MAJOR_OLD:
10441044
case MINOR_YOUNG:
1045-
this.generationUsedSummary = summary;
1045+
this.usedSummary = summary;
10461046
break;
10471047
}
10481048
}

‎parser/src/test/java/com/microsoft/gctoolkit/parser/GenerationalZGCParserTest.java‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -166,12 +166,12 @@ public void testZgcMajorCycle() {
166166

167167
assertTrue(checkZGCMetaSpaceSummary(young.getMetaspaceSummary(),36, 37, 1088));
168168

169-
assertTrue(checkUsedSummary(young.getGenerationUsedSummary(), 296, 308, 240, 76));
169+
assertTrue(checkUsedSummary(young.getUsedSummary(), 296, 308, 240, 76));
170170
assertTrue(checkLiveSummary(young.getLiveSummary(), 24, 24, 24));
171171
assertTrue(checkGarbageSummary(young.getGarbageSummary(), 271, 203, 31));
172172
assertTrue(checkAllocatedSummary(young.getAllocatedSummary(), 12, 12, 19));
173173

174-
assertTrue(checkReclaimSummary(young.getReclaimSummary(), 68, 239));
174+
assertTrue(checkReclaimSummary(young.getReclaimedSummary(), 68, 239));
175175
assertTrue(checkPromotedSummary(young.getPromotedSummary(), 0, 0));
176176
assertTrue(checkCompactedSummary(young.getCompactedSummary(), 10));
177177

@@ -253,12 +253,12 @@ public void testZgcMajorCycle() {
253253

254254
assertEquals(125 * 1024, old.getForwardingUsage());
255255

256-
assertTrue(checkUsedSummary(old.getGenerationUsedSummary(), 0, 0, 0, 0));
256+
assertTrue(checkUsedSummary(old.getUsedSummary(), 0, 0, 0, 0));
257257
assertTrue(checkLiveSummary(old.getLiveSummary(), 0, 0, 0));
258258
assertTrue(checkGarbageSummary(old.getGarbageSummary(), 0, 0, 0));
259259
assertTrue(checkAllocatedSummary(old.getAllocatedSummary(), 0, 0, 0));
260260

261-
assertTrue(checkReclaimSummary(old.getReclaimSummary(), 0, 0));
261+
assertTrue(checkReclaimSummary(old.getReclaimedSummary(), 0, 0));
262262
assertNull(old.getPromotedSummary());
263263
assertTrue(checkCompactedSummary(old.getCompactedSummary(), 0));
264264

@@ -375,12 +375,12 @@ public void testZgcMinorCycle() {
375375

376376
assertTrue(checkZGCMetaSpaceSummary(young.getMetaspaceSummary(),100, 101, 1152));
377377

378-
assertTrue(checkUsedSummary(young.getGenerationUsedSummary(), 14132, 14900, 12364, 1466));
378+
assertTrue(checkUsedSummary(young.getUsedSummary(), 14132, 14900, 12364, 1466));
379379
assertTrue(checkLiveSummary(young.getLiveSummary(), 120, 120, 120));
380380
assertTrue(checkGarbageSummary(young.getGarbageSummary(), 14011, 11457, 2));
381381
assertTrue(checkAllocatedSummary(young.getAllocatedSummary(), 768, 786, 1343));
382382

383-
assertTrue(checkReclaimSummary(young.getReclaimSummary(), 2554, 14009));
383+
assertTrue(checkReclaimSummary(young.getReclaimedSummary(), 2554, 14009));
384384
assertTrue(checkPromotedSummary(young.getPromotedSummary(), 0, 0));
385385
assertTrue(checkCompactedSummary(young.getCompactedSummary(), 104));
386386

@@ -638,8 +638,8 @@ private boolean checkReferenceSummary(ZGCReferenceSummary refSummary, long encou
638638
return refSummary.getEncountered() == encounderted && refSummary.getDiscovered() == discovered && refSummary.getEnqueued() == enqueued;
639639
}
640640

641-
private boolean checkUsedSummary(OccupancySummary summary, long markStart, long markEnd, long relocateStart, long relocateEnd) {
642-
return summary.getMarkStart() == (markStart * 1024) && summary.getMarkEnd() == (markEnd * 1024) && summary.getReclaimStart() == (relocateStart * 1024) && summary.getReclaimEnd() == (relocateEnd * 1024);
641+
private boolean checkUsedSummary(ZGCUsedSummary summary, long markStart, long markEnd, long relocateStart, long relocateEnd) {
642+
return summary.getMarkStart() == (markStart * 1024) && summary.getMarkEnd() == (markEnd * 1024) && summary.getRelocateStart() == (relocateStart * 1024) && summary.getRelocateEnd() == (relocateEnd * 1024);
643643
}
644644

645645
private boolean checkDateTimeStampMatch(String expected, double offsetMs, DateTimeStamp dateTimeStamp) {
@@ -687,8 +687,8 @@ private boolean checkGarbageSummary(ZGCGarbageSummary summary, long markEnd, lon
687687
return summary.getMarkEnd() == (markEnd * 1024) && summary.getRelocateStart() == (relocateStart * 1024) && summary.getRelocateEnd() == (relocateEnd * 1024);
688688
}
689689

690-
private boolean checkReclaimSummary(ZGCReclaimSummary summary, long relocateStart, long relocateEnd) {
691-
return summary.getReclaimStart() == (relocateStart * 1024) && summary.getReclaimEnd() == (relocateEnd * 1024);
690+
private boolean checkReclaimSummary(ZGCReclaimedSummary summary, long relocateStart, long relocateEnd) {
691+
return summary.getRelocateStart() == (relocateStart * 1024) && summary.getRelocateEnd() == (relocateEnd * 1024);
692692
}
693693

694694
private boolean checkPromotedSummary(ZGCPromotedSummary summary, long relocateStart, long relocateEnd) {

0 commit comments

Comments
 (0)