include/linux/nilfs2_fs.h

   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
  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)
  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;
  89         __le32  i_ctime_nsec;
  90         __le32  i_mtime_nsec;
  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 */
 154 #define NILFS_MOUNT_NORECOVERY          0x4000  /* Disable write access during
 155                                                    mount-time recovery */
 156 #define NILFS_MOUNT_DISCARD             0x8000  /* Issue DISCARD requests */
 157
 158
 159 /**
 160  * struct nilfs_super_block - structure of super block on disk
 161  */
 162 struct nilfs_super_block {
 163 /*00*/  __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 /*10*/  __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 /*20*/  __le64  s_dev_size;             /* block device size in bytes */
 179         __le64  s_first_data_block;     /* 1st seg disk block number */
 180 /*30*/  __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 /*40*/  __le64  s_last_pseg;            /* disk block addr pseg written last */
 185         __le64  s_last_seq;             /* seq. number of seg written last */
 186 /*50*/  __le64  s_free_blocks_count;    /* Free blocks count */
 187
 188         __le64  s_ctime;                /* Creation time (execution time of
 189                                            newfs) */
 190 /*60*/  __le64  s_mtime;                /* Mount time */
 191         __le64  s_wtime;                /* Write time */
 192 /*70*/  __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 /*80*/  __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 */
 202         __le32  s_first_ino;            /* First non-reserved inode */
 203
 204 /*90*/  __le16  s_inode_size;           /* Size of an inode */
 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 /*98*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
 210 /*A8*/  char    s_volume_name[80];      /* volume name */
 211
 212 /*F8*/  __le32  s_c_interval;           /* Commit interval of segment */
 213         __le32  s_c_block_max;          /* Threshold of data amount for
 214                                            the segment construction */
 215 /*100*/ __le64  s_feature_compat;       /* Compatible feature set */
 216         __le64  s_feature_compat_ro;    /* Read-only compatible feature set */
 217         __le64  s_feature_incompat;     /* Incompatible feature set */
 218         __u32   s_reserved[186];        /* padding to the end of the block */
 219 };
 220
 221 /*
 222  * Codes for operating systems
 223  */
 224 #define NILFS_OS_LINUX          0
 225 /* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */
 226
 227 /*
 228  * Revision levels
 229  */
 230 #define NILFS_CURRENT_REV       2       /* current major revision */
 231 #define NILFS_MINOR_REV         0       /* minor revision */
 232
 233 /*
 234  * Feature set definitions
 235  *
 236  * If there is a bit set in the incompatible feature set that the kernel
 237  * doesn't know about, it should refuse to mount the filesystem.
 238  */
 239 #define NILFS_FEATURE_COMPAT_SUPP       0ULL
 240 #define NILFS_FEATURE_COMPAT_RO_SUPP    0ULL
 241 #define NILFS_FEATURE_INCOMPAT_SUPP     0ULL
 242
 243 /*
 244  * Bytes count of super_block for CRC-calculation
 245  */
 246 #define NILFS_SB_BYTES  \
 247         ((long)&((struct nilfs_super_block *)0)->s_reserved)
 248
 249 /*
 250  * Special inode number
 251  */
 252 #define NILFS_ROOT_INO          2       /* Root file inode */
 253 #define NILFS_DAT_INO           3       /* DAT file */
 254 #define NILFS_CPFILE_INO        4       /* checkpoint file */
 255 #define NILFS_SUFILE_INO        5       /* segment usage file */
 256 #define NILFS_IFILE_INO         6       /* ifile */
 257 #define NILFS_ATIME_INO         7       /* Atime file (reserved) */
 258 #define NILFS_XATTR_INO         8       /* Xattribute file (reserved) */
 259 #define NILFS_SKETCH_INO        10      /* Sketch file */
 260 #define NILFS_USER_INO          11      /* Fisrt user's file inode number */
 261
 262 #define NILFS_SB_OFFSET_BYTES   1024    /* byte offset of nilfs superblock */
 263 #define NILFS_SUPER_MAGIC       0x3434  /* NILFS filesystem  magic number */
 264
 265 #define NILFS_SEG_MIN_BLOCKS    16      /* Minimum number of blocks in
 266                                            a full segment */
 267 #define NILFS_PSEG_MIN_BLOCKS   2       /* Minimum number of blocks in
 268                                            a partial segment */
 269 #define NILFS_MIN_NRSVSEGS      8       /* Minimum number of reserved
 270                                            segments */
 271
 272 /*
 273  * bytes offset of secondary super block
 274  */
 275 #define NILFS_SB2_OFFSET_BYTES(devsize) ((((devsize) >> 12) - 1) << 12)
 276
 277 /*
 278  * Maximal count of links to a file
 279  */
 280 #define NILFS_LINK_MAX          32000
 281
 282 /*
 283  * Structure of a directory entry
 284  *  (Same as ext2)
 285  */
 286
 287 #define NILFS_NAME_LEN 255
 288
 289 /*
 290  * Block size limitations
 291  */
 292 #define NILFS_MIN_BLOCK_SIZE            1024
 293 #define NILFS_MAX_BLOCK_SIZE            65536
 294
 295 /*
 296  * The new version of the directory entry.  Since V0 structures are
 297  * stored in intel byte order, and the name_len field could never be
 298  * bigger than 255 chars, it's safe to reclaim the extra byte for the
 299  * file_type field.
 300  */
 301 struct nilfs_dir_entry {
 302         __le64  inode;                  /* Inode number */
 303         __le16  rec_len;                /* Directory entry length */
 304         __u8    name_len;               /* Name length */
 305         __u8    file_type;
 306         char    name[NILFS_NAME_LEN];   /* File name */
 307         char    pad;
 308 };
 309
 310 /*
 311  * NILFS directory file types.  Only the low 3 bits are used.  The
 312  * other bits are reserved for now.
 313  */
 314 enum {
 315         NILFS_FT_UNKNOWN,
 316         NILFS_FT_REG_FILE,
 317         NILFS_FT_DIR,
 318         NILFS_FT_CHRDEV,
 319         NILFS_FT_BLKDEV,
 320         NILFS_FT_FIFO,
 321         NILFS_FT_SOCK,
 322         NILFS_FT_SYMLINK,
 323         NILFS_FT_MAX
 324 };
 325
 326 /*
 327  * NILFS_DIR_PAD defines the directory entries boundaries
 328  *
 329  * NOTE: It must be a multiple of 8
 330  */
 331 #define NILFS_DIR_PAD                   8
 332 #define NILFS_DIR_ROUND                 (NILFS_DIR_PAD - 1)
 333 #define NILFS_DIR_REC_LEN(name_len)     (((name_len) + 12 + NILFS_DIR_ROUND) & \
 334                                         ~NILFS_DIR_ROUND)
 335 #define NILFS_MAX_REC_LEN               ((1<<16)-1)
 336
 337 static inline unsigned nilfs_rec_len_from_disk(__le16 dlen)
 338 {
 339         unsigned len = le16_to_cpu(dlen);
 340
 341         if (len == NILFS_MAX_REC_LEN)
 342                 return 1 << 16;
 343         return len;
 344 }
 345
 346 static inline __le16 nilfs_rec_len_to_disk(unsigned len)
 347 {
 348         if (len == (1 << 16))
 349                 return cpu_to_le16(NILFS_MAX_REC_LEN);
 350         else if (len > (1 << 16))
 351                 BUG();
 352         return cpu_to_le16(len);
 353 }
 354
 355 /**
 356  * struct nilfs_finfo - file information
 357  * @fi_ino: inode number
 358  * @fi_cno: checkpoint number
 359  * @fi_nblocks: number of blocks (including intermediate blocks)
 360  * @fi_ndatablk: number of file data blocks
 361  */
 362 struct nilfs_finfo {
 363         __le64 fi_ino;
 364         __le64 fi_cno;
 365         __le32 fi_nblocks;
 366         __le32 fi_ndatablk;
 367         /* array of virtual block numbers */
 368 };
 369
 370 /**
 371  * struct nilfs_binfo_v - information for the block to which a virtual block number is assigned
 372  * @bi_vblocknr: virtual block number
 373  * @bi_blkoff: block offset
 374  */
 375 struct nilfs_binfo_v {
 376         __le64 bi_vblocknr;
 377         __le64 bi_blkoff;
 378 };
 379
 380 /**
 381  * struct nilfs_binfo_dat - information for the block which belongs to the DAT file
 382  * @bi_blkoff: block offset
 383  * @bi_level: level
 384  * @bi_pad: padding
 385  */
 386 struct nilfs_binfo_dat {
 387         __le64 bi_blkoff;
 388         __u8 bi_level;
 389         __u8 bi_pad[7];
 390 };
 391
 392 /**
 393  * union nilfs_binfo: block information
 394  * @bi_v: nilfs_binfo_v structure
 395  * @bi_dat: nilfs_binfo_dat structure
 396  */
 397 union nilfs_binfo {
 398         struct nilfs_binfo_v bi_v;
 399         struct nilfs_binfo_dat bi_dat;
 400 };
 401
 402 /**
 403  * struct nilfs_segment_summary - segment summary
 404  * @ss_datasum: checksum of data
 405  * @ss_sumsum: checksum of segment summary
 406  * @ss_magic: magic number
 407  * @ss_bytes: size of this structure in bytes
 408  * @ss_flags: flags
 409  * @ss_seq: sequence number
 410  * @ss_create: creation timestamp
 411  * @ss_next: next segment
 412  * @ss_nblocks: number of blocks
 413  * @ss_nfinfo: number of finfo structures
 414  * @ss_sumbytes: total size of segment summary in bytes
 415  * @ss_pad: padding
 416  * @ss_cno: checkpoint number
 417  */
 418 struct nilfs_segment_summary {
 419         __le32 ss_datasum;
 420         __le32 ss_sumsum;
 421         __le32 ss_magic;
 422         __le16 ss_bytes;
 423         __le16 ss_flags;
 424         __le64 ss_seq;
 425         __le64 ss_create;
 426         __le64 ss_next;
 427         __le32 ss_nblocks;
 428         __le32 ss_nfinfo;
 429         __le32 ss_sumbytes;
 430         __le32 ss_pad;
 431         __le64 ss_cno;
 432         /* array of finfo structures */
 433 };
 434
 435 #define NILFS_SEGSUM_MAGIC      0x1eaffa11  /* segment summary magic number */
 436
 437 /*
 438  * Segment summary flags
 439  */
 440 #define NILFS_SS_LOGBGN 0x0001  /* begins a logical segment */
 441 #define NILFS_SS_LOGEND 0x0002  /* ends a logical segment */
 442 #define NILFS_SS_SR     0x0004  /* has super root */
 443 #define NILFS_SS_SYNDT  0x0008  /* includes data only updates */
 444 #define NILFS_SS_GC     0x0010  /* segment written for cleaner operation */
 445
 446 /**
 447  * struct nilfs_btree_node - B-tree node
 448  * @bn_flags: flags
 449  * @bn_level: level
 450  * @bn_nchildren: number of children
 451  * @bn_pad: padding
 452  */
 453 struct nilfs_btree_node {
 454         __u8 bn_flags;
 455         __u8 bn_level;
 456         __le16 bn_nchildren;
 457         __le32 bn_pad;
 458 };
 459
 460 /* flags */
 461 #define NILFS_BTREE_NODE_ROOT   0x01
 462
 463 /* level */
 464 #define NILFS_BTREE_LEVEL_DATA          0
 465 #define NILFS_BTREE_LEVEL_NODE_MIN      (NILFS_BTREE_LEVEL_DATA + 1)
 466 #define NILFS_BTREE_LEVEL_MAX           14
 467
 468 /**
 469  * struct nilfs_palloc_group_desc - block group descriptor
 470  * @pg_nfrees: number of free entries in block group
 471  */
 472 struct nilfs_palloc_group_desc {
 473         __le32 pg_nfrees;
 474 };
 475
 476 /**
 477  * struct nilfs_dat_entry - disk address translation entry
 478  * @de_blocknr: block number
 479  * @de_start: start checkpoint number
 480  * @de_end: end checkpoint number
 481  * @de_rsv: reserved for future use
 482  */
 483 struct nilfs_dat_entry {
 484         __le64 de_blocknr;
 485         __le64 de_start;
 486         __le64 de_end;
 487         __le64 de_rsv;
 488 };
 489
 490 /**
 491  * struct nilfs_snapshot_list - snapshot list
 492  * @ssl_next: next checkpoint number on snapshot list
 493  * @ssl_prev: previous checkpoint number on snapshot list
 494  */
 495 struct nilfs_snapshot_list {
 496         __le64 ssl_next;
 497         __le64 ssl_prev;
 498 };
 499
 500 /**
 501  * struct nilfs_checkpoint - checkpoint structure
 502  * @cp_flags: flags
 503  * @cp_checkpoints_count: checkpoints count in a block
 504  * @cp_snapshot_list: snapshot list
 505  * @cp_cno: checkpoint number
 506  * @cp_create: creation timestamp
 507  * @cp_nblk_inc: number of blocks incremented by this checkpoint
 508  * @cp_inodes_count: inodes count
 509  * @cp_blocks_count: blocks count
 510  * @cp_ifile_inode: inode of ifile
 511  */
 512 struct nilfs_checkpoint {
 513         __le32 cp_flags;
 514         __le32 cp_checkpoints_count;
 515         struct nilfs_snapshot_list cp_snapshot_list;
 516         __le64 cp_cno;
 517         __le64 cp_create;
 518         __le64 cp_nblk_inc;
 519         __le64 cp_inodes_count;
 520         __le64 cp_blocks_count;         /* Reserved (might be deleted) */
 521
 522         /* Do not change the byte offset of ifile inode.
 523            To keep the compatibility of the disk format,
 524            additional fields should be added behind cp_ifile_inode. */
 525         struct nilfs_inode cp_ifile_inode;
 526 };
 527
 528 /* checkpoint flags */
 529 enum {
 530         NILFS_CHECKPOINT_SNAPSHOT,
 531         NILFS_CHECKPOINT_INVALID,
 532         NILFS_CHECKPOINT_SKETCH,
 533         NILFS_CHECKPOINT_MINOR,
 534 };
 535
 536 #define NILFS_CHECKPOINT_FNS(flag, name)                                \
 537 static inline void                                                      \
 538 nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp)                \
 539 {                                                                       \
 540         cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) |          \
 541                                    (1UL << NILFS_CHECKPOINT_##flag));   \
 542 }                                                                       \
 543 static inline void                                                      \
 544 nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp)              \
 545 {                                                                       \
 546         cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) &          \
 547                                    ~(1UL << NILFS_CHECKPOINT_##flag));  \
 548 }                                                                       \
 549 static inline int                                                       \
 550 nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp)              \
 551 {                                                                       \
 552         return !!(le32_to_cpu(cp->cp_flags) &                           \
 553                   (1UL << NILFS_CHECKPOINT_##flag));                    \
 554 }
 555
 556 NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot)
 557 NILFS_CHECKPOINT_FNS(INVALID, invalid)
 558 NILFS_CHECKPOINT_FNS(MINOR, minor)
 559
 560 /**
 561  * struct nilfs_cpinfo - checkpoint information
 562  * @ci_flags: flags
 563  * @ci_pad: padding
 564  * @ci_cno: checkpoint number
 565  * @ci_create: creation timestamp
 566  * @ci_nblk_inc: number of blocks incremented by this checkpoint
 567  * @ci_inodes_count: inodes count
 568  * @ci_blocks_count: blocks count
 569  * @ci_next: next checkpoint number in snapshot list
 570  */
 571 struct nilfs_cpinfo {
 572         __u32 ci_flags;
 573         __u32 ci_pad;
 574         __u64 ci_cno;
 575         __u64 ci_create;
 576         __u64 ci_nblk_inc;
 577         __u64 ci_inodes_count;
 578         __u64 ci_blocks_count;
 579         __u64 ci_next;
 580 };
 581
 582 #define NILFS_CPINFO_FNS(flag, name)                                    \
 583 static inline int                                                       \
 584 nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo)                  \
 585 {                                                                       \
 586         return !!(cpinfo->ci_flags & (1UL << NILFS_CHECKPOINT_##flag)); \
 587 }
 588
 589 NILFS_CPINFO_FNS(SNAPSHOT, snapshot)
 590 NILFS_CPINFO_FNS(INVALID, invalid)
 591 NILFS_CPINFO_FNS(MINOR, minor)
 592
 593
 594 /**
 595  * struct nilfs_cpfile_header - checkpoint file header
 596  * @ch_ncheckpoints: number of checkpoints
 597  * @ch_nsnapshots: number of snapshots
 598  * @ch_snapshot_list: snapshot list
 599  */
 600 struct nilfs_cpfile_header {
 601         __le64 ch_ncheckpoints;
 602         __le64 ch_nsnapshots;
 603         struct nilfs_snapshot_list ch_snapshot_list;
 604 };
 605
 606 #define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET    \
 607         ((sizeof(struct nilfs_cpfile_header) +                          \
 608           sizeof(struct nilfs_checkpoint) - 1) /                        \
 609                         sizeof(struct nilfs_checkpoint))
 610
 611 /**
 612  * struct nilfs_segment_usage - segment usage
 613  * @su_lastmod: last modified timestamp
 614  * @su_nblocks: number of blocks in segment
 615  * @su_flags: flags
 616  */
 617 struct nilfs_segment_usage {
 618         __le64 su_lastmod;
 619         __le32 su_nblocks;
 620         __le32 su_flags;
 621 };
 622
 623 /* segment usage flag */
 624 enum {
 625         NILFS_SEGMENT_USAGE_ACTIVE,
 626         NILFS_SEGMENT_USAGE_DIRTY,
 627         NILFS_SEGMENT_USAGE_ERROR,
 628
 629         /* ... */
 630 };
 631
 632 #define NILFS_SEGMENT_USAGE_FNS(flag, name)                             \
 633 static inline void                                                      \
 634 nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su)          \
 635 {                                                                       \
 636         su->su_flags = cpu_to_le32(le32_to_cpu(su->su_flags) |          \
 637                                    (1UL << NILFS_SEGMENT_USAGE_##flag));\
 638 }                                                                       \
 639 static inline void                                                      \
 640 nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su)        \
 641 {                                                                       \
 642         su->su_flags =                                                  \
 643                 cpu_to_le32(le32_to_cpu(su->su_flags) &                 \
 644                             ~(1UL << NILFS_SEGMENT_USAGE_##flag));      \
 645 }                                                                       \
 646 static inline int                                                       \
 647 nilfs_segment_usage_##name(const struct nilfs_segment_usage *su)        \
 648 {                                                                       \
 649         return !!(le32_to_cpu(su->su_flags) &                           \
 650                   (1UL << NILFS_SEGMENT_USAGE_##flag));                 \
 651 }
 652
 653 NILFS_SEGMENT_USAGE_FNS(ACTIVE, active)
 654 NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty)
 655 NILFS_SEGMENT_USAGE_FNS(ERROR, error)
 656
 657 static inline void
 658 nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su)
 659 {
 660         su->su_lastmod = cpu_to_le64(0);
 661         su->su_nblocks = cpu_to_le32(0);
 662         su->su_flags = cpu_to_le32(0);
 663 }
 664
 665 static inline int
 666 nilfs_segment_usage_clean(const struct nilfs_segment_usage *su)
 667 {
 668         return !le32_to_cpu(su->su_flags);
 669 }
 670
 671 /**
 672  * struct nilfs_sufile_header - segment usage file header
 673  * @sh_ncleansegs: number of clean segments
 674  * @sh_ndirtysegs: number of dirty segments
 675  * @sh_last_alloc: last allocated segment number
 676  */
 677 struct nilfs_sufile_header {
 678         __le64 sh_ncleansegs;
 679         __le64 sh_ndirtysegs;
 680         __le64 sh_last_alloc;
 681         /* ... */
 682 };
 683
 684 #define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \
 685         ((sizeof(struct nilfs_sufile_header) +                          \
 686           sizeof(struct nilfs_segment_usage) - 1) /                     \
 687                          sizeof(struct nilfs_segment_usage))
 688
 689 /**
 690  * nilfs_suinfo - segment usage information
 691  * @sui_lastmod:
 692  * @sui_nblocks:
 693  * @sui_flags:
 694  */
 695 struct nilfs_suinfo {
 696         __u64 sui_lastmod;
 697         __u32 sui_nblocks;
 698         __u32 sui_flags;
 699 };
 700
 701 #define NILFS_SUINFO_FNS(flag, name)                                    \
 702 static inline int                                                       \
 703 nilfs_suinfo_##name(const struct nilfs_suinfo *si)                      \
 704 {                                                                       \
 705         return si->sui_flags & (1UL << NILFS_SEGMENT_USAGE_##flag);     \
 706 }
 707
 708 NILFS_SUINFO_FNS(ACTIVE, active)
 709 NILFS_SUINFO_FNS(DIRTY, dirty)
 710 NILFS_SUINFO_FNS(ERROR, error)
 711
 712 static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si)
 713 {
 714         return !si->sui_flags;
 715 }
 716
 717 /* ioctl */
 718 enum {
 719         NILFS_CHECKPOINT,
 720         NILFS_SNAPSHOT,
 721 };
 722
 723 /**
 724  * struct nilfs_cpmode -
 725  * @cc_cno:
 726  * @cc_mode:
 727  */
 728 struct nilfs_cpmode {
 729         __u64 cm_cno;
 730         __u32 cm_mode;
 731         __u32 cm_pad;
 732 };
 733
 734 /**
 735  * struct nilfs_argv - argument vector
 736  * @v_base:
 737  * @v_nmembs:
 738  * @v_size:
 739  * @v_flags:
 740  * @v_index:
 741  */
 742 struct nilfs_argv {
 743         __u64 v_base;
 744         __u32 v_nmembs; /* number of members */
 745         __u16 v_size;   /* size of members */
 746         __u16 v_flags;
 747         __u64 v_index;
 748 };
 749
 750 /**
 751  * struct nilfs_period -
 752  * @p_start:
 753  * @p_end:
 754  */
 755 struct nilfs_period {
 756         __u64 p_start;
 757         __u64 p_end;
 758 };
 759
 760 /**
 761  * struct nilfs_cpstat -
 762  * @cs_cno: checkpoint number
 763  * @cs_ncps: number of checkpoints
 764  * @cs_nsss: number of snapshots
 765  */
 766 struct nilfs_cpstat {
 767         __u64 cs_cno;
 768         __u64 cs_ncps;
 769         __u64 cs_nsss;
 770 };
 771
 772 /**
 773  * struct nilfs_sustat -
 774  * @ss_nsegs: number of segments
 775  * @ss_ncleansegs: number of clean segments
 776  * @ss_ndirtysegs: number of dirty segments
 777  * @ss_ctime: creation time of the last segment
 778  * @ss_nongc_ctime: creation time of the last segment not for GC
 779  * @ss_prot_seq: least sequence number of segments which must not be reclaimed
 780  */
 781 struct nilfs_sustat {
 782         __u64 ss_nsegs;
 783         __u64 ss_ncleansegs;
 784         __u64 ss_ndirtysegs;
 785         __u64 ss_ctime;
 786         __u64 ss_nongc_ctime;
 787         __u64 ss_prot_seq;
 788 };
 789
 790 /**
 791  * struct nilfs_vinfo - virtual block number information
 792  * @vi_vblocknr:
 793  * @vi_start:
 794  * @vi_end:
 795  * @vi_blocknr:
 796  */
 797 struct nilfs_vinfo {
 798         __u64 vi_vblocknr;
 799         __u64 vi_start;
 800         __u64 vi_end;
 801         __u64 vi_blocknr;
 802 };
 803
 804 /**
 805  * struct nilfs_vdesc -
 806  */
 807 struct nilfs_vdesc {
 808         __u64 vd_ino;
 809         __u64 vd_cno;
 810         __u64 vd_vblocknr;
 811         struct nilfs_period vd_period;
 812         __u64 vd_blocknr;
 813         __u64 vd_offset;
 814         __u32 vd_flags;
 815         __u32 vd_pad;
 816 };
 817
 818 /**
 819  * struct nilfs_bdesc -
 820  */
 821 struct nilfs_bdesc {
 822         __u64 bd_ino;
 823         __u64 bd_oblocknr;
 824         __u64 bd_blocknr;
 825         __u64 bd_offset;
 826         __u32 bd_level;
 827         __u32 bd_pad;
 828 };
 829
 830 #define NILFS_IOCTL_IDENT               'n'
 831
 832 #define NILFS_IOCTL_CHANGE_CPMODE  \
 833         _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode)
 834 #define NILFS_IOCTL_DELETE_CHECKPOINT  \
 835         _IOW(NILFS_IOCTL_IDENT, 0x81, __u64)
 836 #define NILFS_IOCTL_GET_CPINFO  \
 837         _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv)
 838 #define NILFS_IOCTL_GET_CPSTAT  \
 839         _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat)
 840 #define NILFS_IOCTL_GET_SUINFO  \
 841         _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv)
 842 #define NILFS_IOCTL_GET_SUSTAT  \
 843         _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat)
 844 #define NILFS_IOCTL_GET_VINFO  \
 845         _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv)
 846 #define NILFS_IOCTL_GET_BDESCS  \
 847         _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv)
 848 #define NILFS_IOCTL_CLEAN_SEGMENTS  \
 849         _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5])
 850 #define NILFS_IOCTL_SYNC  \
 851         _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64)
 852 #define NILFS_IOCTL_RESIZE  \
 853         _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64)
 854
 855 #endif  /* _LINUX_NILFS_FS_H */