docs/CodeGenerator.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   2                       "http://www.w3.org/TR/html4/strict.dtd">
   3 <html>
   4 <head>
   5   <title>The LLVM Target-Independent Code Generator</title>
   6   <link rel="stylesheet" href="llvm.css" type="text/css">
   7 </head>
   8 <body>
   9
  10 <div class="doc_title">
  11   The LLVM Target-Independent Code Generator
  12 </div>
  13
  14 <ol>
  15   <li><a href="#introduction">Introduction</a>
  16     <ul>
  17       <li><a href="#required">Required components in the code generator</a></li>
  18       <li><a href="#high-level-design">The high-level design of the code generator</a></li>
  19       <li><a href="#tablegen">Using TableGen for target description</a></li>
  20     </ul>
  21   </li>
  22   <li><a href="#targetdesc">Target description classes</a>
  23     <ul>
  24       <li><a href="#targetmachine">The <tt>TargetMachine</tt> class</a></li>
  25       <li><a href="#targetdata">The <tt>TargetData</tt> class</a></li>
  26       <li><a href="#targetlowering">The <tt>TargetLowering</tt> class</a></li>
  27       <li><a href="#mregisterinfo">The <tt>MRegisterInfo</tt> class</a></li>
  28       <li><a href="#targetinstrinfo">The <tt>TargetInstrInfo</tt> class</a></li>
  29       <li><a href="#targetframeinfo">The <tt>TargetFrameInfo</tt> class</a></li>
  30       <li><a href="#targetjitinfo">The <tt>TargetJITInfo</tt> class</a></li>
  31     </ul>
  32   </li>
  33   <li><a href="#codegendesc">Machine code description classes</a>
  34     <ul>
  35     <li><a href="#machineinstr">The <tt>MachineInstr</tt> class</a></li>
  36     </ul>
  37   </li>
  38   <li><a href="#codegenalgs">Target-independent code generation algorithms</a>
  39     <ul>
  40     <li><a href="#instselect">Instruction Selection</a>
  41       <ul>
  42       <li><a href="#selectiondag_intro">Introduction to SelectionDAGs</a></li>
  43       <li><a href="#selectiondag_process">SelectionDAG Code Generation
  44                                           Process</a></li>
  45       <li><a href="#selectiondag_build">Initial SelectionDAG
  46                                         Construction</a></li>
  47       <li><a href="#selectiondag_legalize">SelectionDAG Legalize Phase</a></li>
  48       <li><a href="#selectiondag_optimize">SelectionDAG Optimization
  49                                            Phase</a></li>
  50       <li><a href="#selectiondag_select">SelectionDAG Select Phase</a></li>
  51       <li><a href="#selectiondag_future">Future directions for the
  52                                          SelectionDAG</a></li>
  53       </ul></li>
  54     </ul>
  55   </li>
  56   <li><a href="#targetimpls">Target description implementations</a>
  57     <ul>
  58     <li><a href="#x86">The X86 backend</a></li>
  59     </ul>
  60   </li>
  61
  62 </ol>
  63
  64 <div class="doc_author">
  65   <p>Written by <a href="mailto:sabre@nondot.org">Chris Lattner</a></p>
  66 </div>
  67
  68 <div class="doc_warning">
  69   <p>Warning: This is a work in progress.</p>
  70 </div>
  71
  72 <!-- *********************************************************************** -->
  73 <div class="doc_section">
  74   <a name="introduction">Introduction</a>
  75 </div>
  76 <!-- *********************************************************************** -->
  77
  78 <div class="doc_text">
  79
  80 <p>The LLVM target-independent code generator is a framework that provides a
  81 suite of reusable components for translating the LLVM internal representation to
  82 the machine code for a specified target -- either in assembly form (suitable for
  83 a static compiler) or in binary machine code format (usable for a JIT compiler).
  84 The LLVM target-independent code generator consists of five main components:</p>
  85
  86 <ol>
  87 <li><a href="#targetdesc">Abstract target description</a> interfaces which
  88 capture important properties about various aspects of the machine, independently
  89 of how they will be used.  These interfaces are defined in
  90 <tt>include/llvm/Target/</tt>.</li>
  91
  92 <li>Classes used to represent the <a href="#codegendesc">machine code</a> being
  93 generated for a target.  These classes are intended to be abstract enough to
  94 represent the machine code for <i>any</i> target machine.  These classes are
  95 defined in <tt>include/llvm/CodeGen/</tt>.</li>
  96
  97 <li><a href="#codegenalgs">Target-independent algorithms</a> used to implement
  98 various phases of native code generation (register allocation, scheduling, stack
  99 frame representation, etc).  This code lives in <tt>lib/CodeGen/</tt>.</li>
 100
 101 <li><a href="#targetimpls">Implementations of the abstract target description
 102 interfaces</a> for particular targets.  These machine descriptions make use of
 103 the components provided by LLVM, and can optionally provide custom
 104 target-specific passes, to build complete code generators for a specific target.
 105 Target descriptions live in <tt>lib/Target/</tt>.</li>
 106
 107 <li><a href="#jit">The target-independent JIT components</a>.  The LLVM JIT is
 108 completely target independent (it uses the <tt>TargetJITInfo</tt> structure to
 109 interface for target-specific issues.  The code for the target-independent
 110 JIT lives in <tt>lib/ExecutionEngine/JIT</tt>.</li>
 111
 112 </ol>
 113
 114 <p>
 115 Depending on which part of the code generator you are interested in working on,
 116 different pieces of this will be useful to you.  In any case, you should be
 117 familiar with the <a href="#targetdesc">target description</a> and <a
 118 href="#codegendesc">machine code representation</a> classes.  If you want to add
 119 a backend for a new target, you will need to <a href="#targetimpls">implement the
 120 target description</a> classes for your new target and understand the <a
 121 href="LangRef.html">LLVM code representation</a>.  If you are interested in
 122 implementing a new <a href="#codegenalgs">code generation algorithm</a>, it
 123 should only depend on the target-description and machine code representation
 124 classes, ensuring that it is portable.
 125 </p>
 126
 127 </div>
 128
 129 <!-- ======================================================================= -->
 130 <div class="doc_subsection">
 131  <a name="required">Required components in the code generator</a>
 132 </div>
 133
 134 <div class="doc_text">
 135
 136 <p>The two pieces of the LLVM code generator are the high-level interface to the
 137 code generator and the set of reusable components that can be used to build
 138 target-specific backends.  The two most important interfaces (<a
 139 href="#targetmachine"><tt>TargetMachine</tt></a> and <a
 140 href="#targetdata"><tt>TargetData</tt></a>) are the only ones that are
 141 required to be defined for a backend to fit into the LLVM system, but the others
 142 must be defined if the reusable code generator components are going to be
 143 used.</p>
 144
 145 <p>This design has two important implications.  The first is that LLVM can
 146 support completely non-traditional code generation targets.  For example, the C
 147 backend does not require register allocation, instruction selection, or any of
 148 the other standard components provided by the system.  As such, it only
 149 implements these two interfaces, and does its own thing.  Another example of a
 150 code generator like this is a (purely hypothetical) backend that converts LLVM
 151 to the GCC RTL form and uses GCC to emit machine code for a target.</p>
 152
 153 <p>This design also implies that it is possible to design and
 154 implement radically different code generators in the LLVM system that do not
 155 make use of any of the built-in components.  Doing so is not recommended at all,
 156 but could be required for radically different targets that do not fit into the
 157 LLVM machine description model: programmable FPGAs for example.</p>
 158
 159 <p><b>Important Note:</b> For historical reasons, the LLVM SparcV9 code
 160 generator uses almost entirely different code paths than described in this
 161 document.  For this reason, there are some deprecated interfaces (such as
 162 <tt>TargetRegInfo</tt> and <tt>TargetSchedInfo</tt>), which are only used by the
 163 V9 backend and should not be used by any other targets.  Also, all code in the
 164 <tt>lib/Target/SparcV9</tt> directory and subdirectories should be considered
 165 deprecated, and should not be used as the basis for future code generator work.
 166 The SparcV9 backend is slowly being merged into the rest of the
 167 target-independent code generators, but this is a low-priority process with no
 168 predictable completion date.</p>
 169
 170 </div>
 171
 172 <!-- ======================================================================= -->
 173 <div class="doc_subsection">
 174  <a name="high-level-design">The high-level design of the code generator</a>
 175 </div>
 176
 177 <div class="doc_text">
 178
 179 <p>The LLVM target-independent code generator is designed to support efficient and
 180 quality code generation for standard register-based microprocessors.  Code
 181 generation in this model is divided into the following stages:</p>
 182
 183 <ol>
 184 <li><b><a href="#instselect">Instruction Selection</a></b> - Determining an
 185 efficient implementation of the input LLVM code in the target instruction set.
 186 This stage produces the initial code for the program in the target instruction
 187 set, then makes use of virtual registers in SSA form and physical registers that
 188 represent any required register assignments due to target constraints or calling
 189 conventions.</li>
 190
 191 <li><b><a href="#ssamco">SSA-based Machine Code Optimizations</a></b> - This
 192 optional stage consists of a series of machine-code optimizations that
 193 operate on the SSA-form produced by the instruction selector.  Optimizations
 194 like modulo-scheduling, normal scheduling, or peephole optimization work here.
 195 </li>
 196
 197 <li><b><a name="#regalloc">Register Allocation</a></b> - The
 198 target code is transformed from an infinite virtual register file in SSA form
 199 to the concrete register file used by the target.  This phase introduces spill
 200 code and eliminates all virtual register references from the program.</li>
 201
 202 <li><b><a name="#proepicode">Prolog/Epilog Code Insertion</a></b> - Once the
 203 machine code has been generated for the function and the amount of stack space
 204 required is known (used for LLVM alloca's and spill slots), the prolog and
 205 epilog code for the function can be inserted and "abstract stack location
 206 references" can be eliminated.  This stage is responsible for implementing
 207 optimizations like frame-pointer elimination and stack packing.</li>
 208
 209 <li><b><a name="latemco">Late Machine Code Optimizations</a></b> - Optimizations
 210 that operate on "final" machine code can go here, such as spill code scheduling
 211 and peephole optimizations.</li>
 212
 213 <li><b><a name="codemission">Code Emission</a></b> - The final stage actually
 214 puts out the code for the current function, either in the target assembler
 215 format or in machine code.</li>
 216
 217 </ol>
 218
 219 <p>
 220 The code generator is based on the assumption that the instruction selector will
 221 use an optimal pattern matching selector to create high-quality sequences of
 222 native instructions.  Alternative code generator designs based on pattern
 223 expansion and
 224 aggressive iterative peephole optimization are much slower.  This design
 225 permits efficient compilation (important for JIT environments) and
 226 aggressive optimization (used when generating code offline) by allowing
 227 components of varying levels of sophistication to be used for any step of
 228 compilation.</p>
 229
 230 <p>
 231 In addition to these stages, target implementations can insert arbitrary
 232 target-specific passes into the flow.  For example, the X86 target uses a
 233 special pass to handle the 80x87 floating point stack architecture.  Other
 234 targets with unusual requirements can be supported with custom passes as needed.
 235 </p>
 236
 237 </div>
 238
 239
 240 <!-- ======================================================================= -->
 241 <div class="doc_subsection">
 242  <a name="tablegen">Using TableGen for target description</a>
 243 </div>
 244
 245 <div class="doc_text">
 246
 247 <p>The target description classes require a detailed description of the target
 248 architecture.  These target descriptions often have a large amount of common
 249 information (e.g., an <tt>add</tt> instruction is almost identical to a
 250 <tt>sub</tt> instruction).
 251 In order to allow the maximum amount of commonality to be factored out, the LLVM
 252 code generator uses the <a href="TableGenFundamentals.html">TableGen</a> tool to
 253 describe big chunks of the target machine, which allows the use of
 254 domain-specific and target-specific abstractions to reduce the amount of
 255 repetition.
 256 </p>
 257
 258 </div>
 259
 260 <!-- *********************************************************************** -->
 261 <div class="doc_section">
 262   <a name="targetdesc">Target description classes</a>
 263 </div>
 264 <!-- *********************************************************************** -->
 265
 266 <div class="doc_text">
 267
 268 <p>The LLVM target description classes (which are located in the
 269 <tt>include/llvm/Target</tt> directory) provide an abstract description of the
 270 target machine; independent of any particular client.  These classes are
 271 designed to capture the <i>abstract</i> properties of the target (such as the
 272 instructions and registers it has), and do not incorporate any particular pieces
 273 of code generation algorithms. These interfaces do not take interference graphs
 274 as inputs or other algorithm-specific data structures.</p>
 275
 276 <p>All of the target description classes (except the <tt><a
 277 href="#targetdata">TargetData</a></tt> class) are designed to be subclassed by
 278 the concrete target implementation, and have virtual methods implemented.  To
 279 get to these implementations, the <tt><a
 280 href="#targetmachine">TargetMachine</a></tt> class provides accessors that
 281 should be implemented by the target.</p>
 282
 283 </div>
 284
 285 <!-- ======================================================================= -->
 286 <div class="doc_subsection">
 287   <a name="targetmachine">The <tt>TargetMachine</tt> class</a>
 288 </div>
 289
 290 <div class="doc_text">
 291
 292 <p>The <tt>TargetMachine</tt> class provides virtual methods that are used to
 293 access the target-specific implementations of the various target description
 294 classes via the <tt>get*Info</tt> methods (<tt>getInstrInfo</tt>,
 295 <tt>getRegisterInfo</tt>, <tt>getFrameInfo</tt>, etc.).  This class is
 296 designed to be specialized by
 297 a concrete target implementation (e.g., <tt>X86TargetMachine</tt>) which
 298 implements the various virtual methods.  The only required target description
 299 class is the <a href="#targetdata"><tt>TargetData</tt></a> class, but if the
 300 code generator components are to be used, the other interfaces should be
 301 implemented as well.</p>
 302
 303 </div>
 304
 305
 306 <!-- ======================================================================= -->
 307 <div class="doc_subsection">
 308   <a name="targetdata">The <tt>TargetData</tt> class</a>
 309 </div>
 310
 311 <div class="doc_text">
 312
 313 <p>The <tt>TargetData</tt> class is the only required target description class,
 314 and it is the only class that is not extensible. You cannot derived  a new
 315 class from it.  <tt>TargetData</tt> specifies information about how the target
 316 lays out memory for structures, the alignment requirements for various data
 317 types, the size of pointers in the target, and whether the target is
 318 little-endian or big-endian.</p>
 319
 320 </div>
 321
 322 <!-- ======================================================================= -->
 323 <div class="doc_subsection">
 324   <a name="targetlowering">The <tt>TargetLowering</tt> class</a>
 325 </div>
 326
 327 <div class="doc_text">
 328
 329 <p>The <tt>TargetLowering</tt> class is used by SelectionDAG based instruction
 330 selectors primarily to describe how LLVM code should be lowered to SelectionDAG
 331 operations.  Among other things, this class indicates:
 332 <ul><li>an initial register class to use for various ValueTypes,</li>
 333   <li>which operations are natively supported by the target machine,</li>
 334   <li>the return type of setcc operations, and</li>
 335   <li>the type to use for shift amounts, etc</li>.
 336 </ol></p>
 337
 338 </div>
 339
 340
 341
 342
 343
 344 <!-- ======================================================================= -->
 345 <div class="doc_subsection">
 346   <a name="mregisterinfo">The <tt>MRegisterInfo</tt> class</a>
 347 </div>
 348
 349 <div class="doc_text">
 350
 351 <p>The <tt>MRegisterInfo</tt> class (which will eventually be renamed to
 352 <tt>TargetRegisterInfo</tt>) is used to describe the register file of the
 353 target and any interactions between the registers.</p>
 354
 355 <p>Registers in the code generator are represented in the code generator by
 356 unsigned numbers.  Physical registers (those that actually exist in the target
 357 description) are unique small numbers, and virtual registers are generally
 358 large.</p>
 359
 360 <p>Each register in the processor description has an associated
 361 <tt>MRegisterDesc</tt> entry, which provides a textual name for the register
 362 (used for assembly output and debugging dumps), a set of aliases (used to
 363 indicate that one register overlaps with another), and some flag bits.
 364 </p>
 365
 366 <p>In addition to the per-register description, the <tt>MRegisterInfo</tt> class
 367 exposes a set of processor specific register classes (instances of the
 368 <tt>TargetRegisterClass</tt> class).  Each register class contains sets of
 369 registers that have the same properties (for example, they are all 32-bit
 370 integer registers).  Each SSA virtual register created by the instruction
 371 selector has an associated register class.  When the register allocator runs, it
 372 replaces virtual registers with a physical register in the set.</p>
 373
 374 <p>
 375 The target-specific implementations of these classes is auto-generated from a <a
 376 href="TableGenFundamentals.html">TableGen</a> description of the register file.
 377 </p>
 378
 379 </div>
 380
 381 <!-- ======================================================================= -->
 382 <div class="doc_subsection">
 383   <a name="targetinstrinfo">The <tt>TargetInstrInfo</tt> class</a>
 384 </div>
 385
 386 <!-- ======================================================================= -->
 387 <div class="doc_subsection">
 388   <a name="targetframeinfo">The <tt>TargetFrameInfo</tt> class</a>
 389 </div>
 390
 391 <!-- ======================================================================= -->
 392 <div class="doc_subsection">
 393   <a name="targetjitinfo">The <tt>TargetJITInfo</tt> class</a>
 394 </div>
 395
 396 <!-- *********************************************************************** -->
 397 <div class="doc_section">
 398   <a name="codegendesc">Machine code description classes</a>
 399 </div>
 400 <!-- *********************************************************************** -->
 401
 402 <div class="doc_text">
 403
 404 <p>
 405 At the high-level, LLVM code is translated to a machine specific representation
 406 formed out of MachineFunction, MachineBasicBlock, and <a
 407 href="#machineinstr"><tt>MachineInstr</tt></a> instances
 408 (defined in include/llvm/CodeGen).  This representation is completely target
 409 agnostic, representing instructions in their most abstract form: an opcode and a
 410 series of operands.  This representation is designed to support both SSA
 411 representation for machine code, as well as a register allocated, non-SSA form.
 412 </p>
 413
 414 </div>
 415
 416 <!-- ======================================================================= -->
 417 <div class="doc_subsection">
 418   <a name="machineinstr">The <tt>MachineInstr</tt> class</a>
 419 </div>
 420
 421 <div class="doc_text">
 422
 423 <p>Target machine instructions are represented as instances of the
 424 <tt>MachineInstr</tt> class.  This class is an extremely abstract way of
 425 representing machine instructions.  In particular, it only keeps track of
 426 an opcode number and a set of operands.</p>
 427
 428 <p>The opcode number is a simple unsigned number that only has meaning to a
 429 specific backend.  All of the instructions for a target should be defined in
 430 the <tt>*InstrInfo.td</tt> file for the target. The opcode enum values
 431 are auto-generated from this description.  The <tt>MachineInstr</tt> class does
 432 not have any information about how to interpret the instruction (i.e., what the
 433 semantics of the instruction are): for that you must refer to the
 434 <tt><a href="#targetinstrinfo">TargetInstrInfo</a></tt> class.</p>
 435
 436 <p>The operands of a machine instruction can be of several different types:
 437 they can be a register reference, constant integer, basic block reference, etc.
 438 In addition, a machine operand should be marked as a def or a use of the value
 439 (though only registers are allowed to be defs).</p>
 440
 441 <p>By convention, the LLVM code generator orders instruction operands so that
 442 all register definitions come before the register uses, even on architectures
 443 that are normally printed in other orders.  For example, the SPARC add
 444 instruction: "<tt>add %i1, %i2, %i3</tt>" adds the "%i1", and "%i2" registers
 445 and stores the result into the "%i3" register.  In the LLVM code generator,
 446 the operands should be stored as "<tt>%i3, %i1, %i2</tt>": with the destination
 447 first.</p>
 448
 449 <p>Keeping destination (definition) operands at the beginning of the operand
 450 list has several advantages.  In particular, the debugging printer will print
 451 the instruction like this:</p>
 452
 453 <pre>
 454   %r3 = add %i1, %i2
 455 </pre>
 456
 457 <p>If the first operand is a def, and it is also easier to <a
 458 href="#buildmi">create instructions</a> whose only def is the first
 459 operand.</p>
 460
 461 </div>
 462
 463 <!-- _______________________________________________________________________ -->
 464 <div class="doc_subsubsection">
 465   <a name="buildmi">Using the <tt>MachineInstrBuilder.h</tt> functions</a>
 466 </div>
 467
 468 <div class="doc_text">
 469
 470 <p>Machine instructions are created by using the <tt>BuildMI</tt> functions,
 471 located in the <tt>include/llvm/CodeGen/MachineInstrBuilder.h</tt> file.  The
 472 <tt>BuildMI</tt> functions make it easy to build arbitrary machine
 473 instructions.  Usage of the <tt>BuildMI</tt> functions look like this:
 474 </p>
 475
 476 <pre>
 477   // Create a 'DestReg = mov 42' (rendered in X86 assembly as 'mov DestReg, 42')
 478   // instruction.  The '1' specifies how many operands will be added.
 479   MachineInstr *MI = BuildMI(X86::MOV32ri, 1, DestReg).addImm(42);
 480
 481   // Create the same instr, but insert it at the end of a basic block.
 482   MachineBasicBlock &amp;MBB = ...
 483   BuildMI(MBB, X86::MOV32ri, 1, DestReg).addImm(42);
 484
 485   // Create the same instr, but insert it before a specified iterator point.
 486   MachineBasicBlock::iterator MBBI = ...
 487   BuildMI(MBB, MBBI, X86::MOV32ri, 1, DestReg).addImm(42);
 488
 489   // Create a 'cmp Reg, 0' instruction, no destination reg.
 490   MI = BuildMI(X86::CMP32ri, 2).addReg(Reg).addImm(0);
 491   // Create an 'sahf' instruction which takes no operands and stores nothing.
 492   MI = BuildMI(X86::SAHF, 0);
 493
 494   // Create a self looping branch instruction.
 495   BuildMI(MBB, X86::JNE, 1).addMBB(&amp;MBB);
 496 </pre>
 497
 498 <p>
 499 The key thing to remember with the <tt>BuildMI</tt> functions is that you have
 500 to specify the number of operands that the machine instruction will take. This
 501 allows for efficient memory allocation.  You also need to specify if operands
 502 default to be uses of values, not definitions.  If you need to add a definition
 503 operand (other than the optional destination register), you must explicitly
 504 mark it as such.
 505 </p>
 506
 507 </div>
 508
 509 <!-- _______________________________________________________________________ -->
 510 <div class="doc_subsubsection">
 511   <a name="fixedregs">Fixed (preassigned) registers</a>
 512 </div>
 513
 514 <div class="doc_text">
 515
 516 <p>One important issue that the code generator needs to be aware of is the
 517 presence of fixed registers.  In particular, there are often places in the
 518 instruction stream where the register allocator <em>must</em> arrange for a
 519 particular value to be in a particular register.  This can occur due to
 520 limitations of the instruction set (e.g., the X86 can only do a 32-bit divide
 521 with the <tt>EAX</tt>/<tt>EDX</tt> registers), or external factors like calling
 522 conventions.  In any case, the instruction selector should emit code that
 523 copies a virtual register into or out of a physical register when needed.</p>
 524
 525 <p>For example, consider this simple LLVM example:</p>
 526
 527 <pre>
 528   int %test(int %X, int %Y) {
 529     %Z = div int %X, %Y
 530     ret int %Z
 531   }
 532 </pre>
 533
 534 <p>The X86 instruction selector produces this machine code for the div
 535 and ret (use
 536 "<tt>llc X.bc -march=x86 -print-machineinstrs</tt>" to get this):</p>
 537
 538 <pre>
 539         ;; Start of div
 540         %EAX = mov %reg1024           ;; Copy X (in reg1024) into EAX
 541         %reg1027 = sar %reg1024, 31
 542         %EDX = mov %reg1027           ;; Sign extend X into EDX
 543         idiv %reg1025                 ;; Divide by Y (in reg1025)
 544         %reg1026 = mov %EAX           ;; Read the result (Z) out of EAX
 545
 546         ;; Start of ret
 547         %EAX = mov %reg1026           ;; 32-bit return value goes in EAX
 548         ret
 549 </pre>
 550
 551 <p>By the end of code generation, the register allocator has coalesced
 552 the registers and deleted the resultant identity moves, producing the
 553 following code:</p>
 554
 555 <pre>
 556         ;; X is in EAX, Y is in ECX
 557         mov %EAX, %EDX
 558         sar %EDX, 31
 559         idiv %ECX
 560         ret
 561 </pre>
 562
 563 <p>This approach is extremely general (if it can handle the X86 architecture,
 564 it can handle anything!) and allows all of the target specific
 565 knowledge about the instruction stream to be isolated in the instruction
 566 selector.  Note that physical registers should have a short lifetime for good
 567 code generation, and all physical registers are assumed dead on entry and
 568 exit of basic blocks (before register allocation).  Thus if you need a value
 569 to be live across basic block boundaries, it <em>must</em> live in a virtual
 570 register.</p>
 571
 572 </div>
 573
 574 <!-- _______________________________________________________________________ -->
 575 <div class="doc_subsubsection">
 576   <a name="ssa">Machine code SSA form</a>
 577 </div>
 578
 579 <div class="doc_text">
 580
 581 <p><tt>MachineInstr</tt>'s are initially selected in SSA-form, and
 582 are maintained in SSA-form until register allocation happens.  For the most
 583 part, this is trivially simple since LLVM is already in SSA form: LLVM PHI nodes
 584 become machine code PHI nodes, and virtual registers are only allowed to have a
 585 single definition.</p>
 586
 587 <p>After register allocation, machine code is no longer in SSA-form, as there
 588 are no virtual registers left in the code.</p>
 589
 590 </div>
 591
 592 <!-- *********************************************************************** -->
 593 <div class="doc_section">
 594   <a name="codegenalgs">Target-independent code generation algorithms</a>
 595 </div>
 596 <!-- *********************************************************************** -->
 597
 598 <div class="doc_text">
 599
 600 <p>This section documents the phases described in the <a
 601 href="high-level-design">high-level design of the code generator</a>.  It
 602 explains how they work and some of the rationale behind their design.</p>
 603
 604 </div>
 605
 606 <!-- ======================================================================= -->
 607 <div class="doc_subsection">
 608   <a name="instselect">Instruction Selection</a>
 609 </div>
 610
 611 <div class="doc_text">
 612 <p>
 613 Instruction Selection is the process of translating LLVM code presented to the
 614 code generator into target-specific machine instructions.  There are several
 615 well-known ways to do this in the literature.  In LLVM there are two main forms:
 616 the old-style 'simple' instruction selector (which effectively peephole selects
 617 each LLVM instruction into a series of machine instructions), and the new
 618 SelectionDAG based instruction selector.
 619 </p>
 620
 621 <p>The 'simple' instruction selectors are tedious to write, require a lot of
 622 boiler plate code, and are difficult to get correct.  Additionally, any
 623 optimizations written for a simple instruction selector cannot be used by other
 624 targets.  For this reason, LLVM is moving to a new SelectionDAG based
 625 instruction selector, which is described in this section.  If you are starting a
 626 new port, we recommend that you write the instruction selector using the
 627 SelectionDAG infrastructure.</p>
 628
 629 <p>In time, most of the target-specific code for instruction selection will be
 630 auto-generated from the target description (<tt>*.td</tt>) files.  For now,
 631 however, the <a href="#selectiondag_select">Select Phase</a> must still be
 632 written by hand.</p>
 633 </div>
 634
 635 <!-- _______________________________________________________________________ -->
 636 <div class="doc_subsubsection">
 637   <a name="selectiondag_intro">Introduction to SelectionDAGs</a>
 638 </div>
 639
 640 <div class="doc_text">
 641
 642 <p>
 643 The SelectionDAG provides an abstraction for code representation in a way that
 644 is amenable to instruction selection using automatic techniques
 645 (e.g. dynamic-programming based optimal pattern matching selectors), It is also
 646 well suited to other phases of code generation; in particular, instruction scheduling.  Additionally, the SelectionDAG provides a host representation where a
 647 large variety of very-low-level (but target-independent)
 648 <a href="#selectiondag_optimize">optimizations</a> may be
 649 performed: ones which require extensive information about the instructions
 650 efficiently supported by the target.
 651 </p>
 652
 653 <p>
 654 The SelectionDAG is a Directed-Acyclic-Graph whose nodes are instances of the
 655 <tt>SDNode</tt> class.  The primary payload of the <tt>SDNode</tt> is its
 656 operation code (Opcode) that indicates what operation the node performs.
 657 The various operation node types are described at the top of the
 658 <tt>include/llvm/CodeGen/SelectionDAGNodes.h</tt> file.  Depending on the
 659 operation, nodes may contain additional information (e.g. the condition code
 660 for a SETCC node) contained in a derived class.</p>
 661
 662 <p>Although most operations define a single value, each node in the graph may
 663 define multiple values.  For example, a combined div/rem operation will define
 664 both the dividend and the remainder. Many other situations require multiple
 665 values as well.  Each node also has some number of operands, which are edges
 666 to the node defining the used value.  Because nodes may define multiple values,
 667 edges are represented by instances of the <tt>SDOperand</tt> class, which is
 668 a &lt;SDNode, unsigned&gt; pair, indicating the node and result
 669 value being used, respectively.  Each value produced by an SDNode has an
 670 associated MVT::ValueType, indicating what type the value is.
 671 </p>
 672
 673 <p>
 674 SelectionDAGs contain two different kinds of values: those that represent data
 675 flow and those that represent control flow dependencies.  Data values are simple
 676 edges with an integer or floating point value type.  Control edges are
 677 represented as "chain" edges which are of type MVT::Other.  These edges provide
 678 an ordering between nodes that have side effects (such as
 679 loads/stores/calls/return/etc).  All nodes that have side effects should take a
 680 token chain as input and produce a new one as output.  By convention, token
 681 chain inputs are always operand #0, and chain results are always the last
 682 value produced by an operation.</p>
 683
 684 <p>
 685 A SelectionDAG has designated "Entry" and "Root" nodes.  The Entry node is
 686 always a marker node with an Opcode of ISD::EntryToken.  The Root node is the
 687 final side-effecting node in the token chain. For example, in a single basic
 688 block function, this would be the return node.
 689 </p>
 690
 691 <p>
 692 One important concept for SelectionDAGs is the notion of a "legal" vs. "illegal"
 693 DAG.  A legal DAG for a target is one that only uses supported operations and
 694 supported types.  On PowerPC, for example, a DAG with any values of i1, i8, i16,
 695 or i64 type would be illegal.  The <a href="#selectiondag_legalize">legalize</a>
 696 phase is responsible for turning an illegal DAG into a legal DAG.
 697 </p>
 698 </div>
 699
 700 <!-- _______________________________________________________________________ -->
 701 <div class="doc_subsubsection">
 702   <a name="selectiondag_process">SelectionDAG Instruction Selection Process</a>
 703 </div>
 704
 705 <div class="doc_text">
 706
 707 <p>
 708 SelectionDAG-based instruction selection consists of the following steps:
 709 </p>
 710
 711 <ol>
 712 <li><a href="#selectiondag_build">Build initial DAG</a> - This stage performs
 713     a simple translation from the input LLVM code to an illegal SelectionDAG.
 714     </li>
 715 <li><a href="#selectiondag_optimize">Optimize SelectionDAG</a> - This stage
 716     performs simple optimizations on the SelectionDAG to simplify it and
 717     recognize meta instructions (like rotates and div/rem pairs) for
 718     targets that support these meta operations.  This makes the resultant code
 719     more efficient and the 'select instructions from DAG' phase (below) simpler.
 720 </li>
 721 <li><a href="#selectiondag_legalize">Legalize SelectionDAG</a> - This stage
 722     converts the illegal SelectionDAG to a legal SelectionDAG, by eliminating
 723     unsupported operations and data types.</li>
 724 <li><a href="#selectiondag_optimize">Optimize SelectionDAG (#2)</a> - This
 725     second run of the SelectionDAG optimized the newly legalized DAG, to
 726     eliminate inefficiencies introduced by legalization.</li>
 727 <li><a href="#selectiondag_select">Select instructions from DAG</a> - Finally,
 728     the target instruction selector matches the DAG operations to target
 729     instructions, emitting them and building the MachineFunction being
 730     compiled.</li>
 731 </ol>
 732
 733 <p>After all of these steps are complete, the SelectionDAG is destroyed and the
 734 rest of the code generation passes are run.</p>
 735
 736 </div>
 737
 738 <!-- _______________________________________________________________________ -->
 739 <div class="doc_subsubsection">
 740   <a name="selectiondag_build">Initial SelectionDAG Construction</a>
 741 </div>
 742
 743 <div class="doc_text">
 744
 745 <p>
 746 The initial SelectionDAG is naively peephole expanded from the LLVM input by
 747 the <tt>SelectionDAGLowering</tt> class in the SelectionDAGISel.cpp file.  The
 748 intent of  this pass is to expose as much low-level, target-specific details
 749 to the SelectionDAG as possible.  This pass is mostly hard-coded (e.g. an LLVM
 750 add turns into an SDNode add while a geteelementptr is expanded into the obvious
 751 arithmetic). This pass requires target-specific hooks to lower calls and
 752 returns, varargs, etc.  For these features, the TargetLowering interface is
 753 used.
 754 </p>
 755
 756 </div>
 757
 758 <!-- _______________________________________________________________________ -->
 759 <div class="doc_subsubsection">
 760   <a name="selectiondag_legalize">SelectionDAG Legalize Phase</a>
 761 </div>
 762
 763 <div class="doc_text">
 764
 765 <p>The Legalize phase is in charge of converting a DAG to only use the types and
 766 operations that are natively supported by the target.  This involves two major
 767 tasks:</p>
 768
 769 <ol>
 770 <li><p>Convert values of unsupported types to values of supported types.</p>
 771     <p>There are two main ways of doing this: promoting a small type to a larger
 772        type (e.g. f32 -&gt; f64, or i16 -&gt; i32), and breaking up large
 773        integer types
 774        to smaller ones (e.g. implementing i64 with i32 operations where
 775        possible).  Type conversions can insert sign and zero extensions as
 776        needed to make sure that the final code has the same behavior as the
 777        input.</p>
 778 </li>
 779
 780 <li><p>Eliminate operations that are not supported by the target in a supported
 781        type.</p>
 782     <p>Targets often have wierd constraints, such as not supporting every
 783        operation on every supported datatype (e.g. X86 does not support byte
 784        conditional moves).  Legalize takes care of either open-coding another
 785        sequence of operations to emulate the operation (this is known as
 786        expansion), promoting to a larger type that supports the operation
 787        (promotion), or using a target-specific hook to implement the
 788        legalization.</p>
 789 </li>
 790 </ol>
 791
 792 <p>
 793 Instead of using a Legalize pass, we could require that every target-specific
 794 <a href="#selectiondag_optimize">selector</a> supports and expands every
 795 operator and type even if they are not supported and may require many
 796 instructions to implement (in fact, this is the approach taken by the
 797 "simple" selectors).  However, using a Legalize pass allows all of the
 798 cannonicalization patterns to be shared across targets which makes it very
 799 easy to optimize the cannonicalized code because it is still in the form of
 800 a DAG.
 801 </p>
 802
 803 </div>
 804
 805 <!-- _______________________________________________________________________ -->
 806 <div class="doc_subsubsection">
 807   <a name="selectiondag_optimize">SelectionDAG Optimization Phase</a>
 808 </div>
 809
 810 <div class="doc_text">
 811
 812 <p>
 813 The SelectionDAG optimization phase is run twice for code generation: once
 814 immediately after the DAG is built and once after legalization.  The first run
 815 of the pass allows the initial code to be cleaned up (e.g. performing
 816 optimizations that depend on knowing that the operators have restricted type
 817 inputs).  The second run of the pass cleans up the messy code generated by the
 818 Legalize pass, allowing Legalize to be very simple since it can ignore many
 819 special cases.
 820 </p>
 821
 822 <p>
 823 One important class of optimizations that this pass will do in the future is
 824 optimizing inserted sign and zero extension instructions.  Here are some good
 825 papers on the subject:</p>
 826
 827 <p>
 828 "<a href="http://www.eecs.harvard.edu/~nr/pubs/widen-abstract.html">Widening
 829 integer arithmetic</a>"<br>
 830 Kevin Redwine and Norman Ramsey<br>
 831 International Conference on Compiler Construction (CC) 2004
 832 </p>
 833
 834
 835 <p>
 836  "<a href="http://portal.acm.org/citation.cfm?doid=512529.512552">Effective
 837  sign extension elimination</a>"<br>
 838  Motohiro Kawahito, Hideaki Komatsu, and Toshio Nakatani<br>
 839  Proceedings of the ACM SIGPLAN 2002 Conference on Programming Language Design
 840  and Implementation.
 841 </p>
 842
 843 </div>
 844
 845 <!-- _______________________________________________________________________ -->
 846 <div class="doc_subsubsection">
 847   <a name="selectiondag_select">SelectionDAG Select Phase</a>
 848 </div>
 849
 850 <div class="doc_text">
 851
 852 <p>The Select phase is the bulk of the target-specific code for instruction
 853 selection.  This phase takes a legal SelectionDAG as input, and does simple
 854 pattern matching on the DAG to generate code.  In time, the Select phase will
 855 be automatically generated from the target's InstrInfo.td file, which is why we
 856 want to make the Select phase as simple and mechanical as possible.</p>
 857
 858 </div>
 859
 860 <!-- _______________________________________________________________________ -->
 861 <div class="doc_subsubsection">
 862   <a name="selectiondag_future">Future directions for the SelectionDAG</a>
 863 </div>
 864
 865 <div class="doc_text">
 866
 867 <ol>
 868 <li>Optional whole-function selection.</li>
 869 <li>Select is a graph translation phase.</li>
 870 <li>Place the machine instructions resulting from Select according to register
 871 pressure or a schedule.</li>
 872 <li>DAG Scheduling.</li>
 873 <li>Auto-generate the Select phase from the target description (*.td) files.
 874 </li>
 875 </ol>
 876
 877 </div>
 878
 879 <!-- ======================================================================= -->
 880 <div class="doc_subsection">
 881   <a name="ssamco">SSA-based Machine Code Optimizations</a>
 882 </div>
 883 <div class="doc_text"><p>To Be Written</p></div>
 884 <!-- ======================================================================= -->
 885 <div class="doc_subsection">
 886   <a name="regalloc">Register Allocation</a>
 887 </div>
 888 <div class="doc_text"><p>To Be Written</p></div>
 889 <!-- ======================================================================= -->
 890 <div class="doc_subsection">
 891   <a name="proepicode">Prolog/Epilog Code Insertion</a>
 892 </div>
 893 <div class="doc_text"><p>To Be Written</p></div>
 894 <!-- ======================================================================= -->
 895 <div class="doc_subsection">
 896   <a name="latemco">Late Machine Code Optimizations</a>
 897 </div>
 898 <div class="doc_text"><p>To Be Written</p></div>
 899 <!-- ======================================================================= -->
 900 <div class="doc_subsection">
 901   <a name="codemission">Code Emission</a>
 902 </div>
 903
 904 <!-- *********************************************************************** -->
 905 <div class="doc_section">
 906   <a name="targetimpls">Target description implementations</a>
 907 </div>
 908 <!-- *********************************************************************** -->
 909
 910 <div class="doc_text">
 911
 912 <p>This section of the document explains features or design decisions that
 913 are specific to the code generator for a particular target.</p>
 914
 915 </div>
 916
 917
 918 <!-- ======================================================================= -->
 919 <div class="doc_subsection">
 920   <a name="x86">The X86 backend</a>
 921 </div>
 922
 923 <div class="doc_text">
 924
 925 <p>
 926 The X86 code generator lives in the <tt>lib/Target/X86</tt> directory.  This
 927 code generator currently targets a generic P6-like processor.  As such, it
 928 produces a few P6-and-above instructions (like conditional moves), but it does
 929 not make use of newer features like MMX or SSE.  In the future, the X86 backend
 930 will have sub-target support added for specific processor families and
 931 implementations.</p>
 932
 933 </div>
 934
 935 <!-- _______________________________________________________________________ -->
 936 <div class="doc_subsubsection">
 937   <a name="x86_tt">X86 Target Triples Supported</a>
 938 </div>
 939
 940 <div class="doc_text">
 941 <p>
 942 The following are the known target triples that are supported by the X86
 943 backend.  This is not an exhaustive list, but it would be useful to add those
 944 that people test.
 945 </p>
 946
 947 <ul>
 948 <li><b>i686-pc-linux-gnu</b> - Linux</li>
 949 <li><b>i386-unknown-freebsd5.3</b> - FreeBSD 5.3</li>
 950 <li><b>i686-pc-cygwin</b> - Cygwin on Win32</li>
 951 <li><b>i686-pc-mingw32</b> - MingW on Win32</li>
 952 <li><b>i686-apple-darwin*</b> - Apple Darwin</li>
 953 </ul>
 954
 955 </div>
 956
 957 <!-- _______________________________________________________________________ -->
 958 <div class="doc_subsubsection">
 959   <a name="x86_memory">Representing X86 addressing modes in MachineInstrs</a>
 960 </div>
 961
 962 <div class="doc_text">
 963
 964 <p>The x86 has a very flexible way of accessing memory.  It is capable of
 965 forming memory addresses of the following expression directly in integer
 966 instructions (which use ModR/M addressing):</p>
 967
 968 <pre>
 969    Base+[1,2,4,8]*IndexReg+Disp32
 970 </pre>
 971
 972 <p>In order to represent this, LLVM tracks no less than 4 operands for each
 973 memory operand of this form.  This means that the "load" form of 'mov' has the
 974 following <tt>MachineOperand</tt>s in this order:</p>
 975
 976 <pre>
 977 Index:        0     |    1        2       3           4
 978 Meaning:   DestReg, | BaseReg,  Scale, IndexReg, Displacement
 979 OperandTy: VirtReg, | VirtReg, UnsImm, VirtReg,   SignExtImm
 980 </pre>
 981
 982 <p>Stores, and all other instructions, treat the four memory operands in the
 983 same way, in the same order.</p>
 984
 985 </div>
 986
 987 <!-- _______________________________________________________________________ -->
 988 <div class="doc_subsubsection">
 989   <a name="x86_names">Instruction naming</a>
 990 </div>
 991
 992 <div class="doc_text">
 993
 994 <p>
 995 An instruction name consists of the base name, a default operand size, and a
 996 a character per operand with an optional special size. For example:</p>
 997
 998 <p>
 999 <tt>ADD8rr</tt> -&gt; add, 8-bit register, 8-bit register<br>
1000 <tt>IMUL16rmi</tt> -&gt; imul, 16-bit register, 16-bit memory, 16-bit immediate<br>
1001 <tt>IMUL16rmi8</tt> -&gt; imul, 16-bit register, 16-bit memory, 8-bit immediate<br>
1002 <tt>MOVSX32rm16</tt> -&gt; movsx, 32-bit register, 16-bit memory
1003 </p>
1004
1005 </div>
1006
1007 <!-- *********************************************************************** -->
1008 <hr>
1009 <address>
1010   <a href="http://jigsaw.w3.org/css-validator/check/referer"><img
1011   src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!"></a>
1012   <a href="http://validator.w3.org/check/referer"><img
1013   src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" /></a>
1014
1015   <a href="mailto:sabre@nondot.org">Chris Lattner</a><br>
1016   <a href="http://llvm.cs.uiuc.edu">The LLVM Compiler Infrastructure</a><br>
1017   Last modified: $Date$
1018 </address>
1019
1020 </body>
1021 </html>