device_health_probe.hpp

1. Overview

The device_health_probe.hpp file collects storage-device health information before recovery or imaging operations.

This is an interface and data-contract file. It declares the public and internal types used by this subsystem, allowing implementation files and callers to share a stable compile-time contract.

Its paired source or interface file is device_health_probe.cpp.

Primary responsibilities:

  • Query SMART or kernel health data
  • Classify device condition and risk
  • Return diagnostic messages
  • Support safer recovery decisions

2. File Identity and Scope

  • Source path: src/device_health_probe.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 47
  • Non-empty lines: 41
  • SHA-256: baffe410d27048e72cda975949a4a67fec97d6838086fba935d76b241dc91cd9

The declarations in this file use the global namespace.

3. Dependencies

3.2 Standard and External Headers

  • cstdint
  • functional
  • string
  • vector

These dependencies define the file’s compile-time integration with the recovery engine, GTK interface, on-disk format decoders, operating-system services, or C++ standard library.

4. Declared Types

  • enum class DeviceHealthState.
  • struct DeviceProbeSample.
  • struct DeviceHealthReport.
  • class DeviceHealthProbe.

4.1 Enumeration Values

DeviceHealthState defines:

  • Healthy
  • ReadableWithErrors
  • PartiallyReadable
  • EnumeratedButUnstable
  • NotReadable

5. Constants and Configuration Values

No preprocessor or compile-time constants were detected as top-level declarations in this file.

6. Data Members and Persistent State

The interface declares the following state-bearing members:

  • uint64_t offset {0}
  • size_t size {0}
  • bool success {false}
  • bool timeout {false}
  • std::string error
  • uint64_t latency_ms {0}
  • std::string device_path
  • uint64_t total_size {0}
  • uint32_t logical_sector_size {512}
  • bool open_ok {false}
  • bool read_lba0_ok {false}
  • bool read_tail_ok {false}
  • bool intermittent_failures {false}
  • bool size_suspicious {false}
  • bool unstable_latency {false}
  • DeviceHealthState state {DeviceHealthState::NotReadable}
  • std::vector<DeviceProbeSample> samples
  • std::string summary
  • CancelCallback cancel_cb={})

These members hold configuration, parser context, UI widgets, source references, progress state, recovered metadata, or temporary resources according to the owning type.

7. API and Function Inventory

No standalone function declaration or definition was detected. The file may consist primarily of structures, constants, templates, aliases, or embedded data.

8. Operational Flow

The subsystem represented by this file normally participates in the following flow:

  1. Query SMART or kernel health data.
  2. Classify device condition and risk.
  3. Return diagnostic messages.
  4. Support safer recovery decisions.
  5. Return explicit results, progress data, recovered records, or diagnostics to the calling layer.

9. Validation and Error Handling

  • Errors are propagated through Boolean results, error strings, logs, exceptions, or status records depending on the API.
  • Byte offsets, sizes and lengths must be validated before arithmetic and before every read to avoid overflow and out-of-bounds access.
  • Input and output paths require existence checks, permission handling and safe destination construction.

10. Runtime, Concurrency, and Resource Management

  • Deterministic behavior: callers depend on explicit return values and stable data structures to distinguish successful recovery from partial or invalid results.

11. Security and Data-Recovery Considerations

  • Recovery code should prefer read-only source access and avoid writing to the original damaged medium.
  • Raw devices and image files are treated as untrusted binary input; every offset and length must remain bounded by the source size.

12. Implementation Considerations

  • Changes to public declarations can affect every translation unit that includes this header and should preserve binary and source compatibility where required.
  • State-bearing members should have explicit ownership and initialization semantics, especially for references, pointers, file descriptors and GTK widgets.
  • Large-device arithmetic uses 64-bit values; additions and multiplications should be checked before use as offsets or allocation sizes.

13. Integration with the Recovery Pipeline

  • The file belongs to the source-discovery, parsing or support layer.
  • Its results feed scanner, recovery or reporting modules through shared models.
  • The API should remain deterministic so higher layers can combine results safely.

14. Licensing and Provenance

No explicit copyright or software-license statement was detected in the opening section of this individual file. Distribution terms should therefore be verified against the project-level license and repository metadata.

The SHA-256 value in this document can be used to associate the generated documentation with the exact source version analyzed.

Published on:
Last updated on: