Cosmos/source2/Debug/Cosmos.Debug.VSDebugEngine/AD7.Impl/AD7Process.cs

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Collections.Specialized;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Runtime.InteropServices;
using System.Text;
using System.Threading;
using System.Windows.Forms;
using Cosmos.Build.Common;
using Cosmos.Debug.Common;
using Cosmos.Debug.Consts;
using Microsoft.VisualStudio;
using Microsoft.VisualStudio.Debugger.Interop;
using Microsoft.Win32;

namespace Cosmos.Debug.VSDebugEngine {
  public class AD7Process : IDebugProcess2 {
    public Guid mID = Guid.NewGuid();
    protected Process mProcess;
    protected ProcessStartInfo mProcessStartInfo;
    protected EngineCallback mCallback;
    public AD7Thread mThread;
    protected AD7Engine mEngine;
    public ReverseSourceInfos mReverseSourceMappings;
    public SourceInfos mSourceMappings;
    public uint? mCurrentAddress = null;
    protected readonly NameValueCollection mDebugInfo;
    protected LaunchType mLaunch;
    internal DebugInfo mDebugInfoDb;
    internal List<KeyValuePair<uint, string>> mAddressLabelMappings;
    internal IDictionary<string, uint> mLabelAddressMappings;
    private int mProcessExitEventSent = 0;

    // Connection to target environment. Usually serial but is
    // abstracted to allow other transports (ethernet, etc)
    public DebugConnector mDbgConnector;
    //
    // These are static because we need them persistent between debug
    // sessions to avoid reconnection issues. But they are not created
    // until the debug session is ready the first time so that we know
    // the debug window pipes are already reayd.
    //
    // Pipe to communicate with Cosmos.VS.Windows
    static private Cosmos.Debug.Common.PipeClient mDebugDownPipe = null;
    // Pipe to receive messages from Cosmos.VS.Windows
    static private Cosmos.Debug.Common.PipeServer mDebugUpPipe = null;

    Host.Base mHost;

    public string mISO;
    public string mProjectFile;

    protected void DbgCmdRegisters(byte[] aData) {
      mDebugDownPipe.SendCommand(VsipUi.Registers, aData);
    }

    protected void DbgCmdFrame(byte[] aData) {
      mDebugDownPipe.SendCommand(VsipUi.Frame, aData);
    }

    protected void DbgCmdPong(byte[] aData) {
      mDebugDownPipe.SendCommand(VsipUi.PongDebugStub, aData);
    }

    protected void DbgCmdStack(byte[] aData) {
      mDebugDownPipe.SendCommand(VsipUi.Stack, aData);
    }

    void mDebugUpPipe_DataPacketReceived(byte aCmd, byte[] aData) {
      switch (aCmd) {
        case UiVsip.Noop:
          // do nothing
          break;

        case UiVsip.PingVSIP:
          mDebugDownPipe.SendCommand(VsipUi.PongVSIP);
          break;

        case UiVsip.PingDebugStub:
          mDbgConnector.Ping();
          break;

        case UiVsip.SetAsmBreak:
          string xLabel = Encoding.UTF8.GetString(aData);
          uint xAddress = mLabelAddressMappings[xLabel];
          mDbgConnector.SetAsmBreakpoint(xAddress);
          mDbgConnector.Continue();
          //mDebugDownPipe.SendCommand(VsipUi.OutputPane, xAddress.ToString());
          break;

        default:
          throw new Exception(String.Format("Command value '{0}' not supported in method AD7Process.mDebugUpPipe_DataPacketReceived.", aCmd));
      }
    }

    protected void DebugConnectorConnected() {
      OutputText("Connected to DebugStub.");
    }

    ProcessStartInfo CreateHostProcessInfo(string aExe) {
      bool xShowHost = mDebugInfo[BuildProperties.ShowLaunchConsoleString].ToLower() == "true";
      var xResult = new ProcessStartInfo(Path.Combine(PathUtilities.GetVSIPDir(), aExe));
      xResult.UseShellExecute = false;
      xResult.RedirectStandardInput = true;
      xResult.RedirectStandardError = !xShowHost;
      xResult.RedirectStandardOutput = !xShowHost;
      xResult.CreateNoWindow = !xShowHost;
      return xResult;
    }

