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  * Written by Koji Sato and Ryusuke Konishi.
  17  */
  18 /*
  19  *  linux/include/linux/ext2_fs.h
  20  *
  21  * Copyright (C) 1992, 1993, 1994, 1995
  22  * Remy Card (card@masi.ibp.fr)
  23  * Laboratoire MASI - Institut Blaise Pascal
  24  * Universite Pierre et Marie Curie (Paris VI)
  25  *
  26  *  from
  27  *
  28  *  linux/include/linux/minix_fs.h
  29  *
  30  *  Copyright (C) 1991, 1992  Linus Torvalds
  31  */
  32
  33 #ifndef _LINUX_NILFS_FS_H
  34 #define _LINUX_NILFS_FS_H
  35
  36 #include <linux/types.h>
  37 #include <linux/ioctl.h>
  38 #include <linux/magic.h>
  39 #include <linux/bug.h>
  40
  41
  42 #define NILFS_INODE_BMAP_SIZE   7
  43 /**
  44  * struct nilfs_inode - structure of an inode on disk
  45  * @i_blocks: blocks count
  46  * @i_size: size in bytes
  47  * @i_ctime: creation time (seconds)
  48  * @i_mtime: modification time (seconds)
  49  * @i_ctime_nsec: creation time (nano seconds)
  50  * @i_mtime_nsec: modification time (nano seconds)
  51  * @i_uid: user id
  52  * @i_gid: group id
  53  * @i_mode: file mode
  54  * @i_links_count: links count
  55  * @i_flags: file flags
  56  * @i_bmap: block mapping
  57  * @i_xattr: extended attributes
  58  * @i_generation: file generation (for NFS)
  59  * @i_pad:      padding
  60  */
  61 struct nilfs_inode {
  62         __le64  i_blocks;
  63         __le64  i_size;
  64         __le64  i_ctime;
  65         __le64  i_mtime;
  66         __le32  i_ctime_nsec;
  67         __le32  i_mtime_nsec;
  68         __le32  i_uid;
  69         __le32  i_gid;
  70         __le16  i_mode;
  71         __le16  i_links_count;
  72         __le32  i_flags;
  73         __le64  i_bmap[NILFS_INODE_BMAP_SIZE];
  74 #define i_device_code   i_bmap[0]
  75         __le64  i_xattr;
  76         __le32  i_generation;
  77         __le32  i_pad;
  78 };
  79
  80 #define NILFS_MIN_INODE_SIZE            128
  81
  82 /**
  83  * struct nilfs_super_root - structure of super root
  84  * @sr_sum: check sum
  85  * @sr_bytes: byte count of the structure
  86  * @sr_flags: flags (reserved)
  87  * @sr_nongc_ctime: write time of the last segment not for cleaner operation
  88  * @sr_dat: DAT file inode
  89  * @sr_cpfile: checkpoint file inode
  90  * @sr_sufile: segment usage file inode
  91  */
  92 struct nilfs_super_root {
  93         __le32 sr_sum;
  94         __le16 sr_bytes;
  95         __le16 sr_flags;
  96         __le64 sr_nongc_ctime;
  97         struct nilfs_inode sr_dat;
  98         struct nilfs_inode sr_cpfile;
  99         struct nilfs_inode sr_sufile;
 100 };
 101
 102 #define NILFS_SR_MDT_OFFSET(inode_size, i)  \
 103         ((unsigned long)&((struct nilfs_super_root *)0)->sr_dat + \
 104                         (inode_size) * (i))
 105 #define NILFS_SR_DAT_OFFSET(inode_size)     NILFS_SR_MDT_OFFSET(inode_size, 0)
 106 #define NILFS_SR_CPFILE_OFFSET(inode_size)  NILFS_SR_MDT_OFFSET(inode_size, 1)
 107 #define NILFS_SR_SUFILE_OFFSET(inode_size)  NILFS_SR_MDT_OFFSET(inode_size, 2)
 108 #define NILFS_SR_BYTES(inode_size)          NILFS_SR_MDT_OFFSET(inode_size, 3)
 109
 110 /*
 111  * Maximal mount counts
 112  */
 113 #define NILFS_DFL_MAX_MNT_COUNT         50      /* 50 mounts */
 114
 115 /*
 116  * File system states (sbp->s_state, nilfs->ns_mount_state)
 117  */
 118 #define NILFS_VALID_FS                  0x0001  /* Unmounted cleanly */
 119 #define NILFS_ERROR_FS                  0x0002  /* Errors detected */
 120 #define NILFS_RESIZE_FS                 0x0004  /* Resize required */
 121
 122 /*
 123  * Mount flags (sbi->s_mount_opt)
 124  */
 125 #define NILFS_MOUNT_ERROR_MODE          0x0070  /* Error mode mask */
 126 #define NILFS_MOUNT_ERRORS_CONT         0x0010  /* Continue on errors */
 127 #define NILFS_MOUNT_ERRORS_RO           0x0020  /* Remount fs ro on errors */
 128 #define NILFS_MOUNT_ERRORS_PANIC        0x0040  /* Panic on errors */
 129 #define NILFS_MOUNT_BARRIER             0x1000  /* Use block barriers */
 130 #define NILFS_MOUNT_STRICT_ORDER        0x2000  /* Apply strict in-order
 131                                                    semantics also for data */
 132 #define NILFS_MOUNT_NORECOVERY          0x4000  /* Disable write access during
 133                                                    mount-time recovery */
 134 #define NILFS_MOUNT_DISCARD             0x8000  /* Issue DISCARD requests */
 135
 136
 137 /**
 138  * struct nilfs_super_block - structure of super block on disk
 139  */
 140 struct nilfs_super_block {
 141 /*00*/  __le32  s_rev_level;            /* Revision level */
 142         __le16  s_minor_rev_level;      /* minor revision level */
 143         __le16  s_magic;                /* Magic signature */
 144
 145         __le16  s_bytes;                /* Bytes count of CRC calculation
 146                                            for this structure. s_reserved
 147                                            is excluded. */
 148         __le16  s_flags;                /* flags */
 149         __le32  s_crc_seed;             /* Seed value of CRC calculation */
 150 /*10*/  __le32  s_sum;                  /* Check sum of super block */
 151
 152         __le32  s_log_block_size;       /* Block size represented as follows
 153                                            blocksize =
 154                                                1 << (s_log_block_size + 10) */
 155         __le64  s_nsegments;            /* Number of segments in filesystem */
 156 /*20*/  __le64  s_dev_size;             /* block device size in bytes */
 157         __le64  s_first_data_block;     /* 1st seg disk block number */
 158 /*30*/  __le32  s_blocks_per_segment;   /* number of blocks per full segment */
 159         __le32  s_r_segments_percentage; /* Reserved segments percentage */
 160
 161         __le64  s_last_cno;             /* Last checkpoint number */
 162 /*40*/  __le64  s_last_pseg;            /* disk block addr pseg written last */
 163         __le64  s_last_seq;             /* seq. number of seg written last */
 164 /*50*/  __le64  s_free_blocks_count;    /* Free blocks count */
 165
 166         __le64  s_ctime;                /* Creation time (execution time of
 167                                            newfs) */
 168 /*60*/  __le64  s_mtime;                /* Mount time */
 169         __le64  s_wtime;                /* Write time */
 170 /*70*/  __le16  s_mnt_count;            /* Mount count */
 171         __le16  s_max_mnt_count;        /* Maximal mount count */
 172         __le16  s_state;                /* File system state */
 173         __le16  s_errors;               /* Behaviour when detecting errors */
 174         __le64  s_lastcheck;            /* time of last check */
 175
 176 /*80*/  __le32  s_checkinterval;        /* max. time between checks */
 177         __le32  s_creator_os;           /* OS */
 178         __le16  s_def_resuid;           /* Default uid for reserved blocks */
 179         __le16  s_def_resgid;           /* Default gid for reserved blocks */
 180         __le32  s_first_ino;            /* First non-reserved inode */
 181
 182 /*90*/  __le16  s_inode_size;           /* Size of an inode */
 183         __le16  s_dat_entry_size;       /* Size of a dat entry */
 184         __le16  s_checkpoint_size;      /* Size of a checkpoint */
 185         __le16  s_segment_usage_size;   /* Size of a segment usage */
 186
 187 /*98*/  __u8    s_uuid[16];             /* 128-bit uuid for volume */
 188 /*A8*/  char    s_volume_name[80];      /* volume name */
 189
 190 /*F8*/  __le32  s_c_interval;           /* Commit interval of segment */
 191         __le32  s_c_block_max;          /* Threshold of data amount for
 192                                            the segment construction */
 193 /*100*/ __le64  s_feature_compat;       /* Compatible feature set */
 194         __le64  s_feature_compat_ro;    /* Read-only compatible feature set */
 195         __le64  s_feature_incompat;     /* Incompatible feature set */
 196         __u32   s_reserved[186];        /* padding to the end of the block */
 197 };
 198
 199 /*
 200  * Codes for operating systems
 201  */
 202 #define NILFS_OS_LINUX          0
 203 /* Codes from 1 to 4 are reserved to keep compatibility with ext2 creator-OS */
 204
 205 /*
 206  * Revision levels
 207  */
 208 #define NILFS_CURRENT_REV       2       /* current major revision */
 209 #define NILFS_MINOR_REV         0       /* minor revision */
 210 #define NILFS_MIN_SUPP_REV      2       /* minimum supported revision */
 211
 212 /*
 213  * Feature set definitions
 214  *
 215  * If there is a bit set in the incompatible feature set that the kernel
 216  * doesn't know about, it should refuse to mount the filesystem.
 217  */
 218 #define NILFS_FEATURE_COMPAT_RO_BLOCK_COUNT     0x00000001ULL
 219
 220 #define NILFS_FEATURE_COMPAT_SUPP       0ULL
 221 #define NILFS_FEATURE_COMPAT_RO_SUPP    NILFS_FEATURE_COMPAT_RO_BLOCK_COUNT
 222 #define NILFS_FEATURE_INCOMPAT_SUPP     0ULL
 223
 224 /*
 225  * Bytes count of super_block for CRC-calculation
 226  */
 227 #define NILFS_SB_BYTES  \
 228         ((long)&((struct nilfs_super_block *)0)->s_reserved)
 229
 230 /*
 231  * Special inode number
 232  */
 233 #define NILFS_ROOT_INO          2       /* Root file inode */
 234 #define NILFS_DAT_INO           3       /* DAT file */
 235 #define NILFS_CPFILE_INO        4       /* checkpoint file */
 236 #define NILFS_SUFILE_INO        5       /* segment usage file */
 237 #define NILFS_IFILE_INO         6       /* ifile */
 238 #define NILFS_ATIME_INO         7       /* Atime file (reserved) */
 239 #define NILFS_XATTR_INO         8       /* Xattribute file (reserved) */
 240 #define NILFS_SKETCH_INO        10      /* Sketch file */
 241 #define NILFS_USER_INO          11      /* Fisrt user's file inode number */
 242
 243 #define NILFS_SB_OFFSET_BYTES   1024    /* byte offset of nilfs superblock */
 244
 245 #define NILFS_SEG_MIN_BLOCKS    16      /* Minimum number of blocks in
 246                                            a full segment */
 247 #define NILFS_PSEG_MIN_BLOCKS   2       /* Minimum number of blocks in
 248                                            a partial segment */
 249 #define NILFS_MIN_NRSVSEGS      8       /* Minimum number of reserved
 250                                            segments */
 251
 252 /*
 253  * We call DAT, cpfile, and sufile root metadata files.  Inodes of
 254  * these files are written in super root block instead of ifile, and
 255  * garbage collector doesn't keep any past versions of these files.
 256  */
 257 #define NILFS_ROOT_METADATA_FILE(ino) \
 258         ((ino) >= NILFS_DAT_INO && (ino) <= NILFS_SUFILE_INO)
 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  * Block size limitations
 279  */
 280 #define NILFS_MIN_BLOCK_SIZE            1024
 281 #define NILFS_MAX_BLOCK_SIZE            65536
 282
 283 /*
 284  * The new version of the directory entry.  Since V0 structures are
 285  * stored in intel byte order, and the name_len field could never be
 286  * bigger than 255 chars, it's safe to reclaim the extra byte for the
 287  * file_type field.
 288  */
 289 struct nilfs_dir_entry {
 290         __le64  inode;                  /* Inode number */
 291         __le16  rec_len;                /* Directory entry length */
 292         __u8    name_len;               /* Name length */
 293         __u8    file_type;              /* Dir entry type (file, dir, etc) */
 294         char    name[NILFS_NAME_LEN];   /* File name */
 295         char    pad;
 296 };
 297
 298 /*
 299  * NILFS directory file types.  Only the low 3 bits are used.  The
 300  * other bits are reserved for now.
 301  */
 302 enum {
 303         NILFS_FT_UNKNOWN,
 304         NILFS_FT_REG_FILE,
 305         NILFS_FT_DIR,
 306         NILFS_FT_CHRDEV,
 307         NILFS_FT_BLKDEV,
 308         NILFS_FT_FIFO,
 309         NILFS_FT_SOCK,
 310         NILFS_FT_SYMLINK,
 311         NILFS_FT_MAX
 312 };
 313
 314 /*
 315  * NILFS_DIR_PAD defines the directory entries boundaries
 316  *
 317  * NOTE: It must be a multiple of 8
 318  */
 319 #define NILFS_DIR_PAD                   8
 320 #define NILFS_DIR_ROUND                 (NILFS_DIR_PAD - 1)
 321 #define NILFS_DIR_REC_LEN(name_len)     (((name_len) + 12 + NILFS_DIR_ROUND) & \
 322                                         ~NILFS_DIR_ROUND)
 323 #define NILFS_MAX_REC_LEN               ((1<<16)-1)
 324
 325 static inline unsigned nilfs_rec_len_from_disk(__le16 dlen)
 326 {
 327         unsigned len = le16_to_cpu(dlen);
 328
 329 #if !defined(__KERNEL__) || (PAGE_SIZE >= 65536)
 330         if (len == NILFS_MAX_REC_LEN)
 331                 return 1 << 16;
 332 #endif
 333         return len;
 334 }
 335
 336 static inline __le16 nilfs_rec_len_to_disk(unsigned len)
 337 {
 338 #if !defined(__KERNEL__) || (PAGE_SIZE >= 65536)
 339         if (len == (1 << 16))
 340                 return cpu_to_le16(NILFS_MAX_REC_LEN);
 341         else if (len > (1 << 16))
 342                 BUG();
 343 #endif
 344         return cpu_to_le16(len);
 345 }
 346
 347 /**
 348  * struct nilfs_finfo - file information
 349  * @fi_ino: inode number
 350  * @fi_cno: checkpoint number
 351  * @fi_nblocks: number of blocks (including intermediate blocks)
 352  * @fi_ndatablk: number of file data blocks
 353  */
 354 struct nilfs_finfo {
 355         __le64 fi_ino;
 356         __le64 fi_cno;
 357         __le32 fi_nblocks;
 358         __le32 fi_ndatablk;
 359         /* array of virtual block numbers */
 360 };
 361
 362 /**
 363  * struct nilfs_binfo_v - information for the block to which a virtual block number is assigned
 364  * @bi_vblocknr: virtual block number
 365  * @bi_blkoff: block offset
 366  */
 367 struct nilfs_binfo_v {
 368         __le64 bi_vblocknr;
 369         __le64 bi_blkoff;
 370 };
 371
 372 /**
 373  * struct nilfs_binfo_dat - information for the block which belongs to the DAT file
 374  * @bi_blkoff: block offset
 375  * @bi_level: level
 376  * @bi_pad: padding
 377  */
 378 struct nilfs_binfo_dat {
 379         __le64 bi_blkoff;
 380         __u8 bi_level;
 381         __u8 bi_pad[7];
 382 };
 383
 384 /**
 385  * union nilfs_binfo: block information
 386  * @bi_v: nilfs_binfo_v structure
 387  * @bi_dat: nilfs_binfo_dat structure
 388  */
 389 union nilfs_binfo {
 390         struct nilfs_binfo_v bi_v;
 391         struct nilfs_binfo_dat bi_dat;
 392 };
 393
 394 /**
 395  * struct nilfs_segment_summary - segment summary header
 396  * @ss_datasum: checksum of data
 397  * @ss_sumsum: checksum of segment summary
 398  * @ss_magic: magic number
 399  * @ss_bytes: size of this structure in bytes
 400  * @ss_flags: flags
 401  * @ss_seq: sequence number
 402  * @ss_create: creation timestamp
 403  * @ss_next: next segment
 404  * @ss_nblocks: number of blocks
 405  * @ss_nfinfo: number of finfo structures
 406  * @ss_sumbytes: total size of segment summary in bytes
 407  * @ss_pad: padding
 408  * @ss_cno: checkpoint number
 409  */
 410 struct nilfs_segment_summary {
 411         __le32 ss_datasum;
 412         __le32 ss_sumsum;
 413         __le32 ss_magic;
 414         __le16 ss_bytes;
 415         __le16 ss_flags;
 416         __le64 ss_seq;
 417         __le64 ss_create;
 418         __le64 ss_next;
 419         __le32 ss_nblocks;
 420         __le32 ss_nfinfo;
 421         __le32 ss_sumbytes;
 422         __le32 ss_pad;
 423         __le64 ss_cno;
 424         /* array of finfo structures */
 425 };
 426
 427 #define NILFS_SEGSUM_MAGIC      0x1eaffa11  /* segment summary magic number */
 428
 429 /*
 430  * Segment summary flags
 431  */
 432 #define NILFS_SS_LOGBGN 0x0001  /* begins a logical segment */
 433 #define NILFS_SS_LOGEND 0x0002  /* ends a logical segment */
 434 #define NILFS_SS_SR     0x0004  /* has super root */
 435 #define NILFS_SS_SYNDT  0x0008  /* includes data only updates */
 436 #define NILFS_SS_GC     0x0010  /* segment written for cleaner operation */
 437
 438 /**
 439  * struct nilfs_btree_node - B-tree node
 440  * @bn_flags: flags
 441  * @bn_level: level
 442  * @bn_nchildren: number of children
 443  * @bn_pad: padding
 444  */
 445 struct nilfs_btree_node {
 446         __u8 bn_flags;
 447         __u8 bn_level;
 448         __le16 bn_nchildren;
 449         __le32 bn_pad;
 450 };
 451
 452 /* flags */
 453 #define NILFS_BTREE_NODE_ROOT   0x01
 454
 455 /* level */
 456 #define NILFS_BTREE_LEVEL_DATA          0
 457 #define NILFS_BTREE_LEVEL_NODE_MIN      (NILFS_BTREE_LEVEL_DATA + 1)
 458 #define NILFS_BTREE_LEVEL_MAX           14      /* Max level (exclusive) */
 459
 460 /**
 461  * struct nilfs_palloc_group_desc - block group descriptor
 462  * @pg_nfrees: number of free entries in block group
 463  */
 464 struct nilfs_palloc_group_desc {
 465         __le32 pg_nfrees;
 466 };
 467
 468 /**
 469  * struct nilfs_dat_entry - disk address translation entry
 470  * @de_blocknr: block number
 471  * @de_start: start checkpoint number
 472  * @de_end: end checkpoint number
 473  * @de_rsv: reserved for future use
 474  */
 475 struct nilfs_dat_entry {
 476         __le64 de_blocknr;
 477         __le64 de_start;
 478         __le64 de_end;
 479         __le64 de_rsv;
 480 };
 481
 482 #define NILFS_MIN_DAT_ENTRY_SIZE        32
 483
 484 /**
 485  * struct nilfs_snapshot_list - snapshot list
 486  * @ssl_next: next checkpoint number on snapshot list
 487  * @ssl_prev: previous checkpoint number on snapshot list
 488  */
 489 struct nilfs_snapshot_list {
 490         __le64 ssl_next;
 491         __le64 ssl_prev;
 492 };
 493
 494 /**
 495  * struct nilfs_checkpoint - checkpoint structure
 496  * @cp_flags: flags
 497  * @cp_checkpoints_count: checkpoints count in a block
 498  * @cp_snapshot_list: snapshot list
 499  * @cp_cno: checkpoint number
 500  * @cp_create: creation timestamp
 501  * @cp_nblk_inc: number of blocks incremented by this checkpoint
 502  * @cp_inodes_count: inodes count
 503  * @cp_blocks_count: blocks count
 504  * @cp_ifile_inode: inode of ifile
 505  */
 506 struct nilfs_checkpoint {
 507         __le32 cp_flags;
 508         __le32 cp_checkpoints_count;
 509         struct nilfs_snapshot_list cp_snapshot_list;
 510         __le64 cp_cno;
 511         __le64 cp_create;
 512         __le64 cp_nblk_inc;
 513         __le64 cp_inodes_count;
 514         __le64 cp_blocks_count;
 515
 516         /* Do not change the byte offset of ifile inode.
 517            To keep the compatibility of the disk format,
 518            additional fields should be added behind cp_ifile_inode. */
 519         struct nilfs_inode cp_ifile_inode;
 520 };
 521
 522 #define NILFS_MIN_CHECKPOINT_SIZE       (64 + NILFS_MIN_INODE_SIZE)
 523
 524 /* checkpoint flags */
 525 enum {
 526         NILFS_CHECKPOINT_SNAPSHOT,
 527         NILFS_CHECKPOINT_INVALID,
 528         NILFS_CHECKPOINT_SKETCH,
 529         NILFS_CHECKPOINT_MINOR,
 530 };
 531
 532 #define NILFS_CHECKPOINT_FNS(flag, name)                                \
 533 static inline void                                                      \
 534 nilfs_checkpoint_set_##name(struct nilfs_checkpoint *cp)                \
 535 {                                                                       \
 536         cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) |          \
 537                                    (1UL << NILFS_CHECKPOINT_##flag));   \
 538 }                                                                       \
 539 static inline void                                                      \
 540 nilfs_checkpoint_clear_##name(struct nilfs_checkpoint *cp)              \
 541 {                                                                       \
 542         cp->cp_flags = cpu_to_le32(le32_to_cpu(cp->cp_flags) &          \
 543                                    ~(1UL << NILFS_CHECKPOINT_##flag));  \
 544 }                                                                       \
 545 static inline int                                                       \
 546 nilfs_checkpoint_##name(const struct nilfs_checkpoint *cp)              \
 547 {                                                                       \
 548         return !!(le32_to_cpu(cp->cp_flags) &                           \
 549                   (1UL << NILFS_CHECKPOINT_##flag));                    \
 550 }
 551
 552 NILFS_CHECKPOINT_FNS(SNAPSHOT, snapshot)
 553 NILFS_CHECKPOINT_FNS(INVALID, invalid)
 554 NILFS_CHECKPOINT_FNS(MINOR, minor)
 555
 556 /**
 557  * struct nilfs_cpinfo - checkpoint information
 558  * @ci_flags: flags
 559  * @ci_pad: padding
 560  * @ci_cno: checkpoint number
 561  * @ci_create: creation timestamp
 562  * @ci_nblk_inc: number of blocks incremented by this checkpoint
 563  * @ci_inodes_count: inodes count
 564  * @ci_blocks_count: blocks count
 565  * @ci_next: next checkpoint number in snapshot list
 566  */
 567 struct nilfs_cpinfo {
 568         __u32 ci_flags;
 569         __u32 ci_pad;
 570         __u64 ci_cno;
 571         __u64 ci_create;
 572         __u64 ci_nblk_inc;
 573         __u64 ci_inodes_count;
 574         __u64 ci_blocks_count;
 575         __u64 ci_next;
 576 };
 577
 578 #define NILFS_CPINFO_FNS(flag, name)                                    \
 579 static inline int                                                       \
 580 nilfs_cpinfo_##name(const struct nilfs_cpinfo *cpinfo)                  \
 581 {                                                                       \
 582         return !!(cpinfo->ci_flags & (1UL << NILFS_CHECKPOINT_##flag)); \
 583 }
 584
 585 NILFS_CPINFO_FNS(SNAPSHOT, snapshot)
 586 NILFS_CPINFO_FNS(INVALID, invalid)
 587 NILFS_CPINFO_FNS(MINOR, minor)
 588
 589
 590 /**
 591  * struct nilfs_cpfile_header - checkpoint file header
 592  * @ch_ncheckpoints: number of checkpoints
 593  * @ch_nsnapshots: number of snapshots
 594  * @ch_snapshot_list: snapshot list
 595  */
 596 struct nilfs_cpfile_header {
 597         __le64 ch_ncheckpoints;
 598         __le64 ch_nsnapshots;
 599         struct nilfs_snapshot_list ch_snapshot_list;
 600 };
 601
 602 #define NILFS_CPFILE_FIRST_CHECKPOINT_OFFSET    \
 603         ((sizeof(struct nilfs_cpfile_header) +                          \
 604           sizeof(struct nilfs_checkpoint) - 1) /                        \
 605                         sizeof(struct nilfs_checkpoint))
 606
 607 /**
 608  * struct nilfs_segment_usage - segment usage
 609  * @su_lastmod: last modified timestamp
 610  * @su_nblocks: number of blocks in segment
 611  * @su_flags: flags
 612  */
 613 struct nilfs_segment_usage {
 614         __le64 su_lastmod;
 615         __le32 su_nblocks;
 616         __le32 su_flags;
 617 };
 618
 619 #define NILFS_MIN_SEGMENT_USAGE_SIZE    16
 620
 621 /* segment usage flag */
 622 enum {
 623         NILFS_SEGMENT_USAGE_ACTIVE,
 624         NILFS_SEGMENT_USAGE_DIRTY,
 625         NILFS_SEGMENT_USAGE_ERROR,
 626
 627         /* ... */
 628 };
 629
 630 #define NILFS_SEGMENT_USAGE_FNS(flag, name)                             \
 631 static inline void                                                      \
 632 nilfs_segment_usage_set_##name(struct nilfs_segment_usage *su)          \
 633 {                                                                       \
 634         su->su_flags = cpu_to_le32(le32_to_cpu(su->su_flags) |          \
 635                                    (1UL << NILFS_SEGMENT_USAGE_##flag));\
 636 }                                                                       \
 637 static inline void                                                      \
 638 nilfs_segment_usage_clear_##name(struct nilfs_segment_usage *su)        \
 639 {                                                                       \
 640         su->su_flags =                                                  \
 641                 cpu_to_le32(le32_to_cpu(su->su_flags) &                 \
 642                             ~(1UL << NILFS_SEGMENT_USAGE_##flag));      \
 643 }                                                                       \
 644 static inline int                                                       \
 645 nilfs_segment_usage_##name(const struct nilfs_segment_usage *su)        \
 646 {                                                                       \
 647         return !!(le32_to_cpu(su->su_flags) &                           \
 648                   (1UL << NILFS_SEGMENT_USAGE_##flag));                 \
 649 }
 650
 651 NILFS_SEGMENT_USAGE_FNS(ACTIVE, active)
 652 NILFS_SEGMENT_USAGE_FNS(DIRTY, dirty)
 653 NILFS_SEGMENT_USAGE_FNS(ERROR, error)
 654
 655 static inline void
 656 nilfs_segment_usage_set_clean(struct nilfs_segment_usage *su)
 657 {
 658         su->su_lastmod = cpu_to_le64(0);
 659         su->su_nblocks = cpu_to_le32(0);
 660         su->su_flags = cpu_to_le32(0);
 661 }
 662
 663 static inline int
 664 nilfs_segment_usage_clean(const struct nilfs_segment_usage *su)
 665 {
 666         return !le32_to_cpu(su->su_flags);
 667 }
 668
 669 /**
 670  * struct nilfs_sufile_header - segment usage file header
 671  * @sh_ncleansegs: number of clean segments
 672  * @sh_ndirtysegs: number of dirty segments
 673  * @sh_last_alloc: last allocated segment number
 674  */
 675 struct nilfs_sufile_header {
 676         __le64 sh_ncleansegs;
 677         __le64 sh_ndirtysegs;
 678         __le64 sh_last_alloc;
 679         /* ... */
 680 };
 681
 682 #define NILFS_SUFILE_FIRST_SEGMENT_USAGE_OFFSET \
 683         ((sizeof(struct nilfs_sufile_header) +                          \
 684           sizeof(struct nilfs_segment_usage) - 1) /                     \
 685                          sizeof(struct nilfs_segment_usage))
 686
 687 /**
 688  * nilfs_suinfo - segment usage information
 689  * @sui_lastmod: timestamp of last modification
 690  * @sui_nblocks: number of written blocks in segment
 691  * @sui_flags: segment usage flags
 692  */
 693 struct nilfs_suinfo {
 694         __u64 sui_lastmod;
 695         __u32 sui_nblocks;
 696         __u32 sui_flags;
 697 };
 698
 699 #define NILFS_SUINFO_FNS(flag, name)                                    \
 700 static inline int                                                       \
 701 nilfs_suinfo_##name(const struct nilfs_suinfo *si)                      \
 702 {                                                                       \
 703         return si->sui_flags & (1UL << NILFS_SEGMENT_USAGE_##flag);     \
 704 }
 705
 706 NILFS_SUINFO_FNS(ACTIVE, active)
 707 NILFS_SUINFO_FNS(DIRTY, dirty)
 708 NILFS_SUINFO_FNS(ERROR, error)
 709
 710 static inline int nilfs_suinfo_clean(const struct nilfs_suinfo *si)
 711 {
 712         return !si->sui_flags;
 713 }
 714
 715 /* ioctl */
 716 /**
 717  * nilfs_suinfo_update - segment usage information update
 718  * @sup_segnum: segment number
 719  * @sup_flags: flags for which fields are active in sup_sui
 720  * @sup_reserved: reserved necessary for alignment
 721  * @sup_sui: segment usage information
 722  */
 723 struct nilfs_suinfo_update {
 724         __u64 sup_segnum;
 725         __u32 sup_flags;
 726         __u32 sup_reserved;
 727         struct nilfs_suinfo sup_sui;
 728 };
 729
 730 enum {
 731         NILFS_SUINFO_UPDATE_LASTMOD,
 732         NILFS_SUINFO_UPDATE_NBLOCKS,
 733         NILFS_SUINFO_UPDATE_FLAGS,
 734         __NR_NILFS_SUINFO_UPDATE_FIELDS,
 735 };
 736
 737 #define NILFS_SUINFO_UPDATE_FNS(flag, name)                             \
 738 static inline void                                                      \
 739 nilfs_suinfo_update_set_##name(struct nilfs_suinfo_update *sup)         \
 740 {                                                                       \
 741         sup->sup_flags |= 1UL << NILFS_SUINFO_UPDATE_##flag;            \
 742 }                                                                       \
 743 static inline void                                                      \
 744 nilfs_suinfo_update_clear_##name(struct nilfs_suinfo_update *sup)       \
 745 {                                                                       \
 746         sup->sup_flags &= ~(1UL << NILFS_SUINFO_UPDATE_##flag);         \
 747 }                                                                       \
 748 static inline int                                                       \
 749 nilfs_suinfo_update_##name(const struct nilfs_suinfo_update *sup)       \
 750 {                                                                       \
 751         return !!(sup->sup_flags & (1UL << NILFS_SUINFO_UPDATE_##flag));\
 752 }
 753
 754 NILFS_SUINFO_UPDATE_FNS(LASTMOD, lastmod)
 755 NILFS_SUINFO_UPDATE_FNS(NBLOCKS, nblocks)
 756 NILFS_SUINFO_UPDATE_FNS(FLAGS, flags)
 757
 758 enum {
 759         NILFS_CHECKPOINT,
 760         NILFS_SNAPSHOT,
 761 };
 762
 763 /**
 764  * struct nilfs_cpmode - change checkpoint mode structure
 765  * @cm_cno: checkpoint number
 766  * @cm_mode: mode of checkpoint
 767  * @cm_pad: padding
 768  */
 769 struct nilfs_cpmode {
 770         __u64 cm_cno;
 771         __u32 cm_mode;
 772         __u32 cm_pad;
 773 };
 774
 775 /**
 776  * struct nilfs_argv - argument vector
 777  * @v_base: pointer on data array from userspace
 778  * @v_nmembs: number of members in data array
 779  * @v_size: size of data array in bytes
 780  * @v_flags: flags
 781  * @v_index: start number of target data items
 782  */
 783 struct nilfs_argv {
 784         __u64 v_base;
 785         __u32 v_nmembs; /* number of members */
 786         __u16 v_size;   /* size of members */
 787         __u16 v_flags;
 788         __u64 v_index;
 789 };
 790
 791 /**
 792  * struct nilfs_period - period of checkpoint numbers
 793  * @p_start: start checkpoint number (inclusive)
 794  * @p_end: end checkpoint number (exclusive)
 795  */
 796 struct nilfs_period {
 797         __u64 p_start;
 798         __u64 p_end;
 799 };
 800
 801 /**
 802  * struct nilfs_cpstat - checkpoint statistics
 803  * @cs_cno: checkpoint number
 804  * @cs_ncps: number of checkpoints
 805  * @cs_nsss: number of snapshots
 806  */
 807 struct nilfs_cpstat {
 808         __u64 cs_cno;
 809         __u64 cs_ncps;
 810         __u64 cs_nsss;
 811 };
 812
 813 /**
 814  * struct nilfs_sustat - segment usage statistics
 815  * @ss_nsegs: number of segments
 816  * @ss_ncleansegs: number of clean segments
 817  * @ss_ndirtysegs: number of dirty segments
 818  * @ss_ctime: creation time of the last segment
 819  * @ss_nongc_ctime: creation time of the last segment not for GC
 820  * @ss_prot_seq: least sequence number of segments which must not be reclaimed
 821  */
 822 struct nilfs_sustat {
 823         __u64 ss_nsegs;
 824         __u64 ss_ncleansegs;
 825         __u64 ss_ndirtysegs;
 826         __u64 ss_ctime;
 827         __u64 ss_nongc_ctime;
 828         __u64 ss_prot_seq;
 829 };
 830
 831 /**
 832  * struct nilfs_vinfo - virtual block number information
 833  * @vi_vblocknr: virtual block number
 834  * @vi_start: start checkpoint number (inclusive)
 835  * @vi_end: end checkpoint number (exclusive)
 836  * @vi_blocknr: disk block number
 837  */
 838 struct nilfs_vinfo {
 839         __u64 vi_vblocknr;
 840         __u64 vi_start;
 841         __u64 vi_end;
 842         __u64 vi_blocknr;
 843 };
 844
 845 /**
 846  * struct nilfs_vdesc - descriptor of virtual block number
 847  * @vd_ino: inode number
 848  * @vd_cno: checkpoint number
 849  * @vd_vblocknr: virtual block number
 850  * @vd_period: period of checkpoint numbers
 851  * @vd_blocknr: disk block number
 852  * @vd_offset: logical block offset inside a file
 853  * @vd_flags: flags (data or node block)
 854  * @vd_pad: padding
 855  */
 856 struct nilfs_vdesc {
 857         __u64 vd_ino;
 858         __u64 vd_cno;
 859         __u64 vd_vblocknr;
 860         struct nilfs_period vd_period;
 861         __u64 vd_blocknr;
 862         __u64 vd_offset;
 863         __u32 vd_flags;
 864         __u32 vd_pad;
 865 };
 866
 867 /**
 868  * struct nilfs_bdesc - descriptor of disk block number
 869  * @bd_ino: inode number
 870  * @bd_oblocknr: disk block address (for skipping dead blocks)
 871  * @bd_blocknr: disk block address
 872  * @bd_offset: logical block offset inside a file
 873  * @bd_level: level in the b-tree organization
 874  * @bd_pad: padding
 875  */
 876 struct nilfs_bdesc {
 877         __u64 bd_ino;
 878         __u64 bd_oblocknr;
 879         __u64 bd_blocknr;
 880         __u64 bd_offset;
 881         __u32 bd_level;
 882         __u32 bd_pad;
 883 };
 884
 885 #define NILFS_IOCTL_IDENT               'n'
 886
 887 #define NILFS_IOCTL_CHANGE_CPMODE  \
 888         _IOW(NILFS_IOCTL_IDENT, 0x80, struct nilfs_cpmode)
 889 #define NILFS_IOCTL_DELETE_CHECKPOINT  \
 890         _IOW(NILFS_IOCTL_IDENT, 0x81, __u64)
 891 #define NILFS_IOCTL_GET_CPINFO  \
 892         _IOR(NILFS_IOCTL_IDENT, 0x82, struct nilfs_argv)
 893 #define NILFS_IOCTL_GET_CPSTAT  \
 894         _IOR(NILFS_IOCTL_IDENT, 0x83, struct nilfs_cpstat)
 895 #define NILFS_IOCTL_GET_SUINFO  \
 896         _IOR(NILFS_IOCTL_IDENT, 0x84, struct nilfs_argv)
 897 #define NILFS_IOCTL_GET_SUSTAT  \
 898         _IOR(NILFS_IOCTL_IDENT, 0x85, struct nilfs_sustat)
 899 #define NILFS_IOCTL_GET_VINFO  \
 900         _IOWR(NILFS_IOCTL_IDENT, 0x86, struct nilfs_argv)
 901 #define NILFS_IOCTL_GET_BDESCS  \
 902         _IOWR(NILFS_IOCTL_IDENT, 0x87, struct nilfs_argv)
 903 #define NILFS_IOCTL_CLEAN_SEGMENTS  \
 904         _IOW(NILFS_IOCTL_IDENT, 0x88, struct nilfs_argv[5])
 905 #define NILFS_IOCTL_SYNC  \
 906         _IOR(NILFS_IOCTL_IDENT, 0x8A, __u64)
 907 #define NILFS_IOCTL_RESIZE  \
 908         _IOW(NILFS_IOCTL_IDENT, 0x8B, __u64)
 909 #define NILFS_IOCTL_SET_ALLOC_RANGE  \
 910         _IOW(NILFS_IOCTL_IDENT, 0x8C, __u64[2])
 911 #define NILFS_IOCTL_SET_SUINFO  \
 912         _IOW(NILFS_IOCTL_IDENT, 0x8D, struct nilfs_argv)
 913
 914 #endif  /* _LINUX_NILFS_FS_H */