posix

nimony/lib/std/posix/posix.nim

This is a raw POSIX interface module. It does not not provide any convenience: cstrings are used instead of proper Nim strings and return codes indicate errors. If you want exceptions and a proper Nim-like interface, use the OS module or write a wrapper.

Every binding is header-free: types and constants are ABI transcriptions (see posix_other.nim) and procs are bare importc of real libc/kernel symbols. -d:useLibc changes which allocator and stdio implementation the stdlib uses, never which declarations exist.

const EPERM: int32
const ENOENT: int32
const ESRCH: int32
const EINTR: int32
const EIO: int32
const ENXIO: int32
const E2BIG: int32
const ENOEXEC: int32
const EBADF: int32
const ECHILD: int32
const EAGAIN: int32
const ENOMEM: int32
const EACCES: int32
const EFAULT: int32
const EBUSY: int32
const EEXIST: int32
const EXDEV: int32
const ENODEV: int32
const ENOTDIR: int32
const EISDIR: int32
const EINVAL: int32
const ENFILE: int32
const EMFILE: int32
const ENOTTY: int32
const ETXTBSY: int32
const EFBIG: int32
const ENOSPC: int32
const ESPIPE: int32
const EROFS: int32
const EMLINK: int32
const EPIPE: int32
const EDOM: int32
const ERANGE: int32
const EDEADLK: int32
const ENAMETOOLONG: int32
const ENOLCK: int32
const ENOSYS: int32
const ENOTEMPTY: int32
const ELOOP: int32
const EWOULDBLOCK: int32
const ENOMSG: int32
const EIDRM: int32
const ENOSTR: int32
const ENODATA: int32
const ETIME: int32
const ENOSR: int32
const EPROTO: int32
const EBADMSG: int32
const EOVERFLOW: int32
const EILSEQ: int32
const ENOTSOCK: int32
const EDESTADDRREQ: int32
const EMSGSIZE: int32
const EPROTOTYPE: int32
const ENOPROTOOPT: int32
const EPROTONOSUPPORT: int32
const EOPNOTSUPP: int32
const ENOTSUP: int32
const EAFNOSUPPORT: int32
const EADDRINUSE: int32
const EADDRNOTAVAIL: int32
const ENETDOWN: int32
const ENETUNREACH: int32
const ENETRESET: int32
const ECONNABORTED: int32
const ECONNRESET: int32
const ENOBUFS: int32
const EISCONN: int32
const ENOTCONN: int32
const ETIMEDOUT: int32
const ECONNREFUSED: int32
const EHOSTUNREACH: int32
const EALREADY: int32
const EINPROGRESS: int32
const ECANCELED: int32
const O_RDONLY: int32
const O_WRONLY: int32
const O_RDWR: int32
const O_CREAT: int32
const O_TRUNC: int32
const O_APPEND: int32
const O_NONBLOCK: int32
const O_CLOEXEC: int32
const F_GETFL: int32
const F_SETFL: int32
const RTLD_NOW: int32
const RTLD_GLOBAL: int32
const PTHREAD_MUTEX_RECURSIVE: int32
const SIGABRT: int32
const SIGKILL: int32
const SIGTERM: int32
const SIGCONT: int32
const SIGSTOP: int32
const PROT_READ: int32
const PROT_WRITE: int32
const MAP_SHARED: int32
const MAP_PRIVATE: int32
const MAP_ANONYMOUS: int32
const MAP_POPULATE: int32
const AF_UNSPEC: int32
const AF_UNIX: int32
const AF_INET: int32
const AF_INET6: int32
const SOCK_STREAM: int32
const SOCK_DGRAM: int32
const SOCK_RAW: int32
const SOCK_SEQPACKET: int32
const SOL_SOCKET: int32
const SO_REUSEADDR: int32
const IPPROTO_IP: int32
const IPPROTO_ICMP: int32
const IPPROTO_TCP: int32
const IPPROTO_UDP: int32
const IPPROTO_IPV6: int32
const IPPROTO_ICMPV6: int32
const IPPROTO_RAW: int32
const INADDR_ANY: uint32
const WNOHANG: int32
const WCONTINUED: int32
const CLOCK_REALTIME: int32
const CLOCK_MONOTONIC: int32
const TIMER_ABSTIME: int32
const SEEK_SET: int32
const SEEK_CUR: int32
const SEEK_END: int32
const SC_NPROCESSORS_ONLN: int32
const IOFBF: int32
const S_IRUSR: int32
const S_IWUSR: int32
type ClockId = int32
type Time = distinct int64

