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