Subvolume Class Reference

Inheritance diagram for Subvolume:

Public Member Functions
	Subvolume (string name, string path, string parent_dev_uuid, SnapshotRepo? parent_repo)
Device?	get_device ()
void	print_info ()
bool	remove ()
bool	restore ()

Static Public Member Functions
static Gee.HashMap< string, Subvolume >	detect_subvolumes_for_system_by_path (string system_path, SnapshotRepo? repo, Gtk.Window? parent_window)

Public Attributes
string	device_uuid
string	name = ""
string	path = ""
long	id = -1
int64	total_bytes = 0
int64	unshared_bytes = 0
string	mount_path = ""
SnapshotRepo?	repo

Properties
string	total_formatted [get]
string	unshared_formatted [get]
bool	exists_on_disk [get]
bool	is_system_subvolume [get]

Detailed Description

Definition at line 32 of file Subvolume.vala.

Constructor & Destructor Documentation

Subvolume()

Subvolume.Subvolume ( string name, string path, string parent_dev_uuid, SnapshotRepo? parent_repo )

inline

Definition at line 46 of file Subvolume.vala.

                                                                                                 {
        
        this.name = name;
        this.path = path;
        this.device_uuid = parent_dev_uuid;
        this.repo = parent_repo;
 
        if (repo != null){
            this.mount_path = repo.mount_paths[name];
        }
    }

References SnapshotRepo.mount_paths, name, path, and repo.

Referenced by Main.create_pre_restore_snapshot_btrfs(), detect_subvolumes_for_system_by_path(), and Snapshot.read_control_file().

Member Function Documentation

detect_subvolumes_for_system_by_path()

Gee.HashMap< string, Subvolume > Subvolume.detect_subvolumes_for_system_by_path ( string system_path, SnapshotRepo? repo, Gtk.Window? parent_window )

inlinestatic

Definition at line 87 of file Subvolume.vala.

                                                                          {
 
        var map = new Gee.HashMap<string, Subvolume>();
        
        log_debug("Searching subvolume for system at path: %s".printf(system_path));
        
        var fstab = FsTabEntry.read_file(path_combine(system_path, "/etc/fstab"));
        var crypttab = CryptTabEntry.read_file(path_combine(system_path, "/etc/crypttab"));
        
        foreach(var item in fstab){
            
            if (!item.is_for_system_directory()){ continue; }
            
            if (item.subvolume_name().length > 0){
                
                var dev = item.resolve_device(crypttab, parent_window);
                var dev_name = (dev == null) ? "" : dev.device;
                var dev_uuid = (dev == null) ? "" : dev.uuid;
                
                log_debug("Found subvolume: %s, on device: %s".printf(item.subvolume_name(), dev_name));
                
                var subvol = new Subvolume(item.subvolume_name(), item.mount_point, dev_uuid, repo);
                map.set(subvol.name, subvol);
            }
        }
 
        return map;
    }

References TeeJee.Logging.log_debug(), TeeJee.FileSystem.path_combine(), repo, and Subvolume().

Referenced by Main.detect_system_devices(), and SnapshotRepo.unlock_and_mount_devices().

get_device()

Device? Subvolume.get_device ( )

inline

Definition at line 70 of file Subvolume.vala.

                               {
        
        return Device.get_device_by_uuid(device_uuid);
    }

References device_uuid, and Device.get_device_by_uuid().

print_info()

void Subvolume.print_info ( )

inline

Definition at line 117 of file Subvolume.vala.

                            {
        
        log_debug("name=%s, uuid=%s, id=%ld, path=%s".printf(name, device_uuid, id, path));
    }

References device_uuid, TeeJee.Logging.log_debug(), name, and path.

remove()

bool Subvolume.remove ( )

inline

