//===--- StackMapLivenessAnalysis - StackMap Liveness Analysis --*- C++ -*-===//
//
//                     The LLVM Compiler Infrastructure
//
// This file is distributed under the University of Illinois Open Source
// License. See LICENSE.TXT for details.
//
//===----------------------------------------------------------------------===//
//
// This pass calculates the liveness for each basic block in a function and
// attaches the register live-out information to a stackmap or patchpoint
// intrinsic if present.
//
//===----------------------------------------------------------------------===//

#ifndef LLVM_CODEGEN_STACKMAP_LIVENESS_ANALYSIS_H
#define LLVM_CODEGEN_STACKMAP_LIVENESS_ANALYSIS_H

#include "llvm/CodeGen/LivePhysRegs.h"
#include "llvm/CodeGen/MachineFunctionPass.h"


namespace llvm {

/// \brief This pass calculates the liveness information for each basic block in
/// a function and attaches the register live-out information to a stackmap or
/// patchpoint intrinsic if present.
///
/// This is an optional pass that has to be explicitely enabled via the
/// -enable-stackmap-liveness flag. The pass skips functions that don't have any
/// stackmap or patchpoint intrinsics. The information provided by this pass is
/// optional and not required by the aformentioned intrinsics to function.
class StackMapLiveness : public MachineFunctionPass {
  MachineFunction *MF;
  const TargetRegisterInfo *TRI;
  LivePhysRegs LiveRegs;
public:
  static char ID;

  /// \brief Default construct and initialize the pass.
  StackMapLiveness();

  /// \brief Tell the pass manager which passes we depend on and what
  /// information we preserve.
  virtual void getAnalysisUsage(AnalysisUsage &AU) const;

  /// \brief Calculate the liveness information for the given machine function.
  virtual bool runOnMachineFunction(MachineFunction &MF);

private:
  /// \brief Performs the actual liveness calculation for the function.
  bool calculateLiveness();

  /// \brief Add the current register live set to the instruction.
  void addLiveOutSetToMI(MachineInstr &MI);

  /// \brief Create a register mask and initialize it with the registers from
  /// the register live set.
  uint32_t *createRegisterMask() const;

  /// \brief Print the current register live set for debugging.
  void printLiveOutSet(raw_ostream &OS) const;
};

} // end llvm namespace

#endif // end LLVM_CODEGEN_STACKMAP_LIVENESS_ANALYSIS_H