cosmopolitan/libc/sysv/systemfive.S
2021-02-11 08:37:18 -08:00

459 lines
16 KiB
ArmAsm
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*-*- mode:unix-assembly; indent-tabs-mode:t; tab-width:8; coding:utf-8 -*-│
vi: set et ft=asm ts=8 sw=8 fenc=utf-8 :vi
Copyright 2020 Justine Alexandra Roberts Tunney
Permission to use, copy, modify, and/or distribute this software for
any purpose with or without fee is hereby granted, provided that the
above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THIS SOFTWARE.
*/
#include "libc/dce.h"
#include "libc/sysv/consts/prot.h"
#include "libc/sysv/consts/nr.h"
#include "libc/sysv/consts/map.h"
#include "libc/macros.h"
/*
besiyata
dishmaya
cosmopolitan § bell system five » system call support
*/
.initbss 300,_init_systemfive
__hostos:
.quad 0
.endobj __hostos,globl,hidden
// Performs System Five System Call.
//
// Cosmopolitan is designed to delegate all function calls into the
// Linux, FreeBSD, OpenBSD, and XNU kernels via this function, with
// few exceptions. This function should generally only be called by
// generated thunks in the libc/sysv/syscalls/ directory.
//
// It's safe to call this function on Windows, where it will always
// return -1 with errno == ENOSYS. Further note that -1 is the only
// return value that means error, a common anti-pattern is to check
// for values less than 0 (which is more problematic on 32-bit).
//
// It is important to consider that system calls are one order of a
// magnitude more expensive than normal function calls. For example
// getpid() on Linux usually takes 500ns, and cached i/o calls will
// take 1µs or more. So we don't need to inline them like Chromium.
//
// Another thing to consider is that BSDs only loosely follow the
// System Five ABI for the SYSCALL instruction. For example Linux
// always follows the six argument limit but the FreeBSD sendfile
// system call accepts a seventh argument that is passed on stack
// and OpenBSD modifies functions like mmap so that the sixth arg
// is passed on the stack. There's also the carry flag convention
// that XNU, FreeBSD, and OpenBSD inherited from 386BSD aka Jolix
//
// @param %rax function ordinal supplied by jump slot
// @param %rdi,%rsi,%rdx,%rcx,%r8,%r9 and rest on stack
// @return %rax:%rdx is result, or -1 w/ errno on error
// @clob %rcx,%r10,%r11
// @see syscalls.sh
__systemfive:
.quad 0
.endobj __systemfive,globl,hidden
.previous
.privileged
.Lanchorpoint:
#if SupportsLinux() || SupportsMetal()
systemfive_linux:
and $0xfff,%eax
cmp $0xfff,%eax
je systemfive_enosys
mov %rcx,%r10 # syscall instruction clobbers %rcx
push %rbp # linux never reads args from stack
mov %rsp,%rbp # having frame will help backtraces
syscall # this is known as a context switch
pop %rbp # next we check to see if it failed
cmp $-4095,%rax # system five nexgen32e abi § A.2.1
jae systemfive_error # encodes errno as neg return value
ret
.endfn systemfive_linux,globl,hidden
systemfive_error:
neg %eax
// 𝑠𝑙𝑖𝑑𝑒
.endfn systemfive_error,globl,hidden
#endif
systemfive_errno:
mov %eax,errno(%rip) # normalize to c library convention
push $-1 # negative one is only error result
pop %rax # the push pop is to save code size
ret
.endfn systemfive_errno,globl,hidden
systemfive_enosys:
mov ENOSYS(%rip),%eax
jmp systemfive_errno
.endfn systemfive_enosys,globl,hidden
#if SupportsNetbsd()
systemfive_netbsd:
shr $4*13,%rax
jmp systemfive_bsdscrub
.endfn systemfive_netbsd,globl,hidden
#endif
#if SupportsOpenbsd()
systemfive_openbsd:
shr $4*10,%rax
jmp systemfive_bsdscrub
.endfn systemfive_openbsd,globl,hidden
#endif
#if SupportsFreebsd()
systemfive_freebsd:
shr $4*7,%rax
movzwl %ax,%eax
// 𝑠𝑙𝑖𝑑𝑒
.endfn systemfive_freebsd,globl,hidden
#endif
#if SupportsBsd()
systemfive_bsdscrub:
and $0xfff,%eax
// 𝑠𝑙𝑖𝑑𝑒
.endfn systemfive_bsdscrub,globl,hidden
systemfive_bsd:
cmp $0xfff,%ax
je systemfive_enosys
mov %rcx,%r10 # note: we do not create a stack frame
syscall # bsd will need arg on stack sometimes
jc systemfive_errno # bsd sets carry flag if %rax is errno
ret
.endfn systemfive_bsd
#endif
#if SupportsXnu()
systemfive_xnu:
// 0x?????????2153??? # how syscalls.sh encodes xnu ordinals
//
//
// 0x0000000002000153 # how xnu wants ordinals to be encoded
mov %eax,%r11d
and $0x0f000000,%r11d
shl $8,%eax
shr $20,%eax
or %r11d,%eax
jmp systemfive_bsd
.endfn systemfive_xnu,globl,hidden
#endif
.previous
// Initializes System Five system call support.
//
// (1) Extracts parameters passed by kernel
// (2) Detects OS without issuing system calls
// (3) Unpacks magnums from libc/sysv/consts.sh
// (4) Replaces stack with one we control
//
// @param %r15 is auxv
// @note OpenBSD devs: let us know if you start using auxv
.init.start 300,_init_systemfive
push %rbx
push %rsi
#if SupportsMetal()
testb $METAL,(%rdi) # @see ape/ape.S
jnz _init_systemfive_metal
#endif
#if SupportsXnu()
testb $XNU,(%rdi) # @see libc/crt/crt.S
jnz _init_systemfive_xnu
#endif
#if SupportsFreebsd()
testb $FREEBSD,(%rdi) # @see libc/crt/crt.S
jnz _init_systemfive_freebsd
#endif
#if SupportsWindows()
testb $WINDOWS,(%rdi) # @see libc/runtime/winmain.c
jnz _init_systemfive_windows
#endif
#if SupportsOpenbsd()
cmpq $0,(%r15) # OpenBSD doesn't have auxv
je _init_systemfive_openbsd
#endif
#if SupportsNetbsd()
xor %eax,%eax
0: cmpq $2014,(%r15,%rax,8) # NetBSD's distinctive AT_EXECFN
je _init_systemfive_netbsd
cmpq $0,(%r15,%rax,8)
lea 2(%eax),%eax
jnz 0b
#endif
#if SupportsLinux() || SupportsMetal()
_init_systemfive_linux:
pushb systemfive_linux-.Lanchorpoint
push $LINUX
ezlea syscon_linux,si
jmp _init_systemfive_os
#endif
#if SupportsMetal()
_init_systemfive_metal:
pushb systemfive_linux-.Lanchorpoint
push $METAL
ezlea syscon_linux,si
jmp _init_systemfive_os
#endif
#if SupportsWindows()
_init_systemfive_windows:
pushb systemfive_enosys-.Lanchorpoint
push $WINDOWS
ezlea syscon_windows,si
jmp _init_systemfive_os
#endif
#if SupportsFreebsd()
_init_systemfive_freebsd:
pushb systemfive_freebsd-.Lanchorpoint
push $FREEBSD
ezlea syscon_freebsd,si
jmp _init_systemfive_os
#endif
#if SupportsOpenbsd()
_init_systemfive_openbsd:
pushb systemfive_openbsd-.Lanchorpoint
push $OPENBSD
ezlea syscon_openbsd,si
jmp _init_systemfive_os
#endif
#if SupportsNetbsd()
_init_systemfive_netbsd:
pushb systemfive_netbsd-.Lanchorpoint
push $NETBSD
ezlea syscon_netbsd,si
jmp _init_systemfive_os
#endif
#if SupportsXnu()
_init_systemfive_xnu:
pushb systemfive_xnu-.Lanchorpoint
push $XNU
ezlea syscon_xnu,si
// 𝑠𝑙𝑖𝑑𝑒
#endif
_init_systemfive_os:
ezlea .Lanchorpoint,cx
pop %rax
stosq # __hostos
pop %rax
add %rcx,%rax
stosq # __systemfive
// 𝑠𝑙𝑖𝑑𝑒
_init_systemfive_magnums:
push %rdi
ezlea syscon_start,di
ezlea syscon_end,bx
or $-1,%r9
2: cmp %rbx,%rdi
jnb 5f
xor %ecx,%ecx
xor %edx,%edx
3: lodsb # decodes sleb128
mov %rax,%r8
and $127,%r8d
sal %cl,%r8
add $7,%ecx
or %r8,%rdx
test %al,%al
js 3b
test $64,%al
je 4f
mov %r9,%rax
sal %cl,%rax
or %rax,%rdx
4: mov %rdx,%rax
cmpq $0,(%rdi) # dont change if set
cmovne (%rdi),%rax # @see WinMain()
stosq
jmp 2b
5: pop %rdi
pop %rsi
pop %rbx
// 𝑠𝑙𝑖𝑑𝑒
#if SupportsSystemv() && !defined(TINY)
_init_systemfive_stack: # determinism ftw!
#if SupportsWindows()
testb IsWindows() # already did this
jnz _init_systemfive_done
#endif
push %rdi
push %rsi
mov __NR_mmap,%eax
mov $0x700000000000-STACKSIZE,%rdi
mov $STACKSIZE,%esi
mov $PROT_READ|PROT_WRITE,%edx
mov $MAP_PRIVATE|MAP_FIXED,%r10d
or MAP_ANONYMOUS,%r10d
or $-1,%r8d
xor %r9d,%r9d
push %r9 # openbsd:pad
push %r9 # openbsd:align
#if SupportsOpenbsd()
testb IsOpenbsd()
jz 0f
syscall # openbsd:dubstack
jc 1f
mov __NR_mmap,%eax
#endif
0: or MAP_GROWSDOWN,%r10d # openbsd:mapstack
clc
syscall
pop %r9
pop %r9
jnc 2f
1: mov %eax,%edi
mov __NR_exit_group,%eax
syscall
2: test %rax,%rax
js 1b
.weak _mmi
ezlea _mmi,cx
test %rcx,%rcx
jz 3f
movb $1,(%rcx) # _mmi.i
movl $(0x700000000000-STACKSIZE)>>16,8(%rcx) # _mmi.p[0].x
movl $(0x700000000000-1)>>16,12(%rcx) # _mmi.p[0].y
mov %edx,20(%rcx) # _mmi.p[0].prot
mov %r10d,24(%rcx) # _mmi.p[0].flags
3: pop %rsi
pop %rdi
leave
pop %rcx
lea STACKSIZE-16(%rax),%rsp # openbsd:stackbound
mov %rbp,(%rsp)
push %rcx
push %rbp
mov %rsp,%rbp
// 𝑠𝑙𝑖𝑑𝑒
_init_systemfive_syscall:
mov __NR_msyscall,%eax # syscall origin protect
test %eax,%eax # openbsd is pretty cool
js _init_systemfive_done
push %rdi
push %rsi
.weak __privileged_addr
.weak __privileged_size
mov $__privileged_addr,%edi
mov $__privileged_size,%esi
syscall
pop %rsi
pop %rdi
// 𝑠𝑙𝑖𝑑𝑒
#endif /* TINY */
_init_systemfive_done:
nop
.init.end 300,_init_systemfive,globl,hidden
// Sections for varint encoded magic numbers.
//
// These sections are all ordered by (group_name, constant_name).
// They're populated by modules simply referencing the symbols.
//
// @see libc/sysv/consts.sh
// @see libc/sysv/consts/syscon_h
.section .piro.bss.sort.syscon.1,"aw",@nobits
.align 8
syscon_start:/*
...decentralized quadwords...
*/.previous
.section .piro.bss.sort.syscon.3,"aw",@nobits
syscon_end:
.previous
.type syscon_start,@object
.type syscon_end,@object
.globl syscon_start
.globl syscon_end
#if SupportsLinux() || SupportsMetal()
.section .sort.rodata.syscon.linux.1,"a",@progbits
.align 1
syscon_linux:/*
...decentralized leb128...
*/.previous
.type syscon_linux,@object
.globl syscon_linux
#endif
#if SupportsXnu()
.section .sort.rodata.syscon.xnu.1,"a",@progbits
.align 1
syscon_xnu:/*
...decentralized leb128...
*/.previous
.type syscon_xnu,@object
.globl syscon_xnu
#endif
#if SupportsFreebsd()
.section .sort.rodata.syscon.freebsd.1,"a",@progbits
.align 1
syscon_freebsd:/*
...decentralized leb128...
*/.previous
.type syscon_freebsd,@object
.globl syscon_freebsd
#endif
#if SupportsOpenbsd()
.section .sort.rodata.syscon.openbsd.1,"a",@progbits
.align 1
syscon_openbsd:/*
...decentralized leb128...
*/.previous
.type syscon_openbsd,@object
.globl syscon_openbsd
#endif
#if SupportsNetbsd()
.section .sort.rodata.syscon.netbsd.1,"a",@progbits
.align 1
syscon_netbsd:/*
...decentralized leb128...
*/.previous
.type syscon_netbsd,@object
.globl syscon_netbsd
#endif
#if SupportsWindows()
.section .sort.rodata.syscon.windows.1,"a",@progbits
.align 1
syscon_windows:/*
...decentralized leb128...
*/.previous
.type syscon_windows,@object
.globl syscon_windows
#endif