Unionfs: A Stackable Unification File System

Unionfs logo    This project builds a stackable unification file system, which can appear to merge the contents of several directories (branches), while keeping their physical content separate. Unionfs is useful for unified source tree management, merged contents of split CD-ROM, merged separate software package directories, data grids, and more. Unionfs allows any mix of read-only and read-write branches, as well as insertion and deletion of branches anywhere in the fan-out. To maintain unix semantics, Unionfs handles elimination of duplicates, partial-error conditions, and more. Unionfs is part of the larger FiST project.
Unionfs 2.x is now part of Andrew Morton's -mm tree, as of January 9, 2007.

Software Download:

Unionfs releases of kernel code and user-level utilities, as well as snapshots, are available via FTP or HTTP.

Download Unionfs 2.x with experimental On Disk Format (ODF) support. Read the ODF Design Document.

Unionfs 2.x is maintained in a Git repository. Here are instructions how to check out the latest code with Git.

See list of mirror sites.

Kernel Version Compatibility:

Kernel Version Unionfs version 1.x
(legacy code)
Unionfs version 2.x
(stable code)
Unionfs version 2.x + ODF
(experimental code)
2.6.26-rc0 N/A (use 2.x) unionfs-2.3.3_for_2.6.25 N/A
2.6.25 N/A (use 2.x) unionfs-2.3.3_for_2.6.25 N/A
2.6.24.5 N/A (use 2.x) unionfs-2.3.3_for_2.6.24.5 unionfs-2.1.11-odf_for_2.6.24-rc4
2.6.23.17 N/A (use 2.x) unionfs-2.3.3_for_2.6.23.17 N/A
2.6.22.19 N/A (use 2.x) unionfs-2.3.3_for_2.6.22.19 2.6.22-rc2-odf2
2.6.21.7 N/A (use 2.x) unionfs-2.3.3_for_2.6.21.7 N/A
2.6.20.21 N/A (use 2.x) unionfs-2.3.3_for_2.6.20.21 2.6.20-rc6-odf1
2.6.19.7 N/A (use 2.x) unionfs-2.3.3_for_2.6.19.7 N/A
2.6.18.8 1.4 unionfs-2.3.3_for_2.6.18.8 N/A
2.6.17 1.3 N/A N/A
2.6.16 1.2 N/A N/A
2.6.10 - 2.6.15 1.1.5 N/A N/A
2.6.9 1.1.5 unionfs-2.3.3_for_2.6.9-final N/A
2.6.x (x<9) Not Supported N/A N/A
2.4.x (x>19) 1.0.14 N/A N/A
CVS Snapshots CVS Snapshots N/A N/A

Mailing Lists:

Click on the list name below to access the subscription Web page. That page will also tell you how to post to the list, access the lists' archives, change your subscription status, etc.

List Name Purpose Who Can Subscribe Who Can Post Comments
unionfs For users' and developers' questions, announcements, bug reports, and general. Anyone Subscribers only  
unionfs-cvs For CVS commit logs Anyone No one: automated CVS logs only  

Miscellaneous:

If you find a problem, please describe it in detail and submit a bug report via Bugzilla.

Some Unionfs users congregate in #unionfs on the FreeNode IRC network.

Users of Real Time (RT) Linux can find additional RT patches for Unionfs.

Various articles and tutorials involving Unionfs:

Projects Using Unionfs:

