mm

README

Experimental memory-allocator generator, based on https://www.youtube.com/watch?v=mCrVYYlFTrA.

NB: This is only a proof-of-concept implementation, nothing else. It has bugs, problems, it could be smarter, not as nice to use etc... So don't use this in production nor anywhere... it's just a proof-of-concept, nothing else.

To generate an example: go run gen.go.

Notes: It rarely makes sense to use such custom-allocators in Go. If you need to use it, you might be better off implementing that thing in some other language (e.g. C++, D, Rust, C etc.).

Documentation

Index

• Constants
• func Generate(def string, specs map[string]*Spec) ([]byte, error)
• type Aligned
  • func (m Aligned) Alignment() int
  • func (m Aligned) Alloc(size int) unsafe.Pointer
  • func (m Aligned) Dealloc(p unsafe.Pointer) bool
  • func (m Aligned) Realloc(p *unsafe.Pointer, size int) bool
• type Allocator
• type Deallocator
• type Emptyer
• type Error
  • func (err *Error) Error() string
• type Malloc
  • func (m Malloc) Alignment() int
  • func (m Malloc) Alloc(size int) unsafe.Pointer
  • func (m Malloc) Dealloc(p unsafe.Pointer) bool
  • func (m Malloc) Realloc(p *unsafe.Pointer, size int) bool
• type Owner
• type Reallocator
• type Spec
  • func SpecFor(v Allocator) *Spec

Constants

const FallbackDef = `` /* 919-byte string literal not displayed */

const PlatformAlignment = 4 // todo: add build tags

Functions

func Generate

func Generate(def string, specs map[string]*Spec) ([]byte, error)

Types

type Aligned

type Aligned struct{}

func (Aligned) Alignment

func (m Aligned) Alignment() int

func (Aligned) Alloc

func (m Aligned) Alloc(size int) unsafe.Pointer

func (Aligned) Dealloc

func (m Aligned) Dealloc(p unsafe.Pointer) bool

func (Aligned) Realloc

func (m Aligned) Realloc(p *unsafe.Pointer, size int) bool

type Allocator

type Allocator interface {
	Alignment() int
	Alloc(size int) unsafe.Pointer
}

type Deallocator

type Deallocator interface {
	Dealloc(p unsafe.Pointer) bool
}

type Emptyer

type Emptyer interface {
	Empty() bool
}

type Error

type Error struct {
	Message   error
	Generated []byte
}

func (*Error) Error

func (err *Error) Error() string

type Malloc

type Malloc struct{}

func (Malloc) Alignment

func (m Malloc) Alignment() int

func (Malloc) Alloc

func (m Malloc) Alloc(size int) unsafe.Pointer

func (Malloc) Dealloc

func (m Malloc) Dealloc(p unsafe.Pointer) bool

func (Malloc) Realloc

func (m Malloc) Realloc(p *unsafe.Pointer, size int) bool

type Owner

type Owner interface {
	Owns(p unsafe.Pointer) bool
}

type Reallocator

type Reallocator interface {
	Realloc(p *unsafe.Pointer, size int) bool
}

type Spec

type Spec struct {
	Type      string
	Alignment int
	Dealloc   bool
	Owns      bool
	Empty     bool
}

func SpecFor

func SpecFor(v Allocator) *Spec