debug.go

//go:build darwin && debug
// +build darwin,debug

package vz

/*
#cgo darwin CFLAGS: -mmacosx-version-min=11 -x objective-c -fno-objc-arc
#cgo darwin LDFLAGS: -lobjc -framework Foundation -framework Virtualization
# include "virtualization_debug.h"
*/
import "C"
import (
	"runtime"

	"github.com/lima-vm/vz/v4/internal/objc"
)

// DebugStubConfiguration is an interface to debug configuration.
type DebugStubConfiguration interface {
	objc.NSObject

	debugStubConfiguration()
}

type baseDebugStubConfiguration struct{}

func (*baseDebugStubConfiguration) debugStubConfiguration() {}

// GDBDebugStubConfiguration is a configuration for gdb debugging.
type GDBDebugStubConfiguration struct {
	*pointer

	*baseDebugStubConfiguration
}

var _ DebugStubConfiguration = (*GDBDebugStubConfiguration)(nil)

// NewGDBDebugStubConfiguration creates a new GDB debug confiuration.
//
// This API is not officially published and is subject to change without notice.
//
// This is only supported on macOS 11 and newer, error will
// be returned on older versions.
func NewGDBDebugStubConfiguration(port uint32) (*GDBDebugStubConfiguration, error) {
	if err := macOSAvailable(11); err != nil {
		return nil, err
	}

	config := &GDBDebugStubConfiguration{
		pointer: objc.NewPointer(
			C.newVZGDBDebugStubConfiguration(C.uint32_t(port)),
		),
	}
	objc.SetFinalizer(config, func(self *GDBDebugStubConfiguration) {
		objc.Release(self)
	})
	return config, nil
}

// SetDebugStubVirtualMachineConfiguration sets debug stub configuration. Empty by default.
//
// This API is not officially published and is subject to change without notice.
func (v *VirtualMachineConfiguration) SetDebugStubVirtualMachineConfiguration(dc DebugStubConfiguration) {
	C.setDebugStubVZVirtualMachineConfiguration(objc.Ptr(v), objc.Ptr(dc))
}