/* SPDX-License-Identifier: GPL-2.0 */
/*
 *  linux/include/linux/ufs_fs.h
 *
 * Copyright (C) 1996
 * Adrian Rodriguez (adrian@franklins-tower.rutgers.edu)
 * Laboratory for Computer Science Research Computing Facility
 * Rutgers, The State University of New Jersey
 *
 * Clean swab support by Fare <fare@tunes.org>
 * just hope no one is using NNUUXXI on __?64 structure elements
 * 64-bit clean thanks to Maciej W. Rozycki <macro@ds2.pg.gda.pl>
 *
 * 4.4BSD (FreeBSD) support added on February 1st 1998 by
 * Niels Kristian Bech Jensen <nkbj@image.dk> partially based
 * on code by Martin von Loewis <martin@mira.isdn.cs.tu-berlin.de>.
 *
 * NeXTstep support added on February 5th 1998 by
 * Niels Kristian Bech Jensen <nkbj@image.dk>.
 *
 * Write support by Daniel Pirkl <daniel.pirkl@email.cz>
 *
 * HP/UX hfs filesystem support added by
 * Martin K. Petersen <mkp@mkp.net>, August 1999
 *
 * UFS2 (of FreeBSD 5.x) support added by
 * Niraj Kumar <niraj17@iitbombay.org>  , Jan 2004
 *
 */

#ifndef __LINUX_UFS_FS_H
#define __LINUX_UFS_FS_H

#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/stat.h>
#include <linux/fs.h>
#include <linux/workqueue.h>

#include <asm/div64.h>
typedef __u64 __bitwise __fs64;
typedef __u32 __bitwise __fs32;
typedef __u16 __bitwise __fs16;

#define UFS_BBLOCK 0
#define UFS_BBSIZE 8192
#define UFS_SBLOCK 8192
#define UFS_SBSIZE 8192

#define UFS_SECTOR_SIZE 512
#define UFS_SECTOR_BITS 9
#define UFS_MAGIC  0x00011954
#define UFS_MAGIC_BW 0x0f242697
#define UFS2_MAGIC 0x19540119
#define UFS_CIGAM  0x54190100 /* byteswapped MAGIC */

/* Copied from FreeBSD */
/*
 * Each disk drive contains some number of filesystems.
 * A filesystem consists of a number of cylinder groups.
 * Each cylinder group has inodes and data.
 *
 * A filesystem is described by its super-block, which in turn
 * describes the cylinder groups.  The super-block is critical
 * data and is replicated in each cylinder group to protect against
 * catastrophic loss.  This is done at `newfs' time and the critical
 * super-block data does not change, so the copies need not be
 * referenced further unless disaster strikes.
 *
 * For filesystem fs, the offsets of the various blocks of interest
 * are given in the super block as:
 *      [fs->fs_sblkno]         Super-block
 *      [fs->fs_cblkno]         Cylinder group block
 *      [fs->fs_iblkno]         Inode blocks
 *      [fs->fs_dblkno]         Data blocks
 * The beginning of cylinder group cg in fs, is given by
 * the ``cgbase(fs, cg)'' macro.
 *
 * Depending on the architecture and the media, the superblock may
 * reside in any one of four places. For tiny media where every block
 * counts, it is placed at the very front of the partition. Historically,
 * UFS1 placed it 8K from the front to leave room for the disk label and
 * a small bootstrap. For UFS2 it got moved to 64K from the front to leave
 * room for the disk label and a bigger bootstrap, and for really piggy
 * systems we check at 256K from the front if the first three fail. In
 * all cases the size of the superblock will be SBLOCKSIZE. All values are
 * given in byte-offset form, so they do not imply a sector size. The
 * SBLOCKSEARCH specifies the order in which the locations should be searched.
 */
#define SBLOCK_FLOPPY        0
#define SBLOCK_UFS1       8192
#define SBLOCK_UFS2      65536
#define SBLOCK_PIGGY    262144
#define SBLOCKSIZE        8192
#define SBLOCKSEARCH \
        { SBLOCK_UFS2, SBLOCK_UFS1, SBLOCK_FLOPPY, SBLOCK_PIGGY, -1 }


/* HP specific MAGIC values */

#define UFS_MAGIC_LFN   0x00095014 /* fs supports filenames > 14 chars */
#define UFS_CIGAM_LFN   0x14500900 /* srahc 41 < semanelif stroppus sf */

#define UFS_MAGIC_SEC   0x00612195 /* B1 security fs */
#define UFS_CIGAM_SEC   0x95216100

#define UFS_MAGIC_FEA   0x00195612 /* fs_featurebits supported */
#define UFS_CIGAM_FEA   0x12561900

#define UFS_MAGIC_4GB   0x05231994 /* fs > 4 GB && fs_featurebits */
#define UFS_CIGAM_4GB   0x94192305

/* Seems somebody at HP goofed here. B1 and lfs are both 0x2 !?! */
#define UFS_FSF_LFN     0x00000001 /* long file names */
#define UFS_FSF_B1      0x00000002 /* B1 security */
#define UFS_FSF_LFS     0x00000002 /* large files */
#define UFS_FSF_LUID    0x00000004 /* large UIDs */

/* End of HP stuff */


#define UFS_BSIZE 8192
#define UFS_MINBSIZE 4096
#define UFS_FSIZE 1024
#define UFS_MAXFRAG (UFS_BSIZE / UFS_FSIZE)

#define UFS_NDADDR 12
#define UFS_NINDIR 3

#define UFS_IND_BLOCK (UFS_NDADDR + 0)
#define UFS_DIND_BLOCK (UFS_NDADDR + 1)
#define UFS_TIND_BLOCK (UFS_NDADDR + 2)

