util

Documentation

Index

• Constants
• Variables
• func CheckBackupType(backupTarget string) (string, error)
• func ConvertFromQcow2ToRaw(sourcePath, targetPath string) error
• func ConvertFromRawToQcow2(filePath string) error
• func CopyFile(srcPath, dstPath string) (int64, error)
• func DetectGRPCServerAvailability(address string, waitIntervalInSecond int, shouldAvailable bool) bool
• func DetectHTTPServerAvailability(url string, waitIntervalInSecond int, shouldAvailable bool) bool
• func Execute(envs []string, binary string, args ...string) (string, error)
• func ExecuteWithTimeout(timeout time.Duration, envs []string, binary string, args ...string) (string, error)
• func FileModificationTime(filePath string) string
• func GetDiskConfig(diskPath string) (string, error)
• func GetFileChecksum(filePath string) (string, error)
• func GetHTTPClientErrorPrefix(stateCode int) string
• func GetIPForPod() (ip string, err error)
• func GetLocalIPv4fromInterface(name string) (ip string, err error)
• func GetSyncServiceAddressWithPodIP(address string) (string, error)
• func GetSyncingFileConfigFilePath(syncingFilePath string) string
• func GunzipFile(filePath string, dstFilePath string) error
• func IsGRPCErrorMatchingCode(err error, errCode codes.Code) bool
• func IsGRPCErrorNotFound(err error) bool
• func IsHTTPClientErrorNotFound(inputErr error) bool
• func PrintJSON(obj interface{}) error
• func ValidBackingImageName(name string) bool
• func WriteSyncingFileConfig(configFilePath string, config *SyncingFileConfig) (err error)
• type Bitmap
  • func NewBitmap(start, end int32) *Bitmap
  • func (b *Bitmap) AllocateRange(count int32) (int32, int32, error)
  • func (b *Bitmap) ReleaseRange(start, end int32) error
• type DiskConfig
• type QemuImgInfo
  • func GetQemuImgInfo(filePath string) (imgInfo QemuImgInfo, err error)
• type SyncingFileConfig
  • func ReadSyncingFileConfig(configFilePath string) (*SyncingFileConfig, error)

Constants

const (
	HTTPClientErrorPrefixTemplate = "resp.StatusCode(%d) != http.StatusOK(200)"

	EnvPodIP = "POD_IP"

	StorageNetworkInterface = "lhnet1"
)

const (
	DiskConfigFile = "longhorn-disk.cfg"
)

DiskConfigFile should be the same as the schema in longhorn-manager/util

const (
	QemuImgBinary = "qemu-img"
)

const (
	SyncingFileConfigFileSuffix = ".cfg"
)

Variables

var (
	MaximumBackingImageNameSize = 64
)

Functions

func CheckBackupType

func CheckBackupType(backupTarget string) (string, error)

func ConvertFromQcow2ToRaw

func ConvertFromQcow2ToRaw(sourcePath, targetPath string) error

func ConvertFromRawToQcow2

func ConvertFromRawToQcow2(filePath string) error

func CopyFile

func CopyFile(srcPath, dstPath string) (int64, error)

func DetectGRPCServerAvailability

func DetectGRPCServerAvailability(address string, waitIntervalInSecond int, shouldAvailable bool) bool

func DetectHTTPServerAvailability

func DetectHTTPServerAvailability(url string, waitIntervalInSecond int, shouldAvailable bool) bool

func Execute

func Execute(envs []string, binary string, args ...string) (string, error)

func ExecuteWithTimeout

func ExecuteWithTimeout(timeout time.Duration, envs []string, binary string, args ...string) (string, error)

func FileModificationTime

func FileModificationTime(filePath string) string

func GetDiskConfig

func GetDiskConfig(diskPath string) (string, error)

func GetFileChecksum

func GetFileChecksum(filePath string) (string, error)

func GetHTTPClientErrorPrefix

func GetHTTPClientErrorPrefix(stateCode int) string

func GetIPForPod

func GetIPForPod() (ip string, err error)

func GetLocalIPv4fromInterface

func GetLocalIPv4fromInterface(name string) (ip string, err error)

func GetSyncServiceAddressWithPodIP

func GetSyncServiceAddressWithPodIP(address string) (string, error)

func GetSyncingFileConfigFilePath

func GetSyncingFileConfigFilePath(syncingFilePath string) string

func GunzipFile

func GunzipFile(filePath string, dstFilePath string) error

func IsGRPCErrorMatchingCode

func IsGRPCErrorMatchingCode(err error, errCode codes.Code) bool

func IsGRPCErrorNotFound

func IsGRPCErrorNotFound(err error) bool

func IsHTTPClientErrorNotFound

func IsHTTPClientErrorNotFound(inputErr error) bool

func PrintJSON

func PrintJSON(obj interface{}) error

func ValidBackingImageName

func ValidBackingImageName(name string) bool

func WriteSyncingFileConfig

func WriteSyncingFileConfig(configFilePath string, config *SyncingFileConfig) (err error)

Types

type Bitmap

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

func NewBitmap

func NewBitmap(start, end int32) *Bitmap

NewBitmap allocate a bitmap range from [start, end], notice the end is included

func (*Bitmap) AllocateRange

func (b *Bitmap) AllocateRange(count int32) (int32, int32, error)

func (*Bitmap) ReleaseRange

func (b *Bitmap) ReleaseRange(start, end int32) error

type DiskConfig

type DiskConfig struct {
	DiskUUID string `json:"diskUUID"`
}

type QemuImgInfo

type QemuImgInfo struct {
	// For qcow2 files, VirtualSize may be larger than the physical
	// image size on disk.  For raw files, `qemu-img info` will report
	// VirtualSize as being the same as the physical file size.
	VirtualSize int64  `json:"virtual-size"`
	Format      string `json:"format"`
}

func GetQemuImgInfo

func GetQemuImgInfo(filePath string) (imgInfo QemuImgInfo, err error)

type SyncingFileConfig

type SyncingFileConfig struct {
	FilePath         string `json:"name"`
	UUID             string `json:"uuid"`
	Size             int64  `json:"size"`
	VirtualSize      int64  `json:"virtualSize"`
	ExpectedChecksum string `json:"expectedChecksum"`
	CurrentChecksum  string `json:"currentChecksum"`
	ModificationTime string `json:"modificationTime"`
}

func ReadSyncingFileConfig

func ReadSyncingFileConfig(configFilePath string) (*SyncingFileConfig, error)