sbin/newfs_hammer/newfs_hammer.8

   1 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
   2 .\"
   3 .\" This code is derived from software contributed to The DragonFly Project
   4 .\" by Matthew Dillon <dillon@backplane.com>
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\"
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in
  14 .\"    the documentation and/or other materials provided with the
  15 .\"    distribution.
  16 .\" 3. Neither the name of The DragonFly Project nor the names of its
  17 .\"    contributors may be used to endorse or promote products derived
  18 .\"    from this software without specific, prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
  24 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  28 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  29 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  30 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  31 .\" SUCH DAMAGE.
  32 .\"
  33 .\" $DragonFly: src/sbin/newfs_hammer/newfs_hammer.8,v 1.10 2008/07/27 16:47:19 thomas Exp $
  34 .Dd July 24, 2008
  35 .Dt NEWFS_HAMMER 8
  36 .Os
  37 .Sh NAME
  38 .Nm newfs_hammer
  39 .Nd construct a new HAMMER file system
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Fl L Ar label
  43 .Op Fl b Ar bootsize
  44 .Op Fl f
  45 .Op Fl m Ar savesize
  46 .Op Fl u Ar undosize
  47 .Op Fl V Ar version
  48 .Ar special ...
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility creates a
  53 .Nm HAMMER
  54 file system on device
  55 .Ar special .
  56 If multiple devices are specified a single
  57 .Nm HAMMER
  58 file system is created
  59 which spans all of them.
  60 Each
  61 .Ar special
  62 will constitute a volume which the
  63 .Nm HAMMER
  64 file system is built on.
  65 .Nm HAMMER
  66 file systems are sector-size agnostic, however the
  67 .Dx
  68 implementation requires the sector size to be no larger than 16K.
  69 .Nm HAMMER
  70 file systems start at a relative offset of 0 and may only be created
  71 under out-of-band disk labels
  72 .Po
  73 .Xr disklabel64 5
  74 or
  75 .Xr gpt 8
  76 labels
  77 .Pc ,
  78 or in
  79 .Xr disklabel 5
  80 partitions which do not overlap the label area (have a starting sector
  81 greater then 16).
  82 .Pp
  83 .Nm HAMMER
  84 filesystems are designed for large storage systems, up to 1 Exabyte, and
  85 will not operate efficiently on small storage systems.
  86 The minimum recommended filesystem size is 50GB.
  87 .Nm HAMMER
  88 must reserve 500MB to 1GB of its storage for reblocking and UNDO.
  89 In addition, HAMMER filesystems operating normally, with full history
  90 retention and daily snapshots, do not immediately reclaim space when
  91 files are deleted.
  92 A regular system maintenance cron job runs once a day to handle reclamation.
  93 .Pp
  94 .Nm HAMMER
  95 works best when the machine's normal workload would not otherwise fill
  96 the filesystem up in the course of 60 days of operation.
  97 .Pp
  98 The options are as follows:
  99 .Bl -tag -width indent
 100 .It Fl L Ar label
 101 All
 102 .Nm HAMMER
 103 file systems must be named and names should be unique on a
 104 per-machine basis.
 105 .It Fl b Ar bootsize
 106 Specify a fixed area in which a boot related kernel and data can be stored.
 107 The
 108 .Ar bootsize
 109 is specified in bytes.
 110 By default a boot area of approximately 4MB will be created.
 111 .It Fl f
 112 Force the creation of a
 113 .Nm HAMMER
 114 file system with less than 100M UNDO FIFO.
 115 This should not be used under normal circumstances.
 116 .It Fl m Ar savesize
 117 Specify a fixed area which
 118 .Nm HAMMER
 119 may use as a memory log.
 120 This area is currently unused.
 121 The
 122 .Ar savesize
 123 is specified in bytes.
 124 .It Fl u Ar undosize
 125 Specify the size of the fixed UNDO FIFO.
 126 The
 127 .Ar undosize
 128 is specified in bytes.
 129 By default 0.1% of the root
 130 volume's size is used, with a reasonable minimum and a reasonable cap.
 131 The UNDO FIFO is used to sequence meta-data out to the media for instant
 132 crash recovery.
 133 .It Fl V Ar version
 134 Specify the HAMMER filesystem version to format.
 135 By default
 136 .Nm
 137 formats the filesystem using the highest production version number
 138 supported by the HAMMER VFS by checking the vfs.hammer.supported_version
 139 sysctl.
 140 If you need to maintain compatibility with an older version of HAMMER
 141 you may specify the version with this option.
 142 .El
 143 .Pp
 144 The
 145 .Ar bootsize ,
 146 .Ar savesize
 147 and
 148 .Ar undosize
 149 can be given with a suffix of
 150 .Cm K , M , G
 151 or
 152 .Cm T
 153 meaning kilo, mega, giga and tera.
 154 Lower case can also be used for suffix.
 155 .Sh EXAMPLES
 156 .Bd -literal -offset indent
 157 newfs_hammer -L Home /dev/ad0s1d
 158 .Ed
 159 .Pp
 160 Create a file system named
 161 .Sq Home
 162 on
 163 .Pa /dev/ad0s1d .
 164 .Sh DIAGNOSTICS
 165 Exit status is 0 on success and 1 on error.
 166 .Sh SEE ALSO
 167 .Xr disklabel 5 ,
 168 .Xr disklabel64 5 ,
 169 .Xr HAMMER 5 ,
 170 .Xr fdisk 8 ,
 171 .Xr gpt 8 ,
 172 .Xr newfs 8
 173 .Sh HISTORY
 174 The
 175 .Nm
 176 utility first appeared in
 177 .Dx 1.11 .
 178 .Sh AUTHORS
 179 .An Matthew Dillon Aq dillon@backplane.com