    void CreateDebugConnector() {
      mDbgConnector = null;

      string xPort = mDebugInfo[BuildProperties.VisualStudioDebugPortString];
      var xParts = xPort.Split(' ');
      string xPortType = xParts[0].ToLower();
      string xPortParam = xParts[1].ToLower();

      OutputText("Starting debug connector.");
      if (xPortType == "pipe:") {
        mDbgConnector = new Cosmos.Debug.Common.DebugConnectorPipeServer(xPortParam);
      } else if (xPortType == "serial:") {
        mDbgConnector = new Cosmos.Debug.Common.DebugConnectorSerial(xPortParam);
      }

      if (mDbgConnector == null) {
        throw new Exception("No debug connector found.");
      }
      mDbgConnector.Connected = DebugConnectorConnected;
      mDbgConnector.CmdTrace += new Action<byte, uint>(DbgCmdTrace);
      mDbgConnector.CmdText += new Action<string>(DbgCmdText);
      mDbgConnector.CmdStarted += new Action(DbgCmdStarted);
      mDbgConnector.OnDebugMsg += new Action<string>(DebugMsg);
      mDbgConnector.ConnectionLost += new Action<Exception>(DbgConnector_ConnectionLost);
      mDbgConnector.CmdRegisters += new Action<byte[]>(DbgCmdRegisters);
      mDbgConnector.CmdFrame += new Action<byte[]>(DbgCmdFrame);
      mDbgConnector.CmdStack += new Action<byte[]>(DbgCmdStack);
      mDbgConnector.CmdPong += new Action<byte[]>(DbgCmdPong);
    }

