diagnostics/cros_healthd/fetchers/storage/device_info.h

// Copyright 2020 The Chromium OS Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef DIAGNOSTICS_CROS_HEALTHD_FETCHERS_STORAGE_DEVICE_INFO_H_
#define DIAGNOSTICS_CROS_HEALTHD_FETCHERS_STORAGE_DEVICE_INFO_H_

#include <cstdint>
#include <memory>
#include <string>

#include <base/files/file_path.h>
#include <base/optional.h>

#include "diagnostics/common/statusor.h"
#include "diagnostics/cros_healthd/fetchers/storage/disk_iostat.h"
#include "diagnostics/cros_healthd/fetchers/storage/platform.h"
#include "diagnostics/cros_healthd/fetchers/storage/storage_device_adapter.h"
#include "diagnostics/cros_healthd/utils/error_utils.h"
#include "mojo/cros_healthd_probe.mojom.h"

namespace diagnostics {

// StorageDeviceInfo encapsulates the logic for retrieving info about an
// individual storage device. Should not leave longer than its parent
// StorageDeviceManager.
class StorageDeviceInfo {
 public:
  static std::unique_ptr<StorageDeviceInfo> Create(
      const base::FilePath& dev_sys_path,
      const base::FilePath& dev_node_path,
      const std::string& subsystem,
      chromeos::cros_healthd::mojom::StorageDevicePurpose purpose,
      const Platform* platform);

  // PopulateDeviceInfo fills the fields of Mojo's data structure representing
  // a block device. It is responsible for population of most of the info.
  Status PopulateDeviceInfo(
      chromeos::cros_healthd::mojom::NonRemovableBlockDeviceInfo* output_info);

  // PopulateLegaceInfo fills the fields of Mojo's data structure representing
  // a block device. It is responsible for population of fields which are kept
  // for compatibility with the existing applications and will be gradually
  // replaced.
  void PopulateLegacyFields(
      chromeos::cros_healthd::mojom::NonRemovableBlockDeviceInfo* output_info);

 private:
  const base::FilePath dev_sys_path_;
  const base::FilePath dev_node_path_;
  const std::string subsystem_;
  const chromeos::cros_healthd::mojom::StorageDevicePurpose purpose_;
  const std::unique_ptr<const StorageDeviceAdapter> adapter_;
  // platform_ is owned by the StorageDeviceManager.
  const Platform* platform_;

  DiskIoStat iostat_;

  StorageDeviceInfo(const base::FilePath& dev_sys_path,
                    const base::FilePath& dev_node_path,
                    const std::string& subsystem,
                    chromeos::cros_healthd::mojom::StorageDevicePurpose purpose,
                    std::unique_ptr<StorageDeviceAdapter> adapter,
                    const Platform* platform);
  StorageDeviceInfo(const StorageDeviceInfo&) = delete;
  StorageDeviceInfo(StorageDeviceInfo&&) = delete;
  StorageDeviceInfo& operator=(const StorageDeviceInfo&) = delete;
  StorageDeviceInfo& operator=(StorageDeviceInfo&&) = delete;
};

}  // namespace diagnostics

#endif  // DIAGNOSTICS_CROS_HEALTHD_FETCHERS_STORAGE_DEVICE_INFO_H_