se_manifestcodegen.go

// +build !manifestcodegen
// Code generated by "menifestcodegen". DO NOT EDIT.
// To reproduce: go run github.com/9elements/converged-security-suite/v2/pkg/intel/metadata/manifest/common/manifestcodegen/cmd/manifestcodegen github.com/9elements/converged-security-suite/v2/pkg/intel/metadata/manifest/bootpolicy

package bootpolicy

import (
	"encoding/binary"
	"fmt"
	"io"
	"strings"

	"github.com/9elements/converged-security-suite/v2/pkg/intel/metadata/manifest"
	"github.com/9elements/converged-security-suite/v2/pkg/intel/metadata/manifest/common/pretty"
)

var (
	// Just to avoid errors in "import" above in case if it wasn't used below
	_ = binary.LittleEndian
	_ = (fmt.Stringer)(nil)
	_ = (io.Reader)(nil)
	_ = pretty.Header
	_ = strings.Join
	_ = manifest.StructInfo{}
)

// NewIBBSegment returns a new instance of IBBSegment with
// all default values set.
func NewIBBSegment() *IBBSegment {
	s := &IBBSegment{}
	s.Rehash()
	return s
}

// Validate (recursively) checks the structure if there are any unexpected
// values. It returns an error if so.
func (s *IBBSegment) Validate() error {
	// See tag "require"
	for idx := range s.Reserved {
		if s.Reserved[idx] != 0 {
			return fmt.Errorf("'Reserved[%d]' is expected to be 0, but it is %v", idx, s.Reserved[idx])
		}
	}

	return nil
}

// ReadFrom reads the IBBSegment from 'r' in format defined in the document #575623.
func (s *IBBSegment) ReadFrom(r io.Reader) (int64, error) {
	totalN := int64(0)

	// Reserved (ManifestFieldType: arrayStatic)
	{
		n, err := 2, binary.Read(r, binary.LittleEndian, s.Reserved[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Reserved': %w", err)
		}
		totalN += int64(n)
	}

	// Flags (ManifestFieldType: endValue)
	{
		n, err := 2, binary.Read(r, binary.LittleEndian, &s.Flags)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Flags': %w", err)
		}
		totalN += int64(n)
	}

	// Base (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Read(r, binary.LittleEndian, &s.Base)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Base': %w", err)
		}
		totalN += int64(n)
	}

	// Size (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Read(r, binary.LittleEndian, &s.Size)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Size': %w", err)
		}
		totalN += int64(n)
	}

	return totalN, nil
}

// RehashRecursive calls Rehash (see below) recursively.
func (s *IBBSegment) RehashRecursive() {
	s.Rehash()
}

// Rehash sets values which are calculated automatically depending on the rest
// data. It is usually about the total size field of an element.
func (s *IBBSegment) Rehash() {
}

// WriteTo writes the IBBSegment into 'w' in format defined in
// the document #575623.
func (s *IBBSegment) WriteTo(w io.Writer) (int64, error) {
	totalN := int64(0)
	s.Rehash()

	// Reserved (ManifestFieldType: arrayStatic)
	{
		n, err := 2, binary.Write(w, binary.LittleEndian, s.Reserved[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Reserved': %w", err)
		}
		totalN += int64(n)
	}

	// Flags (ManifestFieldType: endValue)
	{
		n, err := 2, binary.Write(w, binary.LittleEndian, &s.Flags)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Flags': %w", err)
		}
		totalN += int64(n)
	}

	// Base (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Write(w, binary.LittleEndian, &s.Base)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Base': %w", err)
		}
		totalN += int64(n)
	}

	// Size (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Write(w, binary.LittleEndian, &s.Size)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Size': %w", err)
		}
		totalN += int64(n)
	}

	return totalN, nil
}

// ReservedSize returns the size in bytes of the value of field Reserved
func (s *IBBSegment) ReservedTotalSize() uint64 {
	return 2
}

// FlagsSize returns the size in bytes of the value of field Flags
func (s *IBBSegment) FlagsTotalSize() uint64 {
	return 2
}

