Files
Aaru/Aaru.Images/Partimage/Read.cs

472 lines
20 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Read.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Disk image plugins.
//
// --[ Description ] ----------------------------------------------------------
//
// Reads partimage disk images.
//
// --[ 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.IO;
using Aaru.CommonTypes;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Extents;
using Aaru.CommonTypes.Interfaces;
using Aaru.Console;
using Aaru.Helpers;
namespace Aaru.DiscImages
{
public sealed partial class Partimage
{
/// <inheritdoc />
public ErrorNumber Open(IFilter imageFilter)
{
Stream stream = imageFilter.GetDataForkStream();
stream.Seek(0, SeekOrigin.Begin);
if(stream.Length < 512)
return ErrorNumber.InvalidArgument;
byte[] hdrB = new byte[Marshal.SizeOf<Header>()];
stream.Read(hdrB, 0, Marshal.SizeOf<Header>());
_cVolumeHeader = Marshal.ByteArrayToStructureLittleEndian<Header>(hdrB);
AaruConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.magic = {0}",
StringHandlers.CToString(_cVolumeHeader.magic));
AaruConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.version = {0}",
StringHandlers.CToString(_cVolumeHeader.version));
AaruConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.volumeNumber = {0}",
_cVolumeHeader.volumeNumber);
AaruConsole.DebugWriteLine("Partimage plugin", "CVolumeHeader.identificator = {0:X16}",
_cVolumeHeader.identificator);
// TODO: Support multifile volumes
if(_cVolumeHeader.volumeNumber > 0)
{
AaruConsole.ErrorWriteLine("Support for multiple volumes not supported");
return ErrorNumber.NotImplemented;
}
hdrB = new byte[Marshal.SizeOf<MainHeader>()];
stream.Read(hdrB, 0, Marshal.SizeOf<MainHeader>());
_cMainHeader = Marshal.ByteArrayToStructureLittleEndian<MainHeader>(hdrB);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szFileSystem = {0}",
StringHandlers.CToString(_cMainHeader.szFileSystem));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szPartDescription = {0}",
StringHandlers.CToString(_cMainHeader.szPartDescription));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szOriginalDevice = {0}",
StringHandlers.CToString(_cMainHeader.szOriginalDevice));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szFirstImageFilepath = {0}",
StringHandlers.CToString(_cMainHeader.szFirstImageFilepath));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameSysname = {0}",
StringHandlers.CToString(_cMainHeader.szUnameSysname));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameNodename = {0}",
StringHandlers.CToString(_cMainHeader.szUnameNodename));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameRelease = {0}",
StringHandlers.CToString(_cMainHeader.szUnameRelease));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameVersion = {0}",
StringHandlers.CToString(_cMainHeader.szUnameVersion));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szUnameMachine = {0}",
StringHandlers.CToString(_cMainHeader.szUnameMachine));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwCompression = {0} ({1})",
_cMainHeader.dwCompression, (uint)_cMainHeader.dwCompression);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwMainFlags = {0}", _cMainHeader.dwMainFlags);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_sec = {0}",
_cMainHeader.dateCreate.Second);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_min = {0}",
_cMainHeader.dateCreate.Minute);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_hour = {0}",
_cMainHeader.dateCreate.Hour);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_mday = {0}",
_cMainHeader.dateCreate.DayOfMonth);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_mon = {0}",
_cMainHeader.dateCreate.Month);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_year = {0}",
_cMainHeader.dateCreate.Year);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_wday = {0}",
_cMainHeader.dateCreate.DayOfWeek);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_yday = {0}",
_cMainHeader.dateCreate.DayOfYear);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_isdst = {0}",
_cMainHeader.dateCreate.IsDst);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_gmtoffsec = {0}",
_cMainHeader.dateCreate.GmtOff);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate.tm_zone = {0}",
_cMainHeader.dateCreate.Timezone);
var dateCreate = new DateTime(1900 + (int)_cMainHeader.dateCreate.Year,
(int)_cMainHeader.dateCreate.Month + 1,
(int)_cMainHeader.dateCreate.DayOfMonth, (int)_cMainHeader.dateCreate.Hour,
(int)_cMainHeader.dateCreate.Minute, (int)_cMainHeader.dateCreate.Second);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dateCreate = {0}", dateCreate);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.qwPartSize = {0}", _cMainHeader.qwPartSize);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szHostname = {0}",
StringHandlers.CToString(_cMainHeader.szHostname));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.szVersion = {0}",
StringHandlers.CToString(_cMainHeader.szVersion));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwMbrCount = {0}", _cMainHeader.dwMbrCount);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwMbrSize = {0}", _cMainHeader.dwMbrSize);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwEncryptAlgo = {0} ({1})",
_cMainHeader.dwEncryptAlgo, (uint)_cMainHeader.dwEncryptAlgo);
AaruConsole.DebugWriteLine("Partimage plugin", "ArrayIsNullOrEmpty(CMainHeader.cHashTestKey) = {0}",
ArrayHelpers.ArrayIsNullOrEmpty(_cMainHeader.cHashTestKey));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture000 = {0}",
_cMainHeader.dwReservedFuture000);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture001 = {0}",
_cMainHeader.dwReservedFuture001);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture002 = {0}",
_cMainHeader.dwReservedFuture002);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture003 = {0}",
_cMainHeader.dwReservedFuture003);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture004 = {0}",
_cMainHeader.dwReservedFuture004);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture005 = {0}",
_cMainHeader.dwReservedFuture005);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture006 = {0}",
_cMainHeader.dwReservedFuture006);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture007 = {0}",
_cMainHeader.dwReservedFuture007);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture008 = {0}",
_cMainHeader.dwReservedFuture008);
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.dwReservedFuture009 = {0}",
_cMainHeader.dwReservedFuture009);
AaruConsole.DebugWriteLine("Partimage plugin", "ArrayIsNullOrEmpty(CMainHeader.cReserved) = {0}",
ArrayHelpers.ArrayIsNullOrEmpty(_cMainHeader.cReserved));
AaruConsole.DebugWriteLine("Partimage plugin", "CMainHeader.crc = 0x{0:X8}", _cMainHeader.crc);
// partimage 0.6.1 does not support them either
if(_cMainHeader.dwEncryptAlgo != PEncryption.None)
{
AaruConsole.ErrorWriteLine("Encrypted images are currently not supported.");
return ErrorNumber.NotImplemented;
}
string magic;
// Skip MBRs
if(_cMainHeader.dwMbrCount > 0)
{
hdrB = new byte[MAGIC_BEGIN_MBRBACKUP.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_MBRBACKUP.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_MBRBACKUP))
{
AaruConsole.ErrorWriteLine("Cannot find MBRs");
return ErrorNumber.InvalidArgument;
}
stream.Seek(_cMainHeader.dwMbrSize * _cMainHeader.dwMbrCount, SeekOrigin.Current);
}
// Skip extended headers and their CRC fields
stream.Seek((MAGIC_BEGIN_EXT000.Length + 4) * 10, SeekOrigin.Current);
hdrB = new byte[MAGIC_BEGIN_LOCALHEADER.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_LOCALHEADER.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_LOCALHEADER))
{
AaruConsole.ErrorWriteLine("Cannot find local header");
return ErrorNumber.InvalidArgument;
}
hdrB = new byte[Marshal.SizeOf<CLocalHeader>()];
stream.Read(hdrB, 0, Marshal.SizeOf<CLocalHeader>());
CLocalHeader localHeader = Marshal.ByteArrayToStructureLittleEndian<CLocalHeader>(hdrB);
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBlockSize = {0}", localHeader.qwBlockSize);
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwUsedBlocks = {0}", localHeader.qwUsedBlocks);
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBlocksCount = {0}",
localHeader.qwBlocksCount);
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBitmapSize = {0}", localHeader.qwBitmapSize);
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.qwBadBlocksCount = {0}",
localHeader.qwBadBlocksCount);
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.szLabel = {0}",
StringHandlers.CToString(localHeader.szLabel));
AaruConsole.DebugWriteLine("Partimage plugin", "ArrayIsNullOrEmpty(CLocalHeader.cReserved) = {0}",
ArrayHelpers.ArrayIsNullOrEmpty(localHeader.cReserved));
AaruConsole.DebugWriteLine("Partimage plugin", "CLocalHeader.crc = 0x{0:X8}", localHeader.crc);
hdrB = new byte[MAGIC_BEGIN_BITMAP.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_BITMAP.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_BITMAP))
{
AaruConsole.ErrorWriteLine("Cannot find bitmap");
return ErrorNumber.InvalidArgument;
}
_bitmap = new byte[localHeader.qwBitmapSize];
stream.Read(_bitmap, 0, (int)localHeader.qwBitmapSize);
hdrB = new byte[MAGIC_BEGIN_INFO.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_INFO.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_INFO))
{
AaruConsole.ErrorWriteLine("Cannot find info block");
return ErrorNumber.InvalidArgument;
}
// Skip info block and its checksum
stream.Seek(16384 + 4, SeekOrigin.Current);
hdrB = new byte[MAGIC_BEGIN_DATABLOCKS.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_DATABLOCKS.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_DATABLOCKS))
{
AaruConsole.ErrorWriteLine("Cannot find data blocks");
return ErrorNumber.InvalidArgument;
}
_dataOff = stream.Position;
AaruConsole.DebugWriteLine("Partimage plugin", "dataOff = {0}", _dataOff);
// Seek to tail
stream.Seek(-(Marshal.SizeOf<CMainTail>() + MAGIC_BEGIN_TAIL.Length), SeekOrigin.End);
hdrB = new byte[MAGIC_BEGIN_TAIL.Length];
stream.Read(hdrB, 0, MAGIC_BEGIN_TAIL.Length);
magic = StringHandlers.CToString(hdrB);
if(!magic.Equals(MAGIC_BEGIN_TAIL))
{
AaruConsole.ErrorWriteLine("Cannot find tail. Multiple volumes are not supported or image is corrupt.");
return ErrorNumber.InvalidArgument;
}
AaruConsole.DebugWriteLine("Partimage plugin", "Filling extents");
DateTime start = DateTime.Now;
_extents = new ExtentsULong();
_extentsOff = new Dictionary<ulong, ulong>();
bool current = (_bitmap[0] & (1 << (0 % 8))) != 0;
ulong blockOff = 0;
ulong extentStart = 0;
for(ulong i = 1; i <= localHeader.qwBlocksCount; i++)
{
bool next = (_bitmap[i / 8] & (1 << (int)(i % 8))) != 0;
// Flux
if(next != current)
if(next)
{
extentStart = i;
_extentsOff.Add(i, ++blockOff);
}
else
{
_extents.Add(extentStart, i);
_extentsOff.TryGetValue(extentStart, out ulong _);
}
if(next && current)
blockOff++;
current = next;
}
DateTime end = DateTime.Now;
AaruConsole.DebugWriteLine("Partimage plugin", "Took {0} seconds to fill extents",
(end - start).TotalSeconds);
_sectorCache = new Dictionary<ulong, byte[]>();
_imageInfo.CreationTime = dateCreate;
_imageInfo.LastModificationTime = imageFilter.LastWriteTime;
_imageInfo.MediaTitle = Path.GetFileNameWithoutExtension(imageFilter.Filename);
_imageInfo.Sectors = localHeader.qwBlocksCount + 1;
_imageInfo.SectorSize = (uint)localHeader.qwBlockSize;
_imageInfo.XmlMediaType = XmlMediaType.BlockMedia;
_imageInfo.MediaType = MediaType.GENERIC_HDD;
_imageInfo.Version = StringHandlers.CToString(_cMainHeader.szVersion);
_imageInfo.Comments = StringHandlers.CToString(_cMainHeader.szPartDescription);
_imageInfo.ImageSize =
(ulong)(stream.Length - (_dataOff + Marshal.SizeOf<CMainTail>() + MAGIC_BEGIN_TAIL.Length));
_imageStream = stream;
return ErrorNumber.NoError;
}
/// <inheritdoc />
public ErrorNumber ReadSector(ulong sectorAddress, out byte[] buffer)
{
buffer = null;
if(sectorAddress > _imageInfo.Sectors - 1)
return ErrorNumber.OutOfRange;
if((_bitmap[sectorAddress / 8] & (1 << (int)(sectorAddress % 8))) == 0)
{
buffer = new byte[_imageInfo.SectorSize];
return ErrorNumber.NoError;
}
if(_sectorCache.TryGetValue(sectorAddress, out buffer))
return ErrorNumber.NoError;
ulong blockOff = BlockOffset(sectorAddress);
// Offset of requested sector is:
// Start of data +
long imageOff = _dataOff +
// How many stored bytes to skip
(long)(blockOff * _imageInfo.SectorSize) +
// How many bytes of CRC blocks to skip
((long)(blockOff / (CHECK_FREQUENCY / _imageInfo.SectorSize)) * Marshal.SizeOf<CCheck>());
buffer = new byte[_imageInfo.SectorSize];
_imageStream.Seek(imageOff, SeekOrigin.Begin);
_imageStream.Read(buffer, 0, (int)_imageInfo.SectorSize);
if(_sectorCache.Count > MAX_CACHED_SECTORS)
_sectorCache.Clear();
_sectorCache.Add(sectorAddress, buffer);
return ErrorNumber.NoError;
}
/// <inheritdoc />
public ErrorNumber ReadSectors(ulong sectorAddress, uint length, out byte[] buffer)
{
buffer = null;
if(sectorAddress > _imageInfo.Sectors - 1)
return ErrorNumber.OutOfRange;
if(sectorAddress + length > _imageInfo.Sectors)
return ErrorNumber.OutOfRange;
var ms = new MemoryStream();
bool allEmpty = true;
for(uint i = 0; i < length; i++)
if((_bitmap[sectorAddress / 8] & (1 << (int)(sectorAddress % 8))) != 0)
{
allEmpty = false;
break;
}
if(allEmpty)
{
buffer = new byte[_imageInfo.SectorSize * length];
return ErrorNumber.NoError;
}
for(uint i = 0; i < length; i++)
{
ErrorNumber errno = ReadSector(sectorAddress + i, out byte[] sector);
if(errno != ErrorNumber.NoError)
return errno;
ms.Write(sector, 0, sector.Length);
}
buffer = ms.ToArray();
return ErrorNumber.NoError;
}
}
}