PointerFlow.h

Go to the documentation of this file.

//===- PointerFlow.h --------------------------------------------*- 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 per-translation-unit summary type for the
//  pointer-flow analysis, which records static pointer assignment sites
//  as directed graph edges (EdgeSet).
//
//===----------------------------------------------------------------------===//
#ifndef LLVM_CLANG_SCALABLESTATICANALYSISFRAMEWORK_ANALYSES_POINTERFLOW_POINTERFLOW_H
#define LLVM_CLANG_SCALABLESTATICANALYSISFRAMEWORK_ANALYSES_POINTERFLOW_POINTERFLOW_H
 
#include "clang/ScalableStaticAnalysisFramework/Analyses/EntityPointerLevel/EntityPointerLevel.h"
#include "clang/ScalableStaticAnalysisFramework/Core/TUSummary/EntitySummary.h"
 
namespace clang::ssaf {
 
/// Maps each LHS pointer (source / assignee) to the set of RHS pointers
/// (destinations / assigned values) at static assignment sites.
using EdgeSet = std::map<EntityPointerLevel, EntityPointerLevelSet>;
 
class PointerFlowEntitySummary final : public EntitySummary {
  EdgeSet Edges;
 
  friend PointerFlowEntitySummary buildPointerFlowEntitySummary(EdgeSet Edges);
  friend llvm::iterator_range<EdgeSet::const_iterator>
  getEdges(const PointerFlowEntitySummary &);
 
  explicit PointerFlowEntitySummary(EdgeSet Edges) : Edges(std::move(Edges)) {}
 
public:
  static constexpr llvm::StringLiteral Name = "PointerFlow";
 
  SummaryName getSummaryName() const override { return summaryName(); }
 
  bool operator==(const EdgeSet &Other) const { return Edges == Other; }
 
  bool operator==(const PointerFlowEntitySummary &Other) const {
    return Edges == Other.Edges;
  }
 
  bool empty() const { return Edges.empty(); }
 
  static SummaryName summaryName() { return SummaryName{Name.str()}; }
};
} // namespace clang::ssaf
 
#endif // LLVM_CLANG_SCALABLESTATICANALYSISFRAMEWORK_ANALYSES_POINTERFLOW_POINTERFLOW_H