Difference between pages "BTRFS Fun" and "Install/ru/Partitioning"

From Funtoo
(Difference between pages)
Jump to navigation Jump to search
 
 
Line 1: Line 1:
{{Article}}
<noinclude>
{{fancyimportant|BTRFS is still '''experimental''' even with latest Linux kernels (3.4-rc at date of writing) so be prepared to lose some data sooner or later or hit a severe issue/regressions/"itchy" bugs. Subliminal message: '''Do not put critical data on BTRFS partitions'''.}}
{{InstallPart|процесс разбиения диска и создания файловых систем}}
</noinclude>
=== Подготовка жесткого диска ===


= Introduction =
В этой части  мы научимся различным способам установки Funtoo Linux -- и загрузки с -- жесткий диск.


BTRFS is an advanced filesystem mostly contributed by Sun/Oracle whose origins take place in 2007. A good summary is given in
==== Введение ====
[http://lwn.net/Articles/342892/]. BTRFS aims to provide a modern answer for making storage more flexible and efficient. According to its main contributor, Chris Mason, the goal was "to let Linux scale for the storage that will be available. Scaling is not just about addressing the storage but also means being able to administer and to manage it with a clean interface that lets people see what's being used and makes it more reliable." (Ref. [http://en.wikipedia.org/wiki/Btrfs http://en.wikipedia.org/wiki/Btrfs]).


Btrfs, often compared to ZFS, is offering some interesting features like:
В прежние времена существовал лишь один способ загрузить PC-совместимый компьютер. Все наши дектопы и сервера имели стандартный PC BIOS, все наши харды использовали MBR и были разбиты используя схему разбивки MBR.  Вот как это все было и нам это нравилось!


* Using very few fixed location metadata, thus allowing an existing ext2/ext3 filesystem to be "upgraded" in-place to BTRFS.
Затем появились EFI и UEFI, встроенные программы нового образца наряду со схемой разбивки GPT, поддерживающая диски размером более 2.2TБ. Неожиданно, нам стали доступны различные способы установки и загрузки Линукс систем . То, что было единым методом, стало чем-то более сложным.
* Operations are transactional
* Online volume defragmentation (online filesystem check is on the radar but is not yet implemented).  
* Built-in storage pool capabilities (no need for LVM)
* Built-in RAID capabilities (both for the data and filesystem metadata). RAID-5/6 is planned for 3.5 kernels
* Capabilities to grow/shrink the volume
* Subvolumes and snapshots (extremely powerful, you can "rollback" to a previous filesystem state as if nothing had happened).
* Copy-On-Write
* Usage of B-Trees to store the internal filesystem structures (B-Trees are known to have a logarithmic growth in depth, thus making them more efficient when scanning)


= Requirements =
Let's take a moment to review the options available to you for configuring a hard drive to boot Funtoo Linux. This Install Guide uses, and recommends, the old-school method of BIOS booting and using an MBR. It works and (except for rare cases) is universally supported. There's nothing wrong with it. If your system disk is 2TB or smaller in size, it won't prevent you from using all of your disk's capacity, either.


A recent Linux kernel (BTRFS metadata format evolves from time to time and mounting using a recent Linux kernel can make the BTRFS volume unreadable with an older kernel revision, e.g. Linux 2.6.31 vs Linux 2.6.30). You must also use sys-fs/btrfs-progs (0.19 or better use -9999 which points to the git repository).
But, there are some situations where the old-school method isn't optimal. If you have a system disk >2TB in size, then MBR partitions won't allow you to access all your storage. So that's one reason. Another reason is that there are some so-called "PC" systems out there that don't support BIOS booting anymore, and force you to use UEFI to boot. So, out of compassion for people who fall into this predicament, this Install Guide documents UEFI booting too.


= Playing with BTRFS storage pool capabilities =
Our recommendation is still to go old-school unless you have reason not to. The boot loader we will be using to load the Linux kernel in this guide is called GRUB, so we call this method the '''BIOS + GRUB (MBR)''' method. It's the traditional method of setting up a PC-compatible system to boot Linux.


Whereas it would possible to use btrfs just as you are used to under a non-LVM system, it shines in using its built-in storage pool capabilities. Tired of playing with LVM ? :-) Good news: you do not need it anymore with btrfs.  
If you need to use UEFI to boot, we recommend not using the MBR at all for booting, as some systems support this, but others don't. Instead, we recommend using UEFI to boot GRUB, which in turn will load Linux. We refer to this method as the '''UEFI + GRUB (GPT)''' method.


== Setting up a storage pool ==
And yes, there are even more methods, some of which are documented on the [[Boot Methods]] page. We used to recommend a '''BIOS + GRUB (GPT)''' method but it is not consistently supported across a wide variety of hardware.


BTRFS terminology is a bit confusing.  If you already have used another 'advanced' filesystem like ZFS or some mechanism like LVM, it's good to know that there are many correlations.  In the BTRFS world, the word ''volume'' corresponds to a storage ''pool'' (ZFS) or a ''volume group'' (LVM). Ref. [http://www.rkeene.org/projects/info/wiki.cgi/165 http://www.rkeene.org/projects/info/wiki.cgi/165]
'''The big question is -- which boot method should you use?''' Here's how to tell.


The test bench uses disk images through loopback devices. Of course, in a real world case, you will use local drives or units though a SAN. To start with, 5 devices of 1 GiB are allocated:
;Principle 1 - Old School: If you can reliably boot System Rescue CD and it shows you an initial light blue menu, you are booting the CD using the BIOS, and it's likely that you can thus boot Funtoo Linux using the BIOS. So, go old-school and use BIOS booting, ''unless'' you have some reason to use UEFI, such as having a >2.2TB system disk. In that case, see Principle 2, as your system may also support UEFI booting.


<console>
;Principle 2 - New School: If you can reliably boot System Rescue CD and it shows you an initial black and white menu -- congratulations, your system is configured to support UEFI booting. This means that you are ready to install Funtoo Linux to boot via UEFI. Your system may still support BIOS booting, but just be trying UEFI first. You can poke around in your BIOS boot configuration and play with this.
###i## dd if=/dev/zero of=/tmp/btrfs-vol0.img bs=1G count=1
###i## dd if=/dev/zero of=/tmp/btrfs-vol1.img bs=1G count=1
###i## dd if=/dev/zero of=/tmp/btrfs-vol2.img bs=1G count=1
###i## dd if=/dev/zero of=/tmp/btrfs-vol3.img bs=1G count=1
###i## dd if=/dev/zero of=/tmp/btrfs-vol4.img bs=1G count=1
</console>
 
Then attached:


<console>
;What's the Big Difference between Old School and New School?: Here's the deal. If you go with old-school MBR partitions, your <code>/boot</code> partition will be an ext2 filesystem, and you'll use <code>fdisk</code> to create your MBR partitions. If you go with new-school GPT partitions and UEFI booting, your <code>/boot</code> partition will be a vfat filesystem, because this is what UEFI is able to read, and you will use <code>gdisk</code> to create your GPT partitions. And you'll install GRUB a bit differently. That's about all it comes down to, in case you were curious.
###i## losetup /dev/loop0 /tmp/btrfs-vol0.img
###i## losetup /dev/loop1 /tmp/btrfs-vol1.img
###i## losetup /dev/loop2 /tmp/btrfs-vol2.img
###i## losetup /dev/loop3 /tmp/btrfs-vol3.img
###i## losetup /dev/loop4 /tmp/btrfs-vol4.img
</console>


== Creating the initial volume (pool) ==
;Also Note: To install Funtoo Linux to boot via the New School UEFI method, you must boot System Rescue CD using UEFI -- and see an initial black and white screen. Otherwise, UEFI will not be active and you will not be able to set it up!


BTRFS uses different strategies to store data and for the filesystem metadata (ref. [https://btrfs.wiki.kernel.org/index.php/Using_Btrfs_with_Multiple_Devices https://btrfs.wiki.kernel.org/index.php/Using_Btrfs_with_Multiple_Devices]).
{{Note|'''Some motherboards may appear to support UEFI, but don't.''' Do your research. For example, the Award BIOS in my Gigabyte GA-990FXA-UD7 rev 1.1 has an option to enable UEFI boot for CD/DVD. '''This is not sufficient for enabling UEFI boot for hard drives and installing Funtoo Linux.''' UEFI must be supported for both removable media (so you can boot System Rescue CD using UEFI) as well as fixed media (so you can boot your new Funtoo Linux installation.) It turns out that later revisions of this board (rev 3.0) have a new BIOS that fully supports UEFI boot. This may point to a third principle -- know thy hardware.}}


By default the behavior is:
==== Old-School (BIOS/MBR) Method ====
* metadata is '''replicated''' on all of the devices.  If a single device is used the metadata is duplicated inside this single device (useful in case of corruption or bad sector, there is a higher chance that one of the two copies is clean). To tell btrfs to maintain a single copy of the metadata, just use ''single''. Remember: '''dead metadata = dead volume with no chance of recovery.'''
* data is '''spread''' amongst all of the devices (this means no redundancy; any data block left on a defective device will be inaccessible)