    internal AD7Process(NameValueCollection aDebugInfo, EngineCallback aCallback, AD7Engine aEngine, IDebugPort2 aPort) {
      mCallback = aCallback;
      mDebugInfo = aDebugInfo;

      mLaunch = (LaunchType)Enum.Parse(typeof(LaunchType), aDebugInfo[BuildProperties.LaunchString]);

      if (mDebugDownPipe == null) {
        mDebugDownPipe = new Cosmos.Debug.Common.PipeClient(Cosmos.Debug.Consts.Pipes.DownName);

        mDebugUpPipe = new Cosmos.Debug.Common.PipeServer(Cosmos.Debug.Consts.Pipes.UpName);
        mDebugUpPipe.DataPacketReceived += new Action<byte, byte[]>(mDebugUpPipe_DataPacketReceived);
        mDebugUpPipe.Start();
      }
      // Must be after mDebugDownPipe is initialized
      OutputClear();
      OutputText("Debugger process initialized.");

      mISO = mDebugInfo["ISOFile"];
      OutputText("Using ISO file " + mISO + ".");
      mProjectFile = mDebugInfo["ProjectFile"];
      //
      var xGDBDebugStub = false;
      Boolean.TryParse(mDebugInfo[BuildProperties.EnableGDBString], out xGDBDebugStub);
      OutputText("GDB " + (xGDBDebugStub ? "Enabled" : "Disabled") + ".");
      //
      var xGDBClient = false;
      Boolean.TryParse(mDebugInfo[BuildProperties.StartCosmosGDBString], out xGDBClient);

      string xHostArgs = "";
      if (mLaunch == LaunchType.VMware) {
        OutputText("Preparing VMWare.");
        string xFlavor = mDebugInfo[BuildProperties.VMwareEditionString].ToUpper();
        string xVmxFile = Path.Combine(PathUtilities.GetBuildDir(), @"VMWare\Workstation\Debug.vmx");

        // Try alternate if selected one is not installed
        if (xFlavor == "PLAYER" && !Host.VMwarePlayer.IsInstalled) {
          xFlavor = "WORKSTATION";
        } else if (xFlavor == "WORKSTATION" && !Host.VMwareWorkstation.IsInstalled) {
          xFlavor = "PLAYER";
        }

        if (xFlavor == "PLAYER" && Host.VMwarePlayer.IsInstalled) {
          mHost = new Host.VMwarePlayer(mDebugInfo, xVmxFile);
        } else if (xFlavor == "WORKSTATION" && Host.VMwareWorkstation.IsInstalled) {
          mHost = new Host.VMwareWorkstation(mDebugInfo, xVmxFile);
        } else {
          throw new Exception("VMWare Flavor '" + xFlavor + "' not implemented.");
        }

      } else if (mLaunch == LaunchType.Slave) {
        mHost = new Host.Slave(mDebugInfo);

      } else if (mLaunch == LaunchType.Manual) {
        mHost = new Host.Manual(mDebugInfo);

      } else {
        throw new Exception("Invalid Launch value: '" + mLaunch + "'.");
      }

      string xCpdbPath = Path.ChangeExtension(mISO, "cpdb");
      if (!File.Exists(xCpdbPath)) {
        throw new Exception("Debug data file " + xCpdbPath + " not found. Could be a omitted build process of Cosmos project so that not created.");
      }

      mDebugInfoDb = new DebugInfo();
      mDebugInfoDb.OpenCPDB(xCpdbPath);
      mDebugInfoDb.ReadLabels(out mAddressLabelMappings, out mLabelAddressMappings);
      if (mAddressLabelMappings.Count == 0) {
        throw new Exception("Debug data not found: LabelByAddressMapping");
      }

      mSourceMappings = Cosmos.Debug.Common.SourceInfo.GetSourceInfo(mAddressLabelMappings, mLabelAddressMappings, mDebugInfoDb);
      if (mSourceMappings.Count == 0) {
        throw new Exception("Debug data not found: SourceMappings");
      }
      mReverseSourceMappings = new ReverseSourceInfos(mSourceMappings);

      CreateDebugConnector();
      aEngine.BPMgr.SetDebugConnector(mDbgConnector);

      System.Threading.Thread.Sleep(250);

      OutputText("Starting launch debug host.");
      mProcessStartInfo = CreateHostProcessInfo(mHost.GetHostProcessExe());
      mProcessStartInfo.Arguments = mHost.Start(xGDBDebugStub);
      System.Diagnostics.Debug.WriteLine(String.Format("Launching process: \"{0}\" {1}", mProcessStartInfo.FileName, mProcessStartInfo.Arguments).Trim());
      mProcess = Process.Start(mProcessStartInfo);

      mProcess.EnableRaisingEvents = true;
      mProcess.Exited += new EventHandler(mProcess_Exited);

      // Sleep 250 and see if it exited too quickly. Why do we do this? We have .Exited hooked. Is this in case it happens between start and hook?
      // if so, why not hook before start? 
      // MtW: we do this for the potential situation where it might exit before the Exited event is hooked. Iirc i had this situation before..
      System.Threading.Thread.Sleep(250);
      if (mProcess.HasExited) {
        Trace.WriteLine("Error while running: " + mProcess.StandardError.ReadToEnd());
        Trace.WriteLine(mProcess.StandardOutput.ReadToEnd());
        Trace.WriteLine("ExitCode: " + mProcess.ExitCode);
        throw new Exception("Error while starting OS debug host.");
      }

      mEngine = aEngine;
      mThread = new AD7Thread(aEngine, this);
      mCallback.OnThreadStart(mThread);
      mPort = aPort;

      if (xGDBDebugStub && xGDBClient) {
        LaunchGdbClient();
      }
    }

