about.rst 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. .. SPDX-License-Identifier: GPL-2.0
  2. About this Book
  3. ===============
  4. This document attempts to describe the on-disk format for ext4
  5. filesystems. The same general ideas should apply to ext2/3 filesystems
  6. as well, though they do not support all the features that ext4 supports,
  7. and the fields will be shorter.
  8. **NOTE**: This is a work in progress, based on notes that the author
  9. (djwong) made while picking apart a filesystem by hand. The data
  10. structure definitions should be current as of Linux 4.18 and
  11. e2fsprogs-1.44. All comments and corrections are welcome, since there is
  12. undoubtedly plenty of lore that might not be reflected in freshly
  13. created demonstration filesystems.
  14. License
  15. -------
  16. This book is licensed under the terms of the GNU Public License, v2.
  17. Terminology
  18. -----------
  19. ext4 divides a storage device into an array of logical blocks both to
  20. reduce bookkeeping overhead and to increase throughput by forcing larger
  21. transfer sizes. Generally, the block size will be 4KiB (the same size as
  22. pages on x86 and the block layer's default block size), though the
  23. actual size is calculated as 2 ^ (10 + ``sb.s_log_block_size``) bytes.
  24. Throughout this document, disk locations are given in terms of these
  25. logical blocks, not raw LBAs, and not 1024-byte blocks. For the sake of
  26. convenience, the logical block size will be referred to as
  27. ``$block_size`` throughout the rest of the document.
  28. When referenced in ``preformatted text`` blocks, ``sb`` refers to fields
  29. in the super block, and ``inode`` refers to fields in an inode table
  30. entry.
  31. Other References
  32. ----------------
  33. Also see https://www.nongnu.org/ext2-doc/ for quite a collection of
  34. information about ext2/3. Here's another old reference:
  35. http://wiki.osdev.org/Ext2