cutil

Documentation

Index

• Constants
• func Free(p CPtr)
• func Memcpy(dst, src CPtr, n SizeT)
• func SplitBuffer(b []byte) []string
• func SplitSparseBuffer(b []byte) []string
• type CPtr
  • func CBytes(b []byte) CPtr
  • func Malloc(s SizeT) CPtr
• type CPtrCSlice
  • func NewCPtrCSlice(size int) CPtrCSlice
  • func (v *CPtrCSlice) Free()
  • func (v *CPtrCSlice) Ptr() CPtr
• type CharPtr
  • func CString(s string) CharPtr
• type CharPtrPtr
• type CommandInput
  • func NewCommandInput(cmd [][]byte, inputBuffer []byte) *CommandInput
  • func (ci *CommandInput) Cmd() CharPtrPtr
  • func (ci *CommandInput) CmdLen() SizeT
  • func (ci *CommandInput) Free()
  • func (ci *CommandInput) InBuf() CharPtr
  • func (ci *CommandInput) InBufLen() SizeT
• type CommandOutput
  • func NewCommandOutput() *CommandOutput
  • func (co *CommandOutput) Free()
  • func (co *CommandOutput) GoValues() (buf []byte, status string)
  • func (co *CommandOutput) OutBuf() CharPtrPtr
  • func (co *CommandOutput) OutBufLen() SizeTPtr
  • func (co *CommandOutput) Outs() CharPtrPtr
  • func (co *CommandOutput) OutsLen() SizeTPtr
  • func (co *CommandOutput) SetFreeFunc(f FreeFunc) *CommandOutput
• type FreeFunc
• type Iovec
  • func ByteSlicesToIovec(data [][]byte) (v Iovec)
  • func (v *Iovec) Free()
  • func (v *Iovec) Len() int
  • func (v *Iovec) Pointer() unsafe.Pointer
  • func (v *Iovec) Sync()
• type PtrGuard
  • func NewPtrGuard(cPtr CPtr, goPtr unsafe.Pointer) *PtrGuard
  • func (v *PtrGuard) Release()
• type SizeT
• type SizeTCSlice
  • func NewSizeTCSlice(size int) SizeTCSlice
  • func (v *SizeTCSlice) Free()
  • func (v *SizeTCSlice) Ptr() CPtr
• type SizeTPtr
• type SyncBuffer
  • func NewSyncBuffer(cPtr CPtr, data []byte) *SyncBuffer
  • func (v *SyncBuffer) Release()
  • func (v *SyncBuffer) Sync()

Constants

const (
	// MaxIdx is the maximum index on 32 bit systems
	MaxIdx = math.MaxInt32 // 2GB, max int32 value, should be safe

	// PtrSize is the size of a pointer
	PtrSize = C.sizeof_voidptr

	// SizeTSize is the size of C.size_t
	SizeTSize = C.sizeof_size_t
)

Functions

func Free

func Free(p CPtr)

Free is C.free

func Memcpy

func Memcpy(dst, src CPtr, n SizeT)

Memcpy is C.memcpy

func SplitBuffer

func SplitBuffer(b []byte) []string

SplitBuffer splits a byte-slice buffer, typically returned from C code, into a slice of strings. The contents of the buffer are assumed to be null-byte separated. If the buffer contains a sequence of null-bytes it will assume that the "space" between the bytes are meant to be empty strings.

func SplitSparseBuffer

func SplitSparseBuffer(b []byte) []string

SplitSparseBuffer splits a byte-slice buffer, typically returned from C code, into a slice of strings. The contents of the buffer are assumed to be null-byte separated. This function assumes that buffer to be "sparse" such that only non-null-byte strings will be returned, and no "empty" strings exist if null-bytes are found adjacent to each other.

Types

type CPtr

type CPtr unsafe.Pointer

CPtr is an unsafe.Pointer to C allocated memory

func CBytes

func CBytes(b []byte) CPtr

CBytes is C.CBytes

func Malloc

func Malloc(s SizeT) CPtr

Malloc is C.malloc

type CPtrCSlice

type CPtrCSlice []CPtr

CPtrCSlice is a C allocated slice of C pointers.

func NewCPtrCSlice

func NewCPtrCSlice(size int) CPtrCSlice

NewCPtrCSlice returns a CPtrSlice. Similar to CString it must be freed with slice.Free()

func (*CPtrCSlice) Free

func (v *CPtrCSlice) Free()

Free frees a CPtrSlice

func (*CPtrCSlice) Ptr

func (v *CPtrCSlice) Ptr() CPtr

Ptr returns a pointer to CPtrSlice

type CharPtr

type CharPtr unsafe.Pointer

CharPtr is an unsafe pointer wrapping C's `char*`.

func CString

func CString(s string) CharPtr

CString is C.CString

type CharPtrPtr

type CharPtrPtr unsafe.Pointer

CharPtrPtr is an unsafe pointer wrapping C's `char**`.

type CommandInput

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

CommandInput can be used to manage the input to ceph's *_command functions.

func NewCommandInput

func NewCommandInput(cmd [][]byte, inputBuffer []byte) *CommandInput

NewCommandInput creates C-level pointers from go byte buffers suitable for passing off to ceph's *_command functions.

