libxfs

package module

Go to main page

Versions in this module

v0

v0.3.1

Aug 9, 2026

Changes in this version

+ type AllocatedInodeSource = string

+ const InodeSourceChunkScan

+ const InodeSourceInodeBtree

+ const InodeSourceMixed

+ type AllocationGroupInodeCounts struct

+ AGICount uint32

+ AGIFreeCount uint32

+ Allocated uint64

+ AllocationGroup uint32

+ BackedSlots uint64

+ Balanced bool

+ Chunks int

+ Free uint64

+ Source AllocatedInodeSource

+ type InodeChunk struct

+ AllocationGroup uint32

+ Count uint8

+ FreeCount uint32

+ FreeMask uint64

+ HoleMask uint16

+ RelativeStartInode uint32

+ StartInode uint64

+ func (c InodeChunk) AllocatedCount() int

+ func (c InodeChunk) AllocatedInodes(dst []uint64) []uint64

+ func (c InodeChunk) InodeNumber(slot int) uint64

+ func (c InodeChunk) IsAllocated(slot int) bool

+ func (c InodeChunk) IsFree(slot int) bool

+ func (c InodeChunk) IsHole(slot int) bool

+ type InodeClass = string

+ const InodeClassMetadata

+ const InodeClassReachable

+ const InodeClassUnlinked

+ const InodeClassUnreferenced

+ type InodeCompletenessOptions struct

+ Enumeration InodeEnumerationOptions

+ MaxOrphans int

+ MaxWalkEntries int

+ RootPath string

+ SkipOrphanDetails bool

+ SkipOrphanedDirectoryDescent bool

+ type InodeCompletenessReport struct

+ AllocationGroupAllocated uint64

+ AllocationGroupCount uint64

+ AllocationGroupFree uint64

+ Anomalies []ReportAnomaly

+ Balanced bool

+ ClassifiedInodes uint64

+ EnumeratedAllocated uint64

+ GeneratedAt time.Time

+ MetadataInodes uint64

+ Orphans []RecoverableInode

+ OrphansTruncated bool

+ PerAllocationGroup []AllocationGroupInodeCounts

+ ReachableInodes uint64

+ RootPath string

+ Source AllocatedInodeSource

+ SuperblockAllocated uint64

+ SuperblockIcount uint64

+ SuperblockIfree uint64

+ SuperblockLazy bool

+ UnlinkedInodes uint64

+ UnreferencedInodes uint64

+ func (r *InodeCompletenessReport) Summary() string

+ type InodeEnumeration struct

+ AllocatedCount uint64

+ Anomalies []ReportAnomaly

+ BackedSlotCount uint64

+ Balanced bool

+ Chunks []InodeChunk

+ FreeCount uint64

+ Inodes []uint64

+ PerAllocationGroup []AllocationGroupInodeCounts

+ Source AllocatedInodeSource

+ Truncated bool

+ type InodeEnumerationOptions struct

+ BestEffort bool

+ IncludeChunks bool

+ MaxInodes int

+ VerifyFreeInodeBtree bool

type InodeInformation

+ Count uint32

+ FreeCount uint32

+ FreeInodeBtreeBlocks uint32

+ FreeInodeBtreeDepth uint32

+ FreeInodeBtreeRootBlock uint32

+ InodeBtreeBlocks uint32

+ LastDirectoryChunk uint32

+ Length uint32

+ SequenceNumber uint32

+ UnlinkedBuckets [agiUnlinkedBuckets]uint32

+ func (i InodeInformation) AllocatedInodes() uint32

+ func (i InodeInformation) HasFreeInodeBtree() bool

+ func (i InodeInformation) HasUnlinkedInodes() bool

+ type RecoverableInode struct

+ AllocationGroup uint32

+ Anomalies []ReportAnomaly

+ Class InodeClass

+ FileMode uint16

+ GroupID uint32

+ InodeChangeTime time.Time

+ InodeNumber uint64

+ ModificationTime time.Time

+ NumberOfLinks uint32

+ OwnerID uint32

+ ParentInodeNumber uint64

+ ParentPath string

+ RecoveredPath string

+ RecoveredPathRoot uint64

+ Size uint64

+ Type string

+ UnlinkedBucket int

