ReLibreHardwareMonitor/Hardware/HDD/ATAStorage.cs

// Mozilla Public License 2.0
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// Copyright (C) LibreHardwareMonitor and Contributors
// All Rights Reserved

using System;
using System.Collections.Generic;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Reflection;
using System.Text;
using OpenHardwareMonitor.Interop;

namespace OpenHardwareMonitor.Hardware.HDD {
  public abstract class ATAStorage : AbstractStorage {
    // array of all harddrive types, matching type is searched in this order
    private static readonly Type[] hddTypes = { typeof(SSDPlextor), typeof(SSDIntel), typeof(SSDSandforce), typeof(SSDIndilinx), typeof(SSDSamsung), typeof(SSDMicron), typeof(GenericHarddisk) };

    private readonly ISmart smart;
    private readonly List<SmartAttribute> smartAttributes;
    private IDictionary<SmartAttribute, Sensor> sensors;

    /// <summary>
    /// Gets the SMART data.
    /// </summary>
    public ISmart Smart => smart;

    /// <summary>
    /// Gets the SMART attributes.
    /// </summary>
    public IReadOnlyList<SmartAttribute> SmartAttributes => smartAttributes;

    internal ATAStorage(StorageInfo storageInfo, ISmart smart, string name, string firmwareRevision, string id, int index, IEnumerable<SmartAttribute> smartAttributes, ISettings settings)
      : base(storageInfo, name, firmwareRevision, id, index, settings) {
      this.smart = smart;
      if (smart.IsValid)
        smart.EnableSmart();
      
      this.smartAttributes = new List<SmartAttribute>(smartAttributes);
      CreateSensors();
    }

    internal static AbstractStorage CreateInstance(StorageInfo info, ISettings settings) {
      ISmart smart = new WindowsSmart(info.Index);
      string name = null;
      string firmwareRevision = null;
      Kernel32.SMART_ATTRIBUTE[] values = { };

      if (smart.IsValid) {
        bool nameValid = smart.ReadNameAndFirmwareRevision(out name, out firmwareRevision);
        bool smartEnabled = smart.EnableSmart();

        if (smartEnabled)
          values = smart.ReadSmartData();

        if (!nameValid) {
          name = null;
          firmwareRevision = null;
        }
      } else {
        string[] logicalDrives = WindowsStorage.GetLogicalDrives(info.Index);
        if (logicalDrives == null || logicalDrives.Length == 0) {
          smart.Close();
          return null;
        }

        bool hasNonZeroSizeDrive = false;
        foreach (string logicalDrive in logicalDrives) {
          try {
            var di = new DriveInfo(logicalDrive);
            if (di.TotalSize > 0) {
              hasNonZeroSizeDrive = true;
              break;
            }
          } catch (ArgumentException) { } catch (IOException) { } catch (UnauthorizedAccessException) { }
        }

        if (!hasNonZeroSizeDrive) {
          smart.Close();
          return null;
        }
      }

      if (string.IsNullOrEmpty(name))
        name = string.IsNullOrEmpty(info.Name) ? "Generic Hard Disk" : info.Name;

      if (string.IsNullOrEmpty(firmwareRevision))
        firmwareRevision = string.IsNullOrEmpty(info.Revision) ? "Unknown" : info.Revision;

      foreach (Type type in hddTypes) {
        // get the array of name prefixes for the current type
        var namePrefixes = type.GetCustomAttributes(typeof(NamePrefixAttribute), true) as NamePrefixAttribute[];

        // get the array of the required SMART attributes for the current type
        var requiredAttributes = type.GetCustomAttributes(typeof(RequireSmartAttribute), true) as RequireSmartAttribute[];

        // check if all required attributes are present
        bool allRequiredAttributesFound = true;
        foreach (var requireAttribute in requiredAttributes) {
          bool attributeFound = false;
          foreach (Kernel32.SMART_ATTRIBUTE value in values) {
            if (value.Id == requireAttribute.AttributeId) {
              attributeFound = true;
              break;
            }
          }

          if (!attributeFound) {
            allRequiredAttributesFound = false;
            break;
          }
        }

        // if an attribute is missing, then try the next type
        if (!allRequiredAttributesFound)
          continue;


        // check if there is a matching name prefix for this type
        foreach (NamePrefixAttribute prefix in namePrefixes) {
          if (name.StartsWith(prefix.Prefix, StringComparison.InvariantCulture)) {
            var flags = BindingFlags.NonPublic | BindingFlags.Public | BindingFlags.Instance;
            return Activator.CreateInstance(type, flags, null, new object[] { info, smart, name, firmwareRevision, info.Index, settings }, null) as ATAStorage;
          }
        }
      }

      // no matching type has been found
      smart.Close();
      return null;
    }