#define UFS_NDIR_FRAGMENT (UFS_NDADDR << uspi->s_fpbshift)
#define UFS_IND_FRAGMENT (UFS_IND_BLOCK << uspi->s_fpbshift)
#define UFS_DIND_FRAGMENT (UFS_DIND_BLOCK << uspi->s_fpbshift)
#define UFS_TIND_FRAGMENT (UFS_TIND_BLOCK << uspi->s_fpbshift)

#define UFS_ROOTINO 2
#define UFS_FIRST_INO (UFS_ROOTINO + 1)

#define UFS_USEEFT  ((__u16)65535)

/* fs_clean values */
#define UFS_FSOK      0x7c269d38
#define UFS_FSACTIVE  ((__s8)0x00)
#define UFS_FSCLEAN   ((__s8)0x01)
#define UFS_FSSTABLE  ((__s8)0x02)
#define UFS_FSOSF1    ((__s8)0x03) /* is this correct for DEC OSF/1? */
#define UFS_FSBAD     ((__s8)0xff)

/* Solaris-specific fs_clean values */
#define UFS_FSSUSPEND ((__s8)0xfe) /* temporarily suspended */
#define UFS_FSLOG     ((__s8)0xfd) /* logging fs */
#define UFS_FSFIX     ((__s8)0xfc) /* being repaired while mounted */

/* From here to next blank line, s_flags for ufs_sb_info */
/* directory entry encoding */
#define UFS_DE_MASK  0x00000010 /* mask for the following */
#define UFS_DE_OLD  0x00000000
#define UFS_DE_44BSD  0x00000010
/* uid encoding */
#define UFS_UID_MASK  0x00000060 /* mask for the following */
#define UFS_UID_OLD  0x00000000
#define UFS_UID_44BSD  0x00000020
#define UFS_UID_EFT  0x00000040
/* superblock state encoding */
#define UFS_ST_MASK  0x00000700 /* mask for the following */
#define UFS_ST_OLD  0x00000000
#define UFS_ST_44BSD  0x00000100
#define UFS_ST_SUN  0x00000200 /* Solaris */
#define UFS_ST_SUNOS  0x00000300
#define UFS_ST_SUNx86  0x00000400 /* Solaris x86 */
/*cylinder group encoding */
#define UFS_CG_MASK  0x00003000 /* mask for the following */
#define UFS_CG_OLD  0x00000000
#define UFS_CG_44BSD  0x00002000
#define UFS_CG_SUN  0x00001000
/* filesystem type encoding */
#define UFS_TYPE_MASK  0x00010000 /* mask for the following */
#define UFS_TYPE_UFS1  0x00000000
#define UFS_TYPE_UFS2  0x00010000


/* fs_inodefmt options */
#define UFS_42INODEFMT -1
#define UFS_44INODEFMT 2

/*
 * MINFREE gives the minimum acceptable percentage of file system
 * blocks which may be free. If the freelist drops below this level
 * only the superuser may continue to allocate blocks. This may
 * be set to 0 if no reserve of free blocks is deemed necessary,
 * however throughput drops by fifty percent if the file system
 * is run at between 95% and 100% full; thus the minimum default
 * value of fs_minfree is 5%. However, to get good clustering
 * performance, 10% is a better choice. hence we use 10% as our
 * default value. With 10% free space, fragmentation is not a
 * problem, so we choose to optimize for time.
 */
#define UFS_MINFREE         5
#define UFS_DEFAULTOPT      UFS_OPTTIME

/*
 * Turn file system block numbers into disk block addresses.
 * This maps file system blocks to device size blocks.
 */
#define ufs_fsbtodb(uspi, b) ((b) << (uspi)->s_fsbtodb)
#define ufs_dbtofsb(uspi, b) ((b) >> (uspi)->s_fsbtodb)

/*
 * Cylinder group macros to locate things in cylinder groups.
 * They calc file system addresses of cylinder group data structures.
 */
#define ufs_cgbase(c) (uspi->s_fpg * (c))
#define ufs_cgstart(c) ((uspi)->fs_magic == UFS2_MAGIC ?  ufs_cgbase(c) : \
 (ufs_cgbase(c)  + uspi->s_cgoffset * ((c) & ~uspi->s_cgmask)))
#define ufs_cgsblock(c) (ufs_cgstart(c) + uspi->s_sblkno) /* super blk */
#define ufs_cgcmin(c) (ufs_cgstart(c) + uspi->s_cblkno) /* cg block */
#define ufs_cgimin(c) (ufs_cgstart(c) + uspi->s_iblkno) /* inode blk */
#define ufs_cgdmin(c) (ufs_cgstart(c) + uspi->s_dblkno) /* 1st data */

/*
 * Macros for handling inode numbers:
 *     inode number to file system block offset.
 *     inode number to cylinder group number.
 *     inode number to file system block address.
 */
#define ufs_inotocg(x)  ((x) / uspi->s_ipg)
#define ufs_inotocgoff(x) ((x) % uspi->s_ipg)
#define ufs_inotofsba(x) (((u64)ufs_cgimin(ufs_inotocg(x))) + ufs_inotocgoff(x) / uspi->s_inopf)
#define ufs_inotofsbo(x) ((x) % uspi->s_inopf)

/*
 * Compute the cylinder and rotational position of a cyl block addr.
 */
#define ufs_cbtocylno(bno) \
 ((bno) * uspi->s_nspf / uspi->s_spc)
#define ufs_cbtorpos(bno)          \
 ((UFS_SB(sb)->s_flags & UFS_CG_SUN) ?        \
  (((((bno) * uspi->s_nspf % uspi->s_spc) %       \
     uspi->s_nsect) *          \
    uspi->s_nrpos) / uspi->s_nsect)        \
  :            \
 ((((bno) * uspi->s_nspf % uspi->s_spc / uspi->s_nsect \
 * uspi->s_trackskew + (bno) * uspi->s_nspf % uspi->s_spc \
 % uspi->s_nsect * uspi->s_interleave) % uspi->s_nsect \
   * uspi->s_nrpos) / uspi->s_npsect))

