xref: /netbsd/lib/libc/sys/lfs_bmapv.2 (revision 6550d01e)
1.\"	$NetBSD: lfs_bmapv.2,v 1.10 2008/04/30 13:10:51 martin Exp $
2.\"
3.\" Copyright (c) 2000 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Konrad Schroder.
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 NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28.\" POSSIBILITY OF SUCH DAMAGE.
29.\"
30.Dd May 23, 2000
31.Dt LFS_BMAPV 2
32.Os
33.Sh NAME
34.Nm lfs_bmapv
35.Nd retrieve disk addresses for arrays of blocks
36.Sh LIBRARY
37.Lb libc
38.Sh SYNOPSIS
39.In sys/types.h
40.In ufs/lfs/lfs.h
41.Ft int
42.Fn lfs_bmapv "fsid_t *fsidp" "BLOCK_INFO *blkiov" "int blkcnt"
43.Sh DESCRIPTION
44.Fn lfs_bmapv
45fills in the bi_daddr field for every block listed in the block array
46.Fa blkiov
47with the disk address corresponding to the logical block
48.Fa bi_lbn
49of the file with inode
50.Fa bi_inode .
51If
52.Fa bi_lbn
53is LFS_UNUSED_LBN, the disk location of the inode block containing the
54file's inode will be returned in
55.Fa bi_daddr
56instead.
57.Pp
58The
59.Fa fsidp
60argument contains the id of the file system to which the inodes and
61blocks belong.
62The
63.Fa blkiov
64argument is an array of BLOCK_INFO structures (see below).
65The
66.Fa blkcnt
67argument determines the size of the
68.Fa blkiov
69array.
70.Bd -literal
71typedef struct block_info {
72    ino_t       bi_inode;     /* inode # */
73    ufs_daddr_t bi_lbn;       /* logical block w/in file */
74    ufs_daddr_t bi_daddr;     /* disk address of block */
75    time_t      bi_segcreate; /* origin segment create time */
76    int         bi_version;   /* file version number */
77    void       *bi_bp;        /* data buffer */
78    int         bi_size;      /* size of the block (if fragment) */
79} BLOCK_INFO;
80.Ed
81.Sh RETURN VALUES
82.Fn lfs_bmapv
83returns 0 on success, or \-1 on error.
84.Sh ERRORS
85An error return from
86.Fn lfs_bmapv
87indicates:
88.Bl -tag -width Er
89.It Bq Er EFAULT
90.Fa fsidp
91points outside the process's allocated address space.
92.It Bq Er EINVAL
93.Fa *fsidp
94does not specify a valid file system.
95.El
96.Sh SEE ALSO
97.Xr lfs_markv 2 ,
98.Xr lfs_segclean 2 ,
99.Xr lfs_segwait 2 ,
100.Xr lfs_cleanerd 8
101.Sh HISTORY
102The
103.Fn lfs_bmapv
104function call appeared in
105.Bx 4.4 .
106