Version 8.2.2.2

- Updated manpages.
dm-vdo · Jun 20, 2023 · e7a687d · e7a687d
1 parent 163f9d8
commit e7a687d
Show file tree

Hide file tree

Showing 16 changed files with 181 additions and 89 deletions.
diff --git a/utils/uds/Makefile b/utils/uds/Makefile
@@ -18,7 +18,7 @@
 #
 # $Id: //eng/vdo-releases/chlorine/src/packaging/src-dist/user/utils/uds/Makefile#1 $
 
-BUILD_VERSION = 8.2.0.2
+BUILD_VERSION = 8.2.2.2
 
 DEPDIR = .deps
 

diff --git a/utils/vdo/Makefile b/utils/vdo/Makefile
@@ -18,7 +18,7 @@
 #
 # $Id: //eng/vdo-releases/chlorine/src/packaging/src-dist/user/utils/vdo/Makefile#2 $
 
-VDO_VERSION = 8.2.0.2
+VDO_VERSION = 8.2.2.2
 
 UDS_DIR      = ../uds
 

diff --git a/utils/vdo/man/vdoaudit.8 b/utils/vdo/man/vdoaudit.8
@@ -1,4 +1,4 @@
-.TH VDOAUDIT 8 "2020-05-04" "Red Hat" \" -*- nroff -*-
+.TH VDOAUDIT 8 "2023-03-28" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdoaudit \- confirm the reference counts of a VDO device
 .SH SYNOPSIS
@@ -14,6 +14,9 @@ physical blocks against the stored reference counts. Finally, it validates
 that the slab summary approximation of the free blocks in each slab is
 correct.
 .PP
+.I filename
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
+.PP
 If \-\-verbose is specified, a line item will be reported for each
 inconsistency; otherwise a summary of the problems will be displayed.
 .SH OPTIONS
@@ -30,7 +33,13 @@ Display a line item for each inconsistency found on the volume.
 .B \-\-version
 Show the version of vdoaudit.
 .
-.\" .SH EXAMPLES
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# vdoaudit --verbose /dev/mapper/vdo1-vdo0pool_vdata
+# lvchange -an vdo1/vdo0pool_vdata
+.fi
 .\" .SH NOTES
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8)
diff --git a/utils/vdo/man/vdodumpblockmap.8 b/utils/vdo/man/vdodumpblockmap.8
@@ -1,4 +1,4 @@
-.TH VDODUMPBLOCKMAP 8 "2020-05-06" "Red Hat" \" -*- nroff -*-
+.TH VDODUMPBLOCKMAP 8 "2023-03-28" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdodumpblockmap \- dump the LBA->PBA mappings of a VDO device
 .SH SYNOPSIS
@@ -9,6 +9,9 @@ vdodumpblockmap \- dump the LBA->PBA mappings of a VDO device
 .B vdodumpblockmap
 dumps all (or only the specified) LBA->PBA mappings from a cleanly
 shut down VDO device.
+.PP
+.I filename
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
 .SH OPTIONS
 .TP
 .B \-\-help
@@ -20,5 +23,12 @@ Dump only the mapping for the specified LBA.
 .B \-\-version
 Show the version of vdodumpblockmap.
 .
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# vdodumpblockmap /dev/mapper/vdo1-vdo0pool_vdata
+# lvchange -an vdo1/vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8)
diff --git a/utils/vdo/man/vdodumpconfig.8 b/utils/vdo/man/vdodumpconfig.8
@@ -1,17 +1,25 @@
-.TH VDODUMPCONFIG 8 "2017-09-12" "Red Hat" \" -*- nroff -*-
+.TH VDODUMPCONFIG 8 "2023-04-04" "Red Hat" \" -*- nroff -*-
 .SH NAME
-vdodumpconfig \- dump the configuration of a VDO volume from its backing
-store
+vdodumpconfig \- dump the configuration of a VDO volume from its backing store
 .SH SYNOPSIS
 .B vdodumpconfig
 .I vdoBacking
 .SH DESCRIPTION
 .B vdodumpconfig
