fault_tolerant_reader.hpp

1. Overview

The fault_tolerant_reader.hpp file wraps raw reads with retries, subdivision and bad-range tracking for damaged media.

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 fault_tolerant_reader.cpp.

Primary responsibilities:

  • Retry failed or slow reads
  • Split problematic ranges into smaller requests
  • Fill or skip unreadable regions according to policy
  • Update the bad-block map and diagnostics

2. File Identity and Scope

  • Source path: src/fault_tolerant_reader.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 58
  • Non-empty lines: 45
  • SHA-256: 76eb9790952f35850c64e8d636445f7b8a1218360bf712ed59e6e3640723ddf9

The declarations in this file use the global namespace.

3. Dependencies

3.1 Project Headers

  • bad_block_map.hpp
  • disk_reader.hpp

3.2 Standard and External Headers

  • cstddef
  • cstdint
  • functional
  • mutex
  • string

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

  • struct ReadResult.
  • struct FaultTolerantReaderConfig.
  • class FaultTolerantReader.

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:

  • bool success {false}
  • size_t bytes_read {0}
  • bool partial {false}
  • bool timeout {false}
  • std::string error
  • size_t initial_chunk_size {1024*1024}
  • size_t min_chunk_size {4096}
  • int max_retries {3}
  • bool mark_slow_ranges {true}
  • DiskReader reader_
  • FaultTolerantReaderConfig config_
  • CancelCallback cancel_cb_
  • BadBlockMap bad_map_
  • mutable std::mutex mutex_

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

The following callable interfaces or definitions were detected:

  • bool open(const std::string&path,std::string&error) – Manages the corresponding resource lifecycle or resets internal state.
  • void close() – Manages the corresponding resource lifecycle or resets internal state.
  • bool is_open()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • uint64_t size()const – Implements the operation identified by this API and updates or returns the associated state.
  • uint32_t logical_sector_size()const – Implements the operation identified by this API and updates or returns the associated state.
  • void set_config(const FaultTolerantReaderConfig&cfg) – Persists or exports the supplied state to the relevant destination.
  • void set_cancel_callback(CancelCallback cb) – Persists or exports the supplied state to the relevant destination.
  • ReadResult read_at(uint64_t offset,void*buffer,size_t size) – Reads or derives the requested information and returns or stores the decoded result.
  • ReadResult read_rescue(uint64_t offset,void*buffer,size_t size) – Reads or derives the requested information and returns or stores the decoded result.
  • ReadResult read_rescue_recursive(uint64_t offset,unsigned char*buffer,size_t size) – Reads or derives the requested information and returns or stores the decoded result.

8. Operational Flow

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

  1. Retry failed or slow reads.
  2. Split problematic ranges into smaller requests.
  3. Fill or skip unreadable regions according to policy.
  4. Update the bad-block map and diagnostics.
  5. Expose or execute the detected APIs: open, close, is_open, size, logical_sector_size, set_config, set_cancel_callback, read_at, read_rescue, read_rescue_recursive.
  6. 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

  • Concurrency: the file contains worker-thread or synchronization primitives; UI updates and shared state must remain thread-safe.
  • File descriptors and streams must be closed on success, cancellation and error paths.

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: