Rux

Appearance

Illumos Package ​

Unstable API

The package is under active development and its API is not yet stable. Names, signatures, and behavior may change between releases, and this documentation will be updated to match.

Direct Illumos x86-64 system-call bindings for Rux programs.

Module: Illumos

Source: github.com/rux-lang/Illumos

The package provides raw zero-to-six-argument syscall entry points, typed wrappers for common I/O, process, memory, and time operations, and the constants and structures those wrappers require. It calls the kernel without libc.

Requirements ​

  • An Illumos distribution on x86-64, such as OmniOS, OpenIndiana, or SmartOS
  • A Rux compiler with the rux-illumos syscall thunks

The syscall numbers and calling convention are platform- and architecture-specific. Prefer Std when it provides the operation you need.

Installation ​

Add the package and install project dependencies:

sh
rux add Illumos
rux install

Then import the symbols you need:

rux
import Illumos::{ Stdout, Write };

Result Convention ​

Functions returning int64 expose the thunk result directly. The package treats values from 1 through 4095 as positive errno values; IsError performs exactly that range check and Errno returns the value when it falls in that range.

Ambiguous positive results

The current convention overlaps legitimate small positive success values, including byte counts returned by Read and Write, and potentially process IDs. Consequently, IsError can misclassify a successful result. Interpret each function's result according to its own contract; do not apply IsError blindly to every positive result.

The package does not set a thread-local errno, retry interrupted calls, or convert failures into exceptions.

Reference ​

TopicContents
Types and constantsFile descriptors, flags, clocks, and Timespec.
I/ORead, write, and close file descriptors.
MemoryMap, unmap, and change the program break.
ProcessProcess ID and immediate termination.
TimeRead clocks and suspend execution.
Raw syscallsSyscall0-Syscall6 and error helpers.

Example ​

rux
import Illumos::{ Stdout, Write };

func Main() -> int32 {
    let message = "hello from Illumos\n";
    let result = Write(Stdout, message.data, message.length);

    // A complete write returns the requested byte count.
    return result == message.length as int64 ? 0i32 : 1i32;
}