-dumps the configuration of a VDO volume, whether or not the VDO is running.
+dumps the configuration of a VDO volume.
+.PP
+.I vdoBacking
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
 .SH OPTIONS
 .TP
 .I vdoBacking
-The name of the file or block device used as the backing store for
-VDO.
+The name of the file or block device used as the backing store for VDO.
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# vdodumpconfig /dev/mapper/vdo1-vdo0pool_vdata
+# lvchange -an vdo1/vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8)
diff --git a/utils/vdo/man/vdodumpmetadata.8 b/utils/vdo/man/vdodumpmetadata.8
@@ -1,4 +1,4 @@
-.TH VDODUMPMETADATA 8 "2017-09-12" "Red Hat" \" -*- nroff -*-
+.TH VDODUMPMETADATA 8 "2023-03-38" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdodumpmetadata \- dump the metadata regions from a VDO device
 .SH SYNOPSIS
@@ -12,6 +12,9 @@ dumps the metadata regions of a VDO device to
 another file, to enable save and transfer of metadata from
 a VDO without transfer of the entire backing store.
 .PP
+.I vdoBacking
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
+.PP
 .B vdodumpmetadata
 will produce a large output file. The expected size is
 roughly equal to VDO's metadata size. A rough estimate of the storage
@@ -26,5 +29,13 @@ Omit the block map. The output file will be of size no higher than
 Saves the block map page associated with the specified LBN in the
 output file. This option may be specified up to 255 times.
 Implies \-\-no\-block\-map.
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# vdodumpmetadata /dev/mapper/vdo1-vdo0pool_vdata vdo1-meta-dump
+# lvchange -an vdo1/vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8),
+.BR vdodebugmetadata (8)
diff --git a/utils/vdo/man/vdoforcerebuild.8 b/utils/vdo/man/vdoforcerebuild.8
@@ -1,4 +1,4 @@
-.TH VDOFORCEREBUILD 8 "2017-09-12" "Red Hat" \" -*- nroff -*-
+.TH VDOFORCEREBUILD 8 "2023-04-14" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdoforcerebuild \- prepare a VDO device to exit read-only mode
 .SH SYNOPSIS
@@ -8,9 +8,29 @@ vdoforcerebuild \- prepare a VDO device to exit read-only mode
 .B vdoforcerebuild
 forces an existing VDO device to exit read-only
 mode and to attempt to regenerate as much metadata as possible.
+.PP
+.I filename
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
+Since \fBlvchange\fP(8) will only mount that as read-only, a writable version
+of that device must be manually created, as shown in the example below.
+.PP
 .SH OPTIONS
 .TP
-.I filename
-The name of the file or block device to be updated.
+.B \-\-help
+Print this help message and exit.
+.TP
+.B \-\-version
+Show the version of vdoforcerebuild.
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# dmsetup table vdo1-vdo0pool_vdata > vdata.table
+# lvchange -an vdo1/vdo0pool_vdata
+# dmsetup create vdo1-vdo0pool_vdata --table "`cat vdata.table`"
+# vdoforcerebuild /dev/mapper/vdo1-vdo0pool_vdata
+# dmsetup remove vdo1-vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8),
+.BR dmsetup (8)
diff --git a/utils/vdo/man/vdolistmetadata.8 b/utils/vdo/man/vdolistmetadata.8
@@ -1,4 +1,4 @@
-.TH VDOLISTMETADATA 8 "2020-05-12" "Red Hat" \" -*- nroff -*-
+.TH VDOLISTMETADATA 8 "2023-03-28" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdolistmetadata \- list the metadata regions on a VDO device
 .SH SYNOPSIS
@@ -14,6 +14,9 @@ Each range is on a separate line of the form:
 Both endpoints are included in the range, and are the zero-based
 indexes of 4KB VDO metadata blocks on the backing device.
 
