[mirror_ubuntu-eoan-kernel.git] / fs / btrfs / ioctl.h


/*
 * Copyright (C) 2007 Oracle.  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 __IOCTL_
#define __IOCTL_
#include <linux/ioctl.h>

#define BTRFS_IOCTL_MAGIC 0x94
#define BTRFS_VOL_NAME_MAX 255
#define BTRFS_PATH_NAME_MAX 4087

/* this should be 4k */
struct btrfs_ioctl_vol_args {
	__s64 fd;
	char name[BTRFS_PATH_NAME_MAX + 1];
};

#define BTRFS_INO_LOOKUP_PATH_MAX 4080
struct btrfs_ioctl_ino_lookup_args {
	__u64 treeid;
	__u64 objectid;
	char name[BTRFS_INO_LOOKUP_PATH_MAX];
};

struct btrfs_ioctl_search_key {
	/* which root are we searching.  0 is the tree of tree roots */
	__u64 tree_id;

	/* keys returned will be >= min and <= max */
	__u64 min_objectid;
	__u64 max_objectid;

	/* keys returned will be >= min and <= max */
	__u64 min_offset;
	__u64 max_offset;

	/* max and min transids to search for */
	__u64 min_transid;
	__u64 max_transid;

	/* keys returned will be >= min and <= max */
	__u32 min_type;
	__u32 max_type;

	/*
	 * how many items did userland ask for, and how many are we
	 * returning
	 */
	__u32 nr_items;

	/* align to 64 bits */
	__u32 unused;

	/* some extra for later */
	__u64 unused1;
	__u64 unused2;
	__u64 unused3;
	__u64 unused4;
};

struct btrfs_ioctl_search_header {
	__u64 transid;
	__u64 objectid;
	__u64 offset;
	__u32 type;
	__u32 len;
};

#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
/*
 * the buf is an array of search headers where
 * each header is followed by the actual item
 * the type field is expanded to 32 bits for alignment
 */
struct btrfs_ioctl_search_args {
	struct btrfs_ioctl_search_key key;
	char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
};

struct btrfs_ioctl_clone_range_args {
  __s64 src_fd;
  __u64 src_offset, src_length;
  __u64 dest_offset;
};

/* flags for the defrag range ioctl */
#define BTRFS_DEFRAG_RANGE_COMPRESS 1
#define BTRFS_DEFRAG_RANGE_START_IO 2

struct btrfs_ioctl_defrag_range_args {
	/* start of the defrag operation */
	__u64 start;

	/* number of bytes to defrag, use (u64)-1 to say all */
	__u64 len;

	/*
	 * flags for the operation, which can include turning
	 * on compression for this one defrag
	 */
	__u64 flags;

	/*
	 * any extent bigger than this will be considered
	 * already defragged.  Use 0 to take the kernel default
	 * Use 1 to say every single extent must be rewritten
	 */
	__u32 extent_thresh;

	/* spare for later */
	__u32 unused[5];
};


#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
				   struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
				   struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
				   struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
				   struct btrfs_ioctl_vol_args)
/* trans start and trans end are dangerous, and only for
 * use by applications that know how to avoid the
 * resulting deadlocks
 */
#define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
#define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
#define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)

#define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
				   struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
				   struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
				   struct btrfs_ioctl_vol_args)

#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
				  struct btrfs_ioctl_clone_range_args)

#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
				   struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
				struct btrfs_ioctl_vol_args)
#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
				struct btrfs_ioctl_defrag_range_args)
#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
				   struct btrfs_ioctl_search_args)
#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
				   struct btrfs_ioctl_ino_lookup_args)
#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
#endif
Commit	Line	Data
6ef5ed0d	1
6cbd5570 CM	2	/*
	3	* Copyright (C) 2007 Oracle. All rights reserved.
	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of the GNU General Public
	7	* License v2 as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	* General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public
	15	* License along with this program; if not, write to the
	16	* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	17	* Boston, MA 021110-1307, USA.
	18	*/
	19
c5739bba CM	20	#ifndef __IOCTL_
	21	#define __IOCTL_
	22	#include <linux/ioctl.h>
	23
	24	#define BTRFS_IOCTL_MAGIC 0x94
	25	#define BTRFS_VOL_NAME_MAX 255
