c4432e8d9c9142b96eda77e54f9b15d4a3de1dcf
[platform/upstream/f2fs-tools.git] / fsck / fsck.h
1 /**
2  * fsck.h
3  *
4  * Copyright (c) 2013 Samsung Electronics Co., Ltd.
5  *             http://www.samsung.com/
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11 #ifndef _FSCK_H_
12 #define _FSCK_H_
13
14 #include "f2fs.h"
15
16 struct quota_ctx;
17
18 #define FSCK_UNMATCHED_EXTENT           0x00000001
19 #define FSCK_INLINE_INODE               0x00000002
20
21 enum {
22         PREEN_MODE_0,
23         PREEN_MODE_1,
24         PREEN_MODE_2,
25         PREEN_MODE_MAX
26 };
27
28 enum {
29         NOERROR,
30         EWRONG_OPT,
31         ENEED_ARG,
32         EUNKNOWN_OPT,
33         EUNKNOWN_ARG,
34 };
35
36 enum SB_ADDR {
37         SB0_ADDR = 0,
38         SB1_ADDR,
39         SB_MAX_ADDR,
40 };
41
42 #define SB_MASK(i)      (1 << i)
43 #define SB_MASK_ALL     (SB_MASK(SB0_ADDR) | SB_MASK(SB1_ADDR))
44
45 /* fsck.c */
46 struct orphan_info {
47         u32 nr_inodes;
48         u32 *ino_list;
49 };
50
51 struct extent_info {
52         u32 fofs;               /* start offset in a file */
53         u32 blk;                /* start block address of the extent */
54         u32 len;                /* length of the extent */
55 };
56
57 struct child_info {
58         u32 state;
59         u32 links;
60         u32 files;
61         u32 pgofs;
62         u8 dots;
63         u8 dir_level;
64         u32 p_ino;              /*parent ino*/
65         u32 pp_ino;             /*parent parent ino*/
66         struct extent_info ei;
67         u32 last_blk;
68         u32 i_namelen;  /* dentry namelen */
69 };
70
71 struct f2fs_fsck {
72         struct f2fs_sb_info sbi;
73
74         struct orphan_info orphani;
75         struct chk_result {
76                 u64 valid_blk_cnt;
77                 u32 valid_nat_entry_cnt;
78                 u32 valid_node_cnt;
79                 u32 valid_inode_cnt;
80                 u32 multi_hard_link_files;
81                 u64 sit_valid_blocks;
82                 u32 sit_free_segs;
83                 u32 wp_fixed;
84                 u32 wp_inconsistent_zones;
85         } chk;
86
87         struct hard_link_node *hard_link_list_head;
88
89         char *main_seg_usage;
90         char *main_area_bitmap;
91         char *nat_area_bitmap;
92         char *sit_area_bitmap;
93
94         u64 main_area_bitmap_sz;
95         u32 nat_area_bitmap_sz;
96         u32 sit_area_bitmap_sz;
97
98         u64 nr_main_blks;
99         u32 nr_nat_entries;
100
101         u32 dentry_depth;
102         struct f2fs_nat_entry *entries;
103         u32 nat_valid_inode_cnt;
104
105         struct quota_ctx *qctx;
106 };
107
108 #define BLOCK_SZ                4096
109 struct block {
110         unsigned char buf[BLOCK_SZ];
111 };
112
113 enum NODE_TYPE {
114         TYPE_INODE = 37,
115         TYPE_DIRECT_NODE = 43,
116         TYPE_INDIRECT_NODE = 53,
117         TYPE_DOUBLE_INDIRECT_NODE = 67,
118         TYPE_XATTR = 77
119 };
120
121 struct hard_link_node {
122         u32 nid;
123         u32 links;
124         u32 actual_links;
125         struct hard_link_node *next;
126 };
127
128 enum seg_type {
129         SEG_TYPE_DATA,
130         SEG_TYPE_CUR_DATA,
131         SEG_TYPE_NODE,
132         SEG_TYPE_CUR_NODE,
133         SEG_TYPE_MAX,
134 };
135
136 struct selabel_handle;
137
138 static inline bool need_fsync_data_record(struct f2fs_sb_info *sbi)
139 {
140         return !is_set_ckpt_flags(F2FS_CKPT(sbi), CP_UMOUNT_FLAG) ||
141                 c.zoned_model == F2FS_ZONED_HM;
142 }
143
144 extern int fsck_chk_orphan_node(struct f2fs_sb_info *);
145 extern int fsck_chk_quota_node(struct f2fs_sb_info *);
146 extern int fsck_chk_quota_files(struct f2fs_sb_info *);
147 extern int fsck_chk_node_blk(struct f2fs_sb_info *, struct f2fs_inode *, u32,
148                 enum FILE_TYPE, enum NODE_TYPE, u32 *,
149                 struct child_info *);
150 extern void fsck_chk_inode_blk(struct f2fs_sb_info *, u32, enum FILE_TYPE,
151                 struct f2fs_node *, u32 *, struct node_info *, struct child_info *);
152 extern int fsck_chk_dnode_blk(struct f2fs_sb_info *, struct f2fs_inode *,
153                 u32, enum FILE_TYPE, struct f2fs_node *, u32 *,
154                 struct child_info *, struct node_info *);
155 extern int fsck_chk_idnode_blk(struct f2fs_sb_info *, struct f2fs_inode *,
156                 enum FILE_TYPE, struct f2fs_node *, u32 *, struct child_info *);
157 extern int fsck_chk_didnode_blk(struct f2fs_sb_info *, struct f2fs_inode *,
158                 enum FILE_TYPE, struct f2fs_node *, u32 *, struct child_info *);
159 extern int fsck_chk_data_blk(struct f2fs_sb_info *, int,
160                 u32, struct child_info *, int, enum FILE_TYPE, u32, u16, u8, int);
161 extern int fsck_chk_dentry_blk(struct f2fs_sb_info *, int,
162                 u32, struct child_info *, int, int);
163 int fsck_chk_inline_dentries(struct f2fs_sb_info *, struct f2fs_node *,
164                 struct child_info *);
165 void fsck_chk_checkpoint(struct f2fs_sb_info *sbi);
166 int fsck_chk_meta(struct f2fs_sb_info *sbi);
167 void fsck_chk_and_fix_write_pointers(struct f2fs_sb_info *);
168 int fsck_chk_curseg_info(struct f2fs_sb_info *);
169 void pretty_print_filename(const u8 *raw_name, u32 len,
170                            char out[F2FS_PRINT_NAMELEN], int enc_name);
171
172 extern void update_free_segments(struct f2fs_sb_info *);
173 void print_cp_state(u32);
174 extern void print_node_info(struct f2fs_sb_info *, struct f2fs_node *, int);
175 extern void print_inode_info(struct f2fs_sb_info *, struct f2fs_node *, int);
176 extern struct seg_entry *get_seg_entry(struct f2fs_sb_info *, unsigned int);
177 extern struct f2fs_summary_block *get_sum_block(struct f2fs_sb_info *,
178                                 unsigned int, int *);
179 extern int get_sum_entry(struct f2fs_sb_info *, u32, struct f2fs_summary *);
180 extern void update_sum_entry(struct f2fs_sb_info *, block_t,
181                                 struct f2fs_summary *);
182 extern void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
183 extern void nullify_nat_entry(struct f2fs_sb_info *, u32);
184 extern void rewrite_sit_area_bitmap(struct f2fs_sb_info *);
185 extern void build_nat_area_bitmap(struct f2fs_sb_info *);
186 extern void build_sit_area_bitmap(struct f2fs_sb_info *);
187 extern int f2fs_set_main_bitmap(struct f2fs_sb_info *, u32, int);
188 extern int f2fs_set_sit_bitmap(struct f2fs_sb_info *, u32);
189 extern void fsck_init(struct f2fs_sb_info *);
190 extern int fsck_verify(struct f2fs_sb_info *);
191 extern void fsck_free(struct f2fs_sb_info *);
192 extern int f2fs_ra_meta_pages(struct f2fs_sb_info *, block_t, int, int);
193 extern int f2fs_do_mount(struct f2fs_sb_info *);
194 extern void f2fs_do_umount(struct f2fs_sb_info *);
195 extern int f2fs_sparse_initialize_meta(struct f2fs_sb_info *);
196
197 extern void flush_journal_entries(struct f2fs_sb_info *);
198 extern void update_curseg_info(struct f2fs_sb_info *, int);
199 extern void zero_journal_entries(struct f2fs_sb_info *);
200 extern void flush_sit_entries(struct f2fs_sb_info *);
201 extern void move_curseg_info(struct f2fs_sb_info *, u64, int);
202 extern void write_curseg_info(struct f2fs_sb_info *);
203 extern int find_next_free_block(struct f2fs_sb_info *, u64 *, int, int, bool);
204 extern void duplicate_checkpoint(struct f2fs_sb_info *);
205 extern void write_checkpoint(struct f2fs_sb_info *);
206 extern void write_checkpoints(struct f2fs_sb_info *);
207 extern void update_superblock(struct f2fs_super_block *, int);
208 extern void update_data_blkaddr(struct f2fs_sb_info *, nid_t, u16, block_t);
209 extern void update_nat_blkaddr(struct f2fs_sb_info *, nid_t, nid_t, block_t);
210
211 extern void print_raw_sb_info(struct f2fs_super_block *);
212 extern pgoff_t current_nat_addr(struct f2fs_sb_info *, nid_t, int *);
213
214 extern u32 get_free_segments(struct f2fs_sb_info *);
215 extern void get_current_sit_page(struct f2fs_sb_info *,
216                         unsigned int, struct f2fs_sit_block *);
217 extern void rewrite_current_sit_page(struct f2fs_sb_info *, unsigned int,
218                         struct f2fs_sit_block *);
219
220 extern u32 update_nat_bits_flags(struct f2fs_super_block *,
221                                 struct f2fs_checkpoint *, u32);
222 extern void write_nat_bits(struct f2fs_sb_info *, struct f2fs_super_block *,
223                         struct f2fs_checkpoint *, int);
224
225 /* dump.c */
226 struct dump_option {
227         nid_t nid;
228         nid_t start_nat;
229         nid_t end_nat;
230         int start_sit;
231         int end_sit;
232         int start_ssa;
233         int end_ssa;
234         int32_t blk_addr;
235 };
236
237 extern void nat_dump(struct f2fs_sb_info *, nid_t, nid_t);
238 extern void sit_dump(struct f2fs_sb_info *, unsigned int, unsigned int);
239 extern void ssa_dump(struct f2fs_sb_info *, int, int);
240 extern void dump_node(struct f2fs_sb_info *, nid_t, int);
241 extern int dump_info_from_blkaddr(struct f2fs_sb_info *, u32);
242 extern unsigned int start_bidx_of_node(unsigned int, struct f2fs_node *);
243
244
245 /* defrag.c */
246 int f2fs_defragment(struct f2fs_sb_info *, u64, u64, u64, int);
247
248 /* resize.c */
249 int f2fs_resize(struct f2fs_sb_info *);
250
251 /* sload.c */
252 int f2fs_sload(struct f2fs_sb_info *);
253
254 /* segment.c */
255 int reserve_new_block(struct f2fs_sb_info *, block_t *,
256                                         struct f2fs_summary *, int, bool);
257 int new_data_block(struct f2fs_sb_info *, void *,
258                                         struct dnode_of_data *, int);
259 int f2fs_build_file(struct f2fs_sb_info *, struct dentry *);
260 void f2fs_alloc_nid(struct f2fs_sb_info *, nid_t *);
261 void set_data_blkaddr(struct dnode_of_data *);
262 block_t new_node_block(struct f2fs_sb_info *,
263                                         struct dnode_of_data *, unsigned int);
264
265 /* segment.c */
266 u64 f2fs_read(struct f2fs_sb_info *, nid_t, u8 *, u64, pgoff_t);
267 u64 f2fs_write(struct f2fs_sb_info *, nid_t, u8 *, u64, pgoff_t);
268 void f2fs_filesize_update(struct f2fs_sb_info *, nid_t, u64);
269
270 int get_dnode_of_data(struct f2fs_sb_info *, struct dnode_of_data *,
271                                         pgoff_t, int);
272 void make_dentry_ptr(struct f2fs_dentry_ptr *, struct f2fs_node *, void *, int);
273 int f2fs_create(struct f2fs_sb_info *, struct dentry *);
274 int f2fs_mkdir(struct f2fs_sb_info *, struct dentry *);
275 int f2fs_symlink(struct f2fs_sb_info *, struct dentry *);
276 int inode_set_selinux(struct f2fs_sb_info *, u32, const char *);
277 int f2fs_find_path(struct f2fs_sb_info *, char *, nid_t *);
278 nid_t f2fs_lookup(struct f2fs_sb_info *, struct f2fs_node *, u8 *, int);
279 int f2fs_add_link(struct f2fs_sb_info *, struct f2fs_node *,
280                 const unsigned char *, int, nid_t, int, block_t, int);
281
282 /* xattr.c */
283 void *read_all_xattrs(struct f2fs_sb_info *, struct f2fs_node *);
284
285 #endif /* _FSCK_H_ */