[linux-block.git] / fs / btrfs / send.h

/* SPDX-License-Identifier: GPL-2.0 */
/*
 * Copyright (C) 2012 Alexander Block.  All rights reserved.
 * Copyright (C) 2012 STRATO.  All rights reserved.
 */

#ifndef BTRFS_SEND_H
#define BTRFS_SEND_H

#include <linux/types.h>

#define BTRFS_SEND_STREAM_MAGIC "btrfs-stream"
/* Conditional support for the upcoming protocol version. */
#ifdef CONFIG_BTRFS_DEBUG
#define BTRFS_SEND_STREAM_VERSION 3
#else
#define BTRFS_SEND_STREAM_VERSION 2
#endif

/*
 * In send stream v1, no command is larger than 64K. In send stream v2, no
 * limit should be assumed, the buffer size is set to be a header with
 * compressed extent size.
 */
#define BTRFS_SEND_BUF_SIZE_V1				SZ_64K
#define BTRFS_SEND_BUF_SIZE_V2	ALIGN(SZ_16K + BTRFS_MAX_COMPRESSED, PAGE_SIZE)

struct inode;
struct btrfs_ioctl_send_args;

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_FILEATTR		= 24,
	BTRFS_SEND_C_ENCODED_WRITE	= 25,
	BTRFS_SEND_C_MAX_V2		= 25,

	/* Version 3 */
	BTRFS_SEND_C_ENABLE_VERITY	= 26,
	BTRFS_SEND_C_MAX_V3		= 26,
	/* End */
	BTRFS_SEND_C_MAX		= 26,
};

/* 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,

	/*
	 * File attributes from the FS_*_FL namespace (i_flags, xflags),
	 * translated to BTRFS_INODE_* bits (BTRFS_INODE_FLAG_MASK) and stored
	 * in btrfs_inode_item::flags (represented by btrfs_inode::flags and
	 * btrfs_inode::ro_flags).
	 */
	BTRFS_SEND_A_FILEATTR		= 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,

	/* Version 3 */
	BTRFS_SEND_A_VERITY_ALGORITHM	= 32,
	BTRFS_SEND_A_VERITY_BLOCK_SIZE	= 33,
	BTRFS_SEND_A_VERITY_SALT_DATA	= 34,
	BTRFS_SEND_A_VERITY_SIG_DATA	= 35,
	BTRFS_SEND_A_MAX_V3		= 35,

	__BTRFS_SEND_A_MAX		= 35,
};

long btrfs_ioctl_send(struct inode *inode, struct btrfs_ioctl_send_args *arg);

#endif
Commit	Line	Data
9888c340	1	/* SPDX-License-Identifier: GPL-2.0 */
31db9f7c AB	2	/*
	3	* Copyright (C) 2012 Alexander Block. All rights reserved.
	4	* Copyright (C) 2012 STRATO. All rights reserved.
31db9f7c AB	5	*/
31db9f7c AB	6
9888c340 DS	7	#ifndef BTRFS_SEND_H
	8	#define BTRFS_SEND_H
	9
8234d3f6	10	#include <linux/types.h>
31db9f7c AB	11
31db9f7c AB	12	#define BTRFS_SEND_STREAM_MAGIC "btrfs-stream"
9971a741 BB	13	/* Conditional support for the upcoming protocol version. */
	14	#ifdef CONFIG_BTRFS_DEBUG
	15	#define BTRFS_SEND_STREAM_VERSION 3
	16	#else
d6815592	17	#define BTRFS_SEND_STREAM_VERSION 2
9971a741	18	#endif
31db9f7c	19
b7c14f23	20	/*
875c627c WY	21	* In send stream v1, no command is larger than 64K. In send stream v2, no
	22	* limit should be assumed, the buffer size is set to be a header with
	23	* compressed extent size.
b7c14f23 OS	24	*/
b7c14f23 OS	25	#define BTRFS_SEND_BUF_SIZE_V1 SZ_64K
875c627c	26	#define BTRFS_SEND_BUF_SIZE_V2 ALIGN(SZ_16K + BTRFS_MAX_COMPRESSED, PAGE_SIZE)
31db9f7c	27
8234d3f6 DS	28	struct inode;
	29	struct btrfs_ioctl_send_args;
	30