+.PP
+.I filename
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
 .SH OPTIONS
 .TP
 .B \-\-help
@@ -22,5 +25,12 @@ Print this help message and exit.
 .B \-\-version
 Show the version of vdolistmetadata.
 .
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# vdolistmetadata /dev/mapper/vdo1-vdo0pool_vdata
+# lvchange -an vdo1/vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8)
diff --git a/utils/vdo/man/vdoreadonly.8 b/utils/vdo/man/vdoreadonly.8
@@ -1,4 +1,4 @@
-.TH VDOREADONLY 8 "2020-05-13" "Red Hat" \" -*- nroff -*-
+.TH VDOREADONLY 8 "2023-04-14" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdoreadonly \- puts a VDO device into read-only mode
 .SH SYNOPSIS
@@ -7,6 +7,12 @@ vdoreadonly \- puts a VDO device into read-only mode
 .SH DESCRIPTION
 .B vdoreadonly
 forces an existing VDO device into read-only mode.
+.PP
+.I filename
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
+Since \fBlvchange\fP(8) will only mount that as read-only, a writable version
+of that device must be manually created, as shown in the example below.
+.PP
 .SH OPTIONS
 .TP
 .B \-\-help
@@ -15,5 +21,16 @@ Print this help message and exit.
 .B \-\-version
 Show the version of vdoreadonly.
 .
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# dmsetup table vdo1-vdo0pool_vdata > vdata.table
+# lvchange -an vdo1/vdo0pool_vdata
+# dmsetup create vdo1-vdo0pool_vdata --table "`cat vdata.table`"
+# vdoreadonly /dev/mapper/vdo1-vdo0pool_vdata
+# dmsetup remove vdo1-vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8),
+.BR dmsetup (8)
diff --git a/utils/vdo/man/vdoregenerategeometry.8 b/utils/vdo/man/vdoregenerategeometry.8
@@ -1,4 +1,4 @@
-.TH VDOREGENERATEGEOMETRY 8 "2020-05-09" "Red Hat" \" -*- nroff -*-
+.TH VDOREGENERATEGEOMETRY 8 "2023-04-14" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdoregenerategeometry \- regenerate a VDO whose first few blocks have been wiped
 .SH SYNOPSIS
@@ -12,6 +12,11 @@ the beginning of the backing store was wiped. This tool will fail if enough of
 the device was wiped that the VDO super block was also erased, or if there are
 multiple valid super block candidates on the volume.
 .PP
+.I filename
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
+Since \fBlvchange\fP(8) will only mount that as read-only, a writable version
+of that device must be manually created, as shown in the example below.
+.PP
 If the super block location is known, or to select one of the candidate
 super blocks in the event that multiple candidates were found, the
 .B \-\-offset
@@ -28,7 +33,16 @@ Specify the location (in bytes) of the super block.
 .B \-\-version
 Show the version of vdoregenerategeometry.
 .
-.\" .SH EXAMPLES
-.\" .SH NOTES
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# dmsetup table vdo1-vdo0pool_vdata > vdata.table
+# lvchange -an vdo1/vdo0pool_vdata
+# dmsetup create vdo1-vdo0pool_vdata --table "`cat vdata.table`"
+# vdoregenerategeometry /dev/mapper/vdo1-vdo0pool_vdata
+# dmsetup remove vdo1-vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8),
+.BR dmsetup (8)
diff --git a/utils/vdo/man/vdosetuuid.8 b/utils/vdo/man/vdosetuuid.8
@@ -1,4 +1,4 @@
-.TH VDOSETUUID 8 "2019-09-12" "Red Hat" \" -*- nroff -*-
+.TH VDOSETUUID 8 "2023-04-10" "Red Hat" \" -*- nroff -*-
 .SH NAME
 vdosetuuid \- sets a new uuid for the vdo volume stored on a backing
 store
@@ -10,7 +10,12 @@ store
 .B vdosetuuid
 sets a new uuid for the VDO volume stored on the 
 .I vdoBacking
-device, whether the volume is running or not.
+device.
+.PP
+.I vdoBacking
+must be the path of the VDODataLV as described in \fBlvmvdo\fP(7).
+Since \fBlvchange\fP(8) will only mount that as read-only, a writable version
+of that device must be manually created, as shown in the example below.
 .PP
 .SH OPTIONS
 .TP
@@ -23,5 +28,16 @@ specified, the uuid is randomly generated.
 .TP
 .B \-\-version
 Show the version of vdosetuuid.
+.SH EXAMPLE
+.nf
+# lvchange -ay vdo1/vdo0pool_vdata
+# dmsetup table vdo1-vdo0pool_vdata > vdata.table
+# lvchange -an vdo1/vdo0pool_vdata
+# dmsetup create vdo1-vdo0pool_vdata --table "`cat vdata.table`"
+# vdosetuuid --uuid 6ecb9db8-[...] /dev/mapper/vdo1-vdo0pool_vdata
+# dmsetup remove vdo1-vdo0pool_vdata
+.fi
 .SH SEE ALSO
-.BR vdo (8).
+.BR lvmvdo (7),
+.BR lvchange (8),
+.BR dmsetup (8)
diff --git a/utils/vdo/messageStatsReader.c b/utils/vdo/messageStatsReader.c
@@ -620,6 +620,16 @@ static int read_hash_lock_statistics(char **buf,
 	if (result != VDO_SUCCESS) {
 		return result;
 	}
+	/** Current number of dedupe queries that are in flight */
+	result = skip_string(buf, "currDedupeQueries : ");
+	if (result != VDO_SUCCESS) {
+		return result;
+	}
+	result = read_uint32_t(buf,
+			       &stats->curr_dedupe_queries);
+	if (result != VDO_SUCCESS) {
+		return result;
+	}
 	return VDO_SUCCESS;
 }
 
@@ -836,26 +846,6 @@ static int read_index_statistics(char **buf,
 	if (result != VDO_SUCCESS) {
 		return result;
 	}
-	/** Current number of dedupe queries that are in flight */
-	result = skip_string(buf, "currDedupeQueries : ");
-	if (result != VDO_SUCCESS) {
-		return result;
-	}
-	result = read_uint32_t(buf,
-			       &stats->curr_dedupe_queries);
-	if (result != VDO_SUCCESS) {
-		return result;
-	}
-	/** Maximum number of dedupe queries that have been in flight */
-	result = skip_string(buf, "maxDedupeQueries : ");
-	if (result != VDO_SUCCESS) {
-		return result;
-	}
-	result = read_uint32_t(buf,
-			       &stats->max_dedupe_queries);
-	if (result != VDO_SUCCESS) {
-		return result;
-	}
 	return VDO_SUCCESS;
 }
 

diff --git a/utils/vdo/statistics.h b/utils/vdo/statistics.h
@@ -25,7 +25,7 @@
 #include "types.h"
 
 enum {
-	STATISTICS_VERSION = 34,
+	STATISTICS_VERSION = 35,
 };
 
 struct block_allocator_statistics {
@@ -155,6 +155,8 @@ struct hash_lock_statistics {
 	uint64_t concurrent_data_matches;
 	/** Number of writes whose hash collided with an in-flight write */
 	uint64_t concurrent_hash_collisions;
+	/** Current number of dedupe queries that are in flight */
+	uint32_t curr_dedupe_queries;
 };
 
 /** Counts of error conditions in VDO. */
@@ -205,10 +207,6 @@ struct index_statistics {
 	uint64_t updates_found;
 	/** Number of update calls that added a new entry */
 	uint64_t updates_not_found;
-	/** Current number of dedupe queries that are in flight */
-	uint32_t curr_dedupe_queries;
-	/** Maximum number of dedupe queries that have been in flight */
-	uint32_t max_dedupe_queries;
 };
 
 /** The statistics of the vdo service. */