To create a BTRFS volume made of multiple devices with default options, use:
{{Note|Use this method if you are booting using your BIOS, and if your System Rescue CD initial boot menu was light blue. If you're going to use the new-school method, [[#New-School (UEFI/GPT) Method|click here to jump down to UEFI/GPT.]]}}


<console>
===== Preparation =====
###i## mkfs.btrfs /dev/loop0 /dev/loop1 /dev/loop2
</console>


To create a BTRFS volume made of a single device with a single copy of the metadata (dangerous!), use:
First, it's a good idea to make sure that you've found the correct hard disk to partition. Try this command and verify that <code>/dev/sda</code> is the disk that you want to partition:


<console>
<console>
###i## mkfs.btrfs -m single /dev/loop0
# ##i##fdisk -l /dev/sda
</console>


To create a BTRFS volume made of multiple devices with metadata spread amongst all of the devices, use:
Disk /dev/sda: 640.1 GB, 640135028736 bytes, 1250263728 sectors
Units = sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disk label type: gpt


<console>
###i## mkfs.btrfs -m raid0 /dev/loop0 /dev/loop1 /dev/loop2
</console>
To create a BTRFS volume made of multiple devices, with metadata spread amongst all of the devices and data mirrored on all of the devices (you probably don't want this in a real setup), use:


<console>
#        Start          End    Size  Type            Name
###i## mkfs.btrfs -m raid0 -d raid1 /dev/loop0 /dev/loop1 /dev/loop2
1        2048  1250263694  596.2G  Linux filesyste Linux filesystem
</console>
</console>


To create a fully redundant BTRFS volume (data and metadata mirrored amongst all of the devices), use:
Now, it's recommended that you erase any existing MBR or GPT partition tables on the disk, which could confuse the system's BIOS at boot time. We do this using <code>sgdisk</code>:
{{fancywarning|This will make any existing partitions inaccessible! You are '''strongly''' cautioned and advised to backup any critical data before proceeding.}}


<console>
<console>
###i## mkfs.btrfs -d raid1 /dev/loop0 /dev/loop1 /dev/loop2
# ##i##sgdisk --zap-all /dev/sda
</console>


{{Fancynote|Technically you can use anything as a physical volume: you can have a volume composed of 2 local hard drives, 3 USB keys, 1 loopback device pointing to a file on a NFS share and 3 logical devices accessed through your SAN (you would be an idiot, but you can, nevertheless). Having different physical volume sizes would lead to issues, but it works :-).}}
Creating new GPT entries.
 
GPT data structures destroyed! You may now partition the disk using fdisk or
== Checking the initial volume ==
other utilities.
 
To verify the devices of which BTRFS volume is composed, just use '''btrfs-show ''device'' ''' (old style) or '''btrfs filesystem show ''device'' ''' (new style). You need to specify one of the devices (the metadata has been designed to keep a track of the what device is linked what other device). If the initial volume was set up like this:
 
<console>
###i## mkfs.btrfs /dev/loop0 /dev/loop1 /dev/loop2
 
WARNING! - Btrfs Btrfs v0.19 IS EXPERIMENTAL
WARNING! - see http://btrfs.wiki.kernel.org before using
 
adding device /dev/loop1 id 2
adding device /dev/loop2 id 3
fs created label (null) on /dev/loop0
        nodesize 4096 leafsize 4096 sectorsize 4096 size 3.00GB
Btrfs Btrfs v0.19
</console>
</console>


It can be checked with one of these commands (They are equivalent):
This output is also nothing to worry about, as the command still succeded:


<console>
<console>
###i## btrfs filesystem show /dev/loop0
***************************************************************
###i## btrfs filesystem show /dev/loop1
Found invalid GPT and valid MBR; converting MBR to GPT format
###i## btrfs filesystem show /dev/loop2
in memory.
***************************************************************
</console>
</console>


The result is the same for all commands:
===== Partitioning =====


<pre>
Now we will use <code>fdisk</code> to create the MBR partition table and partitions:
Label: none  uuid: 0a774d9c-b250-420e-9484-b8f982818c09
        Total devices 3 FS bytes used 28.00KB
        devid    3 size 1.00GB used 263.94MB path /dev/loop2
        devid    1 size 1.00GB used 275.94MB path /dev/loop0
        devid    2 size 1.00GB used 110.38MB path /dev/loop1
</pre>
 
To show all of the volumes that are present:


<console>
<console>
###i## btrfs filesystem show
# ##i##fdisk /dev/sda
Label: none  uuid: 0a774d9c-b250-420e-9484-b8f982818c09
        Total devices 3 FS bytes used 28.00KB
        devid    3 size 1.00GB used 263.94MB path /dev/loop2
        devid    1 size 1.00GB used 275.94MB path /dev/loop0
        devid    2 size 1.00GB used 110.38MB path /dev/loop1
 
Label: none  uuid: 1701af39-8ea3-4463-8a77-ec75c59e716a
        Total devices 1 FS bytes used 944.40GB
        devid    1 size 1.42TB used 1.04TB path /dev/sda2
 
Label: none  uuid: 01178c43-7392-425e-8acf-3ed16ab48813
        Total devices 1 FS bytes used 180.14GB
        devid    1 size 406.02GB used 338.54GB path /dev/sda4
</console>
</console>


{{Fancywarning|BTRFS wiki mentions that '''btrfs device scan''' should be performed, consequence of not doing the incantation? Volume not seen?}}
Within <code>fdisk</code>, follow these steps:
 
== Mounting the initial volume ==


BTRFS volumes can be mounted like any other filesystem. The cool stuff at the top on the sundae is that the design of the BTRFS metadata makes it possible to use any of the volume devices. The following commands are equivalent:
'''Empty the partition table''':


<console>
<console>
###i## mount /dev/loop0 /mnt
Command (m for help): ##i##o ↵
###i## mount /dev/loop1 /mnt
###i## mount /dev/loop2 /mnt
</console>
</console>


For every physical device used for mounting the BTRFS volume <tt>df -h</tt> reports the same (in all cases 3 GiB of "free" space is reported):
'''Create Partition 1''' (boot):
 
<console>
###i## df -h
Filesystem      Size  Used Avail Use% Mounted on
/dev/loop1      3.0G  56K  1.8G  1% /mnt
</console>


The following command prints very useful information (like how the BTRFS volume has been created):
<console>
<console>
###i## btrfs filesystem df /mnt     
Command (m for help): ##i##n ↵
Data, RAID0: total=409.50MB, used=0.00
Partition type (default p): ##i##↵
Data: total=8.00MB, used=0.00
Partition number (1-4, default 1): ##i##↵
System, RAID1: total=8.00MB, used=4.00KB
First sector: ##i##↵
System: total=4.00MB, used=0.00
Last sector: ##i##+128M ↵
Metadata, RAID1: total=204.75MB, used=28.00KB
Metadata: total=8.00MB, used=0.00
</console>
</console>
By the way, as you can see, for the btrfs command the mount point should be specified, not one of the physical devices.


== Shrinking the volume ==
'''Create Partition 2''' (swap):
 
A common practice in system administration is to leave some head space, instead of using the whole capacity of a storage pool (just in case). With btrfs one can easily shrink volumes. Let's shrink the volume a bit (about 25%):


<console>
<console>
###i## btrfs filesystem resize -500m /mnt
Command (m for help): ##i##n ↵
###i## dh -h
Partition type (default p): ##i##
/dev/loop1      2.6G  56K  1.8G  1% /mnt
Partition number (2-4, default 2): ##i##↵
First sector: ##i##↵
Last sector: ##i##+2G ↵
Command (m for help): ##i##t ↵
Partition number (1,2, default 2): ##i## ↵
Hex code (type L to list all codes): ##i##82 ↵
</console>
</console>
 
And yes, it is an on-line resize, there is no need to umount/shrink/mount. So no downtimes! :-) However, a BTRFS volume requires a minimal size... if the shrink is too aggressive the volume won't be resized:


<console>
'''Create the root partition:'''
###i## btrfs filesystem resize -1g /mnt 
Resize '/mnt' of '-1g'
ERROR: unable to resize '/mnt'
</console>
 
== Growing the volume ==
 
This is the opposite operation, you can make a BTRFS grow to reach a particular size (e.g. 150 more megabytes):


<console>
<console>
###i## btrfs filesystem resize +150m /mnt
Command (m for help): ##i##n ↵
Resize '/mnt' of '+150m'
Partition type (default p): ##i##
###i## dh -h
Partition number (3,4, default 3): ##i##↵
/dev/loop1      2.7G  56K  1.8G  1% /mnt
First sector: ##i##
Last sector: ##i##
</console>
</console>


You can also take an ''"all you can eat"'' approach via the '''max''' option, meaning all of the possible space will be used for the volume:
'''Verify the partition table:'''


<console>
<console>
###i## btrfs filesystem resize max /mnt
Command (m for help): ##i##p
Resize '/mnt' of 'max'
###i## dh -h
/dev/loop1      3.0G  56K  1.8G  1% /mnt
</console>


== Adding a new device to the BTRFS volume ==
Disk /dev/sda: 298.1 GiB, 320072933376 bytes, 625142448 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: dos
Disk identifier: 0x82abc9a6


To add a new device to the volume:
Device    Boot    Start      End    Blocks  Id System
 
/dev/sda1          2048    264191    131072 83 Linux
<console>
/dev/sda2         264192  4458495  2097152  82 Linux swap / Solaris
###i## btrfs device add /dev/loop4 /mnt
/dev/sda3        4458496 625142447 310341976  83 Linux
oxygen ~ # btrfs filesystem show /dev/loop4
Label: none uuid: 0a774d9c-b250-420e-9484-b8f982818c09
        Total devices 4 FS bytes used 28.00KB
        devid    3 size 1.00GB used 263.94MB path /dev/loop2
         devid    4 size 1.00GB used 0.00 path /dev/loop4
        devid    1 size 1.00GB used 275.94MB path /dev/loop0
        devid    2 size 1.00GB used 110.38MB path /dev/loop1
</console>
</console>


Again, no need to umount the volume first as adding a device is an on-line operation (the device has no space used yet hence the '0.00'). The operation is not finished as we must tell btrfs to prepare the new device (i.e. rebalance/mirror the metadata and the data between all devices):
'''Write the parition table to disk:'''


<console>
<console>
###i## btrfs filesystem balance /mnt
Command (m for help): ##i##w
###i## btrfs filesystem show /dev/loop4
Label: none  uuid: 0a774d9c-b250-420e-9484-b8f982818c09
        Total devices 4 FS bytes used 28.00KB
        devid    3 size 1.00GB used 110.38MB path /dev/loop2
        devid    4 size 1.00GB used 366.38MB path /dev/loop4
        devid    1 size 1.00GB used 378.38MB path /dev/loop0
        devid    2 size 1.00GB used 110.38MB path /dev/loop1
</console>
</console>


{{Fancynote|Depending on the sizes and what is in the volume a balancing operation could take several minutes or hours.}}
Your new MBR partition table will now be written to your system disk.


== Removing a device from the BTRFS volume ==
{{Note|You're done with partitioning! Now, jump over to [[#Creating filesystems|Creating filesystems]].}}
 
<console>
###i## btrfs device delete /dev/loop2 /mnt
###i## btrfs filesystem show /dev/loop0 
Label: none  uuid: 0a774d9c-b250-420e-9484-b8f982818c09
        Total devices 4 FS bytes used 28.00KB
        devid    4 size 1.00GB used 264.00MB path /dev/loop4
        devid    1 size 1.00GB used 268.00MB path /dev/loop0
        devid    2 size 1.00GB used 0.00 path /dev/loop1
        *** Some devices missing
###i## df -h
Filesystem      Size  Used Avail Use% Mounted on
/dev/loop1      3.0G  56K  1.5G  1% /mnt
</console>


Here again, removing a device is totally dynamic and can be done as an on-line operation! Note that when a device is removed, its content is transparently redistributed among the other devices.
==== New-School (UEFI/GPT) Method ====


Obvious points:
{{Note|Use this method if you are booting using UEFI, and if your System Rescue CD initial boot menu was black and white. If it was light blue, this method will not work.}}
* '''** DO NOT UNPLUG THE DEVICE BEFORE THE END OF THE OPERATION, DATA LOSS WILL RESULT**'''
* If you have used raid0 in either metadata or data at the BTRFS volume creation you will end in a unusable volume if one of the the devices fails before being properly removed from the volume as some stripes will be lost.


Once you add a new device to the BTRFS volume as a replacement for a removed one, you can cleanup the references to the missing device:
The <tt>gdisk</tt> commands to create a GPT partition table are as follows. Adapt sizes as necessary, although these defaults will work for most users. Start <code>gdisk</code>:


<console>
<console>
###i## btrfs device delete missing
# ##i##gdisk
</console>
</console>


== Using a BTRFS volume in degraded mode ==
Within <tt>gdisk</tt>, follow these steps:
 
{{fancywarning|It is not possible to use a volume in degraded mode if raid0 has been used for data/metadata and the device had not been properly removed with '''btrfs device delete''' (some stripes will be missing). The situation is even worse if RAID0 is used for the the metadata: trying to mount a BTRFS volume in read/write mode while not all the devices are accessible '''will simply kill the remaining metadata, hence making the BTRFS volume totally unusable'''... you have been warned! :-)}}


If you use raid1 or raid10 for data AND metadata and you have a usable submirror accessible (consisting of 1 drive in case of RAID1 or the two drive of the same RAID0 array in case of RAID10), you can mount the array in degraded mode in the case of some devices are missing (e.g. dead SAN link or dead drive) :
'''Create a new empty partition table''' (This ''will'' erase all data on the disk when saved):


<console>
<console>
###i## mount -o degraded /dev/loop0 /mnt
Command: ##i##o
</console>
This option deletes all partitions and creates a new protective MBR.
 
Proceed? (Y/N): ##i##y ↵
If you use RAID0 (and have one of your drives inaccessible) the metadata or RAID10 but not enough drives are on-line to even get a degraded mode possible, btrfs will refuse to mount the volume:
 
<console>
###i## mount /dev/loop0 /mnt
mount: wrong fs type, bad option, bad superblock on /dev/loop0,
      missing codepage or helper program, or other error
      In some cases useful info is found in syslog - try
      dmesg | tail  or so
</console>
</console>


The situation is no better if you have used RAID1 for the metadata and RAID0 for the data, you can mount the drive in degraded mode but you will encounter problems while accessing your files:
'''Create Partition 1''' (boot):


<console>
<console>
###i## cp /mnt/test.dat /tmp
Command: ##i##n ↵
cp: reading `/mnt/test.dat': Input/output error
Partition Number: ##i##1 ↵
cp: failed to extend `/tmp/test.dat': Input/output error
First sector: ##i##↵
Last sector: ##i##+500M ↵
Hex Code: ##i##↵
</console>
</console>


= Playing with subvolumes and snapshots =
'''Create Partition 2''' (swap):
 
== A story of boxes.... ==
 
When you think about subvolumes in BTRFS, think about boxes. Each one of those can contain items and other smaller boxes ("sub-boxes") which in turn can also contains items and boxes (sub-sub-boxes) and so on. Each box and items has a number and a name, except for the top level box, which has only a number (zero). Now imagine that all of the boxes are semi-opaque: you can see what they contain if you are outside the box but you can't see outside when you are inside the box. Thus, depending on the box you are in you can view either all of the items and sub-boxes (top level box) or only a part of them (any other box but the top level one). To give you a better idea of this somewhat abstract explanation let's illustrate a bit:
 
<pre>
(0) --+-> Item A (1)
      |
      +-> Item B (2)
      |
      +-> Sub-box 1 (3) --+-> Item C (4)
      |                  |
      |                  +-> Sub-sub-box 1.1 (5) --+-> Item D (6)
      |                  |                        |
      |                  |                        +-> Item E (7)
      |                  |                        |
      |                  |                        +-> Sub-Sub-sub-box 1.1.1 (8) ---> Item F (9)
      |                  +-> Item F (10)
      |
      +-> Sub-box 2 (11) --> Item G (12)                   
</pre>
 
What you see in the hierarchy depends on where you are (note that the top level box numbered 0 doesn't have a name, you will see why later). So:
* If you are in the node named top box (numbered 0) you see everything, i.e. things numbered 1 to 12
* If you are in "Sub-sub-box 1.1" (numbered 5), you see only things 6 to 9
* If you are in "Sub-box 2" (numbered 11), you only see what is numbered 12
 
Did you notice? We have two items named 'F' (respectively numbered 9 and 10). This is not a typographic error, this is just to illustrate the fact that every item lives its own peaceful existence in its own box. Although they have the same name, 9 and 10 are two distinct and unrelated objects (of course it is impossible to have two objects named 'F' in the same box, even they would be numbered differently).
 
== ... applied to BTRFS! (or, "What is a volume/subvolume?") ==
 
BTRFS subvolumes work in the exact same manner, with some nuances:
 
* First, imagine a frame that surrounds the whole hierarchy (represented in dots below). This is your BTRFS '''volume'''. A bit abstract at first glance, but BTRFS volumes have no tangible existence, they are just an ''aggregation'' of devices tagged as being clustered together (that fellowship is created when you invoke '''mkfs.btrfs''' or '''btrfs device add''').
* Second, the first level of hierarchy contains '''only''' a single box numbered zero which can never be destroyed (because everything it contains would also be destroyed).
 
If in our analogy of a nested boxes structure we used the word '''"box"''', in the real BTRFS word we use the word '''"subvolume"''' (box => subvolume). Like in our boxes analogy, all subvolumes hold a unique number greater than zero and a name, with the exception of root subvolume located at the very first level of the hierarchy which is ''always'' numbered zero and has no name (BTRFS tools destroy subvolumes by their name not their number so '''no name = no possible destruction'''.  This is a totally intentional architectural choice, not a flaw). 
 
Here is a typical hierarchy:
 
<pre>
.....BTRFS Volume................................................................................................................................
.
.  Root subvolume (0) --+-> Subvolume SV1 (258) ---> Directory D1 --+-> File F1
.                      |                                          |
.                      |                                          +-> File F2
.                      |
.                      +-> Directory D1 --+-> File F1
.                      |                  |
.                      |                  +-> File F2
.                      |                  |
.                      |                  +-> File F3
.                      |                  |
.                      |                  +-> Directory D11 ---> File F4
.                      +-> File F1
.                      |
.                      +-> Subvolume SV2 (259) --+-> Subvolume SV21 (260)
.                                                |
.                                                +-> Subvolume SV22 (261) --+-> Directory D2 ---> File F4
.                                                                            |
.                                                                            +-> Directory D3 --+-> Subvolume SV221 (262) ---> File F5
.                                                                            |                  |
.                                                                            |                  +-> File F6
.                                                                            |                  |
.                                                                            |                  +-> File F7
.                                                                            |
.                                                                            +-> File F8
.
.....................................................................................................................................
</pre>
 
Maybe you have a question: "Okay, What is the difference between a directory and a subvolume? Both can can contain something!". To further confuse you, here is what users get if they reproduce the first level hierarchy on a real machine:


<console>
<console>
###i## ls -l
Command: ##i##n ↵
total 0
Partition Number: ##i##2 ↵
drwx------ 1 root root 0 May 23 12:48 SV1
First sector: ##i##↵
drwxr-xr-x 1 root root 0 May 23 12:48 D1
Last sector: ##i##+4G ↵
-rw-r--r-- 1 root root 0 May 23 12:48 F1
Hex Code: ##i##8200 ↵
drwx------ 1 root root 0 May 23 12:48 SV2
</console>
</console>


Although subvolumes SV1 and SV2 have been created with special BTRFS commands they appear just as if they were ordinary directories! A subtle nuance exists, however: think again at our boxes analogy we did before and map the following concepts in the following manner:
'''Create Partition 3''' (root):
 
* a subvolume : the semi-opaque '''box'''
* a directory : a ''sort of'' '''item''' (that can contain something even another subvolume)
* a file : ''another sort of'' '''item'''
 
So, in the internal filesystem metadata SV1 and SV2 are stored in a different manner than D1 (although this is transparently handled for users). You can, however see SV1 and SV2 for what they are (subvolumes) by running the following command (subvolume numbered (0) has been mounted on /mnt):


<console>
<console>
###i## btrfs subvolume list /mnt
Command: ##i##n ↵
ID 258 top level 5 path SV1
Partition Number: ##i##3 ↵
ID 259 top level 5 path SV2
First sector: ##i##↵
Last sector: ##i##↵##!i## (for rest of disk)
Hex Code: ##i##↵
</console>
</console>


What would we get if we create SV21 and SV22 inside of SV2? Let's try! Before going further you should be aware that a subvolume is created by invoking the magic command '''btrfs subvolume create''':
Along the way, you can type "<tt>p</tt>" and hit Enter to view your current partition table. If you make a mistake, you can type "<tt>d</tt>" to delete an existing partition that you created. When you are satisfied with your partition setup, type "<tt>w</tt>" to write your configuration to disk:


<console>
'''Write Partition Table To Disk''':
###i## cd /mnt/SV2
###i## btrfs subvolume create SV21
Create subvolume './SV21'
###i## btrfs subvolume create SV22
Create subvolume './SV22'
###i## btrfs subvolume list /mnt 
ID 258 top level 5 path SV1
ID 259 top level 5 path SV2
ID 260 top level 5 path SV2/SV21
ID 261 top level 5 path SV2/SV22
</console>


Again, invoking '''ls''' in /mnt/SV2 will report the subvolumes as being directories:
<console>
###i## ls -l
total 0
drwx------ 1 root root 0 May 23 13:15 SV21
drwx------ 1 root root 0 May 23 13:15 SV22
</console>
== Changing the point of view on the subvolumes hierarchy ==
At some point in our boxes analogy we have talked about what we see and what we don't see depending on our location in the hierarchy. Here lies a big important point: whereas most of the BTRFS users mount the root subvolume (subvolume id = 0, we will retain the ''root subvolume'' terminology) in their VFS hierarchy thus making visible the whole hierarchy contained in the BTRFS volume, it is absolutely possible to mount only a ''subset'' of it. How that could be possible? Simple: Just specify the subvolume number when you invoke mount. For example, to mount the hierarchy in the VFS starting at subvolume SV22 (261) do the following:
<console>
###i## mount -o subvolid=261 /dev/loop0 /mnt
</console>
Here lies an important notion not disclosed in the previous paragraph: although both directories and subvolumes can act as containers, '''only subvolumes can be mounted in a VFS hierarchy'''. It is a fundamental aspect to remember: you cannot mount a sub-part of a subvolume in the VFS; you can only mount the subvolume in itself. Considering the hierarchy schema in the previous section, if you want to access the directory D3 you have three possibilities:
# Mount the non-named subvolume (numbered 0) and access D3 through /mnt/SV2/SV22/D3 if the non-named subvolume is mounted in /mnt
# Mount the subvolume SV2 (numbered 259) and access D3 through /mnt/SV22/D3 if the the subvolume SV2 is mounted in /mnt
# Mount the subvolume SV22 (numbered 261) and access D3 through /mnt/D3 if the the subvolume SV22 is mounted in /mnt
This is accomplished by the following commands, respectively:
<console>
###i## mount -o subvolid=0 /dev/loop0 /mnt
###i## mount -o subvolid=259 /dev/loop0 /mnt
###i## mount -o subvolid=261 /dev/loop0 /mnt
</console>
{{fancynote|When a subvolume is mounted in the VFS, everything located "above" the subvolume is hidden. Concretely, if you mount the subvolume numbered 261 in /mnt, you only see what is under SV22, you won't see what is located above SV22 like SV21, SV2, D1, SV1, etc. }}
== The default subvolume ==
$100 questions:
1. "If I don't put 'subvolid' in the command line, 1. how does the kernel know which one of the subvolumes it has to mount?
2. Does Omitting the 'subvolid' means automatically 'mount subvolume numbered 0'?".
Answers:
1. BTRFS magic! ;-)
2. No, not necessarily, you can choose something other than the non-named subvolume.
When you create a brand new BTRFS filesystem, the system not only creates the initial the root subvolume (numbered 0) but also tags it as being the '''default subvolume'''. When you ask the operating system to mount a subvolume contained in a BTRFS volume without specifying a subvolume number, it determines which of the existing subvolumes has been tagged as "default subvolume" and mounts it. If none of the exiting subvolumes has the tag "default subvolume" (e.g. because the default subvolume has been deleted), the mount command gives up with a rather cryptic message:
<console>
###i## mount /dev/loop0 /mnt
mount: No such file or directory
</console>
It is also possible to change at any time which subvolume contained in a BTRFS volume is considered the default volume. This is accomplished with '''btrfs subvolume set-default'''. The following tags the subvolume 261 as being the default:
<console>
###i## btrfs subvolume set-default 261 /mnt
</console>
After that operation, doing the following is exactly the same:
<console>
###i## mount /dev/loop0 /mnt
###i## mount -o subvolid=261 /dev/loop0 /mnt
</console>
{{fancynote|The chosen new default subvolume must be visible in the VFS when you invoke ''btrfs subvolume set-default''' }}
== Deleting subvolumes ==
Question: "As subvolumes appear like directories, can I delete a subvolume by doing an rm -rf on it?".
Answer: Yes, you ''can'', but that way is not the most elegant, especially when it contains several gigabytes of data scattered on thousands of files, directories and maybe other subvolumes located in the one you want to remove. It isn't elegant because ''rm -rf'' could take several minutes (or even hours!) to complete whereas something else can do the same job in the fraction of a second.
"Huh?" Yes perfectly possible, and here is the cool goodie for the readers who arrived at this point: when you want to remove a subvolume, use '''btrfs subvolume delete''' instead of '''rm -rf'''. That btrfs command will remove the snapshots in a fraction of a second, even it contains several gigabytes of data!
{{fancywarning|* You can '''never''' remove the root subvolume of a BTRFS volume as '''btrfs delete''' expects a subvolume name (again: this is not a flaw in the design of BTRFS; removing the subvolume numbered 0 would destroy the entirety of a BTRFS volume...too dangerous).
* If the subvolume you delete was tagged as the default subvolume you will have to designate another default subvolume or explicitly tell the system which one of the subvolumes has to be mounted) }}
An example: considering our initial example given [[BTRFS_Fun#..._applied_to_BTRFS.21_.28or_what_is_a_volume.2Fsubvolume.29|above]] and supposing you have mounted non-named subvolume numbered 0 in /mnt, you can remove SV22 by doing:
<console>
###i## btrfs subvolume delete /mnt/SV2/SV22
</console>
Obviously the BTRFS volume will look like this after the operation:
<pre>
.....BTRFS Volume................................................................................................................................
.
.  (0) --+-> Subvolume SV1 (258) ---> Directory D1 --+-> File F1
.        |                                          |
.        |                                          +-> File F2
.        |
.        +-> Directory D1 --+-> File F1
.        |                  |
.        |                  +-> File F2
.        |                  |
.        |                  +-> File F3
.        |                  |
.        |                  +-> Directory D11 ---> File F4
.        +-> File F1
.        |
.        +-> Subvolume SV2 (259) --+-> Subvolume SV21 (260)
.....................................................................................................................................
</pre>
== Snapshot and subvolumes ==
If you have a good comprehension of what a subvolume is, understanding what a snapshot is won't be a problem: a snapshot is a subvolume with some initial contents. "Some initial contents" here means an exact copy.
When you think about snapshots, think about copy-on-write: the data blocks are not duplicated between a mounted subvolume and its snapshot unless you start to make changes to the files (a snapshot can occupy nearly zero extra space on the disk). At time goes on, more and more data blocks will be changed, thus making snapshots "occupy" more and more space on the disk. It is therefore recommended to keep only a minimal set of them and remove unnecessary ones to avoid wasting space on the volume.
The following illustrates how to take a snaphot of the VFS root:
<console>
<console>
###i## btrfs subvolume snapshot / /snap-2011-05-23
Command: ##i##w ↵
Create a snapshot of '/' in '//snap-2011-05-23'
Do you want to proceed? (Y/N): ##i##Y ↵
</console>
</console>


Once created, the snapshot will persist in /snap-2011-05-23 as long as you don't delete it. Note that the snapshot contents will remain exactly the same it was at the time is was taken (as long as you don't make changes... BTRFS snapshots are writable!). A drawback of having snapshots: if you delete some files in the original filesystem, the snapshot still contains them and the disk blocks can't be claimed as free space. Remember to remove unwanted snapshots and keep a bare minimal set of them.
The partition table will now be written to disk and <tt>gdisk</tt> will close.
 
== Listing and deleting snaphots ==
 
As there is no distinction between a snapshot and a subvolume, snapshots are managed with the exact same commands, especially when the time has come to delete some of them. An interesting feature in BTRFS is that snapshots are writable. You can take a snapshot and make changes in the files/directories it contains.  A word of caution: there are no undo capbilities! What has been changed has been changed forever... If you need to do several tests just take several snapshots or, better yet, snapshot your snapshot then do whatever you need in this copy-of-the-copy :-).
 
