blob: c7276eb905df1f9d9ede468926d097d6f84ab568 [file] [log] [blame]
/*
* Copyright (C) 2014 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ART_COMPILER_DEX_PASS_ME_H_
#define ART_COMPILER_DEX_PASS_ME_H_
#include <string>
#include "pass.h"
namespace art {
// Forward declarations.
struct BasicBlock;
struct CompilationUnit;
class Pass;
/**
* @brief OptimizationFlag is an enumeration to perform certain tasks for a given pass.
* @details Each enum should be a power of 2 to be correctly used.
*/
enum OptimizationFlag {
kOptimizationBasicBlockChange = 1, /**< @brief Has there been a change to a BasicBlock? */
kOptimizationDefUsesChange = 2, /**< @brief Has there been a change to a def-use? */
kLoopStructureChange = 4, /**< @brief Has there been a loop structural change? */
};
// Data holder class.
class PassMEDataHolder: public PassDataHolder {
public:
CompilationUnit* c_unit;
BasicBlock* bb;
void* data;
};
enum DataFlowAnalysisMode {
kAllNodes = 0, /**< @brief All nodes. */
kPreOrderDFSTraversal, /**< @brief Depth-First-Search / Pre-Order. */
kRepeatingPreOrderDFSTraversal, /**< @brief Depth-First-Search / Repeating Pre-Order. */
kReversePostOrderDFSTraversal, /**< @brief Depth-First-Search / Reverse Post-Order. */
kRepeatingPostOrderDFSTraversal, /**< @brief Depth-First-Search / Repeating Post-Order. */
kRepeatingReversePostOrderDFSTraversal, /**< @brief Depth-First-Search / Repeating Reverse Post-Order. */
kPostOrderDOMTraversal, /**< @brief Dominator tree / Post-Order. */
kTopologicalSortTraversal, /**< @brief Topological Order traversal. */
kRepeatingTopologicalSortTraversal, /**< @brief Repeating Topological Order traversal. */
kLoopRepeatingTopologicalSortTraversal, /**< @brief Loop-repeating Topological Order traversal. */
kNoNodes, /**< @brief Skip BasicBlock traversal. */
};
/**
* @class Pass
* @brief Pass is the Pass structure for the optimizations.
* @details The following structure has the different optimization passes that we are going to do.
*/
class PassME: public Pass {
public:
explicit PassME(const char* name, DataFlowAnalysisMode type = kAllNodes,
unsigned int flags = 0u, const char* dump = "")
: Pass(name), traversal_type_(type), flags_(flags), dump_cfg_folder_(dump) {
}
PassME(const char* name, DataFlowAnalysisMode type, const char* dump)
: Pass(name), traversal_type_(type), flags_(0), dump_cfg_folder_(dump) {
}
PassME(const char* name, const char* dump)
: Pass(name), traversal_type_(kAllNodes), flags_(0), dump_cfg_folder_(dump) {
}
~PassME() {
}
virtual DataFlowAnalysisMode GetTraversal() const {
return traversal_type_;
}
const char* GetDumpCFGFolder() const {
return dump_cfg_folder_;
}
bool GetFlag(OptimizationFlag flag) const {
return (flags_ & flag);
}
protected:
/** @brief Type of traversal: determines the order to execute the pass on the BasicBlocks. */
const DataFlowAnalysisMode traversal_type_;
/** @brief Flags for additional directives: used to determine if a particular post-optimization pass is necessary. */
const unsigned int flags_;
/** @brief CFG Dump Folder: what sub-folder to use for dumping the CFGs post pass. */
const char* const dump_cfg_folder_;
};
} // namespace art
#endif // ART_COMPILER_DEX_PASS_ME_H_