// BaseSize returns the size in bytes of the value of field Base
func (s *IBBSegment) BaseTotalSize() uint64 {
	return 4
}

// SizeSize returns the size in bytes of the value of field Size
func (s *IBBSegment) SizeTotalSize() uint64 {
	return 4
}

// ReservedOffset returns the offset in bytes of field Reserved
func (s *IBBSegment) ReservedOffset() uint64 {
	return 0
}

// FlagsOffset returns the offset in bytes of field Flags
func (s *IBBSegment) FlagsOffset() uint64 {
	return s.ReservedOffset() + s.ReservedTotalSize()
}

// BaseOffset returns the offset in bytes of field Base
func (s *IBBSegment) BaseOffset() uint64 {
	return s.FlagsOffset() + s.FlagsTotalSize()
}

// SizeOffset returns the offset in bytes of field Size
func (s *IBBSegment) SizeOffset() uint64 {
	return s.BaseOffset() + s.BaseTotalSize()
}

// Size returns the total size of the IBBSegment.
func (s *IBBSegment) TotalSize() uint64 {
	if s == nil {
		return 0
	}

	var size uint64
	size += s.ReservedTotalSize()
	size += s.FlagsTotalSize()
	size += s.BaseTotalSize()
	size += s.SizeTotalSize()
	return size
}

// PrettyString returns the content of the structure in an easy-to-read format.
func (s *IBBSegment) PrettyString(depth uint, withHeader bool, opts ...pretty.Option) string {
	var lines []string
	if withHeader {
		lines = append(lines, pretty.Header(depth, "IBB Segment", s))
	}
	if s == nil {
		return strings.Join(lines, "\n")
	}
	// ManifestFieldType is arrayStatic
	lines = append(lines, pretty.SubValue(depth+1, "Reserved", "", &s.Reserved, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "Flags", "", &s.Flags, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "Base", "", &s.Base, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "Size", "", &s.Size, opts...)...)
	if depth < 2 {
		lines = append(lines, "")
	}
	return strings.Join(lines, "\n")
}

// NewSE returns a new instance of SE with
// all default values set.
func NewSE() *SE {
	s := &SE{}
	copy(s.StructInfo.ID[:], []byte(StructureIDSE))
	s.StructInfo.Version = 0x20
	// Set through tag "required":
	s.SetNumber = 0
	// Recursively initializing a child structure:
	s.PostIBBHash = *manifest.NewHashStructure()
	// Recursively initializing a child structure:
	s.DigestList = *manifest.NewHashList()
	// Recursively initializing a child structure:
	s.OBBHash = *manifest.NewHashStructure()
	s.Rehash()
	return s
}

// Validate (recursively) checks the structure if there are any unexpected
// values. It returns an error if so.
func (s *SE) Validate() error {
	// See tag "require"
	for idx := range s.Reserved0 {
		if s.Reserved0[idx] != 0 {
			return fmt.Errorf("'Reserved0[%d]' is expected to be 0, but it is %v", idx, s.Reserved0[idx])
		}
	}
	// See tag "require"
	if s.SetNumber != 0 {
		return fmt.Errorf("field 'SetNumber' expects value '0', but has %v", s.SetNumber)
	}
	// See tag "require"
	for idx := range s.Reserved1 {
		if s.Reserved1[idx] != 0 {
			return fmt.Errorf("'Reserved1[%d]' is expected to be 0, but it is %v", idx, s.Reserved1[idx])
		}
	}
	// Recursively validating a child structure:
	if err := s.PostIBBHash.Validate(); err != nil {
		return fmt.Errorf("error on field 'PostIBBHash': %w", err)
	}
	// Recursively validating a child structure:
	if err := s.DigestList.Validate(); err != nil {
		return fmt.Errorf("error on field 'DigestList': %w", err)
	}
	// Recursively validating a child structure:
	if err := s.OBBHash.Validate(); err != nil {
		return fmt.Errorf("error on field 'OBBHash': %w", err)
	}
	// See tag "require"
	for idx := range s.Reserved2 {
		if s.Reserved2[idx] != 0 {
			return fmt.Errorf("'Reserved2[%d]' is expected to be 0, but it is %v", idx, s.Reserved2[idx])
		}
	}

	return nil
}