== Using snapshots for system recovery (aka Back to the Future) ==
 
Here is where BTRFS can literally be a lifeboat. Suppose you want to apply some updates via '''emerge -uaDN @world''' but you want to be sure that you can jump back into the past in case something goes seriously wrong after the system update (does libpng14 remind you of anything?!). Here is the "putting-things-together part" of the article!
 
The following only applies if your VFS root and system directories containing '''/sbin, /bin, /usr, /etc....''' are located on a BTRFS volume. To make things simple, the whole structure is supposed to be located in the SAME subvolume of the same BTRFS volume.
 
To jump back into the past you have at least two options:


# Fiddle with the default subvolume numbers
Now, your GPT/GUID partitions have been created, and will show up as the following ''block devices'' under Linux:
# Use the kernel command line parameters in the bootloader configuration files


In all cases you must take a snapshot of your VFS root *before* updating the system:
* <tt>/dev/sda1</tt>, which will be used to hold the <tt>/boot</tt> filesystem,
* <tt>/dev/sda2</tt>, which will be used for swap space, and
* <tt>/dev/sda3</tt>, which will hold your root filesystem.


<console>
==== Creating filesystems ====
###i## btrfs subvolume snapshot / /before-updating-2011-05-24
Create a snapshot of '/' in '//before-updating-2011-05-24'
</console>