/*
 * The following macros optimize certain frequently calculated
 * quantities by using shifts and masks in place of divisions
 * modulos and multiplications.
 */
#define ufs_blkoff(loc)  ((loc) & uspi->s_qbmask)
#define ufs_fragoff(loc) ((loc) & uspi->s_qfmask)
#define ufs_lblktosize(blk) ((blk) << uspi->s_bshift)
#define ufs_lblkno(loc)  ((loc) >> uspi->s_bshift)
#define ufs_numfrags(loc) ((loc) >> uspi->s_fshift)
#define ufs_blkroundup(size) (((size) + uspi->s_qbmask) & uspi->s_bmask)
#define ufs_fragroundup(size) (((size) + uspi->s_qfmask) & uspi->s_fmask)
#define ufs_fragstoblks(frags) ((frags) >> uspi->s_fpbshift)
#define ufs_blkstofrags(blks) ((blks) << uspi->s_fpbshift)
#define ufs_fragnum(fsb) ((fsb) & uspi->s_fpbmask)
#define ufs_blknum(fsb)  ((fsb) & ~uspi->s_fpbmask)

#define UFS_MAXNAMLEN 255
#define UFS_MAXMNTLEN 512
#define UFS2_MAXMNTLEN 468
#define UFS2_MAXVOLLEN 32
#define UFS_MAXCSBUFS 31
#define UFS_LINK_MAX 32000
/*
#define UFS2_NOCSPTRS ((128 / sizeof(void *)) - 4)
*/
#define UFS2_NOCSPTRS 28

/*
 * UFS_DIR_PAD defines the directory entries boundaries
 * (must be a multiple of 4)
 */
#define UFS_DIR_PAD   4
#define UFS_DIR_ROUND   (UFS_DIR_PAD - 1)
#define UFS_DIR_REC_LEN(name_len) (((name_len) + 1 + 8 + UFS_DIR_ROUND) & ~UFS_DIR_ROUND)

struct ufs_timeval {
 __fs32 tv_sec;
 __fs32 tv_usec;
};

struct ufs_dir_entry {
 __fs32  d_ino;   /* inode number of this entry */
 __fs16  d_reclen;  /* length of this entry */
 union {
  __fs16 d_namlen;  /* actual length of d_name */
  struct {
   __u8 d_type;  /* file type */
   __u8 d_namlen; /* length of string in d_name */
  } d_44;
 } d_u;
 __u8 d_name[UFS_MAXNAMLEN + 1]; /* file name */
};

struct ufs_csum {
 __fs32 cs_ndir; /* number of directories */
 __fs32 cs_nbfree; /* number of free blocks */
 __fs32 cs_nifree; /* number of free inodes */
 __fs32 cs_nffree; /* number of free frags */
};
struct ufs2_csum_total {
 __fs64 cs_ndir; /* number of directories */
 __fs64 cs_nbfree; /* number of free blocks */
 __fs64 cs_nifree; /* number of free inodes */
 __fs64 cs_nffree; /* number of free frags */
 __fs64   cs_numclusters; /* number of free clusters */
 __fs64   cs_spare[3]; /* future expansion */
};

struct ufs_csum_core {
 __u64 cs_ndir; /* number of directories */
 __u64 cs_nbfree; /* number of free blocks */
 __u64 cs_nifree; /* number of free inodes */
 __u64 cs_nffree; /* number of free frags */
 __u64   cs_numclusters; /* number of free clusters */
};

/*
 * File system flags
 */
#define UFS_UNCLEAN      0x01    /* file system not clean at mount (unused) */
#define UFS_DOSOFTDEP    0x02    /* file system using soft dependencies */
#define UFS_NEEDSFSCK    0x04    /* needs sync fsck (FreeBSD compat, unused) */
#define UFS_INDEXDIRS    0x08    /* kernel supports indexed directories */
#define UFS_ACLS         0x10    /* file system has ACLs enabled */
#define UFS_MULTILABEL   0x20    /* file system is MAC multi-label */
#define UFS_FLAGS_UPDATED 0x80   /* flags have been moved to new location */

#if 0
/*
 * This is the actual superblock, as it is laid out on the disk.
 * Do NOT use this structure, because of sizeof(ufs_super_block) > 512 and
 * it may occupy several blocks, use
 * struct ufs_super_block_(first,second,third) instead.
 */