func (*CommandInput) Cmd

func (ci *CommandInput) Cmd() CharPtrPtr

Cmd returns an unsafe wrapper around an array of C-strings.

func (*CommandInput) CmdLen

func (ci *CommandInput) CmdLen() SizeT

CmdLen returns the length of the array of C-strings returned by Cmd.

func (*CommandInput) Free

func (ci *CommandInput) Free()

Free any C memory managed by this CommandInput.

func (*CommandInput) InBuf

func (ci *CommandInput) InBuf() CharPtr

InBuf returns an unsafe wrapper to a C char*.

func (*CommandInput) InBufLen

func (ci *CommandInput) InBufLen() SizeT

InBufLen returns the length of the buffer returned by InBuf.

type CommandOutput

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

CommandOutput can be used to manage the outputs of ceph's *_command functions.

func NewCommandOutput

func NewCommandOutput() *CommandOutput

NewCommandOutput returns an empty CommandOutput. The pointers that a CommandOutput provides can be used to get the results of ceph's *_command functions.

func (*CommandOutput) Free

func (co *CommandOutput) Free()

Free any C memory tracked by this object.

func (*CommandOutput) GoValues

func (co *CommandOutput) GoValues() (buf []byte, status string)

GoValues returns native go values converted from the internal C-language values tracked by this object.

func (*CommandOutput) OutBuf

func (co *CommandOutput) OutBuf() CharPtrPtr

OutBuf returns an unsafe wrapper around a pointer to a `char*`.

func (*CommandOutput) OutBufLen

func (co *CommandOutput) OutBufLen() SizeTPtr

OutBufLen returns an unsafe wrapper around a pointer to a size_t.

func (*CommandOutput) Outs

func (co *CommandOutput) Outs() CharPtrPtr

Outs returns an unsafe wrapper around a pointer to a `char*`.

func (*CommandOutput) OutsLen

func (co *CommandOutput) OutsLen() SizeTPtr

OutsLen returns an unsafe wrapper around a pointer to a size_t.

func (*CommandOutput) SetFreeFunc

func (co *CommandOutput) SetFreeFunc(f FreeFunc) *CommandOutput

SetFreeFunc sets the function used to free memory held by CommandOutput. Not all uses of CommandOutput expect to use the basic C.free function and either require or prefer the use of a custom deallocation function. Use SetFreeFunc to change the free function and return the modified CommandOutput object.

type FreeFunc

type FreeFunc func(unsafe.Pointer)

FreeFunc is a wrapper around calls to, or act like, C's free function.

type Iovec

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

Iovec is a slice of iovec structs. Might have allocated C memory, so it must be freed with the Free() method.

func ByteSlicesToIovec

func ByteSlicesToIovec(data [][]byte) (v Iovec)

ByteSlicesToIovec creates an Iovec and links it to Go buffers in data.

func (*Iovec) Free

func (v *Iovec) Free()

Free the C memory in the Iovec.

func (*Iovec) Len

func (v *Iovec) Len() int

Len returns a pointer to the iovec

func (*Iovec) Pointer

func (v *Iovec) Pointer() unsafe.Pointer

Pointer returns a pointer to the iovec

func (*Iovec) Sync

func (v *Iovec) Sync()

Sync makes sure the slices contain the same as the C buffers

type PtrGuard

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

PtrGuard respresents a guarded Go pointer (pointing to memory allocated by Go runtime) stored in C memory (allocated by C)

func NewPtrGuard

func NewPtrGuard(cPtr CPtr, goPtr unsafe.Pointer) *PtrGuard

NewPtrGuard writes the goPtr (pointing to Go memory) into C memory at the position cPtr, and returns a PtrGuard object.

func (*PtrGuard) Release

func (v *PtrGuard) Release()

Release removes the guarded Go pointer from the C memory by overwriting it with NULL.

type SizeT

type SizeT C.size_t

SizeT wraps size_t from C.

type SizeTCSlice

type SizeTCSlice []SizeT

SizeTCSlice is a C allocated slice of C.size_t.

func NewSizeTCSlice

func NewSizeTCSlice(size int) SizeTCSlice

NewSizeTCSlice returns a SizeTCSlice. Similar to CString it must be freed with slice.Free()

func (*SizeTCSlice) Free

func (v *SizeTCSlice) Free()

Free frees a SizeTCSlice

func (*SizeTCSlice) Ptr

func (v *SizeTCSlice) Ptr() CPtr

Ptr returns a pointer to SizeTCSlice

type SizeTPtr

type SizeTPtr unsafe.Pointer

SizeTPtr is an unsafe pointer wrapping C's `size_t*`.

type SyncBuffer

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

SyncBuffer is a C buffer connected to a data slice

func NewSyncBuffer

func NewSyncBuffer(cPtr CPtr, data []byte) *SyncBuffer

NewSyncBuffer creates a C buffer from a data slice and stores it at CPtr

func (*SyncBuffer) Release

func (v *SyncBuffer) Release()

Release releases the C buffer and nulls its stored pointer

func (*SyncBuffer) Sync

func (v *SyncBuffer) Sync()

Sync asserts that changes in the C buffer are available in the data slice