type ReportOptions

+ IncludeInodeCompleteness bool

+ InodeCompleteness InodeCompletenessOptions

type Superblock

+ FeatureFlags2 uint32

+ FeatureFlags2Backup uint32

+ GroupQuotaInodeNumber uint64

+ Icount uint64

+ Ifree uint64

+ ProjectQuotaInodeNumber uint64

+ RealtimeBitmapInodeNumber uint64

+ RealtimeSummaryInodeNumber uint64

+ SparseInodeAlignment uint32

+ UserQuotaInodeNumber uint64

+ func (s Superblock) AllocatedInodes() uint64

+ func (s Superblock) HasSparseInodes() bool

+ func (s Superblock) LazySuperblockCounters() bool

+ func (s Superblock) MetadataInodeNumbers() []uint64

+ type UnlinkedInode struct

+ AllocationGroup uint32

+ Bucket int

+ InodeNumber uint64

+ Position int

type Volume

+ func (v *Volume) AllocationGroupCount() int

+ func (v *Volume) AllocationGroupInodeInfo(index int) (InodeInformation, error)

+ func (v *Volume) EnumerateAllocatedInodes(ctx context.Context, options InodeEnumerationOptions) (InodeEnumeration, error)

+ func (v *Volume) InodeCompletenessReport(ctx context.Context, options InodeCompletenessOptions) (InodeCompletenessReport, error)

+ func (v *Volume) UnlinkedInodes(ctx context.Context) ([]UnlinkedInode, []ReportAnomaly, error)

+ func (v *Volume) WalkInodeChunks(ctx context.Context, options InodeEnumerationOptions, ...) (InodeEnumeration, error)

type XFSReport

+ Completeness *InodeCompletenessReport

v0.3.0

Aug 9, 2026

Changes in this version

+ const DirectorySourceFormatBlock

+ const DirectorySourceFormatLeaf

+ const DirectorySourceFormatNode

+ const DirectorySourceFormatShortForm

+ const ExtentFlagUnwritten

+ var ErrDirectoryTruncated = errors.New("directory scan truncated at a configured limit")

type DirectoryListing

+ SourceFormat string

type InodeFragment

+ IsUnwritten bool

type Volume

+ func (v *Volume) ListDirectoryEntriesReport(inodeNumber uint64) (DirectoryListing, error)

+ func (v *Volume) ListDirectoryEntriesReportByPath(path string) (DirectoryListing, error)

v0.2.0

Aug 7, 2026

Changes in this version

+ const DirEntryFileTypeBlockDevice

+ const DirEntryFileTypeCharacterDevice

+ const DirEntryFileTypeDirectory

+ const DirEntryFileTypeFIFO

+ const DirEntryFileTypeRegularFile

+ const DirEntryFileTypeSocket

+ const DirEntryFileTypeSymbolicLink

+ const DirEntryFileTypeUnknown

+ const DirEntryFileTypeWhiteout

+ const DirectoryFormatBlock

+ const DirectoryFormatMultiBlock

+ const DirectoryFormatShortForm

+ const ExtentFlagSparse

+ const FeatureIncompatBigTime

+ const FeatureIncompatFileType

+ const FeatureIncompatLargeExtentCounts

+ const FeatureIncompatMetaUUID

+ const FeatureIncompatNeedsRepair

+ const FeatureIncompatSparseInodes

+ const FileTypeBlockDevice

+ const FileTypeCharacterDevice

+ const FileTypeDirectory

+ const FileTypeFIFO

+ const FileTypeRegularFile

+ const FileTypeSocket

+ const FileTypeSymbolicLink

+ const FilesystemTypeName

+ const ForkTypeBtree

+ const ForkTypeDevice

+ const ForkTypeExtents

+ const ForkTypeInlineData

+ const InodeTypeDirectory

+ const InodeTypeFile

+ const ReasonAlignedOffset

+ const ReasonFileTypeValid

+ const ReasonInFreeSlot

+ const ReasonInodeAllocated

+ const ReasonInodeUnaddressable

+ const ReasonInodeUnallocated

+ const ReasonIntactFraming

+ const ReasonNamePrintable

+ const ReasonTagMatchesOffset

+ const SeverityError