struct ufs_super_block {
 union {
  struct {
   __fs32 fs_link; /* UNUSED */
  } fs_42;
  struct {
   __fs32 fs_state; /* file system state flag */
  } fs_sun;
 } fs_u0;
 __fs32 fs_rlink; /* UNUSED */
 __fs32 fs_sblkno; /* addr of super-block in filesys */
 __fs32 fs_cblkno; /* offset of cyl-block in filesys */
 __fs32 fs_iblkno; /* offset of inode-blocks in filesys */
 __fs32 fs_dblkno; /* offset of first data after cg */
 __fs32 fs_cgoffset; /* cylinder group offset in cylinder */
 __fs32 fs_cgmask; /* used to calc mod fs_ntrak */
 __fs32 fs_time; /* last time written -- time_t */
 __fs32 fs_size; /* number of blocks in fs */
 __fs32 fs_dsize; /* number of data blocks in fs */
 __fs32 fs_ncg;  /* number of cylinder groups */
 __fs32 fs_bsize; /* size of basic blocks in fs */
 __fs32 fs_fsize; /* size of frag blocks in fs */
 __fs32 fs_frag; /* number of frags in a block in fs */
/* these are configuration parameters */
 __fs32 fs_minfree; /* minimum percentage of free blocks */
 __fs32 fs_rotdelay; /* num of ms for optimal next block */
 __fs32 fs_rps;  /* disk revolutions per second */
/* these fields can be computed from the others */
 __fs32 fs_bmask; /* ``blkoff'' calc of blk offsets */
 __fs32 fs_fmask; /* ``fragoff'' calc of frag offsets */
 __fs32 fs_bshift; /* ``lblkno'' calc of logical blkno */
 __fs32 fs_fshift; /* ``numfrags'' calc number of frags */
/* these are configuration parameters */
 __fs32 fs_maxcontig; /* max number of contiguous blks */
 __fs32 fs_maxbpg; /* max number of blks per cyl group */
/* these fields can be computed from the others */
 __fs32 fs_fragshift; /* block to frag shift */
 __fs32 fs_fsbtodb; /* fsbtodb and dbtofsb shift constant */
 __fs32 fs_sbsize; /* actual size of super block */
 __fs32 fs_csmask; /* csum block offset */
 __fs32 fs_csshift; /* csum block number */
 __fs32 fs_nindir; /* value of NINDIR */
 __fs32 fs_inopb; /* value of INOPB */
 __fs32 fs_nspf; /* value of NSPF */
/* yet another configuration parameter */
 __fs32 fs_optim; /* optimization preference, see below */
/* these fields are derived from the hardware */
 union {
  struct {
   __fs32 fs_npsect; /* # sectors/track including spares */
  } fs_sun;
  struct {
   __fs32 fs_state; /* file system state time stamp */
  } fs_sunx86;
 } fs_u1;
 __fs32 fs_interleave; /* hardware sector interleave */
 __fs32 fs_trackskew; /* sector 0 skew, per track */
/* a unique id for this filesystem (currently unused and unmaintained) */
/* In 4.3 Tahoe this space is used by fs_headswitch and fs_trkseek */
/* Neither of those fields is used in the Tahoe code right now but */
/* there could be problems if they are.                            */
 __fs32 fs_id[2]; /* file system id */
/* sizes determined by number of cylinder groups and their sizes */
 __fs32 fs_csaddr; /* blk addr of cyl grp summary area */
 __fs32 fs_cssize; /* size of cyl grp summary area */
 __fs32 fs_cgsize; /* cylinder group size */
/* these fields are derived from the hardware */
 __fs32 fs_ntrak; /* tracks per cylinder */
 __fs32 fs_nsect; /* sectors per track */
 __fs32 fs_spc;  /* sectors per cylinder */
/* this comes from the disk driver partitioning */
 __fs32 fs_ncyl; /* cylinders in file system */
/* these fields can be computed from the others */
 __fs32 fs_cpg;  /* cylinders per group */
 __fs32 fs_ipg;  /* inodes per cylinder group */
 __fs32 fs_fpg;  /* blocks per group * fs_frag */
/* this data must be re-computed after crashes */
 struct ufs_csum fs_cstotal; /* cylinder summary information */
/* these fields are cleared at mount time */
 __s8 fs_fmod; /* super block modified flag */
 __s8 fs_clean; /* file system is clean flag */
 __s8 fs_ronly; /* mounted read-only flag */
 __s8 fs_flags;
 union {
  struct {
   __s8 fs_fsmnt[UFS_MAXMNTLEN];/* name mounted on */
   __fs32 fs_cgrotor; /* last cg searched */
   __fs32 fs_csp[UFS_MAXCSBUFS];/*list of fs_cs info buffers */
   __fs32 fs_maxcluster;
   __fs32 fs_cpc;  /* cyl per cycle in postbl */
   __fs16 fs_opostbl[16][8]; /* old rotation block list head */
  } fs_u1;
  struct {
   __s8  fs_fsmnt[UFS2_MAXMNTLEN]; /* name mounted on */
   __u8   fs_volname[UFS2_MAXVOLLEN]; /* volume name */
   __fs64  fs_swuid;  /* system-wide uid */
   __fs32  fs_pad; /* due to alignment of fs_swuid */
   __fs32   fs_cgrotor;     /* last cg searched */
   __fs32   fs_ocsp[UFS2_NOCSPTRS]; /*list of fs_cs info buffers */
   __fs32   fs_contigdirs;/*# of contiguously allocated dirs */
   __fs32   fs_csp; /* cg summary info buffer for fs_cs */
   __fs32   fs_maxcluster;
   __fs32   fs_active;/* used by snapshots to track fs */
   __fs32   fs_old_cpc; /* cyl per cycle in postbl */
   __fs32   fs_maxbsize;/*maximum blocking factor permitted */
   __fs64   fs_sparecon64[17];/*old rotation block list head */
   __fs64   fs_sblockloc; /* byte offset of standard superblock */
   struct  ufs2_csum_total fs_cstotal;/*cylinder summary information*/
   struct  ufs_timeval    fs_time;  /* last time written */
   __fs64    fs_size;  /* number of blocks in fs */
   __fs64    fs_dsize; /* number of data blocks in fs */
   __fs64   fs_csaddr; /* blk addr of cyl grp summary area */
   __fs64    fs_pendingblocks;/* blocks in process of being freed */
   __fs32    fs_pendinginodes;/*inodes in process of being freed */
  } fs_u2;
 }  fs_u11;
 union {
  struct {
   __fs32 fs_sparecon[53];/* reserved for future constants */
   __fs32 fs_reclaim;
   __fs32 fs_sparecon2[1];
   __fs32 fs_state; /* file system state time stamp */
   __fs32 fs_qbmask[2]; /* ~usb_bmask */
   __fs32 fs_qfmask[2]; /* ~usb_fmask */
  } fs_sun;
  struct {
   __fs32 fs_sparecon[53];/* reserved for future constants */
   __fs32 fs_reclaim;
   __fs32 fs_sparecon2[1];
   __fs32 fs_npsect; /* # sectors/track including spares */
   __fs32 fs_qbmask[2]; /* ~usb_bmask */
   __fs32 fs_qfmask[2]; /* ~usb_fmask */
  } fs_sunx86;
  struct {
   __fs32 fs_sparecon[50];/* reserved for future constants */
   __fs32 fs_contigsumsize;/* size of cluster summary array */
   __fs32 fs_maxsymlinklen;/* max length of an internal symlink */
   __fs32 fs_inodefmt; /* format of on-disk inodes */
   __fs32 fs_maxfilesize[2]; /* max representable file size */
   __fs32 fs_qbmask[2]; /* ~usb_bmask */
   __fs32 fs_qfmask[2]; /* ~usb_fmask */
   __fs32 fs_state; /* file system state time stamp */
  } fs_44;
 } fs_u2;
 __fs32 fs_postblformat; /* format of positional layout tables */
 __fs32 fs_nrpos;  /* number of rotational positions */
 __fs32 fs_postbloff;  /* (__s16) rotation block list head */
 __fs32 fs_rotbloff;  /* (__u8) blocks for each rotation */
 __fs32 fs_magic;  /* magic number */
 __u8 fs_space[1];  /* list of blocks for each rotation */
};
#endif/*struct ufs_super_block*/

