xref: /openbmc/linux/fs/ext4/fsmap.h (revision 711aab1d)
1 /*
2  * Copyright (C) 2017 Oracle.  All Rights Reserved.
3  *
4  * Author: Darrick J. Wong <darrick.wong@oracle.com>
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it would be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write the Free Software Foundation,
18  * Inc.,  51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
19  */
20 #ifndef __EXT4_FSMAP_H__
21 #define	__EXT4_FSMAP_H__
22 
23 struct fsmap;
24 
25 /* internal fsmap representation */
26 struct ext4_fsmap {
27 	struct list_head	fmr_list;
28 	dev_t		fmr_device;	/* device id */
29 	uint32_t	fmr_flags;	/* mapping flags */
30 	uint64_t	fmr_physical;	/* device offset of segment */
31 	uint64_t	fmr_owner;	/* owner id */
32 	uint64_t	fmr_length;	/* length of segment, blocks */
33 };
34 
35 struct ext4_fsmap_head {
36 	uint32_t	fmh_iflags;	/* control flags */
37 	uint32_t	fmh_oflags;	/* output flags */
38 	unsigned int	fmh_count;	/* # of entries in array incl. input */
39 	unsigned int	fmh_entries;	/* # of entries filled in (output). */
40 
41 	struct ext4_fsmap fmh_keys[2];	/* low and high keys */
42 };
43 
44 void ext4_fsmap_from_internal(struct super_block *sb, struct fsmap *dest,
45 		struct ext4_fsmap *src);
46 void ext4_fsmap_to_internal(struct super_block *sb, struct ext4_fsmap *dest,
47 		struct fsmap *src);
48 
49 /* fsmap to userspace formatter - copy to user & advance pointer */
50 typedef int (*ext4_fsmap_format_t)(struct ext4_fsmap *, void *);
51 
52 int ext4_getfsmap(struct super_block *sb, struct ext4_fsmap_head *head,
53 		ext4_fsmap_format_t formatter, void *arg);
54 
55 #define EXT4_QUERY_RANGE_ABORT		1
56 #define EXT4_QUERY_RANGE_CONTINUE	0
57 
58 /*	fmr_owner special values for FS_IOC_GETFSMAP; some share w/ XFS */
59 #define EXT4_FMR_OWN_FREE	FMR_OWN_FREE      /* free space */
60 #define EXT4_FMR_OWN_UNKNOWN	FMR_OWN_UNKNOWN   /* unknown owner */
61 #define EXT4_FMR_OWN_FS		FMR_OWNER('X', 1) /* static fs metadata */
62 #define EXT4_FMR_OWN_LOG	FMR_OWNER('X', 2) /* journalling log */
63 #define EXT4_FMR_OWN_INODES	FMR_OWNER('X', 5) /* inodes */
64 #define EXT4_FMR_OWN_GDT	FMR_OWNER('f', 1) /* group descriptors */
65 #define EXT4_FMR_OWN_RESV_GDT	FMR_OWNER('f', 2) /* reserved gdt blocks */
66 #define EXT4_FMR_OWN_BLKBM	FMR_OWNER('f', 3) /* inode bitmap */
67 #define EXT4_FMR_OWN_INOBM	FMR_OWNER('f', 4) /* block bitmap */
68 
69 #endif /* __EXT4_FSMAP_H__ */
70