1e2be04c7SGreg Kroah-Hartman /* SPDX-License-Identifier: LGPL-2.1+ WITH Linux-syscall-note */
2e63e88bcSRyusuke Konishi /*
3e63e88bcSRyusuke Konishi * nilfs2_ondisk.h - NILFS2 on-disk structures
4e63e88bcSRyusuke Konishi *
5e63e88bcSRyusuke Konishi * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation.
6e63e88bcSRyusuke Konishi *
7e63e88bcSRyusuke Konishi * This program is free software; you can redistribute it and/or modify
8e63e88bcSRyusuke Konishi * it under the terms of the GNU Lesser General Public License as published
9e63e88bcSRyusuke Konishi * by the Free Software Foundation; either version 2.1 of the License, or
10e63e88bcSRyusuke Konishi * (at your option) any later version.
11e63e88bcSRyusuke Konishi */
12e63e88bcSRyusuke Konishi /*
13e63e88bcSRyusuke Konishi * linux/include/linux/ext2_fs.h
14e63e88bcSRyusuke Konishi *
15e63e88bcSRyusuke Konishi * Copyright (C) 1992, 1993, 1994, 1995
16e63e88bcSRyusuke Konishi * Remy Card (card@masi.ibp.fr)
17e63e88bcSRyusuke Konishi * Laboratoire MASI - Institut Blaise Pascal
18e63e88bcSRyusuke Konishi * Universite Pierre et Marie Curie (Paris VI)
19e63e88bcSRyusuke Konishi *
20e63e88bcSRyusuke Konishi * from
21e63e88bcSRyusuke Konishi *
22e63e88bcSRyusuke Konishi * linux/include/linux/minix_fs.h
23e63e88bcSRyusuke Konishi *
24e63e88bcSRyusuke Konishi * Copyright (C) 1991, 1992 Linus Torvalds
25e63e88bcSRyusuke Konishi */
26e63e88bcSRyusuke Konishi
27e63e88bcSRyusuke Konishi #ifndef _LINUX_NILFS2_ONDISK_H
28e63e88bcSRyusuke Konishi #define _LINUX_NILFS2_ONDISK_H
29e63e88bcSRyusuke Konishi
30e63e88bcSRyusuke Konishi #include <linux/types.h>
31e63e88bcSRyusuke Konishi #include <linux/magic.h>
32*c32cc30cSMasahiro Yamada #include <asm/byteorder.h>
33e63e88bcSRyusuke Konishi
34e63e88bcSRyusuke Konishi #define NILFS_INODE_BMAP_SIZE 7
35e63e88bcSRyusuke Konishi
36e63e88bcSRyusuke Konishi /**
37e63e88bcSRyusuke Konishi * struct nilfs_inode - structure of an inode on disk
38e63e88bcSRyusuke Konishi * @i_blocks: blocks count
39e63e88bcSRyusuke Konishi * @i_size: size in bytes
40e63e88bcSRyusuke Konishi * @i_ctime: creation time (seconds)
41e63e88bcSRyusuke Konishi * @i_mtime: modification time (seconds)
42e63e88bcSRyusuke Konishi * @i_ctime_nsec: creation time (nano seconds)
43e63e88bcSRyusuke Konishi * @i_mtime_nsec: modification time (nano seconds)
44e63e88bcSRyusuke Konishi * @i_uid: user id
45e63e88bcSRyusuke Konishi * @i_gid: group id
46e63e88bcSRyusuke Konishi * @i_mode: file mode
47e63e88bcSRyusuke Konishi * @i_links_count: links count
48e63e88bcSRyusuke Konishi * @i_flags: file flags
49e63e88bcSRyusuke Konishi * @i_bmap: block mapping
50e63e88bcSRyusuke Konishi * @i_xattr: extended attributes
51e63e88bcSRyusuke Konishi * @i_generation: file generation (for NFS)
52e63e88bcSRyusuke Konishi * @i_pad: padding
53e63e88bcSRyusuke Konishi */
54e63e88bcSRyusuke Konishi struct nilfs_inode {
55e63e88bcSRyusuke Konishi __le64 i_blocks;
56e63e88bcSRyusuke Konishi __le64 i_size;
57e63e88bcSRyusuke Konishi __le64 i_ctime;
58e63e88bcSRyusuke Konishi __le64 i_mtime;
59e63e88bcSRyusuke Konishi __le32 i_ctime_nsec;
60e63e88bcSRyusuke Konishi __le32 i_mtime_nsec;
61e63e88bcSRyusuke Konishi __le32 i_uid;
62e63e88bcSRyusuke Konishi __le32 i_gid;
63e63e88bcSRyusuke Konishi __le16 i_mode;
64e63e88bcSRyusuke Konishi __le16 i_links_count;
65e63e88bcSRyusuke Konishi __le32 i_flags;
66e63e88bcSRyusuke Konishi __le64 i_bmap[NILFS_INODE_BMAP_SIZE];
67e63e88bcSRyusuke Konishi #define i_device_code i_bmap[0]
68e63e88bcSRyusuke Konishi __le64 i_xattr;
69e63e88bcSRyusuke Konishi __le32 i_generation;
70e63e88bcSRyusuke Konishi __le32 i_pad;
71e63e88bcSRyusuke Konishi };
72e63e88bcSRyusuke Konishi
73e63e88bcSRyusuke Konishi #define NILFS_MIN_INODE_SIZE 128
74e63e88bcSRyusuke Konishi
75e63e88bcSRyusuke Konishi /**
76e63e88bcSRyusuke Konishi * struct nilfs_super_root - structure of super root
77e63e88bcSRyusuke Konishi * @sr_sum: check sum
78e63e88bcSRyusuke Konishi * @sr_bytes: byte count of the structure
79e63e88bcSRyusuke Konishi * @sr_flags: flags (reserved)
80e63e88bcSRyusuke Konishi * @sr_nongc_ctime: write time of the last segment not for cleaner operation
81e63e88bcSRyusuke Konishi * @sr_dat: DAT file inode
82e63e88bcSRyusuke Konishi * @sr_cpfile: checkpoint file inode
83e63e88bcSRyusuke Konishi * @sr_sufile: segment usage file inode
84e63e88bcSRyusuke Konishi */
85e63e88bcSRyusuke Konishi struct nilfs_super_root {
86e63e88bcSRyusuke Konishi __le32 sr_sum;
87e63e88bcSRyusuke Konishi __le16 sr_bytes;
88e63e88bcSRyusuke Konishi __le16 sr_flags;
89e63e88bcSRyusuke Konishi __le64 sr_nongc_ctime;
90e63e88bcSRyusuke Konishi struct nilfs_inode sr_dat;
91e63e88bcSRyusuke Konishi struct nilfs_inode sr_cpfile;
92e63e88bcSRyusuke Konishi struct nilfs_inode sr_sufile;
93e63e88bcSRyusuke Konishi };
94e63e88bcSRyusuke Konishi
95e63e88bcSRyusuke Konishi #define NILFS_SR_MDT_OFFSET(inode_size, i) \
96e63e88bcSRyusuke Konishi ((unsigned long)&((struct nilfs_super_root *)0)->sr_dat + \
97e63e88bcSRyusuke Konishi (inode_size) * (i))
98e63e88bcSRyusuke Konishi #define NILFS_SR_DAT_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 0)
99e63e88bcSRyusuke Konishi #define NILFS_SR_CPFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 1)
100e63e88bcSRyusuke Konishi #define NILFS_SR_SUFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 2)
101e63e88bcSRyusuke Konishi #define NILFS_SR_BYTES(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 3)
102e63e88bcSRyusuke Konishi
103e63e88bcSRyusuke Konishi /*
104e63e88bcSRyusuke Konishi * Maximal mount counts
105e63e88bcSRyusuke Konishi */
106e63e88bcSRyusuke Konishi #define NILFS_DFL_MAX_MNT_COUNT 50 /* 50 mounts */
107e63e88bcSRyusuke Konishi
108e63e88bcSRyusuke Konishi /*
109e63e88bcSRyusuke Konishi * File system states (sbp->s_state, nilfs->ns_mount_state)
110e63e88bcSRyusuke Konishi */
111e63e88bcSRyusuke Konishi #define NILFS_VALID_FS 0x0001 /* Unmounted cleanly */
112e63e88bcSRyusuke Konishi #define NILFS_ERROR_FS 0x0002 /* Errors detected */
113e63e88bcSRyusuke Konishi #define NILFS_RESIZE_FS 0x0004 /* Resize required */
114e63e88bcSRyusuke Konishi
115e63e88bcSRyusuke Konishi /*
116e63e88bcSRyusuke Konishi * Mount flags (sbi->s_mount_opt)
117e63e88bcSRyusuke Konishi */
118e63e88bcSRyusuke Konishi #define NILFS_MOUNT_ERROR_MODE 0x0070 /* Error mode mask */
119e63e88bcSRyusuke Konishi #define NILFS_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */
120e63e88bcSRyusuke Konishi #define NILFS_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */
121e63e88bcSRyusuke Konishi #define NILFS_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */
122e63e88bcSRyusuke Konishi #define NILFS_MOUNT_BARRIER 0x1000 /* Use block barriers */
123e63e88bcSRyusuke Konishi #define NILFS_MOUNT_STRICT_ORDER 0x2000 /*
124e63e88bcSRyusuke Konishi * Apply strict in-order
125e63e88bcSRyusuke Konishi * semantics also for data
126e63e88bcSRyusuke Konishi */
127e63e88bcSRyusuke Konishi #define NILFS_MOUNT_NORECOVERY 0x4000 /*
128e63e88bcSRyusuke Konishi * Disable write access during
129e63e88bcSRyusuke Konishi * mount-time recovery
130e63e88bcSRyusuke Konishi */
131e63e88bcSRyusuke Konishi #define NILFS_MOUNT_DISCARD 0x8000 /* Issue DISCARD requests */
132e63e88bcSRyusuke Konishi
133e63e88bcSRyusuke Konishi
134e63e88bcSRyusuke Konishi /**
135e63e88bcSRyusuke Konishi * struct nilfs_super_block - structure of super block on disk
136e63e88bcSRyusuke Konishi */
137e63e88bcSRyusuke Konishi struct nilfs_super_block {
138e63e88bcSRyusuke Konishi /*00*/ __le32 s_rev_level; /* Revision level */
139e63e88bcSRyusuke Konishi __le16 s_minor_rev_level; /* minor revision level */
140e63e88bcSRyusuke Konishi __le16 s_magic; /* Magic signature */
141e63e88bcSRyusuke Konishi
142e63e88bcSRyusuke Konishi __le16 s_bytes; /*
143e63e88bcSRyusuke Konishi * Bytes count of CRC calculation
144e63e88bcSRyusuke Konishi * for this structure. s_reserved
145e63e88bcSRyusuke Konishi * is excluded.
146e63e88bcSRyusuke Konishi */
147e63e88bcSRyusuke Konishi __le16 s_flags; /* flags */
148e63e88bcSRyusuke Konishi __le32 s_crc_seed; /* Seed value of CRC calculation */
149e63e88bcSRyusuke Konishi /*10*/ __le32 s_sum; /* Check sum of super block */
150e63e88bcSRyusuke Konishi
151e63e88bcSRyusuke Konishi __le32 s_log_block_size; /*
152e63e88bcSRyusuke Konishi * Block size represented as follows
153e63e88bcSRyusuke Konishi * blocksize =
154e63e88bcSRyusuke Konishi * 1 << (s_log_block_size + 10)
155e63e88bcSRyusuke Konishi */
156e63e88bcSRyusuke Konishi __le64 s_nsegments; /* Number of segments in filesystem */
157e63e88bcSRyusuke Konishi /*20*/ __le64 s_dev_size; /* block device size in bytes */
158e63e88bcSRyusuke Konishi __le64 s_first_data_block; /* 1st seg disk block number */
159e63e88bcSRyusuke Konishi /*30*/ __le32 s_blocks_per_segment; /* number of blocks per full segment */
160e63e88bcSRyusuke Konishi __le32 s_r_segments_percentage; /* Reserved segments percentage */
161e63e88bcSRyusuke Konishi
162e63e88bcSRyusuke Konishi __le64 s_last_cno; /* Last checkpoint number */
163e63e88bcSRyusuke Konishi /*40*/ __le64 s_last_pseg; /* disk block addr pseg written last */
164e63e88bcSRyusuke Konishi __le64 s_last_seq; /* seq. number of seg written last */
165e63e88bcSRyusuke Konishi /*50*/ __le64 s_free_blocks_count; /* Free blocks count */
166e63e88bcSRyusuke Konishi
167e63e88bcSRyusuke Konishi __le64 s_ctime; /*
168e63e88bcSRyusuke Konishi * Creation time (execution time of
169e63e88bcSRyusuke Konishi * newfs)
170e63e88bcSRyusuke Konishi */
171e63e88bcSRyusuke Konishi /*60*/ __le64 s_mtime; /* Mount time */
172e63e88bcSRyusuke Konishi __le64 s_wtime; /* Write time */
173e63e88bcSRyusuke Konishi /*70*/ __le16 s_mnt_count; /* Mount count */
174e63e88bcSRyusuke Konishi __le16 s_max_mnt_count; /* Maximal mount count */
175e63e88bcSRyusuke Konishi __le16 s_state; /* File system state */
176e63e88bcSRyusuke Konishi __le16 s_errors; /* Behaviour when detecting errors */
177e63e88bcSRyusuke Konishi __le64 s_lastcheck; /* time of last check */
178e63e88bcSRyusuke Konishi
179e63e88bcSRyusuke Konishi /*80*/ __le32 s_checkinterval; /* max. time between checks */
180e63e88bcSRyusuke Konishi __le32 s_creator_os; /* OS */
181e63e88bcSRyusuke Konishi __le16 s_def_resuid; /* Default uid for reserved blocks */
182e63e88bcSRyusuke Konishi __le16 s_def_resgid; /* Default gid for reserved blocks */
183e63e88bcSRyusuke Konishi __le32 s_first_ino; /* First non-reserved inode */
184e63e88bcSRyusuke Konishi
185e63e88bcSRyusuke Konishi /*90*/ __le16 s_inode_size; /* Size of an inode */
186e63e88bcSRyusuke Konishi __le16 s_dat_entry_size; /* Size of a dat entry */
187e63e88bcSRyusuke Konishi __le16 s_checkpoint_size; /* Size of a checkpoint */
188e63e88bcSRyusuke Konishi __le16 s_segment_usage_size; /* Size of a segment usage */
189e63e88bcSRyusuke Konishi
190e63e88bcSRyusuke Konishi /*98*/ __u8 s_uuid[16]; /* 128-bit uuid for volume */
191e63e88bcSRyusuke Konishi /*A8*/ char s_volume_name[80]; /* volume name */
192e63e88bcSRyusuke Konishi
193e63e88bcSRyusuke Konishi /*F8*/ __le32 s_c_interval; /* Commit interval of segment */
194e63e88bcSRyusuke Konishi __le32 s_c_block_max; /*
195e63e88bcSRyusuke Konishi * Threshold of data amount for
196e63e88bcSRyusuke Konishi * the segment construction
197e63e88bcSRyusuke Konishi */
198e63e88bcSRyusuke Konishi /*100*/ __le64 s_feature_compat; /* Compatible feature set */
199e63e88bcSRyusuke Konishi __le64 s_feature_compat_ro; /* Read-only compatible feature set */
200e63e88bcSRyusuke Konishi __le64 s_feature_incompat; /* Incompatible feature set */
201e63e88bcSRyusuke Konishi __u32 s_reserved[186]; /* padding to the end of the block */
202e63e88bcSRyusuke Konishi };
203e63e88bcSRyusuke Konishi
204e63e88bcSRyusuke Konishi /*
205e63e88bcSRyusuke Konishi * Codes for operating systems
206e63e88bcSRyusuke Konishi */
207e63e88bcSRyusuke Konishi #define NILFS_OS_LINUX 0
208e63e88bcSRyusuke Konishi /* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */
209e63e88bcSRyusuke Konishi
210e63e88bcSRyusuke Konishi /*
211e63e88bcSRyusuke Konishi * Revision levels
212e63e88bcSRyusuke Konishi */
213e63e88bcSRyusuke Konishi #define NILFS_CURRENT_REV 2 /* current major revision */
214e63e88bcSRyusuke Konishi #define NILFS_MINOR_REV 0 /* minor revision */
215e63e88bcSRyusuke Konishi #define NILFS_MIN_SUPP_REV 2 /* minimum supported revision */
216e63e88bcSRyusuke Konishi
217e63e88bcSRyusuke Konishi /*
218e63e88bcSRyusuke Konishi * Feature set definitions
219e63e88bcSRyusuke Konishi *
220e63e88bcSRyusuke Konishi * If there is a bit set in the incompatible feature set that the kernel
221e63e88bcSRyusuke Konishi * doesn't know about, it should refuse to mount the filesystem.
222e63e88bcSRyusuke Konishi */
223e63e88bcSRyusuke Konishi #define NILFS_FEATURE_COMPAT_RO_BLOCK_COUNT 0x00000001ULL
224e63e88bcSRyusuke Konishi
225e63e88bcSRyusuke Konishi #define NILFS_FEATURE_COMPAT_SUPP 0ULL
226e63e88bcSRyusuke Konishi #define NILFS_FEATURE_COMPAT_RO_SUPP NILFS_FEATURE_COMPAT_RO_BLOCK_COUNT
227e63e88bcSRyusuke Konishi #define NILFS_FEATURE_INCOMPAT_SUPP 0ULL
228e63e88bcSRyusuke Konishi
229e63e88bcSRyusuke Konishi /*
230e63e88bcSRyusuke Konishi * Bytes count of super_block for CRC-calculation
231e63e88bcSRyusuke Konishi */
232e63e88bcSRyusuke Konishi #define NILFS_SB_BYTES \
233e63e88bcSRyusuke Konishi ((long)&((struct nilfs_super_block *)0)->s_reserved)
234e63e88bcSRyusuke Konishi
235e63e88bcSRyusuke Konishi /*
236e63e88bcSRyusuke Konishi * Special inode number
237e63e88bcSRyusuke Konishi */
238e63e88bcSRyusuke Konishi #define NILFS_ROOT_INO 2 /* Root file inode */
239e63e88bcSRyusuke Konishi #define NILFS_DAT_INO 3 /* DAT file */
240e63e88bcSRyusuke Konishi #define NILFS_CPFILE_INO 4 /* checkpoint file */
241e63e88bcSRyusuke Konishi #define NILFS_SUFILE_INO 5 /* segment usage file */
242e63e88bcSRyusuke Konishi #define NILFS_IFILE_INO 6 /* ifile */
243e63e88bcSRyusuke Konishi #define NILFS_ATIME_INO 7 /* Atime file (reserved) */
244e63e88bcSRyusuke Konishi #define NILFS_XATTR_INO 8 /* Xattribute file (reserved) */
245e63e88bcSRyusuke Konishi #define NILFS_SKETCH_INO 10 /* Sketch file */
246e63e88bcSRyusuke Konishi #define NILFS_USER_INO 11 /* Fisrt user's file inode number */
247e63e88bcSRyusuke Konishi
248e63e88bcSRyusuke Konishi #define NILFS_SB_OFFSET_BYTES 1024 /* byte offset of nilfs superblock */
249e63e88bcSRyusuke Konishi
250e63e88bcSRyusuke Konishi #define NILFS_SEG_MIN_BLOCKS 16 /*
251e63e88bcSRyusuke Konishi * Minimum number of blocks in
252e63e88bcSRyusuke Konishi * a full segment
253e63e88bcSRyusuke Konishi */
254e63e88bcSRyusuke Konishi #define NILFS_PSEG_MIN_BLOCKS 2 /*
255e63e88bcSRyusuke Konishi * Minimum number of blocks in
256e63e88bcSRyusuke Konishi * a partial segment
257e63e88bcSRyusuke Konishi */
258e63e88bcSRyusuke Konishi #define NILFS_MIN_NRSVSEGS 8 /*
259e63e88bcSRyusuke Konishi * Minimum number of reserved
260e63e88bcSRyusuke Konishi * segments
261e63e88bcSRyusuke Konishi */
262e63e88bcSRyusuke Konishi
263e63e88bcSRyusuke Konishi /*
264e63e88bcSRyusuke Konishi * We call DAT, cpfile, and sufile root metadata files. Inodes of
265e63e88bcSRyusuke Konishi * these files are written in super root block instead of ifile, and
266e63e88bcSRyusuke Konishi * garbage collector doesn't keep any past versions of these files.
267e63e88bcSRyusuke Konishi */
268e63e88bcSRyusuke Konishi #define NILFS_ROOT_METADATA_FILE(ino) \
269e63e88bcSRyusuke Konishi ((ino) >= NILFS_DAT_INO && (ino) <= NILFS_SUFILE_INO)
270e63e88bcSRyusuke Konishi
271e63e88bcSRyusuke Konishi /*
272e63e88bcSRyusuke Konishi * bytes offset of secondary super block
273e63e88bcSRyusuke Konishi */
274e63e88bcSRyusuke Konishi #define NILFS_SB2_OFFSET_BYTES(devsize) ((((devsize) >> 12) - 1) << 12)
275e63e88bcSRyusuke Konishi
276e63e88bcSRyusuke Konishi /*
277e63e88bcSRyusuke Konishi * Maximal count of links to a file
278e63e88bcSRyusuke Konishi */
279e63e88bcSRyusuke Konishi #define NILFS_LINK_MAX 32000
280e63e88bcSRyusuke Konishi
281e63e88bcSRyusuke Konishi /*
282e63e88bcSRyusuke Konishi * Structure of a directory entry
283e63e88bcSRyusuke Konishi * (Same as ext2)
284e63e88bcSRyusuke Konishi */
285e63e88bcSRyusuke Konishi
286e63e88bcSRyusuke Konishi #define NILFS_NAME_LEN 255
287e63e88bcSRyusuke Konishi
288e63e88bcSRyusuke Konishi /*
289e63e88bcSRyusuke Konishi * Block size limitations
290e63e88bcSRyusuke Konishi */
291e63e88bcSRyusuke Konishi #define NILFS_MIN_BLOCK_SIZE 1024
292e63e88bcSRyusuke Konishi #define NILFS_MAX_BLOCK_SIZE 65536
293e63e88bcSRyusuke Konishi
294e63e88bcSRyusuke Konishi /*
295e63e88bcSRyusuke Konishi * The new version of the directory entry. Since V0 structures are
296e63e88bcSRyusuke Konishi * stored in intel byte order, and the name_len field could never be
297e63e88bcSRyusuke Konishi * bigger than 255 chars, it's safe to reclaim the extra byte for the
298e63e88bcSRyusuke Konishi * file_type field.
299e63e88bcSRyusuke Konishi */
300e63e88bcSRyusuke Konishi struct nilfs_dir_entry {
301e63e88bcSRyusuke Konishi __le64 inode; /* Inode number */
302e63e88bcSRyusuke Konishi __le16 rec_len; /* Directory entry length */
303e63e88bcSRyusuke Konishi __u8 name_len; /* Name length */
304e63e88bcSRyusuke Konishi __u8 file_type; /* Dir entry type (file, dir, etc) */
305e63e88bcSRyusuke Konishi char name[NILFS_NAME_LEN]; /* File name */
306e63e88bcSRyusuke Konishi char pad;
307e63e88bcSRyusuke Konishi };
308e63e88bcSRyusuke Konishi
309e63e88bcSRyusuke Konishi /*
310e63e88bcSRyusuke Konishi * NILFS directory file types. Only the low 3 bits are used. The
311e63e88bcSRyusuke Konishi * other bits are reserved for now.
312e63e88bcSRyusuke Konishi */
313e63e88bcSRyusuke Konishi enum {
314e63e88bcSRyusuke Konishi NILFS_FT_UNKNOWN,
315e63e88bcSRyusuke Konishi NILFS_FT_REG_FILE,
316e63e88bcSRyusuke Konishi NILFS_FT_DIR,
317e63e88bcSRyusuke Konishi NILFS_FT_CHRDEV,
318e63e88bcSRyusuke Konishi NILFS_FT_BLKDEV,
319e63e88bcSRyusuke Konishi NILFS_FT_FIFO,
320e63e88bcSRyusuke Konishi NILFS_FT_SOCK,
321e63e88bcSRyusuke Konishi NILFS_FT_SYMLINK,
322e63e88bcSRyusuke Konishi NILFS_FT_MAX
323e63e88bcSRyusuke Konishi };
324e63e88bcSRyusuke Konishi
325e63e88bcSRyusuke Konishi /*
326e63e88bcSRyusuke Konishi * NILFS_DIR_PAD defines the directory entries boundaries
327e63e88bcSRyusuke Konishi *
328e63e88bcSRyusuke Konishi * NOTE: It must be a multiple of 8
329e63e88bcSRyusuke Konishi */
330e63e88bcSRyusuke Konishi #define NILFS_DIR_PAD 8
331e63e88bcSRyusuke Konishi #define NILFS_DIR_ROUND (NILFS_DIR_PAD - 1)
332e63e88bcSRyusuke Konishi #define NILFS_DIR_REC_LEN(name_len) (((name_len) + 12 + NILFS_DIR_ROUND) & \
333e63e88bcSRyusuke Konishi ~NILFS_DIR_ROUND)
334e63e88bcSRyusuke Konishi #define NILFS_MAX_REC_LEN ((1 << 16) - 1)
335e63e88bcSRyusuke Konishi
336e63e88bcSRyusuke Konishi /**
337e63e88bcSRyusuke Konishi * struct nilfs_finfo - file information
338e63e88bcSRyusuke Konishi * @fi_ino: inode number
339e63e88bcSRyusuke Konishi * @fi_cno: checkpoint number
340e63e88bcSRyusuke Konishi * @fi_nblocks: number of blocks (including intermediate blocks)
341e63e88bcSRyusuke Konishi * @fi_ndatablk: number of file data blocks
342e63e88bcSRyusuke Konishi */
343e63e88bcSRyusuke Konishi struct nilfs_finfo {
344e63e88bcSRyusuke Konishi __le64 fi_ino;
345e63e88bcSRyusuke Konishi __le64 fi_cno;
346e63e88bcSRyusuke Konishi __le32 fi_nblocks;
347e63e88bcSRyusuke Konishi __le32 fi_ndatablk;
348e63e88bcSRyusuke Konishi };
349e63e88bcSRyusuke Konishi
350e63e88bcSRyusuke Konishi /**
351e63e88bcSRyusuke Konishi * struct nilfs_binfo_v - information on a data block (except DAT)
352e63e88bcSRyusuke Konishi * @bi_vblocknr: virtual block number
353e63e88bcSRyusuke Konishi * @bi_blkoff: block offset
354e63e88bcSRyusuke Konishi */
355e63e88bcSRyusuke Konishi struct nilfs_binfo_v {
356e63e88bcSRyusuke Konishi __le64 bi_vblocknr;
357e63e88bcSRyusuke Konishi __le64 bi_blkoff;
358e63e88bcSRyusuke Konishi };
359e63e88bcSRyusuke Konishi
360e63e88bcSRyusuke Konishi /**
361e63e88bcSRyusuke Konishi * struct nilfs_binfo_dat - information on a DAT node block
362e63e88bcSRyusuke Konishi * @bi_blkoff: block offset
363e63e88bcSRyusuke Konishi * @bi_level: level
364e63e88bcSRyusuke Konishi * @bi_pad: padding
365e63e88bcSRyusuke Konishi */
366e63e88bcSRyusuke Konishi struct nilfs_binfo_dat {
367e63e88bcSRyusuke Konishi __le64 bi_blkoff;
368e63e88bcSRyusuke Konishi __u8 bi_level;
369e63e88bcSRyusuke Konishi __u8 bi_pad[7];
370e63e88bcSRyusuke Konishi };
371e63e88bcSRyusuke Konishi
372e63e88bcSRyusuke Konishi /**
373e63e88bcSRyusuke Konishi * union nilfs_binfo: block information
374e63e88bcSRyusuke Konishi * @bi_v: nilfs_binfo_v structure
375e63e88bcSRyusuke Konishi * @bi_dat: nilfs_binfo_dat structure
376e63e88bcSRyusuke Konishi */
377e63e88bcSRyusuke Konishi union nilfs_binfo {
378e63e88bcSRyusuke Konishi struct nilfs_binfo_v bi_v;
379e63e88bcSRyusuke Konishi struct nilfs_binfo_dat bi_dat;
380e63e88bcSRyusuke Konishi };
381e63e88bcSRyusuke Konishi
382e63e88bcSRyusuke Konishi /**
383e63e88bcSRyusuke Konishi * struct nilfs_segment_summary - segment summary header
384e63e88bcSRyusuke Konishi * @ss_datasum: checksum of data
385e63e88bcSRyusuke Konishi * @ss_sumsum: checksum of segment summary
386e63e88bcSRyusuke Konishi * @ss_magic: magic number
387e63e88bcSRyusuke Konishi * @ss_bytes: size of this structure in bytes
388e63e88bcSRyusuke Konishi * @ss_flags: flags
389e63e88bcSRyusuke Konishi * @ss_seq: sequence number
390e63e88bcSRyusuke Konishi * @ss_create: creation timestamp
391e63e88bcSRyusuke Konishi * @ss_next: next segment
392e63e88bcSRyusuke Konishi * @ss_nblocks: number of blocks
393e63e88bcSRyusuke Konishi * @ss_nfinfo: number of finfo structures
394e63e88bcSRyusuke Konishi * @ss_sumbytes: total size of segment summary in bytes
395e63e88bcSRyusuke Konishi * @ss_pad: padding
396e63e88bcSRyusuke Konishi * @ss_cno: checkpoint number
397e63e88bcSRyusuke Konishi */
398e63e88bcSRyusuke Konishi struct nilfs_segment_summary {
399e63e88bcSRyusuke Konishi __le32 ss_datasum;
400e63e88bcSRyusuke Konishi __le32 ss_sumsum;
401e63e88bcSRyusuke Konishi __le32 ss_magic;
402e63e88bcSRyusuke Konishi __le16 ss_bytes;
403e63e88bcSRyusuke Konishi __le16 ss_flags;
404e63e88bcSRyusuke Konishi __le64 ss_seq;
405e63e88bcSRyusuke Konishi __le64 ss_create;
406e63e88bcSRyusuke Konishi __le64 ss_next;
407e63e88bcSRyusuke Konishi __le32 ss_nblocks;
408e63e88bcSRyusuke Konishi __le32 ss_nfinfo;
409e63e88bcSRyusuke Konishi __le32 ss_sumbytes;
410e63e88bcSRyusuke Konishi __le32 ss_pad;
411e63e88bcSRyusuke Konishi __le64 ss_cno;
412e63e88bcSRyusuke Konishi /* array of finfo structures */
413e63e88bcSRyusuke Konishi };
414e63e88bcSRyusuke Konishi
415e63e88bcSRyusuke Konishi #define NILFS_SEGSUM_MAGIC 0x1eaffa11 /* segment summary magic number */
416e63e88bcSRyusuke Konishi
417e63e88bcSRyusuke Konishi /*
418e63e88bcSRyusuke Konishi * Segment summary flags
419e63e88bcSRyusuke Konishi */
420e63e88bcSRyusuke Konishi #define NILFS_SS_LOGBGN 0x0001 /* begins a logical segment */
421e63e88bcSRyusuke Konishi #define NILFS_SS_LOGEND 0x0002 /* ends a logical segment */
422e63e88bcSRyusuke Konishi #define NILFS_SS_SR 0x0004 /* has super root */
423e63e88bcSRyusuke Konishi #define NILFS_SS_SYNDT 0x0008 /* includes data only updates */
424e63e88bcSRyusuke Konishi #define NILFS_SS_GC 0x0010 /* segment written for cleaner operation */
425e63e88bcSRyusuke Konishi
426e63e88bcSRyusuke Konishi /**
427e63e88bcSRyusuke Konishi * struct nilfs_btree_node - header of B-tree node block
428e63e88bcSRyusuke Konishi * @bn_flags: flags
429e63e88bcSRyusuke Konishi * @bn_level: level
430e63e88bcSRyusuke Konishi * @bn_nchildren: number of children
431e63e88bcSRyusuke Konishi * @bn_pad: padding
432e63e88bcSRyusuke Konishi */
433e63e88bcSRyusuke Konishi struct nilfs_btree_node {
434e63e88bcSRyusuke Konishi __u8 bn_flags;
435e63e88bcSRyusuke Konishi __u8 bn_level;
436e63e88bcSRyusuke Konishi __le16 bn_nchildren;
437e63e88bcSRyusuke Konishi __le32 bn_pad;
438e63e88bcSRyusuke Konishi };
439e63e88bcSRyusuke Konishi
440e63e88bcSRyusuke Konishi /* flags */
441e63e88bcSRyusuke Konishi #define NILFS_BTREE_NODE_ROOT 0x01
442e63e88bcSRyusuke Konishi
443e63e88bcSRyusuke Konishi /* level */
444e63e88bcSRyusuke Konishi #define NILFS_BTREE_LEVEL_DATA 0
445e63e88bcSRyusuke Konishi #define NILFS_BTREE_LEVEL_NODE_MIN (NILFS_BTREE_LEVEL_DATA + 1)
446e63e88bcSRyusuke Konishi #define NILFS_BTREE_LEVEL_MAX 14 /* Max level (exclusive) */
447e63e88bcSRyusuke Konishi
448e63e88bcSRyusuke Konishi /**
449e63e88bcSRyusuke Konishi * struct nilfs_direct_node - header of built-in bmap array
450e63e88bcSRyusuke Konishi * @dn_flags: flags
451e63e88bcSRyusuke Konishi * @dn_pad: padding
452e63e88bcSRyusuke Konishi */
453e63e88bcSRyusuke Konishi struct nilfs_direct_node {
454e63e88bcSRyusuke Konishi __u8 dn_flags;
455e63e88bcSRyusuke Konishi __u8 pad[7];
456e63e88bcSRyusuke Konishi };
457e63e88bcSRyusuke Konishi
458e63e88bcSRyusuke Konishi /**
459e63e88bcSRyusuke Konishi * struct nilfs_palloc_group_desc - block group descriptor
460e63e88bcSRyusuke Konishi * @pg_nfrees: number of free entries in block group
461e63e88bcSRyusuke Konishi */
462e63e88bcSRyusuke Konishi struct nilfs_palloc_group_desc {
463e63e88bcSRyusuke Konishi __le32 pg_nfrees;
464e63e88bcSRyusuke Konishi };
465e63e88bcSRyusuke Konishi
466e63e88bcSRyusuke Konishi /**
467e63e88bcSRyusuke Konishi * struct nilfs_dat_entry - disk address translation entry
468e63e88bcSRyusuke Konishi * @de_blocknr: block number
469e63e88bcSRyusuke Konishi * @de_start: start checkpoint number
470e63e88bcSRyusuke Konishi * @de_end: end checkpoint number
471e63e88bcSRyusuke Konishi * @de_rsv: reserved for future use
472e63e88bcSRyusuke Konishi */
473e63e88bcSRyusuke Konishi struct nilfs_dat_entry {
474e63e88bcSRyusuke Konishi __le64 de_blocknr;
475e63e88bcSRyusuke Konishi __le64 de_start;
476e63e88bcSRyusuke Konishi __le64 de_end;
477e63e88bcSRyusuke Konishi __le64 de_rsv;
478e63e88bcSRyusuke Konishi };
479e63e88bcSRyusuke Konishi
480e63e88bcSRyusuke Konishi #define NILFS_MIN_DAT_ENTRY_SIZE 32
481e63e88bcSRyusuke Konishi
482e63e88bcSRyusuke Konishi /**
483e63e88bcSRyusuke Konishi * struct nilfs_snapshot_list - snapshot list
484e63e88bcSRyusuke Konishi * @ssl_next: next checkpoint number on snapshot list
485e63e88bcSRyusuke Konishi * @ssl_prev: previous checkpoint number on snapshot list
486e63e88bcSRyusuke Konishi */
487e63e88bcSRyusuke Konishi struct nilfs_snapshot_list {
488e63e88bcSRyusuke Konishi __le64 ssl_next;
489e63e88bcSRyusuke Konishi __le64 ssl_prev;
490e63e88bcSRyusuke Konishi };
491e63e88bcSRyusuke Konishi
492e63e88bcSRyusuke Konishi /**
493e63e88bcSRyusuke Konishi * struct nilfs_checkpoint - checkpoint structure
494e63e88bcSRyusuke Konishi * @cp_flags: flags
495e63e88bcSRyusuke Konishi * @cp_checkpoints_count: checkpoints count in a block
496e63e88bcSRyusuke Konishi * @cp_snapshot_list: snapshot list
497e63e88bcSRyusuke Konishi * @cp_cno: checkpoint number
498e63e88bcSRyusuke Konishi * @cp_create: creation timestamp
499e63e88bcSRyusuke Konishi * @cp_nblk_inc: number of blocks incremented by this checkpoint
500e63e88bcSRyusuke Konishi * @cp_inodes_count: inodes count
501e63e88bcSRyusuke Konishi * @cp_blocks_count: blocks count
502e63e88bcSRyusuke Konishi * @cp_ifile_inode: inode of ifile
503e63e88bcSRyusuke Konishi */
504e63e88bcSRyusuke Konishi struct nilfs_checkpoint {
505e63e88bcSRyusuke Konishi __le32 cp_flags;
506e63e88bcSRyusuke Konishi __le32 cp_checkpoints_count;
507e63e88bcSRyusuke Konishi struct nilfs_snapshot_list cp_snapshot_list;
508e63e88bcSRyusuke Konishi __le64 cp_cno;
509e63e88bcSRyusuke Konishi __le64 cp_create;
510e63e88bcSRyusuke Konishi __le64 cp_nblk_inc;
511e63e88bcSRyusuke Konishi __le64 cp_inodes_count;
512e63e88bcSRyusuke Konishi __le64 cp_blocks_count;
513e63e88bcSRyusuke Konishi
514e63e88bcSRyusuke Konishi /*
515e63e88bcSRyusuke Konishi * Do not change the byte offset of ifile inode.
516e63e88bcSRyusuke Konishi * To keep the compatibility of the disk format,
517e63e88bcSRyusuke Konishi * additional fields should be added behind cp_ifile_inode.
518e63e88bcSRyusuke Konishi */
519e63e88bcSRyusuke Konishi struct nilfs_inode cp_ifile_inode;
520e63e88bcSRyusuke Konishi };
521e63e88bcSRyusuke Konishi
522e63e88bcSRyusuke Konishi #define NILFS_MIN_CHECKPOINT_SIZE (64 + NILFS_MIN_INODE_SIZE)
523e63e88bcSRyusuke Konishi
524e63e88bcSRyusuke Konishi /* checkpoint flags */
525e63e88bcSRyusuke Konishi enum {
526e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_SNAPSHOT,
527e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_INVALID,
528e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_SKETCH,
529e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_MINOR,
530e63e88bcSRyusuke Konishi };
531e63e88bcSRyusuke Konishi
532e63e88bcSRyusuke Konishi #define NILFS_CHECKPOINT_FNS(flag, name) \
533e63e88bcSRyusuke Konishi static inline void \
534e63e88bcSRyusuke Konishi nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp) \
535e63e88bcSRyusuke Konishi { \
536*c32cc30cSMasahiro Yamada cp->cp_flags = __cpu_to_le32(__le32_to_cpu(cp->cp_flags) | \
537e63e88bcSRyusuke Konishi (1UL << NILFS_CHECKPOINT_##flag)); \
538e63e88bcSRyusuke Konishi } \
539e63e88bcSRyusuke Konishi static inline void \
540e63e88bcSRyusuke Konishi nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp) \
541e63e88bcSRyusuke Konishi { \
542*c32cc30cSMasahiro Yamada cp->cp_flags = __cpu_to_le32(__le32_to_cpu(cp->cp_flags) & \
543e63e88bcSRyusuke Konishi ~(1UL << NILFS_CHECKPOINT_##flag)); \
544e63e88bcSRyusuke Konishi } \
545e63e88bcSRyusuke Konishi static inline int \
546e63e88bcSRyusuke Konishi nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp) \
547e63e88bcSRyusuke Konishi { \
548*c32cc30cSMasahiro Yamada return !!(__le32_to_cpu(cp->cp_flags) & \
549e63e88bcSRyusuke Konishi (1UL << NILFS_CHECKPOINT_##flag)); \
550e63e88bcSRyusuke Konishi }
551e63e88bcSRyusuke Konishi
552e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot)
553e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_FNS(INVALID, invalid)
554e63e88bcSRyusuke Konishi NILFS_CHECKPOINT_FNS(MINOR, minor)
555e63e88bcSRyusuke Konishi
556e63e88bcSRyusuke Konishi /**
557e63e88bcSRyusuke Konishi * struct nilfs_cpfile_header - checkpoint file header
558e63e88bcSRyusuke Konishi * @ch_ncheckpoints: number of checkpoints
559e63e88bcSRyusuke Konishi * @ch_nsnapshots: number of snapshots
560e63e88bcSRyusuke Konishi * @ch_snapshot_list: snapshot list
561e63e88bcSRyusuke Konishi */
562e63e88bcSRyusuke Konishi struct nilfs_cpfile_header {
563e63e88bcSRyusuke Konishi __le64 ch_ncheckpoints;
564e63e88bcSRyusuke Konishi __le64 ch_nsnapshots;
565e63e88bcSRyusuke Konishi struct nilfs_snapshot_list ch_snapshot_list;
566e63e88bcSRyusuke Konishi };
567e63e88bcSRyusuke Konishi
568e63e88bcSRyusuke Konishi #define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET \
569e63e88bcSRyusuke Konishi ((sizeof(struct nilfs_cpfile_header) + \
570e63e88bcSRyusuke Konishi sizeof(struct nilfs_checkpoint) - 1) / \
571e63e88bcSRyusuke Konishi sizeof(struct nilfs_checkpoint))
572e63e88bcSRyusuke Konishi
573e63e88bcSRyusuke Konishi /**
574e63e88bcSRyusuke Konishi * struct nilfs_segment_usage - segment usage
575e63e88bcSRyusuke Konishi * @su_lastmod: last modified timestamp
576e63e88bcSRyusuke Konishi * @su_nblocks: number of blocks in segment
577e63e88bcSRyusuke Konishi * @su_flags: flags
578e63e88bcSRyusuke Konishi */
579e63e88bcSRyusuke Konishi struct nilfs_segment_usage {
580e63e88bcSRyusuke Konishi __le64 su_lastmod;
581e63e88bcSRyusuke Konishi __le32 su_nblocks;
582e63e88bcSRyusuke Konishi __le32 su_flags;
583e63e88bcSRyusuke Konishi };
584e63e88bcSRyusuke Konishi
585e63e88bcSRyusuke Konishi #define NILFS_MIN_SEGMENT_USAGE_SIZE 16
586e63e88bcSRyusuke Konishi
587e63e88bcSRyusuke Konishi /* segment usage flag */
588e63e88bcSRyusuke Konishi enum {
589e63e88bcSRyusuke Konishi NILFS_SEGMENT_USAGE_ACTIVE,
590e63e88bcSRyusuke Konishi NILFS_SEGMENT_USAGE_DIRTY,
591e63e88bcSRyusuke Konishi NILFS_SEGMENT_USAGE_ERROR,
592e63e88bcSRyusuke Konishi };
593e63e88bcSRyusuke Konishi
594e63e88bcSRyusuke Konishi #define NILFS_SEGMENT_USAGE_FNS(flag, name) \
595e63e88bcSRyusuke Konishi static inline void \
596e63e88bcSRyusuke Konishi nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su) \
597e63e88bcSRyusuke Konishi { \
598*c32cc30cSMasahiro Yamada su->su_flags = __cpu_to_le32(__le32_to_cpu(su->su_flags) | \
599e63e88bcSRyusuke Konishi (1UL << NILFS_SEGMENT_USAGE_##flag));\
600e63e88bcSRyusuke Konishi } \
601e63e88bcSRyusuke Konishi static inline void \
602e63e88bcSRyusuke Konishi nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su) \
603e63e88bcSRyusuke Konishi { \
604e63e88bcSRyusuke Konishi su->su_flags = \
605*c32cc30cSMasahiro Yamada __cpu_to_le32(__le32_to_cpu(su->su_flags) & \
606e63e88bcSRyusuke Konishi ~(1UL << NILFS_SEGMENT_USAGE_##flag)); \
607e63e88bcSRyusuke Konishi } \
608e63e88bcSRyusuke Konishi static inline int \
609e63e88bcSRyusuke Konishi nilfs_segment_usage_##name(const struct nilfs_segment_usage *su) \
610e63e88bcSRyusuke Konishi { \
611*c32cc30cSMasahiro Yamada return !!(__le32_to_cpu(su->su_flags) & \
612e63e88bcSRyusuke Konishi (1UL << NILFS_SEGMENT_USAGE_##flag)); \
613e63e88bcSRyusuke Konishi }
614e63e88bcSRyusuke Konishi
NILFS_SEGMENT_USAGE_FNS(ACTIVE,active)615e63e88bcSRyusuke Konishi NILFS_SEGMENT_USAGE_FNS(ACTIVE, active)
616e63e88bcSRyusuke Konishi NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty)
617e63e88bcSRyusuke Konishi NILFS_SEGMENT_USAGE_FNS(ERROR, error)
618e63e88bcSRyusuke Konishi
619e63e88bcSRyusuke Konishi static inline void
620e63e88bcSRyusuke Konishi nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su)
621e63e88bcSRyusuke Konishi {
622*c32cc30cSMasahiro Yamada su->su_lastmod = __cpu_to_le64(0);
623*c32cc30cSMasahiro Yamada su->su_nblocks = __cpu_to_le32(0);
624*c32cc30cSMasahiro Yamada su->su_flags = __cpu_to_le32(0);
625e63e88bcSRyusuke Konishi }
626e63e88bcSRyusuke Konishi
627e63e88bcSRyusuke Konishi static inline int
nilfs_segment_usage_clean(const struct nilfs_segment_usage * su)628e63e88bcSRyusuke Konishi nilfs_segment_usage_clean(const struct nilfs_segment_usage *su)
629e63e88bcSRyusuke Konishi {
630*c32cc30cSMasahiro Yamada return !__le32_to_cpu(su->su_flags);
631e63e88bcSRyusuke Konishi }
632e63e88bcSRyusuke Konishi
633e63e88bcSRyusuke Konishi /**
634e63e88bcSRyusuke Konishi * struct nilfs_sufile_header - segment usage file header
635e63e88bcSRyusuke Konishi * @sh_ncleansegs: number of clean segments
636e63e88bcSRyusuke Konishi * @sh_ndirtysegs: number of dirty segments
637e63e88bcSRyusuke Konishi * @sh_last_alloc: last allocated segment number
638e63e88bcSRyusuke Konishi */
639e63e88bcSRyusuke Konishi struct nilfs_sufile_header {
640e63e88bcSRyusuke Konishi __le64 sh_ncleansegs;
641e63e88bcSRyusuke Konishi __le64 sh_ndirtysegs;
642e63e88bcSRyusuke Konishi __le64 sh_last_alloc;
643e63e88bcSRyusuke Konishi /* ... */
644e63e88bcSRyusuke Konishi };
645e63e88bcSRyusuke Konishi
646e63e88bcSRyusuke Konishi #define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \
647e63e88bcSRyusuke Konishi ((sizeof(struct nilfs_sufile_header) + \
648e63e88bcSRyusuke Konishi sizeof(struct nilfs_segment_usage) - 1) / \
649e63e88bcSRyusuke Konishi sizeof(struct nilfs_segment_usage))
650e63e88bcSRyusuke Konishi
651e63e88bcSRyusuke Konishi #endif /* _LINUX_NILFS2_ONDISK_H */
652