/*
 * Preference for optimization.
 */
#define UFS_OPTTIME 0 /* minimize allocation time */
#define UFS_OPTSPACE 1 /* minimize disk fragmentation */

/*
 * Rotational layout table format types
 */
#define UFS_42POSTBLFMT  -1 /* 4.2BSD rotational table format */
#define UFS_DYNAMICPOSTBLFMT 1 /* dynamic rotational table format */

/*
 * Convert cylinder group to base address of its global summary info.
 */
#define fs_cs(indx) s_csp[(indx)]

/*
 * Cylinder group block for a file system.
 *
 * Writable fields in the cylinder group are protected by the associated
 * super block lock fs->fs_lock.
 */
#define CG_MAGIC 0x090255
#define ufs_cg_chkmagic(sb, ucg) \
 (fs32_to_cpu((sb), (ucg)->cg_magic) == CG_MAGIC)
/*
 * Macros for access to old cylinder group array structures
 */
#define ufs_ocg_blktot(sb, ucg)      fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_btot)
#define ufs_ocg_blks(sb, ucg, cylno) fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_b[cylno])
#define ufs_ocg_inosused(sb, ucg)    fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_iused)
#define ufs_ocg_blksfree(sb, ucg)    fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_free)
#define ufs_ocg_chkmagic(sb, ucg) \
 (fs32_to_cpu((sb), ((struct ufs_old_cylinder_group *)(ucg))->cg_magic) == CG_MAGIC)

/*
 * size of this structure is 172 B
 */
struct ufs_cylinder_group {
 __fs32 cg_link;  /* linked list of cyl groups */
 __fs32 cg_magic;  /* magic number */
 __fs32 cg_time;  /* time last written */
 __fs32 cg_cgx;   /* we are the cgx'th cylinder group */
 __fs16 cg_ncyl;  /* number of cyl's this cg */
 __fs16 cg_niblk;  /* number of inode blocks this cg */
 __fs32 cg_ndblk;  /* number of data blocks this cg */
 struct ufs_csum cg_cs;  /* cylinder summary information */
 __fs32 cg_rotor;  /* position of last used block */
 __fs32 cg_frotor;  /* position of last used frag */
 __fs32 cg_irotor;  /* position of last used inode */
 __fs32 cg_frsum[UFS_MAXFRAG]; /* counts of available frags */
 __fs32 cg_btotoff;  /* (__u32) block totals per cylinder */
 __fs32 cg_boff;  /* (short) free block positions */
 __fs32 cg_iusedoff;  /* (char) used inode map */
 __fs32 cg_freeoff;  /* (u_char) free block map */
 __fs32 cg_nextfreeoff;  /* (u_char) next available space */
 union {
  struct {
   __fs32 cg_clustersumoff; /* (u_int32) counts of avail clusters */
   __fs32 cg_clusteroff;  /* (u_int8) free cluster map */
   __fs32 cg_nclusterblks; /* number of clusters this cg */
   __fs32 cg_sparecon[13]; /* reserved for future use */
  } cg_44;
  struct {
   __fs32 cg_clustersumoff;/* (u_int32) counts of avail clusters */
   __fs32 cg_clusteroff; /* (u_int8) free cluster map */
   __fs32 cg_nclusterblks;/* number of clusters this cg */
   __fs32   cg_niblk; /* number of inode blocks this cg */
   __fs32   cg_initediblk; /* last initialized inode */
   __fs32   cg_sparecon32[3];/* reserved for future use */
   __fs64   cg_time; /* time last written */
   __fs64 cg_sparecon[3]; /* reserved for future use */
  } cg_u2;
  __fs32 cg_sparecon[16]; /* reserved for future use */
 } cg_u;
 __u8 cg_space[1];  /* space for cylinder group maps */
/* actually longer */
};