31db9f7c AB	31	enum btrfs_tlv_type {
	32	BTRFS_TLV_U8,
	33	BTRFS_TLV_U16,
	34	BTRFS_TLV_U32,
	35	BTRFS_TLV_U64,
	36	BTRFS_TLV_BINARY,
	37	BTRFS_TLV_STRING,
	38	BTRFS_TLV_UUID,
	39	BTRFS_TLV_TIMESPEC,
	40	};
	41
	42	struct btrfs_stream_header {
	43	char magic[sizeof(BTRFS_SEND_STREAM_MAGIC)];
	44	__le32 version;
	45	} __attribute__ ((__packed__));
	46
	47	struct btrfs_cmd_header {
	48	/* len excluding the header */
	49	__le32 len;
	50	__le16 cmd;
	51	/* crc including the header with zero crc field */
	52	__le32 crc;
	53	} __attribute__ ((__packed__));
	54
	55	struct btrfs_tlv_header {
	56	__le16 tlv_type;
	57	/* len excluding the header */
	58	__le16 tlv_len;
	59	} __attribute__ ((__packed__));
	60
	61	/* commands */
	62	enum btrfs_send_cmd {
54cab6af	63	BTRFS_SEND_C_UNSPEC = 0,
31db9f7c	64
e77fbf99	65	/* Version 1 */
54cab6af OS	66	BTRFS_SEND_C_SUBVOL = 1,
54cab6af OS	67	BTRFS_SEND_C_SNAPSHOT = 2,
31db9f7c	68
54cab6af OS	69	BTRFS_SEND_C_MKFILE = 3,
	70	BTRFS_SEND_C_MKDIR = 4,
	71	BTRFS_SEND_C_MKNOD = 5,
	72	BTRFS_SEND_C_MKFIFO = 6,
	73	BTRFS_SEND_C_MKSOCK = 7,
	74	BTRFS_SEND_C_SYMLINK = 8,
31db9f7c	75
54cab6af OS	76	BTRFS_SEND_C_RENAME = 9,
	77	BTRFS_SEND_C_LINK = 10,
	78	BTRFS_SEND_C_UNLINK = 11,
	79	BTRFS_SEND_C_RMDIR = 12,
31db9f7c	80
54cab6af OS	81	BTRFS_SEND_C_SET_XATTR = 13,
54cab6af OS	82	BTRFS_SEND_C_REMOVE_XATTR = 14,
31db9f7c	83
54cab6af OS	84	BTRFS_SEND_C_WRITE = 15,
54cab6af OS	85	BTRFS_SEND_C_CLONE = 16,
31db9f7c	86
54cab6af OS	87	BTRFS_SEND_C_TRUNCATE = 17,
	88	BTRFS_SEND_C_CHMOD = 18,
	89	BTRFS_SEND_C_CHOWN = 19,
	90	BTRFS_SEND_C_UTIMES = 20,
31db9f7c	91
54cab6af OS	92	BTRFS_SEND_C_END = 21,
	93	BTRFS_SEND_C_UPDATE_EXTENT = 22,
	94	BTRFS_SEND_C_MAX_V1 = 22,
e77fbf99 DS	95
e77fbf99 DS	96	/* Version 2 */
b7c14f23	97	BTRFS_SEND_C_FALLOCATE = 23,
48247359	98	BTRFS_SEND_C_FILEATTR = 24,
b7c14f23 OS	99	BTRFS_SEND_C_ENCODED_WRITE = 25,
b7c14f23 OS	100	BTRFS_SEND_C_MAX_V2 = 25,
e77fbf99	101
38622010 BB	102	/* Version 3 */
	103	BTRFS_SEND_C_ENABLE_VERITY = 26,
	104	BTRFS_SEND_C_MAX_V3 = 26,
e77fbf99	105	/* End */
38622010	106	BTRFS_SEND_C_MAX = 26,
31db9f7c	107	};
31db9f7c AB	108
	109	/* attributes in send stream */
	110	enum {
54cab6af OS	111	BTRFS_SEND_A_UNSPEC = 0,
54cab6af OS	112
b7c14f23	113	/* Version 1 */
54cab6af OS	114	BTRFS_SEND_A_UUID = 1,
	115	BTRFS_SEND_A_CTRANSID = 2,
	116
	117	BTRFS_SEND_A_INO = 3,
	118	BTRFS_SEND_A_SIZE = 4,
	119	BTRFS_SEND_A_MODE = 5,
	120	BTRFS_SEND_A_UID = 6,
	121	BTRFS_SEND_A_GID = 7,
	122	BTRFS_SEND_A_RDEV = 8,
	123	BTRFS_SEND_A_CTIME = 9,
	124	BTRFS_SEND_A_MTIME = 10,
	125	BTRFS_SEND_A_ATIME = 11,
	126	BTRFS_SEND_A_OTIME = 12,
	127
	128	BTRFS_SEND_A_XATTR_NAME = 13,
	129	BTRFS_SEND_A_XATTR_DATA = 14,
	130
	131	BTRFS_SEND_A_PATH = 15,
	132	BTRFS_SEND_A_PATH_TO = 16,
	133	BTRFS_SEND_A_PATH_LINK = 17,
	134
	135	BTRFS_SEND_A_FILE_OFFSET = 18,
b7c14f23 OS	136	/*
	137	* As of send stream v2, this attribute is special: it must be the last
	138	* attribute in a command, its header contains only the type, and its
	139	* length is implicitly the remaining length of the command.
	140	*/
54cab6af OS	141	BTRFS_SEND_A_DATA = 19,
	142
	143	BTRFS_SEND_A_CLONE_UUID = 20,
	144	BTRFS_SEND_A_CLONE_CTRANSID = 21,
	145	BTRFS_SEND_A_CLONE_PATH = 22,
	146	BTRFS_SEND_A_CLONE_OFFSET = 23,
	147	BTRFS_SEND_A_CLONE_LEN = 24,
	148
b7c14f23 OS	149	BTRFS_SEND_A_MAX_V1 = 24,
	150
	151	/* Version 2 */
	152	BTRFS_SEND_A_FALLOCATE_MODE = 25,
	153
48247359 DS	154	/*
	155	* File attributes from the FS_*_FL namespace (i_flags, xflags),
	156	* translated to BTRFS_INODE_* bits (BTRFS_INODE_FLAG_MASK) and stored
	157	* in btrfs_inode_item::flags (represented by btrfs_inode::flags and
	158	* btrfs_inode::ro_flags).
	159	*/
	160	BTRFS_SEND_A_FILEATTR = 26,
b7c14f23 OS	161
	162	BTRFS_SEND_A_UNENCODED_FILE_LEN = 27,
	163	BTRFS_SEND_A_UNENCODED_LEN = 28,
	164	BTRFS_SEND_A_UNENCODED_OFFSET = 29,
	165	/*
	166	* COMPRESSION and ENCRYPTION default to NONE (0) if omitted from
	167	* BTRFS_SEND_C_ENCODED_WRITE.
	168	*/
	169	BTRFS_SEND_A_COMPRESSION = 30,
	170	BTRFS_SEND_A_ENCRYPTION = 31,
	171	BTRFS_SEND_A_MAX_V2 = 31,
	172
38622010 BB	173	/* Version 3 */
	174	BTRFS_SEND_A_VERITY_ALGORITHM = 32,
	175	BTRFS_SEND_A_VERITY_BLOCK_SIZE = 33,
	176	BTRFS_SEND_A_VERITY_SALT_DATA = 34,
	177	BTRFS_SEND_A_VERITY_SIG_DATA = 35,
	178	BTRFS_SEND_A_MAX_V3 = 35,
	179
	180	__BTRFS_SEND_A_MAX = 35,
31db9f7c	181	};
31db9f7c	182
9ad12305	183	long btrfs_ioctl_send(struct inode inode, struct btrfs_ioctl_send_args arg);
9888c340 DS	184
9888c340 DS	185	#endif