Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support to decode a resume token
Browse files Browse the repository at this point in the history
Adding a new subcommand to zstream called token. This
now allows users to decode a resume token to retrieve the toname
field. This can be useful for tools that need this information.
The syntax works as follows zstream token <resume_token>.

Reviewed-by: Matt Ahrens <[email protected]>
Reviewed-by: Brian Behlendorf <[email protected]>
Reviewed-by: Paul Zuchowski <[email protected]>
Signed-off-by: Tony Perkins <[email protected]>
Closes openzfs#10558
tony-zfs authored and RageLtMan committed May 31, 2021
1 parent 8302a11 commit 38c525e
Showing 7 changed files with 127 additions and 1 deletion.
3 changes: 2 additions & 1 deletion cmd/zstream/Makefile.am
Original file line number Diff line number Diff line change
@@ -6,7 +6,8 @@ zstream_SOURCES = \
zstream.c \
zstream.h \
zstream_dump.c \
zstream_redup.c
zstream_redup.c \
zstream_token.c

zstream_LDADD = \
$(abs_top_builddir)/lib/libzfs/libzfs.la \
5 changes: 5 additions & 0 deletions cmd/zstream/zstream.c
Original file line number Diff line number Diff line change
@@ -15,6 +15,7 @@

/*
* Copyright (c) 2020 by Delphix. All rights reserved.
* Copyright (c) 2020 by Datto Inc. All rights reserved.
*/
#include <sys/types.h>
#include <sys/stat.h>
@@ -39,6 +40,8 @@ zstream_usage(void)
"\tzstream dump [-vCd] FILE\n"
"\t... | zstream dump [-vCd]\n"
"\n"
"\tzstream token resume_token\n"
"\n"
"\tzstream redup [-v] FILE | ...\n");
exit(1);
}
@@ -53,6 +56,8 @@ main(int argc, char *argv[])

