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 package org.graalvm.compiler.hotspot.replacements.profiling;
24
25 import static org.graalvm.compiler.hotspot.GraalHotSpotVMConfig.INJECTED_VMCONFIG;
26 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.config;
27 import static org.graalvm.compiler.nodes.extended.BranchProbabilityNode.SLOW_PATH_PROBABILITY;
28 import static org.graalvm.compiler.nodes.extended.BranchProbabilityNode.probability;
29 import static org.graalvm.compiler.replacements.SnippetTemplate.DEFAULT_REPLACER;
30
31 import org.graalvm.compiler.api.replacements.Snippet;
32 import org.graalvm.compiler.api.replacements.Snippet.ConstantParameter;
33 import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor;
34 import org.graalvm.compiler.debug.GraalError;
35 import org.graalvm.compiler.graph.Node.ConstantNodeParameter;
36 import org.graalvm.compiler.graph.Node.NodeIntrinsic;
37 import org.graalvm.compiler.hotspot.HotSpotBackend;
38 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
39 import org.graalvm.compiler.hotspot.nodes.aot.LoadMethodCountersNode;
40 import org.graalvm.compiler.hotspot.nodes.profiling.ProfileBranchNode;
41 import org.graalvm.compiler.hotspot.nodes.profiling.ProfileInvokeNode;
42 import org.graalvm.compiler.hotspot.nodes.profiling.ProfileNode;
43 import org.graalvm.compiler.hotspot.word.MethodCountersPointer;
44 import org.graalvm.compiler.nodes.ConstantNode;
45 import org.graalvm.compiler.nodes.StructuredGraph;
46 import org.graalvm.compiler.nodes.extended.ForeignCallNode;
47 import org.graalvm.compiler.nodes.spi.LoweringTool;
48 import org.graalvm.compiler.nodes.util.GraphUtil;
49 import org.graalvm.compiler.options.OptionValues;
50 import org.graalvm.compiler.replacements.SnippetTemplate;
51 import org.graalvm.compiler.replacements.SnippetTemplate.AbstractTemplates;
52 import org.graalvm.compiler.replacements.SnippetTemplate.Arguments;
53 import org.graalvm.compiler.replacements.SnippetTemplate.SnippetInfo;
54 import org.graalvm.compiler.replacements.Snippets;
55
56 import jdk.vm.ci.code.TargetDescription;
57
58 public class ProbabilisticProfileSnippets implements Snippets {
59 @Snippet
60 public static boolean shouldProfile(@ConstantParameter int probLog, int random) {
61 int probabilityMask = (1 << probLog) - 1;
62 return (random & probabilityMask) == 0;
63 }
64
65 @Snippet
66 public static int notificationMask(int freqLog, int probLog) {
67 int probabilityMask = (1 << probLog) - 1;
68 int frequencyMask = (1 << freqLog) - 1;
69 return frequencyMask & ~probabilityMask;
70 }
71
72 @NodeIntrinsic(ForeignCallNode.class)
73 public static native void methodInvocationEvent(@ConstantNodeParameter ForeignCallDescriptor descriptor, MethodCountersPointer counters);
74
75 @Snippet
76 public static void profileMethodEntryWithProbability(MethodCountersPointer counters, int random, @ConstantParameter int freqLog, @ConstantParameter int probLog) {
77 if (probability(1.0 / (1 << probLog), shouldProfile(probLog, random))) {
78 int counterValue = counters.readInt(config(INJECTED_VMCONFIG).invocationCounterOffset) + (config(INJECTED_VMCONFIG).invocationCounterIncrement << probLog);
79 counters.writeInt(config(INJECTED_VMCONFIG).invocationCounterOffset, counterValue);
80 if (freqLog >= 0) {
81 int mask = notificationMask(freqLog, probLog);
82 if (probability(SLOW_PATH_PROBABILITY, (counterValue & (mask << config(INJECTED_VMCONFIG).invocationCounterShift)) == 0)) {
83 methodInvocationEvent(HotSpotBackend.INVOCATION_EVENT, counters);
84 }
85 }
86 }
87 }
88
89 @NodeIntrinsic(ForeignCallNode.class)
90 public static native void methodBackedgeEvent(@ConstantNodeParameter ForeignCallDescriptor descriptor, MethodCountersPointer counters, int bci, int targetBci);
91
92 @Snippet
93 public static void profileBackedgeWithProbability(MethodCountersPointer counters, int random, @ConstantParameter int freqLog, @ConstantParameter int probLog, int bci, int targetBci) {
94 if (probability(1.0 / (1 << probLog), shouldProfile(probLog, random))) {
95 int counterValue = counters.readInt(config(INJECTED_VMCONFIG).backedgeCounterOffset) + (config(INJECTED_VMCONFIG).invocationCounterIncrement << probLog);
96 counters.writeInt(config(INJECTED_VMCONFIG).backedgeCounterOffset, counterValue);
97 int mask = notificationMask(freqLog, probLog);
98 if (probability(SLOW_PATH_PROBABILITY, (counterValue & (mask << config(INJECTED_VMCONFIG).invocationCounterShift)) == 0)) {
99 methodBackedgeEvent(HotSpotBackend.BACKEDGE_EVENT, counters, bci, targetBci);
100 }
101 }
102 }
103
104 @Snippet
105 public static void profileConditionalBackedgeWithProbability(MethodCountersPointer counters, int random, @ConstantParameter int freqLog, @ConstantParameter int probLog, boolean branchCondition,
106 int bci, int targetBci) {
107 if (branchCondition) {
108 profileBackedgeWithProbability(counters, random, freqLog, probLog, bci, targetBci);
109 }
110 }
111
112 public static class Templates extends AbstractTemplates {
113 private final SnippetInfo profileMethodEntryWithProbability = snippet(ProbabilisticProfileSnippets.class, "profileMethodEntryWithProbability");
114 private final SnippetInfo profileBackedgeWithProbability = snippet(ProbabilisticProfileSnippets.class, "profileBackedgeWithProbability");
115 private final SnippetInfo profileConditionalBackedgeWithProbability = snippet(ProbabilisticProfileSnippets.class, "profileConditionalBackedgeWithProbability");
116
117 public Templates(OptionValues options, HotSpotProviders providers, TargetDescription target) {
118 super(options, providers, providers.getSnippetReflection(), target);
119 }
120
121 public void lower(ProfileNode profileNode, LoweringTool tool) {
122 assert profileNode.getRandom() != null;
123
124 StructuredGraph graph = profileNode.graph();
125 LoadMethodCountersNode counters = graph.unique(new LoadMethodCountersNode(profileNode.getProfiledMethod()));
126
127 if (profileNode instanceof ProfileBranchNode) {
128 // Backedge event
129 ProfileBranchNode profileBranchNode = (ProfileBranchNode) profileNode;
130 SnippetInfo snippet = profileBranchNode.hasCondition() ? profileConditionalBackedgeWithProbability : profileBackedgeWithProbability;
131 Arguments args = new Arguments(snippet, graph.getGuardsStage(), tool.getLoweringStage());
132 ConstantNode bci = ConstantNode.forInt(profileBranchNode.bci(), graph);
133 ConstantNode targetBci = ConstantNode.forInt(profileBranchNode.targetBci(), graph);
134 args.add("counters", counters);
135 args.add("random", profileBranchNode.getRandom());
136 args.addConst("freqLog", profileBranchNode.getNotificationFreqLog());
137 args.addConst("probLog", profileBranchNode.getProbabilityLog());
138 if (profileBranchNode.hasCondition()) {
139 args.add("branchCondition", profileBranchNode.branchCondition());
140 }
141 args.add("bci", bci);
142 args.add("targetBci", targetBci);
143
144 SnippetTemplate template = template(args);
145 template.instantiate(providers.getMetaAccess(), profileNode, DEFAULT_REPLACER, args);
146 } else if (profileNode instanceof ProfileInvokeNode) {
147 ProfileInvokeNode profileInvokeNode = (ProfileInvokeNode) profileNode;
148 // Method invocation event
149 Arguments args = new Arguments(profileMethodEntryWithProbability, graph.getGuardsStage(), tool.getLoweringStage());
150 args.add("counters", counters);
151 args.add("random", profileInvokeNode.getRandom());
152 args.addConst("freqLog", profileInvokeNode.getNotificationFreqLog());
153 args.addConst("probLog", profileInvokeNode.getProbabilityLog());
154 SnippetTemplate template = template(args);
155 template.instantiate(providers.getMetaAccess(), profileNode, DEFAULT_REPLACER, args);
156 } else {
157 throw new GraalError("Unsupported profile node type: " + profileNode);
158 }
159
160 assert profileNode.hasNoUsages();
161 if (!profileNode.isDeleted()) {
162 GraphUtil.killWithUnusedFloatingInputs(profileNode);
163 }
164 }
165 }
166 }