+ const SeverityHigh

+ const SeverityInfo

+ const SeverityLow

+ const SeverityMedium

+ const SeverityWarning

+ const XattrNamespaceSecurity

+ const XattrNamespaceTrusted

+ const XattrNamespaceUser

+ var ErrInodeNotFound = errors.New("inode not found")

+ var ErrInvalidAttributeData = errors.New("invalid attribute fork data")

+ var ErrInvalidInode = errors.New("invalid or corrupted XFS inode")

+ var ErrInvalidInodeInfo = errors.New("invalid allocation-group inode information")

+ var ErrInvalidInodeNumber = errors.New("invalid inode number")

+ var ErrInvalidPath = errors.New("invalid path")

+ var ErrInvalidSuperblock = errors.New("invalid or corrupted XFS superblock")

+ var ErrUnsupportedDirFormat = errors.New("unsupported directory format")

+ var ErrUnsupportedFeatureFlag = errors.New("unsupported XFS feature flag")

+ var ErrUnsupportedXattrFormat = errors.New("unsupported extended attribute format")

+ var ErrVerificationFailed = errors.New("forensic verification failed")

+ var ErrVolumeClosed = errors.New("volume is closed")

+ func DirEntryFileTypeName(fileType uint8) string

+ type Concurrency struct

+ Workers int

+ type DirectoryArtifactReport struct

+ ActiveCount int

+ Anomalies []ReportAnomaly

+ CarvedCount int

+ DeletedCount int

+ InodeNumber uint64

+ Path string

+ RecordCount int

+ Records []DirectoryRecord

+ type DirectoryEntry struct

+ FileType uint8

+ InodeNumber uint64

+ Name string

+ type DirectoryIndexReport struct

+ Anomalies []ReportAnomaly

+ DanglingIndexEntries int

+ DataEntries int

+ HasIndex bool

+ HashMismatches []string

+ IndexedEntries int

+ InodeNumber uint64

+ MissingFromIndex []string

+ func (r DirectoryIndexReport) Consistent() bool

+ type DirectoryListing struct

+ Anomalies []ReportAnomaly

+ BlocksScanned uint64

+ Entries []DirectoryEntry

+ Format string

+ InodeNumber uint64

+ Records []DirectoryRecord

+ Truncated bool

+ type DirectoryRecord struct

+ BlockIndex uint64

+ Confidence RecoveryConfidence

+ ConfidenceReasons []string

+ FileType uint8

+ InodeNumber uint64

+ IsCarved bool

+ IsDeleted bool

+ Kind DirectoryRecordKind

+ LogicalOffset uint64

+ Name string

+ Offset uint16

+ RecordLength uint16

+ func (r DirectoryRecord) IsProbabilistic() bool

+ func (r DirectoryRecord) IsVerified() bool

+ type DirectoryRecordKind = string

+ const RecordKindActive

+ const RecordKindCarved

+ const RecordKindFreeSlot

+ type DirectoryScanOptions struct

+ BestEffort bool

+ IncludeDeleted bool

+ MaxBlocks uint64

+ MaxEntries int

+ type ExtendedAttribute struct

+ Flags uint8

+ Name string

+ Namespace string

+ Value []byte

+ type Extent struct

+ LogicalBlockNumber uint64

+ NumberOfBlocks uint32

+ PhysicalBlockNumber uint64

+ RangeFlags uint32

+ type FragmentationReport struct

+ AllocatedExtentCount int

+ DataExtentCount int

+ HasAnyFragmentationOrHoles bool

+ HasLogicalHoles bool

+ HasPhysicalFragmentation bool

+ InodeNumber uint64

+ PhysicalFragmentRuns int

+ Size uint64

+ SparseExtentCount int

+ type IOError struct

+ Err error

+ Offset int64

+ Op string

+ Size int

+ func (e *IOError) Error() string

+ func (e *IOError) Unwrap() error

+ type Inode struct

+ AccessTimeNS int64

+ AttributeExtentCount uint32

+ AttributesExtents []Extent

+ AttributesForkOffset uint16

+ AttributesForkSize uint16

+ AttributesForkType uint8

+ CreationTimeNS int64

+ DataExtentCount uint64

+ DataExtents []Extent

