Skip to content

Commit dc058c0

Browse files
authored
sysfs: reopening file doesn't update fd (#2319)
Signed-off-by: Nuno Cruces <ncruces@users.noreply.github.com>
1 parent 1353ca2 commit dc058c0

File tree

4 files changed

+96
-31
lines changed

4 files changed

+96
-31
lines changed

internal/sysfs/file.go

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -269,7 +269,7 @@ func (f *fsFile) Readdir(n int) (dirents []experimentalsys.Dirent, errno experim
269269

270270
if f.reopenDir { // re-open the directory if needed.
271271
f.reopenDir = false
272-
if errno = adjustReaddirErr(f, f.closed, f.reopen()); errno != 0 {
272+
if errno = adjustReaddirErr(f, f.closed, f.rewindDir()); errno != 0 {
273273
return
274274
}
275275
}
@@ -418,19 +418,25 @@ func seek(s io.Seeker, offset int64, whence int) (int64, experimentalsys.Errno)
418418
return newOffset, experimentalsys.UnwrapOSError(err)
419419
}
420420

421-
// reopenFile allows re-opening a file for reasons such as applying flags or
422-
// directory iteration.
423-
type reopenFile func() experimentalsys.Errno
424-
425-
// compile-time check to ensure fsFile.reopen implements reopenFile.
426-
var _ reopenFile = (*fsFile)(nil).reopen
427-
428-
// reopen implements the same method as documented on reopenFile.
429-
func (f *fsFile) reopen() experimentalsys.Errno {
430-
_ = f.close()
431-
var err error
432-
f.file, err = f.fs.Open(f.name)
433-
return experimentalsys.UnwrapOSError(err)
421+
func (f *fsFile) rewindDir() experimentalsys.Errno {
422+
// Reopen the directory to rewind it.
423+
file, err := f.fs.Open(f.name)
424+
if err != nil {
425+
return experimentalsys.UnwrapOSError(err)
426+
}
427+
fi, err := file.Stat()
428+
if err != nil {
429+
return experimentalsys.UnwrapOSError(err)
430+
}
431+
// Can't check if it's still the same file,
432+
// but is it still a directory, at least?
433+
if !fi.IsDir() {
434+
return experimentalsys.ENOTDIR
435+
}
436+
// Only update f on success.
437+
_ = f.file.Close()
438+
f.file = file
439+
return 0
434440
}
435441

436442
// readdirFile allows masking the `Readdir` function on os.File.

internal/sysfs/file_test.go

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,50 @@ func TestWriteFdNonblock(t *testing.T) {
116116
t.Fatal("writeFd should return EAGAIN at some point")
117117
}
118118

119+
func TestFileReopenFileUpdatesFD(t *testing.T) {
120+
tmpDir := t.TempDir()
121+
path := path.Join(tmpDir, "file")
122+
123+
// Open the file twice. Closing the first file, frees its fd.
124+
// Then reopening the second file will take over the first fd.
125+
// If reopening the file doesn't update the fd, they won't match.
126+
f0 := requireOpenFile(t, path, experimentalsys.O_RDWR|experimentalsys.O_CREAT, 0o600)
127+
f1 := requireOpenFile(t, path, experimentalsys.O_RDWR, 0o600)
128+
defer f1.Close()
129+
f0.Close()
130+
131+
of, ok := f1.(*osFile)
132+
require.True(t, ok)
133+
134+
require.EqualErrno(t, 0, of.reopen())
135+
require.Equal(t, of.file.Fd(), of.fd)
136+
}
137+
138+
func TestFileReopenFileChecksSameFile(t *testing.T) {
139+
tmpDir := t.TempDir()
140+
path := path.Join(tmpDir, "file")
141+
142+
f := requireOpenFile(t, path, experimentalsys.O_RDWR|experimentalsys.O_CREAT, 0o600)
143+
defer f.Close()
144+
145+
require.NoError(t, os.Remove(path))
146+
147+
of, ok := f.(*osFile)
148+
require.True(t, ok)
149+
150+
// Path does not exist anymore.
151+
require.EqualErrno(t, experimentalsys.ENOENT, of.reopen())
152+
require.Equal(t, of.file.Fd(), of.fd)
153+
154+
tmp, err := os.Create(path)
155+
require.NoError(t, err)
156+
defer tmp.Close()
157+
158+
// Path exists, but is not the same file.
159+
require.EqualErrno(t, experimentalsys.ENOENT, of.reopen())
160+
require.Equal(t, of.file.Fd(), of.fd)
161+
}
162+
119163
func TestFileSetAppend(t *testing.T) {
120164
tmpDir := t.TempDir()
121165

@@ -124,6 +168,7 @@ func TestFileSetAppend(t *testing.T) {
124168

125169
// Open without APPEND.
126170
f, errno := OpenOSFile(fPath, experimentalsys.O_RDWR, 0o600)
171+
defer f.Close()
127172
require.EqualErrno(t, 0, errno)
128173
require.False(t, f.IsAppend())
129174

internal/sysfs/osfile.go

Lines changed: 30 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -83,21 +83,12 @@ func (f *osFile) SetAppend(enable bool) (errno experimentalsys.Errno) {
8383
f.flag &= ^experimentalsys.O_APPEND
8484
}
8585

86-
// Clear any create or trunc flag, as we are re-opening, not re-creating.
87-
f.flag &= ^(experimentalsys.O_CREAT | experimentalsys.O_TRUNC)
88-
89-
// appendMode (bool) cannot be changed later, so we have to re-open the
90-
// file. https://github.com/golang/go/blob/go1.20/src/os/file_unix.go#L60
86+
// appendMode cannot be changed later, so we have to re-open the file
87+
// https://github.com/golang/go/blob/go1.23/src/os/file_unix.go#L60
9188
return fileError(f, f.closed, f.reopen())
9289
}
9390

94-
// compile-time check to ensure osFile.reopen implements reopenFile.
95-
var _ reopenFile = (*osFile)(nil).reopen
96-
9791
func (f *osFile) reopen() (errno experimentalsys.Errno) {
98-
// Clear any create flag, as we are re-opening, not re-creating.
99-
f.flag &= ^experimentalsys.O_CREAT
100-
10192
var (
10293
isDir bool
10394
offset int64
@@ -116,22 +107,47 @@ func (f *osFile) reopen() (errno experimentalsys.Errno) {
116107
}
117108
}
118109

119-
_ = f.close()
120-
f.file, errno = OpenFile(f.path, f.flag, f.perm)
110+
// Clear any create or trunc flag, as we are re-opening, not re-creating.
111+
flag := f.flag &^ (experimentalsys.O_CREAT | experimentalsys.O_TRUNC)
112+
file, errno := OpenFile(f.path, flag, f.perm)
113+
if errno != 0 {
114+
return errno
115+
}
116+
errno = f.checkSameFile(file)
121117
if errno != 0 {
122118
return errno
123119
}
124120

125121
if !isDir {
126-
_, err = f.file.Seek(offset, io.SeekStart)
122+
_, err = file.Seek(offset, io.SeekStart)
127123
if err != nil {
124+
_ = file.Close()
128125
return experimentalsys.UnwrapOSError(err)
129126
}
130127
}
131128

129+
// Only update f on success.
130+
_ = f.file.Close()
131+
f.file = file
132+
f.fd = file.Fd()
132133
return 0
133134
}
134135

136+
func (f *osFile) checkSameFile(osf *os.File) experimentalsys.Errno {
137+
fi1, err := f.file.Stat()
138+
if err != nil {
139+
return experimentalsys.UnwrapOSError(err)
140+
}
141+
fi2, err := osf.Stat()
142+
if err != nil {
143+
return experimentalsys.UnwrapOSError(err)
144+
}
145+
if os.SameFile(fi1, fi2) {
146+
return 0
147+
}
148+
return experimentalsys.ENOENT
149+
}
150+
135151
// IsNonblock implements the same method as documented on fsapi.File
136152
func (f *osFile) IsNonblock() bool {
137153
return isNonblock(f)

sys/stat.go

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ type EpochNanos = int64
2929
// # Notes
3030
//
3131
// - This is used for WebAssembly ABI emulating the POSIX `stat` system call.
32-
// Fields included are required for WebAssembly ABI including wasip1
33-
// (a.k.a. wasix) and wasi-filesystem (a.k.a. wasip2). See
34-
// https://pubs.opengroup.org/onlinepubs/9699919799/functions/stat.html
32+
// See https://pubs.opengroup.org/onlinepubs/9699919799/functions/stat.html
3533
// - Fields here are required for WebAssembly ABI including wasip1
3634
// (a.k.a. wasix) and wasi-filesystem (a.k.a. wasip2).
3735
// - This isn't the same as syscall.Stat_t because wazero supports Windows,

0 commit comments

Comments
 (0)