LUSummary.h

Go to the documentation of this file.

//===- LUSummary.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 LUSummary class, which represents a link unit summary
// containing merged and deduplicated entity summaries from multiple TUs.
//
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_CLANG_SCALABLESTATICANALYSISFRAMEWORK_CORE_ENTITYLINKER_LUSUMMARY_H
#define LLVM_CLANG_SCALABLESTATICANALYSISFRAMEWORK_CORE_ENTITYLINKER_LUSUMMARY_H
 
#include "clang/ScalableStaticAnalysisFramework/Core/Model/BuildNamespace.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/EntityId.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/EntityIdTable.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/EntityLinkage.h"
#include "clang/ScalableStaticAnalysisFramework/Core/Model/SummaryName.h"
#include "clang/ScalableStaticAnalysisFramework/Core/TUSummary/EntitySummary.h"
#include <map>
#include <memory>
 
namespace clang::ssaf {
 
/// Represents a link unit (LU) summary containing merged entity summaries.
///
/// LUSummary is the result of linking multiple translation unit summaries
/// together. It contains deduplicated entities with their linkage information
/// and the merged entity summaries.
class LUSummary {
  friend class LUSummaryConsumer;
  friend class SerializationFormat;
  friend class TestFixture;
 
  NestedBuildNamespace LUNamespace;
 
  EntityIdTable IdTable;
 
  std::map<EntityId, EntityLinkage> LinkageTable;
 
  std::map<SummaryName, std::map<EntityId, std::unique_ptr<EntitySummary>>>
      Data;
 
public:
  explicit LUSummary(NestedBuildNamespace LUNamespace)
      : LUNamespace(std::move(LUNamespace)) {}
};
 
} // namespace clang::ssaf
 
#endif // LLVM_CLANG_SCALABLESTATICANALYSISFRAMEWORK_CORE_ENTITYLINKER_LUSUMMARY_H