Share file offset across execve() on Windows

This is a breaking change. It defines the new environment variable named
_COSMO_FDS_V2 which is used for inheriting non-stdio file descriptors on
execve() or posix_spawn(). No effort has been spent thus far integrating
with the older variable. If a new binary launches the older ones or vice
versa they'll only be able to pass stdin / stdout / stderr to each other
therefore it's important that you upgrade all your cosmo binaries if you
depend on this functionality. You'll be glad you did because inheritance
of file descriptors is more aligned with the POSIX standard than before.
This commit is contained in:
Justine Tunney 2024-08-03 17:48:00 -07:00
parent 761c6ad615
commit 3f26dfbb31
No known key found for this signature in database
GPG key ID: BE714B4575D6E328
29 changed files with 572 additions and 249 deletions

View file

@ -17,12 +17,7 @@
PERFORMANCE OF THIS SOFTWARE.
*/
#include "libc/calls/calls.h"
#include "libc/calls/internal.h"
#include "libc/dce.h"
#include "libc/errno.h"
#include "libc/limits.h"
#include "libc/log/check.h"
#include "libc/runtime/runtime.h"
#include "libc/sock/sock.h"
#include "libc/sysv/consts/af.h"
#include "libc/sysv/consts/ipproto.h"
@ -30,23 +25,22 @@
#include "libc/sysv/consts/sock.h"
#include "libc/testlib/subprocess.h"
#include "libc/testlib/testlib.h"
#include "libc/x/x.h"
void SetUpOnce(void) {
testlib_enable_tmp_setup_teardown();
ASSERT_SYS(0, 0, pledge("stdio rpath wpath cpath fattr proc inet", 0));
}
/* TEST(lseek, ebadf) { */
/* ASSERT_SYS(EBADF, -1, lseek(-1, 0, SEEK_SET)); */
/* ASSERT_SYS(EBADF, -1, lseek(+3, 0, SEEK_SET)); */
/* } */
TEST(lseek, ebadf) {
ASSERT_SYS(EBADF, -1, lseek(-1, 0, SEEK_SET));
ASSERT_SYS(EBADF, -1, lseek(+3, 0, SEEK_SET));
}
/* TEST(lseek, badWhence_einval) { */
/* ASSERT_SYS(0, 3, creat("foo", 0644)); */
/* ASSERT_SYS(EINVAL, -1, lseek(3, 0, -1)); */
/* EXPECT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, badWhence_einval) {
ASSERT_SYS(0, 3, creat("foo", 0644));
ASSERT_SYS(EINVAL, -1, lseek(3, 0, -1));
EXPECT_SYS(0, 0, close(3));
}
TEST(lseek, negativeComputedOffset_einval) {
ASSERT_SYS(0, 3, creat("foo", 0644));
@ -59,68 +53,66 @@ TEST(lseek, negativeComputedOffset_einval) {
EXPECT_SYS(0, 0, close(3));
}
/* TEST(lseek, 64bit) { */
/* ASSERT_SYS(0, 3, creat("foo", 0644)); */
/* ASSERT_SYS(0, 0x100000001, lseek(3, 0x100000001, SEEK_SET)); */
/* EXPECT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, 64bit) {
ASSERT_SYS(0, 3, creat("foo", 0644));
ASSERT_SYS(0, 0x100000001, lseek(3, 0x100000001, SEEK_SET));
EXPECT_SYS(0, 0, close(3));
}
/* TEST(lseek, isPipe_ESPIPE) { */
/* int fds[2]; */
/* char buf[2]; */
/* ASSERT_SYS(0, 0, pipe(fds)); */
/* ASSERT_SYS(ESPIPE, -1, lseek(3, 0, SEEK_SET)); */
/* ASSERT_SYS(ESPIPE, -1, pwrite(4, "hi", 2, 0)); */
/* ASSERT_SYS(ESPIPE, -1, pread(3, buf, 2, 0)); */
/* EXPECT_SYS(0, 0, close(4)); */
/* EXPECT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, isPipe_ESPIPE) {
int fds[2];
char buf[2];
ASSERT_SYS(0, 0, pipe(fds));
ASSERT_SYS(ESPIPE, -1, lseek(3, 0, SEEK_SET));
ASSERT_SYS(ESPIPE, -1, pwrite(4, "hi", 2, 0));
ASSERT_SYS(ESPIPE, -1, pread(3, buf, 2, 0));
EXPECT_SYS(0, 0, close(4));
EXPECT_SYS(0, 0, close(3));
}
/* TEST(lseek, isSocket_ESPIPE) { */
/* char buf[2]; */
/* ASSERT_SYS(0, 3, socket(AF_INET, SOCK_STREAM, IPPROTO_TCP)); */
/* ASSERT_SYS(ESPIPE, -1, lseek(3, 0, SEEK_SET)); */
/* ASSERT_SYS(ESPIPE, -1, pwrite(3, "hi", 2, 0)); */
/* ASSERT_SYS(ESPIPE, -1, pread(3, buf, 2, 0)); */
/* EXPECT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, isSocket_ESPIPE) {
char buf[2];
ASSERT_SYS(0, 3, socket(AF_INET, SOCK_STREAM, IPPROTO_TCP));
ASSERT_SYS(ESPIPE, -1, lseek(3, 0, SEEK_SET));
ASSERT_SYS(ESPIPE, -1, pwrite(3, "hi", 2, 0));
ASSERT_SYS(ESPIPE, -1, pread(3, buf, 2, 0));
EXPECT_SYS(0, 0, close(3));
}
/* TEST(lseek, filePositionChanges_areObservableAcrossDup) { */
/* if (IsWindows()) return; // do not want to support */
/* ASSERT_SYS(0, 3, creat("wut", 0644)); */
/* ASSERT_SYS(0, 4, dup(3)); */
/* ASSERT_SYS(0, 0, lseek(3, 0, SEEK_CUR)); */
/* ASSERT_SYS(0, 1, lseek(4, 1, SEEK_SET)); */
/* ASSERT_SYS(0, 1, lseek(3, 0, SEEK_CUR)); */
/* EXPECT_SYS(0, 0, close(4)); */
/* EXPECT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, filePositionChanges_areObservableAcrossDup) {
ASSERT_SYS(0, 3, creat("wut", 0644));
ASSERT_SYS(0, 4, dup(3));
ASSERT_SYS(0, 0, lseek(3, 0, SEEK_CUR));
ASSERT_SYS(0, 1, lseek(4, 1, SEEK_SET));
ASSERT_SYS(0, 1, lseek(3, 0, SEEK_CUR));
EXPECT_SYS(0, 0, close(4));
EXPECT_SYS(0, 0, close(3));
}
/* TEST(lseek, filePositionChanges_areObservableAcrossProcesses) { */
/* if (IsWindows()) return; // do not want to support */
/* char buf[8] = {0}; */
/* ASSERT_SYS(0, 3, open("wut", O_RDWR | O_CREAT, 0644)); */
/* ASSERT_SYS(0, 3, write(3, "wut", 3)); */
/* ASSERT_SYS(0, 0, lseek(3, 0, SEEK_SET)); */
/* SPAWN(fork); */
/* ASSERT_SYS(0, 1, lseek(3, 1, SEEK_SET)); */
/* EXITS(0); */
/* EXPECT_SYS(0, 1, read(3, buf, 1)); */
/* EXPECT_EQ('u', buf[0]); */
/* EXPECT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, filePositionChanges_areObservableAcrossProcesses) {
char buf[8] = {0};
ASSERT_SYS(0, 3, open("wut", O_RDWR | O_CREAT, 0644));
ASSERT_SYS(0, 3, write(3, "wut", 3));
ASSERT_SYS(0, 0, lseek(3, 0, SEEK_SET));
SPAWN(fork);
ASSERT_SYS(0, 1, lseek(3, 1, SEEK_SET));
EXITS(0);
EXPECT_SYS(0, 1, read(3, buf, 1));
EXPECT_EQ('u', buf[0]);
EXPECT_SYS(0, 0, close(3));
}
/* TEST(lseek, beyondEndOfFile_isZeroExtendedUponSubsequentWrite) { */
/* char buf[8] = {1, 1}; */
/* ASSERT_SYS(0, 3, open("foo", O_RDWR | O_CREAT | O_TRUNC, 0644)); */
/* ASSERT_SYS(0, 2, lseek(3, 2, SEEK_SET)); */
/* ASSERT_SYS(0, 2, lseek(3, 0, SEEK_CUR)); */
/* ASSERT_SYS(0, 0, pread(3, buf, 8, 0)); // lseek() alone doesn't extend */
/* ASSERT_SYS(0, 2, write(3, buf, 2)); // does extend once i/o happens */
/* ASSERT_SYS(0, 4, pread(3, buf, 8, 0)); */
/* ASSERT_EQ(0, buf[0]); */
/* ASSERT_EQ(0, buf[1]); */
/* ASSERT_EQ(1, buf[2]); */
/* ASSERT_EQ(1, buf[3]); */
/* ASSERT_SYS(0, 0, close(3)); */
/* } */
TEST(lseek, beyondEndOfFile_isZeroExtendedUponSubsequentWrite) {
char buf[8] = {1, 1};
ASSERT_SYS(0, 3, open("foo", O_RDWR | O_CREAT | O_TRUNC, 0644));
ASSERT_SYS(0, 2, lseek(3, 2, SEEK_SET));
ASSERT_SYS(0, 2, lseek(3, 0, SEEK_CUR));
ASSERT_SYS(0, 0, pread(3, buf, 8, 0)); // lseek() alone doesn't extend
ASSERT_SYS(0, 2, write(3, buf, 2)); // does extend once i/o happens
ASSERT_SYS(0, 4, pread(3, buf, 8, 0));
ASSERT_EQ(0, buf[0]);
ASSERT_EQ(0, buf[1]);
ASSERT_EQ(1, buf[2]);
ASSERT_EQ(1, buf[3]);
ASSERT_SYS(0, 0, close(3));
}

View file

@ -3,60 +3,74 @@
PKGS += TEST_POSIX
TEST_POSIX_SRCS := \
TEST_POSIX_SRCS := \
$(wildcard test/posix/*.c)
TEST_POSIX_SRCS_TEST = \
TEST_POSIX_SRCS_TEST = \
$(filter %_test.c,$(TEST_POSIX_SRCS))
TEST_POSIX_OBJS = \
TEST_POSIX_OBJS = \
$(TEST_POSIX_SRCS:%.c=o/$(MODE)/%.o)
TEST_POSIX_COMS = \
$(TEST_POSIX_SRCS_TEST:%.c=o/$(MODE)/%)
TEST_POSIX_COMS = \
$(TEST_POSIX_SRCS_TEST:%.c=o/$(MODE)/%) \
o/$(MODE)/test/posix/file_offset_exec_prog
TEST_POSIX_BINS = \
$(TEST_POSIX_COMS) \
TEST_POSIX_BINS = \
$(TEST_POSIX_COMS) \
$(TEST_POSIX_COMS:%=%.dbg)
TEST_POSIX_TESTS = \
TEST_POSIX_TESTS = \
$(TEST_POSIX_SRCS_TEST:%.c=o/$(MODE)/%.ok)
TEST_POSIX_CHECKS = \
TEST_POSIX_CHECKS = \
$(TEST_POSIX_SRCS_TEST:%.c=o/$(MODE)/%.runs)
TEST_POSIX_DIRECTDEPS = \
LIBC_CALLS \
LIBC_FMT \
LIBC_INTRIN \
LIBC_MEM \
LIBC_PROC \
LIBC_RUNTIME \
LIBC_STDIO \
LIBC_STR \
LIBC_SYSV \
LIBC_THREAD \
THIRD_PARTY_MUSL \
TEST_POSIX_DIRECTDEPS = \
LIBC_CALLS \
LIBC_FMT \
LIBC_INTRIN \
LIBC_MEM \
LIBC_PROC \
LIBC_RUNTIME \
LIBC_STDIO \
LIBC_STR \
LIBC_SYSV \
LIBC_THREAD \
THIRD_PARTY_MUSL \
TEST_POSIX_DEPS := \
TEST_POSIX_DEPS := \
$(call uniq,$(foreach x,$(TEST_POSIX_DIRECTDEPS),$($(x))))
o/$(MODE)/test/posix/posix.pkg: \
$(TEST_POSIX_OBJS) \
o/$(MODE)/test/posix/posix.pkg: \
$(TEST_POSIX_OBJS) \
$(foreach x,$(TEST_POSIX_DIRECTDEPS),$($(x)_A).pkg)
o/$(MODE)/test/posix/%.dbg: \
$(TEST_POSIX_DEPS) \
o/$(MODE)/test/posix/%.o \
o/$(MODE)/test/posix/posix.pkg \
$(CRT) \
o/$(MODE)/test/posix/%.dbg: \
$(TEST_POSIX_DEPS) \
o/$(MODE)/test/posix/%.o \
o/$(MODE)/test/posix/posix.pkg \
$(CRT) \
$(APE_NO_MODIFY_SELF)
@$(APELINK)
o/$(MODE)/test/posix/fread3gb_test.runs: \
o/$(MODE)/test/posix/file_offset_exec_test.dbg: \
$(TEST_POSIX_DEPS) \
o/$(MODE)/test/posix/file_offset_exec_test.o \
o/$(MODE)/test/posix/file_offset_exec_prog.zip.o \
o/$(MODE)/test/posix/posix.pkg \
$(CRT) \
$(APE_NO_MODIFY_SELF)
@$(APELINK)
o/$(MODE)/test/posix/file_offset_exec_prog.zip.o: private \
ZIPOBJ_FLAGS += \
-B
o/$(MODE)/test/posix/fread3gb_test.runs: \
private QUOTA += -F5gb -M5gb
.PHONY: o/$(MODE)/test/posix
o/$(MODE)/test/posix: \
$(TEST_POSIX_BINS) \
o/$(MODE)/test/posix: \
$(TEST_POSIX_BINS) \
$(TEST_POSIX_CHECKS)

View file

@ -0,0 +1,63 @@
// Copyright 2024 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 <stdatomic.h>
#include <stdlib.h>
#include <sys/mman.h>
#include <unistd.h>
// subprogram for testing that lseek() is shared across execve()
atomic_int *phase;
int main(int argc, char *argv[]) {
if (argc != 3)
return 101;
int fd = atoi(argv[1]);
int mapfd = atoi(argv[2]);
if ((phase = mmap(0, sizeof(atomic_int), PROT_READ | PROT_WRITE, MAP_SHARED,
mapfd, 0)) == MAP_FAILED)
return 102;
if (write(fd, "1", 1) != 1)
return 103;
if (lseek(fd, 0, SEEK_CUR) != 2)
return 104;
*phase = 1;
for (;;)
if (*phase == 2)
break;
if (write(fd, "3", 1) != 1)
return 105;
if (lseek(fd, 0, SEEK_CUR) != 4)
return 106;
*phase = 3;
for (;;)
if (*phase == 4)
break;
if (munmap(phase, sizeof(atomic_int)))
return 107;
if (close(mapfd))
return 108;
if (close(fd))
return 109;
}

View file

@ -0,0 +1,162 @@
// Copyright 2024 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 <signal.h>
#include <stdatomic.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/mman.h>
#include <unistd.h>
// test that lseek() is shared across execve()
__static_yoink("zipos");
void on_unexpected_death(int sig) {
int ws;
if (wait(&ws) == -1)
_Exit(33);
if (!WIFEXITED(ws))
_Exit(34);
if (!(WEXITSTATUS(ws) & 255))
_Exit(35);
_Exit(WEXITSTATUS(ws));
}
int main() {
signal(SIGCHLD, on_unexpected_death);
// extract test program
int exefd;
int zipfd;
ssize_t got;
char exepath[] = "/tmp/file_offset_exec_prog.XXXXXX";
if ((exefd = mkstemp(exepath)) == -1)
return 2;
if (fchmod(exefd, 0755))
return 3;
if ((zipfd = open("/zip/file_offset_exec_prog", O_RDONLY)) == -1)
return 4;
for (;;) {
char chunk[512];
if ((got = read(zipfd, chunk, sizeof(chunk))) == -1)
return 5;
if (!got)
break;
if (write(exefd, chunk, got) != got)
return 6;
}
if (close(zipfd))
return 7;
if (close(exefd))
return 8;
// create file shared memory mapping for synchronization
int mapfd;
atomic_int *phase;
char mappath[] = "/tmp/file_offset_exec_phase.XXXXXX";
if ((mapfd = mkstemp(mappath)) == -1)
return 9;
if (ftruncate(mapfd, sizeof(atomic_int)))
return 10;
if ((phase = mmap(0, sizeof(atomic_int), PROT_READ | PROT_WRITE, MAP_SHARED,
mapfd, 0)) == MAP_FAILED)
return 11;
// create test file to which both processes shall be writing
int fd;
char path[] = "/tmp/file_offset_exec_file.XXXXXX";
if ((fd = mkstemp(path)) == -1)
return 12;
if (lseek(fd, 0, SEEK_CUR) != 0)
return 13;
// start writing to file
if (write(fd, "0", 1) != 1)
return 14;
if (lseek(fd, 0, SEEK_CUR) != 1)
return 15;
// spawn program
int pid;
if ((pid = fork()) == -1)
return 16;
if (!pid) {
char str[2][12];
char *envs[] = {0};
char *args[] = {exepath, str[0], str[1], 0};
sprintf(str[0], "%d", fd);
sprintf(str[1], "%d", mapfd);
execve(exepath, args, envs);
_Exit(17);
}
for (;;)
if (*phase == 1)
break;
if (write(fd, "2", 1) != 1)
return 18;
if (lseek(fd, 0, SEEK_CUR) != 3)
return 19;
*phase = 2;
for (;;)
if (*phase == 3)
break;
if (write(fd, "4", 1) != 1)
return 20;
if (lseek(fd, 0, SEEK_CUR) != 5)
return 21;
signal(SIGCHLD, SIG_DFL);
*phase = 4;
int ws;
if (wait(&ws) == -1)
return 22;
if (!WIFEXITED(ws))
return 23;
if (WEXITSTATUS(ws))
return WEXITSTATUS(ws);
char buf[16] = {0};
if (pread(fd, buf, 15, 0) != 5)
return 24;
if (lseek(fd, 0, SEEK_CUR) != 5)
return 25;
if (close(fd))
return 26;
if (unlink(path))
return 27;
if (unlink(exepath))
return 28;
if (munmap(phase, sizeof(atomic_int)))
return 29;
if (close(mapfd))
return 30;
if (unlink(mappath))
return 31;
if (strcmp(buf, "01234"))
return 32;
}

View file

@ -13,42 +13,54 @@
// TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
// PERFORMANCE OF THIS SOFTWARE.
#include <signal.h>
#include <stdatomic.h>
#include <stdlib.h>
#include <sys/mman.h>
#include <unistd.h>
// test that file offset is shared across multiple processes
// test that lseek() is shared across fork()
atomic_int *phase;
void on_unexpected_death(int sig) {
int ws;
if (wait(&ws) == -1)
_Exit(33);
if (!WIFEXITED(ws))
_Exit(34);
if (!(WEXITSTATUS(ws) & 255))
_Exit(35);
_Exit(WEXITSTATUS(ws));
}
int main() {
signal(SIGCHLD, on_unexpected_death);
atomic_int *phase;
if ((phase = mmap(0, sizeof(atomic_int), PROT_READ | PROT_WRITE,
MAP_SHARED | MAP_ANONYMOUS, -1, 0)) == MAP_FAILED)
return 1;
return 2;
int fd;
char path[] = "/tmp/fd_test.XXXXXX";
char path[] = "/tmp/file_offset_fork_test.XXXXXX";
if ((fd = mkstemp(path)) == -1)
return 2;
return 3;
if (lseek(fd, 0, SEEK_CUR) != 0)
return 22;
return 4;
if (write(fd, "0", 1) != 1)
return 3;
return 5;
if (lseek(fd, 0, SEEK_CUR) != 1)
return 33;
return 6;
int pid;
if ((pid = fork()) == -1)
return 4;
return 7;
if (!pid) {
if (write(fd, "1", 1) != 1)
_Exit(100);
_Exit(8);
if (lseek(fd, 0, SEEK_CUR) != 2)
_Exit(101);
_Exit(9);
*phase = 1;
for (;;)
@ -56,10 +68,15 @@ int main() {
break;
if (write(fd, "3", 1) != 1)
_Exit(102);
_Exit(10);
if (lseek(fd, 0, SEEK_CUR) != 4)
_Exit(103);
_Exit(11);
*phase = 3;
for (;;)
if (*phase == 4)
break;
_Exit(0);
}
@ -68,9 +85,9 @@ int main() {
break;
if (write(fd, "2", 1) != 1)
return 5;
return 12;
if (lseek(fd, 0, SEEK_CUR) != 3)
return 55;
return 13;
*phase = 2;
for (;;)
@ -78,30 +95,36 @@ int main() {
break;
if (write(fd, "4", 1) != 1)
return 6;
return 14;
if (lseek(fd, 0, SEEK_CUR) != 5)
return 66;
return 15;
signal(SIGCHLD, SIG_DFL);
*phase = 4;
int ws;
if (wait(&ws) == -1)
return 7;
return 16;
if (!WIFEXITED(ws))
return 8;
return 17;
if (WEXITSTATUS(ws))
return WEXITSTATUS(ws);
char buf[16] = {0};
if (pread(fd, buf, 15, 0) != 5)
return 12;
return 18;
if (lseek(fd, 0, SEEK_CUR) != 5)
return 77;
return 19;
if (close(fd))
return 13;
return 20;
if (munmap(phase, sizeof(atomic_int)))
return 21;
if (unlink(path))
return 14;
return 22;
if (strcmp(buf, "01234"))
return 15;
return 23;
}