1.\" 2.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3.\" 4.\" Copyright (c) 2021 The FreeBSD Foundation 5.\" 6.\" This manual page was written by Ka Ho Ng under sponsorship from 7.\" the FreeBSD Foundation. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 19.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 22.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 23.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 24.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 25.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 26.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 27.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 28.\" SUCH DAMAGE. 29.\" 30.Dd May 11, 2021 31.Dt VOP_DEALLOCATE 9 32.Os 33.Sh NAME 34.Nm VOP_DEALLOCATE 35.Nd zero and/or deallocate storage from a file 36.Sh SYNOPSIS 37.In sys/param.h 38.In sys/vnode.h 39.Ft int 40.Fo VOP_DEALLOCATE 41.Fa "struct vnode *vp" 42.Fa "off_t *offset" 43.Fa "off_t *len" 44.Fa "int flags" 45.Fa "struct ucred *cred" 46.Fc 47.Sh DESCRIPTION 48This VOP call zeroes/deallocates storage for an offset range in a file. 49It is used to implement the 50.Xr fspacectl 2 51system call. 52.Pp 53Its arguments are: 54.Bl -tag -width offset 55.It Fa vp 56The vnode of the file. 57.It Fa offset 58The start of the range to deallocate storage in the file. 59.It Fa len 60The length of the range to deallocate storage in the file. 61.It Fa flags 62The flags of this call. 63This should be set to 0 for now. 64.It Fa cred 65The credentials of the caller. 66.El 67.Pp 68.Fa *offset 69and 70.Fa *len 71are updated to reflect the portion of the range that 72still needs to be zeroed/deallocated on return. 73Partial result is considered a successful operation. 74.Sh LOCKS 75The vnode should be locked on entry and will still be locked on exit. 76.Sh RETURN VALUES 77Zero is returned if the call is successful, otherwise an appropriate 78error code is returned. 79.Sh ERRORS 80.Bl -tag -width Er 81.It Bq Er EINVAL 82Invalid 83.Fa offset , len 84or 85.Fa flags 86parameters are passed into this VOP call. 87.It Bq Er ENODEV 88The vnode type is not supported by this VOP call. 89.It Bq Er ENOSPC 90The file system is full. 91.It Bq Er EPERM 92An append-only flag is set on the file, but the caller is attempting to 93zero before the current end of file. 94.El 95.Sh SEE ALSO 96.Xr vnode 9 97.Sh AUTHORS 98.Nm 99and this manual page was written by 100.An Ka Ho Ng Aq Mt khng@FreeBSD.org 101under sponsorship from the FreeBSD Foundation. 102