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