LXR linux/include/linux/nilfs2

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