Files
Aaru/Aaru.Filesystems/ZFS/ZFS.cs

66 lines
3.1 KiB
C#
Raw Normal View History

2022-12-07 13:07:31 +00:00
// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : ZFS.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : ZFS filesystem plugin.
//
// --[ License ] --------------------------------------------------------------
//
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, see <http://www.gnu.org/licenses/>.
//
// ----------------------------------------------------------------------------
// Copyright © 2011-2023 Natalia Portillo
// ****************************************************************************/
using System;
using System.Diagnostics.CodeAnalysis;
using Aaru.CommonTypes.Interfaces;
namespace Aaru.Filesystems;
/*
* The ZFS on-disk structure is quite undocumented, so this has been checked using several test images and reading the comments and headers (but not the code)
* of ZFS-On-Linux.
*
* The most basic structure, the vdev label, is as follows:
* 8KiB of blank space
* 8KiB reserved for boot code, stored as a ZIO block with magic and checksum
* 112KiB of nvlist, usually encoded using XDR
* 128KiB of copies of the 1KiB uberblock
*
* Two vdev labels, L0 and L1 are stored at the start of the vdev.
* Another two, L2 and L3 are stored at the end.
*
* The nvlist is nothing more than a double linked list of name/value pairs where name is a string and value is an arbitrary type (and can be an array of it).
* On-disk they are stored sequentially (no pointers) and can be encoded in XDR (an old Sun serialization method that stores everything as 4 bytes chunks) or
* natively (that is as the host natively stores that values, for example on Intel an extended float would be 10 bytes (80 bit).
* It can also be encoded little or big endian.
* Because of this variations, ZFS stored a header indicating the used encoding and endianess before the encoded nvlist.
*/
/// <inheritdoc />
/// <summary>Implements detection for the Zettabyte File System (ZFS)</summary>
[SuppressMessage("ReSharper", "InconsistentNaming"), SuppressMessage("ReSharper", "UnusedType.Local"),
SuppressMessage("ReSharper", "UnusedMember.Local"), SuppressMessage("ReSharper", "NotAccessedField.Local")]
public sealed partial class ZFS : IFilesystem
{
/// <inheritdoc />
public string Name => Localization.ZFS_Name;
/// <inheritdoc />
public Guid Id => new("0750014F-A714-4692-A369-E23F6EC3659C");
/// <inheritdoc />
public string Author => Authors.NataliaPortillo;
}