mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-02-14 23:33:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4825 from cheatfate/ioselectors_vnode

Browse Source 
EVFILT_VNODE events support for ioselectors
This commit is contained in:
Dominik Picheta
2016-09-24 10:45:29 +02:00
committed by GitHub
parent ffb812521d f40c1d3ad1
commit e7e72d9f38
3 changed files with 281 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
lib/pure/ioselectors.nim
View File

@@ -44,14 +44,21 @@ when defined(nimdoc):
Event* {.pure.} = enum
## An enum which hold event types
Read, ## Descriptor is available for read
Write, ## Descriptor is available for write
Timer, ## Timer descriptor is completed
Signal, ## Signal is raised
Process, ## Process is finished
Vnode, ## Currently not supported
User, ## User event is raised
Error ## Error happens while waiting, for descriptor
Read, ## Descriptor is available for read
Write, ## Descriptor is available for write
Timer, ## Timer descriptor is completed
Signal, ## Signal is raised
Process, ## Process is finished
Vnode, ## BSD specific file change happens
User, ## User event is raised
Error, ## Error happens while waiting, for descriptor
VnodeWrite, ## NOTE_WRITE (BSD specific, write to file occured)
VnodeDelete, ## NOTE_DELETE (BSD specific, unlink of file occured)
VnodeExtend, ## NOTE_EXTEND (BSD specific, file extended)
VnodeAttrib, ## NOTE_ATTRIB (BSD specific, file attributes changed)
VnodeLink, ## NOTE_LINK (BSD specific, file link count changed)
VnodeRename, ## NOTE_RENAME (BSD specific, file renamed)
VnodeRevoke ## NOTE_REVOKE (BSD specific, file revoke occured)
ReadyKey*[T] = object
## An object which holds result for descriptor
@@ -107,6 +114,15 @@ when defined(nimdoc):
## ``data`` application-defined data, which to be passed, when
## ``ev`` happens.
proc registerVnode*[T](s: Selector[T], fd: cint, events: set[Event],
data: T) =
## Registers selector BSD/MacOSX specific vnode events for file
## descriptor ``fd`` and events ``events``.
## ``data`` application-defined data, which to be passed, when
## vnode event happens.
##
## This function is supported only by BSD and MacOSX.
proc newSelectEvent*(): SelectEvent =
## Creates new event ``SelectEvent``.
@@ -194,7 +210,9 @@ else:
deallocShared(cast[pointer](sa))
type
Event* {.pure.} = enum
Read, Write, Timer, Signal, Process, Vnode, User, Error, Oneshot
Read, Write, Timer, Signal, Process, Vnode, User, Error, Oneshot,
VnodeWrite, VnodeDelete, VnodeExtend, VnodeAttrib, VnodeLink,
VnodeRename, VnodeRevoke
ReadyKey*[T] = object
fd* : int

41
lib/pure/ioselects/ioselectors_kqueue.nim
View File

