d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
2b4093d332
freebsd-skq/lib/libufs/bread.3

85 lines
1.9 KiB
Groff
Raw Normal View History

Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.\" Author: Juli Mallett <jmallett@FreeBSD.org>
.\" Date: June 04, 2003
.\" Description:
.\" Manual page for libufs functions:
.\" bread(3)
.\" bwrite(3)
.\"
Left out the critical part of my "public domain" template, a notice saying that this file is (these files are) in the public domain. PR: 53149
2003-06-10 18:24:40 +00:00
.\" This file is in the public domain.
.\"
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.\" $FreeBSD$
.\"
.Dd June 04, 2003
.Dt BREAD 3
.Os
.Sh NAME
.Nm bread , bwrite
.Nd read and write blocks of a UFS filesystem
.Sh LIBRARY
.Lb libufs
.Sh SYNOPSIS
.In sys/types.h
.In sys/param.h
.In sys/mount.h
.In ufs/ufs/ufsmount.h
.In ufs/ufs/dinode.h
.In ufs/ffs/fs.h
.In libufs.h
.Ft ssize_t
.Fn bread "struct uufsd *disk" "ufs2_daddr_t blockno" "void *data" "size_t size"
.Ft ssize_t
.Fn bwrite "struct uufsd *disk" "ufs2_daddr_t blockno" "const void *data" "size_t size"
.Sh DESCRIPTION
The
.Fn bread
and
.Fn bwrite
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
functions provide a block read and write API for
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
.Xr libufs 3
consumers.
They operate on a userland UFS disk structure, and perform the read
and write at a given block address, which uses the current
.Fa d_bsize
value of the structure.
.Pp
The
.Fn bread
and
.Fn bwrite
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
functions return the amount read or written, or -1 in case of any error,
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
including short read.
.Sh ERRORS
The function
.Fn bread
may fail and set
.Va errno
for any of the errors specified for the library functions
Various cleanups of careless mistakes/omissions. PR: 53149 Submitted by: Lukas Ertl <l.ertl@univie.ac.at>
2003-06-10 18:36:16 +00:00
.Xr ufs_disk_write 3
Commit rudimentary libufs manual pages, except for that for getino(3)/putino(3), inode.c has been reworked in Perforce to the point where a manual page may not be accurate. Certainly putino(3) has not even been merged back yet. These will need a lot of improvement for most applications, but they document the API enough to get someone on their feet, most likely. The best documentation still exists in the form of libufs(3) consumers in the base system.
2003-06-09 09:59:11 +00:00
or
.Xr pread 2 .
Additionally, it may follow the
.Xr libufs 3
error methodologies in situations where the amount of data read
is not equal to the amount requested, or in case of device error.
.Pp
The function
.Fn bwrite
may fail and set
.Va errno
for any of the errors specified for the library function
.Xr pwrite 2 .
Additionally, it may follow the
.Xr libufs 3
error methodologies in situations where the amount of data written
is not equal to the amount requested, or in case of a device error.
.Sh SEE ALSO
.Xr libufs 3 ,
.Xr ufs_disk_write 3
.Sh HISTORY
These functions first appeared as part of
.Xr libufs 3
in
.Fx 5.0 .
.Sh AUTHORS
.An Juli Mallett Aq jmallett@FreeBSD.org
Reference in New Issue Copy Permalink