/* Historic Cylinder group info */
struct ufs_old_cylinder_group {
 __fs32 cg_link;  /* linked list of cyl groups */
 __fs32 cg_rlink;  /* for incore cyl groups     */
 __fs32 cg_time;  /* time last written */
 __fs32 cg_cgx;   /* we are the cgx'th cylinder group */
 __fs16 cg_ncyl;  /* number of cyl's this cg */
 __fs16 cg_niblk;  /* number of inode blocks this cg */
 __fs32 cg_ndblk;  /* number of data blocks this cg */
 struct ufs_csum cg_cs;  /* cylinder summary information */
 __fs32 cg_rotor;  /* position of last used block */
 __fs32 cg_frotor;  /* position of last used frag */
 __fs32 cg_irotor;  /* position of last used inode */
 __fs32 cg_frsum[8];  /* counts of available frags */
 __fs32 cg_btot[32];  /* block totals per cylinder */
 __fs16 cg_b[32][8];  /* positions of free blocks */
 __u8 cg_iused[256];  /* used inode map */
 __fs32 cg_magic;  /* magic number */
 __u8 cg_free[1];  /* free block map */
/* actually longer */
};

/*
 * structure of an on-disk inode
 */
struct ufs_inode {
 __fs16 ui_mode;  /*  0x0 */
 __fs16 ui_nlink;  /*  0x2 */
 union {
  struct {
   __fs16 ui_suid; /*  0x4 */
   __fs16 ui_sgid; /*  0x6 */
  } oldids;
  __fs32 ui_inumber;  /*  0x4 lsf: inode number */
  __fs32 ui_author;  /*  0x4 GNU HURD: author */
 } ui_u1;
 __fs64 ui_size;  /*  0x8 */
 struct ufs_timeval ui_atime; /* 0x10 access */
 struct ufs_timeval ui_mtime; /* 0x18 modification */
 struct ufs_timeval ui_ctime; /* 0x20 creation */
 union {
  struct {
   __fs32 ui_db[UFS_NDADDR];/* 0x28 data blocks */
   __fs32 ui_ib[UFS_NINDIR];/* 0x58 indirect blocks */
  } ui_addr;
  __u8 ui_symlink[4*(UFS_NDADDR+UFS_NINDIR)];/* 0x28 fast symlink */
 } ui_u2;
 __fs32 ui_flags;  /* 0x64 immutable, append-only... */
 __fs32 ui_blocks;  /* 0x68 blocks in use */
 __fs32 ui_gen;   /* 0x6c like ext2 i_version, for NFS support */
 union {
  struct {
   __fs32 ui_shadow; /* 0x70 shadow inode with security data */
   __fs32 ui_uid;  /* 0x74 long EFT version of uid */
   __fs32 ui_gid;  /* 0x78 long EFT version of gid */
   __fs32 ui_oeftflag; /* 0x7c reserved */
  } ui_sun;
  struct {
   __fs32 ui_uid;  /* 0x70 File owner */
   __fs32 ui_gid;  /* 0x74 File group */
   __fs32 ui_spare[2]; /* 0x78 reserved */
  } ui_44;
  struct {
   __fs32 ui_uid;  /* 0x70 */
   __fs32 ui_gid;  /* 0x74 */
   __fs16 ui_modeh; /* 0x78 mode high bits */
   __fs16 ui_spare; /* 0x7A unused */
   __fs32 ui_trans; /* 0x7c filesystem translator */
  } ui_hurd;
 } ui_u3;
};

#define UFS_NXADDR  2            /* External addresses in inode. */
struct ufs2_inode {
 __fs16     ui_mode;        /*   0: IFMT, permissions; see below. */
 __fs16     ui_nlink;       /*   2: File link count. */
 __fs32     ui_uid;         /*   4: File owner. */
 __fs32     ui_gid;         /*   8: File group. */
 __fs32     ui_blksize;     /*  12: Inode blocksize. */
 __fs64     ui_size;        /*  16: File byte count. */
 __fs64     ui_blocks;      /*  24: Bytes actually held. */
 __fs64   ui_atime;       /*  32: Last access time. */
 __fs64   ui_mtime;       /*  40: Last modified time. */
 __fs64   ui_ctime;       /*  48: Last inode change time. */
 __fs64   ui_birthtime;   /*  56: Inode creation time. */
 __fs32     ui_mtimensec;   /*  64: Last modified time. */
 __fs32     ui_atimensec;   /*  68: Last access time. */
 __fs32     ui_ctimensec;   /*  72: Last inode change time. */
 __fs32     ui_birthnsec;   /*  76: Inode creation time. */
 __fs32     ui_gen;         /*  80: Generation number. */
 __fs32     ui_kernflags;   /*  84: Kernel flags. */
 __fs32     ui_flags;       /*  88: Status flags (chflags). */
 __fs32     ui_extsize;     /*  92: External attributes block. */
 __fs64     ui_extb[UFS_NXADDR];/*  96: External attributes block. */
 union {
  struct {
   __fs64     ui_db[UFS_NDADDR]; /* 112: Direct disk blocks. */
   __fs64     ui_ib[UFS_NINDIR];/* 208: Indirect disk blocks.*/
  } ui_addr;
 __u8 ui_symlink[2*4*(UFS_NDADDR+UFS_NINDIR)];/* 0x28 fast symlink */
 } ui_u2;
 __fs64     ui_spare[3];    /* 232: Reserved; currently unused */
};


/* FreeBSD has these in sys/stat.h */
/* ui_flags that can be set by a file owner */
#define UFS_UF_SETTABLE   0x0000ffff
#define UFS_UF_NODUMP     0x00000001  /* do not dump */
#define UFS_UF_IMMUTABLE  0x00000002  /* immutable (can't "change") */
#define UFS_UF_APPEND     0x00000004  /* append-only */
#define UFS_UF_OPAQUE     0x00000008  /* directory is opaque (unionfs) */
#define UFS_UF_NOUNLINK   0x00000010  /* can't be removed or renamed */
/* ui_flags that only root can set */
#define UFS_SF_SETTABLE   0xffff0000
#define UFS_SF_ARCHIVED   0x00010000  /* archived */
#define UFS_SF_IMMUTABLE  0x00020000  /* immutable (can't "change") */
#define UFS_SF_APPEND     0x00040000  /* append-only */
#define UFS_SF_NOUNLINK   0x00100000  /* can't be removed or renamed */

