ext4_utils.h revision 4df62f342dbbe2f5cca831ce789dc0426d32ec03
1ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross/*
2ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * Copyright (C) 2010 The Android Open Source Project
3ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross *
4ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * Licensed under the Apache License, Version 2.0 (the "License");
5ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * you may not use this file except in compliance with the License.
6ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * You may obtain a copy of the License at
7ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross *
8ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross *      http://www.apache.org/licenses/LICENSE-2.0
9ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross *
10ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * Unless required by applicable law or agreed to in writing, software
11ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * distributed under the License is distributed on an "AS IS" BASIS,
12ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * See the License for the specific language governing permissions and
14ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross * limitations under the License.
15ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross */
16ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
17ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#ifndef _EXT4_UTILS_H_
18ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define _EXT4_UTILS_H_
19ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
20e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker#ifdef __cplusplus
21e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongkerextern "C" {
22e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker#endif
23e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker
24e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker#ifndef _GNU_SOURCE
2533f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#define _GNU_SOURCE
26e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker#endif
2733f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#define _FILE_OFFSET_BITS 64
28dc5abeee1e6fc4827ee0d5ece12aaed2dd56f4c7Colin Cross#define _LARGEFILE64_SOURCE 1
2933f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#include <sys/types.h>
3033f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#include <unistd.h>
3133f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross
32ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#include <sys/types.h>
33ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#include <errno.h>
34ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#include <stdarg.h>
35ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#include <stdio.h>
36ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#include <stdlib.h>
37ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#include <string.h>
382ae7663e1e064000356ee9e49ebd08bdddc545f9Ken Sumrall#include <setjmp.h>
394df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich#include <stdint.h>
40ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
4133f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#if defined(__APPLE__) && defined(__MACH__)
4233f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#define lseek64 lseek
43fe4a03182b5b17d333511c72406f926a791345d3Colin Cross#define ftruncate64 ftruncate
44fe4a03182b5b17d333511c72406f926a791345d3Colin Cross#define mmap64 mmap
4533f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#define off64_t off_t
4633f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#endif
4733f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross
4833f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#ifdef __BIONIC__
4933f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Crossextern void*  __mmap2(void *, size_t, int, int, int, off_t);
5033f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Crossstatic inline void *mmap64(void *addr, size_t length, int prot, int flags,
5133f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross        int fd, off64_t offset)
5233f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross{
5333f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross    return __mmap2(addr, length, prot, flags, fd, offset >> 12);
5433f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross}
5533f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross#endif
5633f96c66e9a1f2e266a75e5e84c091dffa6ef118Colin Cross
57ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossextern int force;
58ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
59ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define warn(fmt, args...) do { fprintf(stderr, "warning: %s: " fmt "\n", __func__, ## args); } while (0)
602ae7663e1e064000356ee9e49ebd08bdddc545f9Ken Sumrall#define error(fmt, args...) do { fprintf(stderr, "error: %s: " fmt "\n", __func__, ## args); if (!force) longjmp(setjmp_env, EXIT_FAILURE); } while (0)
61a7ed433f2dc0116627a93b18fbb260f0665ca0cbColin Cross#define error_errno(s, args...) error(s ": %s", ##args, strerror(errno))
622ae7663e1e064000356ee9e49ebd08bdddc545f9Ken Sumrall#define critical_error(fmt, args...) do { fprintf(stderr, "critical error: %s: " fmt "\n", __func__, ## args); longjmp(setjmp_env, EXIT_FAILURE); } while (0)
63a7ed433f2dc0116627a93b18fbb260f0665ca0cbColin Cross#define critical_error_errno(s, args...) critical_error(s ": %s", ##args, strerror(errno))
64ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
65ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define EXT4_SUPER_MAGIC 0xEF53
66ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define EXT4_JNL_BACKUP_BLOCKS 1
67ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
684605b3fb8a00fa37f617a8d0fe3a095d0503a845Raphael Moll#ifndef min /* already defined by windows.h */
69ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define min(a, b) ((a) < (b) ? (a) : (b))
704605b3fb8a00fa37f617a8d0fe3a095d0503a845Raphael Moll#endif
71ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
72ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define DIV_ROUND_UP(x, y) (((x) + (y) - 1)/(y))
736bd2b5d80db5630cb73e3e5a4be3b38afa241c5aColin Cross#define ALIGN(x, y) ((y) * DIV_ROUND_UP((x), (y)))
74ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
75ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __le64 u64
76ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __le32 u32
77ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __le16 u16
78ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
79ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __be64 u64
80ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __be32 u32
81ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __be16 u16
82ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
83ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __u64 u64
84ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __u32 u32
85ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __u16 u16
86ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#define __u8 u8
87ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
884df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich/* XXX */
894df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich#define cpu_to_le32(x) (x)
904df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich#define cpu_to_le16(x) (x)
914df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich#define le32_to_cpu(x) (x)
924df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich#define le16_to_cpu(x) (x)
934df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich
94ec0a2e83dc66d67addeb90e83144187691852a3eColin Crosstypedef unsigned long long u64;
95435a8b61e925e3efb22fce08612efe210e83f791Ken Sumralltypedef signed long long s64;
96ec0a2e83dc66d67addeb90e83144187691852a3eColin Crosstypedef unsigned int u32;
97ec0a2e83dc66d67addeb90e83144187691852a3eColin Crosstypedef unsigned short int u16;
98ec0a2e83dc66d67addeb90e83144187691852a3eColin Crosstypedef unsigned char u8;
99ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
100ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossstruct block_group_info;
1014df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevichstruct xattr_list_element;
102ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
103ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossstruct ext2_group_desc {
104ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	__le32 bg_block_bitmap;
105ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	__le32 bg_inode_bitmap;
106ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	__le32 bg_inode_table;
107ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	__le16 bg_free_blocks_count;
108ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	__le16 bg_free_inodes_count;
109ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	__le16 bg_used_dirs_count;
11056497f28bd20001dd5f931208e8d948cf2f81b2fColin Cross	__le16 bg_flags;
11156497f28bd20001dd5f931208e8d948cf2f81b2fColin Cross	__le32 bg_reserved[2];
11256497f28bd20001dd5f931208e8d948cf2f81b2fColin Cross	__le16 bg_reserved16;
11356497f28bd20001dd5f931208e8d948cf2f81b2fColin Cross	__le16 bg_checksum;
114ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross};
115ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
116ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossstruct fs_info {
117435a8b61e925e3efb22fce08612efe210e83f791Ken Sumrall	s64 len;	/* If set to 0, ask the block device for the size,
118435a8b61e925e3efb22fce08612efe210e83f791Ken Sumrall			 * if less than 0, reserve that much space at the
119435a8b61e925e3efb22fce08612efe210e83f791Ken Sumrall			 * end of the partition, else use the size given. */
120ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 block_size;
121ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 blocks_per_group;
122ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 inodes_per_group;
123ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 inode_size;
124ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 inodes;
125ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 journal_blocks;
126ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u16 feat_ro_compat;
127ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u16 feat_compat;
128ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u16 feat_incompat;
12922742ce739a046a079b2e1b03342a25472dfa352Colin Cross	u32 bg_desc_reserve_blocks;
130ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	const char *label;
131e4b5ae8ab07e698b95f004c9226000b02f853abcColin Cross	u8 no_journal;
132f0ee37ffded79afdb03e15ae3a69969d2b7e6079Colin Cross
133f0ee37ffded79afdb03e15ae3a69969d2b7e6079Colin Cross	struct sparse_file *sparse_file;
134ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross};
135ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
136ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossstruct fs_aux_info {
137ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	struct ext4_super_block *sb;
138107a9f161babc20daf915311146b0e864d3b4157Ken Sumrall	struct ext4_super_block **backup_sb;
139ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	struct ext2_group_desc *bg_desc;
140ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	struct block_group_info *bgs;
1414df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich	struct xattr_list_element *xattrs;
142ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 first_data_block;
143ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u64 len_blocks;
144ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 inode_table_blocks;
145ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 groups;
146ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 bg_desc_blocks;
147ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 default_i_flags;
148ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 blocks_per_ind;
149ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 blocks_per_dind;
150ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	u32 blocks_per_tind;
151ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross};
152ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
153ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossextern struct fs_info info;
154ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossextern struct fs_aux_info aux_info;
155ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
1562ae7663e1e064000356ee9e49ebd08bdddc545f9Ken Sumrallextern jmp_buf setjmp_env;
1572ae7663e1e064000356ee9e49ebd08bdddc545f9Ken Sumrall
158ec0a2e83dc66d67addeb90e83144187691852a3eColin Crossstatic inline int log_2(int j)
159ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross{
160ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	int i;
161ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
162ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	for (i = 0; j > 0; i++)
163ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross		j >>= 1;
164ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
165ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross	return i - 1;
166ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross}
167ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross
168881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossint ext4_bg_has_super_block(int bg);
169dc5abeee1e6fc4827ee0d5ece12aaed2dd56f4c7Colin Crossvoid write_ext4_image(int fd, int gz, int sparse, int crc);
170881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossvoid ext4_create_fs_aux_info(void);
171881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossvoid ext4_free_fs_aux_info(void);
172881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossvoid ext4_fill_in_sb(void);
173881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossvoid ext4_create_resize_inode(void);
174881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossvoid ext4_create_journal_inode(void);
175881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossvoid ext4_update_free(void);
176b781330b1acae2e5706bbda8d81e5f7575f40e2aColin Crossvoid ext4_queue_sb(void);
1770349bd9f14d252673a7a25767da4a80121aaaaf2Anatol Pomazauu64 get_file_size(int fd);
178881cca2f88ddcce86483b3ba95546b5641de8c0eColin Crossu64 parse_num(const char *arg);
179a7ed433f2dc0116627a93b18fbb260f0665ca0cbColin Crossvoid ext4_parse_sb(struct ext4_super_block *sb);
18056497f28bd20001dd5f931208e8d948cf2f81b2fColin Crossu16 ext4_crc16(u16 crc_in, const void *buf, int size);
181881cca2f88ddcce86483b3ba95546b5641de8c0eColin Cross
182965298695c981ee5a67e86977a8e40a50f7392abColin Crosstypedef void (*fs_config_func_t)(const char *path, int dir, unsigned *uid, unsigned *gid,
1834df62f342dbbe2f5cca831ce789dc0426d32ec03Nick Kralevich        unsigned *mode, uint64_t *capabilities);
184965298695c981ee5a67e86977a8e40a50f7392abColin Cross
185965298695c981ee5a67e86977a8e40a50f7392abColin Crossstruct selabel_handle;
186965298695c981ee5a67e86977a8e40a50f7392abColin Cross
187965298695c981ee5a67e86977a8e40a50f7392abColin Crossint make_ext4fs_internal(int fd, const char *directory,
188965298695c981ee5a67e86977a8e40a50f7392abColin Cross                         const char *mountpoint, fs_config_func_t fs_config_func, int gzip,
18956497f28bd20001dd5f931208e8d948cf2f81b2fColin Cross                         int sparse, int crc, int wipe,
1902057370a2db739d8a7d8a475c9a0773efc3d91a0William Roberts                         struct selabel_handle *sehnd, int verbose);
191965298695c981ee5a67e86977a8e40a50f7392abColin Cross
192e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker#ifdef __cplusplus
193e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker}
194e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker#endif
195e8d74ff5c3253403d3e5c96edc80dfc3e5f8ada8Doug Zongker
196ec0a2e83dc66d67addeb90e83144187691852a3eColin Cross#endif
197