No.NameDescription
1ALT LinuxALT Linux distribution build kit, that allow you to preparing customized distribution or LiveCD, based on ALT Linux Sisyphus packages repository
2ArchieArch Live Project
3Ark Linux LiveArk Linux Live is a "Live CD" version of Ark Linux.
4BlutopiaCluster Life-cycle Management, IBM Research Austin
5ClusterixClusterix is a modular Linux live CD based on Morphix, Knoppix and Debian GNU/Linux.
6DanixCzech Knoppix-like distribution
7Debian LinuxThe Debian Linux distribution
8DSS-LiveA system development environment to create Debian-based live Linux systems.
9EliveA Debian-based LiveCD centered around the Enlightenment window manager.
10Foresight LinuxForesight Linux is a Distribution which showcases the latest and greatest version of the GNOME Desktop Environment and Freedesktop.org
11GeLuXSwiss French Linux distribution based on Morphix
12Generations LinuxBoot/LiveCD containing GNU/Linux and KDE
13Gentoo LinuxThe Gentoo Linux distribution
14Gibraltar firewallGibraltar Security Firewall LiveCD
15Gnome LiveA Gnome LiveCD
16GoblinXGoblinX is a live CD based on Slackware, with standardized themes for novice users.
17grmlLiveCD for system administrators and texttool-users
18INSERTA Linux rescue system with NTFS write support and virus scanning that fits on a credit-card size CD.
19KanotixKnoppix-based LiveCD.
20KnoppixBootable CD with a collection of GNU/Linux Software
21LiveBackupA Framework to create bootable live-ISO's from installed Linux systems
22m-distAudio/MIDI LiveCD based on Slackware.
23Mandriva LinuxThe Mandriva Linux distribution
24Mandriva OneLive & Install CD with everything for office work, Internet and multimedia.
25MiniMythA network-boot distribution that runs the MythTV PVR software.
26MorphixModular Knoppix-based LiveCD
27NOPPENLINUXSUSE Linux based LiveCD
28open Thin ClientA comprehensive management solution and operating system for thin clients
29OpenSuSE Linux 10.2The Open-SuSE Linux distribution
30PaiPixA remastered Knoppix with a focus on Scientific applications.
31rBuilder OnlineAn online tool for creating and maintaining tailored Linux distributions including LiveCDs, Installable CDs, VMWare Images, QEMU Images, and other image types from custom package sets.
32redWall FirewallA bootable CD-ROM Firewall.
33Scientific Linux Live SystemLiveCD and LiveDVD of Scientific Linux
34SLAXSmall Slackware-based bootable CD containing the Linux OS.
35T2A "Distribution Build Kit" that allows you to select various targets for a customized distribution (e.g., router, desktop, or LiveCD).
36TaprobaneA Debian-based LiveCD that is customized for convenience without "dumbing down" the user's experience.
37TuguxPortuguese Linux Distribution
38Ubuntu Linux (Gutsy/Edgy)The Ubuntu Linux distribution
39XarnoppixA Catalan-localized LiveCD focused on education

Journal Articles:

# Title (click for html version) Formats Published In Date Comments
1 On Incremental File System Development PS PDF BibTeX ACM Transactions on Storage (TOS) May 2006  
2 Versatility and Unix Semantics in Namespace Unification PS PDF BibTeX ACM Transactions on Storage (TOS) Feb 2006  
3 Unionfs: Bringing File Systems Together BibTeX Linux Journal Dec 2004  

Conference and Workshop Papers:

# Title (click for html version) Formats Published In Date Comments
1 Kernel Support for Stackable File Systems PS PDF BibTeX 2007 Ottawa Linux Symposium Jun 2007  
2 Making Linux Stacking-Friendly BibTeX First Linux Storage and Filesystem Workshop, held in conjuction with the fifth USENIX Conference on File and Storage Technologies (FAST 2007) Feb 2007  
3 UnionFS: User- and Community-oriented Development of a Unification Filesystem PS PDF BibTeX 2006 Ottawa Linux Symposium Jul 2006  

Technical Reports:

# Title (click for html version) Formats Published In Date Comments
1 Versatility and Unix Semantics in a Fan-Out Unification File System PS PDF BibTeX Stony Brook U. CS TechReport FSL-04-01b Oct 2004  

Current Students:

# Name (click for home page) Program Member Since
1 Yamini Allu MS Jan 2008
2 Rachita Kothiyal MS Sep 2007
3 Josef "Jeff" Sipek BS Jul 2005

Past Students:

# Name (click for home page) Program Period Current Location
1 Charles P. Wright PhD May 2003 - May 2006 Research Staff Member, Network Server Systems Software group, IBM T. J. Watson Research Center (Hawthorne, NY)
2 Jay Pradip Dave MS May 2003 - Dec 2003 Software Design Engineer in Test (SDET), Windows Security and Access Control team (WSAC), Windows Security group, Core Operating Systems Division (COSD), Microsoft (Seattle, WA)
3 Puja Gupta MS Jan 2003 - Dec 2003 File Systems Engineer, Apple (Cupertino, CA)
4 Arun Krishnakumar MS Jan 2005 - Dec 2005 Computer Scientist, Acrobat team, Adobe Systems (India)
5 Harikesavan Pathangi Krishnan MS Jan 2003 - Dec 2003 Software Engineer, Engineering department for WAFS product line, Packeteer, Inc. (South Plainfield, NJ)
6 David Quigley MS Sep 2005 - May 2007 SELinux team, NSA
7 Mohammad Nayyer Zubair MS Jan 2004 - Dec 2004 Software Engineer, Falconstor (Melville, NY)
8 Yiannis Pericleous BS/MS Sep 2006 - Jun 2007 Software Developer, Albourne Partners (Nicosia, Cyprus)
9 David Quigley BS Dec 2004 - Aug 2005 SFS Scholar, Stony Brook U. CS M.S. program (Stony Brook, NY)
10 Mohammad Nayyer Zubair BS May 2003 - Dec 2003 Stony Brook U. CS M.S. program (Stony Brook, NY)

Sponsors:

# Sponsor Amount Period Type Title (click for award abstract)
1 NSF Trusted Computing (TC) $400,000 2003-2006 Sole PI A Layered Approach to Securing Network File Systems


(Last updated: Wed Apr 23 23:23:35 EDT 2008)