mirror of
https://github.com/kdave/btrfs-progs
synced 2025-02-17 18:26:55 +00:00
0ee5b22345
First, add a --proto option to allow specifying the desired send protocol version. It defaults to one, the original version. In a couple of releases once people are aware that protocol revisions are happening, we can change it to default to zero, which means the latest version supported by the kernel. This is based on Dave Sterba's patch. Also add a --compressed-data flag to instruct the kernel to use encoded_write commands for compressed extents. This requires an explicit opt in separate from the protocol version because: 1. The user may not want compression on the receiving side, or may want a different compression algorithm/level on the receiving side. 2. It has a soft requirement for kernel support on the receiving side (btrfs-progs can fall back to decompressing and writing if the kernel doesn't support BTRFS_IOC_ENCODED_WRITE, but the user may not be prepared to pay that CPU cost). Going forward, since it's easier to update progs than the kernel, I think we'll want to make new send features that require kernel support opt-in, whereas anything that only requires a progs update can happen automatically. Signed-off-by: Boris Burkov <boris@bur.io> Signed-off-by: Omar Sandoval <osandov@fb.com> Signed-off-by: David Sterba <dsterba@suse.com>
172 lines
4.0 KiB
C
172 lines
4.0 KiB
C
/*
|
|
* Copyright (C) 2012 Alexander Block. All rights reserved.
|
|
* Copyright (C) 2012 STRATO. All rights reserved.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public
|
|
* License v2 as published by the Free Software Foundation.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public
|
|
* License along with this program; if not, write to the
|
|
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
|
|
* Boston, MA 021110-1307, USA.
|
|
*/
|
|
|
|
#ifndef __BTRFS_SEND_H__
|
|
#define __BTRFS_SEND_H__
|
|
|
|
#include "kernel-shared/ctree.h"
|
|
|
|
#define BTRFS_SEND_STREAM_MAGIC "btrfs-stream"
|
|
#define BTRFS_SEND_STREAM_VERSION 2
|
|
|
|
/*
|
|
* In send stream v1, no command is larger than 64KiB. In send stream v2, no limit
|
|
* should be assumed.
|
|
*/
|
|
#define BTRFS_SEND_BUF_SIZE_V1 (64 * 1024)
|
|
|
|
enum btrfs_tlv_type {
|
|
BTRFS_TLV_U8,
|
|
BTRFS_TLV_U16,
|
|
BTRFS_TLV_U32,
|
|
BTRFS_TLV_U64,
|
|
BTRFS_TLV_BINARY,
|
|
BTRFS_TLV_STRING,
|
|
BTRFS_TLV_UUID,
|
|
BTRFS_TLV_TIMESPEC,
|
|
};
|
|
|
|
struct btrfs_stream_header {
|
|
char magic[sizeof(BTRFS_SEND_STREAM_MAGIC)];
|
|
__le32 version;
|
|
} __attribute__ ((__packed__));
|
|
|
|
struct btrfs_cmd_header {
|
|
/* len excluding the header */
|
|
__le32 len;
|
|
__le16 cmd;
|
|
/* crc including the header with zero crc field */
|
|
__le32 crc;
|
|
} __attribute__ ((__packed__));
|
|
|
|
struct btrfs_tlv_header {
|
|
__le16 tlv_type;
|
|
/* len excluding the header */
|
|
__le16 tlv_len;
|
|
} __attribute__ ((__packed__));
|
|
|
|
/* commands */
|
|
enum btrfs_send_cmd {
|
|
BTRFS_SEND_C_UNSPEC = 0,
|
|
|
|
/* Version 1 */
|
|
BTRFS_SEND_C_SUBVOL = 1,
|
|
BTRFS_SEND_C_SNAPSHOT = 2,
|
|
|
|
BTRFS_SEND_C_MKFILE = 3,
|
|
BTRFS_SEND_C_MKDIR = 4,
|
|
BTRFS_SEND_C_MKNOD = 5,
|
|
BTRFS_SEND_C_MKFIFO = 6,
|
|
BTRFS_SEND_C_MKSOCK = 7,
|
|
BTRFS_SEND_C_SYMLINK = 8,
|
|
|
|
BTRFS_SEND_C_RENAME = 9,
|
|
BTRFS_SEND_C_LINK = 10,
|
|
BTRFS_SEND_C_UNLINK = 11,
|
|
BTRFS_SEND_C_RMDIR = 12,
|
|
|
|
BTRFS_SEND_C_SET_XATTR = 13,
|
|
BTRFS_SEND_C_REMOVE_XATTR = 14,
|
|
|
|
BTRFS_SEND_C_WRITE = 15,
|
|
BTRFS_SEND_C_CLONE = 16,
|
|
|
|
BTRFS_SEND_C_TRUNCATE = 17,
|
|
BTRFS_SEND_C_CHMOD = 18,
|
|
BTRFS_SEND_C_CHOWN = 19,
|
|
BTRFS_SEND_C_UTIMES = 20,
|
|
|
|
BTRFS_SEND_C_END = 21,
|
|
BTRFS_SEND_C_UPDATE_EXTENT = 22,
|
|
BTRFS_SEND_C_MAX_V1 = 22,
|
|
|
|
/* Version 2 */
|
|
BTRFS_SEND_C_FALLOCATE = 23,
|
|
BTRFS_SEND_C_SETFLAGS = 24,
|
|
BTRFS_SEND_C_ENCODED_WRITE = 25,
|
|
BTRFS_SEND_C_MAX_V2 = 25,
|
|
|
|
/* End */
|
|
BTRFS_SEND_C_MAX = 25,
|
|
};
|
|
|
|
/* attributes in send stream */
|
|
enum {
|
|
BTRFS_SEND_A_UNSPEC = 0,
|
|
|
|
/* Version 1 */
|
|
BTRFS_SEND_A_UUID = 1,
|
|
BTRFS_SEND_A_CTRANSID = 2,
|
|
|
|
BTRFS_SEND_A_INO = 3,
|
|
BTRFS_SEND_A_SIZE = 4,
|
|
BTRFS_SEND_A_MODE = 5,
|
|
BTRFS_SEND_A_UID = 6,
|
|
BTRFS_SEND_A_GID = 7,
|
|
BTRFS_SEND_A_RDEV = 8,
|
|
BTRFS_SEND_A_CTIME = 9,
|
|
BTRFS_SEND_A_MTIME = 10,
|
|
BTRFS_SEND_A_ATIME = 11,
|
|
BTRFS_SEND_A_OTIME = 12,
|
|
|
|
BTRFS_SEND_A_XATTR_NAME = 13,
|
|
BTRFS_SEND_A_XATTR_DATA = 14,
|
|
|
|
BTRFS_SEND_A_PATH = 15,
|
|
BTRFS_SEND_A_PATH_TO = 16,
|
|
BTRFS_SEND_A_PATH_LINK = 17,
|
|
|
|
BTRFS_SEND_A_FILE_OFFSET = 18,
|
|
/*
|
|
* As of send stream v2, this attribute is special: it must be the last
|
|
* attribute in a command, its header contains only the type, and its
|
|
* length is implicitly the remaining length of the command.
|
|
*/
|
|
BTRFS_SEND_A_DATA = 19,
|
|
|
|
BTRFS_SEND_A_CLONE_UUID = 20,
|
|
BTRFS_SEND_A_CLONE_CTRANSID = 21,
|
|
BTRFS_SEND_A_CLONE_PATH = 22,
|
|
BTRFS_SEND_A_CLONE_OFFSET = 23,
|
|
BTRFS_SEND_A_CLONE_LEN = 24,
|
|
|
|
BTRFS_SEND_A_MAX_V1 = 24,
|
|
|
|
/* Version 2 */
|
|
BTRFS_SEND_A_FALLOCATE_MODE = 25,
|
|
|
|
BTRFS_SEND_A_SETFLAGS_FLAGS = 26,
|
|
|
|
BTRFS_SEND_A_UNENCODED_FILE_LEN = 27,
|
|
BTRFS_SEND_A_UNENCODED_LEN = 28,
|
|
BTRFS_SEND_A_UNENCODED_OFFSET = 29,
|
|
/*
|
|
* COMPRESSION and ENCRYPTION default to NONE (0) if omitted from
|
|
* BTRFS_SEND_C_ENCODED_WRITE.
|
|
*/
|
|
BTRFS_SEND_A_COMPRESSION = 30,
|
|
BTRFS_SEND_A_ENCRYPTION = 31,
|
|
BTRFS_SEND_A_MAX_V2 = 31,
|
|
|
|
/* End */
|
|
BTRFS_SEND_A_MAX = 31,
|
|
};
|
|
|
|
#endif
|