+ DataForkOffset uint16

+ DataForkSize uint16

+ DeviceIdentifier uint32

+ FileMode uint16

+ ForkType uint8

+ FormatVersion uint8

+ GroupID uint32

+ HasBigTimestamps bool

+ InlineAttributesData []byte

+ InlineData []byte

+ InodeChangeTimeNS int64

+ ModificationTimeNS int64

+ NumberOfAttributesExtent uint16

+ NumberOfDataExtents uint32

+ NumberOfLinks uint32

+ OwnerID uint32

+ Raw []byte

+ Size uint64

+ func (i *Inode) AccessTime() time.Time

+ func (i *Inode) CreationTime() time.Time

+ func (i *Inode) InodeChangeTime() time.Time

+ func (i *Inode) IsDirectory() bool

+ func (i *Inode) ModificationTime() time.Time

+ type InodeForensicReport struct

+ AccessTime time.Time

+ Anomalies []ReportAnomaly

+ AttributesExtentCount int

+ CreationTime time.Time

+ DataExtentCount int

+ ExtendedAttributeNames []string

+ FileMode uint16

+ ForkType uint8

+ Fragmentation FragmentationReport

+ Fragments []InodeFragment

+ GroupID uint32

+ HasInlineData bool

+ InodeChangeTime time.Time

+ InodeNumber uint64

+ ModificationTime time.Time

+ NumberOfLinks uint32

+ OwnerID uint32

+ Path string

+ Size uint64

+ Type string

+ type InodeFragment struct

+ EndOffset uint64

+ IsSparse bool

+ LengthBytes uint64

+ LogicalBlockNumber uint64

+ NumberOfBlocks uint32

+ PhysicalBlockNumber uint64

+ StartOffset uint64

+ type InodeInformation struct

+ FormatVersion uint32

+ InodeBtreeDepth uint32

+ InodeBtreeRootBlock uint32

+ LastAllocatedChunk uint32

+ type ParseError struct

+ Err error

+ Field string

+ Offset int64

+ func (e *ParseError) Error() string

+ func (e *ParseError) Unwrap() error

+ type RecoveryConfidence = string

+ const ConfidenceHigh

+ const ConfidenceLow

+ const ConfidenceMedium

+ type ReportAnomaly struct

+ Code string

+ Inode uint64

+ Message string

+ Path string

+ Severity string

+ type ReportOptions struct

+ Concurrency Concurrency

+ IncludeDirectoryArtifacts bool

+ MaxEntries int

+ RootPath string

+ VerificationMode VerificationMode

+ type ReportProvenance struct

+ Coverage []string

+ InodeCRCChecked bool

+ SuperblockCRCChecked bool

+ VerificationMode VerificationMode

+ type Superblock struct

+ AllocationGroupSize uint32

+ BlockSize uint32

+ DirectoryBlockSize uint32

+ FeatureFlags uint16

+ FeaturesCompat uint32

+ FeaturesIncompat uint32

+ FeaturesLogIncompat uint32

+ FeaturesReadOnlyCompat uint32

+ FormatVersion uint8

+ InodeSize uint16

+ JournalBlockNumber uint64

+ NumberOfAllocationGroups uint32

+ NumberOfBlocks uint64

+ RelativeBlockNumberBits uint8

+ RelativeInodeNumberBits uint8

+ RootDirectoryInodeNumber uint64

+ SecondaryFeatureFlags uint32

+ SectorSize uint16

+ VolumeLabel [12]byte

+ func (s Superblock) HasBigTimestamps() bool

+ func (s Superblock) HasFeatureIncompat(feature uint32) bool

+ func (s Superblock) HasLargeExtentCounts() bool

+ func (s Superblock) NeedsRepair() bool

+ type VerificationMode string

+ const VerificationModeBestEffort

+ const VerificationModeStrict

+ type Volume struct

+ func Open(reader io.ReaderAt) (*Volume, error)

+ func OpenVolumeFromPath(path string) (*Volume, error)

+ func (v *Volume) AnalyzeInodeFragmentation(inodeNumber uint64) (FragmentationReport, error)

+ func (v *Volume) AnalyzeInodeFragmentationByPath(path string) (FragmentationReport, error)

+ func (v *Volume) Close() error

