Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WasmFS JS API: Implement truncate #19543

Merged
merged 26 commits into from
Jun 13, 2023
Merged
Show file tree
Hide file tree
Changes from 14 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions emcc.py
Original file line number Diff line number Diff line change
Expand Up @@ -2325,6 +2325,8 @@ def phase_linker_setup(options, state, newargs):
'_wasmfs_pwrite',
'_wasmfs_rename',
'_wasmfs_mkdir',
'_wasmfs_truncate',
'_wasmfs_ftruncate',
'_wasmfs_unlink',
'_wasmfs_chdir',
'_wasmfs_mknod',
Expand Down
8 changes: 6 additions & 2 deletions src/library_wasmfs.js
Original file line number Diff line number Diff line change
Expand Up @@ -276,8 +276,12 @@ FS.createPreloadedFile = FS_createPreloadedFile;
// TDOO: chown
// TODO: lchown
// TODO: fchown
// TODO: truncate
// TODO: ftruncate
truncate: (path, len) => {
return FS.handleError(withStackSave(() => (__wasmfs_truncate(stringToUTF8OnStack(path), len))));
},
ftruncate: (fd, len) => {
return FS.handleError(__wasmfs_ftruncate(fd, len));
},
// TODO: utime
findObject: (path) => {
var result = __wasmfs_identify(path);
Expand Down
38 changes: 13 additions & 25 deletions system/lib/wasmfs/js_api.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -126,25 +126,25 @@ int _wasmfs_mkdir(char* path, int mode) {
int _wasmfs_rmdir(char* path){ return __syscall_unlinkat(AT_FDCWD, (intptr_t)path, AT_REMOVEDIR); }

int _wasmfs_open(char* path, int flags, mode_t mode) {
int err = __syscall_openat(AT_FDCWD, (intptr_t)path, flags, mode);
if (err == -1) {
return -errno;
}
return err;
return __syscall_openat(AT_FDCWD, (intptr_t)path, flags, mode);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are these bugfixes?

Copy link
Contributor Author

@jameshu15869 jameshu15869 Jun 13, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We realized that this check isn't needed, since the syscalls do not actually set errno. The tests were passing before because err was never equal to -1, so the js_api.cpp function directly returned the error without using errno, giving the desired effect.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you make a separate PR for this cleanup stuff?

}

int _wasmfs_mknod(char* path, mode_t mode, dev_t dev) {
int err = __syscall_mknodat(AT_FDCWD, (intptr_t)path, mode, dev);
if (err == -1) {
return errno;
}
return err;
return __syscall_mknodat(AT_FDCWD, (intptr_t)path, mode, dev);
}

int _wasmfs_unlink(char* path) {
return __syscall_unlinkat(AT_FDCWD, (intptr_t)path, 0);
}

int _wasmfs_truncate(char *path, long size) {
return __syscall_truncate64((intptr_t)path, size);
}

int _wasmfs_ftruncate(int fd, long size) {
return __syscall_ftruncate64(fd, size);
}

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there's no extra logic necessary here, is it possible to skip these wrappers and just call the underlying syscall directly from the JS?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense, although I'm having trouble figuring out how to import the syscalls to library_wasmfs.js. I've tried using __syscall_truncate64 and ___syscall_truncate64 (Three underscores) and neither worked. Normally, I would add _wasmfs_truncate to emcc.py, but I don't think it worked. How should I go about making the syscall available to call?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe that could be a followup.

When calling __syscall_truncate64 from JS you would use an extra underscore... but when adding it to the settings.REQUIRED_EXPORTS list in emcc.py you would not.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Doing this as a follow-up sounds good to me.

int _wasmfs_chdir(char* path) { return __syscall_chdir((intptr_t)path); }

int _wasmfs_symlink(char* old_path, char* new_path) {
Expand Down Expand Up @@ -190,11 +190,7 @@ int _wasmfs_lchmod(char* path, mode_t mode) {
}

int _wasmfs_rename(char* oldpath, char* newpath) {
int err = __syscall_renameat(AT_FDCWD, (intptr_t)oldpath, AT_FDCWD, (intptr_t)newpath);
if (err == -1) {
return errno;
}
return err;
return __syscall_renameat(AT_FDCWD, (intptr_t)oldpath, AT_FDCWD, (intptr_t)newpath);
};

int _wasmfs_read(int fd, void *buf, size_t count) {
Expand Down Expand Up @@ -228,19 +224,11 @@ int _wasmfs_close(int fd) {
}

int _wasmfs_stat(char* path, struct stat* statBuf) {
int err = __syscall_stat64((intptr_t)path, (intptr_t)statBuf);
if (err == -1) {
return errno;
}
return err;
return __syscall_stat64((intptr_t)path, (intptr_t)statBuf);
}

int _wasmfs_lstat(char* path, struct stat* statBuf) {
int err = __syscall_lstat64((intptr_t)path, (intptr_t)statBuf);
if (err == -1) {
return errno;
}
return err;
return __syscall_lstat64((intptr_t)path, (intptr_t)statBuf);
}

// Helper method that identifies what a path is:
Expand Down
71 changes: 71 additions & 0 deletions test/fs/test_fs_js_api.c
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,76 @@ int main() {
assert(createFileNotHere && createFileNotHere.fd >= 0);
);

/********** test FS.truncate() **********/
EM_ASM(
FS.writeFile('truncatetest', 'a=1\nb=2\n');
);

struct stat s;
stat("truncatetest", &s);
assert(s.st_size == 8);

EM_ASM(
FS.truncate('truncatetest', 2);
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As with all these changes it would be good to look for other tests that already use this API, if any? If we were previously disabling, or not running, those tests under WASMFS it would be good to enable them now.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't see anything explicitly calling FS.truncate() in the test dir, so I added them to test_fs_js_api for now. Are there any places besides the test directory that could potentially contain disabled tests?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, it would only be in the test dir. I guess we had not tests for that API. Thanks for looking into it. Hopefully after we are done with this we will have much better test coverage for the JS API!

);
stat("truncatetest", &s);
assert(s.st_size == 2);

EM_ASM(
FS.truncate('truncatetest', 10);
);
stat("truncatetest", &s);
assert(s.st_size == 10);

EM_ASM(
var truncateStream = FS.open('truncatetest', 'w');
FS.ftruncate(truncateStream.fd, 4);
);
stat("truncatetest", &s);
assert(s.st_size == 4);

EM_ASM(
var ex;
try {
FS.truncate('truncatetest', -10);
} catch(err) {
ex = err;
}

assert(ex.name === "ErrnoError" && ex.errno === 28 /* EINVAL */);
);

EM_ASM(
var ex;
try {
var truncateStream = FS.open('truncatetest', 'w');
FS.ftruncate(truncateStream.fd, -10);
} catch(err) {
ex = err;
}

assert(ex.name === "ErrnoError" && ex.errno === 28 /* EINVAL */);
);

EM_ASM(
var ex;
try {
FS.truncate('nonexistent', 10);
} catch(err) {
ex = err;
}
assert(ex.name === "ErrnoError" && ex.errno === 44 /* ENOENT */);

var ex;
try {
FS.ftruncate(99, 10);
} catch(err) {
ex = err;
}

assert(ex.name === "ErrnoError" && ex.errno === 8 /* EBADF */);
);

/********** test FS.rename() **********/
EM_ASM(
FS.mkdir('renamedir');
Expand Down Expand Up @@ -151,6 +221,7 @@ int main() {

remove("mknodtest");
remove("createtest");
remove("truncatetest");
remove("testfile");
remove("renametestfile");
remove("readtestfile");
Expand Down