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 enum {
17 FSCK_SUCCESS = 0,
18 FSCK_ERROR_CORRECTED = 1 << 0,
19 FSCK_SYSTEM_SHOULD_REBOOT = 1 << 1,
20 FSCK_ERRORS_LEFT_UNCORRECTED = 1 << 2,
21 FSCK_OPERATIONAL_ERROR = 1 << 3,
22 FSCK_USAGE_OR_SYNTAX_ERROR = 1 << 4,
23 FSCK_USER_CANCELLED = 1 << 5,
24 FSCK_SHARED_LIB_ERROR = 1 << 7,
25 };
26
27 struct quota_ctx;
28
29 #define FSCK_UNMATCHED_EXTENT 0x00000001
30 #define FSCK_INLINE_INODE 0x00000002
31
32 enum {
33 PREEN_MODE_0,
34 PREEN_MODE_1,
35 PREEN_MODE_2,
36 PREEN_MODE_MAX
37 };
38
39 enum {
40 NOERROR,
41 EWRONG_OPT,
42 ENEED_ARG,
43 EUNKNOWN_OPT,
44 EUNKNOWN_ARG,
45 };
46
47 enum SB_ADDR {
48 SB0_ADDR = 0,
49 SB1_ADDR,
50 SB_MAX_ADDR,
51 };
52
53 #define SB_MASK(i) (1 << (i))
54 #define SB_MASK_ALL (SB_MASK(SB0_ADDR) | SB_MASK(SB1_ADDR))
55
56 /* fsck.c */
57 struct orphan_info {
58 u32 nr_inodes;
59 u32 *ino_list;
60 };
61
62 struct extent_info {
63 u32 fofs; /* start offset in a file */
64 u32 blk; /* start block address of the extent */
65 u32 len; /* length of the extent */
66 };
67
68 struct child_info {
69 u32 state;
70 u32 links;
71 u32 files;
72 u32 pgofs;
73 u8 dot;
74 u8 dotdot;
75 u8 dir_level;
76 u32 p_ino; /* parent ino */
77 char p_name[F2FS_NAME_LEN + 1]; /* parent name */
78 u32 pp_ino; /* parent parent ino*/
79 struct extent_info ei;
80 u32 last_blk;
81 u32 i_namelen; /* dentry namelen */
82 };
83
84 struct f2fs_dentry {
85 char name[F2FS_NAME_LEN + 1];
86 int depth;
87 struct f2fs_dentry *next;
88 };
89
90 struct f2fs_fsck {
91 struct f2fs_sb_info sbi;
92
93 struct orphan_info orphani;
94 struct chk_result {
95 u64 checked_node_cnt;
96 u64 valid_blk_cnt;
97 u32 valid_nat_entry_cnt;
98 u32 valid_node_cnt;
99 u32 valid_inode_cnt;
100 u32 multi_hard_link_files;
101 u64 sit_valid_blocks;
102 u32 sit_free_segs;
103 u32 wp_fixed;
104 u32 wp_inconsistent_zones;
105 } chk;
106
107 struct hard_link_node *hard_link_list_head;
108
109 char *main_seg_usage;
110 char *main_area_bitmap;
111 char *nat_area_bitmap;
112 char *sit_area_bitmap;
113
114 u64 main_area_bitmap_sz;
115 u32 nat_area_bitmap_sz;
116 u32 sit_area_bitmap_sz;
117
118 u64 nr_main_blks;
119 u32 nr_nat_entries;
120
121 u32 dentry_depth;
122 struct f2fs_dentry *dentry;
123 struct f2fs_dentry *dentry_end;
124 struct f2fs_nat_entry *entries;
125 u32 nat_valid_inode_cnt;
126
127 struct quota_ctx *qctx;
128 };
129
130 enum NODE_TYPE {
131 TYPE_INODE = 37,
132 TYPE_DIRECT_NODE = 43,
133 TYPE_INDIRECT_NODE = 53,
134 TYPE_DOUBLE_INDIRECT_NODE = 67,
135 TYPE_XATTR = 77
136 };
137
138 struct hard_link_node {
139 u32 nid;
140 u32 links;
141 u32 actual_links;
142 struct hard_link_node *next;
143 };
144
145 enum seg_type {
146 SEG_TYPE_DATA,
147 SEG_TYPE_CUR_DATA,
148 SEG_TYPE_NODE,
149 SEG_TYPE_CUR_NODE,
150 SEG_TYPE_MAX,
151 };
152
153 struct selabel_handle;
154
need_fsync_data_record(struct f2fs_sb_info * sbi)155 static inline bool need_fsync_data_record(struct f2fs_sb_info *sbi)
156 {
157 return !is_set_ckpt_flags(F2FS_CKPT(sbi), CP_UMOUNT_FLAG);
158 }
159
160 extern int fsck_chk_orphan_node(struct f2fs_sb_info *);
161 extern int fsck_chk_quota_node(struct f2fs_sb_info *);
162 extern int fsck_chk_quota_files(struct f2fs_sb_info *);
163 extern int fsck_sanity_check_nid(struct f2fs_sb_info *, u32,
164 enum FILE_TYPE, enum NODE_TYPE);
165 extern int fsck_sanity_check_nat(struct f2fs_sb_info *sbi, u32 nid);
166 extern int fsck_chk_node_blk(struct f2fs_sb_info *, struct f2fs_inode *, u32,
167 enum FILE_TYPE, enum NODE_TYPE, u32 *,
168 struct f2fs_compr_blk_cnt *, struct child_info *);
169 extern int fsck_chk_root_inode(struct f2fs_sb_info *);
170 extern void fsck_chk_inode_blk(struct f2fs_sb_info *, u32, enum FILE_TYPE,
171 struct f2fs_node *, u32 *, struct f2fs_compr_blk_cnt *,
172 struct node_info *, struct child_info *);
173 extern int fsck_chk_dnode_blk(struct f2fs_sb_info *, struct f2fs_inode *,
174 u32, enum FILE_TYPE, struct f2fs_node *, u32 *,
175 struct f2fs_compr_blk_cnt *, struct child_info *,
176 struct node_info *);
177 extern int fsck_chk_idnode_blk(struct f2fs_sb_info *, struct f2fs_inode *,
178 enum FILE_TYPE, struct f2fs_node *, u32 *,
179 struct f2fs_compr_blk_cnt *, struct child_info *);
180 extern int fsck_chk_didnode_blk(struct f2fs_sb_info *, struct f2fs_inode *,
181 enum FILE_TYPE, struct f2fs_node *, u32 *,
182 struct f2fs_compr_blk_cnt *, struct child_info *);
183 extern int fsck_chk_data_blk(struct f2fs_sb_info *, struct f2fs_inode *,
184 u32, struct child_info *, int, enum FILE_TYPE, u32, u16, u8,
185 struct f2fs_node *);
186 extern int fsck_chk_dentry_blk(struct f2fs_sb_info *, int,
187 u32, struct child_info *, int, int, struct f2fs_node *);
188 int fsck_chk_inline_dentries(struct f2fs_sb_info *, struct f2fs_node *,
189 struct child_info *);
190 void fsck_chk_checkpoint(struct f2fs_sb_info *sbi);
191 int fsck_chk_meta(struct f2fs_sb_info *sbi);
192 void fsck_chk_and_fix_write_pointers(struct f2fs_sb_info *);
193 int fsck_chk_curseg_info(struct f2fs_sb_info *);
194 void pretty_print_filename(const u8 *raw_name, u32 len,
195 char out[F2FS_PRINT_NAMELEN], int enc_name);
196
197 extern void update_free_segments(struct f2fs_sb_info *);
198 void print_cp_state(u32);
199 extern void print_node_info(struct f2fs_sb_info *, struct f2fs_node *, int);
200 extern void print_inode_info(struct f2fs_sb_info *, struct f2fs_node *, int);
201 extern struct seg_entry *get_seg_entry(struct f2fs_sb_info *, unsigned int);
202 extern struct f2fs_summary_block *get_sum_block(struct f2fs_sb_info *,
203 unsigned int, int *);
204 extern int get_sum_entry(struct f2fs_sb_info *, u32, struct f2fs_summary *);
205 extern void update_sum_entry(struct f2fs_sb_info *, block_t,
206 struct f2fs_summary *);
207 extern void get_node_info(struct f2fs_sb_info *, nid_t, struct node_info *);
208 extern void nullify_nat_entry(struct f2fs_sb_info *, u32);
209 extern void rewrite_sit_area_bitmap(struct f2fs_sb_info *);
210 extern void build_nat_area_bitmap(struct f2fs_sb_info *);
211 extern void build_sit_area_bitmap(struct f2fs_sb_info *);
212 extern int f2fs_set_main_bitmap(struct f2fs_sb_info *, u32, int);
213 extern int f2fs_clear_main_bitmap(struct f2fs_sb_info *, u32);
214 extern int f2fs_set_sit_bitmap(struct f2fs_sb_info *, u32);
215 extern int f2fs_clear_sit_bitmap(struct f2fs_sb_info *, u32);
216 extern void fsck_init(struct f2fs_sb_info *);
217 extern int fsck_verify(struct f2fs_sb_info *);
218 extern void fsck_free(struct f2fs_sb_info *);
219 extern bool f2fs_is_valid_blkaddr(struct f2fs_sb_info *sbi,
220 block_t blkaddr, int type);
221 extern int f2fs_ra_meta_pages(struct f2fs_sb_info *, block_t, int, int);
222 extern int f2fs_do_mount(struct f2fs_sb_info *);
223 extern void f2fs_do_umount(struct f2fs_sb_info *);
224 extern int f2fs_sparse_initialize_meta(struct f2fs_sb_info *);
225
226 extern void flush_journal_entries(struct f2fs_sb_info *);
227 extern void update_curseg_info(struct f2fs_sb_info *, int);
228 extern void zero_journal_entries(struct f2fs_sb_info *);
229 extern void flush_sit_entries(struct f2fs_sb_info *);
230 extern void move_curseg_info(struct f2fs_sb_info *, u64, int);
231 extern void move_one_curseg_info(struct f2fs_sb_info *sbi, u64 from, int left,
232 int i);
233 extern void write_curseg_info(struct f2fs_sb_info *);
234 extern void save_curseg_warm_node_info(struct f2fs_sb_info *);
235 extern void restore_curseg_warm_node_info(struct f2fs_sb_info *);
236 extern int find_next_free_block(struct f2fs_sb_info *, u64 *, int, int, bool);
237 extern void duplicate_checkpoint(struct f2fs_sb_info *);
238 extern void write_checkpoint(struct f2fs_sb_info *);
239 extern void write_checkpoints(struct f2fs_sb_info *);
240 extern void write_raw_cp_blocks(struct f2fs_sb_info *sbi,
241 struct f2fs_checkpoint *cp, int which);
242 extern void update_superblock(struct f2fs_super_block *, int);
243 extern void update_data_blkaddr(struct f2fs_sb_info *, nid_t, u16, block_t,
244 struct f2fs_node *);
245 extern void update_nat_blkaddr(struct f2fs_sb_info *, nid_t, nid_t, block_t);
246
247 extern void print_raw_sb_info(struct f2fs_super_block *);
248 extern void print_ckpt_info(struct f2fs_sb_info *);
249 extern bool is_checkpoint_stop(struct f2fs_super_block *, bool);
250 extern bool is_inconsistent_error(struct f2fs_super_block *);
251 extern pgoff_t current_nat_addr(struct f2fs_sb_info *, nid_t, int *);
252
253 extern u32 get_free_segments(struct f2fs_sb_info *);
254 extern void get_current_sit_page(struct f2fs_sb_info *,
255 unsigned int, struct f2fs_sit_block *);
256 extern void rewrite_current_sit_page(struct f2fs_sb_info *, unsigned int,
257 struct f2fs_sit_block *);
258
259 extern u32 update_nat_bits_flags(struct f2fs_super_block *,
260 struct f2fs_checkpoint *, u32);
261 extern void write_nat_bits(struct f2fs_sb_info *, struct f2fs_super_block *,
262 struct f2fs_checkpoint *, int);
263 extern unsigned int get_usable_seg_count(struct f2fs_sb_info *);
264 extern bool is_usable_seg(struct f2fs_sb_info *, unsigned int);
265
266 /* dump.c */
267 struct dump_option {
268 nid_t nid;
269 nid_t start_nat;
270 nid_t end_nat;
271 int start_sit;
272 int end_sit;
273 int start_ssa;
274 int end_ssa;
275 int32_t blk_addr;
276 nid_t scan_nid;
277 int use_root_nid;
278 char *base_path;
279 };
280
281 extern void nat_dump(struct f2fs_sb_info *, nid_t, nid_t);
282 extern void sit_dump(struct f2fs_sb_info *, unsigned int, unsigned int);
283 extern void ssa_dump(struct f2fs_sb_info *, int, int);
284 extern int dump_node(struct f2fs_sb_info *, nid_t, int, char *, int, int, char *);
285 extern int dump_info_from_blkaddr(struct f2fs_sb_info *, u32);
286 extern unsigned int start_bidx_of_node(unsigned int, struct f2fs_node *);
287 extern void dump_node_scan_disk(struct f2fs_sb_info *sbi, nid_t nid);
288 extern bool is_sit_bitmap_set(struct f2fs_sb_info *sbi, u32 blk_addr);
289
290 /* defrag.c */
291 int f2fs_defragment(struct f2fs_sb_info *, u64, u64, u64, int);
292
293 /* resize.c */
294 int f2fs_resize(struct f2fs_sb_info *);
295
296 /* sload.c */
297 int f2fs_sload(struct f2fs_sb_info *);
298
299 /* segment.c */
300 int reserve_new_block(struct f2fs_sb_info *, block_t *,
301 struct f2fs_summary *, int, bool);
302 int new_data_block(struct f2fs_sb_info *, void *,
303 struct dnode_of_data *, int);
304 int f2fs_build_file(struct f2fs_sb_info *, struct dentry *);
305 void f2fs_alloc_nid(struct f2fs_sb_info *, nid_t *);
306 void set_data_blkaddr(struct dnode_of_data *);
307 block_t new_node_block(struct f2fs_sb_info *,
308 struct dnode_of_data *, unsigned int);
309 int f2fs_rebuild_qf_inode(struct f2fs_sb_info *sbi, int qtype);
310 int update_block(struct f2fs_sb_info *sbi, void *buf, u32 *blkaddr,
311 struct f2fs_node *node_blk);
312
313 /* segment.c */
314 struct quota_file;
315 u64 f2fs_quota_size(struct quota_file *);
316 u64 f2fs_read(struct f2fs_sb_info *, nid_t, u8 *, u64, pgoff_t);
317 enum wr_addr_type {
318 WR_NORMAL = 1,
319 WR_COMPRESS_DATA = 2,
320 WR_NULL_ADDR = NULL_ADDR, /* 0 */
321 WR_NEW_ADDR = NEW_ADDR, /* -1U */
322 WR_COMPRESS_ADDR = COMPRESS_ADDR, /* -2U */
323 };
324 u64 f2fs_write(struct f2fs_sb_info *, nid_t, u8 *, u64, pgoff_t);
325 u64 f2fs_write_compress_data(struct f2fs_sb_info *, nid_t, u8 *, u64, pgoff_t);
326 u64 f2fs_write_addrtag(struct f2fs_sb_info *, nid_t, pgoff_t, unsigned int);
327 void f2fs_filesize_update(struct f2fs_sb_info *, nid_t, u64);
328
329 int get_dnode_of_data(struct f2fs_sb_info *, struct dnode_of_data *,
330 pgoff_t, int);
331 void make_dentry_ptr(struct f2fs_dentry_ptr *, struct f2fs_node *, void *, int);
332 int f2fs_create(struct f2fs_sb_info *, struct dentry *);
333 int f2fs_mkdir(struct f2fs_sb_info *, struct dentry *);
334 int f2fs_symlink(struct f2fs_sb_info *, struct dentry *);
335 int inode_set_selinux(struct f2fs_sb_info *, u32, const char *);
336 int f2fs_find_path(struct f2fs_sb_info *, char *, nid_t *);
337 nid_t f2fs_lookup(struct f2fs_sb_info *, struct f2fs_node *, u8 *, int);
338 int f2fs_add_link(struct f2fs_sb_info *, struct f2fs_node *,
339 const unsigned char *, int, nid_t, int, block_t *, int);
340 struct hardlink_cache_entry *f2fs_search_hardlink(struct f2fs_sb_info *sbi,
341 struct dentry *de);
342
343 /* xattr.c */
344 void *read_all_xattrs(struct f2fs_sb_info *, struct f2fs_node *, bool);
345 void write_all_xattrs(struct f2fs_sb_info *sbi,
346 struct f2fs_node *inode, __u32 hsize, void *txattr_addr);
347
348 /* dir.c */
349 int convert_inline_dentry(struct f2fs_sb_info *sbi, struct f2fs_node *node,
350 block_t *p_blkaddr);
351
352 /* node.c */
353 int update_inode(struct f2fs_sb_info *sbi, struct f2fs_node *inode,
354 u32 *blkaddr);
355
356 /* mount.c */
357 int flush_nat_journal_entries(struct f2fs_sb_info *sbi);
358 int flush_sit_journal_entries(struct f2fs_sb_info *sbi);
359
360 /* main.c */
361 int is_digits(char *optarg);
362
363 #endif /* _FSCK_H_ */
364