// StructureIDSE is the StructureID (in terms of
// the document #575623) of element 'SE'.
const StructureIDSE = "__IBBS__"

// GetStructInfo returns current value of StructInfo of the structure.
//
// StructInfo is a set of standard fields with presented in any element
// ("element" in terms of document #575623).
func (s *SE) GetStructInfo() manifest.StructInfo {
	return s.StructInfo
}

// SetStructInfo sets new value of StructInfo to the structure.
//
// StructInfo is a set of standard fields with presented in any element
// ("element" in terms of document #575623).
func (s *SE) SetStructInfo(newStructInfo manifest.StructInfo) {
	s.StructInfo = newStructInfo
}

// ReadFrom reads the SE from 'r' in format defined in the document #575623.
func (s *SE) ReadFrom(r io.Reader) (int64, error) {
	var totalN int64

	err := binary.Read(r, binary.LittleEndian, &s.StructInfo)
	if err != nil {
		return totalN, fmt.Errorf("unable to read structure info at %d: %w", totalN, err)
	}
	totalN += int64(binary.Size(s.StructInfo))

	n, err := s.ReadDataFrom(r)
	if err != nil {
		return totalN, fmt.Errorf("unable to read data: %w", err)
	}
	totalN += n

	return totalN, nil
}

// ReadDataFrom reads the SE from 'r' excluding StructInfo,
// in format defined in the document #575623.
func (s *SE) ReadDataFrom(r io.Reader) (int64, error) {
	totalN := int64(0)

	// StructInfo (ManifestFieldType: structInfo)
	{
		// ReadDataFrom does not read Struct, use ReadFrom for that.
	}

	// Reserved0 (ManifestFieldType: arrayStatic)
	{
		n, err := 1, binary.Read(r, binary.LittleEndian, s.Reserved0[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Reserved0': %w", err)
		}
		totalN += int64(n)
	}

	// SetNumber (ManifestFieldType: endValue)
	{
		n, err := 1, binary.Read(r, binary.LittleEndian, &s.SetNumber)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'SetNumber': %w", err)
		}
		totalN += int64(n)
	}

	// Reserved1 (ManifestFieldType: arrayStatic)
	{
		n, err := 1, binary.Read(r, binary.LittleEndian, s.Reserved1[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Reserved1': %w", err)
		}
		totalN += int64(n)
	}

	// PBETValue (ManifestFieldType: endValue)
	{
		n, err := 1, binary.Read(r, binary.LittleEndian, &s.PBETValue)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'PBETValue': %w", err)
		}
		totalN += int64(n)
	}

	// Flags (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Read(r, binary.LittleEndian, &s.Flags)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Flags': %w", err)
		}
		totalN += int64(n)
	}

	// IBBMCHBAR (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Read(r, binary.LittleEndian, &s.IBBMCHBAR)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'IBBMCHBAR': %w", err)
		}
		totalN += int64(n)
	}

	// VTdBAR (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Read(r, binary.LittleEndian, &s.VTdBAR)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'VTdBAR': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtBase0 (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Read(r, binary.LittleEndian, &s.DMAProtBase0)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'DMAProtBase0': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtLimit0 (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Read(r, binary.LittleEndian, &s.DMAProtLimit0)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'DMAProtLimit0': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtBase1 (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Read(r, binary.LittleEndian, &s.DMAProtBase1)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'DMAProtBase1': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtLimit1 (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Read(r, binary.LittleEndian, &s.DMAProtLimit1)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'DMAProtLimit1': %w", err)
		}
		totalN += int64(n)
	}

	// PostIBBHash (ManifestFieldType: subStruct)
	{
		n, err := s.PostIBBHash.ReadFrom(r)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'PostIBBHash': %w", err)
		}
		totalN += int64(n)
	}

	// IBBEntryPoint (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Read(r, binary.LittleEndian, &s.IBBEntryPoint)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'IBBEntryPoint': %w", err)
		}
		totalN += int64(n)
	}

	// DigestList (ManifestFieldType: subStruct)
	{
		n, err := s.DigestList.ReadFrom(r)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'DigestList': %w", err)
		}
		totalN += int64(n)
	}

	// OBBHash (ManifestFieldType: subStruct)
	{
		n, err := s.OBBHash.ReadFrom(r)
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'OBBHash': %w", err)
		}
		totalN += int64(n)
	}

	// Reserved2 (ManifestFieldType: arrayStatic)
	{
		n, err := 3, binary.Read(r, binary.LittleEndian, s.Reserved2[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to read field 'Reserved2': %w", err)
		}
		totalN += int64(n)
	}

	// IBBSegments (ManifestFieldType: list)
	{
		var count uint8
		err := binary.Read(r, binary.LittleEndian, &count)
		if err != nil {
			return totalN, fmt.Errorf("unable to read the count for field 'IBBSegments': %w", err)
		}
		totalN += int64(binary.Size(count))
		s.IBBSegments = make([]IBBSegment, count)

		for idx := range s.IBBSegments {
			n, err := s.IBBSegments[idx].ReadFrom(r)
			if err != nil {
				return totalN, fmt.Errorf("unable to read field 'IBBSegments[%d]': %w", idx, err)
			}
			totalN += int64(n)
		}
	}

	return totalN, nil
}

