|
| 1 | +/* |
| 2 | + * Copyright (c) 2025, 2025, Oracle and/or its affiliates. All rights reserved. |
| 3 | + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| 4 | + * |
| 5 | + * The Universal Permissive License (UPL), Version 1.0 |
| 6 | + * |
| 7 | + * Subject to the condition set forth below, permission is hereby granted to any |
| 8 | + * person obtaining a copy of this software, associated documentation and/or |
| 9 | + * data (collectively the "Software"), free of charge and under any and all |
| 10 | + * copyright rights in the Software, and any and all patent rights owned or |
| 11 | + * freely licensable by each licensor hereunder covering either (i) the |
| 12 | + * unmodified Software as contributed to or provided by such licensor, or (ii) |
| 13 | + * the Larger Works (as defined below), to deal in both |
| 14 | + * |
| 15 | + * (a) the Software, and |
| 16 | + * |
| 17 | + * (b) any piece of software and/or hardware listed in the lrgrwrks.txt file if |
| 18 | + * one is included with the Software each a "Larger Work" to which the Software |
| 19 | + * is contributed by such licensors), |
| 20 | + * |
| 21 | + * without restriction, including without limitation the rights to copy, create |
| 22 | + * derivative works of, display, perform, and distribute the Software and make, |
| 23 | + * use, sell, offer for sale, import, export, have made, and have sold the |
| 24 | + * Software and the Larger Work(s), and to sublicense the foregoing rights on |
| 25 | + * either these or other terms. |
| 26 | + * |
| 27 | + * This license is subject to the following condition: |
| 28 | + * |
| 29 | + * The above copyright notice and either this complete permission notice or at a |
| 30 | + * minimum a reference to the UPL must be included in all copies or substantial |
| 31 | + * portions of the Software. |
| 32 | + * |
| 33 | + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 34 | + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 35 | + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 36 | + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 37 | + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 38 | + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 39 | + * SOFTWARE. |
| 40 | + */ |
| 41 | +package org.graalvm.shadowed.org.jline.terminal.impl.ffm; |
| 42 | + |
| 43 | +import java.lang.foreign.FunctionDescriptor; |
| 44 | +import java.lang.foreign.Linker; |
| 45 | +import java.lang.foreign.MemoryLayout; |
| 46 | +import java.lang.foreign.StructLayout; |
| 47 | +import java.lang.foreign.ValueLayout; |
| 48 | + |
| 49 | +import org.graalvm.nativeimage.Platform; |
| 50 | +import org.graalvm.nativeimage.hosted.Feature; |
| 51 | +import org.graalvm.nativeimage.hosted.RuntimeForeignAccess; |
| 52 | +import org.graalvm.shadowed.org.jline.terminal.spi.TerminalProvider; |
| 53 | + |
| 54 | +public class FFMTerminalProviderLoader { |
| 55 | + /** |
| 56 | + * Build time flag to disable the FFM provider and avoid pulling FFM related code into the |
| 57 | + * image. |
| 58 | + */ |
| 59 | + static final boolean DISABLED = Boolean.getBoolean("org.graalvm.shadowed.org.jline.terminal.ffm.disable"); |
| 60 | + |
| 61 | + public static TerminalProvider load() { |
| 62 | + if (DISABLED) { |
| 63 | + return null; |
| 64 | + } |
| 65 | + return new org.graalvm.shadowed.org.jline.terminal.impl.ffm.FfmTerminalProvider(); |
| 66 | + } |
| 67 | +} |
| 68 | + |
| 69 | +class FFMTerminalProviderFeature implements Feature { |
| 70 | + private record DowncallDesc(FunctionDescriptor fd, Linker.Option... options) { |
| 71 | + } |
| 72 | + |
| 73 | + private static StructLayout WIN_COORD_LAYOUT = MemoryLayout.structLayout(ValueLayout.JAVA_SHORT.withName("x"), ValueLayout.JAVA_SHORT.withName("y")); |
| 74 | + |
| 75 | + // Downcalls from CLibrary.java |
| 76 | + private static DowncallDesc[] getUnixDowncalls() { |
| 77 | + return new DowncallDesc[]{ |
| 78 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.JAVA_LONG, ValueLayout.ADDRESS), Linker.Option.firstVariadicArg(2)), // ioctl |
| 79 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.JAVA_INT)), // isatty |
| 80 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // tcsetattr |
| 81 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // tcgetattr |
| 82 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_LONG)), // ttyname_r |
| 83 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.ADDRESS)) // openpty |
| 84 | + }; |
| 85 | + } |
| 86 | + |
| 87 | + // Downcalls from Kernel32 |
| 88 | + private static DowncallDesc[] getWindowsDowncalls() { |
| 89 | + return new DowncallDesc[]{ |
| 90 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_INT)), // WaitForSingleObject |
| 91 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.ADDRESS, ValueLayout.JAVA_INT)), // GetStdHandle |
| 92 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_INT, ValueLayout.JAVA_INT, ValueLayout.ADDRESS, |
| 93 | + ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // FormatMessageW |
| 94 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_SHORT)), // SetConsoleTextAttribute |
| 95 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_INT)), // SetConsoleMode |
| 96 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS)), // GetConsoleMode |
| 97 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // SetConsoleTitleW |
| 98 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, WIN_COORD_LAYOUT)), // SetConsoleCursorPosition |
| 99 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_CHAR, ValueLayout.JAVA_INT, WIN_COORD_LAYOUT, ValueLayout.ADDRESS)), // FillConsoleOutputCharacterW |
| 100 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.JAVA_SHORT, ValueLayout.JAVA_INT, WIN_COORD_LAYOUT, ValueLayout.ADDRESS)), // FillConsoleOutputAttribute |
| 101 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS)), // WriteConsoleW |
| 102 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // ReadConsoleInputW |
| 103 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // PeekConsoleInputW |
| 104 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS)), // GetConsoleScreenBufferInfo |
| 105 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS, ValueLayout.ADDRESS, ValueLayout.ADDRESS, WIN_COORD_LAYOUT, ValueLayout.ADDRESS)), // ScrollConsoleScreenBufferW |
| 106 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT)), // GetLastError |
| 107 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.JAVA_INT, ValueLayout.ADDRESS)), // GetFileType |
| 108 | + new DowncallDesc(FunctionDescriptor.of(ValueLayout.ADDRESS, ValueLayout.JAVA_INT)), // _get_osfhandle |
| 109 | + }; |
| 110 | + } |
| 111 | + |
| 112 | + private static DowncallDesc[] getDowncalls() { |
| 113 | + if (Platform.includedIn(Platform.WINDOWS.class)) { |
| 114 | + return getWindowsDowncalls(); |
| 115 | + } |
| 116 | + return getUnixDowncalls(); |
| 117 | + } |
| 118 | + |
| 119 | + public void duringSetup(DuringSetupAccess access) { |
| 120 | + if (FFMTerminalProviderLoader.DISABLED) { |
| 121 | + return; |
| 122 | + } |
| 123 | + for (DowncallDesc downcall : getDowncalls()) { |
| 124 | + RuntimeForeignAccess.registerForDowncall(downcall.fd(), (Object[]) downcall.options()); |
| 125 | + } |
| 126 | + } |
| 127 | +} |
0 commit comments