137 lines
4.4 KiB
Groff
137 lines
4.4 KiB
Groff
.\" $NetBSD: lfs_markv.2,v 1.7 2002/10/01 18:10:44 wiz Exp $
|
|
.\"
|
|
.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" This code is derived from software contributed to The NetBSD Foundation
|
|
.\" by Konrad Schroder.
|
|
.\"
|
|
.\" 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.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgement:
|
|
.\" This product includes software developed by the NetBSD
|
|
.\" Foundation, Inc. and its contributors.
|
|
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
|
|
.\" contributors may be used to endorse or promote products derived
|
|
.\" from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. 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 FOUNDATION 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.
|
|
.\"
|
|
.Dd May 23, 2000
|
|
.Dt LFS_MARKV 2
|
|
.Os
|
|
.Sh NAME
|
|
.Nm lfs_markv
|
|
.Nd rewrite disk blocks to new disk locations
|
|
.Sh LIBRARY
|
|
.Lb libc
|
|
.Sh SYNOPSIS
|
|
.Fd #include \*[Lt]sys/types.h\*[Gt]
|
|
.Fd #include \*[Lt]ufs/lfs/lfs.h\*[Gt]
|
|
.Ft int
|
|
.Fn lfs_markv "fsid_t *fsidp" "BLOCK_INFO *blkiov" "int blkcnt"
|
|
.Sh DESCRIPTION
|
|
.Fn lfs_markv
|
|
rewrites the blocks specified in
|
|
.Fa blkiov
|
|
to new disk locations, for the purposes of grouping them next to one
|
|
another, or to move them out of a segment to clean it.
|
|
All fields of the BLOCK_INFO structure must be filled in, except for
|
|
.Fa bi_segcreate .
|
|
If
|
|
.Fa bi_daddr
|
|
is not the correct current address for logical block
|
|
.Fa bi_lbn
|
|
of the file with inode number
|
|
.Fa bi_inode ,
|
|
or if the file's version number does not match
|
|
.Fa bi_version ,
|
|
the block will not be written to disk, but no error will be returned.
|
|
.Pp
|
|
The
|
|
.Fa fsidp
|
|
argument contains the id of the filesystem to which the inodes and
|
|
blocks belong.
|
|
The
|
|
.Fa bi_bp
|
|
field contains
|
|
.Fa bi_size
|
|
bytes of data to be written into the appropriate block.
|
|
If
|
|
.Fa bi_lbn
|
|
is specified as LFS_UNUSED_LBN, the inode itself will be rewritten.
|
|
.Pp
|
|
The
|
|
.Fa blkiov
|
|
argument is an array of BLOCK_INFO structures (see below).
|
|
The
|
|
.Fa blkcnt
|
|
argument determines the size of the
|
|
.Fa blkiov
|
|
array.
|
|
.Bd -literal
|
|
typedef struct block_info {
|
|
ino_t bi_inode; /* inode # */
|
|
ufs_daddr_t bi_lbn; /* logical block w/in file */
|
|
ufs_daddr_t bi_daddr; /* disk address of block */
|
|
time_t bi_segcreate; /* origin segment create time */
|
|
int bi_version; /* file version number */
|
|
void *bi_bp; /* data buffer */
|
|
int bi_size; /* size of the block (if fragment) */
|
|
} BLOCK_INFO;
|
|
.Ed
|
|
.Sh RETURN VALUES
|
|
.Fn lfs_markv
|
|
returns 0 on success, or -1 on error.
|
|
.Sh ERRORS
|
|
An error return from
|
|
.Fn lfs_markv
|
|
indicates:
|
|
.Bl -tag -width Er
|
|
.It Bq Er EFAULT
|
|
.Fa fsidp
|
|
points outside the process's allocated address space.
|
|
.It Bq Er EINVAL
|
|
.Fa *fsidp
|
|
does not specify a valid filesystem.
|
|
.It Bq Er EBUSY
|
|
One or more of the inodes whose blocks were to be written was locked,
|
|
and its blocks were not rewritten.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr lfs_segclean 2 ,
|
|
.Xr lfs_segwait 2 ,
|
|
.Xr lfs_cleanerd 8
|
|
.Sh HISTORY
|
|
The
|
|
.Fn lfs_markv
|
|
function call appeared in
|
|
.Bx 4.4 .
|
|
.Sh BUGS
|
|
The functionality of
|
|
.Fn lfs_markv
|
|
does not really belong in user space.
|
|
Among other things it could be used to work around the
|
|
SF_IMMUTABLE
|
|
and
|
|
SF_APPEND
|
|
file flags (see
|
|
.Xr chflags 2 ) .
|