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