com.oracle.svm.hosted.jni.JNIRuntimeAccess Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of svm Show documentation
SubstrateVM image builder components
There is a newer version: 19.2.1
/*
 * Copyright (c) 2017, 2017, 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.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * 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.
 */
package com.oracle.svm.hosted.jni;

// Checkstyle: allow reflection

import java.lang.reflect.Executable;
import java.lang.reflect.Field;

import com.oracle.svm.core.SubstrateOptions;
import org.graalvm.nativeimage.ImageSingletons;
import org.graalvm.nativeimage.Platform;
import org.graalvm.nativeimage.Platforms;

import com.oracle.svm.core.option.SubstrateOptionsParser;
import com.oracle.svm.core.util.UserError;

/**
 * Support for registering classes, methods and fields before and during the analysis so they are
 * accessible via JNI at image runtime.
 */
@Platforms(Platform.HOSTED_ONLY.class)
public final class JNIRuntimeAccess {

    private JNIRuntimeAccess() {
    }

    public static void register(Class... classes) {
        getSupport().register(classes);
    }

    public static void register(Executable... methods) {
        getSupport().register(methods);
    }

    public static void register(Field... fields) {
        register(false, fields);
    }

    public static void register(boolean finalIsWritable, Field... fields) {
        getSupport().register(finalIsWritable, fields);
    }

    private static JNIRuntimeAccessibilitySupport getSupport() {
        if (!ImageSingletons.contains(JNIRuntimeAccessibilitySupport.class)) {
            throw UserError.abort("Support for JNI is not enabled. The option " + SubstrateOptionsParser.HOSTED_OPTION_PREFIX + SubstrateOptions.JNI + " must be set.");
        }
        return ImageSingletons.lookup(JNIRuntimeAccessibilitySupport.class);
    }

    public interface JNIRuntimeAccessibilitySupport {
        void register(Class... classes);

        void register(Executable... methods);

        void register(boolean forceWritable, Field... fields);
    }
}