type Timespec = object
  tv_sec: Time
  tv_nsec: int64

type IOVec = object
  iov_base: pointer not nil
  iov_len: uint64

type SockLen = uint32
```
type InAddr = object
  s_addr: uint32
```

type Sockaddr_storage = object
  abi: array[0..15, uint64]

type TSa_Family = uint16

type Sockaddr_in = object
  sin_family: uint16
  sin_port: uint16
  sin_addr: InAddr
  sin_zero: array[0..7, char]

type SockAddr = object
  sa_family: uint16
  sa_data: array[0..255, char]

type Tmsghdr = object
  msg_name: pointer not nil
  msg_namelen: uint32
  msg_iov: ptr IOVec not nil
  msg_iovlen: uint64
  msg_control: pointer not nil
  msg_controllen: uint64
  msg_flags: int32

const linuxA64Raw: bool
Linux/AArch64 on the truly freestanding backend (nimony n: arkham + nifasm, no libc linked): every binding below becomes a RAW syscall (arkham lowers a recognized importc name straight to svc), and AArch64's asm-generic syscall table simply has no open, stat, lstat, readlink, mkdir, rmdir, unlink, rename, pipe, dup2 or fork — the kernel offers only the *at / *2 / clone forms. Where that is true the legacy name is reimplemented here on top of the form that exists, precisely as glibc's wrapper does.
nimNoLibc, NOT nimNativeIo: the C backend uses the same raw-syscall stdlib but still LINKS libc, so there the plain open/stat are real symbols and must keep being bound directly — gating on nimNativeIo made the C backend emit calls to newfstatat, which glibc does not export under that name (it is fstatat), and every C-backend link that touched getFileSize failed.
type InAddrScalar = uint32
type Sighandler = proc (a: int32) {.noconv.}
type FileHandle = int32
type SocketHandle = int32
type Pid = int32
pid_t
type Mode = uint32
mode_t
type Off = int64
off_t
type Dev = uint64
dev_t
type Ino = uint64
ino_t

type Stat = object
  st_dev: uint64
  st_ino: uint64
  st_nlink: uint64
  st_mode: uint32
  st_uid: uint32
  st_gid: uint32
  pad0: int32
  st_rdev: uint64
  st_size: int64
  st_blksize: int64
  st_blocks: int64
  st_atim: Timespec
  st_mtim: Timespec
  st_ctim: Timespec
  glibcReserved: array[0..2, int64]

