mount

package
v1.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 13, 2019 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Overview

Package mount defines an interface to mounting filesystems.

Index

Constants

View Source
const (
	// FakeActionMount is the string for specifying mount as FakeAction.Action
	FakeActionMount = "mount"
	// FakeActionUnmount is the string for specifying unmount as FakeAction.Action
	FakeActionUnmount = "unmount"
)

Variables

This section is empty.

Functions

func CleanupMountPoint added in v1.11.7

func CleanupMountPoint(mountPath string, mounter Interface, extensiveMountPointCheck bool) error

CleanupMountPoint unmounts the given path and deletes the remaining directory if successful. If extensiveMountPointCheck is true IsNotMountPoint will be called instead of IsLikelyNotMountPoint. IsNotMountPoint is more expensive but properly handles bind mounts within the same fs.

func GetDeviceNameFromMount added in v0.15.0

func GetDeviceNameFromMount(mounter Interface, mountPath string) (string, int, error)

GetDeviceNameFromMount given a mnt point, find the device from /proc/mounts returns the device name, reference count, and error code.

func IsCorruptedMnt added in v1.11.7

func IsCorruptedMnt(err error) bool

IsCorruptedMnt return true if err is about corrupted mount point

func IsNotMountPoint added in v1.4.5

func IsNotMountPoint(mounter Interface, file string) (bool, error)

IsNotMountPoint determines if a directory is a mountpoint. It should return ErrNotExist when the directory does not exist. IsNotMountPoint is more expensive than IsLikelyNotMountPoint. IsNotMountPoint detects bind mounts in linux. IsNotMountPoint enumerates all the mountpoints using List() and the list of mountpoints may be large, then it uses isMountPointMatch to evaluate whether the directory is a mountpoint.

func MakeBindOpts added in v1.16.0

func MakeBindOpts(options []string) (bool, []string, []string)

MakeBindOpts detects whether a bind mount is being requested and makes the remount options to use in case of bind mount, due to the fact that bind mount doesn't respect mount options. The list equals:

options - 'bind' + 'remount' (no duplicate)

func PathExists added in v1.11.7

func PathExists(path string) (bool, error)

PathExists returns true if the specified path exists. TODO: clean this up to use pkg/util/file/FileExists

func PathWithinBase added in v1.12.0

func PathWithinBase(fullPath, basePath string) bool

PathWithinBase checks if give path is within given base directory.

func StartsWithBackstep added in v1.14.0

func StartsWithBackstep(rel string) bool

StartsWithBackstep checks if the given path starts with a backstep segment.

Types

type Exec added in v1.8.0

type Exec interface {
	// Run executes a command and returns its stdout + stderr combined in one
	// stream.
	Run(cmd string, args ...string) ([]byte, error)
}

Exec is an interface for executing commands on systems.

func NewOSExec added in v1.16.0

func NewOSExec() Exec

NewOSExec returns a new Exec interface implementation based on exec()

type FakeAction added in v0.13.1

type FakeAction struct {
	Action string // "mount" or "unmount"
	Target string // applies to both mount and unmount actions
	Source string // applies only to "mount" actions
	FSType string // applies only to "mount" actions
}

FakeAction objects are logged every time a fake mount or unmount is called.

type FakeExec added in v1.8.0

type FakeExec struct {
	// contains filtered or unexported fields
}

FakeExec for testing.

func NewFakeExec added in v1.8.0

func NewFakeExec(run runHook) *FakeExec

NewFakeExec returns a new FakeExec

func (*FakeExec) Run added in v1.8.0

func (f *FakeExec) Run(cmd string, args ...string) ([]byte, error)

Run executes the command using the optional runhook, if given

type FakeMounter added in v0.13.0

type FakeMounter struct {
	MountPoints []MountPoint
	Log         []FakeAction
	// Error to return for a path when calling IsLikelyNotMountPoint
	MountCheckErrors map[string]error
	// contains filtered or unexported fields
}

FakeMounter implements mount.Interface for tests.

func (*FakeMounter) GetMountRefs added in v1.11.0

func (f *FakeMounter) GetMountRefs(pathname string) ([]string, error)

GetMountRefs finds all mount references to the path, returns a list of paths.

func (*FakeMounter) IsLikelyNotMountPoint added in v1.1.0

func (f *FakeMounter) IsLikelyNotMountPoint(file string) (bool, error)

IsLikelyNotMountPoint determines whether a path is a mountpoint by checking if the absolute path to file is in the in-memory mountpoints

func (*FakeMounter) List added in v0.13.0

func (f *FakeMounter) List() ([]MountPoint, error)

List returns all the in-memory mountpoints for FakeMounter

func (*FakeMounter) Mount added in v0.13.0

func (f *FakeMounter) Mount(source string, target string, fstype string, options []string) error

