2020-06-15 14:18:57 +00:00
|
|
|
#ifndef COSMOPOLITAN_LIBC_RUNTIME_RUNTIME_H_
|
|
|
|
#define COSMOPOLITAN_LIBC_RUNTIME_RUNTIME_H_
|
|
|
|
COSMOPOLITAN_C_START_
|
|
|
|
/*───────────────────────────────────────────────────────────────────────────│─╗
|
|
|
|
│ cosmopolitan § runtime ─╬─│┼
|
|
|
|
╚────────────────────────────────────────────────────────────────────────────│*/
|
2024-07-27 16:16:54 +00:00
|
|
|
/* clang-format off */
|
2020-06-15 14:18:57 +00:00
|
|
|
|
2023-05-02 20:38:16 +00:00
|
|
|
#ifdef __x86_64__
|
2022-07-10 11:01:17 +00:00
|
|
|
typedef long jmp_buf[8];
|
Make improvements
- We now serialize the file descriptor table when spawning / executing
processes on Windows. This means you can now inherit more stuff than
just standard i/o. It's needed by bash, which duplicates the console
to file descriptor #255. We also now do a better job serializing the
environment variables, so you're less likely to encounter E2BIG when
using your bash shell. We also no longer coerce environ to uppercase
- execve() on Windows now remotely controls its parent process to make
them spawn a replacement for itself. Then it'll be able to terminate
immediately once the spawn succeeds, without having to linger around
for the lifetime as a shell process for proxying the exit code. When
process worker thread running in the parent sees the child die, it's
given a handle to the new child, to replace it in the process table.
- execve() and posix_spawn() on Windows will now provide CreateProcess
an explicit handle list. This allows us to remove handle locks which
enables better fork/spawn concurrency, with seriously correct thread
safety. Other codebases like Go use the same technique. On the other
hand fork() still favors the conventional WIN32 inheritence approach
which can be a little bit messy, but is *controlled* by guaranteeing
perfectly clean slates at both the spawning and execution boundaries
- sigset_t is now 64 bits. Having it be 128 bits was a mistake because
there's no reason to use that and it's only supported by FreeBSD. By
using the system word size, signal mask manipulation on Windows goes
very fast. Furthermore @asyncsignalsafe funcs have been rewritten on
Windows to take advantage of signal masking, now that it's much more
pleasant to use.
- All the overlapped i/o code on Windows has been rewritten for pretty
good signal and cancelation safety. We're now able to ensure overlap
data structures are cleaned up so long as you don't longjmp() out of
out of a signal handler that interrupted an i/o operation. Latencies
are also improved thanks to the removal of lots of "busy wait" code.
Waits should be optimal for everything except poll(), which shall be
the last and final demon we slay in the win32 i/o horror show.
- getrusage() on Windows is now able to report RUSAGE_CHILDREN as well
as RUSAGE_SELF, thanks to aggregation in the process manager thread.
2023-10-08 12:36:18 +00:00
|
|
|
typedef long sigjmp_buf[11];
|
2023-05-02 20:38:16 +00:00
|
|
|
#elif defined(__aarch64__)
|
|
|
|
typedef long jmp_buf[22];
|
Make improvements
- We now serialize the file descriptor table when spawning / executing
processes on Windows. This means you can now inherit more stuff than
just standard i/o. It's needed by bash, which duplicates the console
to file descriptor #255. We also now do a better job serializing the
environment variables, so you're less likely to encounter E2BIG when
using your bash shell. We also no longer coerce environ to uppercase
- execve() on Windows now remotely controls its parent process to make
them spawn a replacement for itself. Then it'll be able to terminate
immediately once the spawn succeeds, without having to linger around
for the lifetime as a shell process for proxying the exit code. When
process worker thread running in the parent sees the child die, it's
given a handle to the new child, to replace it in the process table.
- execve() and posix_spawn() on Windows will now provide CreateProcess
an explicit handle list. This allows us to remove handle locks which
enables better fork/spawn concurrency, with seriously correct thread
safety. Other codebases like Go use the same technique. On the other
hand fork() still favors the conventional WIN32 inheritence approach
which can be a little bit messy, but is *controlled* by guaranteeing
perfectly clean slates at both the spawning and execution boundaries
- sigset_t is now 64 bits. Having it be 128 bits was a mistake because
there's no reason to use that and it's only supported by FreeBSD. By
using the system word size, signal mask manipulation on Windows goes
very fast. Furthermore @asyncsignalsafe funcs have been rewritten on
Windows to take advantage of signal masking, now that it's much more
pleasant to use.
- All the overlapped i/o code on Windows has been rewritten for pretty
good signal and cancelation safety. We're now able to ensure overlap
data structures are cleaned up so long as you don't longjmp() out of
out of a signal handler that interrupted an i/o operation. Latencies
are also improved thanks to the removal of lots of "busy wait" code.
Waits should be optimal for everything except poll(), which shall be
the last and final demon we slay in the win32 i/o horror show.
- getrusage() on Windows is now able to report RUSAGE_CHILDREN as well
as RUSAGE_SELF, thanks to aggregation in the process manager thread.
2023-10-08 12:36:18 +00:00
|
|
|
typedef long sigjmp_buf[25];
|
2023-05-09 04:38:30 +00:00
|
|
|
#elif defined(__powerpc64__)
|
|
|
|
typedef unsigned __int128 jmp_buf[32];
|
|
|
|
#elif defined(__s390x__)
|
|
|
|
typedef unsigned long jmp_buf[18];
|
|
|
|
#elif defined(__riscv)
|
|
|
|
typedef unsigned long jmp_buf[26];
|
2023-05-02 20:38:16 +00:00
|
|
|
#endif
|
|
|
|
|
2024-06-21 03:46:42 +00:00
|
|
|
void mcount(void) libcesque;
|
|
|
|
int daemon(int, int) libcesque;
|
|
|
|
unsigned long getauxval(unsigned long) libcesque;
|
2024-07-27 16:16:54 +00:00
|
|
|
int setjmp(jmp_buf) libcesque returnstwice paramsnonnull();
|
2020-12-05 20:20:41 +00:00
|
|
|
void longjmp(jmp_buf, int) libcesque wontreturn paramsnonnull();
|
2024-07-27 16:16:54 +00:00
|
|
|
int _setjmp(jmp_buf) libcesque returnstwice paramsnonnull();
|
2022-10-11 00:52:41 +00:00
|
|
|
int sigsetjmp(sigjmp_buf, int) libcesque returnstwice paramsnonnull();
|
|
|
|
void siglongjmp(sigjmp_buf, int) libcesque wontreturn paramsnonnull();
|
2021-03-02 11:27:55 +00:00
|
|
|
void _longjmp(jmp_buf, int) libcesque wontreturn paramsnonnull();
|
2020-12-05 20:20:41 +00:00
|
|
|
void exit(int) wontreturn;
|
|
|
|
void _exit(int) libcesque wontreturn;
|
|
|
|
void _Exit(int) libcesque wontreturn;
|
2021-10-14 00:27:13 +00:00
|
|
|
void quick_exit(int) wontreturn;
|
2022-09-04 01:12:01 +00:00
|
|
|
void abort(void) wontreturn;
|
2023-09-06 10:54:42 +00:00
|
|
|
int atexit(void (*)(void)) paramsnonnull() libcesque;
|
|
|
|
char *getenv(const char *) paramsnonnull() __wur nosideeffect libcesque;
|
2024-07-27 16:16:54 +00:00
|
|
|
int putenv(char *) libcesque __read_write(1);
|
2024-06-21 03:46:42 +00:00
|
|
|
int setenv(const char *, const char *, int) libcesque;
|
|
|
|
int unsetenv(const char *) libcesque;
|
|
|
|
int clearenv(void) libcesque;
|
|
|
|
void fpreset(void) libcesque;
|
|
|
|
void *mmap(void *, uint64_t, int32_t, int32_t, int32_t, int64_t) libcesque;
|
2024-07-07 19:24:25 +00:00
|
|
|
void *mremap(void *, size_t, size_t, int, ...) libcesque;
|
2024-06-21 03:46:42 +00:00
|
|
|
int munmap(void *, uint64_t) libcesque;
|
|
|
|
int mprotect(void *, uint64_t, int) libcesque;
|
|
|
|
int msync(void *, size_t, int) libcesque;
|
|
|
|
int mlock(const void *, size_t) libcesque;
|
|
|
|
int munlock(const void *, size_t) libcesque;
|
|
|
|
long gethostid(void) libcesque;
|
|
|
|
int sethostid(long) libcesque;
|
|
|
|
char *getlogin(void) libcesque;
|
2024-07-27 16:16:54 +00:00
|
|
|
int getlogin_r(char *, size_t) libcesque __write_only(1, 2);
|
|
|
|
int login_tty(int) libcesque __fd_arg(1);
|
2024-07-04 17:52:16 +00:00
|
|
|
int getpagesize(void) pureconst libcesque;
|
2024-07-07 19:24:25 +00:00
|
|
|
int getgransize(void) pureconst libcesque;
|
2024-06-21 03:46:42 +00:00
|
|
|
int syncfs(int) dontthrow libcesque;
|
|
|
|
int vhangup(void) libcesque;
|
|
|
|
int getdtablesize(void) libcesque;
|
|
|
|
int sethostname(const char *, size_t) libcesque;
|
|
|
|
int acct(const char *) libcesque;
|
2023-06-10 01:02:06 +00:00
|
|
|
|
2023-08-14 03:31:27 +00:00
|
|
|
#if defined(_GNU_SOURCE) || defined(_COSMO_SOURCE)
|
|
|
|
extern char **environ;
|
2023-09-06 10:54:42 +00:00
|
|
|
char *secure_getenv(const char *) paramsnonnull() __wur nosideeffect libcesque;
|
2023-08-14 03:31:27 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#ifdef _COSMO_SOURCE
|
2023-06-15 20:50:42 +00:00
|
|
|
extern int __argc;
|
|
|
|
extern char **__argv;
|
|
|
|
extern char **__envp;
|
2024-07-19 04:02:59 +00:00
|
|
|
extern int __pagesize;
|
|
|
|
extern int __gransize;
|
2023-06-15 20:50:42 +00:00
|
|
|
extern unsigned long *__auxv;
|
|
|
|
extern intptr_t __oldstack;
|
Loader path security (#1012)
The ape loader now passes the program executable name directly as a
register. `x2` is used on aarch64, `%rdx` on x86_64. This is passed
as the third argument to `cosmo()` (M1) or `Launch` (non-M1) and is
assigned to the global `__program_executable_name`.
`GetProgramExecutableName` now returns this global's value, setting
it if it is initially null. `InitProgramExecutableName` first tries
exotic, secure methods: `KERN_PROC_PATHNAME` on FreeBSD/NetBSD, and
`/proc` on Linux. If those produce a reasonable response (i.e., not
`"/usr/bin/ape"`, which happens with the loader before this change),
that is used. Otherwise, if `issetugid()`, the empty string is used.
Otherwise, the old argv/envp parsing code is run.
The value returned from the loader is always the full absolute path
of the binary to be executed, having passed through `realpath`. For
the non-M1 loader, this necessitated writing `RealPath`, which uses
`readlinkat` of `"/proc/self/fd/[progfd]"` on Linux, `F_GETPATH` on
Xnu, and the `__realpath` syscall on OpenBSD. On FreeBSD/NetBSD, it
punts to `GetProgramExecutableName`, which is secure on those OSes.
With the loader, all platforms now have a secure program executable
name. With no loader or an old loader, everything still works as it
did, but setuid/setgid is not supported if the insecure pathfinding
code would have been needed.
Fixes #991.
2023-12-15 17:23:58 +00:00
|
|
|
extern char *__program_executable_name;
|
2023-06-15 20:50:42 +00:00
|
|
|
extern uint64_t __nosync;
|
|
|
|
extern int __strace;
|
|
|
|
extern int __ftrace;
|
|
|
|
extern uint64_t __syscount;
|
|
|
|
extern uint64_t kStartTsc;
|
|
|
|
extern const char kNtSystemDirectory[];
|
|
|
|
extern const char kNtWindowsDirectory[];
|
|
|
|
extern size_t __virtualmax;
|
2023-08-17 14:21:13 +00:00
|
|
|
extern size_t __stackmax;
|
2023-11-16 04:57:18 +00:00
|
|
|
extern bool32 __isworker;
|
2023-06-10 01:02:06 +00:00
|
|
|
/* utilities */
|
2024-07-27 16:16:54 +00:00
|
|
|
void _intsort(int *, size_t) libcesque __read_write(1, 2);
|
|
|
|
void _longsort(long *, size_t) libcesque __read_write(1, 2);
|
2023-06-10 01:02:06 +00:00
|
|
|
/* diagnostics */
|
2024-06-21 03:46:42 +00:00
|
|
|
void ShowCrashReports(void) libcesque;
|
|
|
|
int ftrace_install(void) libcesque;
|
|
|
|
int ftrace_enabled(int) libcesque;
|
|
|
|
int strace_enabled(int) libcesque;
|
2024-07-06 06:13:20 +00:00
|
|
|
void __print_maps(size_t) libcesque;
|
2025-01-01 12:59:38 +00:00
|
|
|
void __print_maps_win32(int64_t, const char *, size_t) libcesque;
|
2024-06-21 03:46:42 +00:00
|
|
|
void __printargs(const char *) libcesque;
|
2023-10-03 02:25:19 +00:00
|
|
|
/* builtin sh-like system/popen dsl */
|
2024-06-21 03:46:42 +00:00
|
|
|
int _cocmd(int, char **, char **) libcesque;
|
2023-06-10 01:02:06 +00:00
|
|
|
/* executable program */
|
2024-06-21 03:46:42 +00:00
|
|
|
char *GetProgramExecutableName(void) libcesque;
|
|
|
|
char *GetInterpreterExecutableName(char *, size_t) libcesque;
|
|
|
|
int __open_executable(void) libcesque;
|
2023-06-10 01:02:06 +00:00
|
|
|
/* execution control */
|
2024-06-21 03:46:42 +00:00
|
|
|
int verynice(void) libcesque;
|
|
|
|
void __warn_if_powersave(void) libcesque;
|
|
|
|
void _Exit1(int) libcesque wontreturn libcesque;
|
2024-07-27 16:16:54 +00:00
|
|
|
void __paginate(int, const char *) libcesque __fd_arg(1);
|
|
|
|
void __paginate_file(int, const char *) libcesque __fd_arg(1);
|
2023-06-10 01:02:06 +00:00
|
|
|
/* memory management */
|
2024-06-21 03:46:42 +00:00
|
|
|
void _weakfree(void *) libcesque;
|
|
|
|
void *_mapanon(size_t) attributeallocsize((1)) mallocesque libcesque;
|
|
|
|
void *_mapshared(size_t) attributeallocsize((1)) mallocesque libcesque;
|
|
|
|
void CheckForFileLeaks(void) libcesque;
|
|
|
|
void __oom_hook(size_t) libcesque;
|
2023-07-24 15:31:54 +00:00
|
|
|
/* code morphing */
|
2024-06-21 03:46:42 +00:00
|
|
|
void __morph_begin(void) libcesque;
|
|
|
|
void __morph_end(void) libcesque;
|
|
|
|
void __jit_begin(void) libcesque;
|
|
|
|
void __jit_end(void) libcesque;
|
2024-08-26 19:29:59 +00:00
|
|
|
void __clear_cache(void *, void *);
|
2023-06-10 01:02:06 +00:00
|
|
|
/* portability */
|
2024-06-21 03:46:42 +00:00
|
|
|
bool32 IsGenuineBlink(void) libcesque;
|
|
|
|
bool32 IsCygwin(void) libcesque;
|
|
|
|
const char *GetCpuidOs(void) libcesque;
|
|
|
|
const char *GetCpuidEmulator(void) libcesque;
|
|
|
|
void GetCpuidBrand(char[13], uint32_t) libcesque;
|
|
|
|
long __get_rlimit(int) libcesque;
|
|
|
|
const char *__describe_os(void) libcesque;
|
|
|
|
long __get_sysctl(int, int) libcesque;
|
|
|
|
int __get_arg_max(void) pureconst libcesque;
|
|
|
|
int __get_cpu_count(void) pureconst libcesque;
|
|
|
|
long __get_avphys_pages(void) pureconst libcesque;
|
|
|
|
long __get_phys_pages(void) pureconst libcesque;
|
|
|
|
long __get_minsigstksz(void) pureconst libcesque;
|
|
|
|
long __get_safe_size(long, long) libcesque;
|
|
|
|
char *__get_tmpdir(void) libcesque;
|
2024-01-08 18:07:35 +00:00
|
|
|
forceinline int __trace_disabled(int x) {
|
2023-09-21 14:30:39 +00:00
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
#ifndef FTRACE
|
2023-11-10 12:14:27 +00:00
|
|
|
#define ftrace_enabled(...) __trace_disabled(__VA_ARGS__)
|
2023-09-21 14:30:39 +00:00
|
|
|
#endif
|
|
|
|
#ifndef SYSDEBUG
|
2023-11-10 12:14:27 +00:00
|
|
|
#define strace_enabled(...) __trace_disabled(__VA_ARGS__)
|
2023-09-21 14:30:39 +00:00
|
|
|
#endif
|
2023-08-14 03:31:27 +00:00
|
|
|
#endif /* _COSMO_SOURCE */
|
2020-06-15 14:18:57 +00:00
|
|
|
|
|
|
|
COSMOPOLITAN_C_END_
|
|
|
|
#endif /* COSMOPOLITAN_LIBC_RUNTIME_RUNTIME_H_ */
|