Files
Aaru/Aaru.Devices/Remote/Remote.cs

1944 lines
65 KiB
C#

// /***************************************************************************
// Aaru Data Preservation Suite
// ----------------------------------------------------------------------------
//
// Filename : Remote.cs
// Author(s) : Natalia Portillo <claunia@claunia.com>
//
// Component : Aaru Remote.
//
// --[ Description ] ----------------------------------------------------------
//
// Implementation of the Aaru Remote protocol.
//
// --[ 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-2025 Natalia Portillo
// ****************************************************************************/
// ReSharper disable MemberCanBeInternal
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Runtime.InteropServices;
using Aaru.CommonTypes.Enums;
using Aaru.CommonTypes.Interop;
using Aaru.Decoders.ATA;
using Aaru.Logging;
using Sentry;
using Marshal = Aaru.Helpers.Marshal;
using Version = Aaru.CommonTypes.Interop.Version;
namespace Aaru.Devices.Remote;
/// <inheritdoc />
/// <summary>Handles communication with a remote device that's connected using the AaruRemote protocol</summary>
public class Remote : IDisposable
{
readonly string _host;
readonly Socket _socket;
/// <summary>Connects using TCP/IP to the specified remote</summary>
/// <param name="uri">URI of the remote</param>
/// <exception cref="ArgumentException">Unsupported or invalid remote protocol.</exception>
/// <exception cref="SocketException">Host not found.</exception>
/// <exception cref="IOException">Network error.</exception>
public Remote(Uri uri)
{
if(uri.Scheme != "aaru" && uri.Scheme != "dic")
throw new ArgumentException(Localization.Invalid_remote_protocol, nameof(uri.Scheme));
_host = uri.DnsSafeHost;
if(!IPAddress.TryParse(_host, out IPAddress ipAddress))
{
IPHostEntry ipHostEntry = Dns.GetHostEntry(_host);
ipAddress =
ipHostEntry.AddressList.FirstOrDefault(static a => a.AddressFamily == AddressFamily.InterNetwork);
}
if(ipAddress is null)
{
AaruLogging.Error(Localization.Host_not_found);
throw new SocketException(11001);
}
var ipEndPoint = new IPEndPoint(ipAddress, uri.Port > 0 ? uri.Port : 6666);
_socket = new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp);
_socket.Connect(ipEndPoint);
AaruLogging.WriteLine(Localization.Connected_to_0, uri.Host);
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
int len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
throw new IOException();
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
throw new ArgumentException();
}
byte[] buf;
if(hdr.packetType != AaruPacketType.Hello)
{
if(hdr.packetType != AaruPacketType.Nop)
{
AaruLogging.Error(Localization.Expected_Hello_Packet_got_packet_type_0, hdr.packetType);
throw new ArgumentException();
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
throw new IOException();
}
AaruPacketNop nop = Marshal.ByteArrayToStructureLittleEndian<AaruPacketNop>(buf);
AaruLogging.Error($"{nop.reason}");
throw new ArgumentException();
}
if(hdr.version != Consts.PACKET_VERSION)
{
AaruLogging.Error(Localization.Unrecognized_packet_version);
throw new ArgumentException();
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
throw new IOException();
}
AaruPacketHello serverHello = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHello>(buf);
ServerApplication = serverHello.application;
ServerVersion = serverHello.version;
ServerOperatingSystem = serverHello.sysname;
ServerOperatingSystemVersion = serverHello.release;
ServerArchitecture = serverHello.machine;
ServerProtocolVersion = serverHello.maxProtocol;
var clientHello = new AaruPacketHello
{
application = "Aaru",
version = Version.GetInformationalVersion(),
maxProtocol = Consts.MAX_PROTOCOL,
sysname = DetectOS.GetPlatformName(DetectOS.GetRealPlatformID(), DetectOS.GetVersion()),
release = DetectOS.GetVersion(),
machine = RuntimeInformation.ProcessArchitecture.ToString(),
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketHello>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.Hello
}
};
buf = Marshal.StructureToByteArrayLittleEndian(clientHello);
len = _socket.Send(buf, SocketFlags.None);
if(len >= buf.Length) return;
AaruLogging.Error(Localization.Could_not_write_to_the_network);
throw new IOException();
}
/// <summary>Remote server application</summary>
public string ServerApplication { get; }
/// <summary>Remote server application version</summary>
public string ServerVersion { get; }
/// <summary>Remote server operating system</summary>
public string ServerOperatingSystem { get; }
/// <summary>Remote server operating system version</summary>
public string ServerOperatingSystemVersion { get; }
/// <summary>Remote server architecture</summary>
public string ServerArchitecture { get; }
/// <summary>Remote server protocol version</summary>
public int ServerProtocolVersion { get; }
/// <summary>Is remote running with administrative (aka root) privileges?</summary>
public bool IsRoot
{
get
{
var cmdPkt = new AaruPacketCmdAmIRoot
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdAmIRoot>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandAmIRoot
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.ResponseAmIRoot)
{
AaruLogging.Error(Localization.Remote_IsRoot_Expected_Am_I_Root_Response_Packet_got_packet_type_0,
hdr.packetType);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketResAmIRoot res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResAmIRoot>(buf);
return res.am_i_root != 0;
}
}
#region IDisposable Members
/// <inheritdoc />
public void Dispose() => Disconnect();
#endregion
/// <summary>Disconnects from remote</summary>
public void Disconnect()
{
try
{
_socket.Shutdown(SocketShutdown.Both);
_socket.Close();
}
catch(ObjectDisposedException ex)
{
// Ignore if already disposed
SentrySdk.CaptureException(ex);
}
}
/// <summary>Lists devices attached to remote</summary>
/// <returns>List of devices</returns>
public DeviceInfo[] ListDevices()
{
var cmdPkt = new AaruPacketCommandListDevices
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCommandListDevices>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandListDevices
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return [];
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return [];
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return [];
}
if(hdr.packetType != AaruPacketType.ResponseListDevices)
{
if(hdr.packetType != AaruPacketType.Nop)
{
AaruLogging.Error(Localization
.Remote_ListDevices_Expected_List_Devices_Response_Packet_got_packet_type_0,
hdr.packetType);
return [];
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return [];
}
AaruPacketNop nop = Marshal.ByteArrayToStructureLittleEndian<AaruPacketNop>(buf);
AaruLogging.Error($"{nop.reason}");
return [];
}
if(hdr.version != Consts.PACKET_VERSION)
{
AaruLogging.Error(Localization.Unrecognized_packet_version);
return [];
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return [];
}
AaruPacketResponseListDevices response =
Marshal.ByteArrayToStructureLittleEndian<AaruPacketResponseListDevices>(buf);
List<DeviceInfo> devices = [];
int offset = Marshal.SizeOf<AaruPacketResponseListDevices>();
int devInfoLen = Marshal.SizeOf<DeviceInfo>();
for(ushort i = 0; i < response.devices; i++)
{
DeviceInfo dev = Marshal.ByteArrayToStructureLittleEndian<DeviceInfo>(buf, offset, devInfoLen);
dev.Path = dev.Path[0] == '/' ? $"aaru://{_host}{dev.Path}" : $"aaru://{_host}/{dev.Path}";
devices.Add(dev);
offset += devInfoLen;
}
return devices.ToArray();
}
/// <summary>Opens the specified device path on the remote</summary>
/// <param name="devicePath">Device path</param>
/// <param name="lastError">Returned error</param>
/// <returns><c>true</c> if opened correctly, <c>false</c>otherwise</returns>
/// <exception cref="NotImplementedException">
/// Support for the specified device has not yet been implemented in the remote
/// application.
/// </exception>
public bool Open(string devicePath, out int lastError)
{
lastError = 0;
var cmdPkt = new AaruPacketCommandOpenDevice
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCommandOpenDevice>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandOpen
},
device_path = devicePath
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
lastError = -1;
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
lastError = -1;
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
lastError = -1;
return false;
}
if(hdr.packetType != AaruPacketType.Nop)
{
AaruLogging.Error(Localization.Remote_ListDevices_Expected_List_Devices_Response_Packet_got_packet_type_0,
hdr.packetType);
lastError = -1;
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
lastError = -1;
return false;
}
AaruPacketNop nop = Marshal.ByteArrayToStructureLittleEndian<AaruPacketNop>(buf);
switch(nop.reasonCode)
{
case AaruNopReason.OpenOk:
return true;
case AaruNopReason.NotImplemented:
throw new NotImplementedException($"{nop.reason}");
}
AaruLogging.Error($"{nop.reason}");
lastError = nop.errno;
return false;
}
/// <summary>Sends a SCSI command to the remote device</summary>
/// <returns>0 if no error occurred, otherwise, errno</returns>
/// <param name="cdb">SCSI CDB</param>
/// <param name="buffer">Buffer for SCSI command response</param>
/// <param name="senseBuffer">Buffer with the SCSI sense</param>
/// <param name="timeout">Timeout in seconds</param>
/// <param name="direction">SCSI command transfer direction</param>
/// <param name="duration">Time it took to execute the command in milliseconds</param>
/// <param name="sense">
/// <c>True</c> if SCSI command returned non-OK status and <paramref name="senseBuffer" /> contains
/// SCSI sense
/// </param>
public int SendScsiCommand(Span<byte> cdb, ref byte[] buffer, Span<byte> senseBuffer, uint timeout,
ScsiDirection direction, out double duration, out bool sense)
{
duration = 0;
sense = true;
var cmdPkt = new AaruPacketCmdScsi
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandScsi
},
direction = (int)direction,
timeout = timeout * 1000
};
if(cdb != null) cmdPkt.cdb_len = (uint)cdb.Length;
if(buffer != null) cmdPkt.buf_len = (uint)buffer.Length;
cmdPkt.hdr.len = (uint)(Marshal.SizeOf<AaruPacketCmdScsi>() + cmdPkt.cdb_len + cmdPkt.buf_len);
byte[] pktBuf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
var buf = new byte[cmdPkt.hdr.len];
Array.Copy(pktBuf, 0, buf, 0, Marshal.SizeOf<AaruPacketCmdScsi>());
if(cdb != null)
{
byte[] cdbArray = cdb.ToArray();
Array.Copy(cdbArray, 0, buf, Marshal.SizeOf<AaruPacketCmdScsi>(), cmdPkt.cdb_len);
}
if(buffer != null)
Array.Copy(buffer, 0, buf, Marshal.SizeOf<AaruPacketCmdScsi>() + cmdPkt.cdb_len, cmdPkt.buf_len);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return -1;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return -1;
}
if(hdr.packetType != AaruPacketType.ResponseScsi)
{
AaruLogging.Error(Localization.Expected_SCSI_Response_Packet_got_packet_type_0, hdr.packetType);
return -1;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketResScsi res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResScsi>(buf);
buf.AsSpan(Marshal.SizeOf<AaruPacketResScsi>(), (int)res.sense_len).CopyTo(senseBuffer);
buffer = new byte[res.buf_len];
Array.Copy(buf, Marshal.SizeOf<AaruPacketResScsi>() + res.sense_len, buffer, 0, res.buf_len);
duration = res.duration;
sense = res.sense != 0;
return (int)res.error_no;
}
/// <summary>Sends an ATA/ATAPI command to the remote device using CHS addressing</summary>
/// <returns>0 if no error occurred, otherwise, errno</returns>
/// <param name="registers">ATA registers.</param>
/// <param name="errorRegisters">Status/error registers.</param>
/// <param name="protocol">ATA Protocol.</param>
/// <param name="transferRegister">Indicates which register indicates the transfer length</param>
/// <param name="buffer">Buffer for ATA/ATAPI command response</param>
/// <param name="timeout">Timeout in seconds</param>
/// <param name="transferBlocks">
/// If set to <c>true</c>, transfer is indicated in blocks, otherwise, it is indicated in
/// bytes.
/// </param>
/// <param name="duration">Time it took to execute the command in milliseconds</param>
/// <param name="sense"><c>True</c> if ATA/ATAPI command returned non-OK status</param>
public int SendAtaCommand(AtaRegistersChs registers, out AtaErrorRegistersChs errorRegisters, AtaProtocol protocol,
AtaTransferRegister transferRegister, ref byte[] buffer, uint timeout,
bool transferBlocks, out double duration, out bool sense)
{
duration = 0;
sense = true;
errorRegisters = new AtaErrorRegistersChs();
var cmdPkt = new AaruPacketCmdAtaChs
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandAtaChs
},
registers = registers,
protocol = (byte)protocol,
transferRegister = (byte)transferRegister,
transferBlocks = transferBlocks,
timeout = timeout * 1000
};
if(buffer != null) cmdPkt.buf_len = (uint)buffer.Length;
cmdPkt.hdr.len = (uint)(Marshal.SizeOf<AaruPacketCmdAtaChs>() + cmdPkt.buf_len);
byte[] pktBuf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
var buf = new byte[cmdPkt.hdr.len];
Array.Copy(pktBuf, 0, buf, 0, Marshal.SizeOf<AaruPacketCmdAtaChs>());
if(buffer != null) Array.Copy(buffer, 0, buf, Marshal.SizeOf<AaruPacketCmdAtaChs>(), cmdPkt.buf_len);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return -1;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return -1;
}
if(hdr.packetType != AaruPacketType.ResponseAtaChs)
{
AaruLogging.Error(Localization.Expected_ATA_CHS_Response_Packet_got_packet_type_0, hdr.packetType);
return -1;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketResAtaChs res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResAtaChs>(buf);
buffer = new byte[res.buf_len];
Array.Copy(buf, Marshal.SizeOf<AaruPacketResAtaChs>(), buffer, 0, res.buf_len);
duration = res.duration;
sense = res.sense != 0;
errorRegisters = res.registers;
return (int)res.error_no;
}
/// <summary>Sends an ATA/ATAPI command to the remote device using 28-bit LBA addressing</summary>
/// <returns>0 if no error occurred, otherwise, errno</returns>
/// <param name="registers">ATA registers.</param>
/// <param name="errorRegisters">Status/error registers.</param>
/// <param name="protocol">ATA Protocol.</param>
/// <param name="transferRegister">Indicates which register indicates the transfer length</param>
/// <param name="buffer">Buffer for ATA/ATAPI command response</param>
/// <param name="timeout">Timeout in seconds</param>
/// <param name="transferBlocks">
/// If set to <c>true</c>, transfer is indicated in blocks, otherwise, it is indicated in
/// bytes.
/// </param>
/// <param name="duration">Time it took to execute the command in milliseconds</param>
/// <param name="sense"><c>True</c> if ATA/ATAPI command returned non-OK status</param>
public int SendAtaCommand(AtaRegistersLba28 registers, out AtaErrorRegistersLba28 errorRegisters,
AtaProtocol protocol, AtaTransferRegister transferRegister, ref byte[] buffer,
uint timeout, bool transferBlocks, out double duration, out bool sense)
{
duration = 0;
sense = true;
errorRegisters = new AtaErrorRegistersLba28();
var cmdPkt = new AaruPacketCmdAtaLba28
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandAtaLba28
},
registers = registers,
protocol = (byte)protocol,
transferRegister = (byte)transferRegister,
transferBlocks = transferBlocks,
timeout = timeout * 1000
};
if(buffer != null) cmdPkt.buf_len = (uint)buffer.Length;
cmdPkt.hdr.len = (uint)(Marshal.SizeOf<AaruPacketCmdAtaLba28>() + cmdPkt.buf_len);
byte[] pktBuf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
var buf = new byte[cmdPkt.hdr.len];
Array.Copy(pktBuf, 0, buf, 0, Marshal.SizeOf<AaruPacketCmdAtaLba28>());
if(buffer != null) Array.Copy(buffer, 0, buf, Marshal.SizeOf<AaruPacketCmdAtaLba28>(), cmdPkt.buf_len);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return -1;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return -1;
}
if(hdr.packetType != AaruPacketType.ResponseAtaLba28)
{
AaruLogging.Error(Localization.Expected_ATA_LBA28_Response_Packet_got_packet_type_0, hdr.packetType);
return -1;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketResAtaLba28 res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResAtaLba28>(buf);
buffer = new byte[res.buf_len];
Array.Copy(buf, Marshal.SizeOf<AaruPacketResAtaLba28>(), buffer, 0, res.buf_len);
duration = res.duration;
sense = res.sense != 0;
errorRegisters = res.registers;
return (int)res.error_no;
}
/// <summary>Sends an ATA/ATAPI command to the remote device using 48-bit LBA addressing</summary>
/// <returns>0 if no error occurred, otherwise, errno</returns>
/// <param name="registers">ATA registers.</param>
/// <param name="errorRegisters">Status/error registers.</param>
/// <param name="protocol">ATA Protocol.</param>
/// <param name="transferRegister">Indicates which register indicates the transfer length</param>
/// <param name="buffer">Buffer for ATA/ATAPI command response</param>
/// <param name="timeout">Timeout in seconds</param>
/// <param name="transferBlocks">
/// If set to <c>true</c>, transfer is indicated in blocks, otherwise, it is indicated in
/// bytes.
/// </param>
/// <param name="duration">Time it took to execute the command in milliseconds</param>
/// <param name="sense"><c>True</c> if ATA/ATAPI command returned non-OK status</param>
public int SendAtaCommand(AtaRegistersLba48 registers, out AtaErrorRegistersLba48 errorRegisters,
AtaProtocol protocol, AtaTransferRegister transferRegister, ref byte[] buffer,
uint timeout, bool transferBlocks, out double duration, out bool sense)
{
duration = 0;
sense = true;
errorRegisters = new AtaErrorRegistersLba48();
var cmdPkt = new AaruPacketCmdAtaLba48
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandAtaLba48
},
registers = registers,
protocol = (byte)protocol,
transferRegister = (byte)transferRegister,
transferBlocks = transferBlocks,
timeout = timeout * 1000
};
if(buffer != null) cmdPkt.buf_len = (uint)buffer.Length;
cmdPkt.hdr.len = (uint)(Marshal.SizeOf<AaruPacketCmdAtaLba48>() + cmdPkt.buf_len);
byte[] pktBuf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
var buf = new byte[cmdPkt.hdr.len];
Array.Copy(pktBuf, 0, buf, 0, Marshal.SizeOf<AaruPacketCmdAtaLba48>());
if(buffer != null) Array.Copy(buffer, 0, buf, Marshal.SizeOf<AaruPacketCmdAtaLba48>(), cmdPkt.buf_len);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return -1;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return -1;
}
if(hdr.packetType != AaruPacketType.ResponseAtaLba48)
{
AaruLogging.Error(Localization.Expected_ATA_LBA48_Response_Packet_got_packet_type_0, hdr.packetType);
return -1;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketResAtaLba48 res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResAtaLba48>(buf);
buffer = new byte[res.buf_len];
Array.Copy(buf, Marshal.SizeOf<AaruPacketResAtaLba48>(), buffer, 0, res.buf_len);
duration = res.duration;
sense = res.sense != 0;
errorRegisters = res.registers;
return (int)res.error_no;
}
/// <summary>Sends a MMC/SD command to the remote device</summary>
/// <returns>The result of the command.</returns>
/// <param name="command">MMC/SD opcode</param>
/// <param name="buffer">Buffer for MMC/SD command response</param>
/// <param name="timeout">Timeout in seconds</param>
/// <param name="duration">Time it took to execute the command in milliseconds</param>
/// <param name="sense"><c>True</c> if MMC/SD returned non-OK status</param>
/// <param name="write"><c>True</c> if data is sent from host to card</param>
/// <param name="isApplication"><c>True</c> if command should be preceded with CMD55</param>
/// <param name="flags">Flags indicating kind and place of response</param>
/// <param name="blocks">How many blocks to transfer</param>
/// <param name="argument">Command argument</param>
/// <param name="response">Response registers</param>
/// <param name="blockSize">Size of block in bytes</param>
public int SendMmcCommand(MmcCommands command, bool write, bool isApplication, MmcFlags flags, uint argument,
uint blockSize, uint blocks, ref byte[] buffer, out uint[] response, out double duration,
out bool sense, uint timeout = 0)
{
duration = 0;
sense = true;
response = null;
var cmdPkt = new AaruPacketCmdSdhci
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandSdhci
},
command = new AaruCmdSdhci
{
command = command,
write = write,
application = isApplication,
flags = flags,
argument = argument,
block_size = blockSize,
blocks = blocks,
timeout = timeout * 1000
}
};
if(buffer != null) cmdPkt.command.buf_len = (uint)buffer.Length;
cmdPkt.hdr.len = (uint)(Marshal.SizeOf<AaruPacketCmdSdhci>() + cmdPkt.command.buf_len);
byte[] pktBuf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
var buf = new byte[cmdPkt.hdr.len];
Array.Copy(pktBuf, 0, buf, 0, Marshal.SizeOf<AaruPacketCmdSdhci>());
if(buffer != null) Array.Copy(buffer, 0, buf, Marshal.SizeOf<AaruPacketCmdSdhci>(), cmdPkt.command.buf_len);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return -1;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return -1;
}
if(hdr.packetType != AaruPacketType.ResponseSdhci)
{
AaruLogging.Error(Localization.Expected_SDHCI_Response_Packet_got_packet_type_0, hdr.packetType);
return -1;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketResSdhci res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResSdhci>(buf);
buffer = new byte[res.res.buf_len];
Array.Copy(buf, Marshal.SizeOf<AaruPacketResSdhci>(), buffer, 0, res.res.buf_len);
duration = res.res.duration;
sense = res.res.sense != 0;
response = new uint[4];
response[0] = res.res.response[0];
response[1] = res.res.response[1];
response[2] = res.res.response[2];
response[3] = res.res.response[3];
return (int)res.res.error_no;
}
/// <summary>Gets the <see cref="DeviceType" /> for the remote device</summary>
/// <returns>
/// <see cref="DeviceType" />
/// </returns>
public DeviceType GetDeviceType()
{
var cmdPkt = new AaruPacketCmdGetDeviceType
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdGetDeviceType>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandGetType
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return DeviceType.Unknown;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return DeviceType.Unknown;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return DeviceType.Unknown;
}
if(hdr.packetType != AaruPacketType.ResponseGetType)
{
AaruLogging.Error(Localization.Expected_Device_Type_Response_Packet_got_packet_type_0, hdr.packetType);
return DeviceType.Unknown;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return DeviceType.Unknown;
}
AaruPacketResGetDeviceType res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResGetDeviceType>(buf);
return res.device_type;
}
/// <summary>Retrieves the SDHCI registers from the remote device</summary>
/// <param name="csd">CSD register</param>
/// <param name="cid">CID register</param>
/// <param name="ocr">OCR register</param>
/// <param name="scr">SCR register</param>
/// <returns><c>true</c> if the device is attached to an SDHCI controller, <c>false</c> otherwise</returns>
public bool GetSdhciRegisters(out byte[] csd, out byte[] cid, out byte[] ocr, out byte[] scr)
{
csd = null;
cid = null;
ocr = null;
scr = null;
var cmdPkt = new AaruPacketCmdGetSdhciRegisters
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdGetSdhciRegisters>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandGetSdhciRegisters
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.ResponseGetSdhciRegisters)
{
AaruLogging.Error(Localization.Expected_Device_Type_Response_Packet_got_packet_type_0, hdr.packetType);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketResGetSdhciRegisters res =
Marshal.ByteArrayToStructureLittleEndian<AaruPacketResGetSdhciRegisters>(buf);
if(res.csd_len > 0)
{
if(res.csd_len > 16) res.csd_len = 16;
csd = new byte[res.csd_len];
Array.Copy(res.csd, 0, csd, 0, res.csd_len);
}
if(res.cid_len > 0)
{
if(res.cid_len > 16) res.cid_len = 16;
cid = new byte[res.cid_len];
Array.Copy(res.cid, 0, cid, 0, res.cid_len);
}
if(res.ocr_len > 0)
{
if(res.ocr_len > 16) res.ocr_len = 16;
ocr = new byte[res.ocr_len];
Array.Copy(res.ocr, 0, ocr, 0, res.ocr_len);
}
switch(res.scr_len)
{
case <= 0:
return res.isSdhci;
case > 16:
res.scr_len = 16;
break;
}
scr = new byte[res.scr_len];
Array.Copy(res.scr, 0, scr, 0, res.scr_len);
return res.isSdhci;
}
/// <summary>Gets the USB data from the remote device</summary>
/// <param name="descriptors">USB descriptors</param>
/// <param name="idVendor">USB vendor ID</param>
/// <param name="idProduct">USB product ID</param>
/// <param name="manufacturer">USB manufacturer string</param>
/// <param name="product">USB product string</param>
/// <param name="serial">USB serial number string</param>
/// <returns><c>true</c> if the device is attached via USB, <c>false</c> otherwise</returns>
public bool GetUsbData(out byte[] descriptors, out ushort idVendor, out ushort idProduct, out string manufacturer,
out string product, out string serial)
{
descriptors = null;
idVendor = 0;
idProduct = 0;
manufacturer = null;
product = null;
serial = null;
var cmdPkt = new AaruPacketCmdGetUsbData
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdGetUsbData>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandGetUsbData
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.ResponseGetUsbData)
{
AaruLogging.Error(Localization.Expected_USB_Data_Response_Packet_got_packet_type_0, hdr.packetType);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketResGetUsbData res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResGetUsbData>(buf);
if(!res.isUsb) return false;
descriptors = new byte[res.descLen];
Array.Copy(res.descriptors, 0, descriptors, 0, res.descLen);
idVendor = res.idVendor;
idProduct = res.idProduct;
manufacturer = res.manufacturer;
product = res.product;
serial = res.serial;
return true;
}
/// <summary>Gets the FireWire data from the remote device</summary>
/// <param name="idVendor">FireWire vendor ID</param>
/// <param name="idProduct">FireWire product ID</param>
/// <param name="vendor">FireWire vendor string</param>
/// <param name="model">FireWire model string</param>
/// <param name="guid">FireWire GUID</param>
/// <returns><c>true</c> if the device is attached via FireWire, <c>false</c> otherwise</returns>
public bool GetFireWireData(out uint idVendor, out uint idProduct, out ulong guid, out string vendor,
out string model)
{
idVendor = 0;
idProduct = 0;
guid = 0;
vendor = null;
model = null;
var cmdPkt = new AaruPacketCmdGetFireWireData
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdGetFireWireData>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandGetFireWireData
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.ResponseGetFireWireData)
{
AaruLogging.Error(Localization.Expected_FireWire_Data_Response_Packet_got_packet_type_0, hdr.packetType);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketResGetFireWireData res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResGetFireWireData>(buf);
if(!res.isFireWire) return false;
idVendor = res.idVendor;
idProduct = res.idModel;
guid = res.guid;
vendor = res.vendor;
model = res.model;
return true;
}
/// <summary>Gets the PCMCIA/CardBus data from the remote device</summary>
/// <param name="cis">Card Information Structure</param>
/// <returns><c>true</c> if the device is attached via PCMCIA or CardBus, <c>false</c> otherwise</returns>
public bool GetPcmciaData(out byte[] cis)
{
cis = null;
var cmdPkt = new AaruPacketCmdGetPcmciaData
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdGetPcmciaData>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandGetPcmciaData
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.ResponseGetPcmciaData)
{
AaruLogging.Error(Localization.Expected_PCMCIA_Data_Response_Packet_got_packet_type_0, hdr.packetType);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketResGetPcmciaData res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResGetPcmciaData>(buf);
if(!res.isPcmcia) return false;
cis = res.cis;
return true;
}
/// <summary>Receives data from a socket into a buffer</summary>
/// <param name="socket">Socket</param>
/// <param name="buffer">Data buffer</param>
/// <param name="size">Expected total size in bytes</param>
/// <param name="socketFlags">Socket flags</param>
/// <returns>Retrieved number of bytes</returns>
static int Receive(Socket socket, byte[] buffer, int size, SocketFlags socketFlags)
{
var offset = 0;
while(size > 0)
{
int got = socket.Receive(buffer, offset, size, socketFlags);
if(got <= 0) break;
offset += got;
size -= got;
}
return offset;
}
/// <summary>Closes the remote device, without closing the network connection</summary>
public void Close()
{
var cmdPkt = new AaruPacketCmdClose
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdClose>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandCloseDevice
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
try
{
_socket.Send(buf, SocketFlags.None);
}
catch(ObjectDisposedException ex)
{
// Ignore if already disposed
SentrySdk.CaptureException(ex);
}
}
/// <summary>
/// Concatenates a queue of commands to be send to a remote SecureDigital or MultiMediaCard attached to an SDHCI
/// controller
/// </summary>
/// <param name="commands">List of commands</param>
/// <param name="duration">Duration to execute all commands, in milliseconds</param>
/// <param name="sense">Set to <c>true</c> if any of the commands returned an error status, <c>false</c> otherwise</param>
/// <param name="timeout">Maximum allowed time to execute a single command</param>
/// <returns>0 if no error occurred, otherwise, errno</returns>
public int SendMultipleMmcCommands(Devices.Device.MmcSingleCommand[] commands, out double duration, out bool sense,
uint timeout = 0)
{
if(ServerProtocolVersion < 2) return SendMultipleMmcCommandsV1(commands, out duration, out sense, timeout);
sense = false;
duration = 0;
long packetSize = Marshal.SizeOf<AaruPacketMultiCmdSdhci>() +
Marshal.SizeOf<AaruCmdSdhci>() * commands.LongLength;
packetSize =
commands.Aggregate(packetSize, static (current, command) => current + (command.buffer?.Length ?? 0));
var packet = new AaruPacketMultiCmdSdhci
{
cmd_count = (ulong)commands.LongLength,
hdr = new AaruPacketHeader
{
len = (uint)packetSize,
packetType = AaruPacketType.MultiCommandSdhci,
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
version = Consts.PACKET_VERSION
}
};
var buf = new byte[packetSize];
byte[] tmp = Marshal.StructureToByteArrayLittleEndian(packet);
Array.Copy(tmp, 0, buf, 0, tmp.Length);
int off = tmp.Length;
foreach(AaruCmdSdhci cmd in commands.Select(command => new AaruCmdSdhci
{
application = command.isApplication,
argument = command.argument,
block_size = command.blockSize,
blocks = command.blocks,
buf_len = (uint)(command.buffer?.Length ?? 0),
command = command.command,
flags = command.flags,
timeout = timeout,
write = command.write
}))
{
tmp = Marshal.StructureToByteArrayLittleEndian(cmd);
Array.Copy(tmp, 0, buf, off, tmp.Length);
off += tmp.Length;
}
foreach(Devices.Device.MmcSingleCommand command in commands.Where(static command =>
(command.buffer?.Length ?? 0) != 0))
{
Array.Copy(command.buffer, 0, buf, off, command.buffer.Length);
off += command.buffer.Length;
}
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return -1;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return -1;
}
if(hdr.packetType != AaruPacketType.ResponseMultiSdhci)
{
AaruLogging.Error(Localization.Expected_multi_MMC_SD_command_Response_Packet_got_packet_type_0,
hdr.packetType);
return -1;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return -1;
}
AaruPacketMultiCmdSdhci res = Marshal.ByteArrayToStructureLittleEndian<AaruPacketMultiCmdSdhci>(buf);
if(res.cmd_count != (ulong)commands.Length)
{
AaruLogging.Error(Localization.Expected_the_response_to_0_SD_MMC_commands_but_got_1_responses,
commands.Length,
res.cmd_count);
return -1;
}
off = Marshal.SizeOf<AaruPacketMultiCmdSdhci>();
var error = 0;
foreach(Devices.Device.MmcSingleCommand command in commands)
{
AaruResSdhci cmdRes =
Marshal.ByteArrayToStructureLittleEndian<AaruResSdhci>(buf, off, Marshal.SizeOf<AaruResSdhci>());
command.response = cmdRes.response;
duration += cmdRes.duration;
if(cmdRes.error_no != 0 && error == 0) error = (int)cmdRes.error_no;
if(cmdRes.sense != 0) sense = true;
if(cmdRes.buf_len > 0) command.buffer = new byte[cmdRes.buf_len];
off += Marshal.SizeOf<AaruResSdhci>();
}
foreach(Devices.Device.MmcSingleCommand command in commands)
{
Array.Copy(buf, off, command.buffer, 0, command.buffer.Length);
off += command.buffer.Length;
}
return error;
}
/// <summary>
/// Concatenates a queue of commands to be send to a remote SecureDigital or MultiMediaCard attached to an SDHCI
/// controller, using protocol version 1 without specific support for such a queueing
/// </summary>
/// <param name="commands">List of commands</param>
/// <param name="duration">Duration to execute all commands, in milliseconds</param>
/// <param name="sense">Set to <c>true</c> if any of the commands returned an error status, <c>false</c> otherwise</param>
/// <param name="timeout">Maximum allowed time to execute a single command</param>
/// <returns>0 if no error occurred, otherwise, errno</returns>
int SendMultipleMmcCommandsV1(Devices.Device.MmcSingleCommand[] commands, out double duration, out bool sense,
uint timeout)
{
sense = false;
duration = 0;
var error = 0;
foreach(Devices.Device.MmcSingleCommand command in commands)
{
error = SendMmcCommand(command.command,
command.write,
command.isApplication,
command.flags,
command.argument,
command.blockSize,
command.blocks,
ref command.buffer,
out command.response,
out double cmdDuration,
out bool cmdSense,
timeout);
if(cmdSense) sense = true;
duration += cmdDuration;
}
return error;
}
/// <summary>Closes then immediately reopens a remote device</summary>
/// <returns>Returned error number if any</returns>
public bool ReOpen()
{
if(ServerProtocolVersion < 2) return false;
var cmdPkt = new AaruPacketCmdReOpen
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdReOpen>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandReOpenDevice
}
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.Nop)
{
AaruLogging.Error(Localization.Expected_NOP_Packet_got_packet_type_0, hdr.packetType);
return false;
}
if(hdr.version != Consts.PACKET_VERSION)
{
AaruLogging.Error(Localization.Unrecognized_packet_version);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketNop nop = Marshal.ByteArrayToStructureLittleEndian<AaruPacketNop>(buf);
switch(nop.reasonCode)
{
case AaruNopReason.ReOpenOk:
return true;
case AaruNopReason.CloseError:
case AaruNopReason.OpenError:
AaruLogging.Error(Localization.ReOpen_error_closing_device);
break;
default:
AaruLogging.Error(Localization.ReOpen_error_0_with_reason_1, nop.errno, nop.reason);
break;
}
return false;
}
/// <summary>Reads data using operating system buffers.</summary>
/// <param name="buffer">Data buffer</param>
/// <param name="offset">Offset in remote device to start reading, in bytes</param>
/// <param name="length">Number of bytes to read</param>
/// <param name="duration">Total time in milliseconds the reading took</param>
/// <returns><c>true</c> if there was an error, <c>false</c> otherwise</returns>
public bool BufferedOsRead(out byte[] buffer, long offset, uint length, out double duration)
{
duration = 0;
buffer = null;
if(ServerProtocolVersion < 2) return false;
var cmdPkt = new AaruPacketCmdOsRead
{
hdr = new AaruPacketHeader
{
remote_id = Consts.REMOTE_ID,
packet_id = Consts.PACKET_ID,
len = (uint)Marshal.SizeOf<AaruPacketCmdOsRead>(),
version = Consts.PACKET_VERSION,
packetType = AaruPacketType.CommandOsRead
},
length = length,
offset = (ulong)offset
};
byte[] buf = Marshal.StructureToByteArrayLittleEndian(cmdPkt);
int len = _socket.Send(buf, SocketFlags.None);
if(len != buf.Length)
{
AaruLogging.Error(Localization.Could_not_write_to_the_network);
return false;
}
var hdrBuf = new byte[Marshal.SizeOf<AaruPacketHeader>()];
len = Receive(_socket, hdrBuf, hdrBuf.Length, SocketFlags.Peek);
if(len < hdrBuf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketHeader hdr = Marshal.ByteArrayToStructureLittleEndian<AaruPacketHeader>(hdrBuf);
if(hdr.remote_id != Consts.REMOTE_ID || hdr.packet_id != Consts.PACKET_ID)
{
AaruLogging.Error(Localization.Received_data_is_not_an_Aaru_Remote_Packet);
return false;
}
if(hdr.packetType != AaruPacketType.ResponseOsRead)
{
AaruLogging.Error(Localization.Expected_OS_Read_Response_Packet_got_packet_type_0, hdr.packetType);
return false;
}
if(hdr.version != Consts.PACKET_VERSION)
{
AaruLogging.Error(Localization.Unrecognized_packet_version);
return false;
}
buf = new byte[hdr.len];
len = Receive(_socket, buf, buf.Length, SocketFlags.None);
if(len < buf.Length)
{
AaruLogging.Error(Localization.Could_not_read_from_the_network);
return false;
}
AaruPacketResOsRead osRead = Marshal.ByteArrayToStructureLittleEndian<AaruPacketResOsRead>(buf);
duration = osRead.duration;
if(osRead.errno != 0)
{
AaruLogging.Error(Localization.Remote_error_0_in_OS_Read, osRead.errno);
return false;
}
buffer = new byte[length];
Array.Copy(buf, Marshal.SizeOf<AaruPacketResOsRead>(), buffer, 0, length);
return true;
}
}