djwong/xfs-documentation

We don't actually list the ftype constants, so do that.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>

We now record the extents being used to stage a copy on write operation
in the refcount btree with the high bit of rc_startblock set and a
reference count of 1.  Setting the high bit helps us reduce CoW GC time
at mount by moving all the records to the right side of the tree.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Document the reference count btree and talk a little bit about how
the reflink feature uses it.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Add chapters on the operation of the reverse mapping btree and future
things we could do with rmap data.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

…parate chapter

Move the discussion of short and long format btrees into a separate
chapter.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Since the chapter on directories introduces data structures that are
referenced in the xattr chapter, the book should discuss directories first.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Document the new sparse inodes feature and how it affects the inobt records.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Add a chapter to give an overview of the enhanced metadata integrity
fields present on a v5 filesystem.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Document the new fields and data structures added in XFS v5 filesystems.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Discuss the on-disk log format and provide an example of walking through
the log with xfs_logprint.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Provide a quick overview of the history and design goals of XFS, and
specify what exactly this documentation aims to do.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Use asciidoc quotes for quoted strings.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Fix some of the more egregious missing xfs_db examples so that the reader
can appreciate what the data structures look like.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Add missing field definitions for various data structures.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Fix typos and grammatical errors in the text.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Make the section titles of the examples consistently formatted.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Update the common data types to reflect modern XFS source.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

The images of xfs_db sessions were translated to asciidoc, so drop the
unnecessary PNG and SVG files.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Convert images that are purely screenshots of xfs_db sessions to text,
to reduce the document size and format better.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Convert HTML entities back to regular characters, since this is now ASCII.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Restore the rendering of the on-disk struct fields to resemble that of
the old SGI book, with bold field names on one line and the
description indented below.  This is a lot more readable than letting
the whole field and description run together as one long line.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

The current subtitle is redundant and since this is the third edition
(the second ed. came out in 2006) we might as well note that.  Update
some of the headings to make it clear that we're talking about disk
format and not much else.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

Space each include one line apart so that asciidoc knows that each
section has ended at included file's EOF.  This prevents it from
spewing horribly confused XML that blows up xmllint if each included
file doesn't itself end with a blank line.

Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
Reviewed-by: Christoph Hellwig <hch@lst.de>
Signed-off-by: Dave Chinner <david@fromorbit.com>

After a week of tallking about SMR and thinking about the issues
raised in the original document and some of the solutions that
have arisen from LSFMM and Vault, there are some updates that need
to be made.

- outer zone is "conventional media recording" (CMR)
- some drives have much more CMR than others
- SMR architecture is targetted at single drives: no RAID!
- SMR architecture is targetted at unparitioned drives: fs only!
- CMR region is large enough for journal
- clarified the hint to vendors for "hybrid" SMR drives
- implications of 256MB zones made clear
  - /.zones/ needs to be heirarchical
  - zone groups are required for management of locality
  - zone inodes and bitmaps need to be reclaimable
- Cleaner updated for zone group awareness
- Inode data fork reverse mapping btree architecture added
- potential concurrent allocation/write issue solution added

Signed-off-by: Dave Chinner <dchinner@redhat.com>

First pass at filesystem architecture needed to support  host aware
SMR Devices.

Signed-off-by: Dave Chinner <dchinner@redhat.com>

Take the basic XFS filesystem tuning section from the RHEL 6
performance tuning guide, convert it to asciidoc and prepare it for
being expanded.

Signed-off-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

From: Dave Chinner <dchinner@redhat.com>

Pull the self describing metadata doc across from the kernel
Documentation/ directory and convert it to asciidoc format.

Signed-off-by: Dave Chinner <dchinner@redhat.com>
Signed-off-by: Dave Chinner <david@fromorbit.com>

This is pulled in from the xml format documents that are present in
git://git.kernel.org/pub/scm/fs/xfs/xfsdocs-xml-dev.git. They are
converted to asciidoc format and a makefile infrastructure is built
around the newly imported design documentation.

Signed-off-by: Dave Chinner <dchinner@redhat.com>