package proc import ( "bytes" "encoding/binary" "os" "path/filepath" "runtime" "testing" protest "github.com/derekparker/delve/proc/test" ) func init() { runtime.GOMAXPROCS(4) os.Setenv("GOMAXPROCS", "4") } func TestMain(m *testing.M) { os.Exit(protest.RunTestsWithFixtures(m)) } func withTestProcess(name string, t *testing.T, fn func(p *Process, fixture protest.Fixture)) { fixture := protest.BuildFixture(name) p, err := Launch([]string{fixture.Path}) if err != nil { t.Fatal("Launch():", err) } defer func() { p.Halt() p.Detach(true) }() fn(p, fixture) } func getRegisters(p *Process, t *testing.T) Registers { regs, err := p.Registers() if err != nil { t.Fatal("Registers():", err) } return regs } func dataAtAddr(thread *Thread, addr uint64) ([]byte, error) { data := make([]byte, 1) _, err := readMemory(thread, uintptr(addr), data) if err != nil { return nil, err } return data, nil } func assertNoError(err error, t *testing.T, s string) { if err != nil { _, file, line, _ := runtime.Caller(1) fname := filepath.Base(file) t.Fatalf("failed assertion at %s:%d: %s - %s\n", fname, line, s, err) } } func currentPC(p *Process, t *testing.T) uint64 { pc, err := p.PC() if err != nil { t.Fatal(err) } return pc } func currentLineNumber(p *Process, t *testing.T) (string, int) { pc := currentPC(p, t) f, l, _ := p.goSymTable.PCToLine(pc) return f, l } func TestExit(t *testing.T) { withTestProcess("continuetestprog", t, func(p *Process, fixture protest.Fixture) { err := p.Continue() pe, ok := err.(ProcessExitedError) if !ok { t.Fatalf("Continue() returned unexpected error type %s", err) } if pe.Status != 0 { t.Errorf("Unexpected error status: %d", pe.Status) } if pe.Pid != p.Pid { t.Errorf("Unexpected process id: %d", pe.Pid) } }) } func TestHalt(t *testing.T) { stopChan := make(chan interface{}) withTestProcess("loopprog", t, func(p *Process, fixture protest.Fixture) { _, err := p.SetBreakpointByLocation("main.loop") assertNoError(err, t, "SetBreakpoint") assertNoError(p.Continue(), t, "Continue") for _, th := range p.Threads { if th.running != false { t.Fatal("expected running = false for thread", th.Id) } _, err := th.Registers() assertNoError(err, t, "Registers") } go func() { for { if p.Running() { if err := p.RequestManualStop(); err != nil { t.Fatal(err) } stopChan <- nil return } } }() assertNoError(p.Continue(), t, "Continue") <-stopChan // Loop through threads and make sure they are all // actually stopped, err will not be nil if the process // is still running. for _, th := range p.Threads { if th.running != false { t.Fatal("expected running = false for thread", th.Id) } _, err := th.Registers() assertNoError(err, t, "Registers") } }) } func TestStep(t *testing.T) { withTestProcess("testprog", t, func(p *Process, fixture protest.Fixture) { helloworldfunc := p.goSymTable.LookupFunc("main.helloworld") helloworldaddr := helloworldfunc.Entry _, err := p.SetBreakpoint(helloworldaddr) assertNoError(err, t, "SetBreakpoint()") assertNoError(p.Continue(), t, "Continue()") regs := getRegisters(p, t) rip := regs.PC() err = p.Step() assertNoError(err, t, "Step()") regs = getRegisters(p, t) if rip >= regs.PC() { t.Errorf("Expected %#v to be greater than %#v", regs.PC(), rip) } }) } func TestBreakpoint(t *testing.T) { withTestProcess("testprog", t, func(p *Process, fixture protest.Fixture) { helloworldfunc := p.goSymTable.LookupFunc("main.helloworld") helloworldaddr := helloworldfunc.Entry bp, err := p.SetBreakpoint(helloworldaddr) assertNoError(err, t, "SetBreakpoint()") assertNoError(p.Continue(), t, "Continue()") pc, err := p.PC() if err != nil { t.Fatal(err) } if pc-1 != bp.Addr && pc != bp.Addr { f, l, _ := p.goSymTable.PCToLine(pc) t.Fatalf("Break not respected:\nPC:%#v %s:%d\nFN:%#v \n", pc, f, l, bp.Addr) } }) } func TestBreakpointInSeperateGoRoutine(t *testing.T) { withTestProcess("testthreads", t, func(p *Process, fixture protest.Fixture) { fn := p.goSymTable.LookupFunc("main.anotherthread") if fn == nil { t.Fatal("No fn exists") } _, err := p.SetBreakpoint(fn.Entry) if err != nil { t.Fatal(err) } err = p.Continue() if err != nil { t.Fatal(err) } pc, err := p.PC() if err != nil { t.Fatal(err) } f, l, _ := p.goSymTable.PCToLine(pc) if f != "testthreads.go" && l != 8 { t.Fatal("Program did not hit breakpoint") } }) } func TestBreakpointWithNonExistantFunction(t *testing.T) { withTestProcess("testprog", t, func(p *Process, fixture protest.Fixture) { _, err := p.SetBreakpoint(0) if err == nil { t.Fatal("Should not be able to break at non existant function") } }) } func TestClearBreakpointBreakpoint(t *testing.T) { withTestProcess("testprog", t, func(p *Process, fixture protest.Fixture) { fn := p.goSymTable.LookupFunc("main.sleepytime") bp, err := p.SetBreakpoint(fn.Entry) assertNoError(err, t, "SetBreakpoint()") bp, err = p.ClearBreakpoint(fn.Entry) assertNoError(err, t, "ClearBreakpoint()") data, err := dataAtAddr(p.CurrentThread, bp.Addr) if err != nil { t.Fatal(err) } int3 := []byte{0xcc} if bytes.Equal(data, int3) { t.Fatalf("Breakpoint was not cleared data: %#v, int3: %#v", data, int3) } if len(p.Breakpoints) != 0 { t.Fatal("Breakpoint not removed internally") } }) } type nextTest struct { begin, end int } func testnext(program string, testcases []nextTest, initialLocation string, t *testing.T) { withTestProcess(program, t, func(p *Process, fixture protest.Fixture) { bp, err := p.SetBreakpointByLocation(initialLocation) assertNoError(err, t, "SetBreakpoint()") assertNoError(p.Continue(), t, "Continue()") p.ClearBreakpoint(bp.Addr) p.CurrentThread.SetPC(bp.Addr) f, ln := currentLineNumber(p, t) for _, tc := range testcases { if ln != tc.begin { t.Fatalf("Program not stopped at correct spot expected %d was %s:%d", tc.begin, filepath.Base(f), ln) } assertNoError(p.Next(), t, "Next() returned an error") f, ln = currentLineNumber(p, t) if ln != tc.end { t.Fatalf("Program did not continue to correct next location expected %d was %s:%d", tc.end, filepath.Base(f), ln) } } if len(p.Breakpoints) != 0 { t.Fatal("Not all breakpoints were cleaned up", len(p.Breakpoints)) } }) } func TestNextGeneral(t *testing.T) { testcases := []nextTest{ {17, 19}, {19, 20}, {20, 23}, {23, 24}, {24, 26}, {26, 31}, {31, 23}, {23, 24}, {24, 26}, {26, 31}, {31, 23}, {23, 24}, {24, 26}, {26, 27}, {27, 34}, } testnext("testnextprog", testcases, "main.testnext", t) } func TestNextGoroutine(t *testing.T) { testcases := []nextTest{ {46, 47}, {47, 42}, } testnext("testnextprog", testcases, "main.testgoroutine", t) } func TestNextFunctionReturn(t *testing.T) { testcases := []nextTest{ {13, 14}, {14, 35}, } testnext("testnextprog", testcases, "main.helloworld", t) } func TestNextFunctionReturnDefer(t *testing.T) { testcases := []nextTest{ {5, 9}, {9, 6}, } testnext("testnextdefer", testcases, "main.main", t) } func TestRuntimeBreakpoint(t *testing.T) { withTestProcess("testruntimebreakpoint", t, func(p *Process, fixture protest.Fixture) { err := p.Continue() if err != nil { t.Fatal(err) } pc, err := p.PC() if err != nil { t.Fatal(err) } _, l, _ := p.PCToLine(pc) if l != 10 { t.Fatal("did not respect breakpoint") } }) } func TestFindReturnAddress(t *testing.T) { withTestProcess("testnextprog", t, func(p *Process, fixture protest.Fixture) { var ( fdes = p.frameEntries gsd = p.goSymTable ) start, _, err := gsd.LineToPC(fixture.Source, 24) if err != nil { t.Fatal(err) } _, err = p.SetBreakpoint(start) if err != nil { t.Fatal(err) } err = p.Continue() if err != nil { t.Fatal(err) } regs, err := p.Registers() if err != nil { t.Fatal(err) } fde, err := fdes.FDEForPC(start) if err != nil { t.Fatal(err) } ret := fde.ReturnAddressOffset(start) if err != nil { t.Fatal(err) } addr := uint64(int64(regs.SP()) + ret) data := make([]byte, 8) readMemory(p.CurrentThread, uintptr(addr), data) addr = binary.LittleEndian.Uint64(data) _, l, _ := p.goSymTable.PCToLine(addr) if l != 40 { t.Fatalf("return address not found correctly, expected line 40") } }) } func TestSwitchThread(t *testing.T) { withTestProcess("testnextprog", t, func(p *Process, fixture protest.Fixture) { // With invalid thread id err := p.SwitchThread(-1) if err == nil { t.Fatal("Expected error for invalid thread id") } pc, err := p.FindLocation("main.main") if err != nil { t.Fatal(err) } _, err = p.SetBreakpoint(pc) if err != nil { t.Fatal(err) } err = p.Continue() if err != nil { t.Fatal(err) } var nt int ct := p.CurrentThread.Id for tid := range p.Threads { if tid != ct { nt = tid break } } if nt == 0 { t.Fatal("could not find thread to switch to") } // With valid thread id err = p.SwitchThread(nt) if err != nil { t.Fatal(err) } if p.CurrentThread.Id != nt { t.Fatal("Did not switch threads") } }) } type loc struct { line int fn string } func (l1 *loc) match(l2 Location) bool { if l1.line >= 0 { if l1.line != l2.Line-1 { return false } } return l1.fn == l2.Fn.Name } func TestStacktrace(t *testing.T) { stacks := [][]loc{ []loc{{3, "main.stacktraceme"}, {8, "main.func1"}, {16, "main.main"}}, []loc{{3, "main.stacktraceme"}, {8, "main.func1"}, {12, "main.func2"}, {17, "main.main"}}, } withTestProcess("stacktraceprog", t, func(p *Process, fixture protest.Fixture) { bp, err := p.SetBreakpointByLocation("main.stacktraceme") assertNoError(err, t, "BreakByLocation()") for i := range stacks { assertNoError(p.Continue(), t, "Continue()") locations, err := p.CurrentThread.Stacktrace(40) assertNoError(err, t, "Stacktrace()") if len(locations) != len(stacks[i])+2 { t.Fatalf("Wrong stack trace size %d %d\n", len(locations), len(stacks[i])+2) } for j := range stacks[i] { if !stacks[i][j].match(locations[j]) { t.Fatalf("Wrong stack trace pos %d\n", j) } } } p.ClearBreakpoint(bp.Addr) p.Continue() }) } func stackMatch(stack []loc, locations []Location) bool { if len(stack) > len(locations) { return false } for i := range stack { if !stack[i].match(locations[i]) { return false } } return true } func TestStacktraceGoroutine(t *testing.T) { mainStack := []loc{{11, "main.stacktraceme"}, {21, "main.main"}} agoroutineStack := []loc{{-1, "runtime.gopark"}, {-1, "runtime.goparkunlock"}, {-1, "runtime.chansend"}, {-1, "runtime.chansend1"}, {8, "main.agoroutine"}} withTestProcess("goroutinestackprog", t, func(p *Process, fixture protest.Fixture) { bp, err := p.SetBreakpointByLocation("main.stacktraceme") assertNoError(err, t, "BreakByLocation()") assertNoError(p.Continue(), t, "Continue()") gs, err := p.GoroutinesInfo() assertNoError(err, t, "GoroutinesInfo") agoroutineCount := 0 mainCount := 0 for i, g := range gs { locations, err := p.GoroutineStacktrace(g, 40) assertNoError(err, t, "GoroutineStacktrace()") if stackMatch(mainStack, locations) { mainCount++ } if stackMatch(agoroutineStack, locations) { agoroutineCount++ } else { t.Logf("Non-goroutine stack: %d (%d)", i, len(locations)) for i := range locations { name := "" if locations[i].Fn != nil { name = locations[i].Fn.Name } t.Logf("\t%s:%d %s\n", locations[i].File, locations[i].Line, name) } } } if mainCount != 1 { t.Fatalf("Main goroutine stack not found") } if agoroutineCount != 10 { t.Fatalf("Goroutine stacks not found (%d)", agoroutineCount) } p.ClearBreakpoint(bp.Addr) p.Continue() }) }