developer

Documentation

Overview

Package developer offers additional functionality to the developer of ROMs that use a coprocessor. It uses available DWARF data for a binary in order to provide the developer performance profiling and variable information.

The functionality of this package will be greatly expanded in the future.

Index

• type Cartridge
• type Developer
  • func NewDeveloper(state Emulation, tv TV) Developer
  • func (dev *Developer) AttachCartridge(cart Cartridge, romFile string, elfFile string) error
  • func (dev *Developer) BorrowBreakpoints(f func(breakpoints.Breakpoints))
  • func (dev *Developer) BorrowCallStack(f func(callstack.CallStack))
  • func (dev *Developer) BorrowFaults(f func(*faults.Faults))
  • func (dev *Developer) BorrowSource(f func(*dwarf.Source))
  • func (dev *Developer) BorrowYieldState(f func(yield.State))
  • func (dev *Developer) BreakNextInstruction()
  • func (dev *Developer) CheckBreakpoint(addr uint32) bool
  • func (dev *Developer) EnableStrobe(enable bool, addr uint32)
  • func (dev *Developer) HasSource() bool
  • func (dev *Developer) HighAddress() uint32
  • func (dev *Developer) MemoryFault(event string, fault faults.Category, instructionAddr uint32, accessAddr uint32)
  • func (dev *Developer) NewFrame(frameInfo television.FrameInfo) error
  • func (dev *Developer) OnYield(addr uint32, yield coprocessor.CoProcYield)
  • func (dev *Developer) ProcessProfiling()
  • func (dev *Developer) Profiling() *coprocessor.CartCoProcProfiler
  • func (dev *Developer) SearchStaticMemory(output io.Writer, data uint32, width int) error
  • func (dev *Developer) SetEmulationState(state govern.State)
  • func (dev *Developer) StartProfiling()
• type Emulation
• type InstructionRange
  • func (rng *InstructionRange) Add(line *dwarf.SourceLine)
  • func (rng *InstructionRange) Clear()
  • func (rng *InstructionRange) IsEmpty() bool
  • func (rng *InstructionRange) Len() int
  • func (rng *InstructionRange) Less(i int, j int) bool
  • func (rng *InstructionRange) Swap(i int, j int)
• type TV

Types

type Cartridge

type Cartridge interface {
	GetCoProcBus() coprocessor.CartCoProcBus
	GetStaticBus() mapper.CartStaticBus
}

Cartridge defines the interface to the cartridge required by the developer package

type Developer

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

Developer implements the CartCoProcDeveloper interface.

func NewDeveloper

func NewDeveloper(state Emulation, tv TV) Developer

NewDeveloper is the preferred method of initialisation for the Developer type.

func (*Developer) AttachCartridge

func (dev *Developer) AttachCartridge(cart Cartridge, romFile string, elfFile string) error

func (*Developer) BorrowBreakpoints

func (dev *Developer) BorrowBreakpoints(f func(breakpoints.Breakpoints))

BorrowBreakpoints will lock the breakpoints structure for the durction of the supplied function, which will be executed with the breakpoints structure as an argument.

func (*Developer) BorrowCallStack

func (dev *Developer) BorrowCallStack(f func(callstack.CallStack))

BorrowCallStack will lock the callstack structure for the durction of the supplied function, which will be executed with the callstack structure as an argument.

In some situations BorrowCallStack may need to be wrapped in a BorrowSource call in order to prevent a race condition

func (*Developer) BorrowFaults

func (dev *Developer) BorrowFaults(f func(*faults.Faults))

BorrowFaults will lock the illegal access log for the duration of the supplied fucntion, which will be executed with the illegal access log as an argument.

func (*Developer) BorrowSource

func (dev *Developer) BorrowSource(f func(*dwarf.Source))

BorrowSource will lock the source code structure for the durction of the supplied function, which will be executed with the source code structure as an argument.

May return nil.

