blob: 353637904c8f30f0fe8e6e9de8163103b78015d5 [file] [log] [blame]
// Copyright 2014 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Package server provides RPC access to a local program being debugged.
// It is the remote end of the client implementation of the Program interface.
package server
import (
"bytes"
"fmt"
"os"
"regexp"
"strconv"
"strings"
"syscall"
"code.google.com/p/ogle/debug/dwarf"
"code.google.com/p/ogle/debug/elf"
"code.google.com/p/ogle/debug/macho"
"code.google.com/p/ogle/arch"
"code.google.com/p/ogle/program"
"code.google.com/p/ogle/program/proxyrpc"
)
type breakpoint struct {
pc uint64
origInstr [arch.MaxBreakpointSize]byte
}
type call struct {
req, resp interface{}
errc chan error
}
type Server struct {
arch arch.Architecture
executable string // Name of executable.
dwarfData *dwarf.Data
breakpointc chan call
otherc chan call
fc chan func() error
ec chan error
proc *os.Process
procIsUp bool
stoppedPid int
stoppedRegs syscall.PtraceRegs
runtime runtime
breakpoints map[uint64]breakpoint
files []*file // Index == file descriptor.
printer *Printer
}
// runtime are the addresses, in the target program's address space, of Go
// runtime functions such as runtimeĀ·lessstack.
type runtime struct {
evaluated bool
evalErr error
goexit uint64
mstart uint64
mcall uint64
morestack uint64
lessstack uint64
_rt0_go uint64
externalthreadhandlerp uint64
}
// peek implements the Peeker interface required by the printer.
func (s *Server) peek(offset uintptr, buf []byte) error {
return s.ptracePeek(s.stoppedPid, offset, buf)
}
// New parses the executable and builds local data structures for answering requests.
// It returns a Server ready to serve requests about the executable.
func New(executable string) (*Server, error) {
fd, err := os.Open(executable)
if err != nil {
return nil, err
}
defer fd.Close()
architecture, dwarfData, err := loadExecutable(fd)
if err != nil {
return nil, err
}
srv := &Server{
arch: *architecture,
executable: executable,
dwarfData: dwarfData,
breakpointc: make(chan call),
otherc: make(chan call),
fc: make(chan func() error),
ec: make(chan error),
breakpoints: make(map[uint64]breakpoint),
}
srv.printer = NewPrinter(architecture, dwarfData, srv)
go ptraceRun(srv.fc, srv.ec)
go srv.loop()
return srv, nil
}
func loadExecutable(f *os.File) (*arch.Architecture, *dwarf.Data, error) {
// TODO: How do we detect NaCl?
if obj, err := elf.NewFile(f); err == nil {
dwarfData, err := obj.DWARF()
if err != nil {
return nil, nil, err
}
switch obj.Machine {
case elf.EM_ARM:
return &arch.ARM, dwarfData, nil
case elf.EM_386:
switch obj.Class {
case elf.ELFCLASS32:
return &arch.X86, dwarfData, nil
case elf.ELFCLASS64:
return &arch.AMD64, dwarfData, nil
}
case elf.EM_X86_64:
return &arch.AMD64, dwarfData, nil
}
return nil, nil, fmt.Errorf("unrecognized ELF architecture")
}
if obj, err := macho.NewFile(f); err == nil {
dwarfData, err := obj.DWARF()
if err != nil {
return nil, nil, err
}
/* TODO
table, err := parseMachO(obj)
if err != nil {
return nil, nil, err
}
*/
switch obj.Cpu {
case macho.Cpu386:
return &arch.X86, dwarfData, nil
case macho.CpuAmd64:
return &arch.AMD64, dwarfData, nil
}
return nil, nil, fmt.Errorf("unrecognized Mach-O architecture")
}
return nil, nil, fmt.Errorf("unrecognized binary format")
}
func (s *Server) loop() {
for {
var c call
select {
case c = <-s.breakpointc:
case c = <-s.otherc:
}
s.dispatch(c)
}
}
func (s *Server) dispatch(c call) {
switch req := c.req.(type) {
case *proxyrpc.BreakpointRequest:
c.errc <- s.handleBreakpoint(req, c.resp.(*proxyrpc.BreakpointResponse))
case *proxyrpc.CloseRequest:
c.errc <- s.handleClose(req, c.resp.(*proxyrpc.CloseResponse))
case *proxyrpc.EvalRequest:
c.errc <- s.handleEval(req, c.resp.(*proxyrpc.EvalResponse))
case *proxyrpc.FramesRequest:
c.errc <- s.handleFrames(req, c.resp.(*proxyrpc.FramesResponse))
case *proxyrpc.OpenRequest:
c.errc <- s.handleOpen(req, c.resp.(*proxyrpc.OpenResponse))
case *proxyrpc.ReadAtRequest:
c.errc <- s.handleReadAt(req, c.resp.(*proxyrpc.ReadAtResponse))
case *proxyrpc.ResumeRequest:
c.errc <- s.handleResume(req, c.resp.(*proxyrpc.ResumeResponse))
case *proxyrpc.RunRequest:
c.errc <- s.handleRun(req, c.resp.(*proxyrpc.RunResponse))
default:
panic(fmt.Sprintf("unexpected call request type %T", c.req))
}
}
func (s *Server) call(c chan call, req, resp interface{}) error {
errc := make(chan error)
c <- call{req, resp, errc}
return <-errc
}
type file struct {
mode string
index int
f program.File
}
func (s *Server) Open(req *proxyrpc.OpenRequest, resp *proxyrpc.OpenResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleOpen(req *proxyrpc.OpenRequest, resp *proxyrpc.OpenResponse) error {
// TODO: Better simulation. For now we just open the named OS file.
var flag int
switch req.Mode {
case "r":
flag = os.O_RDONLY
case "w":
flag = os.O_WRONLY
case "rw":
flag = os.O_RDWR
default:
return fmt.Errorf("Open: bad open mode %q", req.Mode)
}
osFile, err := os.OpenFile(req.Name, flag, 0)
if err != nil {
return err
}
// Find a file descriptor (index) slot.
index := 0
for ; index < len(s.files) && s.files[index] != nil; index++ {
}
f := &file{
mode: req.Mode,
index: index,
f: osFile,
}
if index == len(s.files) {
s.files = append(s.files, f)
} else {
s.files[index] = f
}
return nil
}
func (s *Server) ReadAt(req *proxyrpc.ReadAtRequest, resp *proxyrpc.ReadAtResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleReadAt(req *proxyrpc.ReadAtRequest, resp *proxyrpc.ReadAtResponse) error {
fd := req.FD
if fd < 0 || len(s.files) <= fd || s.files[fd] == nil {
return fmt.Errorf("ReadAt: bad file descriptor %d", fd)
}
f := s.files[fd]
buf := make([]byte, req.Len) // TODO: Don't allocate every time
n, err := f.f.ReadAt(buf, req.Offset)
resp.Data = buf[:n]
return err
}
func (s *Server) Close(req *proxyrpc.CloseRequest, resp *proxyrpc.CloseResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleClose(req *proxyrpc.CloseRequest, resp *proxyrpc.CloseResponse) error {
fd := req.FD
if fd < 0 || fd >= len(s.files) || s.files[fd] == nil {
return fmt.Errorf("Close: bad file descriptor %d", fd)
}
err := s.files[fd].f.Close()
// Remove it regardless
s.files[fd] = nil
return err
}
func (s *Server) Run(req *proxyrpc.RunRequest, resp *proxyrpc.RunResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleRun(req *proxyrpc.RunRequest, resp *proxyrpc.RunResponse) error {
if s.proc != nil {
s.proc.Kill()
s.proc = nil
s.procIsUp = false
s.stoppedPid = 0
s.stoppedRegs = syscall.PtraceRegs{}
s.runtime.evaluated = false
s.runtime.evalErr = nil
}
p, err := s.startProcess(s.executable, nil, &os.ProcAttr{
Files: []*os.File{
nil, // TODO: be able to feed the target's stdin.
os.Stderr, // TODO: be able to capture the target's stdout.
os.Stderr,
},
Sys: &syscall.SysProcAttr{
Pdeathsig: syscall.SIGKILL,
Ptrace: true,
},
})
if err != nil {
return err
}
s.proc = p
s.stoppedPid = p.Pid
return nil
}
func (s *Server) Resume(req *proxyrpc.ResumeRequest, resp *proxyrpc.ResumeResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleResume(req *proxyrpc.ResumeRequest, resp *proxyrpc.ResumeResponse) error {
if s.proc == nil {
return fmt.Errorf("Resume: Run did not successfully start a process")
}
if !s.procIsUp {
s.procIsUp = true
if _, err := s.waitForTrap(s.stoppedPid, false); err != nil {
return err
}
if err := s.ptraceSetOptions(s.stoppedPid, syscall.PTRACE_O_TRACECLONE); err != nil {
return fmt.Errorf("ptraceSetOptions: %v", err)
}
} else if _, ok := s.breakpoints[s.stoppedRegs.Rip]; ok {
if err := s.ptraceSingleStep(s.stoppedPid); err != nil {
return fmt.Errorf("ptraceSingleStep: %v", err)
}
if _, err := s.waitForTrap(s.stoppedPid, false); err != nil {
return err
}
}
for {
if err := s.setBreakpoints(); err != nil {
return err
}
if err := s.ptraceCont(s.stoppedPid, 0); err != nil {
return fmt.Errorf("ptraceCont: %v", err)
}
wpid, err := s.waitForTrap(-1, true)
if err == nil {
s.stoppedPid = wpid
break
}
bce, ok := err.(*breakpointsChangedError)
if !ok {
return err
}
if err := syscall.Kill(s.stoppedPid, syscall.SIGSTOP); err != nil {
return fmt.Errorf("kill(SIGSTOP): %v", err)
}
_, status, err := s.wait(s.stoppedPid, false)
if err != nil {
return fmt.Errorf("wait (after SIGSTOP): %v", err)
}
if !status.Stopped() || status.StopSignal() != syscall.SIGSTOP {
return fmt.Errorf("wait (after SIGSTOP): unexpected wait status 0x%x", status)
}
if err := s.liftBreakpoints(); err != nil {
return err
}
loop:
for c := bce.call; ; {
s.dispatch(c)
select {
case c = <-s.breakpointc:
default:
break loop
}
}
}
if err := s.liftBreakpoints(); err != nil {
return err
}
if err := s.ptraceGetRegs(s.stoppedPid, &s.stoppedRegs); err != nil {
return fmt.Errorf("ptraceGetRegs: %v", err)
}
s.stoppedRegs.Rip -= uint64(s.arch.BreakpointSize)
if err := s.ptraceSetRegs(s.stoppedPid, &s.stoppedRegs); err != nil {
return fmt.Errorf("ptraceSetRegs: %v", err)
}
resp.Status.PC = s.stoppedRegs.Rip
resp.Status.SP = s.stoppedRegs.Rsp
return nil
}
func (s *Server) waitForTrap(pid int, allowBreakpointsChange bool) (wpid int, err error) {
for {
wpid, status, err := s.wait(pid, allowBreakpointsChange)
if err != nil {
if _, ok := err.(*breakpointsChangedError); !ok {
err = fmt.Errorf("wait: %v", err)
}
return 0, err
}
if status.StopSignal() == syscall.SIGTRAP && status.TrapCause() != syscall.PTRACE_EVENT_CLONE {
return wpid, nil
}
err = s.ptraceCont(wpid, 0) // TODO: non-zero when wait catches other signals?
if err != nil {
return 0, fmt.Errorf("ptraceCont: %v", err)
}
}
}
func (s *Server) Breakpoint(req *proxyrpc.BreakpointRequest, resp *proxyrpc.BreakpointResponse) error {
return s.call(s.breakpointc, req, resp)
}
func (s *Server) handleBreakpoint(req *proxyrpc.BreakpointRequest, resp *proxyrpc.BreakpointResponse) error {
addrs, err := s.eval(req.Address)
if err != nil {
return err
}
var bp breakpoint
for _, addr := range addrs {
pc, err := s.evalAddress(addr)
if err != nil {
return err
}
if _, alreadySet := s.breakpoints[pc]; alreadySet {
return fmt.Errorf("breakpoint already set at %#x (TODO)", pc)
}
err = s.ptracePeek(s.stoppedPid, uintptr(pc), bp.origInstr[:s.arch.BreakpointSize])
if err != nil {
return fmt.Errorf("ptracePeek: %v", err)
}
bp.pc = pc
s.breakpoints[pc] = bp
resp.PCs = append(resp.PCs, pc)
}
return nil
}
func (s *Server) setBreakpoints() error {
for pc := range s.breakpoints {
err := s.ptracePoke(s.stoppedPid, uintptr(pc), s.arch.BreakpointInstr[:s.arch.BreakpointSize])
if err != nil {
return fmt.Errorf("setBreakpoints: %v", err)
}
}
return nil
}
func (s *Server) liftBreakpoints() error {
for pc, breakpoint := range s.breakpoints {
err := s.ptracePoke(s.stoppedPid, uintptr(pc), breakpoint.origInstr[:s.arch.BreakpointSize])
if err != nil {
return fmt.Errorf("liftBreakpoints: %v", err)
}
}
return nil
}
func (s *Server) Eval(req *proxyrpc.EvalRequest, resp *proxyrpc.EvalResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleEval(req *proxyrpc.EvalRequest, resp *proxyrpc.EvalResponse) (err error) {
resp.Result, err = s.eval(req.Expr)
return err
}
// eval evaluates an expression.
// TODO: very weak.
func (s *Server) eval(expr string) ([]string, error) {
switch {
case strings.HasPrefix(expr, "re:"):
// Regular expression. Return list of symbols.
re, err := regexp.Compile(expr[3:])
if err != nil {
return nil, err
}
return s.lookupRE(re)
case strings.HasPrefix(expr, "addr:"):
// Symbol lookup. Return address.
addr, err := s.lookupFunction(expr[5:])
if err != nil {
return nil, err
}
return []string{fmt.Sprintf("%#x", addr)}, nil
case strings.HasPrefix(expr, "val:"):
// Symbol lookup. Return formatted value.
value, err := s.printer.Sprint(expr[4:])
if err != nil {
return nil, err
}
return []string{value}, nil
case strings.HasPrefix(expr, "src:"):
// Numerical address. Return file.go:123.
addr, err := strconv.ParseUint(expr[4:], 0, 0)
if err != nil {
return nil, err
}
file, line, err := s.lookupSource(addr)
if err != nil {
return nil, err
}
return []string{fmt.Sprintf("%s:%d", file, line)}, nil
case len(expr) > 0 && '0' <= expr[0] && expr[0] <= '9':
// Numerical address. Return symbol.
addr, err := strconv.ParseUint(expr, 0, 0)
if err != nil {
return nil, err
}
funcName, err := s.lookupPC(addr)
if err != nil {
return nil, err
}
return []string{funcName}, nil
}
return nil, fmt.Errorf("bad expression syntax: %q", expr)
}
func (s *Server) lookupSource(pc uint64) (file string, line int, err error) {
if s.dwarfData == nil {
return
}
// TODO: The gosym equivalent also returns the relevant Func. Do that when
// DWARF has the same facility.
return s.dwarfData.PCToLine(pc)
}
// evalAddress takes a simple expression, either a symbol or hex value,
// and evaluates it as an address.
func (s *Server) evalAddress(expr string) (uint64, error) {
// Might be a symbol.
addr, err := s.lookupFunction(expr) // TODO: might not be a function
if err == nil {
return addr, nil
}
// Must be a number.
addr, err = strconv.ParseUint(expr, 0, 0)
if err != nil {
return 0, fmt.Errorf("eval: %q is neither symbol nor number", expr)
}
return addr, nil
}
func (s *Server) Frames(req *proxyrpc.FramesRequest, resp *proxyrpc.FramesResponse) error {
return s.call(s.otherc, req, resp)
}
func (s *Server) handleFrames(req *proxyrpc.FramesRequest, resp *proxyrpc.FramesResponse) error {
// TODO: verify that we're stopped.
if !s.runtime.evaluated {
s.evaluateRuntime()
}
if s.runtime.evalErr != nil {
return s.runtime.evalErr
}
regs := syscall.PtraceRegs{}
err := s.ptraceGetRegs(s.stoppedPid, &regs)
if err != nil {
return err
}
pc, sp := regs.Rip, regs.Rsp
var buf [8]byte
b := new(bytes.Buffer)
r := s.dwarfData.Reader()
// TODO: handle walking over a split stack.
for i := 0; i < req.Count; i++ {
fpOffset, err := s.dwarfData.PCToSPOffset(pc)
if err != nil {
return err
}
fp := sp + uint64(fpOffset)
// TODO: the returned frame should be structured instead of a hacked up string.
b.Reset()
fmt.Fprintf(b, "PC=%#x, SP=%#x:", pc, sp)
entry, funcEntry, err := s.entryForPC(pc)
if err != nil {
return err
}
r.Seek(entry.Offset)
for {
entry, err := r.Next()
if err != nil {
return err
}
if entry.Tag == 0 {
break
}
if entry.Tag != dwarf.TagFormalParameter {
continue
}
if entry.Children {
// TODO: handle this??
return fmt.Errorf("FormalParameter has children, expected none")
}
offset := int64(0)
name := "arg"
for _, f := range entry.Field {
switch f.Attr {
case dwarf.AttrLocation:
offset = evalLocation(f.Val.([]uint8))
case dwarf.AttrName:
name = f.Val.(string)
}
}
str, err := s.printer.SprintEntry(entry, uintptr(fp)+uintptr(offset))
fmt.Fprintf(b, "%s (%d(FP)) = %s ", name, offset, str)
if err != nil {
fmt.Fprintf(b, "(%s) ", err)
}
}
resp.Frames = append(resp.Frames, program.Frame{
S: b.String(),
})
// Walk to the caller's PC and SP.
if s.topOfStack(funcEntry) {
break
}
err = s.ptracePeek(s.stoppedPid, uintptr(fp-uint64(s.arch.PointerSize)), buf[:s.arch.PointerSize])
if err != nil {
return fmt.Errorf("ptracePeek: %v", err)
}
pc, sp = s.arch.Uintptr(buf[:s.arch.PointerSize]), fp
}
return nil
}
func (s *Server) evaluateRuntime() {
s.runtime.evaluated = true
s.runtime.evalErr = nil
addrs := [...]struct {
name string
p *uint64
windowsSpecific bool
}{
{"runtime.goexit", &s.runtime.goexit, false},
{"runtime.mstart", &s.runtime.mstart, false},
{"runtime.mcall", &s.runtime.mcall, false},
{"runtime.morestack", &s.runtime.morestack, false},
{"runtime.lessstack", &s.runtime.lessstack, false},
{"_rt0_go", &s.runtime._rt0_go, false},
{"runtime.externalthreadhandlerp", &s.runtime.externalthreadhandlerp, true},
}
for _, a := range addrs {
if a.windowsSpecific {
// TODO: determine if the traced binary is for Windows.
*a.p = 0
continue
}
*a.p, s.runtime.evalErr = s.lookupFunction(a.name)
if s.runtime.evalErr != nil {
return
}
}
}
// topOfStack is the out-of-process equivalent of runtimeĀ·topofstack.
func (s *Server) topOfStack(funcEntry uint64) bool {
return funcEntry == s.runtime.goexit ||
funcEntry == s.runtime.mstart ||
funcEntry == s.runtime.mcall ||
funcEntry == s.runtime.morestack ||
funcEntry == s.runtime.lessstack ||
funcEntry == s.runtime._rt0_go ||
(s.runtime.externalthreadhandlerp != 0 && funcEntry == s.runtime.externalthreadhandlerp)
}