Definition at line 124 of file Subvolume.vala.

                        {
 
        if (is_system_subvolume){
            if (name == "@"){
                path = path_combine(App.mount_point_app + "/backup", "@");
            }
            else if (name == "@home"){
                path = path_combine(App.mount_point_app + "/backup-home", "@home");
            }
        }
        
        string cmd = "";
        string std_out, std_err, subpath;
        int ret_val;
 
        if (!dir_exists(path)){ return true; } // ok, item does not exist
 
        log_msg("%s: %s (Id:%ld)".printf(_("Deleting subvolume"), name, id));
 
        // always remove subvolumes recursively, this does not affect performance
        string options = App.use_option_raw ? "--commit-after" : "";
 
        if (Main.btrfs_version__can_recursive_delete) {
            options += " --recursive";
        }
 
        subpath = path_combine(path, name);
        if (dir_exists(subpath)) { // possible nested subvolume present, verify before deleting
            int rc_show = exec_sync("btrfs subvolume show '%s'".printf(subpath), out std_out, out std_err);
            if (rc_show == 0) {
                // confirmed nested btrfs subvolume, delete it first
                cmd = "btrfs subvolume delete %s '%s'".printf(options, subpath);
                log_debug("Deleting nested subvolume in snapshot");
                log_debug(cmd);
                ret_val = exec_sync(cmd, out std_out, out std_err);
                if (ret_val != 0){
                    log_error(std_err);
                    log_error(_("Failed to delete snapshot nested subvolume") + ": '%s'".printf(subpath));
                    return false;
                }
            } else {
                // path exists but is not a btrfs subvolume, skip nested removal
                log_debug("Nested path exists but is not a btrfs subvolume, skipping: %s".printf(subpath));
            }
        }
        
        cmd = "btrfs subvolume delete %s '%s'".printf(options, path);
        log_debug(cmd);
        ret_val = exec_sync(cmd, out std_out, out std_err);
        if (ret_val != 0){
            log_error(std_err);
            log_error(_("Failed to delete snapshot subvolume") + ": '%s'".printf(path));
            return false;
        }
 
        log_msg("%s: %s (Id:%ld)\n".printf(_("Deleted subvolume"), name, id));
 
        if (App.btrfs_qgroups_enabled) {
            if ((id > 0) && (repo != null)){
 
                log_debug("Waiting on btrfs to finish deleting...");
                while (exec_sync("btrfs subvolume sync %s".printf(mount_path), out std_out, out std_err) != 0) {
                    log_debug("Still waiting for btrfs to finish deleting... %s".printf(std_err));
                    sleep(1000);
                }
 
                log_debug("Rescanning quotas...");
                while (exec_sync("btrfs quota rescan %s".printf(mount_path), out std_out, out std_err) != 0) {
                    log_debug("Still rescanning quotas... %s".printf(std_err));
                    sleep(1000);
                }
 
                // Check if qgroup still exists before trying to destroy it.
                // The qgroup may have been auto-destroyed when the subvolume was deleted.
                string qgroup_id = "0/%ld".printf(id);
                cmd = "btrfs qgroup show -f '%s'".printf(repo.mount_paths[name]);
                log_debug(cmd);
                ret_val = exec_sync(cmd, out std_out, out std_err);
 
                bool qgroup_exists = (ret_val == 0) && (std_out.contains(qgroup_id));
 
                if (!qgroup_exists) {
                    log_debug("Qgroup %s already removed (auto-destroyed with subvolume)".printf(qgroup_id));
                } else {
                    log_msg("%s: %s".printf(_("Destroying qgroup"), qgroup_id));
 
                    cmd = "btrfs qgroup destroy %s '%s'".printf(qgroup_id, repo.mount_paths[name]);
                    log_debug(cmd);
                    ret_val = exec_sync(cmd, out std_out, out std_err);
                    if (ret_val != 0){
                        // Qgroup may have been destroyed between our check and destroy attempt
                        log_debug("Qgroup %s could not be destroyed (likely already removed): %s".printf(qgroup_id, std_err));
                    } else {
                        log_msg("%s: %s\n".printf(_("Destroyed qgroup"), qgroup_id));
                    }
                }
 
                log_debug("Rescanning quotas (post)...");
                while (exec_sync("btrfs quota rescan %s".printf(mount_path), out std_out, out std_err) != 0) {
                    log_debug("Still rescanning quotas (post)... %s".printf(std_err));
                    sleep(1000);
                }
 
                log_debug("Final sync (post)...");
                while (exec_sync("btrfs subvolume sync %s".printf(mount_path), out std_out, out std_err) != 0) {
                    log_debug("Still syncing (post)... %s".printf(std_err));
                    sleep(1000);
                }
 
            }
        }
 
        return true;
    }

