cBugReport_fsGetDisassemblyHTML.py

import re;
from dxBugIdConfig import dxBugIdConfig;

def fsHTMLEncodeAndColorDisassemblyLine(oCdbWrapper, sLine, bImportant = False):
  # If this line starts with an address and opcode, make those semi-transparent.
  oMatch = re.match(r"^([0-9a-fA-F`]+\s+)([0-9a-fA-F]+\s+)(.+)$", sLine);
  if oMatch:
    sAddress, sOpcode, sInstruction = oMatch.groups();
    return "".join([
      "<span class=\"DisassemblyAddress\">%s</span>" % oCdbWrapper.fsHTMLEncode(sAddress),
      "<span class=\"DisassemblyOpcode\">%s</span>" % oCdbWrapper.fsHTMLEncode(sOpcode),
      "<span class=\"DisassemblyInstruction%s\">%s</span>" % \
          (bImportant and " Important" or "", oCdbWrapper.fsHTMLEncode(sInstruction)),
    ]);
  return "<span class=\"DisassemblyInformation\">%s</span>" % oCdbWrapper.fsHTMLEncode(sLine, uTabStop = 8);
  
def cBugReport_fsGetDisassemblyHTML(oBugReport, oCdbWrapper, uAddress, sBeforeAddressInstructionDescription = None, sAtAddressInstructionDescription = None):
  # See dxBugIdConfig for a description of these "magic" values.
  uDisassemblyBytesBefore = dxBugIdConfig["uDisassemblyInstructionsBefore"] * dxBugIdConfig["uDisassemblyAverageInstructionSize"] + \
      dxBugIdConfig["uDisassemblyAlignmentBytes"];
  uDisassemblyBytesAfter = dxBugIdConfig["uDisassemblyInstructionsAfter"] * dxBugIdConfig["uDisassemblyAverageInstructionSize"];
  # Get disassembly around code in which exception happened. This may not be possible if the instruction pointer points to unmapped memory.
  asHTML = [];
  if uDisassemblyBytesBefore > 0:
    # Get disassembly before address
    uStartAddress = uAddress - uDisassemblyBytesBefore;
    # Note: cannot use "u {address} L{length}" as length is number of instructions, and we want number of bytes. 
    asBeforeDisassembly = oCdbWrapper.fasSendCommandAndReadOutput(
      ".if ($vvalid(0x%X, 0x%X)) { u 0x%X 0x%X; }; $$ disassemble before address" %
          (uStartAddress, uDisassemblyBytesBefore, uStartAddress, uAddress - 1),
      bOutputIsInformative = True,
    );
    if not oCdbWrapper.bCdbRunning: return None;
    # Limit number of instructions
    asBeforeDisassembly = asBeforeDisassembly[-dxBugIdConfig["uDisassemblyInstructionsBefore"]:];
    if asBeforeDisassembly:
      # Optionally highlight and describe instruction before the address:
      if sBeforeAddressInstructionDescription:
        sBeforeAddressDisassembly = asBeforeDisassembly.pop(-1);
      asHTML += [fsHTMLEncodeAndColorDisassemblyLine(oCdbWrapper, s) for s in asBeforeDisassembly];
      if sBeforeAddressInstructionDescription:
        asHTML.append(
          "%s <span class=\"Important\">// %s</span>" % \
              (fsHTMLEncodeAndColorDisassemblyLine(oCdbWrapper, sBeforeAddressDisassembly, bImportant = True), \
              sBeforeAddressInstructionDescription)
        );
  if uDisassemblyBytesAfter > 0:
    asAddressAtAndAfterDisassembly = oCdbWrapper.fasSendCommandAndReadOutput(
      ".if ($vvalid(0x%X, 0x%X)) { u 0x%X L0x%X; }; $$ Disassemble after address" %
          (uAddress, uDisassemblyBytesAfter, uAddress, uDisassemblyBytesAfter),
      bOutputIsInformative = True,
    );
    if not oCdbWrapper.bCdbRunning: return None;
    if asAddressAtAndAfterDisassembly:
      assert len(asAddressAtAndAfterDisassembly) >= 2, \
          "Unexpected short disassembly output:\r\n%s" % "\r\n".join(asAddressAtAndAfterDisassembly);
      # The first line contains the address of the instruction
      if not asHTML:
        asHTML.append("(prior disassembly not possible)");
      # disassembly starts with a line containing the address/symbol:
      sAddressLine = asAddressAtAndAfterDisassembly.pop(0);
      asHTML.append(fsHTMLEncodeAndColorDisassemblyLine(oCdbWrapper, sAddressLine));
      # First line of disassembly at address is important;
      sAtAddressDisassembly = asAddressAtAndAfterDisassembly.pop(0);
      sAtAddressDisassemblyHTML = fsHTMLEncodeAndColorDisassemblyLine(oCdbWrapper, sAtAddressDisassembly, bImportant = True);
      if sAtAddressInstructionDescription:
        sAtAddressDisassemblyHTML += " <span class=\"Important\">// %s</span>" % sAtAddressInstructionDescription;
      asHTML.append(sAtAddressDisassemblyHTML);
      # Limit the number of instructions, taking into account we already processed one:
      asAfterDisassembly = asAddressAtAndAfterDisassembly[:dxBugIdConfig["uDisassemblyInstructionsAfter"] - 1];
      asHTML += [fsHTMLEncodeAndColorDisassemblyLine(oCdbWrapper, s) for s in asAfterDisassembly];
    elif asHTML:
      asHTML.append("(further disassembly not possible)");
  return "<br/>".join(asHTML);