libutil-47.30.1.tar.gz

[apple/libutil.git] / wipefs.3

.\"\r
.\" Copyright (c) 2008,2011 Apple Inc. All rights reserved.\r
.\"\r
.\" @APPLE_LICENSE_HEADER_START@\r
.\" \r
.\" This file contains Original Code and/or Modifications of Original Code\r
.\" as defined in and that are subject to the Apple Public Source License\r
.\" Version 2.0 (the 'License'). You may not use this file except in\r
.\" compliance with the License. Please obtain a copy of the License at\r
.\" http://www.opensource.apple.com/apsl/ and read it before using this\r
.\" file.\r
.\" \r
.\" The Original Code and all software distributed under the License are\r
.\" distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER\r
.\" EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,\r
.\" INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,\r
.\" FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.\r
.\" Please see the License for the specific language governing rights and\r
.\" limitations under the License.\r
.\" \r
.\" @APPLE_LICENSE_HEADER_END@\r
.\"\r
.Dd 6/30/11               \" DATE \r
.Dt libutil 3      \" Program name and manual section number \r
.Os Mac OS X\r
.Sh NAME                 \" Section Header - required - don't modify \r
.\" The following lines are read in generating the apropos(man -k) database. Use only key\r
.\" words here as the database is built based on the words here and in the .ND line. \r
.Nm wipefs_alloc ,\r
.Nm wipefs_except_blocks ,\r
.Nm wipefs_wipe ,\r
.Nm wipefs_free\r
.\" Use .Nm macro to designate other names for the documented program.\r
.Nd wipes existing file systems on a volume\r
.Sh LIBRARY             \" Section Header - required - don't modify\r
.Lb libutil\r
.Sh SYNOPSIS\r
.In wipefs.h\r
.Ft int\r
.Fo wipefs_alloc\r
.Fa "int fd"\r
.Fa "size_t block_size"\r
.Fa "wipefs_ctx *handle"\r
.Fc\r
.Ft int\r
.Fo wipefs_include_blocks\r
.Fa "wipefs_ctx handle"\r
.Fa "off_t block_offset"\r
.Fa "off_t nblocks"\r
.Fc\r
.Ft int\r
.Fo wipefs_except_blocks\r
.Fa "wipefs_ctx handle"\r
.Fa "off_t block_offset"\r
.Fa "off_t nblocks"\r
.Fc\r
.Ft int\r
.Fo wipefs_wipe\r
.Fa "wipefs_ctx handle"\r
.Fc\r
.Ft void\r
.Fo wipefs_free\r
.Fa "wipefs_ctx *handle"\r
.Fc\r
.Sh DESCRIPTION          \" Section Header - required - don't modify\r
The wipefs family of functions wipe existing file systems on a volume.  A\r
.Li DKIOCUNMAP\r
ioctl is sent to the device to invalidate all of its content.\r
Then zeroes are written to various locations that are used by various file systems to recognize their content and mount their volumes.\r
This is usually used by the newfs_* utilities before they create new file systems on the volume, so that the existing file system will not be mounted accidentally after the new file system is created.\r
.Pp\r
.Sy NOTE:\r
These routines do not overwrite all volume structures.\r
These routines do not securely erase the previous content.\r
They only overwrite enough to make sure that the normal utilities will no longer recognize any file system content.\r
It is possible that previous file system content could be recovered by other means.\r
.Pp\r
The\r
.Fn wipefs_alloc\r
function initializes a\r
.Fa wipefs_ctx\r
object (which is an opaque data type).\r
.Fa file_desc\r
is the file handle of the volume to be wiped, which can be a block device node, a character device node, or a file.\r
.Fa file_desc\r
must be opened with write access.  If\r
.Fa block_size\r
is 0, this function calls\r
.Xr ioctl 2\r
to get the block size.  A valid\r
.Fa block_size \r
must be supplied if \r
.Fa file_desc\r
is a regular file.  This function does not write any data to the volume.\r
.Pp\r
The\r
.Fn wipefs_include_blocks\r
function tells wipefs to write zeroes in the block range provided, in addition to any other ranges\r
it would normally write.  This may be more efficient than if the caller were to write this range\r
separately, especially if the block range overlaps or is contiguous with other ranges that wipefs\r
will write.  This function does not write any data to the volume.  If this function is called\r
multiple times, the union of all the ranges provided will be written by\r
.Fn wipefs_wipe .\r
.Pp\r
The\r
.Fn wipefs_except_blocks\r
function tells wipefs not to write anything in the block range provided.  This function is used for performance\r
optimizations if the caller will write to these blocks.  It is the caller's responsibility to write to these blocks.\r
Otherwise, some file systems may still be recognized on the volume.  This function does not write any data to the\r
volume.  If this function is called multiple times, the union of all the ranges provided will be excluded from being\r
written by\r
.Fn wipefs_wipe .\r
.Pp\r
The\r
.Fn wipefs_wipe\r
function sends a\r
.Li DKIOCUNMAP\r
ioctl and then writes data to the volume to wipe out existing file systems on it.\r
.Sy CAUTION:\r
this function destroys any file system or partition scheme on the volume represented by\r
.Fa file_desc .\r
If\r
.Fa file_desc\r
represents the entire disk (e.g. /dev/diskX), the partition map of the disk will be destroyed.  If\r
.Fa file_desc\r
represents a partition (e.g., /dev/diskXsY), only the file system in that partition is destroyed.  Although the partition scheme or file system on\r
.Fa file_desc\r
may be beyond repair after \r
.Fn wipefs_wipe ,\r
this function is not designed as a means to safely delete all data.  It is possible that some user data (or intact file systems in some partitions) may still be recovered.\r
.Pp\r
The\r
.Fn wipefs_free\r
function frees the allocated \r
.Fa wipefs_ctx\r
handle and set\r
.Fa *handlep\r
to NULL.\r
.Sh RETURN VALUES\r
The\r
.Fn wipefs_alloc ,\r
.Fn wipefs_include_blocks ,\r
.Fn wipefs_except_blocks\r
and\r
.Fn wipefs_wipe\r
functions return 0 on success, or will fail and return an error code.\r
Each function may return\r
.Fa ENOMEM\r
if insufficient memory is available.  In addition, if\r
.Fa block_size\r
is not provided,\r
.Fn wipefs_alloc\r
may return any error\r
.Xr ioctl 2\r
returns;\r
.Fn wipefs_wipe\r
may return any error\r
.Xr pwrite 2\r
returns.\r
.\" .Sh BUGS              \" Document known, unremedied bugs \r
.\".Sh HISTORY           \" Document history if command behaves in a unique manner \r
.\"The wipefs family of functions first appeared in Mac OS X Leopard (10.5.3).\r