libufs(3) [freebsd man page]

LIBUFS(3)						   BSD Library Functions Manual 						 LIBUFS(3)

NAME

     libufs -- operate on UFS file systems from userland

LIBRARY

     UFS File System Access Library (libufs, -lufs)

SYNOPSIS

     #include <sys/param.h>
     #include <sys/mount.h>
     #include <ufs/ufs/ufsmount.h>
     #include <ufs/ufs/dinode.h>
     #include <ufs/ffs/fs.h>
     #include <libufs.h>

DESCRIPTION

     The libufs library and the functions it provides are used for implementing utilities which need to access a UFS file system at a low level
     from userland.  Facilities provided are used to implement utilities such as newfs(8) and dumpfs(8).  The libufs library is designed to be
     simple, and to provide functions that are traditionally useful to have.

     A disk is represented as the type struct uufsd as defined in <libufs.h>.  The structure is filled out, operations are performed, and the disk
     is closed.

ERRORS

     Functions provided by libufs return -1 in every functional error situation.  They also set the d_error field of struct uufsd to a string
     describing the error.

SEE ALSO

     bread(3), bwrite(3), cgread(3), cgread1(3), cgwrite1(3), sbread(3), sbwrite(3), ufs_disk_close(3), ufs_disk_fillout(3),
     ufs_disk_fillout_blank(3), ufs_disk_write(3), ffs(7)

HISTORY

     The libufs(3) library first appeared in FreeBSD 5.0.

AUTHORS

     Juli Mallett <jmallett@FreeBSD.org>

     Additional design, feedback, and ideas were provided by Poul-Henning Kamp <phk@FreeBSD.org>.

BSD
								   June 4, 2003 							       BSD

UFS_DISK_CLOSE(3)					   BSD Library Functions Manual 					 UFS_DISK_CLOSE(3)

NAME

     ufs_disk_close, ufs_disk_fillout, ufs_disk_fillout_blank, ufs_disk_write -- open and close userland UFS disks

LIBRARY

     UFS File System Access Library (libufs, -lufs)

SYNOPSIS

     #include <sys/param.h>
     #include <sys/mount.h>
     #include <ufs/ufs/ufsmount.h>
     #include <ufs/ufs/dinode.h>
     #include <ufs/ffs/fs.h>
     #include <libufs.h>

     int
     ufs_disk_close(struct uufsd *disk);

     int
     ufs_disk_fillout(struct uufsd *disk, const char *name);

     int
     ufs_disk_fillout_blank(struct uufsd *disk, const char *name);

     int
     ufs_disk_write(struct uufsd *disk);

DESCRIPTION

     The ufs_disk_close() function closes a disk and frees internal memory related to it.  It does not free the disk structure.

     The ufs_disk_fillout() and ufs_disk_fillout_blank() functions open a disk specified by name and populate the structure pointed to by disk.
     The disk is opened read-only.  The specified name may be either a mountpoint, a device name or a filesystem image.  The ufs_disk_fillout()
     function assumes there is a valid superblock and will fail if not, whereas the ufs_disk_fillout_blank() function makes no assumptions of that
     sort.

     The ufs_disk_write() function attempts to re-open a disk as writable if it is not currently.

ERRORS

     The function ufs_disk_close() has no failure points.

     The function ufs_disk_fillout() may fail for any of the reasons ufs_disk_fillout_blank() might, as well as for any reason sbread(3) might.

     The ufs_disk_fillout_blank() may fail and set errno for any of the errors specified for the library functions open(2), strdup(3).	Addition-
     ally, it may follow the libufs(3) error methodologies in situations where no device could be found to open.

     The function ufs_disk_write() may fail and set errno for any of the errors specified for the library functions open(2) and stat(2).  Namely,
     it will fail if the disk in question may not be written to.

SEE ALSO

     open(2), getfsfile(3), libufs(3), sbread(3)

HISTORY

     These functions first appeared as part of libufs(3) in FreeBSD 5.0.

AUTHORS

     Juli Mallett <jmallett@FreeBSD.org>

BSD
								   June 4, 2003 							       BSD