blkid

Documentation

Overview

Package blkid provides information about blockdevice filesystem types and IDs.

Index

• Variables
• type Info
  • func Probe(f *os.File, opts ...ProbeOption) (*Info, error)
  • func ProbePath(devpath string, opts ...ProbeOption) (*Info, error)
• type NestedProbeResult
• type NestedResult
• type ProbeOption
  • func WithProbeLogger(logger *zap.Logger) ProbeOption
  • func WithSkipLocking(skip bool) ProbeOption
• type ProbeOptions
• type ProbeResult

Variables

var (
	ErrFailedLock = errors.New("failed to acquire shared lock while probing blockdevice")
)

Common errors.

Types

type Info

type Info struct {
	// Link to the block device, only if the probed file is a blockdevice.
	BlockDevice *block.Device

	// DevNo is the device number of the probed device.
	//
	// Only available if the probed file is a blockdevice.
	DevNo uint64

	// WholeDisk is true if the probed device is a whole disk.
	//
	// Only available if the probed file is a blockdevice.
	WholeDisk bool

	// Overall size of the probed device (in bytes).
	Size uint64

	// Sector size of the device (in bytes).
	SectorSize uint

	// Optimal I/O size for the device (in bytes).
	IOSize uint

	// ProbeResult is the result of probing the device.
	ProbeResult

	// Parts is the result of probing the nested filesystem/partitions.
	Parts []NestedProbeResult
}

Info represents the result of the probe.

func Probe

func Probe(f *os.File, opts ...ProbeOption) (*Info, error)

Probe returns the probe information for the specified file.

func ProbePath

func ProbePath(devpath string, opts ...ProbeOption) (*Info, error)

ProbePath returns the probe information for the specified path.

type NestedProbeResult

type NestedProbeResult struct {
	NestedResult
	ProbeResult

	Parts []NestedProbeResult
}

NestedProbeResult is a result of probing a nested filesystem/partition.

type NestedResult

type NestedResult struct {
	PartitionUUID  *uuid.UUID
	PartitionType  *uuid.UUID
	PartitionLabel *string
	PartitionIndex uint // 1-based index

	PartitionOffset, PartitionSize uint64
}

NestedResult is result of probing a nested filesystem/partition.

It annotates the ProbeResult with the partition information.

type ProbeOption

type ProbeOption func(*ProbeOptions)

ProbeOption is an option for probing.

func WithProbeLogger

func WithProbeLogger(logger *zap.Logger) ProbeOption

WithProbeLogger sets the logger for the probe.

func WithSkipLocking

func WithSkipLocking(skip bool) ProbeOption

WithSkipLocking skips locking blockdevices in shared mode.

type ProbeOptions

type ProbeOptions struct {
	// Logger to use for logging.
	Logger *zap.Logger
	// SkipLocking blockdevices in shared mode.
	SkipLocking bool
}

ProbeOptions is the options for probing.

type ProbeResult

type ProbeResult struct {
	Name  string
	UUID  *uuid.UUID
	Label *string

	BlockSize           uint32
	FilesystemBlockSize uint32
	ProbedSize          uint64
}

ProbeResult is a result of probing a single filesystem/partition.