const StatHasNanoseconds: bool
\ Boolean flag that indicates if the system supports nanosecond time resolution in the fields of Stat. All supported targets do.
template st_mtime(s: Stat): int64
Time of last data modification (seconds since epoch). All hardcoded layouts store the full st_mtim Timespec; this accessor mirrors the POSIX st_mtime field/macro.
proc fcntl(a1: int32; a2: int32; vanon: varargs): int32
proc open(a1: cstring not nil; a2: int32; mode: uint32): int32
proc ftruncate(a1: int32; a2: int64): int32
proc fstat(a1: int32; a2: var Stat): int32
proc lstat(a1: cstring not nil; a2: var Stat): int32
proc stat(a1: cstring not nil; a2: var Stat): int32
proc close(a1: int32): int32
proc S_ISBLK(m: uint32): bool
block special
proc S_ISCHR(m: uint32): bool
char special
proc S_ISDIR(m: uint32): bool
directory
proc S_ISFIFO(m: uint32): bool
FIFO/pipe
proc S_ISREG(m: uint32): bool
regular file
proc S_ISLNK(m: uint32): bool
symlink
proc S_ISSOCK(m: uint32): bool
socket
proc mmap(a1: pointer; a2: uint64; a3: int32; a4: int32; a5: int32; a6: int64): pointer not nil
proc munmap(a1: pointer; a2: uint64): int32
proc errno(): int32
The last error code (libc's errno).
template pcall(x: untyped): int64
Normalizes a syscall-style call to the Linux raw convention: returns the non-negative result on success, or -errno on failure. Hides whether the error is signalled by the raw syscall's negative return (freestanding / arkham, -d:nimNoLibc) or by libc's -1 + the errno global.
Wrap every syscall-shaped call in this and read the error out of the result. Nothing above this module should touch an errno global.
template mmapFailed(p: pointer not nil): bool
True if an mmap result indicates failure. The kernel signals failure as an address in [-4095, -1]; libc maps that to MAP_FAILED ((void*)-1, itself in range), so one range check covers both conventions.
template mmapErrno(p: pointer not nil): int32
errno for a failed mmap (see mmapFailed).
proc clock_gettime(a1: int32; a2: var Timespec): int32
proc getcwd(a1: cstring not nil; a2: int64): cstring not nil
proc chdir(path: cstring not nil): int32
proc realpath(path: cstring not nil; resolved: cstring not nil): cstring not nil
proc readlink(a1: cstring not nil; a2: cstring not nil; a3: int64): int64
proc symlink(a1: cstring not nil; a2: cstring not nil): int32

type Dirent = object
  d_type: uint8
  d_name: array[0..255, char]

type DIR = object
  fd: int32
  bpos: int32
  nread: int32
  ent: Dirent
  buf: array[0..4095, uint8]

proc opendir(name: cstring not nil): ptr DIR
proc closedir(dirp: ptr DIR): int32
proc readdir(dirp: ptr DIR): ptr Dirent
proc mkdir(path: cstring not nil; mode: uint32): int32
proc rmdir(path: cstring not nil): int32
proc unlink(path: cstring not nil): int32
const DT_UNKNOWN: uint8
Unknown file type.
const DT_FIFO: uint8
Named pipe, or FIFO.
const DT_CHR: uint8
Character device.
const DT_DIR: uint8
Directory.
const DT_BLK: uint8
Block device.
const DT_REG: uint8
Regular file.
const DT_LNK: uint8
Symbolic link.
const DT_SOCK: uint8
UNIX domain socket.
const DT_WHT: uint8
proc sysconf(a1: int32): int64
proc posix_fallocate(a1: int32; a2: int64; a3: int64): int32
proc WEXITSTATUS(s: int32): int32
proc WTERMSIG(s: int32): int32
proc WSTOPSIG(s: int32): int32
proc WIFEXITED(s: int32): bool
proc WIFSIGNALED(s: int32): bool
proc WIFSTOPPED(s: int32): bool
proc WIFCONTINUED(s: int32): bool
type CChar = int8
type CCharArray = ptr UncheckedArray[ptr int8]
proc pipe(a: ptr int32 not nil): int32
proc dup2(oldfd: int32; newfd: int32): int32
proc fork(): int32
proc execve(path: cstring not nil; argv: ptr UncheckedArray[ptr int8]; env: ptr UncheckedArray[ptr int8]): int32
proc waitpid(pid: int32; status: var int32; options: int32): int32
proc kill(pid: int32; sig: int32): int32
proc setpgid(pid: int32; pgid: int32): int32
proc exitnow(status: int32)
proc read(fildes: int32; buf: pointer not nil; nbyte: int64): int64
proc write(fildes: int32; buf: pointer not nil; nbyte: int64): int64
var posix_environ: ptr UncheckedArray[cstring not nil] not nil
proc strerror(errnum: int32): cstring not nil
proc nanosleep(req: var Timespec; rem: var Timespec): int32