    protected void LaunchGdbClient() {
      OutputText("Launching GDB client.");
      if (File.Exists(Cosmos.Build.Common.CosmosPaths.GDBClientExe)) {
        var xPSInfo = new ProcessStartInfo(Cosmos.Build.Common.CosmosPaths.GDBClientExe);
        xPSInfo.Arguments = "\"" + Path.ChangeExtension(mProjectFile, ".cgdb") + "\"" + @" /Connect";
        xPSInfo.UseShellExecute = false;
        xPSInfo.RedirectStandardInput = false;
        xPSInfo.RedirectStandardError = false;
        xPSInfo.RedirectStandardOutput = false;
        xPSInfo.CreateNoWindow = false;
        Process.Start(xPSInfo);
      } else {
        MessageBox.Show(string.Format(
            "The GDB-Client could not be found at \"{0}\". Please deactivate it under \"Properties/Debug/Enable GDB\"",
            Cosmos.Build.Common.CosmosPaths.GDBClientExe), "GDB-Client", MessageBoxButtons.OK, MessageBoxIcon.Warning, MessageBoxDefaultButton.Button1);
      }
    }

    private void DbgConnector_ConnectionLost(Exception e) {
      if (Interlocked.CompareExchange(ref mProcessExitEventSent, 1, 0) == 1) {
        return;
      }
      if (mDbgConnector != null) {
        mEngine.Callback.OnProcessExit(0);
      }
    }

    // Shows a message in the output window of VS. Needs special treatment, 
    // because normally VS only shows msgs from debugged process, not internal
    // stuff like us.
    public void DebugMsg(string aMsg) {
      mCallback.OnOutputString(aMsg + "\n");
    }

    protected void DbgCmdStarted() {
      OutputText("DebugStub handshake completed.");
      DebugMsg("RmtDbg: Started");

      // OK, now debugger is ready. Send it a list of breakpoints that were set before
      // program run.
      foreach (var xBP in mEngine.BPMgr.mPendingBPs) {
        foreach (var xBBP in xBP.mBoundBPs) {
          mDbgConnector.SetBreakpoint(xBBP.RemoteID, xBBP.mAddress);
        }
      }
      mDbgConnector.SendCmd(VsipDs.BatchEnd);
    }

    void DbgCmdText(string obj) {
      mCallback.OnOutputStringUser(obj + "\r\n");
    }

    internal AD7Thread Thread {
      get {
        return mThread;
      }
    }

    void DbgCmdTrace(byte arg1, uint arg2) {
      DebugMsg("DbgCmdTrace");
      switch (arg1) {
        case DsVsip.BreakPoint: {
            // When doing a CALL, the return address is pushed, but that's the address of the next instruction, after CALL. call is 5 bytes (for now?)
            // Dont need to correct the address, becuase DebugStub does it for us.
            var xActualAddress = arg2;
            DebugMsg("BP hit @ " + xActualAddress.ToString("X8").ToUpper());

            var xActionPoints = new List<object>();
            var xBoundBreakpoints = new List<IDebugBoundBreakpoint2>();

            // Search the BPs and find the ones that match our address
            foreach (var xBP in mEngine.BPMgr.mPendingBPs) {
              foreach (var xBBP in xBP.mBoundBPs) {
                if (xBBP.mAddress == xActualAddress) {
                  xBoundBreakpoints.Add(xBBP);
                }
              }
            }

            mCurrentAddress = xActualAddress;
            // if no matching breakpoint, its either a stepping operation, or a code based break
            if (xBoundBreakpoints.Count == 0) {
              // Is it a result of stepping operation?
              if (mEngine.AfterBreak) {
                RequestFullDebugStubUpdate();
                mCallback.OnStepComplete();
              } else {
                RequestFullDebugStubUpdate();
                // Code based break. Tell VS to break.
                mCallback.OnBreakpoint(mThread, new ReadOnlyCollection<IDebugBoundBreakpoint2>(xBoundBreakpoints));
              }
            } else {
              // Found a bound breakpoint
              RequestFullDebugStubUpdate();
              mCallback.OnBreakpoint(mThread, new ReadOnlyCollection<IDebugBoundBreakpoint2>(xBoundBreakpoints));
              mEngine.AfterBreak = true;
            }
            break;
          }

        default: {
            DebugMsg("TraceReceived: " + arg1);
            break;
          }
      }
    }

