diff

type AnalysisReport struct {
	// Entries contains each block with different data.
	Entries AnalysisReportEntries

	// AddressMapper converts the address in DiffRange into a position in the SystemArtifact.
	AddressMapper types.AddressMapper

	// FirstProblemOffset is the offset of the first byte with a different value.
	FirstProblemOffset uint64

	// BytesChanged is a count of bytes with different values.
	BytesChanged uint64

	// HammingDistance is a bit-wise hamming distance between images.
	HammingDistance uint64

	// HammingDistanceNon00orFF is a bit-wise hamming distance between images, excluding
	// bytes 0x00 and 0xff
	HammingDistanceNon00orFF uint64
}

type AnalysisReportEntries []AnalysisReportEntry

type AnalysisReportEntry struct {
	// DiffRange is the information about offsets where the data is different.
	DiffRange pkgbytes.Range

	// HammingDistance is a bit-wise hamming distance between the data blocks.
	HammingDistance uint64

	// HammingDistanceNon00orFF is a bit-wise hamming distance between the data
	// blocks, excluding bytes 0x00 and 0xff
	HammingDistanceNon00orFF uint64

	// RelatedMeasurements contains the list of measurements which overlaps
	// with the data block.
	RelatedMeasurements []RelatedMeasurement

	// Nodes contains the list of UEFI nodes (regions, volumes, modules, files)
	// which overlaps with the data block
	Nodes []NodeInfo
}

type DataChunk struct {
	Description   string
	ForceBytes    []byte
	Reference     pkgbytes.Range
	AddressMapper types.AddressMapper
	CustomData    any
}

type DataChunks []DataChunk

type Firmware interface {
	Buf() []byte
	GetByRange(byteRange pkgbytes.Range) (nodes []*ffs.Node, err error)
	NameToRangesMap() map[string]pkgbytes.Ranges
}

type Measurement struct {
	Description string
	Chunks      DataChunks
	CustomData  any
}

type Measurements []Measurement

type NodeInfo struct {
	UUID        uuid.UUID
	Description string
}

type NodeInfos []NodeInfo

type Range = pkgbytes.Range

type Ranges = pkgbytes.Ranges

type RelatedMeasurement struct {
	RelatedDataChunks DataChunks
	Measurement
}

type RelatedMeasurementsLaconic []RelatedMeasurement