diff mbox series

[V2,1/2] metadump.asciidoc: Add description for version v1's mb_info field

Message ID 20231108083228.1278837-2-chandan.babu@oracle.com (mailing list archive)
State New
Headers show
Series xfsdocs: Describe Metadump V2's ondisk format structure | expand

Commit Message

Chandan Babu R Nov. 8, 2023, 8:32 a.m. UTC
mb_reserved has been replaced with mb_info in upstream xfsprogs. This commit
adds description for valid bits of mb_info field.

Signed-off-by: Chandan Babu R <chandan.babu@oracle.com>
---
 .../metadump.asciidoc                         | 23 ++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

Comments

Darrick J. Wong Nov. 8, 2023, 4:26 p.m. UTC | #1
On Wed, Nov 08, 2023 at 02:02:27PM +0530, Chandan Babu R wrote:
> mb_reserved has been replaced with mb_info in upstream xfsprogs. This commit
> adds description for valid bits of mb_info field.
> 
> Signed-off-by: Chandan Babu R <chandan.babu@oracle.com>

Looks good,
Reviewed-by: Darrick J. Wong <djwong@kernel.org>

--D

> ---
>  .../metadump.asciidoc                         | 23 ++++++++++++++++---
>  1 file changed, 20 insertions(+), 3 deletions(-)
> 
> diff --git a/design/XFS_Filesystem_Structure/metadump.asciidoc b/design/XFS_Filesystem_Structure/metadump.asciidoc
> index 2bddb77..2f35b7e 100644
> --- a/design/XFS_Filesystem_Structure/metadump.asciidoc
> +++ b/design/XFS_Filesystem_Structure/metadump.asciidoc
> @@ -21,7 +21,7 @@ struct xfs_metablock {
>  	__be32		mb_magic;
>  	__be16		mb_count;
>  	uint8_t		mb_blocklog;
> -	uint8_t		mb_reserved;
> +	uint8_t		mb_info;
>  	__be64		mb_daddr[];
>  };
>  ----
> @@ -37,8 +37,25 @@ Number of blocks indexed by this record.  This value must not exceed +(1
>  The log size of a metadump block.  This size of a metadump block 512
>  bytes, so this value should be 9.
>  
> -*mb_reserved*::
> -Reserved.  Should be zero.
> +*mb_info*::
> +Flags describing a metadata dump.
> +
> +[options="header"]
> +|=====
> +| Flag				| Description
> +| +XFS_METADUMP_INFO_FLAGS+ |
> +The remaining bits in this field are valid.
> +
> +| +XFS_METADUMP_OBFUSCATED+ |
> +File names and extended attributes have been obfuscated.
> +
> +| +XFS_METADUMP_FULLBLOCKS+ |
> +Metadata blocks have been copied in full i.e. stale bytes have not
> +been zeroed out.
> +
> +| +XFS_METADUMP_DIRTYLOG+ |
> +Log was dirty.
> +|=====
>  
>  *mb_daddr*::
>  An array of disk addresses.  Each of the +mb_count+ blocks (of size +(1
> -- 
> 2.39.1
>
diff mbox series

Patch

diff --git a/design/XFS_Filesystem_Structure/metadump.asciidoc b/design/XFS_Filesystem_Structure/metadump.asciidoc
index 2bddb77..2f35b7e 100644
--- a/design/XFS_Filesystem_Structure/metadump.asciidoc
+++ b/design/XFS_Filesystem_Structure/metadump.asciidoc
@@ -21,7 +21,7 @@  struct xfs_metablock {
 	__be32		mb_magic;
 	__be16		mb_count;
 	uint8_t		mb_blocklog;
-	uint8_t		mb_reserved;
+	uint8_t		mb_info;
 	__be64		mb_daddr[];
 };
 ----
@@ -37,8 +37,25 @@  Number of blocks indexed by this record.  This value must not exceed +(1
 The log size of a metadump block.  This size of a metadump block 512
 bytes, so this value should be 9.
 
-*mb_reserved*::
-Reserved.  Should be zero.
+*mb_info*::
+Flags describing a metadata dump.
+
+[options="header"]
+|=====
+| Flag				| Description
+| +XFS_METADUMP_INFO_FLAGS+ |
+The remaining bits in this field are valid.
+
+| +XFS_METADUMP_OBFUSCATED+ |
+File names and extended attributes have been obfuscated.
+
+| +XFS_METADUMP_FULLBLOCKS+ |
+Metadata blocks have been copied in full i.e. stale bytes have not
+been zeroed out.
+
+| +XFS_METADUMP_DIRTYLOG+ |
+Log was dirty.
+|=====
 
 *mb_daddr*::
 An array of disk addresses.  Each of the +mb_count+ blocks (of size +(1