Kenneth Skovhede
44bef1e855
Key changes: - Add `MacOSSnapshot` class implementing `SnapshotBase` - Add helper scripts for creating, finding, and removing APFS snapshots - Update `SnapshotUtility` to initialize macOS snapshots - Enable `snapshot-policy` option for macOS in `Options.cs` - Update build configuration to include APFS scripts - Update snapshot test utility with macOS support This fixes #6409
544 lines
22 KiB
C#
544 lines
22 KiB
C#
// Copyright (C) 2025, The Duplicati Team
|
|
// https://duplicati.com, hello@duplicati.com
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a
|
|
// copy of this software and associated documentation files (the "Software"),
|
|
// to deal in the Software without restriction, including without limitation
|
|
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
|
// and/or sell copies of the Software, and to permit persons to whom the
|
|
// Software is furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
|
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Diagnostics;
|
|
using System.Linq;
|
|
using System.Runtime.Versioning;
|
|
using System.Text;
|
|
using Duplicati.Library.Common.IO;
|
|
using Duplicati.Library.Interface;
|
|
|
|
namespace Duplicati.Library.Snapshots
|
|
{
|
|
/// <summary>
|
|
/// This class encapsulates all access to the macOS APFS snapshot feature,
|
|
/// implementing the disposable patterns to ensure correct release of resources.
|
|
/// </summary>
|
|
[SupportedOSPlatform("macOS")]
|
|
public sealed class MacOSSnapshot : SnapshotBase
|
|
{
|
|
/// <summary>
|
|
/// The tag used for logging messages
|
|
/// </summary>
|
|
public static readonly string LOGTAG = Logging.Log.LogTagFromType(typeof(MacOSSnapshot));
|
|
|
|
/// <summary>
|
|
/// This is a lookup, mapping each source folder to the corresponding snapshot
|
|
/// </summary>
|
|
private readonly List<KeyValuePair<string, SnapShot>> m_entries;
|
|
|
|
/// <summary>
|
|
/// This is the list of the snapshots we have created, which must be disposed
|
|
/// </summary>
|
|
private List<SnapShot> m_snapShots;
|
|
|
|
/// <summary>
|
|
/// Constructs a new snapshot module using APFS
|
|
/// </summary>
|
|
/// <param name="sources">The list of folders to create snapshots for</param>
|
|
/// <param name="followSymlinks">A flag indicating if symlinks should be followed</param>
|
|
public MacOSSnapshot(IEnumerable<string> sources, bool followSymlinks)
|
|
: base(followSymlinks)
|
|
{
|
|
try
|
|
{
|
|
m_entries = new List<KeyValuePair<string, SnapShot>>();
|
|
|
|
// Make sure we do not create more snapshots than we have to
|
|
var snaps = new Dictionary<string, SnapShot>();
|
|
foreach (var path in sources)
|
|
{
|
|
var tmp = new SnapShot(path);
|
|
if (!snaps.TryGetValue(tmp.DeviceName, out var snap))
|
|
{
|
|
snaps.Add(tmp.DeviceName, tmp);
|
|
snap = tmp;
|
|
}
|
|
|
|
m_entries.Add(new KeyValuePair<string, SnapShot>(path, snap));
|
|
}
|
|
|
|
m_snapShots = snaps.Values.ToList();
|
|
|
|
// We have all the snapshots that we need, lets activate them
|
|
foreach (var snap in m_snapShots)
|
|
{
|
|
snap.CreateSnapshotVolume();
|
|
}
|
|
}
|
|
catch
|
|
{
|
|
// If something goes wrong, try to clean up
|
|
try
|
|
{
|
|
Dispose();
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
Logging.Log.WriteVerboseMessage(LOGTAG, "SnapshotCleanupError", ex, "Failed to clean up after error");
|
|
}
|
|
|
|
throw;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the source folders
|
|
/// </summary>
|
|
public override IEnumerable<string> SourceEntries => m_entries.Select(x => x.Key);
|
|
|
|
/// <summary>
|
|
/// Enumerates the root source files and folders
|
|
/// </summary>
|
|
/// <returns>The source files and folders</returns>
|
|
public override IEnumerable<ISourceProviderEntry> EnumerateFilesystemEntries()
|
|
{
|
|
foreach (var sourceEntry in SourceEntries)
|
|
{
|
|
if (DirectoryExists(sourceEntry) || sourceEntry.EndsWith(System.IO.Path.DirectorySeparatorChar.ToString()))
|
|
yield return new SnapshotSourceFileEntry(this, Util.AppendDirSeparator(sourceEntry), true, true);
|
|
else
|
|
yield return new SnapshotSourceFileEntry(this, sourceEntry, false, true);
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
protected override void Dispose(bool disposing)
|
|
{
|
|
if (m_snapShots != null)
|
|
{
|
|
if (disposing)
|
|
{
|
|
// Attempt to clean out as many as possible
|
|
foreach (var s in m_snapShots)
|
|
{
|
|
try { s.Dispose(); }
|
|
catch (Exception ex) { Logging.Log.WriteVerboseMessage(LOGTAG, "SnapshotCloseError", ex, "Failed to close a snapshot"); }
|
|
}
|
|
}
|
|
|
|
// Don't try this again
|
|
m_snapShots = null;
|
|
}
|
|
|
|
base.Dispose(disposing);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Internal helper class for keeping track of a single snapshot volume
|
|
/// </summary>
|
|
private sealed class SnapShot : IDisposable
|
|
{
|
|
/// <summary>
|
|
/// The unique id of the snapshot
|
|
/// </summary>
|
|
private readonly string m_name;
|
|
|
|
/// <summary>
|
|
/// The actual APFS snapshot name
|
|
/// </summary>
|
|
private string m_apfsSnapshotName;
|
|
|
|
/// <summary>
|
|
/// Constructs a new snapshot for the given folder
|
|
/// </summary>
|
|
/// <param name="path"></param>
|
|
public SnapShot(string path)
|
|
{
|
|
m_name = $"duplicati-{Guid.NewGuid()}";
|
|
LocalPath = System.IO.Directory.Exists(path) ? Util.AppendDirSeparator(path) : path;
|
|
Initialize(LocalPath);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the path of the folder that this snapshot represents
|
|
/// </summary>
|
|
public string LocalPath { get; }
|
|
|
|
/// <summary>
|
|
/// Gets a value representing the volume on which the folder resides
|
|
/// </summary>
|
|
public string DeviceName { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets the path where the snapshot is mounted
|
|
/// </summary>
|
|
public string SnapshotPath { get; private set; }
|
|
|
|
/// <summary>
|
|
/// Gets the path the source disk is originally mounted
|
|
/// </summary>
|
|
public string MountPoint { get; private set; }
|
|
|
|
#region IDisposable Members
|
|
|
|
/// <summary>
|
|
/// Cleanup any used resources
|
|
/// </summary>
|
|
public void Dispose()
|
|
{
|
|
if (SnapshotPath != null && System.IO.Directory.Exists(SnapshotPath))
|
|
{
|
|
var output = ExecuteCommand("remove-apfs-snapshot.sh", $"\"{m_apfsSnapshotName ?? m_name}\" \"{DeviceName}\" \"{SnapshotPath}\"", 0);
|
|
if (System.IO.Directory.Exists(SnapshotPath))
|
|
throw new Exception(string.Format("Failed to remove mount folder: {0}\n{1}", SnapshotPath, output));
|
|
|
|
SnapshotPath = null;
|
|
DeviceName = null;
|
|
}
|
|
}
|
|
|
|
#endregion
|
|
|
|
/// <summary>
|
|
/// Converts a local path to a snapshot path
|
|
/// </summary>
|
|
/// <param name="localPath">The local path</param>
|
|
/// <returns>The snapshot path</returns>
|
|
public string ConvertToSnapshotPath(string localPath)
|
|
{
|
|
if (localPath.StartsWith(MountPoint, StringComparison.Ordinal))
|
|
return SystemIOLinux.NormalizePath(SnapshotPath + localPath.Substring(MountPoint.Length));
|
|
|
|
// For macOS, the system volume is read-only and the data volume is mounted at /System/Volumes/Data
|
|
// but the user sees the files at /Users, /Applications, etc.
|
|
// If the mount point is /System/Volumes/Data, we can try to map the path directly
|
|
if (MountPoint == "/System/Volumes/Data/" && localPath.StartsWith("/", StringComparison.Ordinal))
|
|
return SystemIOLinux.NormalizePath(SnapshotPath + localPath.Substring(1));
|
|
|
|
throw new InvalidOperationException($"The path {localPath} is not located on the mount point {MountPoint}");
|
|
}
|
|
|
|
/// <summary>
|
|
/// Converts a snapshot path to a local path
|
|
/// </summary>
|
|
/// <param name="snapshotPath">The snapshot path</param>
|
|
/// <returns>The local path</returns>
|
|
public string ConvertToLocalPath(string snapshotPath)
|
|
{
|
|
if (!snapshotPath.StartsWith(SnapshotPath, StringComparison.Ordinal))
|
|
throw new InvalidOperationException($"The path {snapshotPath} is not located on the snapshot path {SnapshotPath}");
|
|
|
|
return MountPoint + snapshotPath.Substring(SnapshotPath.Length);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Helper function to execute a script
|
|
/// </summary>
|
|
/// <param name="program">The name of the apfs-script to execute</param>
|
|
/// <param name="commandline">The arguments to pass to the executable</param>
|
|
/// <param name="expectedExitCode">The exitcode that is expected</param>
|
|
/// <returns>A string with the combined output of the stdout and stderr</returns>
|
|
private static string ExecuteCommand(string program, string commandline, int expectedExitCode)
|
|
{
|
|
program = System.IO.Path.Combine(System.IO.Path.Combine(Duplicati.Library.AutoUpdater.UpdaterManager.INSTALLATIONDIR, "apfs-scripts"), program);
|
|
var inf = new ProcessStartInfo(program, commandline)
|
|
{
|
|
CreateNoWindow = true,
|
|
RedirectStandardError = true,
|
|
RedirectStandardOutput = true,
|
|
RedirectStandardInput = false,
|
|
WindowStyle = ProcessWindowStyle.Hidden,
|
|
UseShellExecute = false
|
|
};
|
|
|
|
try
|
|
{
|
|
var p = Process.Start(inf);
|
|
|
|
//Allow up 30 seconds for the execution
|
|
if (!p.WaitForExit(TimeSpan.FromSeconds(30)))
|
|
{
|
|
//Attempt to close down semi-nicely
|
|
p.Kill();
|
|
p.WaitForExit(TimeSpan.FromSeconds(5)); //This should work, and if it does, prevents a race with any cleanup invocations
|
|
|
|
throw new Interface.UserInformationException(string.Format("External program {0} timed out", program), "ApfsScriptTimeout");
|
|
}
|
|
|
|
//Build the output string. Since the process has exited, these cannot block
|
|
var output = string.Format("Exit code: {1}{0}{2}{0}{3}", Environment.NewLine, p.ExitCode, p.StandardOutput.ReadToEnd(), p.StandardError.ReadToEnd());
|
|
|
|
//Throw an exception if something went wrong
|
|
if (p.ExitCode != expectedExitCode)
|
|
throw new Interface.UserInformationException(string.Format("Script {0} returned error code: {1}\n{2}", program, p.ExitCode, output), "ApfsScriptWrongExitCode");
|
|
|
|
return output;
|
|
}
|
|
catch (Exception ex)
|
|
{
|
|
throw new Exception(string.Format("Failed to launch external program {0}: {1}", program, ex.ToString()));
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Finds the APFS volume of the folder
|
|
/// </summary>
|
|
private void Initialize(string folder)
|
|
{
|
|
//Figure out what volume the path is located on
|
|
var output = ExecuteCommand("find-volume.sh", $"\"{folder}\"", 0);
|
|
|
|
var lines = output.Split(new[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
|
|
var resultLine = lines.FirstOrDefault(l => !l.StartsWith("Exit code:"));
|
|
|
|
if (string.IsNullOrWhiteSpace(resultLine))
|
|
throw new Exception(string.Format("Script output does not contain device info: {0}", output));
|
|
|
|
var parts = resultLine.Trim().Split('|');
|
|
if (parts.Length != 2)
|
|
throw new Exception(string.Format("Script output format error: {0}", resultLine));
|
|
|
|
DeviceName = parts[0];
|
|
MountPoint = Util.AppendDirSeparator(parts[1]);
|
|
}
|
|
|
|
public void CreateSnapshotVolume()
|
|
{
|
|
var output = ExecuteCommand("create-apfs-snapshot.sh", $"\"{m_name}\" \"{DeviceName}\" \"{System.IO.Path.GetTempPath()}\"", 0);
|
|
|
|
var lines = output.Split(new[] { Environment.NewLine }, StringSplitOptions.RemoveEmptyEntries);
|
|
var tmpDirLine = lines.FirstOrDefault(l => l.StartsWith("tmpdir="));
|
|
|
|
if (string.IsNullOrWhiteSpace(tmpDirLine))
|
|
throw new Exception(string.Format("Script output does not contain tmpdir: {0}", output));
|
|
|
|
SnapshotPath = Util.AppendDirSeparator(tmpDirLine.Substring("tmpdir=".Length).Trim('"'));
|
|
|
|
var snapNameLine = lines.FirstOrDefault(l => l.StartsWith("snapshot_name="));
|
|
if (!string.IsNullOrWhiteSpace(snapNameLine))
|
|
{
|
|
m_apfsSnapshotName = snapNameLine.Substring("snapshot_name=".Length).Trim('"');
|
|
}
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Locates the snapshot instance that maps the path
|
|
/// </summary>
|
|
/// <param name="localPath">The file or folder name to match</param>
|
|
/// <returns>The matching snapshot</returns>
|
|
private SnapShot FindSnapshotByLocalPath(string localPath)
|
|
{
|
|
KeyValuePair<string, SnapShot>? best = null;
|
|
foreach (var s in m_entries)
|
|
{
|
|
if (localPath.StartsWith(s.Key, StringComparison.Ordinal) && (best == null || s.Key.Length > best.Value.Key.Length))
|
|
{
|
|
best = s;
|
|
}
|
|
}
|
|
|
|
if (best != null)
|
|
return best.Value.Value;
|
|
|
|
var sb = new StringBuilder();
|
|
sb.Append(Environment.NewLine);
|
|
|
|
foreach (var s in m_entries)
|
|
{
|
|
sb.Append($"{s.Key} ({s.Value.MountPoint} -> {s.Value.SnapshotPath}){Environment.NewLine}");
|
|
}
|
|
|
|
throw new InvalidOperationException(string.Format("The path {0} is not covered by any snapshot. Covered paths: {1}", localPath, sb.ToString()));
|
|
}
|
|
|
|
/// <summary>
|
|
/// Locates the snapshot containing the snapshot path
|
|
/// </summary>
|
|
/// <param name="snapshotPath"></param>
|
|
/// <returns>Snapshot containing snapshotPath</returns>
|
|
private SnapShot FindSnapshotBySnapshotPath(string snapshotPath)
|
|
{
|
|
foreach (var snap in m_snapShots)
|
|
{
|
|
if (snapshotPath.StartsWith(snap.SnapshotPath, StringComparison.Ordinal))
|
|
return snap;
|
|
}
|
|
|
|
throw new InvalidOperationException();
|
|
}
|
|
|
|
public override ISourceProviderEntry GetFilesystemEntry(string path, bool isFolder)
|
|
{
|
|
// Find the snapshot that covers this path
|
|
var match = m_entries.FirstOrDefault(x => path.StartsWith(x.Key, StringComparison.Ordinal));
|
|
|
|
// If we have a snapshot, use it
|
|
if (match.Value != null)
|
|
{
|
|
try
|
|
{
|
|
var snapPath = match.Value.ConvertToSnapshotPath(path);
|
|
if (isFolder)
|
|
{
|
|
if (System.IO.Directory.Exists(snapPath))
|
|
return new SnapshotSourceFileEntry(this, isFolder ? Util.AppendDirSeparator(path) : path, isFolder, false);
|
|
}
|
|
else
|
|
{
|
|
if (System.IO.File.Exists(snapPath))
|
|
return new SnapshotSourceFileEntry(this, isFolder ? Util.AppendDirSeparator(path) : path, isFolder, false);
|
|
}
|
|
}
|
|
catch
|
|
{
|
|
}
|
|
}
|
|
|
|
return base.GetFilesystemEntry(path, isFolder);
|
|
}
|
|
|
|
protected override string[] ListFiles(string folder)
|
|
{
|
|
var snap = FindSnapshotByLocalPath(folder);
|
|
var tmp = System.IO.Directory.GetFiles(snap.ConvertToSnapshotPath(folder));
|
|
for (var i = 0; i < tmp.Length; i++)
|
|
tmp[i] = snap.ConvertToLocalPath(tmp[i]);
|
|
return tmp;
|
|
}
|
|
|
|
protected override string[] ListFolders(string folder)
|
|
{
|
|
var snap = FindSnapshotByLocalPath(folder);
|
|
var tmp = System.IO.Directory.GetDirectories(snap.ConvertToSnapshotPath(folder));
|
|
for (var i = 0; i < tmp.Length; i++)
|
|
tmp[i] = snap.ConvertToLocalPath(tmp[i]);
|
|
return tmp;
|
|
}
|
|
|
|
#region ISnapshotService Members
|
|
|
|
/// <summary>
|
|
/// Gets the last write time of a given file in UTC
|
|
/// </summary>
|
|
/// <param name="localPath">The full path to the file in non-snapshot format</param>
|
|
/// <returns>The last write time of the file</returns>
|
|
public override DateTime GetLastWriteTimeUtc(string localPath)
|
|
=> System.IO.File.GetLastWriteTimeUtc(ConvertToSnapshotPath(localPath));
|
|
|
|
/// <summary>
|
|
/// Gets the creation time of a given file in UTC
|
|
/// </summary>
|
|
/// <param name="localPath">The full path to the file in non-snapshot format</param>
|
|
/// <returns>The last write time of the file</returns>
|
|
public override DateTime GetCreationTimeUtc(string localPath)
|
|
=> System.IO.File.GetCreationTimeUtc(ConvertToSnapshotPath(localPath));
|
|
|
|
/// <summary>
|
|
/// Opens a file for reading
|
|
/// </summary>
|
|
/// <param name="localPath">The full path to the file in non-snapshot format</param>
|
|
/// <returns>An open filestream that can be read</returns>
|
|
public override System.IO.Stream OpenRead(string localPath)
|
|
=> System.IO.File.OpenRead(ConvertToSnapshotPath(localPath));
|
|
|
|
/// <summary>
|
|
/// Returns the size of a file
|
|
/// </summary>
|
|
/// <param name="localPath">The full path to the file in non-snapshot format</param>
|
|
/// <returns>The length of the file</returns>
|
|
public override long GetFileSize(string localPath)
|
|
=> new System.IO.FileInfo(ConvertToSnapshotPath(localPath)).Length;
|
|
|
|
/// <summary>
|
|
/// Gets the attributes for the given file or folder
|
|
/// </summary>
|
|
/// <returns>The file attributes</returns>
|
|
/// <param name="localPath">The file or folder to examine</param>
|
|
public override System.IO.FileAttributes GetAttributes(string localPath)
|
|
=> System.IO.File.GetAttributes(ConvertToSnapshotPath(localPath));
|
|
|
|
/// <summary>
|
|
/// Returns the symlink target if the entry is a symlink, and null otherwise
|
|
/// </summary>
|
|
/// <param name="localPath">The file or folder to examine</param>
|
|
/// <returns>The symlink target</returns>
|
|
public override string GetSymlinkTarget(string localPath)
|
|
=> SystemIO.IO_OS.GetSymlinkTarget(ConvertToSnapshotPath(localPath));
|
|
|
|
/// <summary>
|
|
/// Gets the metadata for the given file or folder
|
|
/// </summary>
|
|
/// <returns>The metadata for the given file or folder</returns>
|
|
/// <param name="localPath">The file or folder to examine</param>
|
|
/// <param name="isSymlink">A flag indicating if the target is a symlink</param>
|
|
public override Dictionary<string, string> GetMetadata(string localPath, bool isSymlink)
|
|
=> SystemIO.IO_OS.GetMetadata(ConvertToSnapshotPath(localPath), isSymlink, FollowSymlinks);
|
|
|
|
/// <summary>
|
|
/// Gets a value indicating if the path points to a block device
|
|
/// </summary>
|
|
/// <returns><c>true</c> if this instance is a block device; otherwise, <c>false</c>.</returns>
|
|
/// <param name="localPath">The file or folder to examine</param>
|
|
public override bool IsBlockDevice(string localPath)
|
|
{
|
|
try
|
|
{
|
|
var n = PosixFile.GetFileType(SystemIOLinux.NormalizePath(localPath));
|
|
switch (n)
|
|
{
|
|
case PosixFile.FileType.Directory:
|
|
case PosixFile.FileType.Symlink:
|
|
case PosixFile.FileType.File:
|
|
return false;
|
|
default:
|
|
return true;
|
|
}
|
|
}
|
|
catch
|
|
{
|
|
if (!System.IO.File.Exists(SystemIOLinux.NormalizePath(localPath)))
|
|
return false;
|
|
|
|
throw;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets a unique hardlink target ID
|
|
/// </summary>
|
|
/// <returns>The hardlink ID</returns>
|
|
/// <param name="localPath">The file or folder to examine</param>
|
|
public override string HardlinkTargetID(string localPath)
|
|
{
|
|
var snapshotPath = ConvertToSnapshotPath(localPath);
|
|
|
|
if (PosixFile.GetHardlinkCount(snapshotPath) <= 1)
|
|
return null;
|
|
|
|
return PosixFile.GetInodeTargetID(snapshotPath);
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public override string ConvertToLocalPath(string snapshotPath)
|
|
=> FindSnapshotBySnapshotPath(snapshotPath).ConvertToLocalPath(snapshotPath);
|
|
|
|
/// <inheritdoc />
|
|
public override string ConvertToSnapshotPath(string localPath)
|
|
=> FindSnapshotByLocalPath(localPath).ConvertToSnapshotPath(localPath);
|
|
|
|
#endregion
|
|
}
|
|
}
|