aboutsummaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2018-01-05xfsdocs: clarify log item header structureHEAD2018-01-05masterDarrick J. Wong1-0/+12
Make it more explicit that each log item has to start with a type code and size, except for transaction headers. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2018-01-05xfsdocs: fix some small discrepancies with libxfsDarrick J. Wong4-4/+9
Fix some small discrepancies between the current libxfs code and this doc. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2017-11-28xfsdocs: fix description of directory free block nvalid and nused header fieldsDarrick J. Wong1-6/+14
The descriptions of the directory free block header's nvalid and nused fields are backwards, so flip them. While we're fixing them, augment the description to relate it to the rest of the directory structure. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2017-10-13xfs: move dir-attr btree sections to a separate chapterDarrick J. Wong4-157/+223
Instead of scattering dabtree documentation across two sections underneath the directory chapter, just give them a separate chapter. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com> Acked-by: Dave Chinner <dchinner@redhat.com>
2017-07-01docs: add missing sb_qflags valuesDarrick J. Wong1-0/+4
We're missing a few of the sb_qflags values, so add them to the docs. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2017-07-01docs: fix mailing listDarrick J. Wong1-1/+1
Fix the mailing list since it's way out of date. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com> Reviewed-by: Eric Sandeen <sandeen@redhat.com>
2017-07-01docs: record the metadump file formatDarrick J. Wong4-0/+86
Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2017-07-01docs: clarify what the ATTRBIT and ATTR2BIT feature flags doDarrick J. Wong1-5/+12
It would seem that the disk format doesn't actually change depending on ATTRBIT and ATTR2BIT. The key difference is that ATTR2BIT (without the 'noattr2' mount option) allows di_forkoff to change depending on how much space the attr fork needs, whereas ATTRBIT (without ATTR2BIT or the 'attr2' mount option) does not allow di_forkoff to change. In other words, at least one of the bits must be set if there are extended attributes, but between the two bits the only difference is a change in the default di_forkoff adjustment behaviors. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2016-12-20docs: enumerate possible directory ftype valuesDarrick J. Wong1-0/+29
We don't actually list the ftype constants, so do that. Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com>
2016-12-20docs: update refcount btree to reflect new cow staging extent policyDarrick J. Wong1-5/+14
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>
2016-12-20docs: fix a typo in the AGF section of the disk format docDarrick J. Wong1-1/+1
Signed-off-by: Darrick J. Wong <darrick.wong@oracle.com> Reviewed-by: Christoph Hellwig <hch@lst.de>
2016-09-08xfsdocs: document the realtime reverse mapping btreeDarrick J. Wong6-2/+263
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>
2016-09-08xfsdocs: document refcount btree and reflinkDarrick J. Wong10-6/+435
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>
2016-09-08xfsdocs: reverse-mapping btree documentationDarrick J. Wong7-9/+526
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>
2016-09-08xfsdocs: move the discussions of short and long format btrees to a separate ↵Darrick J. Wong4-125/+204
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>
2016-09-08xfsdocs: update the on-disk format with changes for Linux 4.5Darrick J. Wong1-5/+14
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>
2016-09-08xfsdocs: document known testing proceduresDarrick J. Wong3-0/+39
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>
2016-09-08journaling_log: fix some typos in the section about EFDsDarrick J. Wong1-3/+3
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>
2016-01-05move directory chapter before xattr chapterDarrick J. Wong1-2/+2
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>
2016-01-05document the sparse inodes featureDarrick J. Wong2-5/+163
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>
2016-01-05document magic numbers and theoretical limitsDarrick J. Wong3-0/+89
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>
2016-01-05add a chapter discussing v5 disk formatDarrick J. Wong2-0/+38
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>
2016-01-05add documentation of v5 fieldsDarrick J. Wong8-33/+680
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>
2016-01-05document the operation of the realtime device and inodesDarrick J. Wong3-17/+36
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>
2016-01-05document the xfs log formatDarrick J. Wong2-1/+836
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>
2016-01-05introduce XFS at a high levelDarrick J. Wong4-11/+70
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>
2016-01-05fix quoted text markingsDarrick J. Wong7-97/+97
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>
2016-01-05add missing xfs_db examplesDarrick J. Wong4-3/+168
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>
2016-01-05add missing structure field definitionsDarrick J. Wong5-0/+386
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>
2016-01-05fix various errors and missing bits in the textDarrick J. Wong7-237/+319
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>
2016-01-05make example section titles consistentDarrick J. Wong5-26/+26
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>
2016-01-05update typesDarrick J. Wong4-14/+23
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>
2016-01-05delete images of hex dumpsDarrick J. Wong26-2625/+0
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>
2016-01-05convert images to textDarrick J. Wong4-27/+251
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>
2016-01-05convert html entities to regular charactersDarrick J. Wong2-17/+17
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>
2016-01-05restore the old rendering of structure field definitionsDarrick J. Wong4-126/+126
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>
2016-01-05update book subtitles and headingsDarrick J. Wong2-5/+5
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>
2016-01-05fix asciidoc confusion w.r.t. include file newline at EOFDarrick J. Wong1-0/+10
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>
2015-03-16SMR: Updates from LSFMM/VaultDave Chinner1-16/+71
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>
2015-03-16design: XFS Host Aware SMR Dave Chinner2-1/+290
First pass at filesystem architecture needed to support host aware SMR Devices. Signed-off-by: Dave Chinner <dchinner@redhat.com>
2014-04-01admin: add basic performance tuning documentDave Chinner6-2/+600
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>
2014-02-11doc: add self describing metadata designDave Chinner2-2/+358
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>
2014-02-11doc: import XFS Filesystem Structure documentationDave Chinner64-3/+10337
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>
2014-02-04doc: use a2x to build targetsDave Chinner2-6/+12
Use the a2x toolchain wrapper to convert the asciidoc via docbook formats. This allows for asciidoc book format output, automatci generation of table of contents and a whole raft of documentation target formats. Signed-off-by: Dave Chinner <dchinner@redhat.com> Signed-off-by: Dave Chinner <david@fromorbit.com>
2014-02-04XFS design documentationDave Chinner4-0/+864
All technical documentation relating to the design and architecture of the XFS filesystem will end up in the design/ directory. As a first step, bring the delayed logging design documentation in the kernel directory over and convert it to asciidoc format. This gives us a build target to start adding makefile infrastructure around to build the documentations. Initially, just start with generating PDF format documentation. Signed-off-by: Dave Chinner <dchinner@redhat.com> Signed-off-by: Dave Chinner <david@fromorbit.com>
2014-02-04readme: initial project descriptionDave Chinner1-0/+17
Signed-off-by: Dave Chinner <dchinner@redhat.com> Signed-off-by: Dave Chinner <david@fromorbit.com>
2014-02-03Initial commitDave Chinner2-0/+340
generated by cgit 1.2.3-korg (git 2.39.0) at 2024-05-15 19:07:17 +0000