xfs_dir.hpp

1. Overview

The xfs_dir.hpp file decodes XFS shortform, block and leaf directory formats.

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

Primary responsibilities:

  • Read directory entries
  • Resolve inode numbers and names
  • Validate directory structures
  • Support recovered path reconstruction

2. File Identity and Scope

  • Source path: src/xfs_dir.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 135
  • Non-empty lines: 121
  • SHA-256: 8e7372e96aab2db3402765c4cbb435b0ee0d09cc50dbdb8b83ae61c3593809c5

Declared namespaces:

  • xfs

3. Dependencies

3.1 Project Headers

  • xfs_format.hpp

3.2 Standard and External Headers

  • cstdint
  • 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

  • struct DirEntry.
  • struct ShortformDir.

5. Constants and Configuration Values

  • constexpr uint8_t XFS_DIR3_FT_UNKNOWN=0
  • constexpr uint8_t XFS_DIR3_FT_REG_FILE=1
  • constexpr uint8_t XFS_DIR3_FT_DIR=2
  • constexpr uint8_t XFS_DIR3_FT_CHRDEV=3
  • constexpr uint8_t XFS_DIR3_FT_BLKDEV=4
  • constexpr uint8_t XFS_DIR3_FT_FIFO=5
  • constexpr uint8_t XFS_DIR3_FT_SOCK=6
  • constexpr uint8_t XFS_DIR3_FT_SYMLINK=7
  • constexpr uint32_t XFS_DIR2_BLOCK_MAGIC=0x58443242u
  • constexpr uint32_t XFS_DIR3_BLOCK_MAGIC=0x58444233u
  • constexpr uint32_t XFS_DIR2_DATA_MAGIC=0x58443244u
  • constexpr uint32_t XFS_DIR3_DATA_MAGIC=0x58444433u
  • constexpr uint16_t XFS_DIR2_DATA_FREE_TAG=0xFFFFu

5.1 Operational Strings, Paths, Formats, or Commands

The following code literals are operationally relevant and may identify filesystem paths, helper commands, formats, signatures, or subsystem labels:

  • xfs_format.hpp

6. Data Members and Persistent State

The interface declares the following state-bearing members:

  • constexpr uint8_t XFS_DIR3_FT_UNKNOWN=0
  • constexpr uint8_t XFS_DIR3_FT_REG_FILE=1
  • constexpr uint8_t XFS_DIR3_FT_DIR=2
  • constexpr uint8_t XFS_DIR3_FT_CHRDEV=3
  • constexpr uint8_t XFS_DIR3_FT_BLKDEV=4
  • constexpr uint8_t XFS_DIR3_FT_FIFO=5
  • constexpr uint8_t XFS_DIR3_FT_SOCK=6
  • constexpr uint8_t XFS_DIR3_FT_SYMLINK=7
  • constexpr uint32_t XFS_DIR2_BLOCK_MAGIC=0x58443242u
  • constexpr uint32_t XFS_DIR3_BLOCK_MAGIC=0x58444233u
  • constexpr uint32_t XFS_DIR2_DATA_MAGIC=0x58443244u
  • constexpr uint32_t XFS_DIR3_DATA_MAGIC=0x58444433u
  • constexpr uint16_t XFS_DIR2_DATA_FREE_TAG=0xFFFFu
  • std::string name
  • uint64_t ino {0}
  • uint8_t ftype {XFS_DIR3_FT_UNKNOWN}
  • bool ftype_valid {false}
  • uint64_t parent_ino {0}
  • std::vector<DirEntry> entries

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 parse_shortform_dir(const unsigned char*data,uint32_t data_len,bool has_ftype,ShortformDir&out) – Reads or derives the requested information and returns or stores the decoded result.
  • bool parse_dir_data_block(const unsigned char*block_buf,uint32_t block_size,bool is_v5,bool has_ftype,bool accept_block_magic,bool accept_data_magic,std::vector<DirEntry>&out) – 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. Read directory entries.
  2. Resolve inode numbers and names.
  3. Validate directory structures.
  4. Support recovered path reconstruction.
  5. Expose or execute the detected APIs: parse_shortform_dir, parse_dir_data_block.
  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.
  • On-disk structures are accepted only after validating signatures, magic values and structural constraints.

10. Runtime, Concurrency, and Resource Management

  • Error handling: explicit error, exception or optional-result paths are present and form part of the file contract.

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.
  • Recovered names and destination paths must be sanitized to prevent directory traversal and accidental overwrite outside the selected export directory.

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: