bad_block_map.hpp

1. Overview

The bad_block_map.hpp file tracks readable, damaged and slow byte ranges encountered while reading unstable 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 bad_block_map.cpp.

Primary responsibilities:

  • Record classified byte ranges
  • Merge overlapping or adjacent ranges
  • Query bad-range intersections
  • Return filtered range inventories

2. File Identity and Scope

  • Source path: src/bad_block_map.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 36
  • Non-empty lines: 28
  • SHA-256: fd996ba4761f0726d22a97a2eb7bd2428346e6d1f94c91cddb52cd3a09b589af

The declarations in this file use the global namespace.

3. Dependencies

3.2 Standard and External Headers

  • cstdint
  • 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 RangeState.
  • struct BlockRange.
  • class BadBlockMap.

4.1 Enumeration Values

RangeState defines:

  • Readable
  • Bad
  • Slow

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}
  • uint64_t length {0}
  • RangeState state {RangeState::Readable}
  • std::vector<BlockRange> ranges_

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:

  • void mark_readable(uint64_t offset,uint64_t length) – Updates the relevant collection or range state.
  • void mark_bad(uint64_t offset,uint64_t length) – Updates the relevant collection or range state.
  • void mark_slow(uint64_t offset,uint64_t length) – Updates the relevant collection or range state.
  • std::vector<BlockRange> readable_ranges()const – Implements the operation identified by this API and updates or returns the associated state.
  • std::vector<BlockRange> bad_ranges()const – Implements the operation identified by this API and updates or returns the associated state.
  • std::vector<BlockRange> slow_ranges()const – Implements the operation identified by this API and updates or returns the associated state.
  • bool is_known_bad(uint64_t offset,uint64_t length)const – Evaluates the stated condition and returns the corresponding Boolean result.
  • void merge_adjacent() – Updates the relevant collection or range state.
  • void mark(uint64_t offset,uint64_t length,RangeState state) – Implements the operation identified by this API and updates or returns the associated state.
  • std::vector<BlockRange> filtered(RangeState state)const – Implements the operation identified by this API and updates or returns the associated state.

8. Operational Flow

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

  1. Record classified byte ranges.
  2. Merge overlapping or adjacent ranges.
  3. Query bad-range intersections.
  4. Return filtered range inventories.
  5. Expose or execute the detected APIs: mark_readable, mark_bad, mark_slow, readable_ranges, bad_ranges, slow_ranges, is_known_bad, merge_adjacent, mark, filtered.
  6. Return explicit results, progress data, recovered records, or diagnostics to the calling layer.

9. Validation and Error Handling

  • Byte offsets, sizes and lengths must be validated before arithmetic and before every read to avoid overflow and out-of-bounds access.

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: