Files
Odin/core/sys/posix/sys_stat.odin
Harold Brenes 219b0fe535 Replace system:System.framework imports with system:System
This makes the linker work for both macOS and iOS targets
2025-07-13 15:45:21 -04:00

516 lines
18 KiB
Odin

#+build linux, darwin, netbsd, openbsd, freebsd, haiku
package posix
import "core:c"
when ODIN_OS == .Darwin {
foreign import lib "system:System"
} else {
foreign import lib "system:c"
}
// sys/stat.h - data returned by the stat() function
foreign lib {
/*
Equivalent to either stat or lstat (based on the SYMLINK_NOFOLLOW bit in flags)
but resolves relative paths based on the given fd.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/fstatat.html ]]
*/
@(link_name="fstatat" + INODE_SUFFIX)
fstatat :: proc(fd: FD, path: cstring, buf: ^stat_t, flag: AT_Flags) -> result ---
/*
Obtain information about a "file" at the given path.
Follows symbolic links.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/fstatat.html ]]
*/
@(link_name=LSTAT)
stat :: proc(path: cstring, buf: ^stat_t) -> result ---
/*
Obtain information about an open file.
Follows symbol links.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/fstat.html ]]
*/
@(link_name=LFSTAT)
fstat :: proc(fildes: FD, buf: ^stat_t) -> result ---
/*
Obtain information about a "file" at the given path.
Does not follow symlinks (will stat the symlink itself).
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/fstatat.html ]]
*/
@(link_name=LLSTAT)
lstat :: proc(path: cstring, buf: ^stat_t) -> result ---
/*
Change the mode of a file.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/chmod.html ]]
*/
chmod :: proc(path: cstring, mode: mode_t) -> result ---
/*
Equivalent to chmod but takes an open file descriptor.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/fchmod.html ]]
*/
fchmod :: proc(fd: FD, mode: mode_t) -> result ---
/*
Equivalent to chmod but follows (or doesn't) symlinks based on the flag and resolves
relative paths from the given fd.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/chmod.html ]]
*/
fchmodat :: proc(fd: FD, path: cstring, mode: mode_t, flag: AT_Flags) -> result ---
/*
Make a directory.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/mkdir.html ]]
*/
mkdir :: proc(path: cstring, mode: mode_t) -> result ---
/*
Equivalent to mkdir but relative paths are relative to fd.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/mkdir.html ]]
*/
mkdirat :: proc(fd: FD, path: cstring, mode: mode_t) -> result ---
/*
Make a FIFO special file.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/mkfifo.html ]]
*/
mkfifo :: proc(path: cstring, mode: mode_t) -> result ---
/*
Equivalent to mkfifo but relative paths are relative to fd.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/mkfifo.html ]]
*/
mkfifoat :: proc(fd: FD, path: cstring, mode: mode_t) -> result ---
/*
Make directory, special file, or regular file.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/mknodat.html ]]
*/
@(link_name=LMKNOD)
mknod :: proc(path: cstring, mode: mode_t, dev: dev_t) -> result ---
/*
Equivalent to mknod but relative paths are relative to fd.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/mknodat.html ]]
*/
mknodat :: proc(fd: FD, path: cstring, mode: mode_t, dev: dev_t) -> result ---
/*
Sets the file access and modification time of the given file descriptor.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/futimens.html ]]
*/
futimens :: proc(fd: FD, times: ^[2]timespec) -> result ---
/*
Equivalent to futimens.
Relative directories are based on fd.
Symlinks may or may not be followed based on the flags.
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/futimens.html ]]
*/
utimensat :: proc(fd: FD, path: cstring, times: ^[2]timespec, flag: AT_Flags) -> result ---
/*
Set and get the file mode creation flags.
Makes the file mode permissions bits in cmask the new default for the process.
Returns: the previous value
[[ More; https://pubs.opengroup.org/onlinepubs/9699919799/functions/umask.html ]]
*/
umask :: proc(cmask: mode_t) -> mode_t ---
}
// Read, write, execute user.
S_IRWXU :: mode_t{ .IRUSR, .IWUSR, .IXUSR }
// Read, write, execute group.
S_IRWXG :: mode_t{ .IRGRP, .IWGRP, .IXGRP }
// Read, write, execute other.
S_IRWXO :: mode_t{ .IROTH, .IWOTH, .IXOTH }
Mode_Bits :: enum c.int {
// File type:
IFCHR = log2(_S_IFCHR), /* Character special */
IFIFO = log2(_S_IFIFO), /* FIFO special */
IFREG = log2(_S_IFREG), /* Regular */
IFDIR = log2(_S_IFDIR), /* Directory */
// Permissions:
IRUSR = log2(_S_IRUSR), /* R for owner */
IWUSR = log2(_S_IWUSR), /* W for owner */
IXUSR = log2(_S_IXUSR), /* X for owner */
IRGRP = log2(_S_IRGRP), /* R for group */
IWGRP = log2(_S_IWGRP), /* W for group */
IXGRP = log2(_S_IXGRP), /* X for group */
IROTH = log2(_S_IROTH), /* R for other */
IWOTH = log2(_S_IWOTH), /* W for other */
IXOTH = log2(_S_IXOTH), /* X for other */
ISUID = log2(_S_ISUID), /* Set user ID on execution */
ISGID = log2(_S_ISGID), /* Set group ID on execution */
ISVXT = log2(_S_ISVTX), /* On directories, restricted deletion flag */
}
mode_t :: bit_set[Mode_Bits; _mode_t]
#assert(size_of(mode_t) == size_of(_mode_t))
S_IFMT :: mode_t{ .IFCHR, .IFREG, .IFDIR, .IFIFO }
S_IFSOCK :: mode_t{ .IFREG, .IFDIR }
S_IFLNK :: mode_t{ .IFREG, .IFCHR }
S_IFBLK :: mode_t{ .IFDIR, .IFCHR }
S_IFIFO :: mode_t{ .IFIFO }
S_IFCHR :: mode_t{ .IFCHR }
S_IFDIR :: mode_t{ .IFDIR }
S_IFREG :: mode_t{ .IFREG }
#assert(_S_IFMT == _S_IFCHR|_S_IFREG|_S_IFDIR|_S_IFIFO)
#assert(_S_IFSOCK == _S_IFREG|_S_IFDIR)
#assert(_S_IFLNK == _S_IFREG|_S_IFCHR)
#assert(_S_IFBLK == _S_IFDIR|_S_IFCHR)
// Test for a block special file.
S_ISBLK :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFBLK
}
// Test for a character special file.
S_ISCHR :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFCHR
}
// Test for a pipe or FIFO special file.
S_ISFIFO :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFIFO
}
// Test for a regular file.
S_ISREG :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFREG
}
// Test for a directory.
S_ISDIR :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFDIR
}
// Test for a symbolic link.
S_ISLNK :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFLNK
}
// Test for a socket.
S_ISSOCK :: #force_inline proc "contextless" (m: mode_t) -> bool {
return (m & S_IFMT) == S_IFSOCK
}
_S_IRWXU :: 0o000700
_S_IRUSR :: 0o000400
_S_IWUSR :: 0o000200
_S_IXUSR :: 0o000100
_S_IRWXG :: 0o000070
_S_IRGRP :: 0o000040
_S_IWGRP :: 0o000020
_S_IXGRP :: 0o000010
_S_IRWXO :: 0o000007
_S_IROTH :: 0o000004
_S_IWOTH :: 0o000002
_S_IXOTH :: 0o000001
_S_ISUID :: 0o004000
_S_ISGID :: 0o002000
_S_ISVTX :: 0o001000
_S_IFBLK :: 0o060000
_S_IFCHR :: 0o020000
_S_IFIFO :: 0o010000
_S_IFREG :: 0o100000
_S_IFDIR :: 0o040000
_S_IFLNK :: 0o120000
_S_IFSOCK :: 0o140000
_S_IFMT :: 0o170000
when ODIN_OS == .NetBSD {
@(private) LSTAT :: "__stat50"
@(private) LFSTAT :: "__fstat50"
@(private) LLSTAT :: "__lstat50"
@(private) LMKNOD :: "__mknod50"
} else {
@(private) LSTAT :: "stat" + INODE_SUFFIX
@(private) LFSTAT :: "fstat" + INODE_SUFFIX
@(private) LLSTAT :: "lstat" + INODE_SUFFIX
@(private) LMKNOD :: "mknod"
}
when ODIN_OS == .Darwin {
dev_t :: distinct c.int32_t
nlink_t :: distinct c.uint16_t
_mode_t :: distinct c.uint16_t
blkcnt_t :: distinct c.int64_t
blksize_t :: distinct c.int32_t
ino_t :: distinct c.uint64_t
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_mode: mode_t, /* [PSX] mode of file */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_ino: ino_t, /* [PSX] file serial number */
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_rdev: dev_t, /* [PSX] device ID */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
st_birthtimespec: timespec, /* time of file creation(birth) */
st_size: off_t, /* [PSX] file size, in bytes */
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_flags: c.uint32_t, /* user defined flags for file */
st_gen: c.uint32_t, /* file generation number */
st_lspare: c.int32_t, /* RESERVED */
st_qspare: [2]c.int64_t, /* RESERVED */
}
UTIME_NOW :: -1
UTIME_OMIT :: -2
} else when ODIN_OS == .FreeBSD {
dev_t :: distinct c.uint64_t
nlink_t :: distinct c.uint64_t
_mode_t :: distinct c.uint16_t
blkcnt_t :: distinct c.int64_t
blksize_t :: distinct c.int32_t
ino_t :: distinct c.uint64_t
when ODIN_ARCH == .i386 {
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_ino: ino_t, /* [PSX] file serial number */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_mode: mode_t, /* [PSX] mode of file */
st_padding0: c.int16_t,
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_padding1: c.int32_t,
st_rdev: dev_t, /* [PSX] device ID */
st_atim_ext: c.int32_t,
st_atim: timespec, /* [PSX] time of last access */
st_mtim_ext: c.int32_t,
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim_ext: c.int32_t,
st_ctim: timespec, /* [PSX] time of last status change */
st_birthtimespec: timespec, /* time of file creation(birth) */
st_size: off_t, /* [PSX] file size, in bytes */
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_flags: c.uint32_t, /* user defined flags for file */
st_gen: c.uint64_t,
st_spare: [10]c.uint64_t,
}
} else {
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_ino: ino_t, /* [PSX] file serial number */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_mode: mode_t, /* [PSX] mode of file */
st_padding0: c.int16_t,
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_padding1: c.int32_t,
st_rdev: dev_t, /* [PSX] device ID */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
st_birthtimespec: timespec, /* time of file creation(birth) */
st_size: off_t, /* [PSX] file size, in bytes */
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_flags: c.uint32_t, /* user defined flags for file */
st_gen: c.uint64_t,
st_spare: [10]c.uint64_t,
}
}
UTIME_NOW :: -1
UTIME_OMIT :: -2
} else when ODIN_OS == .NetBSD {
dev_t :: distinct c.uint64_t
nlink_t :: distinct c.uint32_t
_mode_t :: distinct c.uint32_t
blkcnt_t :: distinct c.int64_t
blksize_t :: distinct c.int32_t
ino_t :: distinct c.uint64_t
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_mode: mode_t, /* [PSX] mode of file */
st_ino: ino_t, /* [PSX] file serial number */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_rdev: dev_t, /* [PSX] device ID */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
st_birthtimespec: timespec, /* time of file creation(birth) */
st_size: off_t, /* [PSX] file size, in bytes */
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_flags: c.uint32_t, /* user defined flags for file */
st_gen: c.uint64_t,
st_spare: [2]c.uint32_t,
}
UTIME_NOW :: (1 << 30) - 1
UTIME_OMIT :: (1 << 30) - 2
} else when ODIN_OS == .OpenBSD {
dev_t :: distinct c.int32_t
nlink_t :: distinct c.uint32_t
_mode_t :: distinct c.uint32_t
blkcnt_t :: distinct c.int64_t
blksize_t :: distinct c.int32_t
ino_t :: distinct c.uint64_t
stat_t :: struct {
st_mode: mode_t, /* [PSX] mode of file */
st_dev: dev_t, /* [PSX] ID of device containing file */
st_ino: ino_t, /* [PSX] file serial number */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_rdev: dev_t, /* [PSX] device ID */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
st_size: off_t, /* [PSX] file size, in bytes */
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_flags: c.uint32_t, /* user defined flags for file */
st_gen: c.int32_t,
st_birthtimespec: timespec,
}
UTIME_NOW :: -2
UTIME_OMIT :: -1
} else when ODIN_OS == .Haiku {
dev_t :: distinct c.int32_t
nlink_t :: distinct c.int32_t
_mode_t :: distinct c.uint32_t
blkcnt_t :: distinct c.int64_t
blksize_t :: distinct c.int32_t
ino_t :: distinct c.int64_t
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_ino: ino_t, /* [PSX] file serial number */
st_mode: mode_t, /* [PSX] mode of file */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_size: off_t, /* [PSX] file size, in bytes */
st_rdev: dev_t, /* [PSX] device ID */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
st_crtim: timespec, /* [PSX] time of last status change */
st_type: c.uint32_t,
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
}
UTIME_NOW :: 1000000000
UTIME_OMIT :: 1000000001
} else when ODIN_OS == .Linux {
dev_t :: distinct u64
_mode_t :: distinct c.uint
blkcnt_t :: distinct i64
when ODIN_ARCH == .arm64 || ODIN_ARCH == .riscv64 {
nlink_t :: distinct c.uint
blksize_t :: distinct c.int
} else {
nlink_t :: distinct c.size_t
blksize_t :: distinct c.long
}
ino_t :: distinct u64
when ODIN_ARCH == .amd64 {
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_ino: ino_t, /* [PSX] file serial number */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_mode: mode_t, /* [PSX] mode of file */
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
_pad0: c.uint,
st_rdev: dev_t, /* [PSX] device ID */
st_size: off_t, /* [PSX] file size, in bytes */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
__unused: [3]c.long,
}
} else {
stat_t :: struct {
st_dev: dev_t, /* [PSX] ID of device containing file */
st_ino: ino_t, /* [PSX] file serial number */
st_mode: mode_t, /* [PSX] mode of file */
st_nlink: nlink_t, /* [PSX] number of hard links */
st_uid: uid_t, /* [PSX] user ID of the file */
st_gid: gid_t, /* [PSX] group ID of the file */
st_rdev: dev_t, /* [PSX] device ID */
__pad: c.ulonglong,
st_size: off_t, /* [PSX] file size, in bytes */
st_blksize: blksize_t, /* [PSX] optimal blocksize for I/O */
__pad2: c.int,
st_blocks: blkcnt_t, /* [PSX] blocks allocated for file */
st_atim: timespec, /* [PSX] time of last access */
st_mtim: timespec, /* [PSX] time of last data modification */
st_ctim: timespec, /* [PSX] time of last status change */
__unused: [2]c.uint,
}
}
}