buse

README

Linux userspace virtual block device in Go

The idea is similar to FUSE but works for block devices. It uses nbd over a unix socket.

Usage scenario

package main

import (
    "github.com/dop251/buse"
    "github.com/dop251/nbd"
)

// Implement your custom driver as nbd.Driver.
var driver nbd.Driver = ....

dev := buse.NewDevice("/dev/nbd0", size, driver)
dev.Run()
// The device will become available as /dev/nbd0

Documentation

Index

• type Device
  • func NewDevice(device string, size int64, driver nbd.Driver) (*Device, error)
  • func (bd *Device) Disconnect()
  • func (bd *Device) Run() error
  • func (bd *Device) SetBlockSize(size int)
  • func (bd *Device) SetLogger(log *logrus.Logger)
  • func (bd *Device) SetMaxProc(p int)
  • func (bd *Device) SetPool(pool nbd.ProcPool)
  • func (bd *Device) SetReadOnly(flag bool)

Types

type Device

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

func NewDevice

func NewDevice(device string, size int64, driver nbd.Driver) (*Device, error)

func (*Device) Disconnect

func (bd *Device) Disconnect()

Disconnect disconnects the Device and interrupts the Run()

func (*Device) Run

func (bd *Device) Run() error

Run connects a Device to an actual device file and starts handling requests. It does not return until it's done serving requests.

func (*Device) SetBlockSize

func (bd *Device) SetBlockSize(size int)

func (*Device) SetLogger

func (bd *Device) SetLogger(log *logrus.Logger)

func (*Device) SetMaxProc

func (bd *Device) SetMaxProc(p int)

func (*Device) SetPool

func (bd *Device) SetPool(pool nbd.ProcPool)

func (*Device) SetReadOnly

func (bd *Device) SetReadOnly(flag bool)