    protected sealed override void CreateSensors() {
      sensors = new Dictionary<SmartAttribute, Sensor>();

      if (smart.IsValid) {
        var smartIds = smart.ReadSmartData().Select(attrValue => attrValue.Id);

        // unique attributes by SensorType and SensorChannel.
        var uniqueAttributes = smartAttributes
                              .Where(a => a.SensorType.HasValue && smartIds.Contains(a.Identifier))
                              .GroupBy(a => new { a.SensorType.Value, a.SensorChannel })
                              .Select(g => g.First());

        sensors = uniqueAttributes.ToDictionary(attr => attr,
                                                attr => new Sensor(attr.SensorName,
                                                                   attr.SensorChannel,
                                                                   attr.DefaultHiddenSensor,
                                                                   attr.SensorType.Value,
                                                                   this,
                                                                   attr.ParameterDescriptions,
                                                                   settings));

        foreach (var sensor in sensors) {
          ActivateSensor(sensor.Value);
        }
      }

      base.CreateSensors();
    }

    protected virtual void UpdateAdditionalSensors(Kernel32.SMART_ATTRIBUTE[] values) { }

    protected override void UpdateSensors() {
      if (smart.IsValid) {
        Kernel32.SMART_ATTRIBUTE[] values = smart.ReadSmartData();

        foreach (KeyValuePair<SmartAttribute, Sensor> keyValuePair in sensors) {
          SmartAttribute attribute = keyValuePair.Key;
          foreach (Kernel32.SMART_ATTRIBUTE value in values) {
            if (value.Id == attribute.Identifier) {
              Sensor sensor = keyValuePair.Value;
              sensor.Value = attribute.ConvertValue(value, sensor.Parameters);
            }
          }
        }

        UpdateAdditionalSensors(values);
      }
    }

    protected override void GetReport(StringBuilder r) {
      if (smart.IsValid) {
        Kernel32.SMART_ATTRIBUTE[] values = smart.ReadSmartData();
        Kernel32.SMART_THRESHOLD[] thresholds = smart.ReadSmartThresholds();

        if (values.Length > 0) {
          r.AppendFormat(CultureInfo.InvariantCulture,
                         " {0}{1}{2}{3}{4}{5}{6}{7}",
                         "Id".PadRight(3),
                         "Description".PadRight(35),
                         "Raw Value".PadRight(13),
                         "Worst".PadRight(6),
                         "Value".PadRight(6),
                         "Threshold".PadRight(6),
                         "Physical".PadRight(8),
                         Environment.NewLine);

          foreach (Kernel32.SMART_ATTRIBUTE value in values) {
            if (value.Id == 0x00)
              break;


            byte? threshold = null;
            foreach (Kernel32.SMART_THRESHOLD t in thresholds) {
              if (t.Id == value.Id) {
                threshold = t.Threshold;
              }
            }

            string description = "Unknown";
            float? physical = null;
            foreach (SmartAttribute a in smartAttributes) {
              if (a.Identifier == value.Id) {
                description = a.Name;
                if (a.HasRawValueConversion | a.SensorType.HasValue)
                  physical = a.ConvertValue(value, null);
                else
                  physical = null;
              }
            }

            string raw = BitConverter.ToString(value.RawValue);
            r.AppendFormat(CultureInfo.InvariantCulture,
                           " {0}{1}{2}{3}{4}{5}{6}{7}",
                           value.Id.ToString("X2").PadRight(3),
                           description.PadRight(35),
                           raw.Replace("-", "").PadRight(13),
                           value.WorstValue.ToString(CultureInfo.InvariantCulture).PadRight(6),
                           value.CurrentValue.ToString(CultureInfo.InvariantCulture).PadRight(6),
                           (threshold.HasValue
                             ? threshold.Value.ToString(CultureInfo.InvariantCulture)
                             : "-").PadRight(6),
                           (physical.HasValue ? physical.Value.ToString(CultureInfo.InvariantCulture) : "-").PadRight(8),
                           Environment.NewLine);
          }

          r.AppendLine();
        }
      }
    }

    protected static float RawToInt(byte[] raw, byte value, IReadOnlyList<IParameter> parameters) {
      return (raw[3] << 24) | (raw[2] << 16) | (raw[1] << 8) | raw[0];
    }

    public override void Close() {
      smart.Close();
      base.Close();
    }
  }
}