{{fancynote|Hint: You can create an empty file at the root of your snapshot with the name of your choice to help you easily identify which subvolume is the currently mounted one (e.g. if the snapshot has been named '''before-updating-2011-05-24''', you can use a slightly different name like '''current-is-before-updating-2011-05-24''' <nowiki>=></nowiki> '''touch /before-updating-2011-05-24/current-is-before-updating-2011-05-24'''). This is extremly useful if you are dealing with several snapshots.}}
{{Note|This section covers both BIOS ''and'' UEFI installs. Don't skip it!}}


There is no "better" way; it's just a question of personal preference.
Before your newly-created partitions can be used, the block devices need to be initialized with filesystem ''metadata''. This process is known as ''creating a filesystem'' on the block devices. After filesystems are created on the block devices, they can be mounted and used to store files.


=== Way #1: Fiddle with the default subvolume number ===
Let's keep this simple. Are you using old-school MBR partitions? If so, let's create an ext2 filesystem on /dev/sda1:
 
'''Hypothesis:
* Your "production" VFS root partition resides in the root subvolume (subvolid=0),'''
* Your /boot partition (where the bootloader configuration files are stored) is on another standalone partition
 
First search for the newly created subvolume number:


<console>
<console>
###i## btrfs subvolume list /  
# ##i##mkfs.ext2 /dev/sda1
'''ID 256''' top level 5 path before-updating-2011-05-24
</console>
</console>


'256' is the ID to be retained (of course, this ID will differ in your case).
If you're using new-school GPT partitions for UEFI, you'll want to create a vfat filesystem on /dev/sda1, because this is what UEFI is able to read:
 
Now, change the default subvolume of the BTRFS volume to designate the subvolume (snapshot) ''before-updating'' and not the root subvolume then reboot:


<console>
<console>
###i## btrfs subvolume set-default 256 /
# ##i##mkfs.vfat -F 32 /dev/sda1
</console>
</console>


Once the system has rebooted, and if you followed the advice in the previous paragraph that suggests to create an empty file of the same name as the snapshot, you should be able to see if the mounted VFS root is the copy hold by the snapshot ''before-updating-2011-05-24'':
Now, let's create a swap partition. This partition will be used as disk-based virtual memory for your Funtoo Linux system.
 
<console>
###i## ls -l /
...
-rw-rw-rw-  1 root root    0 May 24 20:33 current-is-before-updating-2011-05-24
...
</console>


The correct subvolume has been used for mounting the VFS!  Excellent! This is now the time to mount your "production" VFS root (remember the root subvolume can only be accessed via its identification number i.e ''0''):
You will not create a filesystem on your swap partition, since it is not used to store files. But it is necessary to initialize it using the <code>mkswap</code> command. Then we'll run the <code>swapon</code> command to make your newly-initialized swap space immediately active within the live CD environment, in case it is needed during the rest of the install process:


<console>
<console>
###i## mount -o subvolid=0 /mnt
# ##i##mkswap /dev/sda2
###i## mount
# ##i##swapon /dev/sda2
...
/dev/sda2 on /mnt type btrfs (rw,subvolid=0)
</console>
</console>


Oh by the way, as the root subvolume is now mounted in <tt>/mnt</tt> let's try something, just for the sake of the demonstration:
Now, we need to create a root filesystem. This is where Funtoo Linux will live. We generally recommend ext4 or XFS root filesystems. If you're not sure, choose ext4. Here's how to create a root ext4 filesystem:
 
<console>
###i## ls /mnt
...
drwxr-xr-x  1 root root   0 May 24 20:33 current-is-before-updating-2011-05-24
...
###i## btrfs subvolume list /mnt
ID 256 top level 5 path before-updating-2011-05-24
</console>


No doubt possible :-)
Time to rollback! For this '''rsync''' will be used in the following way:
<console>
<console>
###i## rsync --progress -aHAX --exclude=/proc --exclude=/dev --exclude=/sys --exclude=/mnt / /mnt
# ##i##mkfs.ext4 /dev/sda3
</console>
</console>


Basically we are asking rsync to:
...and here's how to create an XFS root filesystem, if you choose to use XFS:
* preserve timestamps, hard and symbolic links, owner/group IDs, ACLs and any extended attributes (refer to the rsync manual page for further details on options used) and to report its progression
* ignore the mount points where virtual filesystems are mounted (procfs, sysfs...)
* avoid a re-recursion by reprocessing /mnt (you can speed up the process by adding some extra directories if you are sure they don't hold any important changes or any change at all like /var/tmp/portage for example).
 
Be patient! The resync may take several minutes or hours depending on the amount of data amount to process...
 
Once finished, you will have to set the default subvolume to be the root subvolume:


<console>
<console>
###i## btrfs subvolume set-default 0 /mnt
# ##i##mkfs.xfs /dev/sda3
ID 256 top level 5 path before-updating-2011-05-24
</console>
</console>


{{fancywarning|'''DO NOT ENTER / instead of /mnt in the above command; it won't work and you will be under the snapshot before-updating-2011-05-24 the next time the machine reboots.'''
Your filesystems (and swap) have all now been initialized, so that that can be mounted (attached to your existing directory heirarchy) and used to store files. We are ready to begin installing Funtoo Linux on these brand-new filesystems.


The reason is that subvolume number must be "visible" from the path given at the end of the '''btrfs subvolume set-default''' command line. Again refer the boxes analogy: in our context we are in a subbox numbered 256 which is located *inside* the box numbered 0 (so it can't see neither interfere with it). [TODO: better explain]
{{fancywarning|1=
When deploying an OpenVZ host, please use ext4 exclusively. The Parallels development team tests extensively with ext4, and modern versions of <code>openvz-rhel6-stable</code> are '''not''' compatible with XFS, and you may experience kernel bugs.
}}
}}


Now just reboot and you should be in business again! Once you have rebooted just check if you are really under the right subvolume:
==== Mounting filesystems ====


<console>
Mount the newly-created filesystems as follows, creating <code>/mnt/funtoo</code> as the installation mount point:
###i## ls /  
...
drwxr-xr-x  1 root root    0 May 24 20:33 current-is-before-updating-2011-05-24
...
###i## btrfs subvolume list /
ID 256 top level 5 path before-updating-2011-05-24
</console>
 
At the right place? Excellent! You can now  delete the snapshot if you wish, or better: keep it as a lifeboat of "last good known system state."
 
=== Way #2: Change the kernel command line in the bootloader configuration files ===
 
First search for the newly created subvolume number:


<console>
<console>
###i## btrfs subvolume list /  
# ##i##mkdir /mnt/funtoo
'''ID 256''' top level 5 path before-updating-2011-05-24
# ##i##mount /dev/sda3 /mnt/funtoo
# ##i##mkdir /mnt/funtoo/boot
# ##i##mount /dev/sda1 /mnt/funtoo/boot
</console>
</console>


'256' is the ID to be retained (can differ in your case).
Optionally, if you have a separate filesystem for <code>/home</code> or anything else:
 
Now with your favourite text editor, edit the adequate kernel command line in your bootloader configuration (<tt>/etc/boot.conf</tt>). This file contains is typically organized in several sections (one per kernel present on the system plus some global settings), like the excerpt below:
 
<pre>
set timeout=5
set default=0
 
# Production kernel
menuentry "Funtoo Linux production kernel (2.6.39-gentoo x86/64)" {
  insmod part_msdos
  insmod ext2
  ...
  set root=(hd0,1)
  linux /kernel-x86_64-2.6.39-gentoo root=/dev/sda2
  initrd /initramfs-x86_64-2.6.39-gentoo
}
...
</pre>
 
Find the correct kernel line and add one of the following statements after root=/dev/sdX:
 
<pre>
rootflags=subvol=before-updating-2011-05-24
  - Or -
rootflags=subvolid=256
</pre>
 
{{fancywarning|If the kernel your want to use has been generated with Genkernel, you '''MUST''' use ''real_rootflags<nowiki>=</nowiki>subvol<nowiki>=</nowiki>''... instead of ''rootflags<nowiki>=</nowiki>subvol''<nowiki>=</nowiki>... at the penalty of not having your rootflags taken into consideration by the kernel on reboot. }}
 
 
Applied to the previous example you will get the following if you referred the subvolume by its name:
 
<pre>
set timeout=5
set default=0
 
# Production kernel
menuentry "Funtoo Linux production kernel (2.6.39-gentoo x86/64)" {
  insmod part_msdos
  insmod ext2
  ...
  set root=(hd0,1)
  linux /kernel-x86_64-2.6.39-gentoo root=/dev/sda2 rootflags=subvol=before-updating-2011-05-24
  initrd /initramfs-x86_64-2.6.39-gentoo
}
...
</pre>
 
Or you will get the following if you referred the subvolume by its identification number:
 
<pre>
set timeout=5
set default=0
 
# Production kernel
menuentry "Funtoo Linux production kernel (2.6.39-gentoo x86/64)" {
  insmod part_msdos
  insmod ext2
  ...
  set root=(hd0,1)
  linux /kernel-x86_64-2.6.39-gentoo root=/dev/sda2 rootflags=subvolid=256
  initrd /initramfs-x86_64-2.6.39-gentoo
}
...
</pre>
 
Once the modifications are done, save your changes and take the necessary extra steps to commit the configuration changes on the first sectors of the disk if needed (this mostly applies to the users of LILO; Grub and SILO do not need to be refreshed) and reboot.
 
Once the system has rebooted and if you followed the advice in the previous paragraph that suggests to create an empty file of the same name as the snapshot, you should be able to see if the mounted VFS root is the copy hold by the snapshot ''before-updating-2011-05-24'':


<console>
<console>
###i## ls -l /
# ##i##mkdir /mnt/funtoo/home
...
# ##i##mount /dev/sda4 /mnt/funtoo/home
-rw-rw-rw-  1 root root    0 May 24 20:33 current-is-before-updating-2011-05-24
...
</console>
</console>


The correct subvolume has been used for mounting the VFS!  Excellent! This is now the time to mount your "production" VFS root (remember the root subvolume can only be accessed via its identification number 0):
If you have <code>/tmp</code> or <code>/var/tmp</code> on a separate filesystem, be sure to change the permissions of the mount point to be globally-writeable after mounting, as follows:


<console>
<console>
###i## mount -o subvolid=0 /mnt
# ##i##chmod 1777 /mnt/funtoo/tmp
###i## mount
...
/dev/sda2 on /mnt type btrfs (rw,subvolid=0)
</console>
</console>
Time to rollback! For this '''rsync''' will be used in the following way:
<console>
###i## rsync --progress -aHAX --exclude=/proc --exclude=/dev --exclude=/sys --exclude=/mnt / /mnt
</console>
Here, please refer to what has been said in [[BTRFS_Fun#Way_.231:_Fiddle_with_the_default_subvolume_number|Way #1]] concerning the used options in rsync. Once everything is in place again, edit your bootloader configuration to remove the rootflags/real_rootflags kernel parameter, reboot and check if you are really under the right subvolume:
<console>
###i## ls /
...
drwxr-xr-x  1 root root    0 May 24 20:33 current-is-before-updating-2011-05-24
...
###i## btrfs subvolume list /
ID 256 top level 5 path current-is-before-updating-2011-05-24
</console>
At the right place? Excellent! You can now  delete the snapshot if you wish, or better: keep it as a lifeboat of "last good known system state."
= Some BTRFS practices / returns of experience / gotchas =
* Although BTRFS is still evolving, at the date of writing it (still) is '''an experimental filesystem and should be not be used for production systems and for storing critical data''' (even if the data is non critical, having backups on a partition formatted with a "stable" filesystem like Reiser or ext3/4 is recommended).
* From time to time some changes are brought to the metadata (BTRFS format is not definitive at date of writing) and a BTRFS partition could not be used with older Linux kernels (this happened with Linux 2.6.31).
* More and more Linux distributions are proposing the filesystem as an alternative for ext4
* Some reported gotchas: [https://btrfs.wiki.kernel.org/index.php/Gotchas https://btrfs.wiki.kernel.org/index.php/Gotchas]
* Playing around with BTFRS can be a bit tricky especially when dealing with default volumes and mount point (again: the box analogy)
* Using compression (e.g. LZO =>> mount -o compress=lzo) on the filesystem can improve the throughput performance, however many files nowadays are already compressed at application level (music, pictures, videos....).
* Using space caching capabilities (mount -o space_cache) seems to brings some extra slight performance improvements.
* There is very [https://lkml.org/lkml/2010/6/18/144 interesting discussion on BTRFS design limitations with B-Trees] lying on LKML. We ''strongly'' encourage you to read about on
== Deploying a Funtoo instance in a subvolume other than the root subvolume ==
Some Funtoo core devs have used BTRFS for many months and no major glitches have been reported so far (except an non-aligned memory access trap on SPARC64 in a checksum calculation routine; minor latest kernels may brought a correction) except a long time ago but this was more related to a kernel crash due to a bug that corrupted some internal data rather than the filesystem code in itself.
The following can simplify your life in case of recovery '''(not tested)''':
When you prepare the disk space that will hold the root of your future Funtoo instance (and so, will hold /usr /bin /sbin /etc etc...), don't use the root subvolume but take an extra step to define a subvolume like illustrated below:
<console>
###i## fdisk /dev/sda2
....
###i## mkfs.btrfs /dev/sda2
###i## mount /dev/sda2 /mnt/funtoo
###i## subvolume create /mnt/funtoo /mnt/funtoo/live-vfs-root-20110523
###i## chroot /mnt/funtoo/live-vfs-root-20110523 /bin/bash
</console>
Then either:
* Set the default subvolume /live-vfs-root-20110523 as being the default subvolume (btrfs subvolume set-default.... remember to inspect the subvolume identification number)
* Use rootflag / real_rootfsflags (always use real_rootfsflags for kernel generated with Genkernel) on the kernel command line in your bootloader configuration file
Technically speaking, it won't change your life BUT at system recovery: when you want to rollback to a functional VFS root copy because something happened (buggy system package, too aggressive cleanup that removed Python, dead compiling toolchain...) you can avoid a time costly rsync but at the cost of putting a bit of overhead over your shoulders when taking a snapshot.
Here again you have two ways to recover the system:
* '''fiddling with the default subvolume:'''
** Mount to the no named volume somewhere (e.g. '''mount -o subvolid=0 /dev/sdX /mnt''')
** Take a snapshot (remember to check its identification number) of your current subvolume and store it under the root volume you just have just mounted ('''btrfs snapshot create / /mnt/before-updating-20110524''') -- (Where is the "frontier"? If 0 is monted does its contennts also appear in the taken snashot located on the same volume?)
** Update your system or do whatever else "dangerous" operation
** If you need to return to the latest good known system state, just set the default subvolume to use to the just taken snapshot ('''btrfs subvolume set-default ''<snapshotnumber here>'' /mnt''')
** Reboot
** Once you have  rebooted, just mount the root subvolume again and delete the subvolume that correspond to the failed system update ('''btrfs subvolume delete /mnt/<buggy VFS rootsnapshot name here>''')
* '''fiddling with the kernel command line:'''
** Mount to the no named volume somewhere (e.g. '''mount -o subvolid=0 /dev/sdX /mnt''')
** Take a snapshot (remember to check its identification number) of your current subvolume and store it under the root volume you just have just mounted ('''btrfs snapshot create / /mnt/before-updating-20110524''') -- (Where is the "frontier"? If 0 is mounted does its contents also appear in the taken snapshot located on the same volume?)
** Update your system or do whatever else "dangerous" operation
** If you need to return to the latest good known system state, just set the rootflags/real_rootflags as demonstrated in previous paragraphs in your loader configuration file
** Reboot
** Once you have  rebooted, just mount the root subvolume again and delete the subvolume that correspond to the failed system update ('''btrfs subvolume delete /mnt/<buggy VFS rootsnapshot name here>''')
== Space recovery / defragmenting the filesystem ==
{{Fancytip|From time to time it is advised to ask for re-optimizing the filesystem structures and data blocks in a subvolume. In BTRFS terminology this is called a defragmentation and it only be performed when the subvolume is mounted in the VFS (online defragmentation):}}
<console>
###i## btrfs filesystem defrag /mnt
</console>
You can still access the subvolume, even change its contents, while a defragmentation is running.
It is also a good idea to remove the snapshots you don't use anymore especially if huge files and/or lots of files are changed because snapshots will still hold some blocks that could be reused.
== SSE 4.2 boost ==
If your CPU supports hardware calculation of CRC32 (e.g. since Intel Nehalem series and later and AMD Bulldozer series), you are encouraged to enable that support in your kernel since BTRFS makes an aggressive use of those. Just check you have enabled ''CRC32c INTEL hardware acceleration'' in  ''Cryptographic API'' either as a module or as a built-in feature
= Recovering an apparent dead BTRFS filesystem =
Dealing with a filesystem metadata coherence is a critical in  a filesystem design. Losing some data blocks (i.e. having some corrupted files) is less critical than having a screwed-up and unmountable filesystem especially if you do backups on a regular basis '''(the rule with BTRFS is *do backups*, BTRFS has no mature filesystem repair tool and you *will* end up in having to re-create your filesystem from scratch again sooner or later).'''
== Mounting with recovery option (Linux 3.2 and beyond) ==
If you are using '''Linux 3.2 and later (only!)''', you can use the ''recovery'' option to make BTRFS seek for a usable copy of tree root (several copies of it exists on the disk). Just mount your filesystem as:
<console>
###i## mount -o recovery /dev/yourBTFSvolume /mount/point
</console>
== btrfs-select-super / btrfs-zero-log ==
Two other handy tools exist but they are not deployed by default by ''sys-fs/btrfs-progs'' (even ''btrfs-progs-9999'') ebuilds because they only lie in the branch ''"next"'' of the'' btrfs-progs'' Git repository:
* btrfs-select-super
* btrfs-zero-log
=== Building the btrfs-progs goodies ===
The two tools this section is about are not build by default and Funtoo ebuilds does not build them as well for the moment. So you must build them manually:
<console>
###i## mkdir ~/src
###i## cd ~/src
###i## git clone git://git.kernel.org/pub/scm/linux/kernel/git/mason/btrfs-progs.git
###i## cd btrfs-progs
###i## make && make btrfs-select-super && make btrfs-zero-log
</console>
{{fancynote|In the past, ''btrfs-select-super'' and ''btrfs-zero-log'' were lying in the git-next branch, this is no longer the case and those tools are available in the master branch }}
=== Fixing dead superblock ===
In case of a corrupted superblock, start by asking btrfsck to use an alternate copy of the superblock instead of the superblock #0. This is achieved via the -s option followed by the number of the alternate copy you wish to use. In the following example we ask for using the superblock copy #2 of /dev/sda7:
<console>
###i## ./btrfsck --s 2 /dev/sd7
</console>
When btrfsck is happy, use btrfs-super-select to restore the default superblock (copy #0) with a clean copy.  In the following example we ask for restoring the superblock of /dev/sda7 with its copy #2:
<console>
###i## ./btrfs-super-select -s 2  /dev/sda7
</console>
Note that this will overwrite all the other supers on the disk, which means you really only get one shot at it. 
'''If you run btrfs-super-select prior prior to figuring out which one is good, you've lost your chance to find a good one.'''
=== Clearing the BTRFS journal ===
''' This will only help with one specific problem! '''
If you are unable to mount a BTRFS partition after a hard shutdown, crash or power loss, it may be due to faulty log playback in kernels prior to 3.2.  The first thing to try is updating your kernel, and mounting.  If this isn't possible, an alternate solution lies in truncating the BTRFS journal, but only if you see "replay_one_*" functions in the oops callstack.
To truncate the journal of a BTRFS partition (and thereby lose any changes that only exist in the log!), just give the filesystem to process to ''btrfs-zero-log'':
<console>
###i## ./btrfs-zero-log /dev/sda7
</console>
This is not a generic technique, and works by permanently throwing away a small amount of potentially good data.
== Using btrfsck ==
{{fancywarning|Extremely experimental...}}
If one thing is famous in the BTRFS world it would be the so-wished fully functional ''btrfsck''. A read-only version of the tool was existing out there for years, however at the begining of 2012, BTRFS developers made a public and very experimental release: the secret jewel lies in the branch ''dangerdonteveruse'' of the BTRFS Git repository hold by Chris Mason on kernel.org.
<console>
###i## git clone git://git.kernel.org/pub/scm/linux/kernel/git/mason/btrfs-progs.git
###i## cd btrfs-progs
###i## git checkout dangerdonteveruse
###i## make
</console>
So far the tool can:
* Fix errors in the extents tree and in blocks groups accounting
* Wipe the CRC tree and create a brand new one (you can to mount the filesystem with CRC checking disabled )
To repair:
<console>
###i## btrfsck --repair /dev/''yourBTRFSvolume''
</console>
To wipe the CRC tree:
<console>
###i## btrfsck --init-csum-tree /dev/''yourBTRFSvolume''
</console>
Two other options exist in the source code: ''--super'' (equivalent of btrfs-select-super ?) and ''--init-extent-tree'' (clears out any extent?)
= Final words =
We give the great lines here but BTRFS can be very tricky especially when several subvolumes coming from several BTRFS volumes are used. And remember: BTRFS is still experimental at date of writing :)
== Lessons learned ==
* Very interesting but still lacks some important features present in ZFS like RAID-Z, virtual volumes, management by attributes, filesystem streaming, etc.
* Extremly interesting for Gentoo/Funtoo systems partitions (snapshot/rollback capabilities). However not integrated in portage yet.
* If possible, use a file monitoring tool like TripWire this is handy to see what file has been corrupted once the filesystem is recovered or if a bug happens
* '''It is highly advised to not use the root subvolume when deploying a new Funtoo instance''' or put any kind of data on it in a more general case. Rolling back a data snapshot will be much easier and much less error prone (no copy process, just a matter of 'swapping' the subvolumes).
* Backup, backup backup your data! ;)
[[Category:Labs]]
[[Category:Articles]]
[[Category:Featured]]
[[Category:Filesystems]]
{{ArticleFooter}}

Revision as of 13:31, January 5, 2015


   Note

This is a template that is used as part of the Installation instructions which covers: процесс разбиения диска и создания файловых систем. Templates are being used to allow multiple variant install guides that use most of the same re-usable parts.


Подготовка жесткого диска

В этой части мы научимся различным способам установки Funtoo Linux -- и загрузки с -- жесткий диск.

Введение

В прежние времена существовал лишь один способ загрузить PC-совместимый компьютер. Все наши дектопы и сервера имели стандартный PC BIOS, все наши харды использовали MBR и были разбиты используя схему разбивки MBR. Вот как это все было и нам это нравилось!

Затем появились EFI и UEFI, встроенные программы нового образца наряду со схемой разбивки GPT, поддерживающая диски размером более 2.2TБ. Неожиданно, нам стали доступны различные способы установки и загрузки Линукс систем . То, что было единым методом, стало чем-то более сложным.

Let's take a moment to review the options available to you for configuring a hard drive to boot Funtoo Linux. This Install Guide uses, and recommends, the old-school method of BIOS booting and using an MBR. It works and (except for rare cases) is universally supported. There's nothing wrong with it. If your system disk is 2TB or smaller in size, it won't prevent you from using all of your disk's capacity, either.

But, there are some situations where the old-school method isn't optimal. If you have a system disk >2TB in size, then MBR partitions won't allow you to access all your storage. So that's one reason. Another reason is that there are some so-called "PC" systems out there that don't support BIOS booting anymore, and force you to use UEFI to boot. So, out of compassion for people who fall into this predicament, this Install Guide documents UEFI booting too.

Our recommendation is still to go old-school unless you have reason not to. The boot loader we will be using to load the Linux kernel in this guide is called GRUB, so we call this method the BIOS + GRUB (MBR) method. It's the traditional method of setting up a PC-compatible system to boot Linux.

If you need to use UEFI to boot, we recommend not using the MBR at all for booting, as some systems support this, but others don't. Instead, we recommend using UEFI to boot GRUB, which in turn will load Linux. We refer to this method as the UEFI + GRUB (GPT) method.

And yes, there are even more methods, some of which are documented on the Boot Methods page. We used to recommend a BIOS + GRUB (GPT) method but it is not consistently supported across a wide variety of hardware.

The big question is -- which boot method should you use? Here's how to tell.

Principle 1 - Old School
If you can reliably boot System Rescue CD and it shows you an initial light blue menu, you are booting the CD using the BIOS, and it's likely that you can thus boot Funtoo Linux using the BIOS. So, go old-school and use BIOS booting, unless you have some reason to use UEFI, such as having a >2.2TB system disk. In that case, see Principle 2, as your system may also support UEFI booting.
Principle 2 - New School
If you can reliably boot System Rescue CD and it shows you an initial black and white menu -- congratulations, your system is configured to support UEFI booting. This means that you are ready to install Funtoo Linux to boot via UEFI. Your system may still support BIOS booting, but just be trying UEFI first. You can poke around in your BIOS boot configuration and play with this.
What's the Big Difference between Old School and New School?
Here's the deal. If you go with old-school MBR partitions, your /boot partition will be an ext2 filesystem, and you'll use fdisk to create your MBR partitions. If you go with new-school GPT partitions and UEFI booting, your /boot partition will be a vfat filesystem, because this is what UEFI is able to read, and you will use gdisk to create your GPT partitions. And you'll install GRUB a bit differently. That's about all it comes down to, in case you were curious.
Also Note
To install Funtoo Linux to boot via the New School UEFI method, you must boot System Rescue CD using UEFI -- and see an initial black and white screen. Otherwise, UEFI will not be active and you will not be able to set it up!
   Note

Some motherboards may appear to support UEFI, but don't. Do your research. For example, the Award BIOS in my Gigabyte GA-990FXA-UD7 rev 1.1 has an option to enable UEFI boot for CD/DVD. This is not sufficient for enabling UEFI boot for hard drives and installing Funtoo Linux. UEFI must be supported for both removable media (so you can boot System Rescue CD using UEFI) as well as fixed media (so you can boot your new Funtoo Linux installation.) It turns out that later revisions of this board (rev 3.0) have a new BIOS that fully supports UEFI boot. This may point to a third principle -- know thy hardware.

Old-School (BIOS/MBR) Method

   Note

Use this method if you are booting using your BIOS, and if your System Rescue CD initial boot menu was light blue. If you're going to use the new-school method, click here to jump down to UEFI/GPT.

Preparation

First, it's a good idea to make sure that you've found the correct hard disk to partition. Try this command and verify that /dev/sda is the disk that you want to partition:

root # fdisk -l /dev/sda

Disk /dev/sda: 640.1 GB, 640135028736 bytes, 1250263728 sectors
Units = sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disk label type: gpt


root #         Start          End    Size  Type            Name
 1         2048   1250263694  596.2G  Linux filesyste Linux filesystem

Now, it's recommended that you erase any existing MBR or GPT partition tables on the disk, which could confuse the system's BIOS at boot time. We do this using sgdisk:

   Warning

This will make any existing partitions inaccessible! You are strongly cautioned and advised to backup any critical data before proceeding.

root # sgdisk --zap-all /dev/sda

Creating new GPT entries.
GPT data structures destroyed! You may now partition the disk using fdisk or
other utilities.

This output is also nothing to worry about, as the command still succeded:

***************************************************************
Found invalid GPT and valid MBR; converting MBR to GPT format
in memory. 
***************************************************************
Partitioning

Now we will use fdisk to create the MBR partition table and partitions:

root # fdisk /dev/sda

Within fdisk, follow these steps:

Empty the partition table:

Command (m for help): o ↵

Create Partition 1 (boot):

Command (m for help): n ↵
Partition type (default p): 
Partition number (1-4, default 1): 
First sector: 
Last sector: +128M ↵

Create Partition 2 (swap):

Command (m for help): n ↵
Partition type (default p): 
Partition number (2-4, default 2): 
First sector: 
Last sector: +2G ↵
Command (m for help): t ↵ 
Partition number (1,2, default 2): 
Hex code (type L to list all codes): 82 ↵

Create the root partition:

Command (m for help): n ↵
Partition type (default p): 
Partition number (3,4, default 3): 
First sector: 
Last sector: 

Verify the partition table:

Command (m for help): p

Disk /dev/sda: 298.1 GiB, 320072933376 bytes, 625142448 sectors
Units: sectors of 1 * 512 = 512 bytes
Sector size (logical/physical): 512 bytes / 512 bytes
I/O size (minimum/optimal): 512 bytes / 512 bytes
Disklabel type: dos
Disk identifier: 0x82abc9a6

Device    Boot     Start       End    Blocks  Id System
/dev/sda1           2048    264191    131072  83 Linux
/dev/sda2         264192   4458495   2097152  82 Linux swap / Solaris
/dev/sda3        4458496 625142447 310341976  83 Linux

Write the parition table to disk:

Command (m for help): w

Your new MBR partition table will now be written to your system disk.

   Note

You're done with partitioning! Now, jump over to Creating filesystems.

New-School (UEFI/GPT) Method

   Note

Use this method if you are booting using UEFI, and if your System Rescue CD initial boot menu was black and white. If it was light blue, this method will not work.

The gdisk commands to create a GPT partition table are as follows. Adapt sizes as necessary, although these defaults will work for most users. Start gdisk:

root # gdisk

Within gdisk, follow these steps:

Create a new empty partition table (This will erase all data on the disk when saved):

Command: o ↵
This option deletes all partitions and creates a new protective MBR.
Proceed? (Y/N): y ↵

Create Partition 1 (boot):

Command: n ↵
Partition Number: 1 ↵
First sector: 
Last sector: +500M ↵
Hex Code: 

Create Partition 2 (swap):

Command: n ↵
Partition Number: 2 ↵
First sector: 
Last sector: +4G ↵
Hex Code: 8200 ↵

Create Partition 3 (root):

Command: n ↵
Partition Number: 3 ↵
First sector: 
Last sector:  (for rest of disk)
Hex Code: 

Along the way, you can type "p" and hit Enter to view your current partition table. If you make a mistake, you can type "d" to delete an existing partition that you created. When you are satisfied with your partition setup, type "w" to write your configuration to disk:

Write Partition Table To Disk:

Command: w ↵
Do you want to proceed? (Y/N): Y ↵

The partition table will now be written to disk and gdisk will close.

Now, your GPT/GUID partitions have been created, and will show up as the following block devices under Linux:

  • /dev/sda1, which will be used to hold the /boot filesystem,
  • /dev/sda2, which will be used for swap space, and
  • /dev/sda3, which will hold your root filesystem.

Creating filesystems

   Note

This section covers both BIOS and UEFI installs. Don't skip it!

Before your newly-created partitions can be used, the block devices need to be initialized with filesystem metadata. This process is known as creating a filesystem on the block devices. After filesystems are created on the block devices, they can be mounted and used to store files.

Let's keep this simple. Are you using old-school MBR partitions? If so, let's create an ext2 filesystem on /dev/sda1:

root # mkfs.ext2 /dev/sda1

If you're using new-school GPT partitions for UEFI, you'll want to create a vfat filesystem on /dev/sda1, because this is what UEFI is able to read:

root # mkfs.vfat -F 32 /dev/sda1

Now, let's create a swap partition. This partition will be used as disk-based virtual memory for your Funtoo Linux system.

You will not create a filesystem on your swap partition, since it is not used to store files. But it is necessary to initialize it using the mkswap command. Then we'll run the swapon command to make your newly-initialized swap space immediately active within the live CD environment, in case it is needed during the rest of the install process:

root # mkswap /dev/sda2
root # swapon /dev/sda2

Now, we need to create a root filesystem. This is where Funtoo Linux will live. We generally recommend ext4 or XFS root filesystems. If you're not sure, choose ext4. Here's how to create a root ext4 filesystem:

root # mkfs.ext4 /dev/sda3

...and here's how to create an XFS root filesystem, if you choose to use XFS:

root # mkfs.xfs /dev/sda3

Your filesystems (and swap) have all now been initialized, so that that can be mounted (attached to your existing directory heirarchy) and used to store files. We are ready to begin installing Funtoo Linux on these brand-new filesystems.

   Warning

When deploying an OpenVZ host, please use ext4 exclusively. The Parallels development team tests extensively with ext4, and modern versions of openvz-rhel6-stable are not compatible with XFS, and you may experience kernel bugs.

Mounting filesystems

Mount the newly-created filesystems as follows, creating /mnt/funtoo as the installation mount point:

root # mkdir /mnt/funtoo
root # mount /dev/sda3 /mnt/funtoo
root # mkdir /mnt/funtoo/boot
root # mount /dev/sda1 /mnt/funtoo/boot

Optionally, if you have a separate filesystem for /home or anything else:

root # mkdir /mnt/funtoo/home
root # mount /dev/sda4 /mnt/funtoo/home

If you have /tmp or /var/tmp on a separate filesystem, be sure to change the permissions of the mount point to be globally-writeable after mounting, as follows:

root # chmod 1777 /mnt/funtoo/tmp