blob: 0752aa368dede3e677b6591a74997307bcd8d5a0 [file] [log] [blame]
//===- Utils.h - Utility functions for code generation ----------*- C++ -*-===//
//
// The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This file contains utility functions for the code generation.
//===----------------------------------------------------------------------===//
#ifndef POLLY_CODEGEN_UTILS_H
#define POLLY_CODEGEN_UTILS_H
namespace llvm {
class Pass;
class Value;
class BasicBlock;
}
namespace polly {
class Scop;
/// @brief Execute a Scop conditionally wrt @p RTC.
///
/// In the CFG the optimized code of the Scop is generated next to the
/// original code. Both the new and the original version of the code remain
/// in the CFG. A branch statement decides which version is executed based on
/// the runtime value of @p RTC.
///
/// Before transformation:
///
/// bb0
/// |
/// orig_scop
/// |
/// bb1
///
/// After transformation:
/// bb0
/// |
/// polly.splitBlock
/// / \.
/// | startBlock
/// | |
/// orig_scop new_scop
/// \ /
/// \ /
/// bb1 (joinBlock)
///
/// @param S The Scop to execute conditionally.
/// @param P A reference to the pass calling this function.
/// @param RTC The runtime condition checked before executing the new SCoP.
///
/// @return The 'StartBlock' to which new code can be added.
llvm::BasicBlock *executeScopConditionally(Scop &S, llvm::Pass *P,
llvm::Value *RTC);
}
#endif