svn commit: r256124 - head/share/man/man9

[John Baldwin]

Author: jhb
Date: Mon Oct  7 20:30:05 2013
New Revision: 256124
URL: http://svnweb.freebsd.org/changeset/base/256124

Log:
  Add manpages for VOP_ADVISE() and VOP_ALLOCATE().
  
  Approved by:	re (gjb)

Added:
  head/share/man/man9/VOP_ADVISE.9   (contents, props changed)
  head/share/man/man9/VOP_ALLOCATE.9   (contents, props changed)
Modified:
  head/share/man/man9/Makefile
  head/share/man/man9/vnode.9

Modified: head/share/man/man9/Makefile
==============================================================================
--- head/share/man/man9/Makefile	Mon Oct  7 20:29:31 2013	(r256123)
+++ head/share/man/man9/Makefile	Mon Oct  7 20:30:05 2013	(r256124)
@@ -343,7 +343,9 @@ MAN=	accept_filter.9 \
 	vnode.9 \
 	VOP_ACCESS.9 \
 	VOP_ACLCHECK.9 \
+	VOP_ADVISE.9 \
 	VOP_ADVLOCK.9 \
+	VOP_ALLOCATE.9 \
 	VOP_ATTRIB.9 \
 	VOP_BWRITE.9 \
 	VOP_CREATE.9 \

Added: head/share/man/man9/VOP_ADVISE.9
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man9/VOP_ADVISE.9	Mon Oct  7 20:30:05 2013	(r256124)
@@ -0,0 +1,88 @@
+.\" -*- nroff -*-
+.\"
+.\" Copyright (c) 2013 Advanced Computing Technologies LLC
+.\" Written by: John H. Baldwin <jhb at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd October 3, 2013
+.Dt VOP_ADVISE 9
+.Os
+.Sh NAME
+.Nm VOP_ADVISE
+.Nd apply advice about use of file data
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/vnode.h
+.Ft int
+.Fn VOP_ADVISE "struct vnode *vp" "off_t start" "off_t end" "int advice"
+.Sh DESCRIPTION
+This call applies advice for a range of a file's data.
+It is used to implement the
+.Xr posix_fadvise
+system call.
+.Pp
+Its arguments are:
+.Bl -tag -width offset
+.It Fa vp
+The vnode of the file.
+.It Fa start
+The start of the range of file data.
+.It Fa end
+The end of the range of file data.
+.It Fa advice
+The type of operation to apply to the file data.
+Possible values are:
+.Bl -tag -width POSIX_FADV_WILLNEED
+.It Dv POSIX_FADV_WILLNEED
+Initiate an asynchronous read of the file data if it is not already resident.
+.It Dv POSIX_FADV_DONTNEED
+Decrease the in-memory priority of clean file data or discard clean file data.
+.El
+.El
+.Pp
+If the
+.Fa start
+and
+.Fa end
+offsets are both zero,
+then the operation should be applied to the entire file.
+Note that this call is advisory only and may perform the requested
+operation on a subset of the requested range
+.Pq including not performing it at all
+and still return success.
+.Sh LOCKS
+The file should be unlocked on entry.
+.Sh RETURN VALUES
+Zero is returned if the call is successful, otherwise an appropriate
+error code is returned.
+.Sh ERRORS
+.Bl -tag -width Er
+.It Bq Er EINVAL
+An invalid value was given for
+.Fa advice .
+.El
+.Sh SEE ALSO
+.Xr vnode 9

Added: head/share/man/man9/VOP_ALLOCATE.9
==============================================================================
--- /dev/null	00:00:00 1970	(empty, because file is newly added)
+++ head/share/man/man9/VOP_ALLOCATE.9	Mon Oct  7 20:30:05 2013	(r256124)
@@ -0,0 +1,84 @@
+.\" -*- nroff -*-
+.\"
+.\" Copyright (c) 2013 Advanced Computing Technologies LLC
+.\" Written by: John H. Baldwin <jhb at FreeBSD.org>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $FreeBSD$
+.\"
+.Dd October 3, 2013
+.Dt VOP_ALLOCATE 9
+.Os
+.Sh NAME
+.Nm VOP_ALLOCATE
+.Nd allocate storage for a file
+.Sh SYNOPSIS
+.In sys/param.h
+.In sys/vnode.h
+.Ft int
+.Fn VOP_ALLOCATE "struct vnode *vp" "off_t *offset" "off_t *len"
+.Sh DESCRIPTION
+This call allocates storage for a range of offsets in a file.
+It is used to implement the
+.Xr posix_fallocate
+system call.
+.Pp
+Its arguments are:
+.Bl -tag -width offset
+.It Fa vp
+The vnode of the file.
+.It Fa offset
+The start of the range to allocate storage for in the file.
+.It Fa len
+The length of the range to allocate storage for in the file.
+.El
+.Pp
+The
+.Fa offset
+and
+.Fa len
+arguments are updated to reflect the portion of the range that
+still needs to be allocated on return.
+A partial allocation is considered a successful operation.
+The file's contents are not changed.
+.Sh LOCKS
+The file should be exclusively locked on entry and will still be locked on exit.
+.Sh RETURN VALUES
+Zero is returned if the call is successful, otherwise an appropriate
+error code is returned.
+.Sh ERRORS
+.Bl -tag -width Er
+.It Bq Er EFBIG
+An attempt was made to write a file that exceeds the process's file size
+limit or the maximum file size.
+.It Bq Er ENOSPC
+The file system is full.
+.It Bq Er EPERM
+An append-only flag is set on the file, but the caller is attempting to
+write before the current end of file.
+.El
+.Sh SEE ALSO
+.Xr vnode 9 ,
+.Xr VOP_READ 9 ,
+.Xr VOP_WRITE 9

Modified: head/share/man/man9/vnode.9
==============================================================================
--- head/share/man/man9/vnode.9	Mon Oct  7 20:29:31 2013	(r256123)
+++ head/share/man/man9/vnode.9	Mon Oct  7 20:30:05 2013	(r256124)
@@ -163,7 +163,9 @@ intertwining of VM Objects and Vnodes.
 .Xr malloc 9 ,
 .Xr VOP_ACCESS 9 ,
 .Xr VOP_ACLCHECK 9 ,
+.Xr VOP_ADVISE 9 ,
 .Xr VOP_ADVLOCK 9 ,
+.Xr VOP_ALLOCATE 9 ,
 .Xr VOP_ATTRIB 9 ,
 .Xr VOP_BWRITE 9 ,
 .Xr VOP_CREATE 9 ,