+ func (v *Volume) DirectoryArtifactReport(inodeNumber uint64) (DirectoryArtifactReport, error)

+ func (v *Volume) DirectoryArtifactReportByPath(path string) (DirectoryArtifactReport, error)

+ func (v *Volume) DirectoryParentInode(inodeNumber uint64) (uint64, error)

+ func (v *Volume) DirectoryParentInodeByPath(path string) (uint64, error)

+ func (v *Volume) GetRootInode() (*Inode, error)

+ func (v *Volume) InodeForensicReport(inodeNumber uint64) (InodeForensicReport, error)

+ func (v *Volume) InodeForensicReportByPath(path string) (InodeForensicReport, error)

+ func (v *Volume) IsClosed() bool

+ func (v *Volume) ListDirectoryEntries(inodeNumber uint64) ([]DirectoryEntry, error)

+ func (v *Volume) ListDirectoryEntriesByPath(path string) ([]DirectoryEntry, error)

+ func (v *Volume) ListDirectoryEntriesWithOptions(inodeNumber uint64, options DirectoryScanOptions) (DirectoryListing, error)

+ func (v *Volume) ListInodeExtendedAttributes(inodeNumber uint64) ([]ExtendedAttribute, error)

+ func (v *Volume) ListRootDirectoryEntries() ([]DirectoryEntry, error)

+ func (v *Volume) OpenInode(inodeNumber uint64) (*Inode, error)

+ func (v *Volume) OpenInodeByPath(path string) (*Inode, error)

+ func (v *Volume) ReadFileData(inodeNumber uint64) ([]byte, error)

+ func (v *Volume) ReadFileDataByPath(path string) ([]byte, error)

+ func (v *Volume) ReadInodeAttributeForkData(inodeNumber uint64) ([]byte, error)

+ func (v *Volume) ReadInodeData(inodeNumber uint64, p []byte, off int64) (int, error)

+ func (v *Volume) Report() (*XFSReport, error)

+ func (v *Volume) ReportWithContext(ctx context.Context, options ReportOptions) (*XFSReport, error)

+ func (v *Volume) ReportWithOptions(options ReportOptions) (*XFSReport, error)

+ func (v *Volume) ResolveInodeByPath(path string) (uint64, error)

+ func (v *Volume) ScanDirectoryRecords(inodeNumber uint64) ([]DirectoryRecord, error)

+ func (v *Volume) ScanDirectoryRecordsByPath(path string) ([]DirectoryRecord, error)

+ func (v *Volume) ScanDirectoryRecordsByPathWithOptions(path string, options DirectoryScanOptions) (DirectoryListing, error)

+ func (v *Volume) ScanDirectoryRecordsWithOptions(inodeNumber uint64, options DirectoryScanOptions) (DirectoryListing, error)

+ func (v *Volume) Superblock() Superblock

+ func (v *Volume) VerifyDirectoryIndex(inodeNumber uint64) (DirectoryIndexReport, error)

+ func (v *Volume) VerifyDirectoryIndexByPath(path string) (DirectoryIndexReport, error)

+ func (v *Volume) VolumeIntegrityReport() (VolumeIntegrityReport, error)

+ type VolumeError struct

+ Err error

+ Op string

+ func (e *VolumeError) Error() string

+ func (e *VolumeError) Unwrap() error

+ type VolumeIntegrityReport struct

+ AllocationGroupSize uint32

+ Anomalies []ReportAnomaly

+ BlockSize uint32

+ DirectoryBlockSize uint32

+ FormatVersion uint8

+ InodeSize uint16

+ NumberOfAllocationGroups uint32

+ NumberOfBlocks uint64

+ RootDirectoryInodeNumber uint64

+ SuperblockCRCChecked bool

+ SuperblockCRCValid bool

+ Type string

+ VolumeLabel string

+ type XFSReport struct

+ Anomalies []ReportAnomaly

+ DirectoryArtifacts []DirectoryArtifactReport

+ Files []InodeForensicReport

+ GeneratedAt time.Time

+ Provenance ReportProvenance

+ RootPath string

+ Volume VolumeIntegrityReport

+ func (r *XFSReport) Summary() string

v0.1.0

Apr 27, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL