1 /*
2 * Copyright (c) 2012, 2015, 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.stubs;
24
25 import static org.graalvm.compiler.hotspot.GraalHotSpotVMConfig.INJECTED_VMCONFIG;
26 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.arrayPrototypeMarkWord;
27 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.getAndClearObjectResult;
28 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperElementTypeMask;
29 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperElementTypeShift;
30 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperHeaderSizeMask;
31 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperHeaderSizeShift;
32 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperLog2ElementSizeMask;
33 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.layoutHelperLog2ElementSizeShift;
34 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.readLayoutHelper;
35 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.registerAsWord;
36 import static org.graalvm.compiler.hotspot.replacements.HotSpotReplacementsUtil.wordSize;
37 import static org.graalvm.compiler.hotspot.replacements.NewObjectSnippets.MAX_ARRAY_FAST_PATH_ALLOCATION_LENGTH;
38 import static org.graalvm.compiler.hotspot.replacements.NewObjectSnippets.formatArray;
39 import static org.graalvm.compiler.hotspot.stubs.NewInstanceStub.refillAllocate;
40 import static org.graalvm.compiler.hotspot.stubs.StubUtil.handlePendingException;
41 import static org.graalvm.compiler.hotspot.stubs.StubUtil.newDescriptor;
42 import static org.graalvm.compiler.hotspot.stubs.StubUtil.printf;
43 import static org.graalvm.compiler.hotspot.stubs.StubUtil.verifyObject;
44 import static jdk.vm.ci.hotspot.HotSpotMetaAccessProvider.computeArrayAllocationSize;
45
46 import org.graalvm.compiler.api.replacements.Fold;
47 import org.graalvm.compiler.api.replacements.Snippet;
48 import org.graalvm.compiler.api.replacements.Snippet.ConstantParameter;
49 import org.graalvm.compiler.core.common.spi.ForeignCallDescriptor;
50 import org.graalvm.compiler.graph.Node.ConstantNodeParameter;
51 import org.graalvm.compiler.graph.Node.NodeIntrinsic;
52 import org.graalvm.compiler.hotspot.HotSpotForeignCallLinkage;
53 import org.graalvm.compiler.hotspot.meta.HotSpotProviders;
54 import org.graalvm.compiler.hotspot.nodes.GraalHotSpotVMConfigNode;
55 import org.graalvm.compiler.hotspot.nodes.StubForeignCallNode;
56 import org.graalvm.compiler.hotspot.nodes.type.KlassPointerStamp;
57 import org.graalvm.compiler.hotspot.replacements.NewObjectSnippets;
58 import org.graalvm.compiler.hotspot.word.KlassPointer;
59 import org.graalvm.compiler.nodes.ConstantNode;
60 import org.graalvm.compiler.options.OptionValues;
61 import org.graalvm.compiler.word.Word;
62 import org.graalvm.word.WordFactory;
63
64 import jdk.vm.ci.code.Register;
65 import jdk.vm.ci.hotspot.HotSpotResolvedObjectType;
66
67 /**
68 * Stub implementing the fast path for TLAB refill during instance class allocation. This stub is
69 * called from the {@linkplain NewObjectSnippets inline} allocation code when TLAB allocation fails.
70 * If this stub fails to refill the TLAB or allocate the object, it calls out to the HotSpot C++
71 * runtime to complete the allocation.
72 */
73 public class NewArrayStub extends SnippetStub {
74
75 public NewArrayStub(OptionValues options, HotSpotProviders providers, HotSpotForeignCallLinkage linkage) {
76 super("newArray", options, providers, linkage);
77 }
78
79 @Override
80 protected Object[] makeConstArgs() {
81 HotSpotResolvedObjectType intArrayType = (HotSpotResolvedObjectType) providers.getMetaAccess().lookupJavaType(int[].class);
82 int count = method.getSignature().getParameterCount(false);
83 Object[] args = new Object[count];
84 assert checkConstArg(3, "intArrayHub");
85 assert checkConstArg(4, "threadRegister");
86 assert checkConstArg(5, "options");
87 args[3] = ConstantNode.forConstant(KlassPointerStamp.klassNonNull(), intArrayType.klass(), null);
88 args[4] = providers.getRegisters().getThreadRegister();
89 args[5] = options;
90 return args;
91 }
92
93 @Fold
94 static boolean logging(OptionValues options) {
95 return StubOptions.TraceNewArrayStub.getValue(options);
96 }
97
98 /**
99 * Re-attempts allocation after an initial TLAB allocation failed or was skipped (e.g., due to
100 * -XX:-UseTLAB).
101 *
102 * @param hub the hub of the object to be allocated
103 * @param length the length of the array
104 * @param fillContents Should the array be filled with zeroes?
105 * @param intArrayHub the hub for {@code int[].class}
106 */
107 @Snippet
108 private static Object newArray(KlassPointer hub, int length, boolean fillContents, @ConstantParameter KlassPointer intArrayHub, @ConstantParameter Register threadRegister,
109 @ConstantParameter OptionValues options) {
110 int layoutHelper = readLayoutHelper(hub);
111 int log2ElementSize = (layoutHelper >> layoutHelperLog2ElementSizeShift(INJECTED_VMCONFIG)) & layoutHelperLog2ElementSizeMask(INJECTED_VMCONFIG);
112 int headerSize = (layoutHelper >> layoutHelperHeaderSizeShift(INJECTED_VMCONFIG)) & layoutHelperHeaderSizeMask(INJECTED_VMCONFIG);
113 int elementKind = (layoutHelper >> layoutHelperElementTypeShift(INJECTED_VMCONFIG)) & layoutHelperElementTypeMask(INJECTED_VMCONFIG);
114 int sizeInBytes = computeArrayAllocationSize(length, wordSize(), headerSize, log2ElementSize);
115 if (logging(options)) {
116 printf("newArray: element kind %d\n", elementKind);
117 printf("newArray: array length %d\n", length);
118 printf("newArray: array size %d\n", sizeInBytes);
119 printf("newArray: hub=%p\n", hub.asWord().rawValue());
120 }
121
122 // check that array length is small enough for fast path.
123 Word thread = registerAsWord(threadRegister);
124 boolean inlineContiguousAllocationSupported = GraalHotSpotVMConfigNode.inlineContiguousAllocationSupported();
125 if (inlineContiguousAllocationSupported && length >= 0 && length <= MAX_ARRAY_FAST_PATH_ALLOCATION_LENGTH) {
126 Word memory = refillAllocate(thread, intArrayHub, sizeInBytes, logging(options));
127 if (memory.notEqual(0)) {
128 if (logging(options)) {
129 printf("newArray: allocated new array at %p\n", memory.rawValue());
130 }
131 return verifyObject(
132 formatArray(hub, sizeInBytes, length, headerSize, memory, WordFactory.unsigned(arrayPrototypeMarkWord(INJECTED_VMCONFIG)), fillContents, false, null));
133 }
134 }
135 if (logging(options)) {
136 printf("newArray: calling new_array_c\n");
137 }
138
139 newArrayC(NEW_ARRAY_C, thread, hub, length);
140 handlePendingException(thread, true);
141 return verifyObject(getAndClearObjectResult(thread));
142 }
143
144 public static final ForeignCallDescriptor NEW_ARRAY_C = newDescriptor(NewArrayStub.class, "newArrayC", void.class, Word.class, KlassPointer.class, int.class);
145
146 @NodeIntrinsic(StubForeignCallNode.class)
147 public static native void newArrayC(@ConstantNodeParameter ForeignCallDescriptor newArrayC, Word thread, KlassPointer hub, int length);
148 }