Skip to content

Commit

Permalink
Support raw mode for posix in native image (#186)
Browse files Browse the repository at this point in the history 
The issue with `Expected Object but got Word` when compiling the native
image comes from the fact that the kotlin compiler insert null checks if
the used types are not nullable.

For example, if we declare tcgetattr as

```kotlin
@cfunction("tcgetattr")
external fun tcgetattr(fd: Int, termios: termios): Int
```

Every call to it will be compiled as

```kotlin
Intrinsics.checkNotNull(termios);
tcgetattr(..., termios);
```

It is possible to disable those checks with the following compiler
parameters:
-Xno-param-assertions, -Xno-call-assertions,-Xno-receiver-assertions.

But in this case, it is enough to simply mark the termios parameter as
nullable.
  • Loading branch information
@hubvd
hubvd authored Jul 9, 2024
1 parent d24d2fa commit 0a54a13
Show file tree
Hide file tree
Showing 2 changed files with 67 additions and 91 deletions.
149 changes: 67 additions & 82 deletions ...om/github/ajalt/mordant/internal/syscalls/nativeimage/SyscallHandler.nativeimage.posix.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ import org.graalvm.nativeimage.c.CContext
import org.graalvm.nativeimage.c.constant.CConstant
import org.graalvm.nativeimage.c.function.CFunction
import org.graalvm.nativeimage.c.struct.CField
import org.graalvm.nativeimage.c.struct.CFieldAddress
import org.graalvm.nativeimage.c.struct.CStruct
import org.graalvm.nativeimage.c.type.CCharPointer
import org.graalvm.word.PointerBase

@CContext(PosixLibC.Directives::class)
Expand All @@ -24,11 +26,11 @@ private object PosixLibC {
@CConstant("TIOCGWINSZ")
external fun TIOCGWINSZ(): Int

// @CConstant("TCSADRAIN")
// external fun TCSADRAIN(): Int
//
// @CConstant("NCCS")
// external fun NCCS(): Int
@CConstant("TCSADRAIN")
external fun TCSADRAIN(): Int

@CConstant("NCCS")
external fun NCCS(): Int

@CStruct("winsize", addStructKeyword = true)
interface winsize : PointerBase {
Expand All @@ -40,51 +42,51 @@ private object PosixLibC {
val ws_col: Short
}

// @CStruct("termios", addStructKeyword = true)
// interface termios : PointerBase {
// @get:CField("c_iflag")
// @set:CField("c_iflag")
// var c_iflag: Int
//
// @get:CField("c_oflag")
// @set:CField("c_oflag")
// var c_oflag: Int
//
// @get:CField("c_cflag")
// @set:CField("c_cflag")
// var c_cflag: Int
//
// @get:CField("c_lflag")
// @set:CField("c_lflag")
// var c_lflag: Int
//
// @get:CField("c_line")
// @set:CField("c_line")
// var c_line: Byte
//
// @get:CFieldAddress("c_cc")
// val c_cc: CCharPointer
//
// @get:CField("c_ispeed")
// @set:CField("c_ispeed")
// var c_ispeed: Int
//
// @get:CField("c_ospeed")
// @set:CField("c_ospeed")
// var c_ospeed: Int
// }
@CStruct("termios", addStructKeyword = true)
interface termios : PointerBase {
@get:CField("c_iflag")
@set:CField("c_iflag")
var c_iflag: Int

@get:CField("c_oflag")
@set:CField("c_oflag")
var c_oflag: Int

@get:CField("c_cflag")
@set:CField("c_cflag")
var c_cflag: Int

@get:CField("c_lflag")
@set:CField("c_lflag")
var c_lflag: Int

@get:CField("c_line")
@set:CField("c_line")
var c_line: Byte

@get:CFieldAddress("c_cc")
val c_cc: CCharPointer

@get:CField("c_ispeed")
@set:CField("c_ispeed")
var c_ispeed: Int

@get:CField("c_ospeed")
@set:CField("c_ospeed")
var c_ospeed: Int
}

@CFunction("isatty")
external fun isatty(fd: Int): Boolean

@CFunction("ioctl")
external fun ioctl(fd: Int, cmd: Int, winSize: winsize?): Int

// @CFunction("tcgetattr")
// external fun tcgetattr(fd: Int, termios: termios): Int
//
// @CFunction("tcsetattr")
// external fun tcsetattr(fd: Int, cmd: Int, termios: termios): Int
@CFunction("tcgetattr")
external fun tcgetattr(fd: Int, termios: termios?): Int

@CFunction("tcsetattr")
external fun tcsetattr(fd: Int, cmd: Int, termios: termios?): Int
}

@Platforms(Platform.LINUX::class, Platform.MACOS::class)
Expand All @@ -101,48 +103,31 @@ internal class SyscallHandlerNativeImagePosix : SyscallHandlerJvmPosix() {
}

override fun getStdinTermios(): Termios {
throw NotImplementedError(
"Raw mode is not currently supported for native-image. If you are familiar with " +
"GraalVM native-image and would like to contribute, see the commented out " +
"code in the file SyscallHandler.nativeimage.posix"
val termios = StackValue.get(PosixLibC.termios::class.java)
if (PosixLibC.tcgetattr(STDIN_FILENO, termios) != 0) {
throw RuntimeException("Error reading terminal attributes")
}
return Termios(
iflag = termios.c_iflag.toUInt(),
oflag = termios.c_oflag.toUInt(),
cflag = termios.c_cflag.toUInt(),
lflag = termios.c_lflag.toUInt(),
cc = ByteArray(PosixLibC.NCCS()) { termios.c_cc.read(it) },
)
/*
This fails with the following error:
Error: Expected Object but got Word for call argument in
com.github.ajalt.mordant.internal.syscalls.nativeimage.SyscallHandlerNativeImagePosix.getStdinTermios(SyscallHandler.nativeimage.posix.kt:117).
One possible cause for this error is when word values are passed into lambdas as parameters
or from variables in an enclosing scope, which is not supported, but can be solved by
instead using explicit classes (including anonymous classes).
I've tried all the ways I can think of to declare tcgetattr and tcsetattr, but the error
persists.
*/
// val termios = StackValue.get(PosixLibC.termios::class.java)
// if (PosixLibC.tcgetattr(STDIN_FILENO, termios) != 0) {
// throw RuntimeException("Error reading terminal attributes")
// }
// return Termios(
// iflag = termios.c_iflag.toUInt(),
// oflag = termios.c_oflag.toUInt(),
// cflag = termios.c_cflag.toUInt(),
// lflag = termios.c_lflag.toUInt(),
// cc = ByteArray(PosixLibC.NCCS()) { termios.c_cc.read(it) },
// )
}

override fun setStdinTermios(termios: Termios) {
// val nativeTermios = StackValue.get(PosixLibC.termios::class.java)
// if (PosixLibC.tcgetattr(STDIN_FILENO, nativeTermios) != 0) {
// throw RuntimeException("Error reading terminal attributes")
// }
// nativeTermios.c_iflag = termios.iflag.toInt()
// nativeTermios.c_oflag = termios.oflag.toInt()
// nativeTermios.c_cflag = termios.cflag.toInt()
// nativeTermios.c_lflag = termios.lflag.toInt()
// termios.cc.forEachIndexed { i, b -> nativeTermios.c_cc.write(i, b) }
// if (PosixLibC.tcsetattr(STDIN_FILENO, PosixLibC.TCSADRAIN(), nativeTermios) != 0) {
// throw RuntimeException("Error setting terminal attributes")
// }
val nativeTermios = StackValue.get(PosixLibC.termios::class.java)
if (PosixLibC.tcgetattr(STDIN_FILENO, nativeTermios) != 0) {
throw RuntimeException("Error reading terminal attributes")
}
nativeTermios.c_iflag = termios.iflag.toInt()
nativeTermios.c_oflag = termios.oflag.toInt()
nativeTermios.c_cflag = termios.cflag.toInt()
nativeTermios.c_lflag = termios.lflag.toInt()
termios.cc.forEachIndexed { i, b -> nativeTermios.c_cc.write(i, b) }
if (PosixLibC.tcsetattr(STDIN_FILENO, PosixLibC.TCSADRAIN(), nativeTermios) != 0) {
throw RuntimeException("Error setting terminal attributes")
}
}
}
9 changes: 0 additions & 9 deletions test/graalvm/src/test/kotlin/GraalSmokeTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,15 +39,6 @@ class GraalSmokeTest {
future.get(1000, TimeUnit.MILLISECONDS)
}

@Ignore("Raw mode is currently unsupported on native-image")
@Test
fun `raw mode test`() {
val t = Terminal(interactive = true)
assertThrows<RuntimeException> {
t.enterRawMode().use {}
}
}

@Test
fun `markdown test`() {
val vt = TerminalRecorder()
Expand Down

0 comments on commit 0a54a13

Please sign in to comment.