    protected void RequestFullDebugStubUpdate() {
      // We catch and resend data rather than using a second serial port because
      // while this would work fine in a VM, it would require 2 serial ports
      // when real hardware is used.
      SendAssembly();
      mDbgConnector.SendRegisters();
      mDbgConnector.SendFrame();
      mDbgConnector.SendStack();
    }

    public int Attach(IDebugEventCallback2 pCallback, Guid[] rgguidSpecificEngines, uint celtSpecificEngines, int[] rghrEngineAttach) {
      Trace.WriteLine(new StackTrace(false).GetFrame(0).GetMethod().GetFullName());
      throw new NotImplementedException();
    }

    public int CanDetach() {
      throw new NotImplementedException();
    }

    public int CauseBreak() {
      throw new NotImplementedException();
    }

    public int Detach() {
      throw new NotImplementedException();
    }

    public int EnumPrograms(out IEnumDebugPrograms2 ppEnum) {
      throw new NotImplementedException();
    }

    public int EnumThreads(out IEnumDebugThreads2 ppEnum) {
      var xEnum = new AD7ThreadEnum(new IDebugThread2[] { mThread });
      ppEnum = xEnum;
      return VSConstants.S_OK;
    }

    public int GetAttachedSessionName(out string pbstrSessionName) {
      throw new NotImplementedException();
    }

    public int GetInfo(enum_PROCESS_INFO_FIELDS Fields, PROCESS_INFO[] pProcessInfo) {
      throw new NotImplementedException();
    }

    public int GetName(enum_GETNAME_TYPE gnType, out string pbstrName) {
      throw new NotImplementedException();
    }

    public int GetPhysicalProcessId(AD_PROCESS_ID[] pProcessId) {
      Trace.WriteLine(new StackTrace(false).GetFrame(0).GetMethod().GetFullName());
      pProcessId[0].dwProcessId = (uint)mProcess.Id;
      pProcessId[0].ProcessIdType = (uint)enum_AD_PROCESS_ID.AD_PROCESS_ID_SYSTEM;
      return VSConstants.S_OK;
    }

    private IDebugPort2 mPort = null;

    public int GetPort(out IDebugPort2 ppPort) {
      if (mPort == null) {
        throw new Exception("Error");
      }
      ppPort = mPort;
      return VSConstants.S_OK;
    }

    public int GetProcessId(out Guid pguidProcessId) {
      Trace.WriteLine(new StackTrace(false).GetFrame(0).GetMethod().GetFullName());
      pguidProcessId = mID;
      return VSConstants.S_OK;
    }

    public int GetServer(out IDebugCoreServer2 ppServer) {
      throw new NotImplementedException();
    }

    public int Terminate() {
      OutputText("Debugger terminating.");
      if (Interlocked.CompareExchange(ref mProcessExitEventSent, 1, 0) == 0) {
        mProcess.Kill();
        mProcess.Exited -= mProcess_Exited;
        if (mDbgConnector != null) {
          mDbgConnector.Dispose();
          mDbgConnector = null;
        }
        if (mDebugInfoDb != null) {
          mDebugInfoDb.Dispose();
          mDebugInfoDb = null;
        }
      }

      mHost.Stop();

      OutputText("Debugger terminated.");
      return VSConstants.S_OK;
    }

    internal void ResumeFromLaunch() {
      // This unpauses our debug host
      // We do this because VS requires a start, and then a resume after. So we have debughost which is a stub
      // that allows VS to "see" that. Here we resume it.
      mProcess.StandardInput.WriteLine();
    }

    void mProcess_Exited(object sender, EventArgs e) {
      Trace.WriteLine("Error while running: " + mProcess.StandardError.ReadToEnd());
      Trace.WriteLine(mProcess.StandardOutput.ReadToEnd());
      Trace.WriteLine(String.Format("Process Exit Code: {0}", mProcess.ExitCode));
      //AD7ThreadDestroyEvent.Send(mEngine, mThread, (uint)mProcess.ExitCode);
      //mCallback.OnProgramDestroy((uint)mProcess.ExitCode);

      if (mDbgConnector != null) {
        mDbgConnector.Dispose();
        mDbgConnector = null;
      }
      if (mDebugInfoDb != null) {
        mDebugInfoDb.Dispose();
        mDebugInfoDb = null;
      }
      if (Interlocked.CompareExchange(ref mProcessExitEventSent, 1, 0) == 0) {
        mCallback.OnProcessExit((uint)mProcess.ExitCode);
      }
    }