/*
 * This structure is used for reading disk structures larger
 * than the size of fragment.
 */
struct ufs_buffer_head {
 __u64 fragment;   /* first fragment */
 __u64 count;    /* number of fragments */
 struct buffer_head * bh[UFS_MAXFRAG]; /* buffers */
};

struct ufs_cg_private_info {
 struct ufs_buffer_head c_ubh;
 __u32 c_cgx;  /* number of cylidner group */
 __u16 c_ncyl;  /* number of cyl's this cg */
 __u16 c_niblk; /* number of inode blocks this cg */
 __u32 c_ndblk; /* number of data blocks this cg */
 __u32 c_rotor; /* position of last used block */
 __u32 c_frotor; /* position of last used frag */
 __u32 c_irotor; /* position of last used inode */
 __u32 c_btotoff; /* (__u32) block totals per cylinder */
 __u32 c_boff;  /* (short) free block positions */
 __u32 c_iusedoff; /* (char) used inode map */
 __u32 c_freeoff; /* (u_char) free block map */
 __u32 c_nextfreeoff; /* (u_char) next available space */
 __u32 c_clustersumoff;/* (u_int32) counts of avail clusters */
 __u32 c_clusteroff; /* (u_int8) free cluster map */
 __u32 c_nclusterblks; /* number of clusters this cg */
};


struct ufs_sb_private_info {
 struct ufs_buffer_head s_ubh; /* buffer containing super block */
 struct ufs_csum_core cs_total;
 __u32 s_sblkno; /* offset of super-blocks in filesys */
 __u32 s_cblkno; /* offset of cg-block in filesys */
 __u32 s_iblkno; /* offset of inode-blocks in filesys */
 __u32 s_dblkno; /* offset of first data after cg */
 __u32 s_cgoffset; /* cylinder group offset in cylinder */
 __u32 s_cgmask; /* used to calc mod fs_ntrak */
 __u64 s_size;  /* number of blocks (fragments) in fs */
 __u64 s_dsize; /* number of data blocks in fs */
 __u32 s_ncg;  /* number of cylinder groups */
 __u32 s_bsize; /* size of basic blocks */
 __u32 s_fsize; /* size of fragments */
 __u32 s_fpb;  /* fragments per block */
 __u32 s_minfree; /* minimum percentage of free blocks */
 __u32 s_bmask; /* `blkoff'' calc of blk offsets */
 __u32 s_fmask; /* s_fsize mask */
 __u32 s_bshift; /* `lblkno'' calc of logical blkno */
 __u32   s_fshift; /* s_fsize shift */
 __u32 s_fpbshift; /* fragments per block shift */
 __u32 s_fsbtodb; /* fsbtodb and dbtofsb shift constant */
 __u32 s_sbsize; /* actual size of super block */
 __u32   s_csmask; /* csum block offset */
 __u32 s_csshift; /* csum block number */
 __u32 s_nindir; /* value of NINDIR */
 __u32 s_inopb; /* value of INOPB */
 __u32 s_nspf;  /* value of NSPF */
 __u32 s_npsect; /* # sectors/track including spares */
 __u32 s_interleave; /* hardware sector interleave */
 __u32 s_trackskew; /* sector 0 skew, per track */
 __u64 s_csaddr; /* blk addr of cyl grp summary area */
 __u32 s_cssize; /* size of cyl grp summary area */
 __u32 s_cgsize; /* cylinder group size */
 __u32 s_ntrak; /* tracks per cylinder */
 __u32 s_nsect; /* sectors per track */
 __u32 s_spc;  /* sectors per cylinder */
 __u32 s_ipg;  /* inodes per cylinder group */
 __u32 s_fpg;  /* fragments per group */
 __u32 s_cpc;  /* cyl per cycle in postbl */
 __s32 s_contigsumsize;/* size of cluster summary array, 44bsd */
 __s64 s_qbmask; /* ~usb_bmask */
 __s64 s_qfmask; /* ~usb_fmask */
 __s32 s_postblformat; /* format of positional layout tables */
 __s32 s_nrpos; /* number of rotational positions */
        __s32 s_postbloff; /* (__s16) rotation block list head */
 __s32 s_rotbloff; /* (__u8) blocks for each rotation */

 __u32 s_fpbmask; /* fragments per block mask */
 __u32 s_apb;  /* address per block */
 __u32 s_apbmask; /* address per block mask */
 __u32 s_apbshift; /* address per block shift */
 __u32 s_nspfshift; /* number of sector per fragment shift */
 __u32 s_nspb;  /* number of sector per block */
 __u32 s_inopf; /* inodes per fragment */
 __u32 s_sbbase; /* offset of NeXTstep superblock */
 __u32 s_bpf;  /* bits per fragment */
 __u32 s_bpfshift; /* bits per fragment shift*/
 __u32 s_bpfmask; /* bits per fragment mask */

 __u32 s_maxsymlinklen;/* upper limit on fast symlinks' size */
 __s32 fs_magic;       /* filesystem magic */
 unsigned int s_dirblksize;
 __u64   s_root_blocks;
 __u64 s_time_to_space;
 __u64 s_space_to_time;
};

/*
 * Sizes of this structures are:
 * ufs_super_block_first 512
 * ufs_super_block_second 512
 * ufs_super_block_third 356
 */
