Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 1 | /* |
| 2 | * nilfs2_fs.h - NILFS2 on-disk structures and common declarations. |
| 3 | * |
| 4 | * Copyright (C) 2005-2008 Nippon Telegraph and Telephone Corporation. |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License |
| 17 | * along with this program; if not, write to the Free Software |
| 18 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 19 | * |
| 20 | * Written by Koji Sato <koji@osrg.net> |
| 21 | * Ryusuke Konishi <ryusuke@osrg.net> |
| 22 | */ |
| 23 | /* |
| 24 | * linux/include/linux/ext2_fs.h |
| 25 | * |
| 26 | * Copyright (C) 1992, 1993, 1994, 1995 |
| 27 | * Remy Card (card@masi.ibp.fr) |
| 28 | * Laboratoire MASI - Institut Blaise Pascal |
| 29 | * Universite Pierre et Marie Curie (Paris VI) |
| 30 | * |
| 31 | * from |
| 32 | * |
| 33 | * linux/include/linux/minix_fs.h |
| 34 | * |
| 35 | * Copyright (C) 1991, 1992 Linus Torvalds |
| 36 | */ |
| 37 | |
| 38 | #ifndef _LINUX_NILFS_FS_H |
| 39 | #define _LINUX_NILFS_FS_H |
| 40 | |
| 41 | #include <linux/types.h> |
| 42 | #include <linux/ioctl.h> |
| 43 | |
| 44 | /* |
| 45 | * Inode flags stored in nilfs_inode and on-memory nilfs inode |
| 46 | * |
| 47 | * We define these flags based on ext2-fs because of the |
| 48 | * compatibility reason; to avoid problems in chattr(1) |
| 49 | */ |
| 50 | #define NILFS_SECRM_FL 0x00000001 /* Secure deletion */ |
| 51 | #define NILFS_UNRM_FL 0x00000002 /* Undelete */ |
| 52 | #define NILFS_SYNC_FL 0x00000008 /* Synchronous updates */ |
| 53 | #define NILFS_IMMUTABLE_FL 0x00000010 /* Immutable file */ |
| 54 | #define NILFS_APPEND_FL 0x00000020 /* writes to file may only append */ |
| 55 | #define NILFS_NODUMP_FL 0x00000040 /* do not dump file */ |
| 56 | #define NILFS_NOATIME_FL 0x00000080 /* do not update atime */ |
| 57 | /* Reserved for compression usage... */ |
| 58 | #define NILFS_NOTAIL_FL 0x00008000 /* file tail should not be merged */ |
| 59 | #define NILFS_DIRSYNC_FL 0x00010000 /* dirsync behaviour */ |
| 60 | |
| 61 | #define NILFS_FL_USER_VISIBLE 0x0003DFFF /* User visible flags */ |
| 62 | #define NILFS_FL_USER_MODIFIABLE 0x000380FF /* User modifiable flags */ |
| 63 | |
| 64 | |
| 65 | #define NILFS_INODE_BMAP_SIZE 7 |
| 66 | /** |
| 67 | * struct nilfs_inode - structure of an inode on disk |
| 68 | * @i_blocks: blocks count |
| 69 | * @i_size: size in bytes |
Ryusuke Konishi | 6123923 | 2009-04-06 19:02:00 -0700 | [diff] [blame] | 70 | * @i_ctime: creation time (seconds) |
| 71 | * @i_mtime: modification time (seconds) |
| 72 | * @i_ctime_nsec: creation time (nano seconds) |
| 73 | * @i_mtime_nsec: modification time (nano seconds) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 74 | * @i_uid: user id |
| 75 | * @i_gid: group id |
| 76 | * @i_mode: file mode |
| 77 | * @i_links_count: links count |
| 78 | * @i_flags: file flags |
| 79 | * @i_bmap: block mapping |
| 80 | * @i_xattr: extended attributes |
| 81 | * @i_generation: file generation (for NFS) |
| 82 | * @i_pad: padding |
| 83 | */ |
| 84 | struct nilfs_inode { |
| 85 | __le64 i_blocks; |
| 86 | __le64 i_size; |
| 87 | __le64 i_ctime; |
| 88 | __le64 i_mtime; |
Ryusuke Konishi | 6123923 | 2009-04-06 19:02:00 -0700 | [diff] [blame] | 89 | __le32 i_ctime_nsec; |
| 90 | __le32 i_mtime_nsec; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 91 | __le32 i_uid; |
| 92 | __le32 i_gid; |
| 93 | __le16 i_mode; |
| 94 | __le16 i_links_count; |
| 95 | __le32 i_flags; |
| 96 | __le64 i_bmap[NILFS_INODE_BMAP_SIZE]; |
| 97 | #define i_device_code i_bmap[0] |
| 98 | __le64 i_xattr; |
| 99 | __le32 i_generation; |
| 100 | __le32 i_pad; |
| 101 | }; |
| 102 | |
| 103 | /** |
| 104 | * struct nilfs_super_root - structure of super root |
| 105 | * @sr_sum: check sum |
| 106 | * @sr_bytes: byte count of the structure |
| 107 | * @sr_flags: flags (reserved) |
| 108 | * @sr_nongc_ctime: write time of the last segment not for cleaner operation |
| 109 | * @sr_dat: DAT file inode |
| 110 | * @sr_cpfile: checkpoint file inode |
| 111 | * @sr_sufile: segment usage file inode |
| 112 | */ |
| 113 | struct nilfs_super_root { |
| 114 | __le32 sr_sum; |
| 115 | __le16 sr_bytes; |
| 116 | __le16 sr_flags; |
| 117 | __le64 sr_nongc_ctime; |
| 118 | struct nilfs_inode sr_dat; |
| 119 | struct nilfs_inode sr_cpfile; |
| 120 | struct nilfs_inode sr_sufile; |
| 121 | }; |
| 122 | |
| 123 | #define NILFS_SR_MDT_OFFSET(inode_size, i) \ |
| 124 | ((unsigned long)&((struct nilfs_super_root *)0)->sr_dat + \ |
| 125 | (inode_size) * (i)) |
| 126 | #define NILFS_SR_DAT_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 0) |
| 127 | #define NILFS_SR_CPFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 1) |
| 128 | #define NILFS_SR_SUFILE_OFFSET(inode_size) NILFS_SR_MDT_OFFSET(inode_size, 2) |
| 129 | #define NILFS_SR_BYTES (sizeof(struct nilfs_super_root)) |
| 130 | |
| 131 | /* |
| 132 | * Maximal mount counts |
| 133 | */ |
| 134 | #define NILFS_DFL_MAX_MNT_COUNT 50 /* 50 mounts */ |
| 135 | |
| 136 | /* |
| 137 | * File system states (sbp->s_state, nilfs->ns_mount_state) |
| 138 | */ |
| 139 | #define NILFS_VALID_FS 0x0001 /* Unmounted cleanly */ |
| 140 | #define NILFS_ERROR_FS 0x0002 /* Errors detected */ |
| 141 | #define NILFS_RESIZE_FS 0x0004 /* Resize required */ |
| 142 | |
| 143 | /* |
| 144 | * Mount flags (sbi->s_mount_opt) |
| 145 | */ |
| 146 | #define NILFS_MOUNT_ERROR_MODE 0x0070 /* Error mode mask */ |
| 147 | #define NILFS_MOUNT_ERRORS_CONT 0x0010 /* Continue on errors */ |
| 148 | #define NILFS_MOUNT_ERRORS_RO 0x0020 /* Remount fs ro on errors */ |
| 149 | #define NILFS_MOUNT_ERRORS_PANIC 0x0040 /* Panic on errors */ |
| 150 | #define NILFS_MOUNT_SNAPSHOT 0x0080 /* Snapshot flag */ |
| 151 | #define NILFS_MOUNT_BARRIER 0x1000 /* Use block barriers */ |
| 152 | #define NILFS_MOUNT_STRICT_ORDER 0x2000 /* Apply strict in-order |
| 153 | semantics also for data */ |
Ryusuke Konishi | 0234576 | 2009-11-20 03:28:01 +0900 | [diff] [blame] | 154 | #define NILFS_MOUNT_NORECOVERY 0x4000 /* Disable write access during |
| 155 | mount-time recovery */ |
Jiro SEKIBA | e902ec9 | 2010-01-30 18:06:35 +0900 | [diff] [blame] | 156 | #define NILFS_MOUNT_DISCARD 0x8000 /* Issue DISCARD requests */ |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 157 | |
| 158 | |
| 159 | /** |
| 160 | * struct nilfs_super_block - structure of super block on disk |
| 161 | */ |
| 162 | struct nilfs_super_block { |
| 163 | __le32 s_rev_level; /* Revision level */ |
| 164 | __le16 s_minor_rev_level; /* minor revision level */ |
| 165 | __le16 s_magic; /* Magic signature */ |
| 166 | |
| 167 | __le16 s_bytes; /* Bytes count of CRC calculation |
| 168 | for this structure. s_reserved |
| 169 | is excluded. */ |
| 170 | __le16 s_flags; /* flags */ |
| 171 | __le32 s_crc_seed; /* Seed value of CRC calculation */ |
| 172 | __le32 s_sum; /* Check sum of super block */ |
| 173 | |
| 174 | __le32 s_log_block_size; /* Block size represented as follows |
| 175 | blocksize = |
| 176 | 1 << (s_log_block_size + 10) */ |
| 177 | __le64 s_nsegments; /* Number of segments in filesystem */ |
| 178 | __le64 s_dev_size; /* block device size in bytes */ |
| 179 | __le64 s_first_data_block; /* 1st seg disk block number */ |
| 180 | __le32 s_blocks_per_segment; /* number of blocks per full segment */ |
| 181 | __le32 s_r_segments_percentage; /* Reserved segments percentage */ |
| 182 | |
| 183 | __le64 s_last_cno; /* Last checkpoint number */ |
| 184 | __le64 s_last_pseg; /* disk block addr pseg written last */ |
| 185 | __le64 s_last_seq; /* seq. number of seg written last */ |
| 186 | __le64 s_free_blocks_count; /* Free blocks count */ |
| 187 | |
| 188 | __le64 s_ctime; /* Creation time (execution time of |
| 189 | newfs) */ |
| 190 | __le64 s_mtime; /* Mount time */ |
| 191 | __le64 s_wtime; /* Write time */ |
| 192 | __le16 s_mnt_count; /* Mount count */ |
| 193 | __le16 s_max_mnt_count; /* Maximal mount count */ |
| 194 | __le16 s_state; /* File system state */ |
| 195 | __le16 s_errors; /* Behaviour when detecting errors */ |
| 196 | __le64 s_lastcheck; /* time of last check */ |
| 197 | |
| 198 | __le32 s_checkinterval; /* max. time between checks */ |
| 199 | __le32 s_creator_os; /* OS */ |
| 200 | __le16 s_def_resuid; /* Default uid for reserved blocks */ |
| 201 | __le16 s_def_resgid; /* Default gid for reserved blocks */ |
Ryusuke Konishi | 0d9cc23 | 2010-04-26 01:17:48 +0900 | [diff] [blame] | 202 | __le32 s_first_ino; /* First non-reserved inode */ |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 203 | |
Ryusuke Konishi | 0d9cc23 | 2010-04-26 01:17:48 +0900 | [diff] [blame] | 204 | __le16 s_inode_size; /* Size of an inode */ |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 205 | __le16 s_dat_entry_size; /* Size of a dat entry */ |
| 206 | __le16 s_checkpoint_size; /* Size of a checkpoint */ |
| 207 | __le16 s_segment_usage_size; /* Size of a segment usage */ |
| 208 | |
| 209 | __u8 s_uuid[16]; /* 128-bit uuid for volume */ |
Jiro SEKIBA | 400ade8 | 2010-05-02 23:29:04 +0900 | [diff] [blame] | 210 | char s_volume_name[80]; /* volume name */ |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 211 | |
| 212 | __le32 s_c_interval; /* Commit interval of segment */ |
| 213 | __le32 s_c_block_max; /* Threshold of data amount for |
| 214 | the segment construction */ |
| 215 | __u32 s_reserved[192]; /* padding to the end of the block */ |
| 216 | }; |
| 217 | |
| 218 | /* |
| 219 | * Codes for operating systems |
| 220 | */ |
| 221 | #define NILFS_OS_LINUX 0 |
| 222 | /* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */ |
| 223 | |
| 224 | /* |
| 225 | * Revision levels |
| 226 | */ |
| 227 | #define NILFS_CURRENT_REV 2 /* current major revision */ |
| 228 | #define NILFS_MINOR_REV 0 /* minor revision */ |
| 229 | |
| 230 | /* |
| 231 | * Bytes count of super_block for CRC-calculation |
| 232 | */ |
| 233 | #define NILFS_SB_BYTES \ |
| 234 | ((long)&((struct nilfs_super_block *)0)->s_reserved) |
| 235 | |
| 236 | /* |
| 237 | * Special inode number |
| 238 | */ |
| 239 | #define NILFS_ROOT_INO 2 /* Root file inode */ |
| 240 | #define NILFS_DAT_INO 3 /* DAT file */ |
| 241 | #define NILFS_CPFILE_INO 4 /* checkpoint file */ |
| 242 | #define NILFS_SUFILE_INO 5 /* segment usage file */ |
| 243 | #define NILFS_IFILE_INO 6 /* ifile */ |
| 244 | #define NILFS_ATIME_INO 7 /* Atime file (reserved) */ |
| 245 | #define NILFS_XATTR_INO 8 /* Xattribute file (reserved) */ |
| 246 | #define NILFS_SKETCH_INO 10 /* Sketch file */ |
| 247 | #define NILFS_USER_INO 11 /* Fisrt user's file inode number */ |
| 248 | |
| 249 | #define NILFS_SB_OFFSET_BYTES 1024 /* byte offset of nilfs superblock */ |
| 250 | #define NILFS_SUPER_MAGIC 0x3434 /* NILFS filesystem magic number */ |
| 251 | |
| 252 | #define NILFS_SEG_MIN_BLOCKS 16 /* Minimum number of blocks in |
| 253 | a full segment */ |
| 254 | #define NILFS_PSEG_MIN_BLOCKS 2 /* Minimum number of blocks in |
| 255 | a partial segment */ |
| 256 | #define NILFS_MIN_NRSVSEGS 8 /* Minimum number of reserved |
| 257 | segments */ |
| 258 | |
Ryusuke Konishi | e339ad3 | 2009-04-06 19:01:59 -0700 | [diff] [blame] | 259 | /* |
| 260 | * bytes offset of secondary super block |
| 261 | */ |
| 262 | #define NILFS_SB2_OFFSET_BYTES(devsize) ((((devsize) >> 12) - 1) << 12) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 263 | |
| 264 | /* |
| 265 | * Maximal count of links to a file |
| 266 | */ |
| 267 | #define NILFS_LINK_MAX 32000 |
| 268 | |
| 269 | /* |
| 270 | * Structure of a directory entry |
| 271 | * (Same as ext2) |
| 272 | */ |
| 273 | |
| 274 | #define NILFS_NAME_LEN 255 |
| 275 | |
| 276 | /* |
| 277 | * The new version of the directory entry. Since V0 structures are |
| 278 | * stored in intel byte order, and the name_len field could never be |
| 279 | * bigger than 255 chars, it's safe to reclaim the extra byte for the |
| 280 | * file_type field. |
| 281 | */ |
| 282 | struct nilfs_dir_entry { |
| 283 | __le64 inode; /* Inode number */ |
| 284 | __le16 rec_len; /* Directory entry length */ |
| 285 | __u8 name_len; /* Name length */ |
| 286 | __u8 file_type; |
| 287 | char name[NILFS_NAME_LEN]; /* File name */ |
| 288 | char pad; |
| 289 | }; |
| 290 | |
| 291 | /* |
| 292 | * NILFS directory file types. Only the low 3 bits are used. The |
| 293 | * other bits are reserved for now. |
| 294 | */ |
| 295 | enum { |
| 296 | NILFS_FT_UNKNOWN, |
| 297 | NILFS_FT_REG_FILE, |
| 298 | NILFS_FT_DIR, |
| 299 | NILFS_FT_CHRDEV, |
| 300 | NILFS_FT_BLKDEV, |
| 301 | NILFS_FT_FIFO, |
| 302 | NILFS_FT_SOCK, |
| 303 | NILFS_FT_SYMLINK, |
| 304 | NILFS_FT_MAX |
| 305 | }; |
| 306 | |
| 307 | /* |
| 308 | * NILFS_DIR_PAD defines the directory entries boundaries |
| 309 | * |
| 310 | * NOTE: It must be a multiple of 8 |
| 311 | */ |
| 312 | #define NILFS_DIR_PAD 8 |
| 313 | #define NILFS_DIR_ROUND (NILFS_DIR_PAD - 1) |
| 314 | #define NILFS_DIR_REC_LEN(name_len) (((name_len) + 12 + NILFS_DIR_ROUND) & \ |
| 315 | ~NILFS_DIR_ROUND) |
| 316 | |
| 317 | |
| 318 | /** |
| 319 | * struct nilfs_finfo - file information |
| 320 | * @fi_ino: inode number |
| 321 | * @fi_cno: checkpoint number |
| 322 | * @fi_nblocks: number of blocks (including intermediate blocks) |
| 323 | * @fi_ndatablk: number of file data blocks |
| 324 | */ |
| 325 | struct nilfs_finfo { |
| 326 | __le64 fi_ino; |
| 327 | __le64 fi_cno; |
| 328 | __le32 fi_nblocks; |
| 329 | __le32 fi_ndatablk; |
| 330 | /* array of virtual block numbers */ |
| 331 | }; |
| 332 | |
| 333 | /** |
| 334 | * struct nilfs_binfo_v - information for the block to which a virtual block number is assigned |
| 335 | * @bi_vblocknr: virtual block number |
| 336 | * @bi_blkoff: block offset |
| 337 | */ |
| 338 | struct nilfs_binfo_v { |
| 339 | __le64 bi_vblocknr; |
| 340 | __le64 bi_blkoff; |
| 341 | }; |
| 342 | |
| 343 | /** |
| 344 | * struct nilfs_binfo_dat - information for the block which belongs to the DAT file |
| 345 | * @bi_blkoff: block offset |
| 346 | * @bi_level: level |
| 347 | * @bi_pad: padding |
| 348 | */ |
| 349 | struct nilfs_binfo_dat { |
| 350 | __le64 bi_blkoff; |
| 351 | __u8 bi_level; |
| 352 | __u8 bi_pad[7]; |
| 353 | }; |
| 354 | |
| 355 | /** |
| 356 | * union nilfs_binfo: block information |
| 357 | * @bi_v: nilfs_binfo_v structure |
| 358 | * @bi_dat: nilfs_binfo_dat structure |
| 359 | */ |
| 360 | union nilfs_binfo { |
| 361 | struct nilfs_binfo_v bi_v; |
| 362 | struct nilfs_binfo_dat bi_dat; |
| 363 | }; |
| 364 | |
| 365 | /** |
| 366 | * struct nilfs_segment_summary - segment summary |
| 367 | * @ss_datasum: checksum of data |
| 368 | * @ss_sumsum: checksum of segment summary |
| 369 | * @ss_magic: magic number |
| 370 | * @ss_bytes: size of this structure in bytes |
| 371 | * @ss_flags: flags |
| 372 | * @ss_seq: sequence number |
| 373 | * @ss_create: creation timestamp |
| 374 | * @ss_next: next segment |
| 375 | * @ss_nblocks: number of blocks |
| 376 | * @ss_nfinfo: number of finfo structures |
| 377 | * @ss_sumbytes: total size of segment summary in bytes |
| 378 | * @ss_pad: padding |
Ryusuke Konishi | 50614bc | 2010-04-10 17:59:15 +0900 | [diff] [blame] | 379 | * @ss_cno: checkpoint number |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 380 | */ |
| 381 | struct nilfs_segment_summary { |
| 382 | __le32 ss_datasum; |
| 383 | __le32 ss_sumsum; |
| 384 | __le32 ss_magic; |
| 385 | __le16 ss_bytes; |
| 386 | __le16 ss_flags; |
| 387 | __le64 ss_seq; |
| 388 | __le64 ss_create; |
| 389 | __le64 ss_next; |
| 390 | __le32 ss_nblocks; |
| 391 | __le32 ss_nfinfo; |
| 392 | __le32 ss_sumbytes; |
| 393 | __le32 ss_pad; |
Ryusuke Konishi | 50614bc | 2010-04-10 17:59:15 +0900 | [diff] [blame] | 394 | __le64 ss_cno; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 395 | /* array of finfo structures */ |
| 396 | }; |
| 397 | |
| 398 | #define NILFS_SEGSUM_MAGIC 0x1eaffa11 /* segment summary magic number */ |
| 399 | |
| 400 | /* |
| 401 | * Segment summary flags |
| 402 | */ |
| 403 | #define NILFS_SS_LOGBGN 0x0001 /* begins a logical segment */ |
| 404 | #define NILFS_SS_LOGEND 0x0002 /* ends a logical segment */ |
| 405 | #define NILFS_SS_SR 0x0004 /* has super root */ |
| 406 | #define NILFS_SS_SYNDT 0x0008 /* includes data only updates */ |
| 407 | #define NILFS_SS_GC 0x0010 /* segment written for cleaner operation */ |
| 408 | |
| 409 | /** |
Jiro SEKIBA | 6600b9d | 2009-11-09 19:10:11 +0900 | [diff] [blame] | 410 | * struct nilfs_btree_node - B-tree node |
| 411 | * @bn_flags: flags |
| 412 | * @bn_level: level |
| 413 | * @bn_nchildren: number of children |
| 414 | * @bn_pad: padding |
| 415 | */ |
| 416 | struct nilfs_btree_node { |
| 417 | __u8 bn_flags; |
| 418 | __u8 bn_level; |
| 419 | __le16 bn_nchildren; |
| 420 | __le32 bn_pad; |
| 421 | }; |
| 422 | |
| 423 | /* flags */ |
| 424 | #define NILFS_BTREE_NODE_ROOT 0x01 |
| 425 | |
| 426 | /* level */ |
| 427 | #define NILFS_BTREE_LEVEL_DATA 0 |
| 428 | #define NILFS_BTREE_LEVEL_NODE_MIN (NILFS_BTREE_LEVEL_DATA + 1) |
| 429 | #define NILFS_BTREE_LEVEL_MAX 14 |
| 430 | |
| 431 | /** |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 432 | * struct nilfs_palloc_group_desc - block group descriptor |
| 433 | * @pg_nfrees: number of free entries in block group |
| 434 | */ |
| 435 | struct nilfs_palloc_group_desc { |
| 436 | __le32 pg_nfrees; |
| 437 | }; |
| 438 | |
| 439 | /** |
| 440 | * struct nilfs_dat_entry - disk address translation entry |
Qinghuang Feng | 37e11f3 | 2010-04-25 20:17:25 +0800 | [diff] [blame] | 441 | * @de_blocknr: block number |
| 442 | * @de_start: start checkpoint number |
| 443 | * @de_end: end checkpoint number |
| 444 | * @de_rsv: reserved for future use |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 445 | */ |
| 446 | struct nilfs_dat_entry { |
| 447 | __le64 de_blocknr; |
| 448 | __le64 de_start; |
| 449 | __le64 de_end; |
| 450 | __le64 de_rsv; |
| 451 | }; |
| 452 | |
| 453 | /** |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 454 | * struct nilfs_snapshot_list - snapshot list |
| 455 | * @ssl_next: next checkpoint number on snapshot list |
| 456 | * @ssl_prev: previous checkpoint number on snapshot list |
| 457 | */ |
| 458 | struct nilfs_snapshot_list { |
| 459 | __le64 ssl_next; |
| 460 | __le64 ssl_prev; |
| 461 | }; |
| 462 | |
| 463 | /** |
| 464 | * struct nilfs_checkpoint - checkpoint structure |
| 465 | * @cp_flags: flags |
| 466 | * @cp_checkpoints_count: checkpoints count in a block |
| 467 | * @cp_snapshot_list: snapshot list |
| 468 | * @cp_cno: checkpoint number |
| 469 | * @cp_create: creation timestamp |
| 470 | * @cp_nblk_inc: number of blocks incremented by this checkpoint |
| 471 | * @cp_inodes_count: inodes count |
| 472 | * @cp_blocks_count: blocks count |
| 473 | * @cp_ifile_inode: inode of ifile |
| 474 | */ |
| 475 | struct nilfs_checkpoint { |
| 476 | __le32 cp_flags; |
| 477 | __le32 cp_checkpoints_count; |
| 478 | struct nilfs_snapshot_list cp_snapshot_list; |
| 479 | __le64 cp_cno; |
| 480 | __le64 cp_create; |
| 481 | __le64 cp_nblk_inc; |
| 482 | __le64 cp_inodes_count; |
| 483 | __le64 cp_blocks_count; /* Reserved (might be deleted) */ |
| 484 | |
| 485 | /* Do not change the byte offset of ifile inode. |
| 486 | To keep the compatibility of the disk format, |
| 487 | additional fields should be added behind cp_ifile_inode. */ |
| 488 | struct nilfs_inode cp_ifile_inode; |
| 489 | }; |
| 490 | |
| 491 | /* checkpoint flags */ |
| 492 | enum { |
| 493 | NILFS_CHECKPOINT_SNAPSHOT, |
| 494 | NILFS_CHECKPOINT_INVALID, |
| 495 | NILFS_CHECKPOINT_SKETCH, |
Ryusuke Konishi | c96fa46 | 2009-04-06 19:01:57 -0700 | [diff] [blame] | 496 | NILFS_CHECKPOINT_MINOR, |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 497 | }; |
| 498 | |
| 499 | #define NILFS_CHECKPOINT_FNS(flag, name) \ |
| 500 | static inline void \ |
| 501 | nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp) \ |
| 502 | { \ |
| 503 | cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) | \ |
| 504 | (1UL << NILFS_CHECKPOINT_##flag)); \ |
| 505 | } \ |
| 506 | static inline void \ |
| 507 | nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp) \ |
| 508 | { \ |
| 509 | cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) & \ |
| 510 | ~(1UL << NILFS_CHECKPOINT_##flag)); \ |
| 511 | } \ |
| 512 | static inline int \ |
| 513 | nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp) \ |
| 514 | { \ |
| 515 | return !!(le32_to_cpu(cp->cp_flags) & \ |
| 516 | (1UL << NILFS_CHECKPOINT_##flag)); \ |
| 517 | } |
| 518 | |
| 519 | NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot) |
| 520 | NILFS_CHECKPOINT_FNS(INVALID, invalid) |
Ryusuke Konishi | c96fa46 | 2009-04-06 19:01:57 -0700 | [diff] [blame] | 521 | NILFS_CHECKPOINT_FNS(MINOR, minor) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 522 | |
| 523 | /** |
| 524 | * struct nilfs_cpinfo - checkpoint information |
| 525 | * @ci_flags: flags |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 526 | * @ci_pad: padding |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 527 | * @ci_cno: checkpoint number |
| 528 | * @ci_create: creation timestamp |
| 529 | * @ci_nblk_inc: number of blocks incremented by this checkpoint |
| 530 | * @ci_inodes_count: inodes count |
| 531 | * @ci_blocks_count: blocks count |
| 532 | * @ci_next: next checkpoint number in snapshot list |
| 533 | */ |
| 534 | struct nilfs_cpinfo { |
| 535 | __u32 ci_flags; |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 536 | __u32 ci_pad; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 537 | __u64 ci_cno; |
| 538 | __u64 ci_create; |
| 539 | __u64 ci_nblk_inc; |
| 540 | __u64 ci_inodes_count; |
| 541 | __u64 ci_blocks_count; |
| 542 | __u64 ci_next; |
| 543 | }; |
| 544 | |
| 545 | #define NILFS_CPINFO_FNS(flag, name) \ |
| 546 | static inline int \ |
| 547 | nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo) \ |
| 548 | { \ |
| 549 | return !!(cpinfo->ci_flags & (1UL << NILFS_CHECKPOINT_##flag)); \ |
| 550 | } |
| 551 | |
| 552 | NILFS_CPINFO_FNS(SNAPSHOT, snapshot) |
| 553 | NILFS_CPINFO_FNS(INVALID, invalid) |
Ryusuke Konishi | c96fa46 | 2009-04-06 19:01:57 -0700 | [diff] [blame] | 554 | NILFS_CPINFO_FNS(MINOR, minor) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 555 | |
| 556 | |
| 557 | /** |
| 558 | * struct nilfs_cpfile_header - checkpoint file header |
| 559 | * @ch_ncheckpoints: number of checkpoints |
| 560 | * @ch_nsnapshots: number of snapshots |
| 561 | * @ch_snapshot_list: snapshot list |
| 562 | */ |
| 563 | struct nilfs_cpfile_header { |
| 564 | __le64 ch_ncheckpoints; |
| 565 | __le64 ch_nsnapshots; |
| 566 | struct nilfs_snapshot_list ch_snapshot_list; |
| 567 | }; |
| 568 | |
| 569 | #define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET \ |
| 570 | ((sizeof(struct nilfs_cpfile_header) + \ |
| 571 | sizeof(struct nilfs_checkpoint) - 1) / \ |
| 572 | sizeof(struct nilfs_checkpoint)) |
| 573 | |
| 574 | /** |
| 575 | * struct nilfs_segment_usage - segment usage |
| 576 | * @su_lastmod: last modified timestamp |
| 577 | * @su_nblocks: number of blocks in segment |
| 578 | * @su_flags: flags |
| 579 | */ |
| 580 | struct nilfs_segment_usage { |
| 581 | __le64 su_lastmod; |
| 582 | __le32 su_nblocks; |
| 583 | __le32 su_flags; |
| 584 | }; |
| 585 | |
| 586 | /* segment usage flag */ |
| 587 | enum { |
| 588 | NILFS_SEGMENT_USAGE_ACTIVE, |
| 589 | NILFS_SEGMENT_USAGE_DIRTY, |
| 590 | NILFS_SEGMENT_USAGE_ERROR, |
| 591 | |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 592 | /* ... */ |
| 593 | }; |
| 594 | |
| 595 | #define NILFS_SEGMENT_USAGE_FNS(flag, name) \ |
| 596 | static inline void \ |
| 597 | nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su) \ |
| 598 | { \ |
| 599 | su->su_flags = cpu_to_le32(le32_to_cpu(su->su_flags) | \ |
| 600 | (1UL << NILFS_SEGMENT_USAGE_##flag));\ |
| 601 | } \ |
| 602 | static inline void \ |
| 603 | nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su) \ |
| 604 | { \ |
| 605 | su->su_flags = \ |
| 606 | cpu_to_le32(le32_to_cpu(su->su_flags) & \ |
| 607 | ~(1UL << NILFS_SEGMENT_USAGE_##flag)); \ |
| 608 | } \ |
| 609 | static inline int \ |
| 610 | nilfs_segment_usage_##name(const struct nilfs_segment_usage *su) \ |
| 611 | { \ |
| 612 | return !!(le32_to_cpu(su->su_flags) & \ |
| 613 | (1UL << NILFS_SEGMENT_USAGE_##flag)); \ |
| 614 | } |
| 615 | |
| 616 | NILFS_SEGMENT_USAGE_FNS(ACTIVE, active) |
| 617 | NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty) |
| 618 | NILFS_SEGMENT_USAGE_FNS(ERROR, error) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 619 | |
| 620 | static inline void |
| 621 | nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su) |
| 622 | { |
| 623 | su->su_lastmod = cpu_to_le64(0); |
| 624 | su->su_nblocks = cpu_to_le32(0); |
| 625 | su->su_flags = cpu_to_le32(0); |
| 626 | } |
| 627 | |
| 628 | static inline int |
| 629 | nilfs_segment_usage_clean(const struct nilfs_segment_usage *su) |
| 630 | { |
| 631 | return !le32_to_cpu(su->su_flags); |
| 632 | } |
| 633 | |
| 634 | /** |
| 635 | * struct nilfs_sufile_header - segment usage file header |
| 636 | * @sh_ncleansegs: number of clean segments |
| 637 | * @sh_ndirtysegs: number of dirty segments |
| 638 | * @sh_last_alloc: last allocated segment number |
| 639 | */ |
| 640 | struct nilfs_sufile_header { |
| 641 | __le64 sh_ncleansegs; |
| 642 | __le64 sh_ndirtysegs; |
| 643 | __le64 sh_last_alloc; |
| 644 | /* ... */ |
| 645 | }; |
| 646 | |
| 647 | #define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \ |
| 648 | ((sizeof(struct nilfs_sufile_header) + \ |
| 649 | sizeof(struct nilfs_segment_usage) - 1) / \ |
| 650 | sizeof(struct nilfs_segment_usage)) |
| 651 | |
| 652 | /** |
| 653 | * nilfs_suinfo - segment usage information |
| 654 | * @sui_lastmod: |
| 655 | * @sui_nblocks: |
| 656 | * @sui_flags: |
| 657 | */ |
| 658 | struct nilfs_suinfo { |
| 659 | __u64 sui_lastmod; |
| 660 | __u32 sui_nblocks; |
| 661 | __u32 sui_flags; |
| 662 | }; |
| 663 | |
| 664 | #define NILFS_SUINFO_FNS(flag, name) \ |
| 665 | static inline int \ |
| 666 | nilfs_suinfo_##name(const struct nilfs_suinfo *si) \ |
| 667 | { \ |
| 668 | return si->sui_flags & (1UL << NILFS_SEGMENT_USAGE_##flag); \ |
| 669 | } |
| 670 | |
| 671 | NILFS_SUINFO_FNS(ACTIVE, active) |
| 672 | NILFS_SUINFO_FNS(DIRTY, dirty) |
| 673 | NILFS_SUINFO_FNS(ERROR, error) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 674 | |
| 675 | static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si) |
| 676 | { |
| 677 | return !si->sui_flags; |
| 678 | } |
| 679 | |
| 680 | /* ioctl */ |
| 681 | enum { |
| 682 | NILFS_CHECKPOINT, |
| 683 | NILFS_SNAPSHOT, |
| 684 | }; |
| 685 | |
| 686 | /** |
| 687 | * struct nilfs_cpmode - |
| 688 | * @cc_cno: |
| 689 | * @cc_mode: |
| 690 | */ |
| 691 | struct nilfs_cpmode { |
| 692 | __u64 cm_cno; |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 693 | __u32 cm_mode; |
| 694 | __u32 cm_pad; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 695 | }; |
| 696 | |
| 697 | /** |
| 698 | * struct nilfs_argv - argument vector |
| 699 | * @v_base: |
| 700 | * @v_nmembs: |
| 701 | * @v_size: |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 702 | * @v_flags: |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 703 | * @v_index: |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 704 | */ |
| 705 | struct nilfs_argv { |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 706 | __u64 v_base; |
| 707 | __u32 v_nmembs; /* number of members */ |
| 708 | __u16 v_size; /* size of members */ |
| 709 | __u16 v_flags; |
| 710 | __u64 v_index; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 711 | }; |
| 712 | |
| 713 | /** |
| 714 | * struct nilfs_period - |
| 715 | * @p_start: |
| 716 | * @p_end: |
| 717 | */ |
| 718 | struct nilfs_period { |
| 719 | __u64 p_start; |
| 720 | __u64 p_end; |
| 721 | }; |
| 722 | |
| 723 | /** |
| 724 | * struct nilfs_cpstat - |
| 725 | * @cs_cno: checkpoint number |
| 726 | * @cs_ncps: number of checkpoints |
| 727 | * @cs_nsss: number of snapshots |
| 728 | */ |
| 729 | struct nilfs_cpstat { |
| 730 | __u64 cs_cno; |
| 731 | __u64 cs_ncps; |
| 732 | __u64 cs_nsss; |
| 733 | }; |
| 734 | |
| 735 | /** |
| 736 | * struct nilfs_sustat - |
| 737 | * @ss_nsegs: number of segments |
| 738 | * @ss_ncleansegs: number of clean segments |
| 739 | * @ss_ndirtysegs: number of dirty segments |
Ryusuke Konishi | 2c2e52f | 2009-04-06 19:01:54 -0700 | [diff] [blame] | 740 | * @ss_ctime: creation time of the last segment |
| 741 | * @ss_nongc_ctime: creation time of the last segment not for GC |
| 742 | * @ss_prot_seq: least sequence number of segments which must not be reclaimed |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 743 | */ |
| 744 | struct nilfs_sustat { |
| 745 | __u64 ss_nsegs; |
| 746 | __u64 ss_ncleansegs; |
| 747 | __u64 ss_ndirtysegs; |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 748 | __u64 ss_ctime; |
| 749 | __u64 ss_nongc_ctime; |
Ryusuke Konishi | 2c2e52f | 2009-04-06 19:01:54 -0700 | [diff] [blame] | 750 | __u64 ss_prot_seq; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 751 | }; |
| 752 | |
| 753 | /** |
| 754 | * struct nilfs_vinfo - virtual block number information |
| 755 | * @vi_vblocknr: |
| 756 | * @vi_start: |
| 757 | * @vi_end: |
| 758 | * @vi_blocknr: |
| 759 | */ |
| 760 | struct nilfs_vinfo { |
| 761 | __u64 vi_vblocknr; |
| 762 | __u64 vi_start; |
| 763 | __u64 vi_end; |
| 764 | __u64 vi_blocknr; |
| 765 | }; |
| 766 | |
| 767 | /** |
| 768 | * struct nilfs_vdesc - |
| 769 | */ |
| 770 | struct nilfs_vdesc { |
| 771 | __u64 vd_ino; |
| 772 | __u64 vd_cno; |
| 773 | __u64 vd_vblocknr; |
| 774 | struct nilfs_period vd_period; |
| 775 | __u64 vd_blocknr; |
| 776 | __u64 vd_offset; |
| 777 | __u32 vd_flags; |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 778 | __u32 vd_pad; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 779 | }; |
| 780 | |
| 781 | /** |
| 782 | * struct nilfs_bdesc - |
| 783 | */ |
| 784 | struct nilfs_bdesc { |
| 785 | __u64 bd_ino; |
| 786 | __u64 bd_oblocknr; |
| 787 | __u64 bd_blocknr; |
| 788 | __u64 bd_offset; |
| 789 | __u32 bd_level; |
Ryusuke Konishi | dc498d0 | 2009-04-06 19:01:52 -0700 | [diff] [blame] | 790 | __u32 bd_pad; |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 791 | }; |
| 792 | |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 793 | #define NILFS_IOCTL_IDENT 'n' |
| 794 | |
| 795 | #define NILFS_IOCTL_CHANGE_CPMODE \ |
| 796 | _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode) |
| 797 | #define NILFS_IOCTL_DELETE_CHECKPOINT \ |
| 798 | _IOW(NILFS_IOCTL_IDENT, 0x81, __u64) |
| 799 | #define NILFS_IOCTL_GET_CPINFO \ |
| 800 | _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv) |
| 801 | #define NILFS_IOCTL_GET_CPSTAT \ |
| 802 | _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat) |
| 803 | #define NILFS_IOCTL_GET_SUINFO \ |
| 804 | _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv) |
| 805 | #define NILFS_IOCTL_GET_SUSTAT \ |
| 806 | _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat) |
| 807 | #define NILFS_IOCTL_GET_VINFO \ |
| 808 | _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv) |
| 809 | #define NILFS_IOCTL_GET_BDESCS \ |
| 810 | _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv) |
| 811 | #define NILFS_IOCTL_CLEAN_SEGMENTS \ |
| 812 | _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5]) |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 813 | #define NILFS_IOCTL_SYNC \ |
| 814 | _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64) |
| 815 | #define NILFS_IOCTL_RESIZE \ |
| 816 | _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64) |
| 817 | |
Koji Sato | eed10e3 | 2009-04-06 19:01:21 -0700 | [diff] [blame] | 818 | #endif /* _LINUX_NILFS_FS_H */ |