mmap

type Context struct {
	Size     int64
	Name     string
	Metadata map[string]string
}

type Descriptor struct {
	Bytes           []byte
	Warning         error
	ReporterOptions ReporterOptions
}

type FileDesc struct {
	// file is the *os.File ref to store
	File **os.File
	// bytes is the []byte slice ref to store the mmap'd address
	Descriptor *Descriptor
	// options specifies options to use when mmaping a file
	Options Options
}

type FileOpener func(filePath string) (*os.File, error)

type FilesResult struct {
	Warning error
}

type HugeTLBOptions struct {
	// enabled determines if using the huge TLB flag is enabled for platforms
	// that support it
	Enabled bool
	// threshold determines if the size being mmap'd is greater or equal
	// to this value to use or not use the huge TLB flag if enabled
	Threshold int64
}

type Options struct {
	// read is whether to make mmap bytes ref readable
	Read bool
	// write is whether to make mmap bytes ref writable
	Write bool
	// hugeTLB is the mmap huge TLB options
	HugeTLB HugeTLBOptions
	// ReporterOptions is the reporter options
	ReporterOptions ReporterOptions
}

type Reporter interface {
	// ReportMap reports the mapping of an mmap and allows an error to be
	// returned in case the reporter want's to deny allowing this map call.
	ReportMap(ctx Context) error
	// ReportUnmap reports the unmapping of an mmap and allows an error to be
	// returned in case the reporter want's to deny allowing this unmap call.
	ReportUnmap(ctx Context) error
}

type ReporterOptions struct {
	// Context is the context to report to reporter for this
	Context Context
	// Reporter if set will receive events for reporting
	Reporter Reporter
}