// RehashRecursive calls Rehash (see below) recursively.
func (s *SE) RehashRecursive() {
	s.StructInfo.Rehash()
	s.PostIBBHash.Rehash()
	s.DigestList.Rehash()
	s.OBBHash.Rehash()
	s.Rehash()
}

// Rehash sets values which are calculated automatically depending on the rest
// data. It is usually about the total size field of an element.
func (s *SE) Rehash() {
	s.Variable0 = 0
	s.ElementSize = uint16(s.TotalSize())
}

// WriteTo writes the SE into 'w' in format defined in
// the document #575623.
func (s *SE) WriteTo(w io.Writer) (int64, error) {
	totalN := int64(0)
	s.Rehash()

	// StructInfo (ManifestFieldType: structInfo)
	{
		n, err := s.StructInfo.WriteTo(w)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'StructInfo': %w", err)
		}
		totalN += int64(n)
	}

	// Reserved0 (ManifestFieldType: arrayStatic)
	{
		n, err := 1, binary.Write(w, binary.LittleEndian, s.Reserved0[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Reserved0': %w", err)
		}
		totalN += int64(n)
	}

	// SetNumber (ManifestFieldType: endValue)
	{
		n, err := 1, binary.Write(w, binary.LittleEndian, &s.SetNumber)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'SetNumber': %w", err)
		}
		totalN += int64(n)
	}

	// Reserved1 (ManifestFieldType: arrayStatic)
	{
		n, err := 1, binary.Write(w, binary.LittleEndian, s.Reserved1[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Reserved1': %w", err)
		}
		totalN += int64(n)
	}

	// PBETValue (ManifestFieldType: endValue)
	{
		n, err := 1, binary.Write(w, binary.LittleEndian, &s.PBETValue)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'PBETValue': %w", err)
		}
		totalN += int64(n)
	}

	// Flags (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Write(w, binary.LittleEndian, &s.Flags)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Flags': %w", err)
		}
		totalN += int64(n)
	}

	// IBBMCHBAR (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Write(w, binary.LittleEndian, &s.IBBMCHBAR)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'IBBMCHBAR': %w", err)
		}
		totalN += int64(n)
	}

	// VTdBAR (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Write(w, binary.LittleEndian, &s.VTdBAR)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'VTdBAR': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtBase0 (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Write(w, binary.LittleEndian, &s.DMAProtBase0)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'DMAProtBase0': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtLimit0 (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Write(w, binary.LittleEndian, &s.DMAProtLimit0)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'DMAProtLimit0': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtBase1 (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Write(w, binary.LittleEndian, &s.DMAProtBase1)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'DMAProtBase1': %w", err)
		}
		totalN += int64(n)
	}

	// DMAProtLimit1 (ManifestFieldType: endValue)
	{
		n, err := 8, binary.Write(w, binary.LittleEndian, &s.DMAProtLimit1)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'DMAProtLimit1': %w", err)
		}
		totalN += int64(n)
	}

	// PostIBBHash (ManifestFieldType: subStruct)
	{
		n, err := s.PostIBBHash.WriteTo(w)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'PostIBBHash': %w", err)
		}
		totalN += int64(n)
	}

	// IBBEntryPoint (ManifestFieldType: endValue)
	{
		n, err := 4, binary.Write(w, binary.LittleEndian, &s.IBBEntryPoint)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'IBBEntryPoint': %w", err)
		}
		totalN += int64(n)
	}

	// DigestList (ManifestFieldType: subStruct)
	{
		n, err := s.DigestList.WriteTo(w)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'DigestList': %w", err)
		}
		totalN += int64(n)
	}

	// OBBHash (ManifestFieldType: subStruct)
	{
		n, err := s.OBBHash.WriteTo(w)
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'OBBHash': %w", err)
		}
		totalN += int64(n)
	}

	// Reserved2 (ManifestFieldType: arrayStatic)
	{
		n, err := 3, binary.Write(w, binary.LittleEndian, s.Reserved2[:])
		if err != nil {
			return totalN, fmt.Errorf("unable to write field 'Reserved2': %w", err)
		}
		totalN += int64(n)
	}

	// IBBSegments (ManifestFieldType: list)
	{
		count := uint8(len(s.IBBSegments))
		err := binary.Write(w, binary.LittleEndian, &count)
		if err != nil {
			return totalN, fmt.Errorf("unable to write the count for field 'IBBSegments': %w", err)
		}
		totalN += int64(binary.Size(count))
		for idx := range s.IBBSegments {
			n, err := s.IBBSegments[idx].WriteTo(w)
			if err != nil {
				return totalN, fmt.Errorf("unable to write field 'IBBSegments[%d]': %w", idx, err)
			}
			totalN += int64(n)
		}
	}

	return totalN, nil
}

// StructInfoSize returns the size in bytes of the value of field StructInfo
func (s *SE) StructInfoTotalSize() uint64 {
	return s.StructInfo.TotalSize()
}

// Reserved0Size returns the size in bytes of the value of field Reserved0
func (s *SE) Reserved0TotalSize() uint64 {
	return 1
}

// SetNumberSize returns the size in bytes of the value of field SetNumber
func (s *SE) SetNumberTotalSize() uint64 {
	return 1
}

// Reserved1Size returns the size in bytes of the value of field Reserved1
func (s *SE) Reserved1TotalSize() uint64 {
	return 1
}

// PBETValueSize returns the size in bytes of the value of field PBETValue
func (s *SE) PBETValueTotalSize() uint64 {
	return 1
}

// FlagsSize returns the size in bytes of the value of field Flags
func (s *SE) FlagsTotalSize() uint64 {
	return 4
}

// IBBMCHBARSize returns the size in bytes of the value of field IBBMCHBAR
func (s *SE) IBBMCHBARTotalSize() uint64 {
	return 8
}

// VTdBARSize returns the size in bytes of the value of field VTdBAR
func (s *SE) VTdBARTotalSize() uint64 {
	return 8
}

// DMAProtBase0Size returns the size in bytes of the value of field DMAProtBase0
func (s *SE) DMAProtBase0TotalSize() uint64 {
	return 4
}

// DMAProtLimit0Size returns the size in bytes of the value of field DMAProtLimit0
func (s *SE) DMAProtLimit0TotalSize() uint64 {
	return 4
}

// DMAProtBase1Size returns the size in bytes of the value of field DMAProtBase1
func (s *SE) DMAProtBase1TotalSize() uint64 {
	return 8
}