    internal void Continue() { // F5
      mCurrentAddress = null;
      mDbgConnector.Continue();
    }

    internal void Step(enum_STEPKIND aKind) {
      if (aKind == enum_STEPKIND.STEP_INTO) { // F11
        mDbgConnector.SendCmd(VsipDs.StepInto);

      } else if (aKind == enum_STEPKIND.STEP_OVER) { // F10
        mDbgConnector.SendCmd(VsipDs.StepOver);

      } else if (aKind == enum_STEPKIND.STEP_OUT) { // Shift-F11
        mDbgConnector.SendCmd(VsipDs.StepOut);

      } else if (aKind == enum_STEPKIND.STEP_BACKWARDS) {
        // STEP_BACKWARDS - Supported at all by VS?
        //
        // Possibly, by dragging the execution location up
        // or down through the source code? -Orvid
        MessageBox.Show("Step backwards is not supported.");
        mCallback.OnStepComplete(); // Have to call this otherwise VS gets "stuck"

      } else {
        MessageBox.Show("Unknown step type requested.");
        mCallback.OnStepComplete(); // Have to call this otherwise VS gets "stuck"
      }
    }

    public void SendAssembly() {
      // Because of Asm breakpoints the address we have might be in the middle of a C# line.
      // So we find the closest address to ours that is less or equal to ours.
      var xQry = from x in mSourceMappings
                 where x.Key <= (uint)mCurrentAddress
                 orderby x.Key descending
                 select x.Value;
      var xValue = xQry.FirstOrDefault();
      if (xValue == null) {
        return;
      }

      // Create list of asm labels that belong to this line of C#.
      //var xValue = mSourceMappings[(uint)mCurrentAddress];
      var xMappings = from x in mSourceMappings
                   where x.Value.SourceFile == xValue.SourceFile
                     && x.Value.Line == xValue.Line
                     && x.Value.Column == xValue.Column
                   select x.Key;
      var xLabels = new List<string>();
      foreach (uint xAddr in xMappings) {
        var xLabelsForAddr = from x in mAddressLabelMappings
                      where x.Key == xAddr
                      select x.Value;
        foreach (string xLabel in xLabelsForAddr) {
          xLabels.Add(xLabel + ":");
        }
      }

      // Get assembly source
      var xCode = AsmSource.GetSourceForLabels(Path.ChangeExtension(mISO, ".asm"), xLabels);

      // Get label for current address.
      // A single address can have multiple labels (IL, Asm). Because of this we search
      // for the one with the Asm tag. We dont have the tags in this debug info though,
      // so instead if there is more than one label we use the last one which is the Asm tag.
      var xCurrentLabelsQry = (from x in mAddressLabelMappings
                           where (x.Key == (uint)mCurrentAddress)
                           select x.Value);
      var xCurrentLabels = xCurrentLabelsQry.ToArray();
      if (xCurrentLabels.Length == 0) {
        return;
      }
      // Insert it to the first line of our data stream
      xCode.Insert(0, xCurrentLabels[xCurrentLabels.Length - 1] + "\r\n");                      

      mDebugDownPipe.SendCommand(VsipUi.AssemblySource, Encoding.UTF8.GetBytes(xCode.ToString()));
    }

    //TODO: At some point this will probably need to be exposed for access outside of AD7Process
    protected void OutputText(string aText) {
      mDebugDownPipe.SendCommand(VsipUi.OutputPane, Encoding.UTF8.GetBytes(aText + "\r\n"));
    }

    protected void OutputClear() {
      mDebugDownPipe.SendCommand(VsipUi.OutputClear);
    }

  }
}