org.pkl.thirdparty.graalvm.nativeimage.Platform Maven / Gradle / Ivy
Show all versions of pkl-tools Show documentation
/*
* Copyright (c) 2013, 2024, 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
*
* 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
*
* (a) the Software, and
*
* (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.
*/
package org.pkl.thirdparty.graalvm.nativeimage;
import org.pkl.thirdparty.graalvm.nativeimage.impl.InternalPlatform;
/**
* Root of the interface hierarchy for architectures, OS, and supported combinations of them.
*
* A platform group (e.g., an architecture or OS) is an interface extending {@link Platform}. A leaf
* platform, e.g., a supported architecture-OS-combination, is a class that implements all the
* groups that it belongs to. A leaf platform class must be non-abstract and must have a no-argument
* constructor. It is good practice to make leaf platform classes {@code final} (to prevent
* accidental subclassing) and to avoid state (i.e., no fields).
*
* The annotation {@link Platforms} restricts a type, method, or field to certain platform groups or
* leaf platforms.
*
* This system makes the set of platform groups and leaf platforms extensible. Some standard
* platforms are defined as inner classes.
*
* @since 19.0
*/
public interface Platform {
/**
* The system property name that specifies the fully qualified name of the {@link Platform}
* implementation class that should be used. If the property is not specified, the platform
* class is inferred from the standard architectures and operating systems specified in this
* file, i.e., in most cases it is not necessary to use this property.
*
* @since 19.0
*/
String PLATFORM_PROPERTY_NAME = "svm.platform";
/**
* Returns true if the current platform (the platform that the native image is built for) is
* included in the provided platform group.
*
* The platformGroup must be a compile-time constant, so that the call to this method can be
* replaced with the constant boolean result.
*
* @since 19.0
*/
static boolean includedIn(Class platformGroup) {
return platformGroup.isInstance(ImageSingletons.lookup(Platform.class));
}
/**
* Returns the string representing Platform's OS name.
*
* This method should be implemented either in a final class or as default method in respective
* OS interface.
*
* @since 21.0
*/
default String getOS() {
throw new UnsupportedOperationException("Platform `" + this.getClass().getCanonicalName() + "`, doesn't implement getOS");
}
/**
* Returns the string representing Platform's architecture name. This value should be the same
* as desired os.arch system property.
*
* This method should be implemented either in final class or as default method in respective
* architecture interface.
*
* @since 21.0
*/
default String getArchitecture() {
throw new UnsupportedOperationException("Platform `" + this.getClass().getCanonicalName() + "`, doesn't implement getArchitecture");
}
/*
* The standard architectures that are supported.
*/
/**
* Supported architecture: x86 64-bit.
*
* @since 19.0
*/
interface AMD64 extends Platform, InternalPlatform.NATIVE_ONLY {
/**
* Returns string representing AMD64 architecture.
*
* @since 21.0
*/
default String getArchitecture() {
return "amd64";
}
}
/**
* Supported architecture: ARMv8 64-bit.
*
* @since 19.0
*/
interface AARCH64 extends Platform, InternalPlatform.NATIVE_ONLY {
/**
* Returns string representing AARCH64 architecture.
*
* @since 21.0
*/
default String getArchitecture() {
return "aarch64";
}
}
/**
* Supported architecture: RISC-V 64-bit.
*
* @since 22.2
*/
interface RISCV64 extends Platform {
/**
* Returns string representing RISCV64 architecture.
*
* @since 22.2
*/
default String getArchitecture() {
return "riscv64";
}
}
/*
* The standard operating systems that are supported.
*/
/**
* Supported operating system: Linux.
*
* @since 19.0
*/
interface LINUX extends InternalPlatform.PLATFORM_JNI, InternalPlatform.NATIVE_ONLY {
/**
* Returns string representing LINUX OS.
*
* @since 21.0
*/
default String getOS() {
return "linux";
}
}
/**
* Supported operating system: Android.
*
* @since 21.0
*/
interface ANDROID extends LINUX {
/**
* Returns string representing ANDROID OS.
*
* @since 21.0
*/
default String getOS() {
return "android";
}
}
/**
* Basis for all Apple operating systems (MacOS and iOS).
*
* @since 19.0
*/
interface DARWIN extends InternalPlatform.PLATFORM_JNI, InternalPlatform.NATIVE_ONLY {
}
/**
* Supported operating system: iOS.
*
* @since 21.0
*/
interface IOS extends DARWIN {
/**
* Returns string representing iOS OS.
*
* @since 21.0
*/
default String getOS() {
return "ios";
}
}
/**
* Supported operating system: MacOS.
*
* @since 22.1
*/
interface MACOS extends DARWIN {
/**
* Returns string representing MACOS OS.
*
* @since 21.0
*/
default String getOS() {
return "darwin";
}
}
/**
* Supported operating system: Windows.
*
* @since 19.0
*/
interface WINDOWS extends InternalPlatform.PLATFORM_JNI, InternalPlatform.NATIVE_ONLY {
/**
* Returns string representing WINDOWS OS.
*
* @since 21.0
*/
default String getOS() {
return "windows";
}
}
/**
* Basis for all Linux operating systems on AMD64 (LINUX_AMD64).
*
* @since 22.1
*/
interface LINUX_AMD64_BASE extends LINUX, AMD64 {
}
/**
* Basis for all Linux operating systems on AARCH64 (LINUX_AARCH64 & ANDROID_AARCH64).
*
* @since 22.1
*/
interface LINUX_AARCH64_BASE extends LINUX, AARCH64 {
}
/**
* Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).
*
* @since 22.1
*/
interface DARWIN_AMD64 extends DARWIN, AMD64 {
}
/**
* Basis for all Apple operating systems on AMD64 (MACOS_AMD64 & IOS_AMD64).
*
* @since 22.1
*/
interface DARWIN_AARCH64 extends DARWIN, AARCH64 {
}
/*
* The standard leaf platforms, i.e., OS-architecture combinations that we support.
*/
/**
* Supported leaf platform: Linux on x86 64-bit.
*
* @since 19.0
*/
class LINUX_AMD64 implements LINUX, LINUX_AMD64_BASE {
/**
* Instantiates a marker instance of this platform.
*
* @since 19.0
*/
public LINUX_AMD64() {
}
}
/**
* Supported leaf platform: Linux on AArch64 64-bit.
*
* @since 19.0
*/
final class LINUX_AARCH64 implements LINUX, LINUX_AARCH64_BASE {
/**
* Instantiates a marker instance of this platform.
*
* @since 19.0
*/
public LINUX_AARCH64() {
}
}
/**
* Supported leaf platform: Linux on RISC-V 64-bit.
*
* @since 22.2
*/
final class LINUX_RISCV64 implements LINUX, RISCV64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 22.2
*/
public LINUX_RISCV64() {
}
}
/**
* Supported leaf platform: Android on AArch64 64-bit.
*
* @since 21.0
*/
final class ANDROID_AARCH64 implements ANDROID, LINUX_AARCH64_BASE {
/**
* Instantiates a marker instance of this platform.
*
* @since 21.0
*/
public ANDROID_AARCH64() {
}
}
/**
* Supported leaf platform: iOS on x86 64-bit.
*
* @since 21.3
*/
final class IOS_AMD64 implements IOS, DARWIN_AMD64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 21.3
*/
public IOS_AMD64() {
}
}
/**
* Supported leaf platform: iOS on AArch 64-bit.
*
* @since 21.0
*/
final class IOS_AARCH64 implements IOS, DARWIN_AARCH64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 21.0
*/
public IOS_AARCH64() {
}
}
/**
* Supported leaf platform: MacOS on x86 64-bit.
*
* @since 22.1
*/
final class MACOS_AMD64 implements MACOS, DARWIN_AMD64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 22.1
*/
public MACOS_AMD64() {
}
}
/**
* Supported leaf platform: MacOS on AArch 64-bit.
*
* @since 22.1
*/
final class MACOS_AARCH64 implements MACOS, DARWIN_AARCH64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 22.1
*/
public MACOS_AARCH64() {
}
}
/**
* Supported leaf platform: Windows on x86 64-bit.
*
* @since 19.0
*/
final class WINDOWS_AMD64 implements WINDOWS, AMD64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 19.0
*/
public WINDOWS_AMD64() {
}
}
/**
* Supported leaf platform: Windows on AArch 64-bit.
*
* @since 22.0
*/
final class WINDOWS_AARCH64 implements WINDOWS, AARCH64 {
/**
* Instantiates a marker instance of this platform.
*
* @since 22.0
*/
public WINDOWS_AARCH64() {
}
}
/**
* Marker for elements (types, methods, or fields) that are only visible during native image
* generation and cannot be used at run time, regardless of the actual platform.
*
* @since 19.0
*/
final class HOSTED_ONLY implements Platform {
private HOSTED_ONLY() {
}
}
}