xfs_inode.hpp

1. Overview

The xfs_inode.hpp file parses XFS inode cores, forks, extents and attributes.

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

Primary responsibilities:

  • Decode inode metadata
  • Resolve data-fork formats
  • Read extent lists and B-tree roots
  • Expose file size, type and timestamps

2. File Identity and Scope

  • Source path: src/xfs_inode.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 199
  • Non-empty lines: 180
  • SHA-256: 40a0659be5f26791f233c690ee823d303d5161112938d44cd96f3c93d3defe8d

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 DinodeCore.
  • struct Extent.

5. Constants and Configuration Values

  • constexpr uint8_t XFS_DINODE_FMT_DEV=0
  • constexpr uint8_t XFS_DINODE_FMT_LOCAL=1
  • constexpr uint8_t XFS_DINODE_FMT_EXTENTS=2
  • constexpr uint8_t XFS_DINODE_FMT_BTREE=3
  • constexpr uint8_t XFS_DINODE_FMT_UUID=4
  • constexpr uint16_t MODE_TYPE_MASK=0xF000
  • constexpr uint16_t MODE_IFREG=0x8000
  • constexpr uint16_t MODE_IFDIR=0x4000
  • constexpr uint16_t MODE_IFLNK=0xA000
  • constexpr uint16_t MODE_IFCHR=0x2000
  • constexpr uint16_t MODE_IFBLK=0x6000
  • constexpr uint16_t MODE_IFIFO=0x1000
  • constexpr uint16_t MODE_IFSOCK=0xC000
  • constexpr uint16_t XFS_DINODE_MAGIC_BE=0x494E

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_DINODE_FMT_DEV=0
  • constexpr uint8_t XFS_DINODE_FMT_LOCAL=1
  • constexpr uint8_t XFS_DINODE_FMT_EXTENTS=2
  • constexpr uint8_t XFS_DINODE_FMT_BTREE=3
  • constexpr uint8_t XFS_DINODE_FMT_UUID=4
  • constexpr uint16_t MODE_TYPE_MASK=0xF000
  • constexpr uint16_t MODE_IFREG=0x8000
  • constexpr uint16_t MODE_IFDIR=0x4000
  • constexpr uint16_t MODE_IFLNK=0xA000
  • constexpr uint16_t MODE_IFCHR=0x2000
  • constexpr uint16_t MODE_IFBLK=0x6000
  • constexpr uint16_t MODE_IFIFO=0x1000
  • constexpr uint16_t MODE_IFSOCK=0xC000
  • constexpr uint16_t XFS_DINODE_MAGIC_BE=0x494E
  • uint16_t magic {0}
  • uint16_t mode {0}
  • uint8_t version {0}
  • uint8_t format {0}
  • uint32_t uid {0}
  • uint32_t gid {0}
  • uint32_t nlink {0}
  • int64_t size {0}
  • uint64_t nblocks {0}
  • uint32_t nextents {0}
  • uint16_t anextents {0}
  • uint8_t forkoff {0}
  • uint8_t aformat {0}
  • uint16_t flags {0}
  • uint32_t gen {0}
  • uint64_t ino {0}
  • uint64_t flags2 {0}
  • const uint16_t t=mode&MODE_TYPE_MASK
  • uint64_t logical_off_blocks {0}
  • uint64_t physical_block {0}
  • uint32_t length_blocks {0}
  • bool unwritten {false}

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 is_v3()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • bool is_dir()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • bool is_reg()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • bool is_symlink()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • bool is_special()const – Evaluates the stated condition and returns the corresponding Boolean result.
  • bool parse_dinode_core(const unsigned char*buf,DinodeCore&out) – Reads or derives the requested information and returns or stores the decoded result.
  • inline uint32_t dinode_data_fork_offset(const DinodeCore&core) – Implements the operation identified by this API and updates or returns the associated state.
  • uint32_t dinode_data_fork_length(const DinodeCore&core,uint32_t inode_size) – Implements the operation identified by this API and updates or returns the associated state.
  • void decode_extent_record(const unsigned char*buf16,Extent&out) – Reads or derives the requested information and returns or stores the decoded result.
  • uint64_t fsb_to_disk_offset(uint64_t fsb,const VolumeContext&vol) – Implements the operation identified by this API and updates or returns the associated state.
  • bool decode_extents_inline(const unsigned char*data_fork_buf,uint32_t nextents,uint32_t max_bytes,std::vector<Extent>&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. Decode inode metadata.
  2. Resolve data-fork formats.
  3. Read extent lists and B-tree roots.
  4. Expose file size, type and timestamps.
  5. Expose or execute the detected APIs: is_v3, is_dir, is_reg, is_symlink, is_special, parse_dinode_core, dinode_data_fork_offset, dinode_data_fork_length, decode_extent_record, fsb_to_disk_offset, decode_extents_inline.
  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.
  • 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: