I am sponsoring the following case for Lori Alt. Requested binding is
micro/patch. The case introduces a new command, zstreamdump, which is
used to dump the metadata in a zfs send stream (i.e., the output of a
'zfs send' command). It will also verify the checksums in the send
stream.
Given the straight-forwardness of the case I believe it
qualifies for self-review. If others disagree, let me know and I'll
convert it to a fast-track.
Template Version: @(#)sac_nextcase 1.68 02/23/09 SMI
This information is Copyright 2009 Sun Microsystems
1. Introduction
1.1. Project/Component Working Name:
zstreamdump - send stream dumping utility
1.2. Name of Document Author/Supplier:
Author: Lori Alt
1.3 Date of This Document:
15 September, 2009
4. Technical Description
OVERVIEW:
It is often useful for debugging purposes to examine the record headers
in a zfs send stream. This tool will also identify most cases of send
stream corruption, by verifying the correctness of the record headers
and checksumming the stream contents.
PROPOSED SOLUTION:
A new tool, zstreamdump, is proposed for this purpose. The utility
reads a send stream from stdin and prints some of the metadata from each
record header (more is printed in verbose mode) to stdout. If the -C
option is not specified, the checksum of each embedded dataset stream is
verified. The draft man page for this tool is supplied below.
DRAFT MAN PAGE
System Administration Commands zstreamdump(1M)
NAME
zstreamdump - dump the metadata in a ZFS send stream
SYNOPSIS
zstreamdump [-vC]
DESCRIPTION
The zstreamdump command reads a ZFS send stream from stdin and
prints out selected fields from the metadata to stdout. By
default, it also validates the checksums for each of the dataset
streams embedded in the overall send stream. A summary of the
stream contents is printed at the end.
OPTIONS
The following options are supported:
-v Verbose mode. All records are dumped. Default is to
only dump the metadata from the BEGIN and END records.
-C Suppress the validation of checksums. Causes the tool to
run faster.
EXIT STATUS
The following exit values are returned:
0 The stream is consistent.
1 An error was detected.
ATTRIBUTES
See attributes(5) for descriptions of the following attributes:
____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | SUNWzfsu |
|_____________________________|_____________________________|
| Interface Stability | Uncommitted |
|_____________________________|_____________________________|
6. Resources and Schedule
6.4. Steering Committee requested information
6.4.1. Consolidation C-team Name:
ON
6.5. ARC review type: Automatic
6.6. ARC Exposure: open