// DMAProtLimit1Size returns the size in bytes of the value of field DMAProtLimit1
func (s *SE) DMAProtLimit1TotalSize() uint64 {
	return 8
}

// PostIBBHashSize returns the size in bytes of the value of field PostIBBHash
func (s *SE) PostIBBHashTotalSize() uint64 {
	return s.PostIBBHash.TotalSize()
}

// IBBEntryPointSize returns the size in bytes of the value of field IBBEntryPoint
func (s *SE) IBBEntryPointTotalSize() uint64 {
	return 4
}

// DigestListSize returns the size in bytes of the value of field DigestList
func (s *SE) DigestListTotalSize() uint64 {
	return s.DigestList.TotalSize()
}

// OBBHashSize returns the size in bytes of the value of field OBBHash
func (s *SE) OBBHashTotalSize() uint64 {
	return s.OBBHash.TotalSize()
}

// Reserved2Size returns the size in bytes of the value of field Reserved2
func (s *SE) Reserved2TotalSize() uint64 {
	return 3
}

// IBBSegmentsSize returns the size in bytes of the value of field IBBSegments
func (s *SE) IBBSegmentsTotalSize() uint64 {
	var size uint64
	size += uint64(binary.Size(uint8(0)))
	for idx := range s.IBBSegments {
		size += s.IBBSegments[idx].TotalSize()
	}
	return size
}

// StructInfoOffset returns the offset in bytes of field StructInfo
func (s *SE) StructInfoOffset() uint64 {
	return 0
}

// Reserved0Offset returns the offset in bytes of field Reserved0
func (s *SE) Reserved0Offset() uint64 {
	return s.StructInfoOffset() + s.StructInfoTotalSize()
}

// SetNumberOffset returns the offset in bytes of field SetNumber
func (s *SE) SetNumberOffset() uint64 {
	return s.Reserved0Offset() + s.Reserved0TotalSize()
}

// Reserved1Offset returns the offset in bytes of field Reserved1
func (s *SE) Reserved1Offset() uint64 {
	return s.SetNumberOffset() + s.SetNumberTotalSize()
}

// PBETValueOffset returns the offset in bytes of field PBETValue
func (s *SE) PBETValueOffset() uint64 {
	return s.Reserved1Offset() + s.Reserved1TotalSize()
}

// FlagsOffset returns the offset in bytes of field Flags
func (s *SE) FlagsOffset() uint64 {
	return s.PBETValueOffset() + s.PBETValueTotalSize()
}

// IBBMCHBAROffset returns the offset in bytes of field IBBMCHBAR
func (s *SE) IBBMCHBAROffset() uint64 {
	return s.FlagsOffset() + s.FlagsTotalSize()
}

// VTdBAROffset returns the offset in bytes of field VTdBAR
func (s *SE) VTdBAROffset() uint64 {
	return s.IBBMCHBAROffset() + s.IBBMCHBARTotalSize()
}

// DMAProtBase0Offset returns the offset in bytes of field DMAProtBase0
func (s *SE) DMAProtBase0Offset() uint64 {
	return s.VTdBAROffset() + s.VTdBARTotalSize()
}

// DMAProtLimit0Offset returns the offset in bytes of field DMAProtLimit0
func (s *SE) DMAProtLimit0Offset() uint64 {
	return s.DMAProtBase0Offset() + s.DMAProtBase0TotalSize()
}

// DMAProtBase1Offset returns the offset in bytes of field DMAProtBase1
func (s *SE) DMAProtBase1Offset() uint64 {
	return s.DMAProtLimit0Offset() + s.DMAProtLimit0TotalSize()
}

// DMAProtLimit1Offset returns the offset in bytes of field DMAProtLimit1
func (s *SE) DMAProtLimit1Offset() uint64 {
	return s.DMAProtBase1Offset() + s.DMAProtBase1TotalSize()
}

// PostIBBHashOffset returns the offset in bytes of field PostIBBHash
func (s *SE) PostIBBHashOffset() uint64 {
	return s.DMAProtLimit1Offset() + s.DMAProtLimit1TotalSize()
}

