xref: /freebsd/contrib/llvm-project/llvm/include/llvm/Transforms/Scalar/SROA.h (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad)
1 //===- SROA.h - Scalar Replacement Of Aggregates ----------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 /// \file
9 /// This file provides the interface for LLVM's Scalar Replacement of
10 /// Aggregates pass. This pass provides both aggregate splitting and the
11 /// primary SSA formation used in the compiler.
12 ///
13 //===----------------------------------------------------------------------===//
14 
15 #ifndef LLVM_TRANSFORMS_SCALAR_SROA_H
16 #define LLVM_TRANSFORMS_SCALAR_SROA_H
17 
18 #include "llvm/IR/PassManager.h"
19 
20 namespace llvm {
21 
22 class Function;
23 
24 enum class SROAOptions : bool { ModifyCFG, PreserveCFG };
25 
26 class SROAPass : public PassInfoMixin<SROAPass> {
27   const SROAOptions PreserveCFG;
28 
29 public:
30   /// If \p PreserveCFG is set, then the pass is not allowed to modify CFG
31   /// in any way, even if it would update CFG analyses.
32   SROAPass(SROAOptions PreserveCFG);
33 
34   /// Run the pass over the function.
35   PreservedAnalyses run(Function &F, FunctionAnalysisManager &AM);
36 
37   void printPipeline(raw_ostream &OS,
38                      function_ref<StringRef(StringRef)> MapClassName2PassName);
39 };
40 
41 } // end namespace llvm
42 
43 #endif // LLVM_TRANSFORMS_SCALAR_SROA_H
44