@@ -262,6 +262,30 @@ proc registerEvent*[T](s: Selector[T], ev: SelectEvent, data: T) =
modifyKQueue(s, fdi.uint, EVFILT_READ, EV_ADD, 0, 0, nil)
inc(s.count)
template processVnodeEvents(events: set[Event]): cuint =
var rfflags = 0.cuint
if events == {Event.VnodeWrite, Event.VnodeDelete, Event.VnodeExtend,
Event.VnodeAttrib, Event.VnodeLink, Event.VnodeRename,
Event.VnodeRevoke}:
rfflags = NOTE_DELETE or NOTE_WRITE or NOTE_EXTEND or NOTE_ATTRIB or
NOTE_LINK or NOTE_RENAME or NOTE_REVOKE
else:
if Event.VnodeDelete in events: rfflags = rfflags or NOTE_DELETE
if Event.VnodeWrite in events: rfflags = rfflags or NOTE_WRITE
if Event.VnodeExtend in events: rfflags = rfflags or NOTE_EXTEND
if Event.VnodeAttrib in events: rfflags = rfflags or NOTE_ATTRIB
if Event.VnodeLink in events: rfflags = rfflags or NOTE_LINK
if Event.VnodeRename in events: rfflags = rfflags or NOTE_RENAME
if Event.VnodeRevoke in events: rfflags = rfflags or NOTE_REVOKE
rfflags
proc registerVnode*[T](s: Selector[T], fd: cint, events: set[Event], data: T) =
let fdi = fd.int
setKey(s, fdi, fdi, {Event.Vnode} + events, 0, data)
var fflags = processVnodeEvents(events)
modifyKQueue(s, fdi.uint, EVFILT_VNODE, EV_ADD or EV_CLEAR, fflags, 0, nil)
inc(s.count)
proc unregister*[T](s: Selector[T], fd: int|SocketHandle) =
let fdi = int(fd)
s.checkFd(fdi)
@@ -295,6 +319,9 @@ proc unregister*[T](s: Selector[T], fd: int|SocketHandle) =
discard posix.close(cint(pkey.key.fd))
modifyKQueue(s, fdi.uint, EVFILT_PROC, EV_DELETE, 0, 0, nil)
dec(s.count)
elif Event.Vnode in pkey.events:
modifyKQueue(s, fdi.uint, EVFILT_VNODE, EV_DELETE, 0, 0, nil)
dec(s.count)
elif Event.User in pkey.events:
modifyKQueue(s, fdi.uint, EVFILT_READ, EV_DELETE, 0, 0, nil)
dec(s.count)
@@ -392,6 +419,20 @@ proc selectInto*[T](s: Selector[T], timeout: int,
of EVFILT_VNODE:
pkey = addr(s.fds[kevent.ident.int])
pkey.key.events = {Event.Vnode}
if (kevent.fflags and NOTE_DELETE) != 0:
pkey.key.events.incl(Event.VnodeDelete)
if (kevent.fflags and NOTE_WRITE) != 0:
pkey.key.events.incl(Event.VnodeWrite)
if (kevent.fflags and NOTE_EXTEND) != 0:
pkey.key.events.incl(Event.VnodeExtend)
if (kevent.fflags and NOTE_ATTRIB) != 0:
pkey.key.events.incl(Event.VnodeAttrib)
if (kevent.fflags and NOTE_LINK) != 0:
pkey.key.events.incl(Event.VnodeLink)
if (kevent.fflags and NOTE_RENAME) != 0:
pkey.key.events.incl(Event.VnodeRename)
if (kevent.fflags and NOTE_REVOKE) != 0:
pkey.key.events.incl(Event.VnodeRevoke)
of EVFILT_SIGNAL:
pkey = addr(s.fds[cast[int](kevent.udata)])
pkey.key.events = {Event.Signal}

213
tests/async/tioselectors.nim
View File

@@ -217,6 +217,216 @@ when not defined(windows):
assert(selector.isEmpty())
result = true
when defined(macosx) or defined(freebsd) or defined(openbsd) or
defined(netbsd):
proc rename(frompath: cstring, topath: cstring): cint
{.importc: "rename", header: "<stdio.h>".}
proc createFile(name: string): cint =
result = posix.open(cstring(name), posix.O_CREAT or posix.O_RDWR)
if result == -1:
raiseOsError(osLastError())
proc writeFile(name: string, data: string) =
let fd = posix.open(cstring(name), posix.O_APPEND or posix.O_RDWR)
if fd == -1:
raiseOsError(osLastError())
let length = len(data).cint
if posix.write(fd, cast[pointer](unsafeAddr data[0]),
len(data).cint) != length:
raiseOsError(osLastError())
if posix.close(fd) == -1:
raiseOsError(osLastError())
proc closeFile(fd: cint) =
if posix.close(fd) == -1:
raiseOsError(osLastError())
proc removeFile(name: string) =
let err = posix.unlink(cstring(name))
if err == -1:
raiseOsError(osLastError())
proc createDir(name: string) =
let err = posix.mkdir(cstring(name), 0x1FF)
if err == -1:
raiseOsError(osLastError())
proc removeDir(name: string) =
let err = posix.rmdir(cstring(name))
if err == -1:
raiseOsError(osLastError())
proc chmodPath(name: string, mode: cint) =
let err = posix.chmod(cstring(name), Mode(mode))
if err == -1:
raiseOsError(osLastError())
proc renameFile(names: string, named: string) =
let err = rename(cstring(names), cstring(named))
if err == -1:
raiseOsError(osLastError())
proc symlink(names: string, named: string) =
let err = posix.symlink(cstring(names), cstring(named))
if err == -1:
raiseOsError(osLastError())
proc openWatch(name: string): cint =
result = posix.open(cstring(name), posix.O_RDONLY)
if result == -1:
raiseOsError(osLastError())
const
testDirectory = "/tmp/kqtest"
type
valType = object
fd: cint
events: set[Event]
proc vnode_test(): bool =
proc validate[T](test: openarray[ReadyKey[T]],
check: openarray[valType]): bool =
result = false
if len(test) == len(check):
for checkItem in check:
result = false
for testItem in test:
if testItem.fd == checkItem.fd and
checkItem.events <= testItem.events:
result = true
break
if not result:
break
var res: seq[ReadyKey[int]]
var selector = newSelector[int]()
var events = {Event.VnodeWrite, Event.VnodeDelete, Event.VnodeExtend,
Event.VnodeAttrib, Event.VnodeLink, Event.VnodeRename,
Event.VnodeRevoke}
result = true
discard posix.unlink(testDirectory)
createDir(testDirectory)
var dirfd = posix.open(cstring(testDirectory), posix.O_RDONLY)
if dirfd == -1:
raiseOsError(osLastError())
selector.registerVnode(dirfd, events, 1)
selector.flush()
# chmod testDirectory to 0777
chmodPath(testDirectory, 0x1FF)
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == dirfd and
{Event.Vnode, Event.VnodeAttrib} <= res[0].events)
# create subdirectory
createDir(testDirectory & "/test")
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == dirfd and
{Event.Vnode, Event.VnodeWrite,
Event.VnodeLink} <= res[0].events)
# open test directory for watching
var testfd = openWatch(testDirectory & "/test")
selector.registerVnode(testfd, events, 2)
selector.flush()
doAssert(len(selector.select(0)) == 0)
# rename test directory
renameFile(testDirectory & "/test", testDirectory & "/renamed")
res = selector.select(0)
doAssert(len(res) == 2)
doAssert(len(selector.select(0)) == 0)
doAssert(validate(res,
[valType(fd: dirfd, events: {Event.Vnode, Event.VnodeWrite}),
valType(fd: testfd,
events: {Event.Vnode, Event.VnodeRename})])
)
# remove test directory
removeDir(testDirectory & "/renamed")
res = selector.select(0)
doAssert(len(res) == 2)
doAssert(len(selector.select(0)) == 0)
doAssert(validate(res,
[valType(fd: dirfd, events: {Event.Vnode, Event.VnodeWrite,
Event.VnodeLink}),
valType(fd: testfd,
events: {Event.Vnode, Event.VnodeDelete})])
)
# create file new test file
testfd = createFile(testDirectory & "/testfile")
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == dirfd and
{Event.Vnode, Event.VnodeWrite} <= res[0].events)
# close new test file
closeFile(testfd)
doAssert(len(selector.select(0)) == 0)
doAssert(len(selector.select(0)) == 0)
# chmod test file with 0666
chmodPath(testDirectory & "/testfile", 0x1B6)
doAssert(len(selector.select(0)) == 0)
testfd = openWatch(testDirectory & "/testfile")
selector.registerVnode(testfd, events, 1)
selector.flush()
# write data to test file
writeFile(testDirectory & "/testfile", "TESTDATA")
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == testfd and
{Event.Vnode, Event.VnodeWrite,
Event.VnodeExtend} <= res[0].events)
# symlink test file
symlink(testDirectory & "/testfile", testDirectory & "/testlink")
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == dirfd and
{Event.Vnode, Event.VnodeWrite} <= res[0].events)
# remove test file
removeFile(testDirectory & "/testfile")
res = selector.select(0)
doAssert(len(res) == 2)
doAssert(len(selector.select(0)) == 0)
doAssert(validate(res,
[valType(fd: testfd, events: {Event.Vnode, Event.VnodeDelete}),
valType(fd: dirfd, events: {Event.Vnode, Event.VnodeWrite})])
)
# remove symlink
removeFile(testDirectory & "/testlink")
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == dirfd and
{Event.Vnode, Event.VnodeWrite} <= res[0].events)
# remove testDirectory
removeDir(testDirectory)
res = selector.select(0)
doAssert(len(res) == 1)
doAssert(len(selector.select(0)) == 0)
doAssert(res[0].fd == dirfd and
{Event.Vnode, Event.VnodeDelete} <= res[0].events)
when hasThreadSupport:
var counter = 0
@@ -256,6 +466,9 @@ when not defined(windows):
processTest("Timer notification test...", timer_notification_test())
processTest("Process notification test...", process_notification_test())
processTest("Signal notification test...", signal_notification_test())
when defined(macosx) or defined(freebsd) or defined(openbsd) or
defined(netbsd):
processTest("File notification test...", vnode_test())
echo("All tests passed!")
else:
import nativesockets, winlean, os, osproc