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