struct ufs_super_block_first {
 union {
  struct {
   __fs32 fs_link; /* UNUSED */
  } fs_42;
  struct {
   __fs32 fs_state; /* file system state flag */
  } fs_sun;
 } fs_u0;
 __fs32 fs_rlink;
 __fs32 fs_sblkno;
 __fs32 fs_cblkno;
 __fs32 fs_iblkno;
 __fs32 fs_dblkno;
 __fs32 fs_cgoffset;
 __fs32 fs_cgmask;
 __fs32 fs_time;
 __fs32 fs_size;
 __fs32 fs_dsize;
 __fs32 fs_ncg;
 __fs32 fs_bsize;
 __fs32 fs_fsize;
 __fs32 fs_frag;
 __fs32 fs_minfree;
 __fs32 fs_rotdelay;
 __fs32 fs_rps;
 __fs32 fs_bmask;
 __fs32 fs_fmask;
 __fs32 fs_bshift;
 __fs32 fs_fshift;
 __fs32 fs_maxcontig;
 __fs32 fs_maxbpg;
 __fs32 fs_fragshift;
 __fs32 fs_fsbtodb;
 __fs32 fs_sbsize;
 __fs32 fs_csmask;
 __fs32 fs_csshift;
 __fs32 fs_nindir;
 __fs32 fs_inopb;
 __fs32 fs_nspf;
 __fs32 fs_optim;
 union {
  struct {
   __fs32 fs_npsect;
  } fs_sun;
  struct {
   __fs32 fs_state;
  } fs_sunx86;
 } fs_u1;
 __fs32 fs_interleave;
 __fs32 fs_trackskew;
 __fs32 fs_id[2];
 __fs32 fs_csaddr;
 __fs32 fs_cssize;
 __fs32 fs_cgsize;
 __fs32 fs_ntrak;
 __fs32 fs_nsect;
 __fs32 fs_spc;
 __fs32 fs_ncyl;
 __fs32 fs_cpg;
 __fs32 fs_ipg;
 __fs32 fs_fpg;
 struct ufs_csum fs_cstotal;
 __s8 fs_fmod;
 __s8 fs_clean;
 __s8 fs_ronly;
 __s8 fs_flags;
 __s8 fs_fsmnt[UFS_MAXMNTLEN - 212];

};

struct ufs_super_block_second {
 union {
  struct {
   __s8 fs_fsmnt[212];
   __fs32 fs_cgrotor;
   __fs32 fs_csp[UFS_MAXCSBUFS];
   __fs32 fs_maxcluster;
   __fs32 fs_cpc;
   __fs16 fs_opostbl[82];
  } fs_u1;
  struct {
   __s8  fs_fsmnt[UFS2_MAXMNTLEN - UFS_MAXMNTLEN + 212];
   __u8   fs_volname[UFS2_MAXVOLLEN];
   __fs64  fs_swuid;
   __fs32  fs_pad;
   __fs32   fs_cgrotor;
   __fs32   fs_ocsp[UFS2_NOCSPTRS];
   __fs32   fs_contigdirs;
   __fs32   fs_csp;
   __fs32   fs_maxcluster;
   __fs32   fs_active;
   __fs32   fs_old_cpc;
   __fs32   fs_maxbsize;
   __fs64   fs_sparecon64[17];
   __fs64   fs_sblockloc;
   __fs64 cs_ndir;
   __fs64 cs_nbfree;
  } fs_u2;
 } fs_un;
};

struct ufs_super_block_third {
 union {
  struct {
   __fs16 fs_opostbl[46];
  } fs_u1;
  struct {
   __fs64 cs_nifree; /* number of free inodes */
   __fs64 cs_nffree; /* number of free frags */
   __fs64   cs_numclusters; /* number of free clusters */
   __fs64   cs_spare[3]; /* future expansion */
   struct  ufs_timeval    fs_time;  /* last time written */
   __fs64    fs_size;  /* number of blocks in fs */
   __fs64    fs_dsize; /* number of data blocks in fs */
   __fs64   fs_csaddr; /* blk addr of cyl grp summary area */
   __fs64    fs_pendingblocks;/* blocks in process of being freed */
   __fs32    fs_pendinginodes;/*inodes in process of being freed */
  } __attribute__ ((packed)) fs_u2;
 } fs_un1;
 union {
  struct {
   __fs32 fs_sparecon[53];/* reserved for future constants */
   __fs32 fs_reclaim;
   __fs32 fs_sparecon2[1];
   __fs32 fs_state; /* file system state time stamp */
   __fs32 fs_qbmask[2]; /* ~usb_bmask */
   __fs32 fs_qfmask[2]; /* ~usb_fmask */
  } fs_sun;
  struct {
   __fs32 fs_sparecon[53];/* reserved for future constants */
   __fs32 fs_reclaim;
   __fs32 fs_sparecon2[1];
   __fs32 fs_npsect; /* # sectors/track including spares */
   __fs32 fs_qbmask[2]; /* ~usb_bmask */
   __fs32 fs_qfmask[2]; /* ~usb_fmask */
  } fs_sunx86;
  struct {
   __fs32 fs_sparecon[50];/* reserved for future constants */
   __fs32 fs_contigsumsize;/* size of cluster summary array */
   __fs32 fs_maxsymlinklen;/* max length of an internal symlink */
   __fs32 fs_inodefmt; /* format of on-disk inodes */
   __fs32 fs_maxfilesize[2]; /* max representable file size */
   __fs32 fs_qbmask[2]; /* ~usb_bmask */
   __fs32 fs_qfmask[2]; /* ~usb_fmask */
   __fs32 fs_state; /* file system state time stamp */
  } fs_44;
 } fs_un2;
 __fs32 fs_postblformat;
 __fs32 fs_nrpos;
 __fs32 fs_postbloff;
 __fs32 fs_rotbloff;
 __fs32 fs_magic;
 __u8 fs_space[1];
};

#endif /* __LINUX_UFS_FS_H */