if (strcmp(subcommand, "dump") == 0) {
return (zstream_do_dump(argc - 1, argv + 1));
} else if (strcmp(subcommand, "token") == 0) {
return (zstream_do_token(argc - 1, argv + 1));
} else if (strcmp(subcommand, "redup") == 0) {
return (zstream_do_redup(argc - 1, argv + 1));
} else {
1 change: 1 addition & 0 deletions cmd/zstream/zstream.h
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@ extern "C" {

extern int zstream_do_redup(int, char *[]);
extern int zstream_do_dump(int, char *[]);
extern int zstream_do_token(int, char *[]);
extern void zstream_usage(void);

#ifdef __cplusplus
78 changes: 78 additions & 0 deletions cmd/zstream/zstream_token.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License (the "License").
* You may not use this file except in compliance with the License.
*
* You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
* or http://www.opensolaris.org/os/licensing.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at usr/src/OPENSOLARIS.LICENSE.
* If applicable, add the following below this CDDL HEADER, with the
* fields enclosed by brackets "[]" replaced with your own identifying
* information: Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*/

/*
* Copyright 2010 Sun Microsystems, Inc. All rights reserved.
* Use is subject to license terms.
*
* Portions Copyright 2012 Martin Matuska <[email protected]>
*/

/*
* Copyright (c) 2020 by Datto Inc. All rights reserved.
*/

#include <ctype.h>
#include <libnvpair.h>
#include <stdio.h>
#include <stdlib.h>
#include <strings.h>
#include <unistd.h>
#include <stddef.h>

#include <libzfs.h>
#include <libzfs_core.h>

#include <sys/dmu.h>
#include <sys/zfs_ioctl.h>
#include "zstream.h"

int
zstream_do_token(int argc, char *argv[])
{
char *resume_token = NULL;

if (argc < 2) {
(void) fprintf(stderr, "Need to pass the resume token\n");
zstream_usage();
}

resume_token = argv[1];

libzfs_handle_t *hdl = libzfs_init();

nvlist_t *resume_nvl =
zfs_send_resume_token_to_nvlist(hdl, resume_token);

if (resume_nvl == NULL) {
(void) fprintf(stderr,
"Unable to parse resume token: %s\n",
libzfs_error_description(hdl));
libzfs_fini(hdl);
return (1);
}

dump_nvlist(resume_nvl, 5);
nvlist_free(resume_nvl);

libzfs_fini(hdl);
return (0);
}
9 changes: 9 additions & 0 deletions man/man8/zstream.8
Original file line number Diff line number Diff line change
@@ -35,6 +35,9 @@
.Cm redup
.Op Fl v
.Ar file
.Nm
.Cm token
.Ar resume_token
.Sh DESCRIPTION
.sp
.LP
@@ -67,6 +70,12 @@ Implies verbose.
.El
.It Xo
.Nm
.Cm token
.Ar resume_token
.Xc
Dumps zfs resume token information
.It Xo
.Nm
.Cm redup
.Op Fl v
.Ar file
16 changes: 16 additions & 0 deletions tests/zfs-tests/tests/functional/rsend/rsend.kshlib
Original file line number Diff line number Diff line change
@@ -26,6 +26,7 @@

#
# Copyright (c) 2013, 2018 by Delphix. All rights reserved.
# Copyright (c) 2020 by Datto Inc. All rights reserved.
#

. $STF_SUITE/include/libtest.shlib
@@ -657,6 +658,21 @@ function resume_test
log_must zfs recv -suv $recvfs </$streamfs/$stream_num
}

function get_resume_token
{
sendcmd=$1
streamfs=$2
recvfs=$3

log_must eval "$sendcmd > /$streamfs/1"
mess_send_file /$streamfs/1
log_mustnot zfs recv -suv $recvfs < /$streamfs/1 2>&1
token=$(zfs get -Hp -o value receive_resume_token $recvfs)
echo "$token" > /$streamfs/resume_token

return 0
}

#
# Setup filesystems for the resumable send/receive tests
#
16 changes: 16 additions & 0 deletions tests/zfs-tests/tests/functional/rsend/send-c_zstreamdump.ksh
Original file line number Diff line number Diff line change
@@ -13,6 +13,7 @@

#
# Copyright (c) 2015 by Delphix. All rights reserved.
# Copyright (c) 2020 by Datto, Inc. All rights reserved.
#

. $STF_SUITE/tests/functional/rsend/rsend.kshlib
@@ -26,6 +27,9 @@
# 1. Create a full compressed send stream
# 2. Verify zstreamdump shows this stream has the relevant features
# 3. Verify zstreamdump's accounting of logical and compressed size is correct
# 4. Verify the toname from a resume token
# 5. Verify it fails with corrupted resume token
# 6. Verify it fails with missing resume token
#

verify_runnable "both"
@@ -34,8 +38,11 @@ log_assert "Verify zstreamdump correctly interprets compressed send streams."
log_onexit cleanup_pool $POOL2

typeset sendfs=$POOL2/fs
typeset streamfs=$POOL2/fs2
typeset recvfs=$POOL2/fs3

log_must zfs create -o compress=lz4 $sendfs
log_must zfs create -o compress=lz4 $streamfs
typeset dir=$(get_prop mountpoint $sendfs)
write_compressible $dir 16m
log_must zfs snapshot $sendfs@full
@@ -56,4 +63,13 @@ csize_prop=$(get_prop used $sendfs)
within_percent $csize $csize_prop 90 || log_fail \
"$csize and $csize_prop differed by too much"

x=$(get_resume_token "zfs send -c $sendfs@full" $streamfs $recvfs)
resume_token=$(cat /$streamfs/resume_token)
to_name_fs=$sendfs
log_must eval "zstream token $resume_token | grep $to_name_fs"

bad_resume_token="1-1162e8285b-100789c6360"
log_mustnot eval "zstream token $bad_resume_token 2>&1"
log_mustnot eval "zstream token 2>&1"

log_pass "zstreamdump correctly interprets compressed send streams."

0 comments on commit 38c525e

Please sign in to comment.