LLVMBasedAliasAnalysis.h

/******************************************************************************
 * Copyright (c) 2019 Philipp Schubert.
 * All rights reserved. This program and the accompanying materials are made
 * available under the terms of LICENSE.txt.
 *
 * Contributors:
 *     Philipp Schubert and others
 *****************************************************************************/

#ifndef PHASAR_PHASARLLVM_POINTER_LLVMBASEDALIASANALYSIS_H_
#define PHASAR_PHASARLLVM_POINTER_LLVMBASEDALIASANALYSIS_H_

#include "llvm/ADT/DenseMap.h"
#include "llvm/Support/raw_ostream.h"

#include <memory>

namespace llvm {
class Value;
class Function;
class Instruction;
class AAResults;
} // namespace llvm

namespace psr {

class LLVMProjectIRDB;

class LLVMBasedAliasAnalysis {
public:
  LLVMBasedAliasAnalysis(LLVMProjectIRDB &IRDB, bool UseLazyEvaluation = true);

  LLVMBasedAliasAnalysis(LLVMBasedAliasAnalysis &&) noexcept = default;
  LLVMBasedAliasAnalysis &
  operator=(LLVMBasedAliasAnalysis &&) noexcept = default;

  LLVMBasedAliasAnalysis(const LLVMBasedAliasAnalysis &) = delete;
  LLVMBasedAliasAnalysis &operator=(const LLVMBasedAliasAnalysis &) = delete;

  ~LLVMBasedAliasAnalysis();

  [[nodiscard]] inline llvm::AAResults *getAAResults(llvm::Function *F) {
    if (!hasAliasInfo(*F)) {
      computeAliasInfo(*F);
    }
    return AAInfos.lookup(F);
  };

  void erase(llvm::Function *F) noexcept;

  void clear() noexcept;

private:
  [[nodiscard]] bool hasAliasInfo(const llvm::Function &Fun) const;

  void computeAliasInfo(llvm::Function &Fun);

  // -- data members

  struct Impl;
  std::unique_ptr<Impl> PImpl;
  llvm::DenseMap<const llvm::Function *, llvm::AAResults *> AAInfos;
};

} // namespace psr

#endif