c/libuv
1
0
Fork 0
mirror of https://github.com/libuv/libuv synced 2025-03-28 21:13:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs for uv_fs_openat

Browse Source 
Signed-off-by: Yage Hu <me@huyage.dev>
This commit is contained in:
Yage Hu 2024-06-13 11:24:41 -07:00
parent cd9bc28f05
commit c044b242fb
5 changed files with 60 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/src/fs.rst
View File

@ -111,7 +111,8 @@ Data types
UV_FS_READDIR,
UV_FS_CLOSEDIR,
UV_FS_MKSTEMP,
UV_FS_LUTIME
UV_FS_LUTIME,
UV_FS_OPENAT
} uv_fs_type;
.. c:type:: uv_statfs_t
@ -237,6 +238,15 @@ API
in binary mode. Because of this the O_BINARY and O_TEXT flags are not
supported.
.. c:function:: int uv_fs_openat(uv_loop_t* loop, uv_fs_t* req, uv_file file, const char* path, int flags, int mode, uv_fs_cb cb)
Equivalent to :man:`openat(2)`.
.. note::
On Windows libuv uses `NtCreateFile` and thus the file is always opened
in binary mode. Because of this the O_BINARY and O_TEXT flags are not
supported.
.. c:function:: int uv_fs_read(uv_loop_t* loop, uv_fs_t* req, uv_file file, const uv_buf_t bufs[], unsigned int nbufs, int64_t offset, uv_fs_cb cb)
Equivalent to :man:`preadv(2)`. If the `offset` argument is `-1`, then

2
include/uv.h
View File

