|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * The Universal Permissive License (UPL), Version 1.0 |
| 6 | + * |
| 7 | + * Subject to the condition set forth below, permission is hereby granted to any |
| 8 | + * person obtaining a copy of this software, associated documentation and/or |
| 9 | + * data (collectively the "Software"), free of charge and under any and all |
| 10 | + * copyright rights in the Software, and any and all patent rights owned or |
| 11 | + * freely licensable by each licensor hereunder covering either (i) the |
| 12 | + * unmodified Software as contributed to or provided by such licensor, or (ii) |
| 13 | + * the Larger Works (as defined below), to deal in both |
| 14 | + * |
| 15 | + * (a) the Software, and |
| 16 | + * |
| 17 | + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if |
| 18 | + * one is included with the Software each a "Larger Work" to which the Software |
| 19 | + * is contributed by such licensors), |
| 20 | + * |
| 21 | + * without restriction, including without limitation the rights to copy, create |
| 22 | + * derivative works of, display, perform, and distribute the Software and make, |
| 23 | + * use, sell, offer for sale, import, export, have made, and have sold the |
| 24 | + * Software and the Larger Work(s), and to sublicense the foregoing rights on |
| 25 | + * either these or other terms. |
| 26 | + * |
| 27 | + * This license is subject to the following condition: |
| 28 | + * |
| 29 | + * The above copyright notice and either this complete permission notice or at a |
| 30 | + * minimum a reference to the UPL must be included in all copies or substantial |
| 31 | + * portions of the Software. |
| 32 | + * |
| 33 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 34 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 35 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 36 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 37 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 38 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 39 | + * SOFTWARE. |
| 40 | + */ |
| 41 | +package com.oracle.truffle.api.dsl.test; |
| 42 | + |
| 43 | +import static org.junit.Assert.assertEquals; |
| 44 | + |
| 45 | +import java.lang.reflect.Field; |
| 46 | + |
| 47 | +import org.junit.Test; |
| 48 | + |
| 49 | +import com.oracle.truffle.api.dsl.Bind; |
| 50 | +import com.oracle.truffle.api.dsl.Cached; |
| 51 | +import com.oracle.truffle.api.dsl.GenerateInline; |
| 52 | +import com.oracle.truffle.api.dsl.NonIdempotent; |
| 53 | +import com.oracle.truffle.api.dsl.Specialization; |
| 54 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.BasicConstantNodeGen; |
| 55 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.CachedInlinedNodeGen; |
| 56 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.CachedSimpleNodeGen; |
| 57 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.InlineMultiInstanceNodeGen; |
| 58 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.InlineSingleInstanceNodeGen; |
| 59 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.MethodGuardNodeGen; |
| 60 | +import com.oracle.truffle.api.dsl.test.SingleSpecializationStateTestFactory.TypeGuardNodeGen; |
| 61 | +import com.oracle.truffle.api.nodes.Node; |
| 62 | +import com.oracle.truffle.api.profiles.InlinedCountingConditionProfile; |
| 63 | + |
| 64 | +@DisableStateBitWidthModfication |
| 65 | +public class SingleSpecializationStateTest { |
| 66 | + |
| 67 | + @GenerateInline(false) |
| 68 | + abstract static class BasicConstantNode extends BaseNode { |
| 69 | + @Specialization |
| 70 | + static Object doDefault(Object a) { |
| 71 | + return a; |
| 72 | + } |
| 73 | + } |
| 74 | + |
| 75 | + @Test |
| 76 | + public void testBasicConstant() { |
| 77 | + assertEquals(0, countStateFields(BasicConstantNodeGen.class)); |
| 78 | + } |
| 79 | + |
| 80 | + @GenerateInline(false) |
| 81 | + abstract static class TypeGuardNode extends BaseNode { |
| 82 | + @Specialization |
| 83 | + static Object doDefault(int a) { |
| 84 | + return a; |
| 85 | + } |
| 86 | + } |
| 87 | + |
| 88 | + @Test |
| 89 | + public void testTypeGuard() { |
| 90 | + assertEquals(0, countStateFields(TypeGuardNodeGen.class)); |
| 91 | + } |
| 92 | + |
| 93 | + @GenerateInline(false) |
| 94 | + abstract static class MethodGuardNode extends BaseNode { |
| 95 | + @Specialization(guards = "true") |
| 96 | + static Object doDefault(Object a) { |
| 97 | + return a; |
| 98 | + } |
| 99 | + } |
| 100 | + |
| 101 | + @Test |
| 102 | + public void testMethodGuardNode() { |
| 103 | + assertEquals(0, countStateFields(MethodGuardNodeGen.class)); |
| 104 | + } |
| 105 | + |
| 106 | + @GenerateInline(false) |
| 107 | + @SuppressWarnings("truffle-neverdefault") |
| 108 | + abstract static class CachedSimpleNode extends BaseNode { |
| 109 | + @Specialization |
| 110 | + static Object doDefault(Object a, |
| 111 | + // all cached state needs to be initialized so we need a state bitset |
| 112 | + @SuppressWarnings("unused") @Cached("true") boolean cached) { |
| 113 | + return a; |
| 114 | + } |
| 115 | + } |
| 116 | + |
| 117 | + @Test |
| 118 | + public void testCachedNode() { |
| 119 | + assertEquals(1, countStateFields(CachedSimpleNodeGen.class)); |
| 120 | + } |
| 121 | + |
| 122 | + @GenerateInline(false) |
| 123 | + @SuppressWarnings("truffle-neverdefault") |
| 124 | + abstract static class CachedInlinedNode extends BaseNode { |
| 125 | + @Specialization |
| 126 | + static Object doDefault(Object a, |
| 127 | + // generates fields but no state bitset |
| 128 | + @SuppressWarnings("unused") @Cached InlinedCountingConditionProfile cached) { |
| 129 | + return a; |
| 130 | + } |
| 131 | + } |
| 132 | + |
| 133 | + @Test |
| 134 | + public void testCachedInlinedNode() { |
| 135 | + assertEquals(0, countStateFields(CachedInlinedNodeGen.class)); |
| 136 | + } |
| 137 | + |
| 138 | + @GenerateInline(false) |
| 139 | + @SuppressWarnings("unused") |
| 140 | + abstract static class InlineSingleInstanceNode extends BaseNode { |
| 141 | + |
| 142 | + @Specialization(guards = "myGuard(a, cached1)", limit = "1") |
| 143 | + static Object doDefault(Object a, |
| 144 | + @Cached InlinedCountingConditionProfile cached1) { |
| 145 | + return a; |
| 146 | + } |
| 147 | + |
| 148 | + @NonIdempotent |
| 149 | + static boolean myGuard(Object a, InlinedCountingConditionProfile profile) { |
| 150 | + return false; |
| 151 | + } |
| 152 | + } |
| 153 | + |
| 154 | + @Test |
| 155 | + public void testInlineSingleInstanceNode() { |
| 156 | + assertEquals(0, countStateFields(InlineSingleInstanceNodeGen.class)); |
| 157 | + } |
| 158 | + |
| 159 | + @GenerateInline(false) |
| 160 | + @SuppressWarnings("unused") |
| 161 | + abstract static class InlineMultiInstanceNode extends BaseNode { |
| 162 | + |
| 163 | + @Specialization(guards = "myGuard(node, a, cached1)", limit = "2") |
| 164 | + static Object doDefault(Object a, |
| 165 | + @Bind Node node, |
| 166 | + // inline condition profiles in guards need state |
| 167 | + // as it may have multiple instances |
| 168 | + @Cached InlinedCountingConditionProfile cached1) { |
| 169 | + return a; |
| 170 | + } |
| 171 | + |
| 172 | + @NonIdempotent |
| 173 | + static boolean myGuard(Node node, Object a, InlinedCountingConditionProfile profile) { |
| 174 | + return false; |
| 175 | + } |
| 176 | + } |
| 177 | + |
| 178 | + @Test |
| 179 | + public void testIInlineMultiInstanceNode() { |
| 180 | + assertEquals(1, countStateFields(InlineMultiInstanceNodeGen.class)); |
| 181 | + } |
| 182 | + |
| 183 | + private static int countStateFields(Class<?> c) { |
| 184 | + int fieldCount = 0; |
| 185 | + for (Field field : c.getDeclaredFields()) { |
| 186 | + if (field.getName().startsWith("state")) { |
| 187 | + fieldCount++; |
| 188 | + } |
| 189 | + } |
| 190 | + return fieldCount; |
| 191 | + } |
| 192 | + |
| 193 | + abstract static class BaseNode extends Node { |
| 194 | + |
| 195 | + abstract Object execute(Object a); |
| 196 | + |
| 197 | + } |
| 198 | + |
| 199 | +} |
0 commit comments