com.oracle.truffle.nfi.NativeSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of truffle-nfi Show documentation
Native function interface for the Truffle framework.
There is a newer version: 24.1.0
/*
 * Copyright (c) 2017, 2021, 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 com.oracle.truffle.nfi;

import java.util.ArrayList;
import java.util.List;

import com.oracle.truffle.nfi.SignatureRootNode.BuildSignatureNode;
import com.oracle.truffle.nfi.backend.spi.types.NativeLibraryDescriptor;

/**
 * Parsed representation of a Truffle NFI source. To use the Truffle NFI, evaluate a source with the
 * mime-type application/x-native. See {@link Parser} for the syntax of the Truffle NFI source.
 */
final class NativeSource {

    private final String nfiId;
    private final Content content;

    NativeSource(String nfiId, Content content) {
        this.nfiId = nfiId;
        this.content = content;
    }

    public boolean isDefaultBackend() {
        return nfiId == null;
    }

    public String getNFIBackendId() {
        return nfiId;
    }

    public Content getContent() {
        return content;
    }

    abstract static class Content {
    }

    static final class ParsedSignature extends Content {

        private final BuildSignatureNode buildSignature;

        ParsedSignature(BuildSignatureNode buildSignature) {
            this.buildSignature = buildSignature;
        }

        public BuildSignatureNode getBuildSignatureNode() {
            return buildSignature;
        }
    }

    static final class ParsedLibrary extends Content {
        private final NativeLibraryDescriptor libraryDescriptor;

        private final List preBoundSymbols;
        private final List preBoundSignatures;

        ParsedLibrary(NativeLibraryDescriptor libraryDescriptor) {
            this.libraryDescriptor = libraryDescriptor;
            this.preBoundSymbols = new ArrayList<>();
            this.preBoundSignatures = new ArrayList<>();
        }

        public NativeLibraryDescriptor getLibraryDescriptor() {
            return libraryDescriptor;
        }

        public int preBoundSymbolsLength() {
            return preBoundSymbols.size();
        }

        public String getPreBoundSymbol(int i) {
            return preBoundSymbols.get(i);
        }

        public BuildSignatureNode getPreBoundSignature(int i) {
            return preBoundSignatures.get(i);
        }

        void register(String symbol, BuildSignatureNode signature) {
            preBoundSymbols.add(symbol);
            preBoundSignatures.add(signature);
        }
    }
}