File: LazyInitializingTest.java

package info (click to toggle)
openjdk-22 22.0.2%2B9-5
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 804,256 kB
  • sloc: java: 5,596,301; cpp: 1,293,691; xml: 1,241,820; ansic: 419,447; asm: 404,850; objc: 20,892; sh: 15,423; javascript: 11,361; python: 6,802; makefile: 2,311; perl: 357; awk: 351; sed: 172; jsp: 24; csh: 3
file content (217 lines) | stat: -rw-r--r-- 7,747 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/*
 * Copyright (c) 2023, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/*
 * @test
 * @bug 8291065
 * @summary Checks interaction of static field VarHandle with class
 *          initialization mechanism..
 * @run junit LazyInitializingTest
 * @run junit/othervm -Djava.lang.invoke.VarHandle.VAR_HANDLE_IDENTITY_ADAPT=true LazyInitializingTest
 * @run junit/othervm -Djava.lang.invoke.VarHandle.VAR_HANDLE_GUARDS=false LazyInitializingTest
 * @run junit/othervm -Djava.lang.invoke.VarHandle.VAR_HANDLE_IDENTITY_ADAPT=true
 *                    -Djava.lang.invoke.VarHandle.VAR_HANDLE_GUARDS=false LazyInitializingTest
 */

import org.junit.jupiter.api.Test;

import java.io.IOException;
import java.lang.constant.ConstantDescs;
import java.lang.invoke.MethodHandles;
import java.lang.invoke.VarHandle;
import java.util.Objects;

import static org.junit.jupiter.api.Assertions.*;

public class LazyInitializingTest {

    record SampleData(Runnable callback, int initialValue) {
        private static final Runnable FAIL_ON_CLINIT_CALLBACK = () -> {
            throw new AssertionError("Class shouldn't be initialized");
        };
        static final SampleData FAIL_ON_CLINIT = new SampleData();

        SampleData() {
            this(FAIL_ON_CLINIT_CALLBACK, 0);
        }
    }
    record ClassInfo(MethodHandles.Lookup definingLookup, VarHandle vh) {}

    private static final MethodHandles.Lookup LOOKUP = MethodHandles.lookup();

    /**
     * Meta test to ensure the testing mechanism to check initialization is correct.
     */
    @Test
    public void testMeta() throws IllegalAccessException {
        boolean[] val = new boolean[1];
        var v0 = createSampleClass(new SampleData(() -> val[0] = true, 0));
        assertFalse(val[0], "callback run before class init");
        v0.definingLookup.ensureInitialized(v0.definingLookup.lookupClass());
        assertTrue(val[0], "callback not run at class init");
    }

    @Test
    public void testUninitializedOperations() {
        var ci = createSampleClass(SampleData.FAIL_ON_CLINIT);
        var vh = ci.vh;
        vh.describeConstable();
        vh.isAccessModeSupported(VarHandle.AccessMode.GET_AND_BITWISE_XOR_ACQUIRE);
        vh.withInvokeExactBehavior();
        vh.withInvokeBehavior();
        vh.toMethodHandle(VarHandle.AccessMode.GET_AND_BITWISE_XOR_ACQUIRE);
        vh.hasInvokeExactBehavior();
        vh.accessModeType(VarHandle.AccessMode.GET_AND_BITWISE_XOR_ACQUIRE);
    }

    @Test
    public void testInitializationOnVarHandleUse() {
        var initialized = new boolean[1];
        var ci = createSampleClass(new SampleData(() -> initialized[0] = true, 42));
        var vh = ci.vh;

        assertEquals(42, (int) vh.get(), "VH does not read value set in class initializer");
        assertTrue(initialized[0], "class initialization not captured");
    }

    @Test
    public void testInitializationOnToMethodHandleUse() throws Throwable {
        var initialized = new boolean[1];
        var ci = createSampleClass(new SampleData(() -> initialized[0] = true, 42));
        var mh = ci.vh.toMethodHandle(VarHandle.AccessMode.GET);

        assertEquals(42, (int) mh.invokeExact(), "VH does not read value set in class initializer");
        assertTrue(initialized[0], "class initialization not captured");
    }

    @Test
    public void testParentChildLoading() throws Throwable {
        // ChildSample: ensure only ParentSample (field declarer) is initialized
        var l = new ParentChildLoader();
        var childSampleClass = l.childClass();
        var lookup = MethodHandles.privateLookupIn(childSampleClass, LOOKUP);
        var childVh = lookup.findStaticVarHandle(childSampleClass, "f", int.class);

        assertEquals(3, (int) childVh.get(), "Child class initialized unnecessarily");

        lookup.ensureInitialized(childSampleClass);

        assertEquals(6, (int) childVh.get(), "Child class was not initialized");
    }

    static ClassInfo createSampleClass(SampleData sampleData) {
        try {
            var lookup = LOOKUP.defineHiddenClassWithClassData(sampleClassBytes(), sampleData, false);
            var vh = lookup.findStaticVarHandle(lookup.lookupClass(), "f", int.class);
            return new ClassInfo(lookup, vh);
        } catch (IllegalAccessException | NoSuchFieldException ex) {
            throw new AssertionError(ex);
        }
    }

    private static byte[] sampleClassBytes;

    private static byte[] sampleClassBytes() {
        var bytes = sampleClassBytes;
        if (bytes != null)
            return bytes;

        try (var in = LazyInitializingTest.class.getResourceAsStream("LazyInitializingSample.class")) {
            if (in == null)
                throw new AssertionError("class file not found");
            return sampleClassBytes = in.readAllBytes();
        } catch (IOException ex) {
            throw new AssertionError(ex);
        }
    }
}

// This is used as a template class, whose bytes are used to define
// hidden classes instead
class LazyInitializingSample {
    static int f;

    static {
        try {
            var data = MethodHandles.classData(MethodHandles.lookup(), ConstantDescs.DEFAULT_NAME,
                    LazyInitializingTest.SampleData.class);
            Objects.requireNonNull(data);

            data.callback().run();
            f = data.initialValue();
        } catch (IllegalAccessException e) {
            throw new ExceptionInInitializerError(e);
        }
    }
}

class ParentChildLoader extends ClassLoader {
    ParentChildLoader() {
        super(LazyInitializingTest.class.getClassLoader().getParent());
    }

    Class<?> parentClass() {
        try {
            return loadClass("ParentSample");
        } catch (ClassNotFoundException e) {
            throw new AssertionError(e);
        }
    }

    Class<?> childClass() {
        try {
            return loadClass("ChildSample");
        } catch (ClassNotFoundException e) {
            throw new AssertionError(e);
        }
    }

    @Override
    protected Class<?> findClass(String name) throws ClassNotFoundException {
        try (var stream = switch (name) {
            case "ParentSample", "ChildSample" -> LazyInitializingTest.class.getResourceAsStream(name + ".class");
            default -> throw new ClassNotFoundException(name);
        }) {
            if (stream == null)
                throw new AssertionError();
            var b = stream.readAllBytes();
            return defineClass(name, b, 0, b.length);
        } catch (IOException ex) {
            throw new AssertionError(ex);
        }
    }
}

class ParentSample {
    static int f;

    static {
        f = 3;
    }
}

class ChildSample extends ParentSample {
    static {
        f = 6;
    }
}