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