func (*Developer) BorrowYieldState

func (dev *Developer) BorrowYieldState(f func(yield.State))

BorrowYieldState will lock the illegal access log for the duration of the supplied fucntion, which will be executed with the illegal access log as an argument.

In some situations BorrowYieldState may need to be wrapped in a BorrowSource call in order to prevent a race condition

func (*Developer) BreakNextInstruction

func (dev *Developer) BreakNextInstruction()

BreakOnNextStep forces the coprocess to break after next instruction execution

func (*Developer) CheckBreakpoint

func (dev *Developer) CheckBreakpoint(addr uint32) bool

CheckBreakpoint implements the coprocessor.CartCoProcDeveloper interface.

func (*Developer) EnableStrobe

func (dev *Developer) EnableStrobe(enable bool, addr uint32)

EnableStrobe sets the yield strobe to the specified enable state and the specified address

func (*Developer) HasSource

func (dev *Developer) HasSource() bool

HasSource returns true if source information has been found.

func (*Developer) HighAddress

func (dev *Developer) HighAddress() uint32

HighAddress implements the coprocessor.CartCoProcDeveloper interface.

func (*Developer) MemoryFault

func (dev *Developer) MemoryFault(event string, fault faults.Category, instructionAddr uint32, accessAddr uint32)

MemoryFault implements the coprocessor.CartCoProcDeveloper interface.

func (*Developer) NewFrame

func (dev *Developer) NewFrame(frameInfo television.FrameInfo) error

NewFrame implements the television.FrameTrigger interface.

func (*Developer) OnYield

func (dev *Developer) OnYield(addr uint32, yield coprocessor.CoProcYield)

OnYield implements the coprocessor.CartCoProcDeveloper interface.

func (*Developer) ProcessProfiling

func (dev *Developer) ProcessProfiling()

ProcessProfiling implements the coprocessor.CartCoProcDeveloper interface.

func (*Developer) Profiling

func (dev *Developer) Profiling() *coprocessor.CartCoProcProfiler

Profiling implements the coprocessor.CartCoProcDeveloper interface.

func (*Developer) SearchStaticMemory

func (dev *Developer) SearchStaticMemory(output io.Writer, data uint32, width int) error

SearchStaticMemory searches the cartridges static memory areas for

func (*Developer) SetEmulationState

func (dev *Developer) SetEmulationState(state govern.State)

SetEmulationState is called by the emulation whenever state changes

func (*Developer) StartProfiling

func (dev *Developer) StartProfiling()

StartProfiling implements the coprocessor.CartCoProcDeveloper interface.

type Emulation

type Emulation interface {
	State() govern.State
}

Emulation defines an interface to the emulation for retreiving the emulation state

type InstructionRange

type InstructionRange struct {
	Instructions []*dwarf.SourceInstruction
}

InstructionRange is used to dynamically create a list of SourceInstruction entries.

func (*InstructionRange) Add

func (rng *InstructionRange) Add(line *dwarf.SourceLine)

Add the instructions for a SourceLine to the range.

func (*InstructionRange) Clear

func (rng *InstructionRange) Clear()

Clear all instructions from the range.

func (*InstructionRange) IsEmpty

func (rng *InstructionRange) IsEmpty() bool

IsEmpty returns true if there are no instructions entries in the range.

func (*InstructionRange) Len

func (rng *InstructionRange) Len() int

Len implements the sort.Sort interface.

func (*InstructionRange) Less

func (rng *InstructionRange) Less(i int, j int) bool

Less implements the sort.Sort interface.

func (*InstructionRange) Swap

func (rng *InstructionRange) Swap(i int, j int)

Swap implements the sort.Sort interface.

type TV

type TV interface {
	GetFrameInfo() television.FrameInfo
	GetCoords() coords.TelevisionCoords
	GetLastSignal() signal.SignalAttributes
}

TV is the interface from the developer type to the television implementation.