// IBBEntryPointOffset returns the offset in bytes of field IBBEntryPoint
func (s *SE) IBBEntryPointOffset() uint64 {
	return s.PostIBBHashOffset() + s.PostIBBHashTotalSize()
}

// DigestListOffset returns the offset in bytes of field DigestList
func (s *SE) DigestListOffset() uint64 {
	return s.IBBEntryPointOffset() + s.IBBEntryPointTotalSize()
}

// OBBHashOffset returns the offset in bytes of field OBBHash
func (s *SE) OBBHashOffset() uint64 {
	return s.DigestListOffset() + s.DigestListTotalSize()
}

// Reserved2Offset returns the offset in bytes of field Reserved2
func (s *SE) Reserved2Offset() uint64 {
	return s.OBBHashOffset() + s.OBBHashTotalSize()
}

// IBBSegmentsOffset returns the offset in bytes of field IBBSegments
func (s *SE) IBBSegmentsOffset() uint64 {
	return s.Reserved2Offset() + s.Reserved2TotalSize()
}

// Size returns the total size of the SE.
func (s *SE) TotalSize() uint64 {
	if s == nil {
		return 0
	}

	var size uint64
	size += s.StructInfoTotalSize()
	size += s.Reserved0TotalSize()
	size += s.SetNumberTotalSize()
	size += s.Reserved1TotalSize()
	size += s.PBETValueTotalSize()
	size += s.FlagsTotalSize()
	size += s.IBBMCHBARTotalSize()
	size += s.VTdBARTotalSize()
	size += s.DMAProtBase0TotalSize()
	size += s.DMAProtLimit0TotalSize()
	size += s.DMAProtBase1TotalSize()
	size += s.DMAProtLimit1TotalSize()
	size += s.PostIBBHashTotalSize()
	size += s.IBBEntryPointTotalSize()
	size += s.DigestListTotalSize()
	size += s.OBBHashTotalSize()
	size += s.Reserved2TotalSize()
	size += s.IBBSegmentsTotalSize()
	return size
}

// PrettyString returns the content of the structure in an easy-to-read format.
func (s *SE) PrettyString(depth uint, withHeader bool, opts ...pretty.Option) string {
	var lines []string
	if withHeader {
		lines = append(lines, pretty.Header(depth, "IBB Segments Element", s))
	}
	if s == nil {
		return strings.Join(lines, "\n")
	}
	// ManifestFieldType is structInfo
	lines = append(lines, pretty.SubValue(depth+1, "Struct Info", "", &s.StructInfo, opts...)...)
	// ManifestFieldType is arrayStatic
	lines = append(lines, pretty.SubValue(depth+1, "Reserved 0", "", &s.Reserved0, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "Set Number", "", &s.SetNumber, opts...)...)
	// ManifestFieldType is arrayStatic
	lines = append(lines, pretty.SubValue(depth+1, "Reserved 1", "", &s.Reserved1, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "PBET Value", "", &s.PBETValue, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "Flags", "", &s.Flags, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "IBB MCHBAR", "", &s.IBBMCHBAR, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "VT-d BAR", "", &s.VTdBAR, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "DMA Protection 0 Base Address", "", &s.DMAProtBase0, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "DMA Protection 0 Limit Address", "", &s.DMAProtLimit0, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "DMA Protection 1 Base Address", "", &s.DMAProtBase1, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "DMA Protection 2 Limit Address", "", &s.DMAProtLimit1, opts...)...)
	// ManifestFieldType is subStruct
	lines = append(lines, pretty.SubValue(depth+1, "Post IBB Hash", "", &s.PostIBBHash, opts...)...)
	// ManifestFieldType is endValue
	lines = append(lines, pretty.SubValue(depth+1, "IBB Entry Point", "", &s.IBBEntryPoint, opts...)...)
	// ManifestFieldType is subStruct
	lines = append(lines, pretty.SubValue(depth+1, "Digest List", "", &s.DigestList, opts...)...)
	// ManifestFieldType is subStruct
	lines = append(lines, pretty.SubValue(depth+1, "OBB Hash", "", &s.OBBHash, opts...)...)
	// ManifestFieldType is arrayStatic
	lines = append(lines, pretty.SubValue(depth+1, "Reserved 2", "", &s.Reserved2, opts...)...)
	// ManifestFieldType is list
	lines = append(lines, pretty.Header(depth+1, fmt.Sprintf("IBBSegments: Array of \"IBB Segment\" of length %d", len(s.IBBSegments)), s.IBBSegments))
	for i := 0; i < len(s.IBBSegments); i++ {
		lines = append(lines, fmt.Sprintf("%sitem #%d: ", strings.Repeat("  ", int(depth+2)), i)+strings.TrimSpace(s.IBBSegments[i].PrettyString(depth+2, true)))
	}
	if depth < 1 {
		lines = append(lines, "")
	}
	if depth < 2 {
		lines = append(lines, "")
	}
	return strings.Join(lines, "\n")
}

