sbin/hammer/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/hammer/hammer.8,v 1.16 2008/05/13 20:49:34 dillon Exp $
  34 .Dd December 31, 2007
  35 .Dt HAMMER 8
  36 .Os
  37 .Sh NAME
  38 .Nm hammer
  39 .Nd HAMMER file system utility
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl hrx
  43 .Op Fl c Ar cyclefile
  44 .Op Fl f Ar blkdev[:blkdev]*
  45 .Op Fl s Ar linkpath
  46 .Op Fl t Ar timeout
  47 .Ar command
  48 .Ar ...
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 utility provides miscellaneous functions related to managing a HAMMER
  53 filesystem.
  54 .Pp
  55 The options are as follows:
  56 .Bl -tag -width indent
  57 .It Fl h
  58 Get help
  59 .It Fl r
  60 Specify recursion for those commands which support it.
  61 .It Fl c Ar cyclefile
  62 When pruning and reblocking you can instruction HAMMER to start at the
  63 object id stored in the specified file.  If the file does not exist
  64 HAMMER will start at the beginning.  If HAMMER is told to run for a
  65 specific period of time and is unable to complete the operation it will
  66 write out the current obj_id so the next run can pick up where it left
  67 off.  If HAMMER runs to completion it will delete the cyclefile..
  68 .It Fl f Ar blkdev[:blkdev]*
  69 Specify the volumes making up a HAMMER filesystem.
  70 .It Fl s Ar linkpath
  71 When pruning a filesystem you can instruct HAMMER to create softlinks
  72 to available snapshots.
  73 .It Fl t Ar timeout
  74 When pruning and reblocking you can tell the utility to stop after a
  75 certain period of time.  This option is used along with the cycle file
  76 option to prune or reblock a portion of the filesystem incrementally.
  77 .It Fl v
  78 Increase verboseness.  May be specified multiple times.
  79 .El
  80 .Pp
  81 The commands are as follows:
  82 .Bl -tag -width indent
  83 .It Ar now
  84 Generate a timestamp suitable for use in the @@ filename extension,
  85 representing right now.
  86 .It Ar now64
  87 Generate a full 64 bit timestamp.
  88 The
  89 .Ar now
  90 and
  91 .Ar now64
  92 directives do not generate a guaranteed transaction id.
  93 Please use the
  94 .Nm Ar synctid
  95 command to generate a guaranteed transaction id.
  96 .It Ar stamp
  97 Generate a timestamp suitable for use in the @@ filename extension.
  98 This command does not sync() or sleep and care should be taken if
  99 generating timestamps for data which may not yet be synced to disk.
 100 A time specification of
 101 .Pf yyyymmdd Oo :hhmmss Oc Ns Op .fractional
 102 specifies an exact as-of timestamp in local (not UTC) time.
 103 Set the TZ environment variable prior to running
 104 .Nm
 105 if you wish to specify the time by some other means.
 106 .It Ar stamp64
 107 Same as the
 108 .Ar stamp
 109 command but generates a 64 bit timestamp.
 110 .It Ar synctid Ar filesystem Op quick
 111 Generates a guaranteed, formal 64 bit transaction id representing the
 112 current state of the specified HAMMER filesystem.  The filesystem will
 113 be synced to the media.
 114 .Pp
 115 If the
 116 .Ar quick
 117 keyword is specified the filesystem will be soft-synced, meaning that a
 118 crash might still undo the state of the filesystem as of the transaction
 119 id returned but any new modifications will occur after the returned
 120 transaction id as expected.
 121 .It Ar date
 122 Output a date equivalent given a transaction id or time stamp.
 123 .It Ar history Ar path
 124 Show the modification history for a HAMMER file's inode and data.
 125 .It Ar show Op vol_no[:clu_no]
 126 Dump the B-Tree starting at the specified volume and cluster, or
 127 at the root volume if not specified.
 128 The B-Tree is dumped recursively if the
 129 .Fl r
 130 option is specified.
 131 .It Ar blockmap
 132 Dump the btree, record, large-data, and small-data blockmaps, showing
 133 physical block assignments and free space percentages.
 134 .It Ar namekey Ar filename
 135 Generate a HAMMER 64 bit directory hash for the specified file name.
 136 The low 32 bits are used as an iterator for hash collisions and will be
 137 output as 0.
 138 .It Ar namekey32 Ar filename
 139 Generate the top 32 bits of a HAMMER 64 bit directory hash for the specified
 140 file name.
 141 .It Ar prune Ar filesystem Ar from Ar #{smhdMy} Ar to Ar #{smhdMy} Ar every Ar #{smhdMy}
 142 .It Ar prune Ar filesystem Ar from Ar #{smhdMy} Ar everything
 143 .It Ar prune Ar filesystem Ar everything
 144 .It Ar prune Ar filesystem Op Ar using Ar filename
 145 Prune the filesystem, removing deleted records to free up physical disk
 146 space.  Specify a time range between the nearest modulo 0 boundary
 147 and prune the tree to the specified granularity within that range.
 148 .Pp
 149 The filesystem specification should be the root of any mounted HAMMER
 150 filesystem.  This command uses a filesystem ioctl to issue the pruning
 151 operation.  If you specify just the filesystem with no other parameters
 152 all prune directives matching that filesystem in the /etc/hammer.conf file
 153 will be used.  If you specify a
 154 .Ar using
 155 file then those directives contained in the file matching
 156 .Ar filesystem
 157 will be used.  Multiple directives may be specified when extracting from
 158 a file.  The directives must be in the same format: "prune ....", in
 159 ascending time order (per filesystem).  Matching prune elements must not
 160 have overlapping time specifications.
 161 .Pp
 162 Both the "from" and the "to" value must be an integral multiple
 163 of the "every" value, and the "to" value must be an integral multiple
 164 of the "from" value.  When you have multiple pruning rules you must
 165 take care to ensure that the range being pruned does not overlap ranges
 166 pruned later on, when the retained data is older.  If they do the retained
 167 data can wind up being destroyed.  For example, if you prune your data
 168 on a 30 minute granularity for the last 24 hours any later pruning must
 169 use a granularity that is a multiple of 30 minutes.  If you prune your
 170 data on a 30 minute boundary, then a 1 day boundary in a later pruning (on
 171 older data), then a pruning beyond that would have to be a multiple of
 172 1 day.  And so forth.
 173 .Pp
 174 The "prune <filesystem> from ... everything" command will remove all
 175 historical records older then the specified date.  It is a way of saying
 176 that you do not want to retain any deleted information past a certain point.
 177 .Pp
 178 The "prune <filesystem> everything" command will remove all historical records
 179 from the filesystem.  The long keyword is designed to prevent accidental use.
 180 This option is not recommended.
 181 .Pp
 182 Example: "hammer prune /mnt from 1h to 1d every 30m"
 183 .Pp
 184 Note that pruning a filesystem does not necessarily immediately free space,
 185 though typically some space will be freed if a large number of records are
 186 pruned out.  The filesystem must be reblocked to completely recover all
 187 available space.
 188 .It Ar reblock Ar filesystem Op Ar fill_percentage
 189 .It Ar reblock-btree Ar filesystem Op Ar fill_percentage
 190 .It Ar reblock-data Ar filesystem Op Ar fill_percentage
 191 .It Ar reblock-recs Ar filesystem Op Ar fill_percentage
 192 Attempt to free space for reuse by reblocking a live HAMMER filesystem.
 193 Big blocks cannot be reused until they are completely free.  Scan the
 194 filesystem and move B-Tree nodes, records, and data from not-quite-full
 195 big blocks to new big blocks in an attempt to free up the not-quite-full
 196 big blocks.
 197 .Pp
 198 If unspecified a fill percentage of 90% is used.  B-Tree nodes, data,
 199 and records can be reblocked together or by separate invocations.
 200 .Pp
 201 A HAMMER filesystem can be defragmented by specifying a fill percentage
 202 of 100%.  Since this can potentially rewrite the entire contents of the
 203 disk it is best to do it incrementally from a cron job with a timeout.
 204 The filesystem would thus be defragmented over long period of time.
 205 .El
 206 .Sh EXAMPLES
 207 .Sh DIAGNOSTICS
 208 Exit status is 0 on success and 1 on error.
 209 .Sh SEE ALSO
 210 .Xr newfs_hammer 8
 211 .Sh HISTORY
 212 The
 213 .Nm
 214 utility first appeared in
 215 .Dx 1.11 .
 216 .Sh AUTHORS
 217 .An Matthew Dillon Aq dillon@backplane.com