Mount records the mount event and updates the in-memory mount points for FakeMounter

func (*FakeMounter) ResetLog added in v0.13.1

func (f *FakeMounter) ResetLog()

ResetLog clears all the log entries in FakeMounter

func (*FakeMounter) Unmount added in v0.13.0

func (f *FakeMounter) Unmount(target string) error

Unmount records the unmount event and updates the in-memory mount points for FakeMounter

type Interface

type Interface interface {
	// Mount mounts source to target as fstype with given options.
	Mount(source string, target string, fstype string, options []string) error
	// Unmount unmounts given target.
	Unmount(target string) error
	// List returns a list of all mounted filesystems.  This can be large.
	// On some platforms, reading mounts directly from the OS is not guaranteed
	// consistent (i.e. it could change between chunked reads). This is guaranteed
	// to be consistent.
	List() ([]MountPoint, error)
	// IsLikelyNotMountPoint uses heuristics to determine if a directory
	// is not a mountpoint.
	// It should return ErrNotExist when the directory does not exist.
	// IsLikelyNotMountPoint does NOT properly detect all mountpoint types
	// most notably linux bind mounts and symbolic link.
	IsLikelyNotMountPoint(file string) (bool, error)
	// GetMountRefs finds all mount references to the path, returns a
	// list of paths. Path could be a mountpoint path, device or a normal
	// directory (for bind mount).
	GetMountRefs(pathname string) ([]string, error)
}

Interface defines the set of methods to allow for mount operations on a system.

func New

func New(mounterPath string) Interface

New returns a mount.Interface for the current system. It provides options to override the default mounter behavior. mounterPath allows using an alternative to `/bin/mount` for mounting.

type MountInfo added in v1.16.0

type MountInfo struct {
	// Unique ID for the mount (maybe reused after umount).
	ID int
	// The ID of the parent mount (or of self for the root of this mount namespace's mount tree).
	ParentID int
	// The value of `st_dev` for files on this filesystem.
	MajorMinor string
	// The pathname of the directory in the filesystem which forms the root of this mount.
	Root string
	// Mount source, filesystem-specific information. e.g. device, tmpfs name.
	Source string
	// Mount point, the pathname of the mount point.
	MountPoint string
	// Optional fieds, zero or more fields of the form "tag[:value]".
	OptionalFields []string
	// The filesystem type in the form "type[.subtype]".
	FsType string
	// Per-mount options.
	MountOptions []string
	// Per-superblock options.
	SuperOptions []string
}

MountInfo represents a single line in /proc/<pid>/mountinfo.

func ParseMountInfo added in v1.16.0

func ParseMountInfo(filename string) ([]MountInfo, error)

ParseMountInfo parses /proc/xxx/mountinfo.

type MountPoint

type MountPoint struct {
	Device string
	Path   string
	Type   string
	Opts   []string
	Freq   int
	Pass   int
}

MountPoint represents a single line in /proc/mounts or /etc/fstab.

type Mounter added in v0.10.0

type Mounter struct {
	// contains filtered or unexported fields
}

Mounter implements mount.Interface for unsupported platforms

func (*Mounter) GetMountRefs added in v1.11.0

func (mounter *Mounter) GetMountRefs(pathname string) ([]string, error)

GetMountRefs always returns an error on unsupported platforms

func (*Mounter) IsLikelyNotMountPoint added in v1.1.0

func (mounter *Mounter) IsLikelyNotMountPoint(file string) (bool, error)

IsLikelyNotMountPoint always returns an error on unsupported platforms

func (*Mounter) List added in v0.10.0

func (mounter *Mounter) List() ([]MountPoint, error)

List always returns an error on unsupported platforms

func (*Mounter) Mount added in v0.10.0

func (mounter *Mounter) Mount(source string, target string, fstype string, options []string) error

Mount always returns an error on unsupported platforms

func (*Mounter) Unmount added in v0.10.0

func (mounter *Mounter) Unmount(target string) error

Unmount always returns an error on unsupported platforms

type SafeFormatAndMount added in v1.1.0

type SafeFormatAndMount struct {
	Interface
	Exec
}

SafeFormatAndMount probes a device to see if it is formatted. Namely it checks to see if a file system is present. If so it mounts it otherwise the device is formatted first then mounted.

func (*SafeFormatAndMount) FormatAndMount added in v1.2.0

func (mounter *SafeFormatAndMount) FormatAndMount(source string, target string, fstype string, options []string) error

FormatAndMount formats the given disk, if needed, and mounts it. That is if the disk is not formatted and it is not being mounted as read-only it will format it first then mount it. Otherwise, if the disk is already formatted or it is being mounted as read-only, it will be mounted without formatting.

Jump to

Keyboard shortcuts

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