windows: support nil done parameter in ReadFile and WriteFile

qmuntal · qmuntal · commit 628365db92cc · 2024-01-30T17:14:39.000Z
Win32 defines the `done` param as optional for ReadFile and WriteFile functions. We should support this case too. Fixes golang/go#65365. Change-Id: I961ff66a63d3a8ffa5560b6dab21fbd4ac9817ae Reviewed-on: https://go-review.googlesource.com/c/sys/+/559375 Reviewed-by: Mauri de Souza Meneguzzo <mauri870@gmail.com> Reviewed-by: Bryan Mills <bcmills@google.com> Reviewed-by: Michael Knyszek <mknyszek@google.com> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
diff --git a/windows/syscall_windows.go b/windows/syscall_windows.go
@@ -572,23 +572,31 @@ func Write(fd Handle, p []byte) (n int, err error) {
 }
 
 func ReadFile(fd Handle, p []byte, done *uint32, overlapped *Overlapped) error {
-	err := readFile(fd, p, done, overlapped)
+	var n uint32
+	err := readFile(fd, p, &n, overlapped)
 	if raceenabled {
-		if *done > 0 {
-			raceWriteRange(unsafe.Pointer(&p[0]), int(*done))
+		if n > 0 {
+			raceWriteRange(unsafe.Pointer(&p[0]), int(n))
 		}
 		raceAcquire(unsafe.Pointer(&ioSync))
 	}
+	if done != nil {
+		*done = n
+	}
 	return err
 }
 
 func WriteFile(fd Handle, p []byte, done *uint32, overlapped *Overlapped) error {
 	if raceenabled {
 		raceReleaseMerge(unsafe.Pointer(&ioSync))
 	}
-	err := writeFile(fd, p, done, overlapped)
-	if raceenabled && *done > 0 {
-		raceReadRange(unsafe.Pointer(&p[0]), int(*done))
+	var n uint32
+	err := writeFile(fd, p, &n, overlapped)
+	if raceenabled && n > 0 {
+		raceReadRange(unsafe.Pointer(&p[0]), int(n))
+	}
+	if done != nil {
+		*done = n
 	}
 	return err
 }
diff --git a/windows/syscall_windows_test.go b/windows/syscall_windows_test.go
@@ -1275,3 +1275,58 @@ uintptr_t beep(void) {
 		t.Fatal("LoadLibraryEx unexpectedly found beep.dll")
 	}
 }
+
+func TestReadWriteFileOverlapped(t *testing.T) {
+	name := filepath.Join(t.TempDir(), "test.txt")
+	fd, err := windows.CreateFile(windows.StringToUTF16Ptr(name), windows.GENERIC_READ|windows.GENERIC_WRITE, 0, nil, windows.CREATE_NEW, windows.FILE_FLAG_OVERLAPPED, 0)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer windows.CloseHandle(fd)
+
+	content := []byte("hello")
+	// Test that we can write to a file using overlapped I/O.
+	var ow windows.Overlapped
+	ow.HEvent, err = windows.CreateEvent(nil, 0, 0, nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer windows.CloseHandle(ow.HEvent)
+	if err := windows.WriteFile(fd, content, nil, &ow); err != nil && err != windows.ERROR_IO_PENDING {
+		t.Fatal(err)
+	}
+	if _, err := windows.WaitForSingleObject(ow.HEvent, windows.INFINITE); err != nil {
+		t.Fatal(err)
+	}
+	var n uint32
+	if err := windows.GetOverlappedResult(fd, &ow, &n, true); err != nil {
+		t.Fatal(err)
+	}
+	if n != uint32(len(content)) {
+		t.Fatalf("got %d bytes written; want %d", n, len(content))
+	}
+
+	// Test that we can read from a file using overlapped I/O.
+	var or windows.Overlapped
+	or.HEvent, err = windows.CreateEvent(nil, 0, 0, nil)
+	if err != nil {
+		t.Fatal(err)
+	}
+	defer windows.CloseHandle(ow.HEvent)
+	buf := make([]byte, len(content))
+	if err := windows.ReadFile(fd, buf, nil, &or); err != nil && err != windows.ERROR_IO_PENDING {
+		t.Fatal(err)
+	}
+	if err != nil {
+		t.Fatal(err)
+	}
+	if _, err := windows.WaitForSingleObject(or.HEvent, windows.INFINITE); err != nil {
+		t.Fatal(err)
+	}
+	if err := windows.GetOverlappedResult(fd, &or, &n, true); err != nil {
+		t.Fatal(err)
+	}
+	if string(buf) != string(content) {
+		t.Fatalf("got %q; want %q", buf, content)
+	}
+}

Original file line number	Diff line number	Diff line change
`@@ -572,23 +572,31 @@ func Write(fd Handle, p []byte) (n int, err error) {`
`572`	`572`	`}`
`573`	`573`
`574`	`574`	`func ReadFile(fd Handle, p []byte, done uint32, overlapped Overlapped) error {`
`575`		`- err := readFile(fd, p, done, overlapped)`
	`575`	`+ var n uint32`
	`576`	`+ err := readFile(fd, p, &n, overlapped)`
`576`	`577`	`if raceenabled {`
`577`		`- if *done > 0 {`
`578`		`- raceWriteRange(unsafe.Pointer(&p[0]), int(*done))`
	`578`	`+ if n > 0 {`
	`579`	`+ raceWriteRange(unsafe.Pointer(&p[0]), int(n))`
`579`	`580`	`}`
`580`	`581`	`raceAcquire(unsafe.Pointer(&ioSync))`
`581`	`582`	`}`
	`583`	`+ if done != nil {`
	`584`	`+ *done = n`
	`585`	`+ }`
`582`	`586`	`return err`
`583`	`587`	`}`
`584`	`588`
`585`	`589`	`func WriteFile(fd Handle, p []byte, done uint32, overlapped Overlapped) error {`
`586`	`590`	`if raceenabled {`
`587`	`591`	`raceReleaseMerge(unsafe.Pointer(&ioSync))`
`588`	`592`	`}`
`589`		`- err := writeFile(fd, p, done, overlapped)`
`590`		`- if raceenabled && *done > 0 {`
`591`		`- raceReadRange(unsafe.Pointer(&p[0]), int(*done))`
	`593`	`+ var n uint32`
	`594`	`+ err := writeFile(fd, p, &n, overlapped)`
	`595`	`+ if raceenabled && n > 0 {`
	`596`	`+ raceReadRange(unsafe.Pointer(&p[0]), int(n))`
	`597`	`+ }`
	`598`	`+ if done != nil {`
	`599`	`+ *done = n`
`592`	`600`	`}`
`593`	`601`	`return err`
`594`	`602`	`}`