svm: Support for build-time initialization of HijrahChronology

Author: zapster

substratevm/src/com.oracle.svm.core/src/com/oracle/svm/core/jdk/HijrahChronologyFeature.java

@@ -1,55 +1,102 @@
 /*
- * Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2025, 2025, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
- * The Universal Permissive License (UPL), Version 1.0
+ * 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.  Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
  *
- * Subject to the condition set forth below, permission is hereby granted to any
- * person obtaining a copy of this software, associated documentation and/or
- * data (collectively the "Software"), free of charge and under any and all
- * copyright rights in the Software, and any and all patent rights owned or
- * freely licensable by each licensor hereunder covering either (i) the
- * unmodified Software as contributed to or provided by such licensor, or (ii)
- * the Larger Works (as defined below), to deal in both
+ * 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).
  *
- * (a) the Software, and
+ * 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.
  *
- * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if
- * one is included with the Software each a "Larger Work" to which the Software
- * is contributed by such licensors),
- *
- * without restriction, including without limitation the rights to copy, create
- * derivative works of, display, perform, and distribute the Software and make,
- * use, sell, offer for sale, import, export, have made, and have sold the
- * Software and the Larger Work(s), and to sublicense the foregoing rights on
- * either these or other terms.
- *
- * This license is subject to the following condition:
- *
- * The above copyright notice and either this complete permission notice or at a
- * minimum a reference to the UPL must be included in all copies or substantial
- * portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
+ * 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.
  */
 package com.oracle.svm.core.jdk;
 
-import org.graalvm.nativeimage.hosted.RuntimeResourceAccess;
+import java.nio.file.Path;
+import java.time.chrono.HijrahChronology;
+import java.util.Properties;
 
+import com.oracle.svm.core.annotate.Delete;
+import com.oracle.svm.core.annotate.Substitute;
+import com.oracle.svm.core.annotate.TargetClass;
 import com.oracle.svm.core.feature.AutomaticallyRegisteredFeature;
 import com.oracle.svm.core.feature.InternalFeature;
 
+/**
+ * Feature to configure {@link HijrahChronology} at build time. All {@link HijrahChronology} object
+ * that end up in the image heap are fully initialized. This has the advantage that the resources
+ * and files for configuring the {@link HijrahChronology} variants are not needed at run time. On
+ * the other hand, the configuration can no longer be changed after building. See
+ * {@link HijrahChronology} for configuration option.
+ */
 @AutomaticallyRegisteredFeature
 public class HijrahChronologyFeature implements InternalFeature {
     @Override
-    public void beforeAnalysis(BeforeAnalysisAccess access) {
-        access.registerReachabilityHandler((e) -> RuntimeResourceAccess.addResource(Class.class.getModule(),
-                "java/time/chrono/hijrah-config-Hijrah-umalqura_islamic-umalqura.properties"), access.findClassByName("java.time.chrono.HijrahChronology"));
+    public void duringSetup(DuringSetupAccess access) {
+        access.registerObjectReplacer(o -> {
+            if (o instanceof HijrahChronology hc) {
+                // implicitly initialize via transitive call to checkCalendarInit()
+                hc.isLeapYear(0);
+            }
+            return o;
+        });
+    }
+}
+
+@TargetClass(HijrahChronology.class)
+final class Target_java_time_chrono_HijrahChronology {
+    // Checkstyle: stop
+    /**
+     * Config path with includes JAVA_HOME. We force full initialization at build time
+     * {@link HijrahChronologyFeature#duringSetup}, so no need to keep this.
+     */
+    @Delete //
+    private static Path CONF_PATH;
+    // Checkstyle: resume
+
+    /**
+     * @see #CONF_PATH
+     */
+    @Delete
+    private static native void registerCustomChrono();
+
+    /**
+     * @see #CONF_PATH
+     */
+    @Delete
+    private native void loadCalendarData();
+
+    /**
+     * @see #CONF_PATH
+     */
+    @Delete
+    private static native Properties readConfigProperties(String chronologyId, String calendarType);
+
+    /**
+     * @see #CONF_PATH
+     */
+    @Delete //
+    private boolean initComplete;
+
+    /**
+     * No more initialization needed.
+     *
+     * @see #CONF_PATH
+     */
+    @Substitute
+    private void checkCalendarInit() {
+        // initialized at build time
     }
-}
+}

substratevm/src/com.oracle.svm.hosted/src/com/oracle/svm/hosted/jdk/JDKInitializationFeature.java

@@ -72,6 +72,8 @@ public void afterRegistration(AfterRegistrationAccess access) {
         rci.initializeAtBuildTime("java.nio", JDK_CLASS_REASON);
         rci.initializeAtBuildTime("java.text", JDK_CLASS_REASON);
         rci.initializeAtBuildTime("java.time", JDK_CLASS_REASON);
+        // see HijrahChronologyFeature for more details
+        rci.initializeAtBuildTime("java.time.chrono.HijrahChronology", "Needs to be fully initialized at build time");
         rci.initializeAtBuildTime("java.util", JDK_CLASS_REASON);
         rci.initializeAtRunTime("java.util.concurrent.SubmissionPublisher", "Executor service must be recomputed");