Aaru/Aaru.Partitions/SGI.cs

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename       : SGI.cs
// Author(s)      : Natalia Portillo <claunia@claunia.com>
//
// Component      : Partitioning scheme plugins.
//
// --[ Description ] ----------------------------------------------------------
//
//     Manages SGI DVHs (Disk Volume Headers).
//
// --[ 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-2021 Natalia Portillo
// ****************************************************************************/

using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Runtime.InteropServices;
using Aaru.CommonTypes.Interfaces;
using Aaru.Console;
using Aaru.Helpers;
using Marshal = Aaru.Helpers.Marshal;

#pragma warning disable 169
#pragma warning disable 649

namespace Aaru.Partitions
{
    /// <inheritdoc />
    /// <summary>
    /// Implements decoding of the SGI Disk Volume Header
    /// </summary>
    [SuppressMessage("ReSharper", "InconsistentNaming")]
    public sealed class SGI : IPartition
    {
        const int SGI_MAGIC = 0x0BE5A941;

        /// <inheritdoc />
        public string Name   => "SGI Disk Volume Header";
        /// <inheritdoc />
        public Guid   Id     => new Guid("AEF5AB45-4880-4CE8-8735-F0A402E2E5F2");
        /// <inheritdoc />
        public string Author => "Natalia Portillo";

        /// <inheritdoc />
        public bool GetInformation(IMediaImage imagePlugin, out List<CommonTypes.Partition> partitions,
                                   ulong sectorOffset)
        {
            partitions = new List<CommonTypes.Partition>();

            byte[] sector = imagePlugin.ReadSector(sectorOffset);

            if(sector.Length < 512)
                return false;

            Label dvh = Marshal.ByteArrayToStructureBigEndian<Label>(sector);

            for(int i = 0; i < dvh.volume.Length; i++)
                dvh.volume[i] = (Volume)Marshal.SwapStructureMembersEndian(dvh.volume[i]);

            for(int i = 0; i < dvh.partitions.Length; i++)
                dvh.partitions[i] = (Partition)Marshal.SwapStructureMembersEndian(dvh.partitions[i]);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.magic = 0x{0:X8} (should be 0x{1:X8})", dvh.magic,
                                       SGI_MAGIC);

