1 .\" Copyright (c) 2007 The DragonFly Project. All rights reserved.
3 .\" This code is derived from software contributed to The DragonFly Project
4 .\" by Matthew Dillon <dillon@backplane.com>
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
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
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.
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
33 .\" $DragonFly: src/sbin/hammer/hammer.8,v 1.58 2008/11/13 02:04:27 dillon Exp $
40 .Nd HAMMER file system utility
47 .Op Fl C Ar cachesize Ns Op Ns Cm \&: Ns Ar readahead
50 .\" .Op Fl s Ar linkpath
57 This manual page documents the
59 utility which provides miscellaneous functions related to managing a
62 For a general introduction to the
64 file system, its features, and
65 examples on how to set up and maintain one, see
68 The options are as follows:
69 .Bl -tag -width indent
73 Tell the mirror commands to use a 2-way protocol, which allows
74 automatic negotiation of transaction id ranges.
75 This option is automatically enabled by the
81 will not attempt to break-up large initial bulk transfers into smaller pieces.
82 This can save time but if the link is lost in the middle of the
83 initial bulk transfer you will have to start over from scratch.
85 Specify a bandwidth limit in bytes per second for mirroring streams.
86 This option is typically used to prevent batch mirroring operations from
87 loading down the machine.
88 The bandwidth may be suffixed with
92 to specify values in kilobytes, megabytes, and gigabytes per second.
93 If no suffix is specified, bytes per second is assumed.
94 .It Fl C Ar cachesize Ns Op Ns Cm \&: Ns Ar readahead
95 Set the memory cache size for any raw
102 for megabytes is allowed,
103 else the cache size is specified in bytes.
105 The read-behind/read-ahead defaults to 4
109 This option is typically only used with diagnostic commands
110 as kernel-supported commands will use the kernel's buffer cache.
111 .It Fl c Ar cyclefile
112 When pruning and reblocking you can instruction
114 to start at the object id stored in the specified file.
115 If the file does not exist
117 will start at the beginning.
121 specific period of time and is unable to complete the operation it will
122 write out the current object id so the next run can pick up where it left off.
125 runs to completion it will delete
128 Specify the volumes making up a
132 is a colon-separated list of devices, each specifying a
136 When maintaining a streaming mirroring this option specifies the
137 minimum delay after a batch ends before the next batch is allowed
139 The default is five seconds.
141 This passes the -p <port> option to ssh when using a remote
142 specification for the source and/or destination.
144 Decrease verboseness.
145 May be specified multiple times.
147 Specify recursion for those commands which support it.
149 When pruning and reblocking you can tell the utility to stop after a
150 certain period of time.
151 This option is used along with the
153 option to prune or reblock a portion of the file system incrementally.
155 Increase verboseness.
156 May be specified multiple times.
158 Enable compression for any remote ssh specifications. Unfortunately
161 option has already been reserved for other purposes so we had to use
162 a different letter. This option is typically used with the
163 mirroring directives.
165 Force "yes" for any interactive question.
168 The commands are as follows:
169 .Bl -tag -width indent
170 .\" ==== synctid ====
171 .It Cm synctid Ar filesystem Op Cm quick
172 Generates a guaranteed, formal 64 bit transaction id representing the
173 current state of the specified
176 The file system will be synced to the media.
180 keyword is specified the file system will be soft-synced, meaning that a
181 crash might still undo the state of the file system as of the transaction
182 id returned but any new modifications will occur after the returned
183 transaction id as expected.
185 This operation does not create a snapshot.
186 It is meant to be used
187 to track temporary fine-grained changes to a subset of files and
188 will only remain valid for
190 snapshot access purposes for the
192 period configured for the PFS.
193 If you desire a real snapshot then the
195 directive may be what you are looking for.
197 .It Cm bstats Op Ar interval
200 B-tree statistics until interrupted.
203 seconds between each display.
204 The default interval is one second.
205 .\" ==== iostats ====
206 .It Cm iostats Op Ar interval
210 statistics until interrupted.
213 seconds between each display.
214 The default interval is one second.
215 .\" ==== history ====
216 .It Cm history Ar path ...
217 Show the modification history for
219 file's inode and data.
220 .\" ==== blockmap ====
222 Dump the blockmap for the file system.
225 blockmap is two-layer
226 blockmap representing the maximum possible file system size of 1 Exabyte.
227 Needless to say the second layer is only present for blocks which exist.
229 blockmap represents 8-Megabyte blocks, called big-blocks.
230 Each big-block has an append
231 point, a free byte count, and a typed zone id which allows content to be
232 reverse engineered to some degree.
236 allocations essentially appended to a selected big-block using
237 the append offset and deducted from the free byte count.
238 When space is freed the free byte count is adjusted but
240 does not track holes in big-blocks for reallocation.
241 A big-block must be completely freed, either
242 through normal file system operations or through reblocking, before
245 Data blocks can be shared by deducting the space used from the free byte
246 count for each shared references, though
248 does not yet make use of this feature.
249 This means the free byte count can legally go negative.
251 This command needs the
255 .It Cm show Op Ar lo Ns Cm \&: Ns Ar objid
257 By default this command will validate all B-Tree
258 linkages and CRCs, including data CRCs, and will report the most verbose
259 information it can dig up.
260 Any errors will show up with a
262 in column 1 along with various
265 If you specify a localization and object id field,
266 .Ar lo Ns Cm \&: Ns Ar objid ,
268 search for the key printing nodes as it recurses down, and then
269 will iterate forwards.
273 the command will report less information about the inode contents.
277 the command will not report the content of the inode or other typed
282 the command will not report volume header information, big-block fill
283 ratios, mirror transaction ids, or report or check data CRCs.
284 B-tree CRCs and linkages are still checked.
286 This command needs the
289 .\" ==== show-undo ====
295 This command needs the
299 .\" Dump the B-tree, record, large-data, and small-data blockmaps, showing
300 .\" physical block assignments and free space percentages.
301 .\" ==== namekey1 ====
302 .It Cm namekey1 Ar filename
305 64 bit directory hash for the specified file name, using
306 the original directory hash algorithm in version 1 of the file system.
307 The low 32 bits are used as an iterator for hash collisions and will be
309 .\" ==== namekey2 ====
310 .It Cm namekey2 Ar filename
313 64 bit directory hash for the specified file name, using
314 the new directory hash algorithm in version 2 of the file system.
315 The low 32 bits are still used as an iterator but will start out containing
316 part of the hash key.
317 .\" ==== namekey32 ====
318 .It Cm namekey32 Ar filename
319 Generate the top 32 bits of a
321 64 bit directory hash for the specified file name.
324 Shows extended information about all the mounted
327 The information is divided into sections:
329 .It Volume identification
330 General information, like the label of the
332 filesystem, the number of volumes it contains, the FSID, and the
335 .It Big block information
336 Big block statistics, such as total, used, reserved and free big blocks.
337 .It Space information
338 Information about space used on the filesystem.
339 Currently total size, used, reserved and free space are displayed.
341 Basic information about the PFSs currently present on a
346 is the ID of the PFS, with 0 being the root PFS.
348 is the current snapshot count on the PFS.
350 displays the mount point of the PFS is currently mounted on (if any).
352 .\" ==== cleanup ====
353 .It Cm cleanup Op Ar filesystem ...
354 This is a meta-command which executes snapshot, prune, rebalance and reblock
355 commands on the specified
360 is specified this command will clean-up all
362 file systems in use, including PFS's.
363 To do this it will scan all
367 mounts, extract PFS id's, and clean-up each PFS found.
369 This command will access a snapshots
370 directory and a configuration file for each
372 creating them if necessary.
373 .Bl -tag -width indent
374 .It Nm HAMMER No version 2-
375 The configuration file is
377 in the snapshots directory which defaults to
378 .Pa <pfs>/snapshots .
379 .It Nm HAMMER No version 3+
380 The configuration file is saved in file system meta-data, see
383 The snapshots directory defaults to
384 .Pa /var/hammer/<pfs>
385 .Pa ( /var/hammer/root
389 The format of the configuration file is:
390 .Bd -literal -offset indent
391 snapshots <period> <retention-time> [any]
392 prune <period> <max-runtime>
393 rebalance <period> <max-runtime>
394 reblock <period> <max-runtime>
395 recopy <period> <max-runtime>
399 .Bd -literal -offset indent
400 snapshots 1d 60d # 0d 0d for PFS /tmp, /var/tmp, /usr/obj
407 Time is given with a suffix of
413 meaning day, hour, minute and second.
417 directive has a period of 0 and a retention time of 0
418 then snapshot generation is disabled, removal of old snapshots are
419 disabled, and prunes will use
420 .Cm prune-everything .
423 directive has a period of 0 but a non-zero retention time
424 then this command will not create any new snapshots but will remove old
425 snapshots it finds based on the retention time.
427 By default only snapshots in the form
428 .Ql snap- Ns Ar yyyymmdd Ns Op - Ns Ar HHMM
432 directive is specified as a third argument on the
434 config line then any softlink of the form
435 .Ql *- Ns Ar yyyymmdd Ns Op - Ns Ar HHMM
437 .Ql *. Ns Ar yyyymmdd Ns Op - Ns Ar HHMM
440 A prune max-runtime of 0 means unlimited.
442 If period hasn't passed since the previous
445 For example a day has passed when midnight is passed (localtime).
453 The default configuration file will create a daily snapshot, do a daily
454 pruning, rebalancing and reblocking run and a monthly recopy run.
455 Reblocking is defragmentation with a level of 95%,
456 and recopy is full defragmentation.
458 By default prune and rebalance operations are time limited to 5 minutes,
459 reblock operations to a bit over 5 minutes,
460 and recopy operations to a bit over 10 minutes.
461 Reblocking and recopy runs are each broken down into four separate functions:
462 btree, inodes, dirs and data.
463 Each function is time limited to the time given in the configuration file,
464 but the btree, inodes and dirs functions usually does not take very long time,
465 full defragmentation is always used for these three functions.
466 Also note that this directive will by default disable snapshots on
473 The defaults may be adjusted by modifying the configuration file.
474 The pruning and reblocking commands automatically maintain a cyclefile
475 for incremental operation.
476 If you interrupt (^C) the program the cyclefile will be updated,
478 may continue to run in the background for a few seconds until the
480 ioctl detects the interrupt.
483 PFS option can be set to use another location for the snapshots directory.
485 Work on this command is still in progress.
487 An ability to remove snapshots dynamically as the
488 file system becomes full.
490 .It Cm config Op Ar filesystem Op Ar configfile
493 If zero or one arguments are specified this function dumps the current
494 configuration file to stdout.
495 Zero arguments specifies the PFS containing the current directory.
496 This configuration file is stored in file system meta-data.
497 If two arguments are specified this function installs a new config file.
501 versions less than 3 the configuration file is by default stored in
502 .Pa <pfs>/snapshots/config ,
503 but in all later versions the configuration file is stored in file system
505 .\" ==== viconfig ====
506 .It Cm viconfig Op Ar filesystem
509 Edit the configuration file and reinstall into file system meta-data when done.
510 Zero arguments specifies the PFS containing the current directory.
511 .\" ==== volume-add ====
512 .It Cm volume-add Ar device Ar filesystem
513 This command will format
515 and add all of its space to
519 All existing data contained on
521 will be destroyed by this operation!
526 file system, formatting will be denied.
527 You can overcome this sanity check
530 to erase the beginning sectors of the device.
531 Also remember that you have to specify
533 together with any other device that make up the file system,
538 .\" ==== volume-del ====
539 .It Cm volume-del Ar device Ar filesystem
540 This command will remove volume
545 Remember that you have to remove
547 from the colon-separated list in
551 .\" ==== snapshot ====
552 .It Cm snapshot Oo Ar filesystem Oc Ar snapshot-dir
553 .It Cm snapshot Ar filesystem Ar snapshot-dir Op Ar note
554 Takes a snapshot of the file system either explicitly given by
556 or implicitly derived from the
558 argument and creates a symlink in the directory provided by
560 pointing to the snapshot.
563 is not a directory, it is assumed to be a format string passed to
565 with the current time as parameter.
568 refers to an existing directory, a default format string of
570 is assumed and used as name for the newly created symlink.
572 Snapshot is a per PFS operation, so a
574 file system and each PFS in it have to be snapshot separately.
576 Example, assuming that
584 are file systems on their own, the following invocations:
585 .Bd -literal -offset indent
586 hammer snapshot /mysnapshots
588 hammer snapshot /mysnapshots/%Y-%m-%d
590 hammer snapshot /obj /mysnapshots/obj-%Y-%m-%d
592 hammer snapshot /usr /my/snaps/usr "note"
595 Would create symlinks similar to:
596 .Bd -literal -offset indent
597 /mysnapshots/snap-20080627-1210 -> /@@0x10d2cd05b7270d16
599 /mysnapshots/2008-06-27 -> /@@0x10d2cd05b7270d16
601 /mysnapshots/obj-2008-06-27 -> /obj@@0x10d2cd05b7270d16
603 /my/snaps/usr/snap-20080627-1210 -> /usr@@0x10d2cd05b7270d16
608 version 3+ file system the snapshot is also recorded in file system meta-data
609 along with the optional
615 .It Cm snap Ar path Op Ar note
618 Create a snapshot for the PFS containing
620 and create a snapshot softlink.
621 If the path specified is a
622 directory a standard snapshot softlink will be created in the directory.
623 The snapshot softlink points to the base of the mounted PFS.
624 .It Cm snaplo Ar path Op Ar note
627 Create a snapshot for the PFS containing
629 and create a snapshot softlink.
630 If the path specified is a
631 directory a standard snapshot softlink will be created in the directory.
632 The snapshot softlink points into the directory it is contained in.
633 .It Cm snapq Ar dir Op Ar note
636 Create a snapshot for the PFS containing the specified directory but do
637 not create a softlink.
638 Instead output a path which can be used to access
639 the directory via the snapshot.
641 An absolute or relative path may be specified.
642 The path will be used as-is as a prefix in the path output to stdout.
644 snap and snapshot directives the snapshot transaction id will be registered
645 in the file system meta-data.
646 .It Cm snaprm Bro Ar path | transid Brc Ar ...
649 Remove a snapshot given its softlink or transaction id.
650 If specifying a transaction id
651 the snapshot is removed from file system meta-data but you are responsible
652 for removing any related softlinks.
653 .It Cm snapls Op Ar path ...
656 Dump the snapshot meta-data for PFSs containing each
658 listing all available snapshots and their notes.
659 If no arguments are specified snapshots for the PFS containing the
660 current directory are listed.
661 This is the definitive list of snapshots for the file system.
663 .It Cm prune Ar softlink-dir
664 Prune the file system based on previously created snapshot softlinks.
665 Pruning is the act of deleting file system history.
668 command will delete file system history such that
669 the file system state is retained for the given snapshots,
670 and all history after the latest snapshot.
671 By setting the per PFS parameter
673 history is guaranteed to be saved at least this time interval.
674 All other history is deleted.
676 The target directory is expected to contain softlinks pointing to
677 snapshots of the file systems you wish to retain.
678 The directory is scanned non-recursively and the mount points and
679 transaction ids stored in the softlinks are extracted and sorted.
680 The file system is then explicitly pruned according to what is found.
681 Cleaning out portions of the file system is as simple as removing a
682 snapshot softlink and then running the
686 As a safety measure pruning only occurs if one or more softlinks are found
689 snapshot id extension.
690 Currently the scanned softlink directory must contain softlinks pointing
694 The softlinks may specify absolute or relative paths.
695 Softlinks must use 20-character
697 transaction ids, as might be returned from
698 .Nm Cm synctid Ar filesystem .
700 Pruning is a per PFS operation, so a
702 file system and each PFS in it have to be pruned separately.
704 Note that pruning a file system may not immediately free-up space,
705 though typically some space will be freed if a large number of records are
707 The file system must be reblocked to completely recover all available space.
709 Example, lets say your that you didn't set
711 and snapshot directory contains the following links:
712 .Bd -literal -offset indent
713 lrwxr-xr-x 1 root wheel 29 May 31 17:57 snap1 ->
714 /usr/obj/@@0x10d2cd05b7270d16
716 lrwxr-xr-x 1 root wheel 29 May 31 17:58 snap2 ->
717 /usr/obj/@@0x10d2cd13f3fde98f
719 lrwxr-xr-x 1 root wheel 29 May 31 17:59 snap3 ->
720 /usr/obj/@@0x10d2cd222adee364
723 If you were to run the
725 command on this directory, then the
728 mount will be pruned to retain the above three snapshots.
729 In addition, history for modifications made to the file system older than
730 the oldest snapshot will be destroyed and history for potentially fine-grained
731 modifications made to the file system more recently than the most recent
732 snapshot will be retained.
734 If you then delete the
736 softlink and rerun the
739 history for modifications pertaining to that snapshot would be destroyed.
743 file system versions 3+ this command also scans the snapshots stored
744 in the file system meta-data and includes them in the prune.
745 .\" ==== prune-everything ====
746 .It Cm prune-everything Ar filesystem
747 This command will remove all historical records from the file system.
748 This directive is not normally used on a production system.
750 This command does not remove snapshot softlinks but will delete all
751 snapshots recorded in file system meta-data (for file system version 3+).
752 The user is responsible for deleting any softlinks.
753 .\" ==== rebalance ====
754 .It Cm rebalance Ar filesystem Op Ar saturation_percentage
755 This command will rebalance the B-tree, nodes with small number of
756 elements will be combined and element counts will be smoothed out
759 The saturation percentage is between 50% and 100%.
760 The default is 75% (the
762 suffix is not needed).
763 .\" ==== reblock* ====
764 .It Cm reblock Ar filesystem Op Ar fill_percentage
765 .It Cm reblock-btree Ar filesystem Op Ar fill_percentage
766 .It Cm reblock-inodes Ar filesystem Op Ar fill_percentage
767 .It Cm reblock-dirs Ar filesystem Op Ar fill_percentage
768 .It Cm reblock-data Ar filesystem Op Ar fill_percentage
769 Attempt to defragment and free space for reuse by reblocking a live
772 Big-blocks cannot be reused by
774 until they are completely free.
775 This command also has the effect of reordering all elements, effectively
776 defragmenting the file system.
778 The default fill percentage is 100% and will cause the file system to be
779 completely defragmented.
780 All specified element types will be reallocated and rewritten.
781 If you wish to quickly free up space instead try specifying
782 a smaller fill percentage, such as 90% or 80% (the
784 suffix is not needed).
786 Since this command may rewrite the entire contents of the disk it is
787 best to do it incrementally from a
793 options to limit the run time.
794 The file system would thus be defragmented over long period of time.
796 It is recommended that separate invocations be used for each data type.
797 B-tree nodes, inodes, and directories are typically the most important
798 elements needing defragmentation.
799 Data can be defragmented over a longer period of time.
801 Reblocking is a per PFS operation, so a
803 file system and each PFS in it have to be reblocked separately.
804 .\" ==== pfs-status ====
805 .It Cm pfs-status Ar dirpath ...
806 Retrieve the mirroring configuration parameters for the specified
808 file systems or pseudo-filesystems (PFS's).
809 .\" ==== pfs-master ====
810 .It Cm pfs-master Ar dirpath Op Ar options
811 Create a pseudo-filesystem (PFS) inside a
814 Up to 65535 such file systems can be created.
815 Each PFS uses an independent inode numbering space making it suitable
816 for use as a replication source or target.
820 directive creates a PFS that you can read, write, and use as a mirroring
823 It is recommended to use a
825 mount to access a PFS, for more information see
827 .\" ==== pfs-slave ====
828 .It Cm pfs-slave Ar dirpath Op Ar options
829 Create a pseudo-filesystem (PFS) inside a
832 Up to 65535 such file systems can be created.
833 Each PFS uses an independent inode numbering space making it suitable
834 for use as a replication source or target.
838 directive creates a PFS that you can use as a mirroring target.
839 You will not be able to access a slave PFS until you have completed the
840 first mirroring operation with it as the target (its root directory will
841 not exist until then).
843 Access to the pfs-slave via the special softlink, as described in the
848 dynamically modify the snapshot transaction id by returning a dynamic result
853 A PFS can only be truly destroyed with the
856 Removing the softlink will not destroy the underlying PFS.
858 It is recommended to use a
860 mount to access a PFS, for more information see
862 .\" ==== pfs-update ====
863 .It Cm pfs-update Ar dirpath Op Ar options
864 Update the configuration parameters for an existing
866 file system or pseudo-filesystem.
867 Options that may be specified:
868 .Bl -tag -width indent
869 .It Cm sync-beg-tid= Ns Ar 0x16llx
870 This is the automatic snapshot access starting transaction id for
872 This parameter is normally updated automatically by the
876 It is important to note that accessing a mirroring slave
877 with a transaction id greater than the last fully synchronized transaction
878 id can result in an unreliable snapshot since you will be accessing
879 data that is still undergoing synchronization.
881 Manually modifying this field is dangerous and can result in a broken mirror.
882 .It Cm sync-end-tid= Ns Ar 0x16llx
883 This is the current synchronization point for mirroring slaves.
884 This parameter is normally updated automatically by the
888 Manually modifying this field is dangerous and can result in a broken mirror.
889 .It Cm shared-uuid= Ns Ar uuid
890 Set the shared UUID for this file system.
891 All mirrors must have the same shared UUID.
892 For safety purposes the
894 directives will refuse to operate on a target with a different shared UUID.
896 Changing the shared UUID on an existing, non-empty mirroring target,
897 including an empty but not completely pruned target,
898 can lead to corruption of the mirroring target.
899 .It Cm unique-uuid= Ns Ar uuid
900 Set the unique UUID for this file system.
901 This UUID should not be used anywhere else,
902 even on exact copies of the file system.
903 .It Cm label= Ns Ar string
904 Set a descriptive label for this file system.
905 .It Cm snapshots= Ns Ar string
906 Specify the snapshots directory which
909 will use to manage this PFS.
910 .Bl -tag -width indent
911 .It Nm HAMMER No version 2-
912 The snapshots directory does not need to be configured for
913 PFS masters and will default to
914 .Pa <pfs>/snapshots .
916 PFS slaves are mirroring slaves so you cannot configure a snapshots
917 directory on the slave itself to be managed by the slave's machine.
918 In fact, the slave will likely have a
920 sub-directory mirrored
921 from the master, but that directory contains the configuration the master
922 is using for its copy of the file system, not the configuration that we
923 want to use for our slave.
925 It is recommended that
926 .Pa <fs>/var/slaves/<name>
927 be configured for a PFS slave, where
933 is an appropriate label.
934 .It Nm HAMMER No version 3+
935 The snapshots directory does not need to be configured for PFS masters or
937 The snapshots directory defaults to
938 .Pa /var/hammer/<pfs>
939 .Pa ( /var/hammer/root
943 You can control snapshot retention on your slave independent of the master.
944 .It Cm snapshots-clear
947 directory path for this PFS.
948 .It Cm prune-min= Ns Ar N Ns Cm d
949 .It Cm prune-min= Ns Oo Ar N Ns Cm d/ Oc Ns \
950 Ar hh Ns Op Cm \&: Ns Ar mm Ns Op Cm \&: Ns Ar ss
951 Set the minimum fine-grained data retention period.
953 always retains fine-grained history up to the most recent snapshot.
954 You can extend the retention period further by specifying a non-zero
956 Any snapshot softlinks within the retention period are ignored
957 for the purposes of pruning (the fine grained history is retained).
958 Number of days, hours, minutes and seconds are given as
963 Because the transaction id in the snapshot softlink cannot be used
964 to calculate a timestamp,
966 uses the earlier of the
970 field of the softlink to
971 determine which snapshots fall within the retention period.
972 Users must be sure to retain one of these two fields when manipulating
975 .\" ==== pfs-upgrade ====
976 .It Cm pfs-upgrade Ar dirpath
977 Upgrade a PFS from slave to master operation.
978 The PFS will be rolled back to the current end synchronization transaction id
979 (removing any partial synchronizations), and will then become writable.
983 currently supports only single masters and using
984 this command can easily result in file system corruption
985 if you don't know what you are doing.
987 This directive will refuse to run if any programs have open descriptors
988 in the PFS, including programs chdir'd into the PFS.
989 .\" ==== pfs-downgrade ====
990 .It Cm pfs-downgrade Ar dirpath
991 Downgrade a master PFS from master to slave operation
992 The PFS becomes read-only and access will be locked to its
995 This directive will refuse to run if any programs have open descriptors
996 in the PFS, including programs chdir'd into the PFS.
997 .\" ==== pfs-destroy ====
998 .It Cm pfs-destroy Ar dirpath
999 This permanently destroys a PFS.
1001 This directive will refuse to run if any programs have open descriptors
1002 in the PFS, including programs chdir'd into the PFS.
1003 .\" ==== mirror-read ====
1004 .It Cm mirror-read Ar filesystem Op Ar begin-tid
1005 Generate a mirroring stream to stdout.
1006 The stream ends when the transaction id space has been exhausted.
1007 .\" ==== mirror-read-stream ====
1008 .It Cm mirror-read-stream Ar filesystem Op Ar begin-tid
1009 Generate a mirroring stream to stdout.
1010 Upon completion the stream is paused until new data is synced to the
1011 master, then resumed.
1012 Operation continues until the pipe is broken.
1013 .\" ==== mirror-write ====
1014 .It Cm mirror-write Ar filesystem
1015 Take a mirroring stream on stdin.
1017 This command will fail if the
1019 configuration field for the two file systems do not match.
1021 If the target PFS does not exist this command will ask you whether
1022 you want to create a compatible PFS slave for the target or not.
1023 .\" ==== mirror-dump ====
1029 to dump an ASCII representation of the mirroring stream.
1030 .\" ==== mirror-copy ====
1031 .\".It Cm mirror-copy Ar [[user@]host:]filesystem [[user@]host:]filesystem
1032 .It Cm mirror-copy \
1033 Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem \
1034 Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem
1035 This is a shortcut which pipes a
1040 If a remote host specification is made the program forks a
1046 on the appropriate host.
1047 The source may be a master or slave PFS, and the target must be a slave PFS.
1049 This command also established full duplex communication and turns on
1050 the two-way protocol feature which automatically negotiates transaction id
1051 ranges without having to use a cyclefile.
1052 If the operation completes successfully the target PFS's
1055 Note that you must re-chdir into the target PFS to see the updated information.
1056 If you do not you will still be in the previous snapshot.
1058 If the target PFS does not exist this command will ask you whether
1059 you want to create a compatible PFS slave for the target or not.
1060 .\" ==== mirror-stream ====
1061 .\".It Cm mirror-stream Ar [[user@]host:]filesystem [[user@]host:]filesystem
1062 .It Cm mirror-stream \
1063 Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem \
1064 Oo Oo Ar user Ns Cm @ Oc Ns Ar host Ns Cm \&: Oc Ns Ar filesystem
1065 This command works similarly to
1067 but does not exit after the initial mirroring completes.
1068 The mirroring operation will resume as changes continue to be made to the
1070 The command is commonly used with
1074 options to keep the mirroring target in sync with the source on a continuing
1077 If the pipe is broken the command will automatically retry after sleeping
1079 The time slept will be 15 seconds plus the time given in the
1083 This command also detects the initial-mirroring case and spends some
1084 time scanning the B-Tree to find good break points, allowing the initial
1085 bulk mirroring operation to be broken down into about 20 separate pieces.
1086 This means that the user can kill and restart the operation and it will
1087 not have to start from scratch once it has gotten past the first chunk.
1090 option may be used to disable this feature and perform an initial bulk
1092 .\" ==== version ====
1093 .It Cm version Ar filesystem
1094 This command returns the
1096 file system version for the specified
1098 as well as the range of versions supported in the kernel.
1101 option may be used to remove the summary at the end.
1102 .\" ==== version-upgrade ====
1103 .It Cm version-upgrade Ar filesystem Ar version Op Cm force
1104 This command upgrades the
1109 Once upgraded a file system may not be downgraded.
1110 If you wish to upgrade a file system to a version greater or equal to the
1111 work-in-progress version number you must specify the
1114 Use of WIP versions should be relegated to testing and may require wiping
1115 the file system as development progresses, even though the WIP version might
1119 This command operates on the entire
1121 file system and is not a per PFS operation.
1122 All PFS's will be affected.
1123 .Bl -tag -width indent
1126 default version, first
1131 New directory entry layout.
1132 This version is using a new directory hash key.
1135 New snapshot management, using file system meta-data for saving
1136 configuration file and snapshots (transaction ids etc.).
1137 Also default snapshots directory has changed.
1141 New undo/flush, giving faster sync.
1145 .Sh PSEUDO-FILESYSTEM (PFS) NOTES
1146 The root of a PFS is not hooked into the primary
1148 file system as a directory.
1151 creates a special softlink called
1153 (exactly 10 characters long) in the primary
1157 then modifies the contents of the softlink as read by
1159 and thus what you see with an
1161 command or if you were to
1164 If the PFS is a master the link reflects the current state of the PFS.
1165 If the PFS is a slave the link reflects the last completed snapshot, and the
1166 contents of the link will change when the next snapshot is completed, and
1171 utility employs numerous safeties to reduce user foot-shooting.
1174 directive requires that the target be configured as a slave and that the
1176 field of the mirroring source and target match.
1177 .Sh UPGRADE INSTRUCTIONS HAMMER V1 TO V2
1178 This upgrade changes the way directory entries are stored.
1179 It is possible to upgrade a V1 file system to V2 in place, but
1180 directories created prior to the upgrade will continue to use
1183 Note that the slave mirroring code in the target kernel had bugs in
1184 V1 which can create an incompatible root directory on the slave.
1187 master created after the upgrade with a
1189 slave created prior to the upgrade.
1191 Any directories created after upgrading will use a new layout.
1192 .Sh UPGRADE INSTRUCTIONS HAMMER V2 TO V3
1193 This upgrade adds meta-data elements to the B-Tree.
1194 It is possible to upgrade a V2 file system to V3 in place.
1195 After issuing the upgrade be sure to run a
1198 to perform post-upgrade tasks.
1200 After making this upgrade running a
1205 directory for each PFS mount into
1206 .Pa /var/hammer/<pfs> .
1209 root mount will migrate
1212 .Pa /var/hammer/root .
1213 Migration occurs only once and only if you have not specified
1214 a snapshots directory in the PFS configuration.
1215 If you have specified a snapshots directory in the PFS configuration no
1216 automatic migration will occur.
1218 For slaves, if you desire, you can migrate your snapshots
1219 config to the new location manually and then clear the
1220 snapshot directory configuration in the slave PFS.
1221 The new snapshots hierarchy is designed to work with
1222 both master and slave PFSs equally well.
1224 In addition, the old config file will be moved to file system meta-data,
1225 editable via the new
1229 The old config file will be deleted.
1230 Migration occurs only once.
1232 The V3 file system has new
1234 directives for creating snapshots.
1235 All snapshot directives, including the original, will create
1236 meta-data entries for the snapshots and the pruning code will
1237 automatically incorporate these entries into its list and
1238 expire them the same way it expires softlinks.
1239 If you by accident blow away your snapshot softlinks you can use the
1241 directive to get a definitive list from the file system meta-data and
1242 regenerate them from that list.
1247 to backup file systems your scripts may be using the
1249 directive to generate transaction ids.
1250 This directive does not create a snapshot.
1251 You will have to modify your scripts to use the
1253 directive to generate the linkbuf for the softlink you create, or
1254 use one of the other
1259 directive will continue to work as expected and in V3 it will also
1260 record the snapshot transaction id in file system meta-data.
1261 You may also want to make use of the new
1263 tag for the meta-data.
1266 If you used to remove snapshot softlinks with
1268 you should probably start using the
1270 directive instead to also remove the related meta-data.
1271 The pruning code scans the meta-data so just removing the
1272 softlink is not sufficient.
1273 .Sh UPGRADE INSTRUCTIONS HAMMER V3 TO V4
1274 This upgrade changes undo/flush, giving faster sync.
1275 It is possible to upgrade a V3 file system to V4 in place.
1276 This upgrade reformats the UNDO FIFO (typically 1GB), so upgrade might take
1277 a minute or two depending.
1279 Version 4 allows the UNDO FIFO to be flushed without also having
1280 to flush the volume header, removing 2 of the 4 disk syncs typically
1281 required for an fsync() and removing 1 of the 2 disk syncs typically
1282 required for a flush sequence.
1286 .Bl -tag -width ".It Pa <fs>/var/slaves/<name>" -compact
1287 .It Pa <pfs>/snapshots
1288 default per PFS snapshots directory
1291 .It Pa /var/hammer/<pfs>
1292 default per PFS snapshots directory (not root)
1295 .It Pa /var/hammer/root
1296 default snapshots directory for root directory
1299 .It Pa <snapshots>/config
1306 .It Pa <fs>/var/slaves/<name>
1307 recommended slave PFS snapshots directory
1315 .Xr periodic.conf 5 ,
1316 .Xr mount_hammer 8 ,
1322 utility first appeared in
1325 .An Matthew Dillon Aq dillon@backplane.com
projects / dragonfly.git / blob