unix: create wrappers for solaris/illumos Event Ports

This work is in support of a cleanup of fsnotify/fsnotify#263

Change-Id: Ibd7500d20322765bfd50aa18333eb43ee7b659d7
Reviewed-on: https://go-review.googlesource.com/c/sys/+/324630
Run-TryBot: Ian Lance Taylor <iant@golang.org>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
Reviewed-by: Tobias Klauser <tobias.klauser@gmail.com>
This commit is contained in:
Nahum Shalman
2021-08-17 13:33:20 +00:00
committed by Tobias Klauser
parent 1e6c022a89
commit 13f9c583af
3 changed files with 602 additions and 1 deletions
+291
View File
@@ -8,7 +8,11 @@
package unix_test
import (
"fmt"
"io/ioutil"
"os"
"os/exec"
"runtime"
"testing"
"golang.org/x/sys/unix"
@@ -41,3 +45,290 @@ func TestSysconf(t *testing.T) {
}
t.Logf("Sysconf(SC_CLK_TCK) = %d", n)
}
// Event Ports
func TestBasicEventPort(t *testing.T) {
tmpfile, err := ioutil.TempFile("", "eventport")
if err != nil {
t.Fatalf("unable to create a tempfile: %v", err)
}
path := tmpfile.Name()
defer os.Remove(path)
stat, err := os.Stat(path)
if err != nil {
t.Fatalf("Failed to stat %s: %v", path, err)
}
port, err := unix.NewEventPort()
if err != nil {
t.Fatalf("NewEventPort failed: %v", err)
}
defer port.Close()
cookie := stat.Mode()
err = port.AssociatePath(path, stat, unix.FILE_MODIFIED, cookie)
if err != nil {
t.Errorf("AssociatePath failed: %v", err)
}
if !port.PathIsWatched(path) {
t.Errorf("PathIsWatched unexpectedly returned false")
}
err = port.DissociatePath(path)
if err != nil {
t.Errorf("DissociatePath failed: %v", err)
}
err = port.AssociatePath(path, stat, unix.FILE_MODIFIED, cookie)
if err != nil {
t.Errorf("AssociatePath failed: %v", err)
}
bs := []byte{42}
tmpfile.Write(bs)
timeout := new(unix.Timespec)
timeout.Sec = 1
pevent, err := port.GetOne(timeout)
if err == unix.ETIME {
t.Errorf("GetOne timed out: %v", err)
}
if err != nil {
t.Errorf("GetOne failed: %v", err)
}
if pevent.Path != path {
t.Errorf("Path mismatch: %v != %v", pevent.Path, path)
}
err = port.AssociatePath(path, stat, unix.FILE_MODIFIED, cookie)
if err != nil {
t.Errorf("AssociatePath failed: %v", err)
}
err = port.AssociatePath(path, stat, unix.FILE_MODIFIED, cookie)
if err == nil {
t.Errorf("Unexpected success associating already associated path")
}
}
func TestEventPortFds(t *testing.T) {
_, path, _, _ := runtime.Caller(0)
stat, err := os.Stat(path)
cookie := stat.Mode()
port, err := unix.NewEventPort()
if err != nil {
t.Errorf("NewEventPort failed: %v", err)
}
defer port.Close()
r, w, err := os.Pipe()
if err != nil {
t.Errorf("unable to create a pipe: %v", err)
}
defer w.Close()
defer r.Close()
fd := r.Fd()
port.AssociateFd(fd, unix.POLLIN, cookie)
if !port.FdIsWatched(fd) {
t.Errorf("FdIsWatched unexpectedly returned false")
}
err = port.DissociateFd(fd)
err = port.AssociateFd(fd, unix.POLLIN, cookie)
bs := []byte{42}
w.Write(bs)
n, err := port.Pending()
if n != 1 {
t.Errorf("Pending() failed: %v, %v", n, err)
}
timeout := new(unix.Timespec)
timeout.Sec = 1
pevent, err := port.GetOne(timeout)
if err == unix.ETIME {
t.Errorf("GetOne timed out: %v", err)
}
if err != nil {
t.Errorf("GetOne failed: %v", err)
}
if pevent.Fd != fd {
t.Errorf("Fd mismatch: %v != %v", pevent.Fd, fd)
}
var c = pevent.Cookie
if c == nil {
t.Errorf("Cookie missing: %v != %v", cookie, c)
return
}
if c != cookie {
t.Errorf("Cookie mismatch: %v != %v", cookie, c)
}
port.AssociateFd(fd, unix.POLLIN, cookie)
err = port.AssociateFd(fd, unix.POLLIN, cookie)
if err == nil {
t.Errorf("unexpected success associating already associated fd")
}
}
func TestEventPortErrors(t *testing.T) {
tmpfile, err := ioutil.TempFile("", "eventport")
if err != nil {
t.Errorf("unable to create a tempfile: %v", err)
}
path := tmpfile.Name()
stat, _ := os.Stat(path)
os.Remove(path)
port, _ := unix.NewEventPort()
defer port.Close()
err = port.AssociatePath(path, stat, unix.FILE_MODIFIED, nil)
if err == nil {
t.Errorf("unexpected success associating nonexistant file")
}
err = port.DissociatePath(path)
if err == nil {
t.Errorf("unexpected success dissociating unassociated path")
}
timeout := new(unix.Timespec)
timeout.Nsec = 1
_, err = port.GetOne(timeout)
if err != unix.ETIME {
t.Errorf("unexpected lack of timeout")
}
err = port.DissociateFd(uintptr(0))
if err == nil {
t.Errorf("unexpected success dissociating unassociated fd")
}
events := make([]unix.PortEvent, 4, 4)
_, err = port.Get(events, 5, nil)
if err == nil {
t.Errorf("unexpected success calling Get with min greater than len of slice")
}
_, err = port.Get(nil, 1, nil)
if err == nil {
t.Errorf("unexpected success calling Get with nil slice")
}
_, err = port.Get(nil, 0, nil)
if err == nil {
t.Errorf("unexpected success calling Get with nil slice")
}
}
func ExamplePortEvent() {
type MyCookie struct {
Name string
}
cookie := MyCookie{"Cookie Monster"}
port, err := unix.NewEventPort()
if err != nil {
fmt.Printf("NewEventPort failed: %v\n", err)
return
}
defer port.Close()
r, w, err := os.Pipe()
if err != nil {
fmt.Printf("os.Pipe() failed: %v\n", err)
return
}
defer w.Close()
defer r.Close()
fd := r.Fd()
port.AssociateFd(fd, unix.POLLIN, cookie)
bs := []byte{42}
w.Write(bs)
timeout := new(unix.Timespec)
timeout.Sec = 1
pevent, err := port.GetOne(timeout)
if err != nil {
fmt.Printf("didn't get the expected event: %v\n", err)
}
// Use a type assertion to convert the received cookie back to its original type
c := pevent.Cookie.(MyCookie)
fmt.Printf("%s", c.Name)
//Output: Cookie Monster
}
func TestPortEventSlices(t *testing.T) {
port, err := unix.NewEventPort()
if err != nil {
t.Fatalf("NewEventPort failed: %v", err)
}
// Create, associate, and delete 6 files
for i := 0; i < 6; i++ {
tmpfile, err := ioutil.TempFile("", "eventport")
if err != nil {
t.Fatalf("unable to create tempfile: %v", err)
}
path := tmpfile.Name()
stat, err := os.Stat(path)
if err != nil {
t.Fatalf("unable to stat tempfile: %v", err)
}
err = port.AssociatePath(path, stat, unix.FILE_MODIFIED, nil)
if err != nil {
t.Fatalf("unable to AssociatePath tempfile: %v", err)
}
err = os.Remove(path)
if err != nil {
t.Fatalf("unable to Remove tempfile: %v", err)
}
}
n, err := port.Pending()
if err != nil {
t.Errorf("Pending failed: %v", err)
}
if n != 6 {
t.Errorf("expected 6 pending events, got %d", n)
}
timeout := new(unix.Timespec)
timeout.Nsec = 1
events := make([]unix.PortEvent, 4, 4)
n, err = port.Get(events, 3, timeout)
if err != nil {
t.Errorf("Get failed: %v", err)
}
if n != 4 {
t.Errorf("expected 4 events, got %d", n)
}
e := events[:n]
for _, p := range e {
if p.Events != unix.FILE_DELETE {
t.Errorf("unexpected event. got %v, expected %v", p.Events, unix.FILE_DELETE)
}
}
n, err = port.Get(events, 3, timeout)
if err != unix.ETIME {
t.Errorf("unexpected error. got %v, expected %v", err, unix.ETIME)
}
if n != 2 {
t.Errorf("expected 2 events, got %d", n)
}
e = events[:n]
for _, p := range e {
if p.Events != unix.FILE_DELETE {
t.Errorf("unexpected event. got %v, expected %v", p.Events, unix.FILE_DELETE)
}
}
r, w, err := os.Pipe()
if err != nil {
t.Fatalf("unable to create a pipe: %v", err)
}
port.AssociateFd(r.Fd(), unix.POLLIN, nil)
port.AssociateFd(w.Fd(), unix.POLLOUT, nil)
bs := []byte{41}
w.Write(bs)
n, err = port.Get(events, 1, timeout)
if err != nil {
t.Errorf("Get failed: %v", err)
}
if n != 2 {
t.Errorf("expected 2 events, got %d", n)
}
err = w.Close()
if err != nil {
t.Errorf("w.Close() failed: %v", err)
}
err = r.Close()
if err != nil {
t.Errorf("r.Close() failed: %v", err)
}
err = port.Close()
if err != nil {
t.Errorf("port.Close() failed: %v", err)
}
}