// PrettyString returns the bits of the flags in an easy-to-read format.
func (flags CachingType) PrettyString(depth uint, withHeader bool, opts ...pretty.Option) string {
	return flags.String()
}

// PrettyString returns the bits of the flags in an easy-to-read format.
func (flags PBETValue) PrettyString(depth uint, withHeader bool, opts ...pretty.Option) string {
	var lines []string
	if withHeader {
		lines = append(lines, pretty.Header(depth, "PBET Value", flags))
	}
	lines = append(lines, pretty.SubValue(depth+1, "PBET Value", "", flags.PBETValue(), opts...)...)
	return strings.Join(lines, "\n")
}

// PrettyString returns the bits of the flags in an easy-to-read format.
func (flags SEFlags) PrettyString(depth uint, withHeader bool, opts ...pretty.Option) string {
	var lines []string
	if withHeader {
		lines = append(lines, pretty.Header(depth, "SE Flags", flags))
	}
	lines = append(lines, pretty.SubValue(depth+1, "Reserved 0", "", flags.Reserved0(), opts...)...)
	if flags.SupportsTopSwapRemediation() {
		lines = append(lines, pretty.SubValue(depth+1, "Supports Top Swap Remediation", "BIOS supports Top Swap remediation action", true, opts...)...)
	} else {
		lines = append(lines, pretty.SubValue(depth+1, "Supports Top Swap Remediation", "BIOS does not support Top Swap remediation action", false, opts...)...)
	}
	if flags.TPMFailureLeavesHierarchiesEnabled() {
		lines = append(lines, pretty.SubValue(depth+1, "TPM Failure Leaves Hierarchies Enabled", "Leave Hierarchies enabled. Cap all PCRs on failure.", true, opts...)...)
	} else {
		lines = append(lines, pretty.SubValue(depth+1, "TPM Failure Leaves Hierarchies Enabled", "Do not leave enabled. Disable all Hierarchies or deactivate on failure.", false, opts...)...)
	}
	if flags.AuthorityMeasure() {
		lines = append(lines, pretty.SubValue(depth+1, "Authority Measure", "Extend Authority Measurements into the Authority PCR 7", true, opts...)...)
	} else {
		lines = append(lines, pretty.SubValue(depth+1, "Authority Measure", "Do not extend into the Authority PCR 7", false, opts...)...)
	}
	if flags.Locality3Startup() {
		lines = append(lines, pretty.SubValue(depth+1, "Locality 3 Startup", "Issue TPM Start-up from Locality 3", true, opts...)...)
	} else {
		lines = append(lines, pretty.SubValue(depth+1, "Locality 3 Startup", "Disabled", false, opts...)...)
	}
	if flags.DMAProtection() {
		lines = append(lines, pretty.SubValue(depth+1, "DMA Protection", "Enable DMA Protection", true, opts...)...)
	} else {
		lines = append(lines, pretty.SubValue(depth+1, "DMA Protection", "Disable DMA Protection", false, opts...)...)
	}
	return strings.Join(lines, "\n")
}