1
2
3
4
5
6
7
8#ifndef _LINUX_F2FS_FS_H
9#define _LINUX_F2FS_FS_H
10
11#include <linux/pagemap.h>
12#include <linux/types.h>
13
14#define F2FS_SUPER_OFFSET 1024
15#define F2FS_MIN_LOG_SECTOR_SIZE 9
16#define F2FS_MAX_LOG_SECTOR_SIZE 12
17#define F2FS_LOG_SECTORS_PER_BLOCK 3
18#define F2FS_BLKSIZE 4096
19#define F2FS_BLKSIZE_BITS 12
20#define F2FS_MAX_EXTENSION 64
21#define F2FS_EXTENSION_LEN 8
22#define F2FS_BLK_ALIGN(x) (((x) + F2FS_BLKSIZE - 1) >> F2FS_BLKSIZE_BITS)
23
24#define NULL_ADDR ((block_t)0)
25#define NEW_ADDR ((block_t)-1)
26
27#define F2FS_BYTES_TO_BLK(bytes) ((bytes) >> F2FS_BLKSIZE_BITS)
28#define F2FS_BLK_TO_BYTES(blk) ((blk) << F2FS_BLKSIZE_BITS)
29
30
31#define F2FS_RESERVED_NODE_NUM 3
32
33#define F2FS_ROOT_INO(sbi) ((sbi)->root_ino_num)
34#define F2FS_NODE_INO(sbi) ((sbi)->node_ino_num)
35#define F2FS_META_INO(sbi) ((sbi)->meta_ino_num)
36
37#define F2FS_MAX_QUOTAS 3
38
39#define F2FS_IO_SIZE(sbi) (1 << F2FS_OPTION(sbi).write_io_size_bits)
40#define F2FS_IO_SIZE_KB(sbi) (1 << (F2FS_OPTION(sbi).write_io_size_bits + 2))
41#define F2FS_IO_SIZE_BYTES(sbi) (1 << (F2FS_OPTION(sbi).write_io_size_bits + 12))
42#define F2FS_IO_SIZE_BITS(sbi) (F2FS_OPTION(sbi).write_io_size_bits)
43#define F2FS_IO_SIZE_MASK(sbi) (F2FS_IO_SIZE(sbi) - 1)
44
45
46#define GFP_F2FS_ZERO (GFP_NOFS | __GFP_ZERO)
47
48
49
50
51
52
53
54#define MAX_ACTIVE_LOGS 16
55#define MAX_ACTIVE_NODE_LOGS 8
56#define MAX_ACTIVE_DATA_LOGS 8
57
58#define VERSION_LEN 256
59#define MAX_VOLUME_NAME 512
60#define MAX_PATH_LEN 64
61#define MAX_DEVICES 8
62
63
64
65
66struct f2fs_device {
67 __u8 path[MAX_PATH_LEN];
68 __le32 total_segments;
69} __packed;
70
71struct f2fs_super_block {
72 __le32 magic;
73 __le16 major_ver;
74 __le16 minor_ver;
75 __le32 log_sectorsize;
76 __le32 log_sectors_per_block;
77 __le32 log_blocksize;
78 __le32 log_blocks_per_seg;
79 __le32 segs_per_sec;
80 __le32 secs_per_zone;
81 __le32 checksum_offset;
82 __le64 block_count;
83 __le32 section_count;
84 __le32 segment_count;
85 __le32 segment_count_ckpt;
86 __le32 segment_count_sit;
87 __le32 segment_count_nat;
88 __le32 segment_count_ssa;
89 __le32 segment_count_main;
90 __le32 segment0_blkaddr;
91 __le32 cp_blkaddr;
92 __le32 sit_blkaddr;
93 __le32 nat_blkaddr;
94 __le32 ssa_blkaddr;
95 __le32 main_blkaddr;
96 __le32 root_ino;
97 __le32 node_ino;
98 __le32 meta_ino;
99 __u8 uuid[16];
100 __le16 volume_name[MAX_VOLUME_NAME];
101 __le32 extension_count;
102 __u8 extension_list[F2FS_MAX_EXTENSION][F2FS_EXTENSION_LEN];
103 __le32 cp_payload;
104 __u8 version[VERSION_LEN];
105 __u8 init_version[VERSION_LEN];
106 __le32 feature;
107 __u8 encryption_level;
108 __u8 encrypt_pw_salt[16];
109 struct f2fs_device devs[MAX_DEVICES];
110 __le32 qf_ino[F2FS_MAX_QUOTAS];
111 __u8 hot_ext_count;
112 __u8 reserved[310];
113 __le32 crc;
114} __packed;
115
116
117
118
119#define CP_DISABLED_QUICK_FLAG 0x00002000
120#define CP_DISABLED_FLAG 0x00001000
121#define CP_QUOTA_NEED_FSCK_FLAG 0x00000800
122#define CP_LARGE_NAT_BITMAP_FLAG 0x00000400
123#define CP_NOCRC_RECOVERY_FLAG 0x00000200
124#define CP_TRIMMED_FLAG 0x00000100
125#define CP_NAT_BITS_FLAG 0x00000080
126#define CP_CRC_RECOVERY_FLAG 0x00000040
127#define CP_FASTBOOT_FLAG 0x00000020
128#define CP_FSCK_FLAG 0x00000010
129#define CP_ERROR_FLAG 0x00000008
130#define CP_COMPACT_SUM_FLAG 0x00000004
131#define CP_ORPHAN_PRESENT_FLAG 0x00000002
132#define CP_UMOUNT_FLAG 0x00000001
133
134#define F2FS_CP_PACKS 2
135
136struct f2fs_checkpoint {
137 __le64 checkpoint_ver;
138 __le64 user_block_count;
139 __le64 valid_block_count;
140 __le32 rsvd_segment_count;
141 __le32 overprov_segment_count;
142 __le32 free_segment_count;
143
144
145 __le32 cur_node_segno[MAX_ACTIVE_NODE_LOGS];
146 __le16 cur_node_blkoff[MAX_ACTIVE_NODE_LOGS];
147
148 __le32 cur_data_segno[MAX_ACTIVE_DATA_LOGS];
149 __le16 cur_data_blkoff[MAX_ACTIVE_DATA_LOGS];
150 __le32 ckpt_flags;
151 __le32 cp_pack_total_block_count;
152 __le32 cp_pack_start_sum;
153 __le32 valid_node_count;
154 __le32 valid_inode_count;
155 __le32 next_free_nid;
156 __le32 sit_ver_bitmap_bytesize;
157 __le32 nat_ver_bitmap_bytesize;
158 __le32 checksum_offset;
159 __le64 elapsed_time;
160
161 unsigned char alloc_type[MAX_ACTIVE_LOGS];
162
163
164 unsigned char sit_nat_version_bitmap[1];
165} __packed;
166
167#define CP_CHKSUM_OFFSET 4092
168#define CP_MIN_CHKSUM_OFFSET \
169 (offsetof(struct f2fs_checkpoint, sit_nat_version_bitmap))
170
171
172
173
174#define F2FS_ORPHANS_PER_BLOCK 1020
175
176#define GET_ORPHAN_BLOCKS(n) (((n) + F2FS_ORPHANS_PER_BLOCK - 1) / \
177 F2FS_ORPHANS_PER_BLOCK)
178
179struct f2fs_orphan_block {
180 __le32 ino[F2FS_ORPHANS_PER_BLOCK];
181 __le32 reserved;
182 __le16 blk_addr;
183 __le16 blk_count;
184 __le32 entry_count;
185 __le32 check_sum;
186} __packed;
187
188
189
190
191struct f2fs_extent {
192 __le32 fofs;
193 __le32 blk;
194 __le32 len;
195} __packed;
196
197#define F2FS_NAME_LEN 255
198
199#define DEFAULT_INLINE_XATTR_ADDRS 50
200#define DEF_ADDRS_PER_INODE 923
201#define CUR_ADDRS_PER_INODE(inode) (DEF_ADDRS_PER_INODE - \
202 get_extra_isize(inode))
203#define DEF_NIDS_PER_INODE 5
204#define ADDRS_PER_INODE(inode) addrs_per_inode(inode)
205#define DEF_ADDRS_PER_BLOCK 1018
206#define ADDRS_PER_BLOCK(inode) addrs_per_block(inode)
207#define NIDS_PER_BLOCK 1018
208
209#define ADDRS_PER_PAGE(page, inode) \
210 (IS_INODE(page) ? ADDRS_PER_INODE(inode) : ADDRS_PER_BLOCK(inode))
211
212#define NODE_DIR1_BLOCK (DEF_ADDRS_PER_INODE + 1)
213#define NODE_DIR2_BLOCK (DEF_ADDRS_PER_INODE + 2)
214#define NODE_IND1_BLOCK (DEF_ADDRS_PER_INODE + 3)
215#define NODE_IND2_BLOCK (DEF_ADDRS_PER_INODE + 4)
216#define NODE_DIND_BLOCK (DEF_ADDRS_PER_INODE + 5)
217
218#define F2FS_INLINE_XATTR 0x01
219#define F2FS_INLINE_DATA 0x02
220#define F2FS_INLINE_DENTRY 0x04
221#define F2FS_DATA_EXIST 0x08
222#define F2FS_INLINE_DOTS 0x10
223#define F2FS_EXTRA_ATTR 0x20
224#define F2FS_PIN_FILE 0x40
225
226struct f2fs_inode {
227 __le16 i_mode;
228 __u8 i_advise;
229 __u8 i_inline;
230 __le32 i_uid;
231 __le32 i_gid;
232 __le32 i_links;
233 __le64 i_size;
234 __le64 i_blocks;
235 __le64 i_atime;
236 __le64 i_ctime;
237 __le64 i_mtime;
238 __le32 i_atime_nsec;
239 __le32 i_ctime_nsec;
240 __le32 i_mtime_nsec;
241 __le32 i_generation;
242 union {
243 __le32 i_current_depth;
244 __le16 i_gc_failures;
245
246
247
248 };
249 __le32 i_xattr_nid;
250 __le32 i_flags;
251 __le32 i_pino;
252 __le32 i_namelen;
253 __u8 i_name[F2FS_NAME_LEN];
254 __u8 i_dir_level;
255
256 struct f2fs_extent i_ext;
257
258 union {
259 struct {
260 __le16 i_extra_isize;
261 __le16 i_inline_xattr_size;
262 __le32 i_projid;
263 __le32 i_inode_checksum;
264 __le64 i_crtime;
265 __le32 i_crtime_nsec;
266 __le32 i_extra_end[0];
267 } __packed;
268 __le32 i_addr[DEF_ADDRS_PER_INODE];
269 };
270 __le32 i_nid[DEF_NIDS_PER_INODE];
271
272} __packed;
273
274struct direct_node {
275 __le32 addr[DEF_ADDRS_PER_BLOCK];
276} __packed;
277
278struct indirect_node {
279 __le32 nid[NIDS_PER_BLOCK];
280} __packed;
281
282enum {
283 COLD_BIT_SHIFT = 0,
284 FSYNC_BIT_SHIFT,
285 DENT_BIT_SHIFT,
286 OFFSET_BIT_SHIFT
287};
288
289#define OFFSET_BIT_MASK (0x07)
290
291struct node_footer {
292 __le32 nid;
293 __le32 ino;
294 __le32 flag;
295 __le64 cp_ver;
296 __le32 next_blkaddr;
297} __packed;
298
299struct f2fs_node {
300
301 union {
302 struct f2fs_inode i;
303 struct direct_node dn;
304 struct indirect_node in;
305 };
306 struct node_footer footer;
307} __packed;
308
309
310
311
312#define NAT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_nat_entry))
313
314struct f2fs_nat_entry {
315 __u8 version;
316 __le32 ino;
317 __le32 block_addr;
318} __packed;
319
320struct f2fs_nat_block {
321 struct f2fs_nat_entry entries[NAT_ENTRY_PER_BLOCK];
322} __packed;
323
324
325
326
327
328
329
330
331#define SIT_VBLOCK_MAP_SIZE 64
332#define SIT_ENTRY_PER_BLOCK (PAGE_SIZE / sizeof(struct f2fs_sit_entry))
333
334
335
336
337
338#define F2FS_MAX_SEGMENT ((16 * 1024 * 1024) / 2)
339
340
341
342
343
344
345#define SIT_VBLOCKS_SHIFT 10
346#define SIT_VBLOCKS_MASK ((1 << SIT_VBLOCKS_SHIFT) - 1)
347#define GET_SIT_VBLOCKS(raw_sit) \
348 (le16_to_cpu((raw_sit)->vblocks) & SIT_VBLOCKS_MASK)
349#define GET_SIT_TYPE(raw_sit) \
350 ((le16_to_cpu((raw_sit)->vblocks) & ~SIT_VBLOCKS_MASK) \
351 >> SIT_VBLOCKS_SHIFT)
352
353struct f2fs_sit_entry {
354 __le16 vblocks;
355 __u8 valid_map[SIT_VBLOCK_MAP_SIZE];
356 __le64 mtime;
357} __packed;
358
359struct f2fs_sit_block {
360 struct f2fs_sit_entry entries[SIT_ENTRY_PER_BLOCK];
361} __packed;
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378#define ENTRIES_IN_SUM 512
379#define SUMMARY_SIZE (7)
380#define SUM_FOOTER_SIZE (5)
381#define SUM_ENTRY_SIZE (SUMMARY_SIZE * ENTRIES_IN_SUM)
382
383
384struct f2fs_summary {
385 __le32 nid;
386 union {
387 __u8 reserved[3];
388 struct {
389 __u8 version;
390 __le16 ofs_in_node;
391 } __packed;
392 };
393} __packed;
394
395
396#define SUM_TYPE_NODE (1)
397#define SUM_TYPE_DATA (0)
398
399struct summary_footer {
400 unsigned char entry_type;
401 __le32 check_sum;
402} __packed;
403
404#define SUM_JOURNAL_SIZE (F2FS_BLKSIZE - SUM_FOOTER_SIZE -\
405 SUM_ENTRY_SIZE)
406#define NAT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
407 sizeof(struct nat_journal_entry))
408#define NAT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
409 sizeof(struct nat_journal_entry))
410#define SIT_JOURNAL_ENTRIES ((SUM_JOURNAL_SIZE - 2) /\
411 sizeof(struct sit_journal_entry))
412#define SIT_JOURNAL_RESERVED ((SUM_JOURNAL_SIZE - 2) %\
413 sizeof(struct sit_journal_entry))
414
415
416
417
418#define EXTRA_INFO_RESERVED (SUM_JOURNAL_SIZE - 2 - 8)
419
420
421
422
423
424enum {
425 NAT_JOURNAL = 0,
426 SIT_JOURNAL
427};
428
429struct nat_journal_entry {
430 __le32 nid;
431 struct f2fs_nat_entry ne;
432} __packed;
433
434struct nat_journal {
435 struct nat_journal_entry entries[NAT_JOURNAL_ENTRIES];
436 __u8 reserved[NAT_JOURNAL_RESERVED];
437} __packed;
438
439struct sit_journal_entry {
440 __le32 segno;
441 struct f2fs_sit_entry se;
442} __packed;
443
444struct sit_journal {
445 struct sit_journal_entry entries[SIT_JOURNAL_ENTRIES];
446 __u8 reserved[SIT_JOURNAL_RESERVED];
447} __packed;
448
449struct f2fs_extra_info {
450 __le64 kbytes_written;
451 __u8 reserved[EXTRA_INFO_RESERVED];
452} __packed;
453
454struct f2fs_journal {
455 union {
456 __le16 n_nats;
457 __le16 n_sits;
458 };
459
460 union {
461 struct nat_journal nat_j;
462 struct sit_journal sit_j;
463 struct f2fs_extra_info info;
464 };
465} __packed;
466
467
468struct f2fs_summary_block {
469 struct f2fs_summary entries[ENTRIES_IN_SUM];
470 struct f2fs_journal journal;
471 struct summary_footer footer;
472} __packed;
473
474
475
476
477#define F2FS_DOT_HASH 0
478#define F2FS_DDOT_HASH F2FS_DOT_HASH
479#define F2FS_MAX_HASH (~((0x3ULL) << 62))
480#define F2FS_HASH_COL_BIT ((0x1ULL) << 63)
481
482typedef __le32 f2fs_hash_t;
483
484
485#define F2FS_SLOT_LEN 8
486#define F2FS_SLOT_LEN_BITS 3
487
488#define GET_DENTRY_SLOTS(x) (((x) + F2FS_SLOT_LEN - 1) >> F2FS_SLOT_LEN_BITS)
489
490
491#define MAX_DIR_HASH_DEPTH 63
492
493
494#define MAX_DIR_BUCKETS (1 << ((MAX_DIR_HASH_DEPTH / 2) - 1))
495
496
497
498
499
500
501
502
503
504
505
506
507
508#define NR_DENTRY_IN_BLOCK 214
509#define SIZE_OF_DIR_ENTRY 11
510#define SIZE_OF_DENTRY_BITMAP ((NR_DENTRY_IN_BLOCK + BITS_PER_BYTE - 1) / \
511 BITS_PER_BYTE)
512#define SIZE_OF_RESERVED (PAGE_SIZE - ((SIZE_OF_DIR_ENTRY + \
513 F2FS_SLOT_LEN) * \
514 NR_DENTRY_IN_BLOCK + SIZE_OF_DENTRY_BITMAP))
515#define MIN_INLINE_DENTRY_SIZE 40
516
517
518struct f2fs_dir_entry {
519 __le32 hash_code;
520 __le32 ino;
521 __le16 name_len;
522 __u8 file_type;
523} __packed;
524
525
526struct f2fs_dentry_block {
527
528 __u8 dentry_bitmap[SIZE_OF_DENTRY_BITMAP];
529 __u8 reserved[SIZE_OF_RESERVED];
530 struct f2fs_dir_entry dentry[NR_DENTRY_IN_BLOCK];
531 __u8 filename[NR_DENTRY_IN_BLOCK][F2FS_SLOT_LEN];
532} __packed;
533
534
535enum {
536 F2FS_FT_UNKNOWN,
537 F2FS_FT_REG_FILE,
538 F2FS_FT_DIR,
539 F2FS_FT_CHRDEV,
540 F2FS_FT_BLKDEV,
541 F2FS_FT_FIFO,
542 F2FS_FT_SOCK,
543 F2FS_FT_SYMLINK,
544 F2FS_FT_MAX
545};
546
547#define S_SHIFT 12
548
549#define F2FS_DEF_PROJID 0
550
551#endif
552