            if(dvh.magic != SGI_MAGIC)
                return false;

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.root_part_num = {0}", dvh.root_part_num);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.swap_part_num = {0}", dvh.swap_part_num);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.boot_file = \"{0}\"",
                                       StringHandlers.CToString(dvh.boot_file));

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_skew = {0}", dvh.device_params.dp_skew);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_gap1 = {0}", dvh.device_params.dp_gap1);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_gap2 = {0}", dvh.device_params.dp_gap2);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_spares_cyl = {0}",
                                       dvh.device_params.dp_spares_cyl);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_cyls = {0}", dvh.device_params.dp_cyls);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_shd0 = {0}", dvh.device_params.dp_shd0);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_trks0 = {0}", dvh.device_params.dp_trks0);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_ctq_depth = {0}",
                                       dvh.device_params.dp_ctq_depth);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_cylshi = {0}",
                                       dvh.device_params.dp_cylshi);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_secs = {0}", dvh.device_params.dp_secs);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_secbytes = {0}",
                                       dvh.device_params.dp_secbytes);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_interleave = {0}",
                                       dvh.device_params.dp_interleave);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_flags = {0}", dvh.device_params.dp_flags);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_datarate = {0}",
                                       dvh.device_params.dp_datarate);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_nretries = {0}",
                                       dvh.device_params.dp_nretries);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_mspw = {0}", dvh.device_params.dp_mspw);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_xgap1 = {0}", dvh.device_params.dp_xgap1);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_xsync = {0}", dvh.device_params.dp_xsync);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_xrdly = {0}", dvh.device_params.dp_xrdly);
            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_xgap2 = {0}", dvh.device_params.dp_xgap2);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_xrgate = {0}",
                                       dvh.device_params.dp_xrgate);

            AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.device_params.dp_xwcont = {0}",
                                       dvh.device_params.dp_xwcont);

            ulong counter = 0;

            for(int i = 0; i < dvh.partitions.Length; i++)
            {
                AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.partitions[{0}].num_blocks = {1}", i,
                                           dvh.partitions[i].num_blocks);

                AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.partitions[{0}].first_block = {1}", i,
                                           dvh.partitions[i].first_block);

                // TODO: Solve big endian marshal with enumerations
                dvh.partitions[i].type = (SGIType)Swapping.Swap((uint)dvh.partitions[i].type);
                AaruConsole.DebugWriteLine("SGIVH plugin", "dvh.partitions[{0}].type = {1}", i, dvh.partitions[i].type);

                var part = new CommonTypes.Partition
                {
                    Start = dvh.partitions[i].first_block * dvh.device_params.dp_secbytes /
                            imagePlugin.Info.SectorSize,
                    Offset = dvh.partitions[i].first_block * dvh.device_params.dp_secbytes,
                    Length = dvh.partitions[i].num_blocks * dvh.device_params.dp_secbytes /
                             imagePlugin.Info.SectorSize,
                    Size     = dvh.partitions[i].num_blocks * dvh.device_params.dp_secbytes,
                    Type     = TypeToString(dvh.partitions[i].type),
                    Sequence = counter,
                    Scheme   = Name
                };

                if(part.Size              <= 0              ||
                   dvh.partitions[i].type == SGIType.Header ||
                   dvh.partitions[i].type == SGIType.Volume)
                    continue;

                partitions.Add(part);
                counter++;
            }

            return true;
        }

        static string TypeToString(SGIType typ)
        {
            switch(typ)
            {
                case SGIType.Header:    return "Volume header";
                case SGIType.TrkRepl:   return "Track replacements";
                case SGIType.SecRepl:   return "Sector replacements";
                case SGIType.Swap:      return "Raw data (swap)";
                case SGIType.Bsd:       return "4.2BSD Fast File System";
                case SGIType.SystemV:   return "UNIX System V";
                case SGIType.Volume:    return "Whole device";
                case SGIType.EFS:       return "EFS";
                case SGIType.Lvol:      return "Logical volume";
                case SGIType.Rlvol:     return "Raw logical volume";
                case SGIType.XFS:       return "XFS";
                case SGIType.Xlvol:     return "XFS log device";
                case SGIType.Rxlvol:    return "XLV volume";
                case SGIType.Xvm:       return "SGI XVM";
                case SGIType.LinuxSwap: return "Linux swap";
                case SGIType.Linux:     return "Linux";
                case SGIType.LinuxRAID: return "Linux RAID";
                default:                return "Unknown";
            }
        }

        [StructLayout(LayoutKind.Sequential, Pack = 1)]
        readonly struct Label
        {
            /// <summary></summary>
            public readonly uint magic;
            /// <summary></summary>
            public readonly short root_part_num;
            /// <summary></summary>
            public readonly short swap_part_num;
            /// <summary></summary>
            [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
            public readonly byte[] boot_file;
            /// <summary></summary>
            public readonly DeviceParameters device_params;
            /// <summary></summary>
            [MarshalAs(UnmanagedType.ByValArray, SizeConst = 15)]
            public readonly Volume[] volume;
            /// <summary></summary>
            [MarshalAs(UnmanagedType.ByValArray, SizeConst = 16)]
            public readonly Partition[] partitions;
            /// <summary></summary>
            public readonly uint csum;
            /// <summary></summary>
            public readonly uint padding;
        }

        [StructLayout(LayoutKind.Sequential, Pack = 1)]
        readonly struct Volume
        {
            /// <summary></summary>
            [MarshalAs(UnmanagedType.ByValArray, SizeConst = 8)]
            public readonly byte[] name;
            /// <summary></summary>
            public readonly uint block_num;
            /// <summary></summary>
            public readonly uint num_bytes;
        }

        enum SGIType : uint
        {
            Header = 0, TrkRepl      = 1, SecRepl      = 2,
            Swap   = 3, Bsd          = 4, SystemV      = 5,
            Volume = 6, EFS          = 7, Lvol         = 8,
            Rlvol  = 9, XFS          = 0xA, Xlvol      = 0xB,
            Rxlvol = 0xC, Xvm        = 0x0D, LinuxSwap = 0x82,
            Linux  = 0x83, LinuxRAID = 0xFD
        }

        [StructLayout(LayoutKind.Sequential, Pack = 1)]
        struct Partition
        {
            /// <summary></summary>
            public readonly uint num_blocks;
            /// <summary></summary>
            public readonly uint first_block;
            /// <summary></summary>
            public SGIType type;
        }

        struct DeviceParameters
        {
            public byte   dp_skew;
            public byte   dp_gap1;
            public byte   dp_gap2;
            public byte   dp_spares_cyl;
            public ushort dp_cyls;
            public ushort dp_shd0;
            public ushort dp_trks0;
            public byte   dp_ctq_depth;
            public byte   dp_cylshi;
            public ushort dp_unused;
            public ushort dp_secs;
            public ushort dp_secbytes;
            public ushort dp_interleave;
            public uint   dp_flags;
            public uint   dp_datarate;
            public uint   dp_nretries;
            public uint   dp_mspw;
            public ushort dp_xgap1;
            public ushort dp_xsync;
            public ushort dp_xrdly;
            public ushort dp_xgap2;
            public ushort dp_xrgate;
            public ushort dp_xwcont;
        }
    }
}