c071fcfd	26	#define BTRFS_PATH_NAME_MAX 4087
8a4b83cc	27
c071fcfd	28	/* this should be 4k */
c5739bba	29	struct btrfs_ioctl_vol_args {
3de4586c	30	__s64 fd;
8a4b83cc	31	char name[BTRFS_PATH_NAME_MAX + 1];
c5739bba CM	32	};
c5739bba CM	33
ac8e9819 CM	34	#define BTRFS_INO_LOOKUP_PATH_MAX 4080
	35	struct btrfs_ioctl_ino_lookup_args {
	36	__u64 treeid;
	37	__u64 objectid;
	38	char name[BTRFS_INO_LOOKUP_PATH_MAX];
	39	};
	40
	41	struct btrfs_ioctl_search_key {
	42	/* which root are we searching. 0 is the tree of tree roots */
	43	__u64 tree_id;
	44
	45	/* keys returned will be >= min and <= max */
	46	__u64 min_objectid;
	47	__u64 max_objectid;
	48
	49	/* keys returned will be >= min and <= max */
	50	__u64 min_offset;
	51	__u64 max_offset;
	52
	53	/* max and min transids to search for */
	54	__u64 min_transid;
	55	__u64 max_transid;
	56
	57	/* keys returned will be >= min and <= max */
	58	__u32 min_type;
	59	__u32 max_type;
	60
	61	/*
	62	* how many items did userland ask for, and how many are we
	63	* returning
	64	*/
	65	__u32 nr_items;
	66
	67	/* align to 64 bits */
	68	__u32 unused;
	69
	70	/* some extra for later */
	71	__u64 unused1;
	72	__u64 unused2;
	73	__u64 unused3;
	74	__u64 unused4;
	75	};
	76
	77	struct btrfs_ioctl_search_header {
	78	__u64 transid;
	79	__u64 objectid;
	80	__u64 offset;
	81	__u32 type;
	82	__u32 len;
	83	};
	84
	85	#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
	86	/*
	87	* the buf is an array of search headers where
	88	* each header is followed by the actual item
	89	* the type field is expanded to 32 bits for alignment
	90	*/
	91	struct btrfs_ioctl_search_args {
	92	struct btrfs_ioctl_search_key key;
	93	char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
	94	};
	95
c071fcfd CM	96	struct btrfs_ioctl_clone_range_args {
	97	__s64 src_fd;
	98	__u64 src_offset, src_length;
	99	__u64 dest_offset;
	100	};
	101
1e701a32 CM	102	/* flags for the defrag range ioctl */
	103	#define BTRFS_DEFRAG_RANGE_COMPRESS 1
	104	#define BTRFS_DEFRAG_RANGE_START_IO 2
	105
	106	struct btrfs_ioctl_defrag_range_args {
	107	/* start of the defrag operation */
	108	__u64 start;
	109
	110	/* number of bytes to defrag, use (u64)-1 to say all */
	111	__u64 len;
	112
	113	/*
	114	* flags for the operation, which can include turning
	115	* on compression for this one defrag
	116	*/
	117	__u64 flags;
	118
	119	/*
	120	* any extent bigger than this will be considered
	121	* already defragged. Use 0 to take the kernel default
	122	* Use 1 to say every single extent must be rewritten
	123	*/
	124	__u32 extent_thresh;
	125
	126	/* spare for later */
	127	__u32 unused[5];
	128	};
	129
	130
c5739bba CM	131	#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
c5739bba CM	132	struct btrfs_ioctl_vol_args)
6702ed49	133	#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
8352d8a4	134	struct btrfs_ioctl_vol_args)
edbd8d4e CM	135	#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
edbd8d4e CM	136	struct btrfs_ioctl_vol_args)
8a4b83cc CM	137	#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
8a4b83cc CM	138	struct btrfs_ioctl_vol_args)
6bf13c0c SW	139	/* trans start and trans end are dangerous, and only for
	140	* use by applications that know how to avoid the
	141	* resulting deadlocks
	142	*/
	143	#define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
	144	#define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
	145	#define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
	146
f2eb0a24	147	#define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
788f20eb CM	148	#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
	149	struct btrfs_ioctl_vol_args)
	150	#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
	151	struct btrfs_ioctl_vol_args)
	152	#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
	153	struct btrfs_ioctl_vol_args)
c5c9cd4d SW	154
	155	#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
	156	struct btrfs_ioctl_clone_range_args)
	157
3de4586c CM	158	#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
3de4586c CM	159	struct btrfs_ioctl_vol_args)
76dda93c YZ	160	#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
76dda93c YZ	161	struct btrfs_ioctl_vol_args)
1e701a32 CM	162	#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
1e701a32 CM	163	struct btrfs_ioctl_defrag_range_args)
ac8e9819 CM	164	#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
	165	struct btrfs_ioctl_search_args)
	166	#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
	167	struct btrfs_ioctl_ino_lookup_args)
6ef5ed0d	168	#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
c5739bba	169	#endif