HAMMER Utilities: Cleanup.
[dragonfly.git] / 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.15 2008/05/12 05:13:47 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 .It Fl x
80 Do not call sync() when running commands which sync() by default.
81 Timestamp commands such as 'hammer now' sync() by default.  This also
82 disables any sleeps the timestamp commands would otherwise perform.
83 .El
84 .Pp
85 The commands are as follows:
86 .Bl -tag -width indent
87 .It Ar now
88 Generate a timestamp suitable for use in the @@ filename extension,
89 representing right now.
90 Unless
91 .Fl x
92 is specified, this command will automatically sync() and
93 wait for the seconds hand to turn over (sleep for up to one second) prior
94 to generating a seconds-denominated timestamp.
95 .It Ar now64
96 Generate a full 64 bit timestamp.
97 Unless
98 .Fl x
99 is specified, this command will automatically sync(), but not sleep,
100 prior to generating the timestamp.
101 .It Ar stamp
102 Generate a timestamp suitable for use in the @@ filename extension.
103 This command does not sync() or sleep and care should be taken if
104 generating timestamps for data which may not yet be synced to disk.
105 A time specification of
106 .Pf yyyymmdd Oo :hhmmss Oc Ns Op .fractional
107 specifies an exact as-of timestamp in local (not UTC) time.
108 Set the TZ environment variable prior to running
109 .Nm
110 if you wish to specify the time by some other means.
111 .It Ar stamp64
112 Same as the
113 .Ar stamp
114 command but generates a 64 bit timestamp.
115 .It Ar date
116 Output a date equivalent given a transaction id or time stamp.
117 .It Ar history Ar path
118 Show the modification history for a HAMMER file's inode and data.
119 .It Ar show Op vol_no[:clu_no]
120 Dump the B-Tree starting at the specified volume and cluster, or
121 at the root volume if not specified.
122 The B-Tree is dumped recursively if the
123 .Fl r
124 option is specified.
125 .It Ar blockmap
126 Dump the btree, record, large-data, and small-data blockmaps, showing
127 physical block assignments and free space percentages.
128 .It Ar namekey Ar filename
129 Generate a HAMMER 64 bit directory hash for the specified file name.
130 The low 32 bits are used as an iterator for hash collisions and will be
131 output as 0.
132 .It Ar namekey32 Ar filename
133 Generate the top 32 bits of a HAMMER 64 bit directory hash for the specified
134 file name.
135 .It Ar prune Ar filesystem Ar from Ar #{smhdMy} Ar to Ar #{smhdMy} Ar every Ar #{smhdMy}
136 .It Ar prune Ar filesystem Ar from Ar #{smhdMy} Ar everything
137 .It Ar prune Ar filesystem Ar everything
138 .It Ar prune Ar filesystem Op Ar using Ar filename
139 Prune the filesystem, removing deleted records to free up physical disk
140 space.  Specify a time range between the nearest modulo 0 boundary
141 and prune the tree to the specified granularity within that range.
142 .Pp
143 The filesystem specification should be the root of any mounted HAMMER
144 filesystem.  This command uses a filesystem ioctl to issue the pruning
145 operation.  If you specify just the filesystem with no other parameters
146 all prune directives matching that filesystem in the /etc/hammer.conf file
147 will be used.  If you specify a
148 .Ar using
149 file then those directives contained in the file matching
150 .Ar filesystem
151 will be used.  Multiple directives may be specified when extracting from
152 a file.  The directives must be in the same format: "prune ....", in
153 ascending time order (per filesystem).  Matching prune elements must not
154 have overlapping time specifications.
155 .Pp
156 Both the "from" and the "to" value must be an integral multiple
157 of the "every" value, and the "to" value must be an integral multiple
158 of the "from" value.  When you have multiple pruning rules you must
159 take care to ensure that the range being pruned does not overlap ranges
160 pruned later on, when the retained data is older.  If they do the retained
161 data can wind up being destroyed.  For example, if you prune your data
162 on a 30 minute granularity for the last 24 hours any later pruning must
163 use a granularity that is a multiple of 30 minutes.  If you prune your
164 data on a 30 minute boundary, then a 1 day boundary in a later pruning (on
165 older data), then a pruning beyond that would have to be a multiple of
166 1 day.  And so forth.
167 .Pp
168 The "prune <filesystem> from ... everything" command will remove all
169 historical records older then the specified date.  It is a way of saying
170 that you do not want to retain any deleted information past a certain point.
171 .Pp
172 The "prune <filesystem> everything" command will remove all historical records
173 from the filesystem.  The long keyword is designed to prevent accidental use.
174 This option is not recommended.
175 .Pp
176 Example: "hammer prune /mnt from 1h to 1d every 30m"
177 .Pp
178 Note that pruning a filesystem does not necessarily immediately free space,
179 though typically some space will be freed if a large number of records are
180 pruned out.  The filesystem must be reblocked to completely recover all
181 available space.
182 .It Ar reblock Ar filesystem Op Ar fill_percentage
183 .It Ar reblock-btree Ar filesystem Op Ar fill_percentage
184 .It Ar reblock-data Ar filesystem Op Ar fill_percentage
185 .It Ar reblock-recs Ar filesystem Op Ar fill_percentage
186 Attempt to free space for reuse by reblocking a live HAMMER filesystem.
187 Big blocks cannot be reused until they are completely free.  Scan the
188 filesystem and move B-Tree nodes, records, and data from not-quite-full
189 big blocks to new big blocks in an attempt to free up the not-quite-full
190 big blocks.
191 .Pp
192 If unspecified a fill percentage of 90% is used.  B-Tree nodes, data,
193 and records can be reblocked together or by separate invocations.
194 .Pp
195 A HAMMER filesystem can be defragmented by specifying a fill percentage
196 of 100%.  Since this can potentially rewrite the entire contents of the
197 disk it is best to do it incrementally from a cron job with a timeout.
198 The filesystem would thus be defragmented over long period of time.
199 .El
200 .Sh EXAMPLES
201 .Sh DIAGNOSTICS
202 Exit status is 0 on success and 1 on error.
203 .Sh SEE ALSO
204 .Xr newfs_hammer 8
205 .Sh HISTORY
206 The
207 .Nm
208 utility first appeared in
209 .Dx 1.11 .
210 .Sh AUTHORS
211 .An Matthew Dillon Aq dillon@backplane.com