MachineCycleAnalysis.h

Go to the documentation of this file.

//===- MachineCycleAnalysis.h - Cycle Info for Machine IR -------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
//
// This file defines the MachineCycleInfo class, which is a thin wrapper over
// the Machine IR instance of GenericCycleInfo.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CODEGEN_MACHINECYCLEANALYSIS_H
#define LLVM_CODEGEN_MACHINECYCLEANALYSIS_H
 
#include "llvm/ADT/GenericCycleInfo.h"
#include "llvm/CodeGen/MachineFunctionPass.h"
#include "llvm/CodeGen/MachinePassManager.h"
#include "llvm/CodeGen/MachineSSAContext.h"
#include "llvm/Support/Compiler.h"
 
namespace llvm {
 
class MachineCycleInfo : public GenericCycleInfo<MachineSSAContext> {
public:
  /// Handle invalidation explicitly.
  LLVM_ABI bool invalidate(MachineFunction &MF, const PreservedAnalyses &PA,
                           MachineFunctionAnalysisManager::Invalidator &);
};
 
/// Legacy analysis pass which computes a \ref MachineCycleInfo.
class LLVM_ABI MachineCycleInfoWrapperPass : public MachineFunctionPass {
  MachineFunction *F = nullptr;
  MachineCycleInfo CI;
 
public:
  static char ID;
 
  MachineCycleInfoWrapperPass();
 
  MachineCycleInfo &getCycleInfo() { return CI; }
  const MachineCycleInfo &getCycleInfo() const { return CI; }
 
  bool runOnMachineFunction(MachineFunction &F) override;
  void getAnalysisUsage(AnalysisUsage &AU) const override;
  void releaseMemory() override;
  void print(raw_ostream &OS, const Module *M = nullptr) const override;
};
 
// TODO: add this function to the GenericCycleInfo template after implementing
//       the IR version.
LLVM_ABI bool isCycleInvariant(const MachineCycleInfo &CI, CycleRef Cycle,
                               MachineInstr &I);
 
class MachineCycleAnalysis : public AnalysisInfoMixin<MachineCycleAnalysis> {
  friend AnalysisInfoMixin<MachineCycleAnalysis>;
  LLVM_ABI static AnalysisKey Key;
 
public:
  using Result = MachineCycleInfo;
 
  LLVM_ABI Result run(MachineFunction &MF,
                      MachineFunctionAnalysisManager &MFAM);
};
 
class MachineCycleInfoPrinterPass
    : public RequiredPassInfoMixin<MachineCycleInfoPrinterPass> {
  raw_ostream &OS;
 
public:
  explicit MachineCycleInfoPrinterPass(raw_ostream &OS) : OS(OS) {}
  LLVM_ABI PreservedAnalyses run(MachineFunction &MF,
                                 MachineFunctionAnalysisManager &MFAM);
};
 
} // end namespace llvm
 
#endif // LLVM_CODEGEN_MACHINECYCLEANALYSIS_H