disk

Documentation

Overview

Package disk contains helpers to interact with the disk.

Index

• func DropCaches(ctx context.Context) error
• func Fill(dir string, tofill uint64) (string, error)
• func FillUntil(dir string, remaining uint64) (string, error)
• func FreeSpace(path string) (uint64, error)
• type Refiller
  • func NewRefiller(dir string) Refiller
  • func (r *Refiller) Close() error
  • func (r *Refiller) Refill(tofill uint64) error
  • func (r *Refiller) RefillUntil(remaining uint64) error

Functions

func DropCaches

func DropCaches(ctx context.Context) error

DropCaches will write dirty pages to disk with 'sync' so that they are not available for freeing and thus helps drop_caches to free more memory from file system and IO operations. 'drop_caches' will clear clean page caches, dentries (directory caches), and inodes (file caches).

func Fill

func Fill(dir string, tofill uint64) (string, error)

Fill creates a temporary file in a directory that fills the disk by allocating it, but without performing any actual IO to write the content.

func FillUntil

func FillUntil(dir string, remaining uint64) (string, error)

FillUntil reates a temporary file in a directory that fills the disk until less than remaining bytes are available.

func FreeSpace

func FreeSpace(path string) (uint64, error)

FreeSpace returns the number of free bytes available at a specific path

Types

type Refiller

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

Refiller maintains the temporary fill file for you, so you can easily (re-)adjust the disk space.

func NewRefiller

func NewRefiller(dir string) Refiller

NewRefiller creates a new refiller. `dir` is the directory to put the temporary file in.

Example:

refiller := NewRefiller(...)
defer func() {
  if err := refiller.Close(); err != nil {
    s.Error(...)
  }
}()
refiller.RefillUntil(...)
...
refiller.RefillUntil(...)
...

func (*Refiller) Close

func (r *Refiller) Close() error

Close removes the temporary file if there is one. You can call it as many times as you want, and you should also call it at the end of your tast to clean things up.

func (*Refiller) Refill

func (r *Refiller) Refill(tofill uint64) error

Refill removes the temporary file previously created, and then fill the disk. See `Fill()`.

func (*Refiller) RefillUntil

func (r *Refiller) RefillUntil(remaining uint64) error

RefillUntil removes the temporary file previously created, and then fill the disk. See `FillUntil()`.