package native import ( "errors" "fmt" "go/ast" "os" "runtime" "sync" "github.com/derekparker/delve/pkg/proc" ) // Process represents all of the information the debugger // is holding onto regarding the process we are debugging. type Process struct { bi proc.BinaryInfo pid int // Process Pid Process *os.Process // Pointer to process struct for the actual process we are debugging // Breakpoint table, holds information on breakpoints. // Maps instruction address to Breakpoint struct. breakpoints map[uint64]*proc.Breakpoint // List of threads mapped as such: pid -> *Thread threads map[int]*Thread // Active thread currentThread *Thread // Goroutine that will be used by default to set breakpoint, eval variables, etc... // Normally selectedGoroutine is currentThread.GetG, it will not be only if SwitchGoroutine is called with a goroutine that isn't attached to a thread selectedGoroutine *proc.G allGCache []*proc.G os *OSProcessDetails breakpointIDCounter int internalBreakpointIDCounter int firstStart bool halt bool exited bool ptraceChan chan func() ptraceDoneChan chan interface{} } // New returns an initialized Process struct. Before returning, // it will also launch a goroutine in order to handle ptrace(2) // functions. For more information, see the documentation on // `handlePtraceFuncs`. func New(pid int) *Process { dbp := &Process{ pid: pid, threads: make(map[int]*Thread), breakpoints: make(map[uint64]*proc.Breakpoint), firstStart: true, os: new(OSProcessDetails), ptraceChan: make(chan func()), ptraceDoneChan: make(chan interface{}), bi: proc.NewBinaryInfo(runtime.GOOS, runtime.GOARCH), } go dbp.handlePtraceFuncs() return dbp } func (dbp *Process) BinInfo() *proc.BinaryInfo { return &dbp.bi } // Detach from the process being debugged, optionally killing it. func (dbp *Process) Detach(kill bool) (err error) { if dbp.exited { return nil } if dbp.Running() { if err = dbp.Halt(); err != nil { return } } if !kill { // Clean up any breakpoints we've set. for _, bp := range dbp.breakpoints { if bp != nil { _, err := dbp.ClearBreakpoint(bp.Addr) if err != nil { return err } } } } dbp.execPtraceFunc(func() { err = dbp.detach(kill) if err != nil { return } if kill { err = killProcess(dbp.pid) } }) dbp.bi.Close() return } // Exited returns whether the debugged // process has exited. func (dbp *Process) Exited() bool { return dbp.exited } // Running returns whether the debugged // process is currently executing. func (dbp *Process) Running() bool { for _, th := range dbp.threads { if th.running { return true } } return false } func (dbp *Process) Pid() int { return dbp.pid } func (dbp *Process) SelectedGoroutine() *proc.G { return dbp.selectedGoroutine } func (dbp *Process) ThreadList() []proc.Thread { r := make([]proc.Thread, 0, len(dbp.threads)) for _, v := range dbp.threads { r = append(r, v) } return r } func (dbp *Process) FindThread(threadID int) (proc.Thread, bool) { th, ok := dbp.threads[threadID] return th, ok } func (dbp *Process) CurrentThread() proc.Thread { return dbp.currentThread } func (dbp *Process) Breakpoints() map[uint64]*proc.Breakpoint { return dbp.breakpoints } // LoadInformation finds the executable and then uses it // to parse the following information: // * Dwarf .debug_frame section // * Dwarf .debug_line section // * Go symbol table. func (dbp *Process) LoadInformation(path string) error { var wg sync.WaitGroup path = findExecutable(path, dbp.pid) wg.Add(1) go dbp.loadProcessInformation(&wg) dbp.bi.LoadBinaryInfo(path, &wg) wg.Wait() return nil } // RequestManualStop sets the `halt` flag and // sends SIGSTOP to all threads. func (dbp *Process) RequestManualStop() error { if dbp.exited { return &proc.ProcessExitedError{} } dbp.halt = true return dbp.requestManualStop() } // SetBreakpoint sets a breakpoint at addr, and stores it in the process wide // break point table. Setting a break point must be thread specific due to // ptrace actions needing the thread to be in a signal-delivery-stop. func (dbp *Process) SetBreakpoint(addr uint64, kind proc.BreakpointKind, cond ast.Expr) (*proc.Breakpoint, error) { tid := dbp.currentThread.ID if bp, ok := dbp.FindBreakpoint(addr); ok { return nil, proc.BreakpointExistsError{bp.File, bp.Line, bp.Addr} } f, l, fn := dbp.bi.PCToLine(uint64(addr)) if fn == nil { return nil, proc.InvalidAddressError{Address: addr} } newBreakpoint := &proc.Breakpoint{ FunctionName: fn.Name, File: f, Line: l, Addr: addr, Kind: kind, Cond: cond, HitCount: map[int]uint64{}, } if kind != proc.UserBreakpoint { dbp.internalBreakpointIDCounter++ newBreakpoint.ID = dbp.internalBreakpointIDCounter } else { dbp.breakpointIDCounter++ newBreakpoint.ID = dbp.breakpointIDCounter } thread := dbp.threads[tid] originalData := make([]byte, dbp.bi.Arch.BreakpointSize()) _, err := thread.ReadMemory(originalData, uintptr(addr)) if err != nil { return nil, err } if err := dbp.writeSoftwareBreakpoint(thread, addr); err != nil { return nil, err } newBreakpoint.OriginalData = originalData dbp.breakpoints[addr] = newBreakpoint return newBreakpoint, nil } // ClearBreakpoint clears the breakpoint at addr. func (dbp *Process) ClearBreakpoint(addr uint64) (*proc.Breakpoint, error) { if dbp.exited { return nil, &proc.ProcessExitedError{} } bp, ok := dbp.FindBreakpoint(addr) if !ok { return nil, proc.NoBreakpointError{Addr: addr} } if _, err := dbp.currentThread.ClearBreakpoint(bp); err != nil { return nil, err } delete(dbp.breakpoints, addr) return bp, nil } func (dbp *Process) ContinueOnce() (proc.Thread, error) { if dbp.exited { return nil, &proc.ProcessExitedError{} } if err := dbp.resume(); err != nil { return nil, err } dbp.allGCache = nil for _, th := range dbp.threads { th.clearBreakpointState() } trapthread, err := dbp.trapWait(-1) if err != nil { return nil, err } if err := dbp.Halt(); err != nil { return nil, dbp.exitGuard(err) } if err := dbp.setCurrentBreakpoints(trapthread); err != nil { return nil, err } return trapthread, err } // StepInstruction will continue the current thread for exactly // one instruction. This method affects only the thread // asssociated with the selected goroutine. All other // threads will remain stopped. func (dbp *Process) StepInstruction() (err error) { if dbp.selectedGoroutine == nil { return errors.New("cannot single step: no selected goroutine") } if dbp.selectedGoroutine.Thread == nil { // Step called on parked goroutine if _, err := dbp.SetBreakpoint(dbp.selectedGoroutine.PC, proc.NextBreakpoint, proc.SameGoroutineCondition(dbp.selectedGoroutine)); err != nil { return err } return proc.Continue(dbp) } dbp.allGCache = nil if dbp.exited { return &proc.ProcessExitedError{} } dbp.selectedGoroutine.Thread.(*Thread).clearBreakpointState() err = dbp.selectedGoroutine.Thread.(*Thread).StepInstruction() if err != nil { return err } return dbp.selectedGoroutine.Thread.(*Thread).SetCurrentBreakpoint() } // SwitchThread changes from current thread to the thread specified by `tid`. func (dbp *Process) SwitchThread(tid int) error { if dbp.exited { return &proc.ProcessExitedError{} } if th, ok := dbp.threads[tid]; ok { dbp.currentThread = th dbp.selectedGoroutine, _ = proc.GetG(dbp.currentThread) return nil } return fmt.Errorf("thread %d does not exist", tid) } // SwitchGoroutine changes from current thread to the thread // running the specified goroutine. func (dbp *Process) SwitchGoroutine(gid int) error { if dbp.exited { return &proc.ProcessExitedError{} } g, err := proc.FindGoroutine(dbp, gid) if err != nil { return err } if g == nil { // user specified -1 and selectedGoroutine is nil return nil } if g.Thread != nil { return dbp.SwitchThread(g.Thread.ThreadID()) } dbp.selectedGoroutine = g return nil } // Halt stops all threads. func (dbp *Process) Halt() (err error) { if dbp.exited { return &proc.ProcessExitedError{} } for _, th := range dbp.threads { if err := th.Halt(); err != nil { return err } } return nil } // FindBreakpoint finds the breakpoint for the given pc. func (dbp *Process) FindBreakpoint(pc uint64) (*proc.Breakpoint, bool) { // Check to see if address is past the breakpoint, (i.e. breakpoint was hit). if bp, ok := dbp.breakpoints[pc-uint64(dbp.bi.Arch.BreakpointSize())]; ok { return bp, true } // Directly use addr to lookup breakpoint. if bp, ok := dbp.breakpoints[pc]; ok { return bp, true } return nil, false } // Returns a new Process struct. func initializeDebugProcess(dbp *Process, path string, attach bool) (*Process, error) { if attach { var err error dbp.execPtraceFunc(func() { err = PtraceAttach(dbp.pid) }) if err != nil { return nil, err } _, _, err = dbp.wait(dbp.pid, 0) if err != nil { return nil, err } } process, err := os.FindProcess(dbp.pid) if err != nil { return nil, err } dbp.Process = process err = dbp.LoadInformation(path) if err != nil { return nil, err } if err := dbp.updateThreadList(); err != nil { return nil, err } ver, isextld, err := proc.GetGoInformation(dbp) if err != nil { return nil, err } dbp.bi.Arch.SetGStructOffset(ver, isextld) // selectedGoroutine can not be set correctly by the call to updateThreadList // because without calling SetGStructOffset we can not read the G struct of currentThread // but without calling updateThreadList we can not examine memory to determine // the offset of g struct inside TLS dbp.selectedGoroutine, _ = proc.GetG(dbp.currentThread) panicpc, err := proc.FindFunctionLocation(dbp, "runtime.startpanic", true, 0) if err == nil { bp, err := dbp.SetBreakpoint(panicpc, proc.UserBreakpoint, nil) if err == nil { bp.Name = "unrecovered-panic" bp.ID = -1 dbp.breakpointIDCounter-- } } return dbp, nil } func (dbp *Process) ClearInternalBreakpoints() error { for _, bp := range dbp.breakpoints { if !bp.Internal() { continue } if _, err := dbp.ClearBreakpoint(bp.Addr); err != nil { return err } } for i := range dbp.threads { if dbp.threads[i].CurrentBreakpoint != nil && dbp.threads[i].CurrentBreakpoint.Internal() { dbp.threads[i].CurrentBreakpoint = nil } } return nil } func (dbp *Process) handlePtraceFuncs() { // We must ensure here that we are running on the same thread during // while invoking the ptrace(2) syscall. This is due to the fact that ptrace(2) expects // all commands after PTRACE_ATTACH to come from the same thread. runtime.LockOSThread() for fn := range dbp.ptraceChan { fn() dbp.ptraceDoneChan <- nil } } func (dbp *Process) execPtraceFunc(fn func()) { dbp.ptraceChan <- fn <-dbp.ptraceDoneChan } func (dbp *Process) postExit() { dbp.exited = true close(dbp.ptraceChan) close(dbp.ptraceDoneChan) } func (dbp *Process) writeSoftwareBreakpoint(thread *Thread, addr uint64) error { _, err := thread.WriteMemory(uintptr(addr), dbp.bi.Arch.BreakpointInstruction()) return err } func (dbp *Process) AllGCache() *[]*proc.G { return &dbp.allGCache }