Source-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[src/trunk]: src/lib/libc/sys Add man pages for LFS syscalls
details: https://anonhg.NetBSD.org/src/rev/691a8a063190
branches: trunk
changeset: 486533:691a8a063190
user: perseant <perseant%NetBSD.org@localhost>
date: Wed May 24 21:54:59 2000 +0000
description:
Add man pages for LFS syscalls
diffstat:
lib/libc/sys/Makefile.inc | 5 +-
lib/libc/sys/lfs_bmapv.2 | 111 +++++++++++++++++++++++++++++++++++
lib/libc/sys/lfs_markv.2 | 137 ++++++++++++++++++++++++++++++++++++++++++++
lib/libc/sys/lfs_segclean.2 | 83 ++++++++++++++++++++++++++
lib/libc/sys/lfs_segwait.2 | 92 +++++++++++++++++++++++++++++
5 files changed, 426 insertions(+), 2 deletions(-)
diffs (truncated from 458 to 300 lines):
diff -r 549cbd05930b -r 691a8a063190 lib/libc/sys/Makefile.inc
--- a/lib/libc/sys/Makefile.inc Wed May 24 20:27:52 2000 +0000
+++ b/lib/libc/sys/Makefile.inc Wed May 24 21:54:59 2000 +0000
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile.inc,v 1.101 2000/04/21 16:39:23 minoura Exp $
+# $NetBSD: Makefile.inc,v 1.102 2000/05/24 21:54:59 perseant Exp $
# @(#)Makefile.inc 8.3 (Berkeley) 10/24/94
# sys sources
@@ -191,7 +191,8 @@
getitimer.2 getlogin.2 getpeername.2 getpgrp.2 getpid.2 \
getpriority.2 getrlimit.2 getrusage.2 getsid.2 getsockname.2 \
getsockopt.2 gettimeofday.2 getuid.2 intro.2 ioctl.2 issetugid.2 \
- kill.2 ktrace.2 link.2 listen.2 lseek.2 mkdir.2 mkfifo.2 mknod.2 \
+ kill.2 ktrace.2 lfs_bmapv.2 lfs_markv.2 lfs_segclean.2 lfs_segwait.2 \
+ link.2 listen.2 lseek.2 mkdir.2 mkfifo.2 mknod.2 \
madvise.2 mincore.2 minherit.2 mlock.2 mlockall.2 mmap.2 mount.2 \
mprotect.2 msgctl.2 msgget.2 msgrcv.2 msgsnd.2 msync.2 \
munmap.2 nanosleep.2 nfssvc.2 open.2 pathconf.2 pipe.2 \
diff -r 549cbd05930b -r 691a8a063190 lib/libc/sys/lfs_bmapv.2
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/lfs_bmapv.2 Wed May 24 21:54:59 2000 +0000
@@ -0,0 +1,111 @@
+.\" $NetBSD: lfs_bmapv.2,v 1.1 2000/05/24 21:54:59 perseant 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_BMAPV 2
+.Os
+.Sh NAME
+.Nm lfs_bmapv
+.Nd retrieve disk addresses for arrays of blocks
+.Sh LIBRARY
+.Lb libc
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <ufs/lfs/lfs.h>
+.Ft int
+.Fn lfs_bmapv "fsid_t *fsidp" "BLOCK_INFO *blkiov" "int blkcnt"
+.Sh DESCRIPTION
+.Fn lfs_bmapv
+fills in the bi_daddr field for every block listed in the block array
+.Fa blkiov
+with the disk address corrseponding to the logical block
+.Fa bi_lbn
+of the file with inode
+.Fa bi_inode.
+If
+.Fa bi_lbn
+is LFS_UNUSED_LBN, the disk location of the inode block containing the
+file's inode will be returned in
+.Fa bi_daddr
+instead.
+.Pp
+The
+.Fa fsidp
+argument contains the id of the filesystem to which the inodes and
+blocks belong.
+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_bmapv
+returns 0 on success, or -1 on error.
+.Sh ERRORS
+An error return from
+.Fn lfs_bmapv
+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.
+.El
+.Sh SEE ALSO
+.Xr lfs_cleanerd 8 ,
+.Xr lfs_markv 2 ,
+.Xr lfs_segclean 2 ,
+.Xr lfs_segwait 2
+.Sh HISTORY
+The
+.Fn lfs_bmapv
+function call appeared in
+.Bx 4.4 .
diff -r 549cbd05930b -r 691a8a063190 lib/libc/sys/lfs_markv.2
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/lfs_markv.2 Wed May 24 21:54:59 2000 +0000
@@ -0,0 +1,137 @@
+.\" $NetBSD: lfs_markv.2,v 1.1 2000/05/24 21:54:59 perseant 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 <sys/types.h>
+.Fd #include <ufs/lfs/lfs.h>
+.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_cleanerd 8 ,
+.Xr lfs_markv 2 ,
+.Xr lfs_segclean 2 ,
+.Xr lfs_segwait 2
+.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
+).
+.Sh HISTORY
+The
+.Fn lfs_bmapv
+function call appeared in
+.Bx 4.4 .
diff -r 549cbd05930b -r 691a8a063190 lib/libc/sys/lfs_segclean.2
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/libc/sys/lfs_segclean.2 Wed May 24 21:54:59 2000 +0000
@@ -0,0 +1,83 @@
+.\" $NetBSD: lfs_segclean.2,v 1.1 2000/05/24 21:55:00 perseant 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
Home |
Main Index |
Thread Index |
Old Index