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