docs/MarkedUpDisassembly.rst

   1 .. _marked_up_disassembly:
   2
   3 =======================================
   4 LLVM's Optional Rich Disassembly Output
   5 =======================================
   6
   7 .. contents::
   8    :local:
   9
  10 Introduction
  11 ============
  12
  13 LLVM's default disassembly output is raw text. To allow consumers more ability
  14 to introspect the instructions' textual representation or to reformat for a more
  15 user friendly display there is an optional rich disassembly output.
  16
  17 This optional output is sufficient to reference into individual portions of the
  18 instruction text. This is intended for clients like disassemblers, list file
  19 generators, and pretty-printers, which need more than the raw instructions and
  20 the ability to print them.
  21
  22 To provide this functionality the assembly text is marked up with annotations.
  23 The markup is simple enough in syntax to be robust even in the case of version
  24 mismatches between consumers and producers. That is, the syntax generally does
  25 not carry semantics beyond "this text has an annotation," so consumers can
  26 simply ignore annotations they do not understand or do not care about.
  27
  28 After calling ``LLVMCreateDisasm()`` to create a disassembler context the
  29 optional output is enable with this call:
  30
  31 .. code-block:: c
  32
  33     LLVMSetDisasmOptions(DC, LLVMDisassembler_Option_UseMarkup);
  34
  35 Then subsequent calls to ``LLVMDisasmInstruction()`` will return output strings
  36 with the marked up annotations.
  37
  38 Instruction Annotations
  39 =======================
  40
  41 .. _contextual markups:
  42
  43 Contextual markups
  44 ------------------
  45
  46 Annoated assembly display will supply contextual markup to help clients more
  47 efficiently implement things like pretty printers. Most markup will be target
  48 independent, so clients can effectively provide good display without any target
  49 specific knowledge.
  50
  51 Annotated assembly goes through the normal instruction printer, but optionally
  52 includes contextual tags on portions of the instruction string. An annotation
  53 is any '<' '>' delimited section of text(1).
  54
  55 .. code-block:: bat
  56
  57     annotation: '<' tag-name tag-modifier-list ':' annotated-text '>'
  58     tag-name: identifier
  59     tag-modifier-list: comma delimited identifier list
  60
  61 The tag-name is an identifier which gives the type of the annotation. For the
  62 first pass, this will be very simple, with memory references, registers, and
  63 immediates having the tag names "mem", "reg", and "imm", respectively.
  64
  65 The tag-modifier-list is typically additional target-specific context, such as
  66 register class.
  67
  68 Clients should accept and ignore any tag-names or tag-modifiers they do not
  69 understand, allowing the annotations to grow in richness without breaking older
  70 clients.
  71
  72 For example, a possible annotation of an ARM load of a stack-relative location
  73 might be annotated as:
  74
  75 .. code-block:: nasm
  76
  77    ldr <reg gpr:r0>, <mem regoffset:[<reg gpr:sp>, <imm:#4>]>
  78
  79
  80 1: For assembly dialects in which '<' and/or '>' are legal tokens, a literal token is escaped by following immediately with a repeat of the character.  For example, a literal '<' character is output as '<<' in an annotated assembly string.
  81
  82 C API Details
  83 -------------
  84
  85 The intended consumers of this information use the C API, therefore the new C
  86 API function for the disassembler will be added to provide an option to produce
  87 disassembled instructions with annotations, ``LLVMSetDisasmOptions()`` and the
  88 ``LLVMDisassembler_Option_UseMarkup`` option (see above).