@ -1473,7 +1473,7 @@ UV_EXTERN int uv_fs_open(uv_loop_t* loop,
uv_fs_cb cb);
UV_EXTERN int uv_fs_openat(uv_loop_t* loop,
uv_fs_t* req,
uv_os_fd_t file,
uv_file file,
const char* path,
int flags,
int mode,

2
src/unix/fs.c
View File

@ -2043,7 +2043,7 @@ int uv_fs_open(uv_loop_t* loop,
int uv_fs_openat(uv_loop_t* loop,
uv_fs_t* req,
uv_os_fd_t file,
uv_file file,
const char* path,
int flags,
int mode,

40
src/win/fs.c
View File

@ -676,7 +676,7 @@ void fs__openat(uv_fs_t* req) {
UNICODE_STRING str;
IO_STATUS_BLOCK isb;
OBJECT_ATTRIBUTES obj;
int current_umask;
int fd, current_umask;
int flags = req->fs.info.file_flags;
struct uv__fd_info_s fd_info;
@ -843,11 +843,19 @@ void fs__openat(uv_fs_t* req) {
options |= FILE_DIRECTORY_FILE;
}
HANDLE dir = (HANDLE) _get_osfhandle(req->fs.info.fd_out);
if (dir == INVALID_HANDLE_VALUE) {
fprintf(stderr, "get_osfhandle\n");
SET_REQ_WIN32_ERROR(req, (DWORD) UV_EBADF);
return;
}
pRtlInitUnicodeString(&str, req->file.pathw);
InitializeObjectAttributes(&obj,
&str,
OBJ_CASE_INSENSITIVE,
req->fs.info.hFile_out,
dir,
NULL);
NTSTATUS status = pNtCreateFile(&file,
@ -864,7 +872,7 @@ void fs__openat(uv_fs_t* req) {
if (!NT_SUCCESS(status)) {
ULONG error = pRtlNtStatusToDosError(status);
if ((isb.Information & FILE_EXISTS != 0) && (flags & UV_FS_O_CREAT) &&
if (((isb.Information & FILE_EXISTS) != 0) && (flags & UV_FS_O_CREAT) &&
!(flags & UV_FS_O_EXCL)) {
/* Special case: when FILE_EXISTS happens and UV_FS_O_CREAT was
* specified, it means the path referred to a directory. */
@ -875,6 +883,22 @@ void fs__openat(uv_fs_t* req) {
return;
}
fd = _open_osfhandle((intptr_t) file, flags);
if (fd < 0) {
/* The only known failure mode for _open_osfhandle() is EMFILE, in which
* case GetLastError() will return zero. However we'll try to handle other
* errors as well, should they ever occur.
*/
if (errno == EMFILE)
SET_REQ_UV_ERROR(req, UV_EMFILE, ERROR_TOO_MANY_OPEN_FILES);
else if (GetLastError() != ERROR_SUCCESS)
SET_REQ_WIN32_ERROR(req, GetLastError());
else
SET_REQ_WIN32_ERROR(req, (DWORD) UV_UNKNOWN);
CloseHandle(file);
return;
}
if (flags & UV_FS_O_FILEMAP) {
FILE_STANDARD_INFO file_info;
if (!GetFileInformationByHandleEx(file,
@ -916,10 +940,10 @@ void fs__openat(uv_fs_t* req) {
}
}
uv__fd_hash_add(file, &fd_info);
uv__fd_hash_add(fd, &fd_info);
}
SET_REQ_RESULT(req, (uintptr_t)file);
SET_REQ_RESULT(req, fd);
return;
einval:
@ -3503,7 +3527,7 @@ int uv_fs_open(uv_loop_t* loop, uv_fs_t* req, const char* path, int flags,
int uv_fs_openat(uv_loop_t* loop,
uv_fs_t* req,
uv_os_fd_t handle,
uv_file handle,
const char* path,
int flags,
int mode,
@ -3517,10 +3541,10 @@ int uv_fs_openat(uv_loop_t* loop,
return req->result;
}
req->fs.info.hFile_out = handle;
req->fs.info.fd_out = handle;
req->fs.info.file_flags = flags;
req->fs.info.mode = mode;
POST0;
POST;
}

30
test/test-fs.c
View File

@ -3248,8 +3248,8 @@ TEST_IMPL(fs_scandir_early_exit) {
TEST_IMPL(fs_openat) {
int r;
uv_fs_t req;
uv_os_fd_t fd;
uv_os_fd_t dirfd;
uv_file fd;
uv_file dirfd;
/* Setup. */
unlink("test/fixtures/test_dir/test_file_not_exist");
@ -3275,7 +3275,7 @@ TEST_IMPL(fs_openat) {
ASSERT_GE(r, 0);
uv_fs_req_cleanup(&req);
dirfd = (uv_os_fd_t) req.result;
dirfd = (uv_file) r;
r = uv_fs_open(NULL,
&req,
@ -3283,9 +3283,9 @@ TEST_IMPL(fs_openat) {
UV_FS_O_RDWR | UV_FS_O_CREAT,
S_IWUSR | S_IRUSR,
NULL);
ASSERT_OK(r);
ASSERT_GE(r, 0);
uv_fs_req_cleanup(&req);
fd = (uv_os_fd_t) req.result;
fd = r;
r = uv_fs_close(NULL, &req, fd, NULL);
ASSERT_OK(r);
uv_fs_req_cleanup(&req);
@ -3299,9 +3299,9 @@ TEST_IMPL(fs_openat) {
UV_FS_O_RDWR | UV_FS_O_CREAT,
S_IWUSR | S_IRUSR,
NULL);
ASSERT_OK(r);
ASSERT_GE(r, 0);
uv_fs_req_cleanup(&req);
fd = (uv_os_fd_t) req.result;
fd = (uv_file) r;
r = uv_fs_close(NULL, &req, fd, NULL);
ASSERT_OK(r);
uv_fs_req_cleanup(&req);
@ -3316,14 +3316,14 @@ TEST_IMPL(fs_openat) {
UV_FS_O_RDWR | UV_FS_O_CREAT,
S_IWUSR | S_IRUSR,
openat_cb_simple);
ASSERT_OK(r);
ASSERT_GE(r, 0);
ASSERT_OK(openat_cb_count);
uv_run(loop, UV_RUN_DEFAULT);
ASSERT_EQ(1, openat_cb_count);
uv_fs_req_cleanup(&req);
fd = (uv_os_fd_t) req.result;
fd = (uv_file) req.result;
r = uv_fs_close(NULL, &req, fd, NULL);
ASSERT_OK(r);
uv_fs_req_cleanup(&req);
@ -3338,9 +3338,9 @@ TEST_IMPL(fs_openat) {
UV_FS_O_RDONLY | UV_FS_O_DIRECTORY,
S_IWUSR | S_IRUSR,
NULL);
ASSERT_OK(r);
ASSERT_GE(r, 0);
uv_fs_req_cleanup(&req);
fd = (uv_os_fd_t) req.result;
fd = (uv_file) req.result;
r = uv_fs_close(NULL, &req, fd, NULL);
ASSERT_OK(r);
uv_fs_req_cleanup(&req);
@ -3355,9 +3355,9 @@ TEST_IMPL(fs_openat) {
UV_FS_O_RDWR | UV_FS_O_CREAT,
S_IWUSR | S_IRUSR,
NULL);
ASSERT_OK(r);
ASSERT_GE(r, 0);
uv_fs_req_cleanup(&req);
fd = (uv_os_fd_t) req.result;
fd = (uv_file) req.result;
r = uv_fs_close(NULL, &req, fd, NULL);
ASSERT_OK(r);
uv_fs_req_cleanup(&req);
@ -3385,10 +3385,10 @@ TEST_IMPL(fs_openat) {
UV_FS_O_RDONLY,
0,
NULL);
ASSERT_OK(r);
ASSERT_GE(r, 0);
uv_fs_req_cleanup(&req);
fd = (uv_os_fd_t) req.result;
fd = (uv_file) req.result;
iov = uv_buf_init(test_buf, sizeof(test_buf));
r = uv_fs_write(NULL,