References _, App, Main.btrfs_qgroups_enabled, Main.btrfs_version__can_recursive_delete, TeeJee.FileSystem.dir_exists(), TeeJee.ProcessHelper.exec_sync(), is_system_subvolume, TeeJee.Logging.log_debug(), TeeJee.Logging.log_error(), TeeJee.Logging.log_msg(), mount_path, SnapshotRepo.mount_paths, Main.mount_point_app, name, path, TeeJee.FileSystem.path_combine(), repo, and TeeJee.System.sleep().

restore()

bool Subvolume.restore ( )

inline

Definition at line 239 of file Subvolume.vala.

                         {
 
        if (is_system_subvolume) { return false; }
 
        // restore snapshot subvolume by creating new subvolume snapshots ----------------------
        
        string src_path = path;
        string dst_path = path_combine(mount_path, name);
 
        if (!dir_exists(src_path)){
            log_error("%s: %s".printf(_("Not Found"), src_path));
            return false;
        }
 
        if (dir_exists(dst_path)){
            log_error("%s: %s".printf(_("Subvolume exists at destination"), dst_path));
            return false;
        }
        
        string cmd = "btrfs subvolume snapshot '%s' '%s'".printf(src_path, dst_path);
        log_debug(cmd);
 
        string std_out, std_err;
        int status = exec_sync(cmd, out std_out, out std_err);
        
        if (status != 0){
            log_error(std_err);
            log_error(_("btrfs returned an error") + ": %d".printf(status));
            log_error(_("Failed to restore system subvolume") + ": %s".printf(name));
            return false;
        }
 
        log_msg(_("Restored system subvolume") + ": %s".printf(name));
        
        return true;
    }

References _, TeeJee.FileSystem.dir_exists(), TeeJee.ProcessHelper.exec_sync(), is_system_subvolume, TeeJee.Logging.log_debug(), TeeJee.Logging.log_error(), TeeJee.Logging.log_msg(), mount_path, name, path, and TeeJee.FileSystem.path_combine().

Member Data Documentation

device_uuid

string Subvolume.device_uuid

Definition at line 34 of file Subvolume.vala.

Referenced by get_device(), and print_info().

id

long Subvolume.id = -1

Definition at line 37 of file Subvolume.vala.

mount_path

string Subvolume.mount_path = ""

Definition at line 41 of file Subvolume.vala.

Referenced by remove(), and restore().

name

string Subvolume.name = ""

Definition at line 35 of file Subvolume.vala.

Referenced by print_info(), remove(), restore(), and Subvolume().

path

string Subvolume.path = ""

Definition at line 36 of file Subvolume.vala.

Referenced by print_info(), remove(), restore(), and Subvolume().

repo

SnapshotRepo? Subvolume.repo

Definition at line 44 of file Subvolume.vala.

Referenced by detect_subvolumes_for_system_by_path(), remove(), and Subvolume().

total_bytes

int64 Subvolume.total_bytes = 0

Definition at line 38 of file Subvolume.vala.

unshared_bytes

int64 Subvolume.unshared_bytes = 0

Definition at line 39 of file Subvolume.vala.

Property Documentation

exists_on_disk

bool Subvolume.exists_on_disk

get

Definition at line 75 of file Subvolume.vala.

                              {
        get {
            return dir_exists(path);
        }
    }

is_system_subvolume

bool Subvolume.is_system_subvolume

get

Definition at line 81 of file Subvolume.vala.

                                   {
        get {
            return (repo == null);
        }
    }

Referenced by remove(), and restore().

total_formatted

string Subvolume.total_formatted

get

Definition at line 58 of file Subvolume.vala.

                                 {
        owned get{
            return format_file_size(total_bytes);
        }
    }

unshared_formatted

string Subvolume.unshared_formatted

get

Definition at line 64 of file Subvolume.vala.

                                    {
        owned get{
            return format_file_size(unshared_bytes);
        }
    }

---

The documentation for this class was generated from the following file:

• BastionGuard/thirdparty/bastionguard-backup/src/Core/Subvolume.vala