Ext2fs [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Ext2/3/4 Filesystem ======

The Extended Filesystem is popular in distributions of the  linux kernel where it as created. Most BSD variants have at least some support for it and there are userland (fuse) drivers as well. This page serves to keep some notes related to %%FreeBSD%%'s kernel implementation that supports the original ext2 and sufficient features to support newer versions of the popular filesystem.

The Extended Filesystem was [[http://e2fsprogs.sourceforge.net/ext2intro.html|designed]], with much inspiration on UFS, to replace the MINIX filesystem used in early versions of Linux. The filesystem is known to be very fast and continues to be very popular despite the availability of other interesting filesystems (JFS, reiserfs, XFS, etc).

In general Ext2fs is very similar to UFS but lacks support for fragments and as a consequence attempting to use bigger blocksizes penalizes the wasted space and also makes fragmentation a problem. The Linux developers have also opted for supporting the faster async mode and compensate the eventual risks with more robust filechecking tools (fsck). The ext2 developers have tried to counter the weaknesses of the filesystem by adding new features in ext3 (journalling) and ext4 (extents) but the basic design seems to be exhausted and its designers are apparently considering more recent designs like btrfs. For freebsd supporting ext2fs and it variants is still important for interoperability and as a general experimentation tool.

The initial %%FreeBSD%% ext2fs implementation was based on the [[http://www.cs.utah.edu/flux/lites/html/ext2fs.html|BSD Lites version]] by Godmar Back. The initial approach was to reuse the BSD interfaces and the similarities between UFS and ext2 and merge the specific block management routines from Linux.
%%NetBSD%% did a complete [[http://www.feyrer.de/NetBSD/ext2fs-rev1.html|reimplementation]] from UFS sources.

While on %%NetBSD%% the ext2fs implementation shares code with UFS, in %%FreeBSD%% the code is independent and has it's own [[https://svnweb.freebsd.org/base/head/sys/fs/ext2fs/|sys/fs/ext2fs]] area in the kernel. [[http://bxr.su/FreeBSD/sys/fs/ext2fs/|Opengrok]] is a great alternative to study the code.

===== Coding guidelines =====

As the rest of the %%FreeBSD%% kernel code, we follow style(9). We do try to keep the code in sync where possible with UFS/FFS to ensure new UFS fixes and features can be applied to Ext2. When implementing new features it is important to give a thought on the layout: the preference should always be to avoid invasive changes in the files that are shared to some extent with UFS and add new functionality in new files.

The Linux driver is, of course, copyleft, so code cannot be generally copied from one implementation to the other. Luckily our implementation is completely different and much more similar to UFS but developers are encouraged to read the existing (public) documentation before starting to work on new features.

===== Main developments =====

During a long time, %%NetBSD%%'s and %%FreeBSD%%'s implementations were maintained independently and while they basically worked, development was stuck. The main difference between both implementations was basically the cleaner license in %%NetBSD%% implementation and the relatively good performance of the %%FreeBSD%% implementation. In both cases, running the BSD implementations in async mode (the default in Linux) is considerably slower in the BSDs compared to the Linux implementation.

On year 2009, there was a Google SOC project:

[[SOC2009AdityaSarawgi|Improving Second Extended File system (ext2fs) and making it GPL free]]

This merged the block allocation code from %%NetBSD%% and a process of merging bugfixes and enhancements from %%FreeBSD%%'s UFS1 begun. Notably the filesystem was made MPsafe and a feature called "Orlov allocator" (known also as the dirpref changes in UFS circles) were brought in.

Ext2fs development on %%FreeBSD%% is now much easier thanks to the similarities with the traditional UFS and merging features and fixes from UFS is an ongoing process.

In year 2010, a second Google %%SoC%% Project took place:

[[SOC2010ZhengLiu|Enhance ext2fs to support preallocation and read ext4 file systems]]

Preallocation was implemented but after extensive testing it was determined that block reallocation was a better alternative and was implemented based on UFS code.
Read-only support for (extents-based) ext4fs was also developed but was only brought into the tree until 2013.
Simultaneously to this project the merging of fixes from UFS1 was finished.
This brought basic O_DIRECT support for async mode mounting and several adjustments.

In year 2012, %%NetBSD%% has a different Google Summer of Code project:

[[https://github.com/vmatyushin/netbsd-ext3-htree|HTree directory indexing for Ext3]]

ZhengLiu did a port of Vyacheslav Matyushin's HTree implementation for %%NetBSD%%'s %%GSoC%%. The HTree code in Linux requires a lot of workarounds for the possibility of a hash collision which were not considered for the %%FreeBSD%% port.
The code was unstable for a while but finally got fixed on SVN [[https://svnweb.freebsd.org/base?view=revision&revision=294504|r294504]].

More recent additions include support for nanosecond/birthtime timestamps (2012), the benefit of a generic SEEK_DATA/SEEK_HOLE lseek() extension (2013), the support for sparse files from ext4 (DamjanJovanovic 2016) and support for Extended Attributes, Ext4 write support, uninit_gb, flex_bg and checksumming (FedorUporov 2017).

===== Features =====

In %%FreeBSD%% ext2, ext3 and ext4 are not different filesystems: ext2 is the base filesystem and some features from ext3 and ext4 are supported. All features in %%FreeBSD%%'s implementation follow UFS semantics and this can sometimes impose important differences.

  * %%FreeBSD%% 13-current supports Big Endian Platforms, including %%PowerPC%%, through byteswapping.

  * %%FreeBSD%% 12.1 and later have support for DTrace to enable debugging in production.

  * All supported %%FreeBSD%% versions support ext2/3 read and write with most of the features, excepting journalling.

  * %%FreeBSD%% 12+ includes initial support for writing ext4 filesystems (thanks to Fedor Uporov).

  * %%FreeBSD%% 10.1+ uses by default reallocblk. This comes from UFS and helps preventing defragmentation issues. Linux doesn't have an exact equivalent but Ext4 does delayed allocation which is similar in concept. In freeBSD 12 the feature was disabled by default as it was unstable.

  * %%FreeBSD%% 9.x+ fully supports the async mode, which is the default on Linux. Unlike Linux, the default is to use the sync mode which will make your filesystem more reliable at the cost of some performance.

  * The ports tree holds several userland (fuse) implementations.

NOTE: If you are trying to mount Ext4 partitions, and we don't yet support writing on your particular release, remember to specifically mount the filesystem **read-only**.

===== Known issues =====

  * We lack support for journalling which is inconvenient but is not necessarily be a problem if you are OK with running in sync mode, which is usually safe and the default on %%FreeBSD%%. Furthermore, at least in the Linux implementation, journalling is known to reduce performance.

  * We don't support the SSD trim command: the code to merge this feature from UFS is relatively simple but while on Linux this is a mount option, in %%FreeBSD%%'s UFS this is set in tunefs. For convenience we always choose to keep the same semantics as in UFS, so it's unsupported (for now).

  * Starting from ext2fsprogs v1.43, Linux distributions are now activating the 64 bit feature even when partitions are smaller than 16T. This feature causes problems for some Linux bootloaders and utilities. The driver in %%FreeBSD%% 12 has support for the feature but we don't expect to merge it to previous %%FreeBSD%% versions.

===== Future Projects =====

Depending on developer's interest there are some possibilities for future development:

  * Journalling is a characteristic feature of ext3+. There has been at least one [[https://github.com/bitwize/src/commits/bitwize_ext3fs/sys/ufs/ext2fs|attempt]] to do a from-scratch implementation for %%NetBSD%%. Haiku also supports journalling in their [[https://git.haiku-os.org/haiku/tree/src/add-ons/kernel/file_systems/ext2|implementation]].

  * Trim support should be doable, based on the UFS implementation.

  * Linux's Ext4 has support for [[http://blog.quarkslab.com/a-glimpse-of-ext4-filesystem-level-encryption.html|encryption]].

  * Performance testing. Benchmarks against UFS and the original Linux ext2 (or the one in %%FreeBSD%% 8.x) are always interesting. We would like to keep the performance as similar as possible to the Linux version but at this time it is not clear how the implementation compares with other implementations.

  * Some options never picked up much interest in Linux but may be interesting for hacking pleasure. One such option is [[http://e2compr.sourceforge.net/|e2compr]] which brings basic compression to ext2fs.

  * Perhaps see what would be missing to make it an installation option.

  * Support for [[https://lwn.net/Articles/905931/|i_version]]: The e2di_version field exits in our implementation but is unused, we could support an ioctl for linux binary applications. 

===== Documentation =====

The most update information for the Ext4 implementation is available through the kernel project itself: [[https://ext4.wiki.kernel.org/index.php/Ext4_Disk_Layout|Ext4 (and Ext2/Ext3) Wiki]]

Some documentation for the Linux implementation:

  * [[https://www.kernel.org/doc/ols/2010/ols2010-pages-121-132.pdf|Space Maps in Ext4]]
  * [[https://www.kernel.org/doc/ols/2007/ols2007v2-pages-21-34.pdf|The new ext4 ﬁlesystem: current status and future plans]]
  * [[http://ext2.sourceforge.net/2005-ols/2005-ext3-paper.pdf|State of the Art: Where we are with the Ext3 filesystem]]
  * [[http://ext2.sourceforge.net/2005-ols/2005-ols-ext3-presentation.pdf|State of the Art: Where we are with the Ext3 filesystem (presentation)]]
  * [[http://kernel.org/doc/ols/2002/ols2002-pages-425-438.pdf|A Directory Index for Ext2]]

Patent: [[https://www.google.com/patents/US20100057755|US Patent 20100057755 A1]], File system with flexible inode structures.
(Red Hat has extended its patent [[https://www.redhat.com/en/about/patent-promise|promise]] to all open-source licenses).

For %%FreeBSD%%'s specific ext2fs driver the general documentation for UFS is useful.

The [[http://www.bsdcan.org/2014/schedule/events/483.en.html|BSDCan talk]] in May 2014 gave an overview of the %%FreeBSD%% implementation.