include/llvm/Transforms/IPO/AlwaysInliner.h

   1 //===-- AlwaysInliner.h - Pass to inline "always_inline" functions --------===//
   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 ///
   9 /// \file
  10 /// Provides passes to inlining "always_inline" functions.
  11 ///
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_TRANSFORMS_IPO_ALWAYSINLINER_H
  15 #define LLVM_TRANSFORMS_IPO_ALWAYSINLINER_H
  16
  17 #include "llvm/IR/PassManager.h"
  18
  19 namespace llvm {
  20
  21 /// Inlines functions marked as "always_inline".
  22 ///
  23 /// Note that this does not inline call sites marked as always_inline and does
  24 /// not delete the functions even when all users are inlined. The normal
  25 /// inliner should be used to handle call site inlining, this pass's goal is to
  26 /// be the simplest possible pass to remove always_inline function definitions'
  27 /// uses by inlining them. The \c GlobalDCE pass can be used to remove these
  28 /// functions once all users are gone.
  29 class AlwaysInlinerPass : public PassInfoMixin<AlwaysInlinerPass> {
  30   bool InsertLifetime;
  31
  32 public:
  33   AlwaysInlinerPass(bool InsertLifetime = true)
  34       : InsertLifetime(InsertLifetime) {}
  35
  36   PreservedAnalyses run(Module &M, ModuleAnalysisManager &);
  37 };
  38
  39 /// Create a legacy pass manager instance of a pass to inline and remove
  40 /// functions marked as "always_inline".
  41 Pass *createAlwaysInlinerLegacyPass(bool InsertLifetime = true);
  42
  43 }
  44
  45 #endif // LLVM_TRANSFORMS_IPO_ALWAYSINLINER_H