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