summaryrefslogtreecommitdiffstats
path: root/share/man/man9/VOP_OPENCLOSE.9
diff options
context:
space:
mode:
authorhmp <hmp@FreeBSD.org>2004-05-10 23:17:09 +0000
committerhmp <hmp@FreeBSD.org>2004-05-10 23:17:09 +0000
commitdd055540b921006f06cefe6d7320b0efb80d2180 (patch)
tree486680826c8c8464a873f5230fc8992fb2139390 /share/man/man9/VOP_OPENCLOSE.9
parent8169074470d5187cbb51f49363327e4ab4025faf (diff)
downloadFreeBSD-src-dd055540b921006f06cefe6d7320b0efb80d2180.zip
FreeBSD-src-dd055540b921006f06cefe6d7320b0efb80d2180.tar.gz
Document the 'fdidx' argument of VOP_OPEN(9).
PR: 56911 Noticed by: Jun Su <junsu@m-net.arbornet.org>
Diffstat (limited to 'share/man/man9/VOP_OPENCLOSE.9')
-rw-r--r--share/man/man9/VOP_OPENCLOSE.917
1 files changed, 16 insertions, 1 deletions
diff --git a/share/man/man9/VOP_OPENCLOSE.9 b/share/man/man9/VOP_OPENCLOSE.9
index 4a6ae2c..fc02c77 100644
--- a/share/man/man9/VOP_OPENCLOSE.9
+++ b/share/man/man9/VOP_OPENCLOSE.9
@@ -39,7 +39,7 @@
.In sys/param.h
.In sys/vnode.h
.Ft int
-.Fn VOP_OPEN "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td"
+.Fn VOP_OPEN "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td" "int fdidx"
.Ft int
.Fn VOP_CLOSE "struct vnode *vp" "int mode" "struct ucred *cred" "struct thread *td"
.Sh DESCRIPTION
@@ -59,6 +59,13 @@ the access mode required by the calling process
the thread which is accessing the file
.El
.Pp
+Additionally,
+.Fn VOP_OPEN
+can accept a file descriptor number in
+.Fa fdidx ;
+this is useful for file systems which require such information, e.g.
+.Xr fdesc 5 .
+.Pp
The access mode is a set of flags, including
.Dv FREAD ,
.Dv FWRITE ,
@@ -78,6 +85,14 @@ Note that
.Fa vn_close
expects an unlocked, referenced vnode and will dereference the vnode prior
to returning.
+.Sh IMPLEMENTATION NOTES
+The
+.Fa fdidx
+argument to
+.Fn VOP_OPEN
+is currently unused, use
+.Ql \-1
+for the meantime; however, this will change in future.
.Sh RETURN VALUES
Zero is returned on success, otherwise an error code is returned.
.Sh PSEUDOCODE
OpenPOWER on IntegriCloud