MachineBasicBlock.cpp revision 1ccc4684f3413d1f176a2c7a867545ce03b6414c
1aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//===-- llvm/CodeGen/MachineBasicBlock.cpp ----------------------*- C++ -*-===//
2aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//
3aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//                     The LLVM Compiler Infrastructure
4aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//
5aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos// This file was developed by the LLVM research group and is distributed under
6aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos// the University of Illinois Open Source License. See LICENSE.TXT for details.
7aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//
8aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//===----------------------------------------------------------------------===//
9aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//
10aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos// Collect the sequence of machine instructions for a basic block.
11aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//
12aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos//===----------------------------------------------------------------------===//
13aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
14aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos#include "llvm/CodeGen/MachineBasicBlock.h"
15aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos#include "llvm/BasicBlock.h"
16aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos#include "llvm/CodeGen/MachineFunction.h"
17aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos#include "llvm/CodeGen/MachineInstr.h"
1807000c6f01d8f57170f2d4c77a86d934bdc5c696Owen Anderson#include "llvm/Target/TargetData.h"
19743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos#include "llvm/Target/TargetInstrInfo.h"
20743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos#include "llvm/Target/TargetMachine.h"
21551ccae044b0ff658fe629dd67edd5ffe75d10e8Reid Spencer#include "llvm/Support/LeakDetector.h"
22954da37bb492b519f5c31dc360f2a142567e08b4Reid Spencer#include <iostream>
2352c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner#include <algorithm>
24aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenosusing namespace llvm;
25aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
2617fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya LattnerMachineBasicBlock::~MachineBasicBlock() {
2717fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner  LeakDetector::removeGarbageObject(this);
2817fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner}
2917fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner
301ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattnerstd::ostream& llvm::operator<<(std::ostream &OS, const MachineBasicBlock &MBB) {
311ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattner  MBB.print(OS);
321ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattner  return OS;
331ccc4684f3413d1f176a2c7a867545ce03b6414cChris Lattner}
3417fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner
35a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos// MBBs start out as #-1. When a MBB is added to a MachineFunction, it
360bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke// gets the next available unique MBB number. If it is removed from a
370bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke// MachineFunction, it goes back to being #-1.
38ca48eb9f5175058a55c1818cb1d5d06052f0092dChris Lattnervoid ilist_traits<MachineBasicBlock>::addNodeToList(MachineBasicBlock* N) {
39792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner  assert(N->Parent == 0 && "machine instruction already in a basic block");
4017fb34bf8cd10a798c9206eeef3bff151b4d3688Tanya Lattner  N->Parent = Parent;
41ca48eb9f5175058a55c1818cb1d5d06052f0092dChris Lattner  N->Number = Parent->addToMBBNumbering(N);
42792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner  LeakDetector::removeGarbageObject(N);
430bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke}
440bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke
45ca48eb9f5175058a55c1818cb1d5d06052f0092dChris Lattnervoid ilist_traits<MachineBasicBlock>::removeNodeFromList(MachineBasicBlock* N) {
46792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner  assert(N->Parent != 0 && "machine instruction not in a basic block");
47ca48eb9f5175058a55c1818cb1d5d06052f0092dChris Lattner  N->Parent->removeFromMBBNumbering(N->Number);
480bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke  N->Number = -1;
49ca48eb9f5175058a55c1818cb1d5d06052f0092dChris Lattner  N->Parent = 0;
50792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner  LeakDetector::addGarbageObject(N);
510bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke}
520bcb1ad7be8515492ba02f64c0e43113ecdf8e32Brian Gaeke
535e61fa95196b85281eec655787e9c73267532bd1Chris Lattner
54bca81448ac8e19c588c9a4ad16fc70732b76327cChris LattnerMachineInstr* ilist_traits<MachineInstr>::createSentinel() {
558b915b4ed2c6e43413937ac71c0cbcf476ad1a98Chris Lattner  MachineInstr* dummy = new MachineInstr(0, 0);
56a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  LeakDetector::removeGarbageObject(dummy);
57a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  return dummy;
58aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos}
59aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
6052c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid ilist_traits<MachineInstr>::addNodeToList(MachineInstr* N) {
61a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  assert(N->parent == 0 && "machine instruction already in a basic block");
62a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  N->parent = parent;
63a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  LeakDetector::removeGarbageObject(N);
64aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos}
65aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
6652c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid ilist_traits<MachineInstr>::removeNodeFromList(MachineInstr* N) {
67a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  assert(N->parent != 0 && "machine instruction not in a basic block");
68a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  N->parent = 0;
69a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  LeakDetector::addGarbageObject(N);
70aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos}
71aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
72aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenosvoid ilist_traits<MachineInstr>::transferNodesFromList(
735504602836de40f07ac390a836161e45389870c2Chris Lattner  iplist<MachineInstr, ilist_traits<MachineInstr> >& fromList,
74a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  ilist_iterator<MachineInstr> first,
7552c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  ilist_iterator<MachineInstr> last) {
765504602836de40f07ac390a836161e45389870c2Chris Lattner  if (parent != fromList.parent)
77a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos    for (; first != last; ++first)
785504602836de40f07ac390a836161e45389870c2Chris Lattner      first->parent = parent;
79aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos}
80aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
8152c09d76564d6fb24444c4d56bc8978e042e72f9Chris LattnerMachineBasicBlock::iterator MachineBasicBlock::getFirstTerminator() {
829bcdcd17c7219dbc68de2f11ca2de86471c8c390Chris Lattner  const TargetInstrInfo& TII = *getParent()->getTarget().getInstrInfo();
83743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos  iterator I = end();
84743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos  while (I != begin() && TII.isTerminatorInstr((--I)->getOpcode()));
85743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos  if (I != end() && !TII.isTerminatorInstr(I->getOpcode())) ++I;
86743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos  return I;
87743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos}
88743d0a1f831f1d5a3141a6ca730558f40c35690aAlkis Evlogimenos
8952c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::dump() const {
90a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  print(std::cerr);
91aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos}
92aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos
9352c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::print(std::ostream &OS) const {
94792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner  if(!getParent()) {
9552c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner    OS << "Can't print out MachineBasicBlock because parent MachineFunction"
9652c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner       << " is null\n";
97792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner    return;
98792699c46ef9bfc47dd459bbfa7e71bcb2cee29aTanya Lattner  }
99a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos
100a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  const BasicBlock *LBB = getBasicBlock();
101db3ea6754bc314cb0ba5b4c2ae534b3b33633cf1Chris Lattner  OS << "\n";
102db3ea6754bc314cb0ba5b4c2ae534b3b33633cf1Chris Lattner  if (LBB) OS << LBB->getName();
103db3ea6754bc314cb0ba5b4c2ae534b3b33633cf1Chris Lattner  OS << " (" << (const void*)this
104db3ea6754bc314cb0ba5b4c2ae534b3b33633cf1Chris Lattner     << ", LLVM BB @" << (const void*) LBB << ", ID#" << getNumber()<< "):\n";
105681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner  // Print the preds of this block according to the CFG.
106681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner  if (!pred_empty()) {
107681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner    OS << "    Predecessors according to CFG:";
108681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner    for (const_pred_iterator PI = pred_begin(), E = pred_end(); PI != E; ++PI)
109681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner      OS << " " << *PI;
110681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner    OS << "\n";
111681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner  }
112681764b20c3418b4af783a84eb2a68145d69a9d7Chris Lattner
113a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  for (const_iterator I = begin(); I != end(); ++I) {
114a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos    OS << "\t";
115a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos    I->print(OS, &getParent()->getTarget());
116a63828619feaeee7a7468ab00c50c3d678afae55Alkis Evlogimenos  }
117380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner
118380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner  // Print the successors of this block according to the CFG.
119380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner  if (!succ_empty()) {
120380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner    OS << "    Successors according to CFG:";
121380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner    for (const_succ_iterator SI = succ_begin(), E = succ_end(); SI != E; ++SI)
122380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner      OS << " " << *SI;
123380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner    OS << "\n";
124380ae495996c84f348d12224ea9f4514f6471f59Chris Lattner  }
125aad5c0505183a5b7913f1a443a1f0650122551ccAlkis Evlogimenos}
12652c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner
127c585a3f62adb2e491d792115af637ef75bdf489eChris Lattnervoid MachineBasicBlock::moveBefore(MachineBasicBlock *NewAfter) {
128c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner  MachineFunction::BasicBlockListType &BBList =getParent()->getBasicBlockList();
129c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner  getParent()->getBasicBlockList().splice(NewAfter, BBList, this);
130c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner}
131c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner
132c585a3f62adb2e491d792115af637ef75bdf489eChris Lattnervoid MachineBasicBlock::moveAfter(MachineBasicBlock *NewBefore) {
133c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner  MachineFunction::BasicBlockListType &BBList =getParent()->getBasicBlockList();
134c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner  MachineFunction::iterator BBI = NewBefore;
135c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner  getParent()->getBasicBlockList().splice(++BBI, BBList, this);
136c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner}
137c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner
138c585a3f62adb2e491d792115af637ef75bdf489eChris Lattner
13952c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::addSuccessor(MachineBasicBlock *succ) {
14052c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  Successors.push_back(succ);
14152c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  succ->addPredecessor(this);
14252c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner}
14352c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner
14452c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::removeSuccessor(MachineBasicBlock *succ) {
14552c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  succ->removePredecessor(this);
14652c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  succ_iterator I = std::find(Successors.begin(), Successors.end(), succ);
14752c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  assert(I != Successors.end() && "Not a current successor!");
14852c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  Successors.erase(I);
14952c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner}
15052c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner
15152c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::removeSuccessor(succ_iterator I) {
15252c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  assert(I != Successors.end() && "Not a current successor!");
15352c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  (*I)->removePredecessor(this);
15452c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  Successors.erase(I);
15552c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner}
15652c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner
15752c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::addPredecessor(MachineBasicBlock *pred) {
15852c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  Predecessors.push_back(pred);
15952c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner}
16052c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner
16152c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattnervoid MachineBasicBlock::removePredecessor(MachineBasicBlock *pred) {
162edf128a7fa90f2b0b7ee24741a04a7ae1ecd6f7eMisha Brukman  std::vector<MachineBasicBlock *>::iterator I =
16352c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner    std::find(Predecessors.begin(), Predecessors.end(), pred);
16452c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  assert(I != Predecessors.end() && "Pred is not a predecessor of this block!");
16552c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner  Predecessors.erase(I);
16652c09d76564d6fb24444c4d56bc8978e042e72f9Chris Lattner}
167