freebsd-dev/lib/geom/union/geom_union.c
Kirk McKusick c7996ddf80 Create a new GEOM utility, gunion(8).
The gunion(8) utility is used to track changes to a read-only disk on
a writable disk. Logically, a writable disk is placed over a read-only
disk. Write requests are intercepted and stored on the writable
disk. Read requests are first checked to see if they have been
written on the top (writable disk) and if found are returned. If
they have not been written on the top disk, then they are read from
the lower disk.

The gunion(8) utility can be especially useful if you have a large
disk with a corrupted filesystem that you are unsure of how to
repair. You can use gunion(8) to place another disk over the corrupted
disk and then attempt to repair the filesystem. If the repair fails,
you can revert all the changes in the upper disk and be back to the
unchanged state of the lower disk thus allowing you to try another
approach to repairing it. If the repair is successful you can commit
all the writes recorded on the top disk to the lower disk.

Another use of the gunion(8) utility is to try out upgrades to your
system. Place the upper disk over the disk holding your filesystem
that is to be upgraded and then run the upgrade on it. If it works,
commit it; if it fails, revert the upgrade.

Further details can be found in the gunion(8) manual page.

Reviewed by: Chuck Silvers, kib (earlier version)
tested by:   Peter Holm
Differential Revision: https://reviews.freebsd.org/D32697
2022-02-28 16:36:08 -08:00

84 lines
2.6 KiB
C

/*-
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
*
* Copyright (c) 2022 Marshall Kirk McKusick <mckusick@mckusick.com>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
#include <stdio.h>
#include <stdint.h>
#include <libgeom.h>
#include <geom/union/g_union.h>
#include "core/geom.h"
uint32_t lib_version = G_LIB_VERSION;
uint32_t version = G_UNION_VERSION;
struct g_command class_commands[] = {
{ "create", G_FLAG_LOADKLD, NULL,
{
{ 'o', "offset", "0", G_TYPE_NUMBER },
{ 's', "size", "0", G_TYPE_NUMBER },
{ 'S', "secsize", "0", G_TYPE_NUMBER },
{ 'v', "verbose", NULL, G_TYPE_BOOL },
{ 'Z', "gunionname", G_VAL_OPTIONAL, G_TYPE_STRING },
G_OPT_SENTINEL
},
"[-v] [-o offset] [-s size] [-S secsize] [-Z gunionname] "
"upperdev lowerdev"
},
{ "destroy", 0, NULL,
{
{ 'f', "force", NULL, G_TYPE_BOOL },
{ 'v', "verbose", NULL, G_TYPE_BOOL },
G_OPT_SENTINEL
},
"[-fv] prov ..."
},
{ "reset", 0, NULL,
{
{ 'v', "verbose", NULL, G_TYPE_BOOL },
G_OPT_SENTINEL
},
"[-v] prov ..."
},
{ "commit", 0, NULL,
{
{ 'f', "force", NULL, G_TYPE_BOOL },
{ 'r', "reboot", NULL, G_TYPE_BOOL },
{ 'v', "verbose", NULL, G_TYPE_BOOL },
G_OPT_SENTINEL
},
"[-frv] prov ..."
},
{ "revert", 0, NULL,
{
{ 'v', "verbose", NULL, G_TYPE_BOOL },
G_OPT_SENTINEL
},
"[-v] prov ..."
},
G_CMD_SENTINEL
};