https://github.com/aviralg created https://github.com/llvm/llvm-project/pull/205946
None >From 4ecaefc93f376f5edcdff01217b1ba5b156ce693 Mon Sep 17 00:00:00 2001 From: Aviral Goel <[email protected]> Date: Thu, 25 Jun 2026 16:05:31 -0700 Subject: [PATCH] Add archive --- .../Core/EntityLinker/Archive.h | 72 +++++++ .../Core/EntityLinker/TUSummaryEncoding.h | 27 +++ .../Core/Model/BuildNamespace.h | 6 +- .../Core/Model/PrivateFieldNames.def | 3 + .../Core/Serialization/JSONFormat.h | 13 ++ .../Core/Serialization/SerializationFormat.h | 12 +- .../Core/CMakeLists.txt | 1 + .../Core/ModelStringConversions.h | 4 + .../Core/Serialization/JSONFormat/Archive.cpp | 185 ++++++++++++++++++ .../Serialization/JSONFormat/Artifact.cpp | 19 +- .../Serialization/JSONFormat/JSONFormatImpl.h | 5 +- .../JSONFormat/TUSummaryEncoding.cpp | 19 +- .../Archive/Inputs/duplicate-member.json | 32 +++ .../Inputs/member-mismatched-type.json | 18 ++ .../Archive/Inputs/member-not-object.json | 9 + .../Inputs/member-triple-mismatch.json | 21 ++ .../Archive/Inputs/members-not-array.json | 9 + .../Archive/Inputs/mismatched-type.json | 9 + .../Archive/Inputs/missing-members.json | 8 + .../Archive/Inputs/missing-namespace.json | 5 + .../Archive/Inputs/missing-target-triple.json | 8 + .../Archive/Inputs/missing-type.json | 8 + .../Inputs/namespace-invalid-kind.json | 9 + .../Inputs/namespace-missing-kind.json | 8 + .../Inputs/namespace-missing-name.json | 8 + .../Archive/Inputs/namespace-wrong-kind.json | 9 + .../Inputs/not-normalized-target-triple.json | 9 + .../ssaf-format/Archive/Inputs/rt-empty.json | 9 + .../Archive/Inputs/rt-multiple-members.json | 43 ++++ .../Archive/Inputs/rt-single-member.json | 21 ++ .../ssaf-format/Archive/round-trip.test | 27 +++ .../ssaf-format/Archive/top-level.test | 107 ++++++++++ .../Artifact/Inputs/rt-archive-empty.json | 9 + .../ssaf-format/Artifact/round-trip.test | 9 + .../ssaf-format/Artifact/top-level.test | 2 +- clang/tools/clang-ssaf-format/SSAFFormat.cpp | 11 +- .../ScalableStaticAnalysis/ArchiveTest.cpp | 32 +++ .../BuildNamespaceTest.cpp | 7 + .../ScalableStaticAnalysis/CMakeLists.txt | 1 + .../TUSummaryExtractorFrontendActionTest.cpp | 14 ++ .../ModelStringConversionsTest.cpp | 13 ++ .../Registries/MockSerializationFormat.cpp | 11 ++ .../Registries/MockSerializationFormat.h | 4 + .../ScalableStaticAnalysis/TestFixture.h | 1 + 44 files changed, 842 insertions(+), 15 deletions(-) create mode 100644 clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h create mode 100644 clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Archive.cpp create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/duplicate-member.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-mismatched-type.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-not-object.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-triple-mismatch.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/members-not-array.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/mismatched-type.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-members.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-namespace.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-target-triple.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-type.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-invalid-kind.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-kind.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-name.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-wrong-kind.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/not-normalized-target-triple.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-empty.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-multiple-members.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-single-member.json create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/round-trip.test create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Archive/top-level.test create mode 100644 clang/test/Analysis/Scalable/ssaf-format/Artifact/Inputs/rt-archive-empty.json create mode 100644 clang/unittests/ScalableStaticAnalysis/ArchiveTest.cpp diff --git a/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h b/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h new file mode 100644 index 0000000000000..44ff71fc11156 --- /dev/null +++ b/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h @@ -0,0 +1,72 @@ +//===- Archive.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 Archive class, which represents a static archive of +// translation unit summary encodings (the SSAF analogue of an ar/lib/libtool +// static archive). +// +//===----------------------------------------------------------------------===// + +#ifndef LLVM_CLANG_SCALABLESTATICANALYSIS_CORE_ENTITYLINKER_ARCHIVE_H +#define LLVM_CLANG_SCALABLESTATICANALYSIS_CORE_ENTITYLINKER_ARCHIVE_H + +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" +#include "clang/ScalableStaticAnalysis/Core/Model/BuildNamespace.h" +#include "llvm/TargetParser/Triple.h" +#include <memory> +#include <set> + +namespace clang::ssaf { + +/// Represents a static archive of translation unit summary encodings. +/// +/// An Archive bundles member translation units without performing entity +/// resolution, mirroring the role of ar / libtool -static / lib.exe in +/// native build pipelines. The final linker is responsible for selective +/// inclusion when an Archive appears on its command line. +/// +/// Archives are single-architecture: every member's target triple must +/// equal the archive's. Multi-architecture archives are expressed as a +/// fat wrapper around per-architecture Archive instances rather than as +/// a single mixed-architecture archive. +/// +/// Members are stored as encoded TUSummaryEncoding objects: the archive +/// tool never decodes per-entity payloads, and the linker consumes them +/// as-is during its selective inclusion pass. +class Archive { + friend class EntityLinker; + friend class SerializationFormat; + friend class TestFixture; + + // Target triple of the archive. All member TUs must share this triple. + llvm::Triple TargetTriple; + + // The namespace identifying this archive (kind=Archive). + BuildNamespace Namespace; + + // Member translation units, ordered by their TUNamespace. Membership is + // by namespace identity: inserting a TU whose TUNamespace already exists + // in the set is rejected during deserialization. The comparator reaches + // the members' private TUNamespace field via friend access on + // TUSummaryEncoding rather than through a public accessor. + std::set<std::unique_ptr<TUSummaryEncoding>, TUSummaryEncodingByNamespace> + Members; + +public: + Archive(llvm::Triple TargetTriple, BuildNamespace Namespace) + : TargetTriple(std::move(TargetTriple)), Namespace(std::move(Namespace)) { + } + + const llvm::Triple &getTargetTriple() const { return TargetTriple; } + + const BuildNamespace &getNamespace() const { return Namespace; } +}; + +} // namespace clang::ssaf + +#endif // LLVM_CLANG_SCALABLESTATICANALYSIS_CORE_ENTITYLINKER_ARCHIVE_H diff --git a/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h b/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h index 2c672a55e4873..edd7009b20957 100644 --- a/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h +++ b/clang/include/clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h @@ -26,6 +26,8 @@ namespace clang::ssaf { +struct TUSummaryEncodingByNamespace; + /// Represents a translation unit summary in its serialized encoding. /// /// TUSummaryEncoding holds entity summary data in a format-specific encoding @@ -36,6 +38,7 @@ class TUSummaryEncoding { friend class EntityLinker; friend class SerializationFormat; friend class TestFixture; + friend struct TUSummaryEncodingByNamespace; // Target triple of the translation unit. llvm::Triple TargetTriple; @@ -62,6 +65,30 @@ class TUSummaryEncoding { const llvm::Triple &getTargetTriple() const { return TargetTriple; } }; +/// Comparator that orders TUSummaryEncoding pointers by their TUNamespace. +/// Lives here (next to TUSummaryEncoding) rather than inside Archive so it +/// can reach the private TUNamespace field via friend access without +/// exposing a public accessor. The transparent overloads enable +/// std::set::find() lookup by a bare BuildNamespace. +struct TUSummaryEncodingByNamespace { + using is_transparent = void; + + bool operator()(const std::unique_ptr<TUSummaryEncoding> &A, + const std::unique_ptr<TUSummaryEncoding> &B) const { + return A->TUNamespace < B->TUNamespace; + } + + bool operator()(const std::unique_ptr<TUSummaryEncoding> &A, + const BuildNamespace &B) const { + return A->TUNamespace < B; + } + + bool operator()(const BuildNamespace &A, + const std::unique_ptr<TUSummaryEncoding> &B) const { + return A < B->TUNamespace; + } +}; + } // namespace clang::ssaf #endif // LLVM_CLANG_SCALABLESTATICANALYSIS_CORE_ENTITYLINKER_TUSUMMARYENCODING_H diff --git a/clang/include/clang/ScalableStaticAnalysis/Core/Model/BuildNamespace.h b/clang/include/clang/ScalableStaticAnalysis/Core/Model/BuildNamespace.h index 6da5a9e42c4da..4c7b23cec9131 100644 --- a/clang/include/clang/ScalableStaticAnalysis/Core/Model/BuildNamespace.h +++ b/clang/include/clang/ScalableStaticAnalysis/Core/Model/BuildNamespace.h @@ -27,7 +27,11 @@ namespace clang::ssaf { -enum class BuildNamespaceKind : unsigned short { CompilationUnit, LinkUnit }; +enum class BuildNamespaceKind : unsigned short { + CompilationUnit, + LinkUnit, + Archive +}; /// Represents a single namespace in the build process. /// diff --git a/clang/include/clang/ScalableStaticAnalysis/Core/Model/PrivateFieldNames.def b/clang/include/clang/ScalableStaticAnalysis/Core/Model/PrivateFieldNames.def index 44931026ba428..ead25397f6526 100644 --- a/clang/include/clang/ScalableStaticAnalysis/Core/Model/PrivateFieldNames.def +++ b/clang/include/clang/ScalableStaticAnalysis/Core/Model/PrivateFieldNames.def @@ -19,6 +19,9 @@ FIELD(BuildNamespace, Kind) FIELD(BuildNamespace, Name) +FIELD(Archive, TargetTriple) +FIELD(Archive, Namespace) +FIELD(Archive, Members) FIELD(EntityId, Index) FIELD(EntityIdTable, Entities) FIELD(EntityLinkage, Linkage) diff --git a/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/JSONFormat.h b/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/JSONFormat.h index 9d9b1ff0bbb51..1a84aff1eebc5 100644 --- a/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/JSONFormat.h +++ b/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/JSONFormat.h @@ -68,6 +68,10 @@ class JSONFormat final : public SerializationFormat { llvm::Error writeLUSummaryEncoding(const LUSummaryEncoding &SummaryEncoding, llvm::StringRef Path) override; + llvm::Expected<Archive> readArchive(llvm::StringRef Path) override; + + llvm::Error writeArchive(const Archive &A, llvm::StringRef Path) override; + llvm::Expected<WPASuite> readWPASuite(llvm::StringRef Path) override; llvm::Error writeWPASuite(const WPASuite &Suite, @@ -122,6 +126,15 @@ class JSONFormat final : public SerializationFormat { llvm::Expected<LUSummaryEncoding> readLUSummaryEncodingFromObject(const Object &Root); + /// Parses an Archive from an already-validated root JSON object. See + /// \c readTUSummaryFromObject for caller responsibilities. + llvm::Expected<Archive> readArchiveFromObject(const Object &Root); + + /// Serializes a TUSummaryEncoding to a JSON object including its + /// self-describing \c type field. Used both by \c writeTUSummaryEncoding + /// and by the Archive writer to emit member entries. + Object tuSummaryEncodingToJSON(const TUSummaryEncoding &SE) const; + /// Parses a WPASuite from an already-validated root JSON object. See /// \c readTUSummaryFromObject for caller responsibilities. llvm::Expected<WPASuite> readWPASuiteFromObject(const Object &Root); diff --git a/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/SerializationFormat.h b/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/SerializationFormat.h index ca3ee9ce3362c..f7fdbe08878df 100644 --- a/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/SerializationFormat.h +++ b/clang/include/clang/ScalableStaticAnalysis/Core/Serialization/SerializationFormat.h @@ -14,6 +14,7 @@ #ifndef LLVM_CLANG_SCALABLESTATICANALYSIS_CORE_SERIALIZATION_SERIALIZATIONFORMAT_H #define LLVM_CLANG_SCALABLESTATICANALYSIS_CORE_SERIALIZATION_SERIALIZATIONFORMAT_H +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummary.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummaryEncoding.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" @@ -40,7 +41,12 @@ using Artifact = std::variant<TUSummary, LUSummary, WPASuite>; /// Lazily-deserialized counterpart of \c Artifact: the same on-disk /// artifacts but with their per-entity summary payloads left as opaque /// format-specific encodings rather than fully resolved analysis results. -using ArtifactEncoding = std::variant<TUSummaryEncoding, LUSummaryEncoding>; +/// +/// \c Archive appears only in this variant: the archive tool and the +/// linker pass member payloads through without decoding them, so a fully +/// decoded archive shape would have no consumer. +using ArtifactEncoding = + std::variant<TUSummaryEncoding, LUSummaryEncoding, Archive>; /// Abstract base class for serialization formats. class SerializationFormat { @@ -94,6 +100,10 @@ class SerializationFormat { writeLUSummaryEncoding(const LUSummaryEncoding &SummaryEncoding, llvm::StringRef Path) = 0; + virtual llvm::Expected<Archive> readArchive(llvm::StringRef Path) = 0; + + virtual llvm::Error writeArchive(const Archive &A, llvm::StringRef Path) = 0; + virtual llvm::Expected<WPASuite> readWPASuite(llvm::StringRef Path) = 0; virtual llvm::Error writeWPASuite(const WPASuite &Suite, diff --git a/clang/lib/ScalableStaticAnalysis/Core/CMakeLists.txt b/clang/lib/ScalableStaticAnalysis/Core/CMakeLists.txt index b2cde5f225445..3f8114c28cbcd 100644 --- a/clang/lib/ScalableStaticAnalysis/Core/CMakeLists.txt +++ b/clang/lib/ScalableStaticAnalysis/Core/CMakeLists.txt @@ -12,6 +12,7 @@ add_clang_library(clangScalableStaticAnalysisCore Model/EntityLinkage.cpp Model/EntityName.cpp Model/SummaryName.cpp + Serialization/JSONFormat/Archive.cpp Serialization/JSONFormat/Artifact.cpp Serialization/JSONFormat/JSONEntitySummaryEncoding.cpp Serialization/JSONFormat/JSONFormatImpl.cpp diff --git a/clang/lib/ScalableStaticAnalysis/Core/ModelStringConversions.h b/clang/lib/ScalableStaticAnalysis/Core/ModelStringConversions.h index ee1603e50025f..0f011dd5639dc 100644 --- a/clang/lib/ScalableStaticAnalysis/Core/ModelStringConversions.h +++ b/clang/lib/ScalableStaticAnalysis/Core/ModelStringConversions.h @@ -36,6 +36,8 @@ inline llvm::StringRef buildNamespaceKindToString(BuildNamespaceKind BNK) { return "CompilationUnit"; case BuildNamespaceKind::LinkUnit: return "LinkUnit"; + case BuildNamespaceKind::Archive: + return "Archive"; } llvm_unreachable("Unhandled BuildNamespaceKind variant"); } @@ -48,6 +50,8 @@ buildNamespaceKindFromString(llvm::StringRef Str) { return BuildNamespaceKind::CompilationUnit; if (Str == "LinkUnit") return BuildNamespaceKind::LinkUnit; + if (Str == "Archive") + return BuildNamespaceKind::Archive; return std::nullopt; } diff --git a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Archive.cpp b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Archive.cpp new file mode 100644 index 0000000000000..061a54c2246cf --- /dev/null +++ b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Archive.cpp @@ -0,0 +1,185 @@ +//===- Archive.cpp --------------------------------------------------------===// +// +// 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 +// +//===----------------------------------------------------------------------===// + +#include "JSONFormatImpl.h" + +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h" +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" +#include "llvm/TargetParser/Triple.h" + +namespace clang::ssaf { + +//---------------------------------------------------------------------------- +// Archive +//---------------------------------------------------------------------------- + +llvm::Expected<Archive> JSONFormat::readArchive(llvm::StringRef Path) { + auto ExpectedJSON = readJSON(Path); + if (!ExpectedJSON) { + return ErrorBuilder::wrap(ExpectedJSON.takeError()) + .context(ErrorMessages::ReadingFromFile, "Archive", Path) + .build(); + } + + Object *RootObjectPtr = ExpectedJSON->getAsObject(); + if (!RootObjectPtr) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::FailedToReadObject, "Archive", + "object") + .context(ErrorMessages::ReadingFromFile, "Archive", Path) + .build(); + } + + if (auto Err = checkSummaryType(*RootObjectPtr, JSONTypeValueArchive)) { + return ErrorBuilder::wrap(std::move(Err)) + .context(ErrorMessages::ReadingFromFile, "Archive", Path) + .build(); + } + + auto ExpectedArchive = readArchiveFromObject(*RootObjectPtr); + if (!ExpectedArchive) { + return ErrorBuilder::wrap(ExpectedArchive.takeError()) + .context(ErrorMessages::ReadingFromFile, "Archive", Path) + .build(); + } + + return std::move(*ExpectedArchive); +} + +llvm::Expected<Archive> +JSONFormat::readArchiveFromObject(const Object &RootObject) { + auto OptTargetTriple = RootObject.getString("target_triple"); + if (!OptTargetTriple) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::FailedToReadObjectAtField, + "TargetTriple", "target_triple", "string") + .build(); + } + + if (auto Err = validateNormalizedTargetTriple(*OptTargetTriple)) { + return ErrorBuilder::wrap(std::move(Err)) + .context(ErrorMessages::ReadingFromField, "TargetTriple", + "target_triple") + .build(); + } + + llvm::Triple T(*OptTargetTriple); + + const Object *NamespaceObject = RootObject.getObject("namespace"); + if (!NamespaceObject) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::FailedToReadObjectAtField, + "BuildNamespace", "namespace", "object") + .build(); + } + + auto ExpectedNamespace = buildNamespaceFromJSON(*NamespaceObject); + if (!ExpectedNamespace) { + return ErrorBuilder::wrap(ExpectedNamespace.takeError()) + .context(ErrorMessages::ReadingFromField, "BuildNamespace", "namespace") + .build(); + } + + if (getKind(*ExpectedNamespace) != BuildNamespaceKind::Archive) { + return ErrorBuilder::create( + std::errc::invalid_argument, + ErrorMessages::MismatchedSummaryType, + buildNamespaceKindToJSON(BuildNamespaceKind::Archive), + "namespace.kind", + buildNamespaceKindToJSON(getKind(*ExpectedNamespace))) + .build(); + } + + Archive A(std::move(T), std::move(*ExpectedNamespace)); + + const Array *MembersArray = RootObject.getArray("members"); + if (!MembersArray) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::FailedToReadObjectAtField, + "Archive members", "members", "array") + .build(); + } + + auto &Members = getMembers(A); + const auto &ArchiveTriple = getTargetTriple(A); + + for (const auto &[Index, MemberValue] : llvm::enumerate(*MembersArray)) { + const Object *MemberObject = MemberValue.getAsObject(); + if (!MemberObject) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::FailedToReadObjectAtIndex, + "Archive member", Index, "object") + .build(); + } + + if (auto Err = checkSummaryType(*MemberObject, JSONTypeValueTUSummary)) { + return ErrorBuilder::wrap(std::move(Err)) + .context(ErrorMessages::ReadingFromIndex, "Archive member", Index) + .build(); + } + + auto ExpectedMember = readTUSummaryEncodingFromObject(*MemberObject); + if (!ExpectedMember) { + return ErrorBuilder::wrap(ExpectedMember.takeError()) + .context(ErrorMessages::ReadingFromIndex, "Archive member", Index) + .build(); + } + + if (ExpectedMember->getTargetTriple() != ArchiveTriple) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::MismatchedSummaryType, + llvm::Triple::normalize(ArchiveTriple.str()), + "target_triple", + llvm::Triple::normalize( + ExpectedMember->getTargetTriple().str())) + .context(ErrorMessages::ReadingFromIndex, "Archive member", Index) + .build(); + } + + auto MemberNamespace = getTUNamespace(*ExpectedMember); + auto Owned = + std::make_unique<TUSummaryEncoding>(std::move(*ExpectedMember)); + auto [It, Inserted] = Members.insert(std::move(Owned)); + if (!Inserted) { + return ErrorBuilder::create(std::errc::invalid_argument, + ErrorMessages::FailedInsertionOnDuplication, + "Archive member", Index, MemberNamespace) + .build(); + } + } + + return std::move(A); +} + +llvm::Error JSONFormat::writeArchive(const Archive &A, llvm::StringRef Path) { + Object RootObject; + + RootObject[JSONTypeKey] = JSONTypeValueArchive; + + RootObject["target_triple"] = + llvm::Triple::normalize(getTargetTriple(A).str()); + + RootObject["namespace"] = buildNamespaceToJSON(getNamespace(A)); + + Array MembersArray; + MembersArray.reserve(getMembers(A).size()); + for (const auto &Member : getMembers(A)) { + MembersArray.push_back(tuSummaryEncodingToJSON(*Member)); + } + RootObject["members"] = std::move(MembersArray); + + if (auto Error = writeJSON(std::move(RootObject), Path)) { + return ErrorBuilder::wrap(std::move(Error)) + .context(ErrorMessages::WritingToFile, "Archive", Path) + .build(); + } + + return llvm::Error::success(); +} + +} // namespace clang::ssaf diff --git a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Artifact.cpp b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Artifact.cpp index 424d7368cf33f..b112c899c28fa 100644 --- a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Artifact.cpp +++ b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/Artifact.cpp @@ -145,10 +145,21 @@ JSONFormat::readArtifactEncoding(llvm::StringRef Path) { return ArtifactEncoding{std::move(*ExpectedLU)}; } + if (*ExpectedType == JSONTypeValueArchive) { + auto ExpectedArchive = readArchiveFromObject(*RootObjectPtr); + if (!ExpectedArchive) { + return ErrorBuilder::wrap(ExpectedArchive.takeError()) + .context(ErrorMessages::ReadingFromFile, "ArtifactEncoding", Path) + .build(); + } + return ArtifactEncoding{std::move(*ExpectedArchive)}; + } + return ErrorBuilder::create(std::errc::invalid_argument, ErrorMessages::UnknownArtifactEncodingType, *ExpectedType, JSONTypeKey, - JSONTypeValueTUSummary, JSONTypeValueLUSummary) + JSONTypeValueTUSummary, JSONTypeValueLUSummary, + JSONTypeValueArchive) .context(ErrorMessages::ReadingFromFile, "ArtifactEncoding", Path) .build(); } @@ -160,11 +171,13 @@ llvm::Error JSONFormat::writeArtifactEncoding(const ArtifactEncoding &E, using T = std::decay_t<decltype(Enc)>; if constexpr (std::is_same_v<T, TUSummaryEncoding>) { return writeTUSummaryEncoding(Enc, Path); + } else if constexpr (std::is_same_v<T, LUSummaryEncoding>) { + return writeLUSummaryEncoding(Enc, Path); } else { static_assert( - std::is_same_v<T, LUSummaryEncoding>, + std::is_same_v<T, Archive>, "ArtifactEncoding visitor must cover all variant alternatives"); - return writeLUSummaryEncoding(Enc, Path); + return writeArchive(Enc, Path); } }, E); diff --git a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/JSONFormatImpl.h b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/JSONFormatImpl.h index 191be83ccb0e5..29048f8991a5b 100644 --- a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/JSONFormatImpl.h +++ b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/JSONFormatImpl.h @@ -85,7 +85,7 @@ inline constexpr const char *MismatchedSummaryType = inline constexpr const char *UnknownArtifactType = "unknown value '{0}' for field '{1}': expected '{2}', '{3}', or '{4}'"; inline constexpr const char *UnknownArtifactEncodingType = - "unknown value '{0}' for field '{1}': expected '{2}', or '{3}'"; + "unknown value '{0}' for field '{1}': expected '{2}', '{3}', or '{4}'"; inline constexpr const char *FailedToDeserializeEntitySummaryNoFormatInfo = "failed to deserialize EntitySummary: no FormatInfo registered for '{0}'"; @@ -149,6 +149,9 @@ inline constexpr const char *JSONTypeValueTUSummary = "TUSummary"; /// Value written to \c JSONTypeKey for serialized \c LUSummary files. inline constexpr const char *JSONTypeValueLUSummary = "LUSummary"; +/// Value written to \c JSONTypeKey for serialized \c Archive files. +inline constexpr const char *JSONTypeValueArchive = "Archive"; + /// Value written to \c JSONTypeKey for serialized \c WPASuite files. inline constexpr const char *JSONTypeValueWPASuite = "WPASuite"; diff --git a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/TUSummaryEncoding.cpp b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/TUSummaryEncoding.cpp index 5a5ab98731c47..3ee4f059bd458 100644 --- a/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/TUSummaryEncoding.cpp +++ b/clang/lib/ScalableStaticAnalysis/Core/Serialization/JSONFormat/TUSummaryEncoding.cpp @@ -164,6 +164,17 @@ JSONFormat::readTUSummaryEncodingFromObject(const Object &RootObject) { llvm::Error JSONFormat::writeTUSummaryEncoding(const TUSummaryEncoding &SummaryEncoding, llvm::StringRef Path) { + if (auto Error = writeJSON(tuSummaryEncodingToJSON(SummaryEncoding), Path)) { + return ErrorBuilder::wrap(std::move(Error)) + .context(ErrorMessages::WritingToFile, "TUSummary", Path) + .build(); + } + + return llvm::Error::success(); +} + +Object JSONFormat::tuSummaryEncodingToJSON( + const TUSummaryEncoding &SummaryEncoding) const { Object RootObject; RootObject[JSONTypeKey] = JSONTypeValueTUSummary; @@ -181,13 +192,7 @@ JSONFormat::writeTUSummaryEncoding(const TUSummaryEncoding &SummaryEncoding, RootObject["data"] = encodingSummaryDataMapToJSON(getData(SummaryEncoding)); - if (auto Error = writeJSON(std::move(RootObject), Path)) { - return ErrorBuilder::wrap(std::move(Error)) - .context(ErrorMessages::WritingToFile, "TUSummary", Path) - .build(); - } - - return llvm::Error::success(); + return RootObject; } } // namespace clang::ssaf diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/duplicate-member.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/duplicate-member.json new file mode 100644 index 0000000000000..e2a9b8bc9c04b --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/duplicate-member.json @@ -0,0 +1,32 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [ + { + "type": "TUSummary", + "target_triple": "arm64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "a.cpp" + }, + "id_table": [], + "linkage_table": [], + "data": [] + }, + { + "type": "TUSummary", + "target_triple": "arm64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "a.cpp" + }, + "id_table": [], + "linkage_table": [], + "data": [] + } + ] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-mismatched-type.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-mismatched-type.json new file mode 100644 index 0000000000000..7ab312e5c3c51 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-mismatched-type.json @@ -0,0 +1,18 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [ + { + "type": "LUSummary", + "target_triple": "arm64-apple-macosx", + "lu_namespace": [], + "id_table": [], + "linkage_table": [], + "data": [] + } + ] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-not-object.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-not-object.json new file mode 100644 index 0000000000000..a479b8e560462 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-not-object.json @@ -0,0 +1,9 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": ["not an object"] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-triple-mismatch.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-triple-mismatch.json new file mode 100644 index 0000000000000..2690bab465d44 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/member-triple-mismatch.json @@ -0,0 +1,21 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [ + { + "type": "TUSummary", + "target_triple": "x86_64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "a.cpp" + }, + "id_table": [], + "linkage_table": [], + "data": [] + } + ] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/members-not-array.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/members-not-array.json new file mode 100644 index 0000000000000..4bf99cf057afd --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/members-not-array.json @@ -0,0 +1,9 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": {} +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/mismatched-type.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/mismatched-type.json new file mode 100644 index 0000000000000..df066e9289767 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/mismatched-type.json @@ -0,0 +1,9 @@ +{ + "type": "TUSummary", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-members.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-members.json new file mode 100644 index 0000000000000..d8a927747b5a0 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-members.json @@ -0,0 +1,8 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + } +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-namespace.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-namespace.json new file mode 100644 index 0000000000000..39d998d19753c --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-namespace.json @@ -0,0 +1,5 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-target-triple.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-target-triple.json new file mode 100644 index 0000000000000..870d44de13aa4 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-target-triple.json @@ -0,0 +1,8 @@ +{ + "type": "Archive", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-type.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-type.json new file mode 100644 index 0000000000000..e1314fc1dd796 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/missing-type.json @@ -0,0 +1,8 @@ +{ + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-invalid-kind.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-invalid-kind.json new file mode 100644 index 0000000000000..bdcc067d17fc8 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-invalid-kind.json @@ -0,0 +1,9 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "invalid_kind", + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-kind.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-kind.json new file mode 100644 index 0000000000000..28f3322831d6f --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-kind.json @@ -0,0 +1,8 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-name.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-name.json new file mode 100644 index 0000000000000..5f87b3e4662df --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-missing-name.json @@ -0,0 +1,8 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "Archive" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-wrong-kind.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-wrong-kind.json new file mode 100644 index 0000000000000..24c437fc61dd5 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/namespace-wrong-kind.json @@ -0,0 +1,9 @@ +{ + "type": "Archive", + "target_triple": "arm64-apple-macosx", + "namespace": { + "kind": "CompilationUnit", + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/not-normalized-target-triple.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/not-normalized-target-triple.json new file mode 100644 index 0000000000000..637d42cd32be8 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/not-normalized-target-triple.json @@ -0,0 +1,9 @@ +{ + "type": "Archive", + "target_triple": "arm64-macosx-apple", + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "members": [] +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-empty.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-empty.json new file mode 100644 index 0000000000000..79513109e8c5d --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-empty.json @@ -0,0 +1,9 @@ +{ + "members": [], + "namespace": { + "kind": "Archive", + "name": "libempty" + }, + "target_triple": "arm64-apple-macosx", + "type": "Archive" +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-multiple-members.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-multiple-members.json new file mode 100644 index 0000000000000..b8210a19216bd --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-multiple-members.json @@ -0,0 +1,43 @@ +{ + "members": [ + { + "data": [], + "id_table": [], + "linkage_table": [], + "target_triple": "arm64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "a.cpp" + }, + "type": "TUSummary" + }, + { + "data": [], + "id_table": [], + "linkage_table": [], + "target_triple": "arm64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "b.cpp" + }, + "type": "TUSummary" + }, + { + "data": [], + "id_table": [], + "linkage_table": [], + "target_triple": "arm64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "c.cpp" + }, + "type": "TUSummary" + } + ], + "namespace": { + "kind": "Archive", + "name": "libmulti" + }, + "target_triple": "arm64-apple-macosx", + "type": "Archive" +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-single-member.json b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-single-member.json new file mode 100644 index 0000000000000..0eab8a9cdb0b6 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/Inputs/rt-single-member.json @@ -0,0 +1,21 @@ +{ + "members": [ + { + "data": [], + "id_table": [], + "linkage_table": [], + "target_triple": "arm64-apple-macosx", + "tu_namespace": { + "kind": "CompilationUnit", + "name": "a.cpp" + }, + "type": "TUSummary" + } + ], + "namespace": { + "kind": "Archive", + "name": "libfoo" + }, + "target_triple": "arm64-apple-macosx", + "type": "Archive" +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/round-trip.test b/clang/test/Analysis/Scalable/ssaf-format/Archive/round-trip.test new file mode 100644 index 0000000000000..b3273abfc3238 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/round-trip.test @@ -0,0 +1,27 @@ +// Round-trip tests: read an Archive JSON input, write it back out, and +// diff the result against the original. +// +// Archive has only an encoding representation, so --encoding is a no-op +// for --type archive and both invocations must produce the same output. + +// RUN: rm -rf %t +// RUN: mkdir -p %t + +// ============================================================================ +// Round-Trip Tests +// ============================================================================ + +// RUN: clang-ssaf-format --type archive %S/Inputs/rt-empty.json -o %t/rt-empty.json +// RUN: diff %S/Inputs/rt-empty.json %t/rt-empty.json +// RUN: clang-ssaf-format --type archive --encoding %S/Inputs/rt-empty.json -o %t/rt-empty-enc.json +// RUN: diff %S/Inputs/rt-empty.json %t/rt-empty-enc.json + +// RUN: clang-ssaf-format --type archive %S/Inputs/rt-single-member.json -o %t/rt-single-member.json +// RUN: diff %S/Inputs/rt-single-member.json %t/rt-single-member.json +// RUN: clang-ssaf-format --type archive --encoding %S/Inputs/rt-single-member.json -o %t/rt-single-member-enc.json +// RUN: diff %S/Inputs/rt-single-member.json %t/rt-single-member-enc.json + +// RUN: clang-ssaf-format --type archive %S/Inputs/rt-multiple-members.json -o %t/rt-multiple-members.json +// RUN: diff %S/Inputs/rt-multiple-members.json %t/rt-multiple-members.json +// RUN: clang-ssaf-format --type archive --encoding %S/Inputs/rt-multiple-members.json -o %t/rt-multiple-members-enc.json +// RUN: diff %S/Inputs/rt-multiple-members.json %t/rt-multiple-members-enc.json diff --git a/clang/test/Analysis/Scalable/ssaf-format/Archive/top-level.test b/clang/test/Analysis/Scalable/ssaf-format/Archive/top-level.test new file mode 100644 index 0000000000000..0746cd72ac8f5 --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Archive/top-level.test @@ -0,0 +1,107 @@ +// Top-level Archive structure tests: target_triple, namespace (Archive +// kind), members array, and per-member validation. Mirrors the LUSummary +// top-level test pattern but covers the Archive-specific shape. + +// ============================================================================ +// readArchive() / writeArchive() type-field errors +// ============================================================================ + +// RUN: not clang-ssaf-format --type archive %S/Inputs/missing-type.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MISSING-TYPE +// MISSING-TYPE: clang-ssaf-format: error: reading Archive from file '{{.*}}missing-type.json' +// MISSING-TYPE-NEXT: failed to read summary type from field 'type': expected JSON string + +// RUN: not clang-ssaf-format --type archive %S/Inputs/mismatched-type.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MISMATCHED-TYPE +// MISMATCHED-TYPE: clang-ssaf-format: error: reading Archive from file '{{.*}}mismatched-type.json' +// MISMATCHED-TYPE-NEXT: expected 'Archive' for field 'type' but got 'TUSummary' + +// ============================================================================ +// target_triple errors +// ============================================================================ + +// RUN: not clang-ssaf-format --type archive %S/Inputs/missing-target-triple.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MISSING-TARGET-TRIPLE +// MISSING-TARGET-TRIPLE: clang-ssaf-format: error: reading Archive from file '{{.*}}missing-target-triple.json' +// MISSING-TARGET-TRIPLE-NEXT: failed to read TargetTriple from field 'target_triple': expected JSON string + +// RUN: not clang-ssaf-format --type archive %S/Inputs/not-normalized-target-triple.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=NOT-NORMALIZED-TARGET-TRIPLE +// NOT-NORMALIZED-TARGET-TRIPLE: clang-ssaf-format: error: reading Archive from file '{{.*}}not-normalized-target-triple.json' +// NOT-NORMALIZED-TARGET-TRIPLE-NEXT: reading TargetTriple from field 'target_triple' +// NOT-NORMALIZED-TARGET-TRIPLE-NEXT: target triple 'arm64-macosx-apple' is not in normalized form (expected 'arm64-apple-macosx') + +// ============================================================================ +// namespace errors +// ============================================================================ + +// RUN: not clang-ssaf-format --type archive %S/Inputs/missing-namespace.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MISSING-NAMESPACE +// MISSING-NAMESPACE: clang-ssaf-format: error: reading Archive from file '{{.*}}missing-namespace.json' +// MISSING-NAMESPACE-NEXT: failed to read BuildNamespace from field 'namespace': expected JSON object + +// RUN: not clang-ssaf-format --type archive %S/Inputs/namespace-missing-kind.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=NAMESPACE-MISSING-KIND +// NAMESPACE-MISSING-KIND: clang-ssaf-format: error: reading Archive from file '{{.*}}namespace-missing-kind.json' +// NAMESPACE-MISSING-KIND-NEXT: reading BuildNamespace from field 'namespace' +// NAMESPACE-MISSING-KIND-NEXT: failed to read BuildNamespaceKind from field 'kind': expected JSON string + +// RUN: not clang-ssaf-format --type archive %S/Inputs/namespace-invalid-kind.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=NAMESPACE-INVALID-KIND +// NAMESPACE-INVALID-KIND: clang-ssaf-format: error: reading Archive from file '{{.*}}namespace-invalid-kind.json' +// NAMESPACE-INVALID-KIND-NEXT: reading BuildNamespace from field 'namespace' +// NAMESPACE-INVALID-KIND-NEXT: reading BuildNamespaceKind from field 'kind' +// NAMESPACE-INVALID-KIND-NEXT: invalid BuildNamespaceKind value 'invalid_kind' for field 'kind' + +// Archive's namespace field must specifically have kind=Archive. Any other +// well-formed kind (CompilationUnit, LinkUnit) is reported as a mismatch. +// RUN: not clang-ssaf-format --type archive %S/Inputs/namespace-wrong-kind.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=NAMESPACE-WRONG-KIND +// NAMESPACE-WRONG-KIND: clang-ssaf-format: error: reading Archive from file '{{.*}}namespace-wrong-kind.json' +// NAMESPACE-WRONG-KIND-NEXT: expected 'Archive' for field 'namespace.kind' but got 'CompilationUnit' + +// RUN: not clang-ssaf-format --type archive %S/Inputs/namespace-missing-name.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=NAMESPACE-MISSING-NAME +// NAMESPACE-MISSING-NAME: clang-ssaf-format: error: reading Archive from file '{{.*}}namespace-missing-name.json' +// NAMESPACE-MISSING-NAME-NEXT: reading BuildNamespace from field 'namespace' +// NAMESPACE-MISSING-NAME-NEXT: failed to read BuildNamespaceName from field 'name': expected JSON string + +// ============================================================================ +// members array errors +// ============================================================================ + +// RUN: not clang-ssaf-format --type archive %S/Inputs/missing-members.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MISSING-MEMBERS +// MISSING-MEMBERS: clang-ssaf-format: error: reading Archive from file '{{.*}}missing-members.json' +// MISSING-MEMBERS-NEXT: failed to read Archive members from field 'members': expected JSON array + +// RUN: not clang-ssaf-format --type archive %S/Inputs/members-not-array.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MEMBERS-NOT-ARRAY +// MEMBERS-NOT-ARRAY: clang-ssaf-format: error: reading Archive from file '{{.*}}members-not-array.json' +// MEMBERS-NOT-ARRAY-NEXT: failed to read Archive members from field 'members': expected JSON array + +// RUN: not clang-ssaf-format --type archive %S/Inputs/member-not-object.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MEMBER-NOT-OBJECT +// MEMBER-NOT-OBJECT: clang-ssaf-format: error: reading Archive from file '{{.*}}member-not-object.json' +// MEMBER-NOT-OBJECT-NEXT: failed to read Archive member from index '0': expected JSON object + +// ============================================================================ +// per-member errors +// ============================================================================ + +// RUN: not clang-ssaf-format --type archive %S/Inputs/member-mismatched-type.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MEMBER-MISMATCHED-TYPE +// MEMBER-MISMATCHED-TYPE: clang-ssaf-format: error: reading Archive from file '{{.*}}member-mismatched-type.json' +// MEMBER-MISMATCHED-TYPE-NEXT: reading Archive member from index '0' +// MEMBER-MISMATCHED-TYPE-NEXT: expected 'TUSummary' for field 'type' but got 'LUSummary' + +// RUN: not clang-ssaf-format --type archive %S/Inputs/member-triple-mismatch.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=MEMBER-TRIPLE-MISMATCH +// MEMBER-TRIPLE-MISMATCH: clang-ssaf-format: error: reading Archive from file '{{.*}}member-triple-mismatch.json' +// MEMBER-TRIPLE-MISMATCH-NEXT: reading Archive member from index '0' +// MEMBER-TRIPLE-MISMATCH-NEXT: expected 'arm64-apple-macosx' for field 'target_triple' but got 'x86_64-apple-macosx' + +// RUN: not clang-ssaf-format --type archive %S/Inputs/duplicate-member.json 2>&1 \ +// RUN: | FileCheck %s --match-full-lines --check-prefix=DUPLICATE-MEMBER +// DUPLICATE-MEMBER: clang-ssaf-format: error: reading Archive from file '{{.*}}duplicate-member.json' +// DUPLICATE-MEMBER-NEXT: failed to insert Archive member at index '1': encountered duplicate 'BuildNamespace(CompilationUnit, a.cpp)' diff --git a/clang/test/Analysis/Scalable/ssaf-format/Artifact/Inputs/rt-archive-empty.json b/clang/test/Analysis/Scalable/ssaf-format/Artifact/Inputs/rt-archive-empty.json new file mode 100644 index 0000000000000..79513109e8c5d --- /dev/null +++ b/clang/test/Analysis/Scalable/ssaf-format/Artifact/Inputs/rt-archive-empty.json @@ -0,0 +1,9 @@ +{ + "members": [], + "namespace": { + "kind": "Archive", + "name": "libempty" + }, + "target_triple": "arm64-apple-macosx", + "type": "Archive" +} diff --git a/clang/test/Analysis/Scalable/ssaf-format/Artifact/round-trip.test b/clang/test/Analysis/Scalable/ssaf-format/Artifact/round-trip.test index 4ddb233940afe..dc7a88a634d7a 100644 --- a/clang/test/Analysis/Scalable/ssaf-format/Artifact/round-trip.test +++ b/clang/test/Analysis/Scalable/ssaf-format/Artifact/round-trip.test @@ -38,3 +38,12 @@ // RUN: diff %S/Inputs/rt-lu-empty.json %t/rt-lu-empty-enc.json // RUN: clang-ssaf-format --type auto --encoding %S/Inputs/rt-lu-empty.json -o %t/rt-lu-empty-enc-explicit.json // RUN: diff %S/Inputs/rt-lu-empty.json %t/rt-lu-empty-enc-explicit.json + +// Archive appears only in the ArtifactEncoding variant (the archive tool +// and the linker pass member payloads through encoded), so it round-trips +// only via --encoding here. + +// RUN: clang-ssaf-format --encoding %S/Inputs/rt-archive-empty.json -o %t/rt-archive-empty-enc.json +// RUN: diff %S/Inputs/rt-archive-empty.json %t/rt-archive-empty-enc.json +// RUN: clang-ssaf-format --type auto --encoding %S/Inputs/rt-archive-empty.json -o %t/rt-archive-empty-enc-explicit.json +// RUN: diff %S/Inputs/rt-archive-empty.json %t/rt-archive-empty-enc-explicit.json diff --git a/clang/test/Analysis/Scalable/ssaf-format/Artifact/top-level.test b/clang/test/Analysis/Scalable/ssaf-format/Artifact/top-level.test index 904b1dffa7d7b..97e45ee54b41e 100644 --- a/clang/test/Analysis/Scalable/ssaf-format/Artifact/top-level.test +++ b/clang/test/Analysis/Scalable/ssaf-format/Artifact/top-level.test @@ -40,4 +40,4 @@ // RUN: not clang-ssaf-format --type auto --encoding %S/Inputs/unknown-type.json 2>&1 \ // RUN: | FileCheck %s --match-full-lines --check-prefix=ENCODING-UNKNOWN-TYPE // ENCODING-UNKNOWN-TYPE: clang-ssaf-format: error: reading ArtifactEncoding from file '{{.*}}unknown-type.json' -// ENCODING-UNKNOWN-TYPE-NEXT: unknown value 'Mystery' for field 'type': expected 'TUSummary', or 'LUSummary' +// ENCODING-UNKNOWN-TYPE-NEXT: unknown value 'Mystery' for field 'type': expected 'TUSummary', 'LUSummary', or 'Archive' diff --git a/clang/tools/clang-ssaf-format/SSAFFormat.cpp b/clang/tools/clang-ssaf-format/SSAFFormat.cpp index 9416b45c974b5..a9cacd5f769eb 100644 --- a/clang/tools/clang-ssaf-format/SSAFFormat.cpp +++ b/clang/tools/clang-ssaf-format/SSAFFormat.cpp @@ -11,6 +11,7 @@ // //===----------------------------------------------------------------------===// +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummaryEncoding.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" #include "clang/ScalableStaticAnalysis/Core/Serialization/JSONFormat.h" @@ -39,7 +40,7 @@ namespace { // Summary Type //===----------------------------------------------------------------------===// -enum class SummaryType { Auto, TU, LU, WPA }; +enum class SummaryType { Auto, TU, LU, Archive, WPA }; //===----------------------------------------------------------------------===// // Command-Line Options @@ -63,6 +64,8 @@ cl::opt<SummaryType> Type( "Detect type from the file's 'type' field"), clEnumValN(SummaryType::TU, "tu", "Translation unit summary"), clEnumValN(SummaryType::LU, "lu", "Link unit summary"), + clEnumValN(SummaryType::Archive, "archive", + "Archive of translation unit summaries"), clEnumValN(SummaryType::WPA, "wpa", "Whole-program analysis suite")), cl::init(SummaryType::Auto), cl::cat(SsafFormatCategory)); @@ -295,6 +298,12 @@ void convert(const FormatInput &FI) { &SerializationFormat::writeLUSummary); } return; + case SummaryType::Archive: + // Archive has only an encoded representation, so --encoding is a no-op + // here: both paths route to readArchive / writeArchive. + run(FI, &SerializationFormat::readArchive, + &SerializationFormat::writeArchive); + return; case SummaryType::WPA: run(FI, &SerializationFormat::readWPASuite, &SerializationFormat::writeWPASuite); diff --git a/clang/unittests/ScalableStaticAnalysis/ArchiveTest.cpp b/clang/unittests/ScalableStaticAnalysis/ArchiveTest.cpp new file mode 100644 index 0000000000000..37e2bf3fae765 --- /dev/null +++ b/clang/unittests/ScalableStaticAnalysis/ArchiveTest.cpp @@ -0,0 +1,32 @@ +//===- ArchiveTest.cpp ----------------------------------------------------===// +// +// 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 +// +//===----------------------------------------------------------------------===// + +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h" +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" +#include "clang/ScalableStaticAnalysis/Core/Model/BuildNamespace.h" +#include "gtest/gtest.h" + +namespace clang::ssaf { +namespace { + +TEST(ArchiveTest, GetNamespace) { + BuildNamespace BN(BuildNamespaceKind::Archive, "libfoo"); + Archive A(llvm::Triple("arm64-apple-macosx"), BN); + + EXPECT_EQ(A.getNamespace(), BN); +} + +TEST(ArchiveTest, GetTargetTriple) { + llvm::Triple T("arm64-apple-macosx"); + Archive A(T, BuildNamespace(BuildNamespaceKind::Archive, "libfoo")); + + EXPECT_EQ(A.getTargetTriple(), T); +} + +} // namespace +} // namespace clang::ssaf diff --git a/clang/unittests/ScalableStaticAnalysis/BuildNamespaceTest.cpp b/clang/unittests/ScalableStaticAnalysis/BuildNamespaceTest.cpp index e98efd45ea6b0..7910ace07c3bb 100644 --- a/clang/unittests/ScalableStaticAnalysis/BuildNamespaceTest.cpp +++ b/clang/unittests/ScalableStaticAnalysis/BuildNamespaceTest.cpp @@ -83,6 +83,7 @@ TEST(BuildNamespaceKindTest, FormatProvider) { "CompilationUnit"); EXPECT_EQ(llvm::formatv("{0}", BuildNamespaceKind::LinkUnit).str(), "LinkUnit"); + EXPECT_EQ(llvm::formatv("{0}", BuildNamespaceKind::Archive).str(), "Archive"); } TEST(BuildNamespaceKindTest, StreamOutputCompilationUnit) { @@ -97,6 +98,12 @@ TEST(BuildNamespaceKindTest, StreamOutputLinkUnit) { EXPECT_EQ(S, "LinkUnit"); } +TEST(BuildNamespaceKindTest, StreamOutputArchive) { + std::string S; + llvm::raw_string_ostream(S) << BuildNamespaceKind::Archive; + EXPECT_EQ(S, "Archive"); +} + TEST(BuildNamespaceTest, FormatProvider) { EXPECT_EQ( llvm::formatv("{0}", BuildNamespace(BuildNamespaceKind::CompilationUnit, diff --git a/clang/unittests/ScalableStaticAnalysis/CMakeLists.txt b/clang/unittests/ScalableStaticAnalysis/CMakeLists.txt index 387f03dc76fc6..a095434f14d54 100644 --- a/clang/unittests/ScalableStaticAnalysis/CMakeLists.txt +++ b/clang/unittests/ScalableStaticAnalysis/CMakeLists.txt @@ -4,6 +4,7 @@ add_distinct_clang_unittest(ClangScalableAnalysisTests Analyses/CallGraph/CallGraphExtractorTest.cpp Analyses/UnsafeBufferUsage/UnsafeBufferUsageTest.cpp Analyses/UnsafeBufferUsage/UnsafeBufferUsageWPATest.cpp + ArchiveTest.cpp ASTEntityMappingTest.cpp BuildNamespaceTest.cpp EntityIdTableTest.cpp diff --git a/clang/unittests/ScalableStaticAnalysis/Frontend/TUSummaryExtractorFrontendActionTest.cpp b/clang/unittests/ScalableStaticAnalysis/Frontend/TUSummaryExtractorFrontendActionTest.cpp index 2d65fb675eec3..8bf194af05930 100644 --- a/clang/unittests/ScalableStaticAnalysis/Frontend/TUSummaryExtractorFrontendActionTest.cpp +++ b/clang/unittests/ScalableStaticAnalysis/Frontend/TUSummaryExtractorFrontendActionTest.cpp @@ -98,6 +98,14 @@ class FailingSerializationFormat final : public SerializationFormat { return failing("writeLUSummaryEncoding"); } + llvm::Expected<Archive> readArchive(llvm::StringRef Path) override { + return failing("readArchive"); + } + + llvm::Error writeArchive(const Archive &A, llvm::StringRef Path) override { + return failing("writeArchive"); + } + llvm::Expected<WPASuite> readWPASuite(llvm::StringRef Path) override { return failing("readWPASuite"); } @@ -179,6 +187,12 @@ class CapturingSerializationFormat final : public SerializationFormat { llvm::StringRef) override { return llvm::Error::success(); } + llvm::Expected<Archive> readArchive(llvm::StringRef) override { + return llvm::createStringError("not implemented"); + } + llvm::Error writeArchive(const Archive &, llvm::StringRef) override { + return llvm::Error::success(); + } llvm::Expected<WPASuite> readWPASuite(llvm::StringRef) override { return llvm::createStringError("not implemented"); } diff --git a/clang/unittests/ScalableStaticAnalysis/ModelStringConversionsTest.cpp b/clang/unittests/ScalableStaticAnalysis/ModelStringConversionsTest.cpp index ff24a8358612d..ffb40e25305a9 100644 --- a/clang/unittests/ScalableStaticAnalysis/ModelStringConversionsTest.cpp +++ b/clang/unittests/ScalableStaticAnalysis/ModelStringConversionsTest.cpp @@ -27,6 +27,10 @@ TEST(BuildNamespaceKindStringTest, ToStringLinkUnit) { "LinkUnit"); } +TEST(BuildNamespaceKindStringTest, ToStringArchive) { + EXPECT_EQ(buildNamespaceKindToString(BuildNamespaceKind::Archive), "Archive"); +} + TEST(BuildNamespaceKindStringTest, FromStringCompilationUnit) { EXPECT_EQ(buildNamespaceKindFromString("CompilationUnit"), BuildNamespaceKind::CompilationUnit); @@ -37,9 +41,15 @@ TEST(BuildNamespaceKindStringTest, FromStringLinkUnit) { BuildNamespaceKind::LinkUnit); } +TEST(BuildNamespaceKindStringTest, FromStringArchive) { + EXPECT_EQ(buildNamespaceKindFromString("Archive"), + BuildNamespaceKind::Archive); +} + TEST(BuildNamespaceKindStringTest, FromStringUnknown) { EXPECT_EQ(buildNamespaceKindFromString("compilation_unit"), std::nullopt); EXPECT_EQ(buildNamespaceKindFromString("link_unit"), std::nullopt); + EXPECT_EQ(buildNamespaceKindFromString("archive"), std::nullopt); EXPECT_EQ(buildNamespaceKindFromString(""), std::nullopt); EXPECT_EQ(buildNamespaceKindFromString("unknown"), std::nullopt); } @@ -51,6 +61,9 @@ TEST(BuildNamespaceKindStringTest, RoundTrip) { EXPECT_EQ(buildNamespaceKindFromString( buildNamespaceKindToString(BuildNamespaceKind::LinkUnit)), BuildNamespaceKind::LinkUnit); + EXPECT_EQ(buildNamespaceKindFromString( + buildNamespaceKindToString(BuildNamespaceKind::Archive)), + BuildNamespaceKind::Archive); } //===----------------------------------------------------------------------===// diff --git a/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.cpp b/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.cpp index 915fe15af832c..256ec19d3decb 100644 --- a/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.cpp +++ b/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.cpp @@ -7,6 +7,7 @@ //===----------------------------------------------------------------------===// #include "Registries/MockSerializationFormat.h" +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummary.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummaryEncoding.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" @@ -198,6 +199,16 @@ llvm::Error MockSerializationFormat::writeLUSummaryEncoding( "MockSerializationFormat does not support LUSummaryEncoding"); } +llvm::Expected<Archive> +MockSerializationFormat::readArchive(llvm::StringRef Path) { + llvm_unreachable("MockSerializationFormat does not support Archive"); +} + +llvm::Error MockSerializationFormat::writeArchive(const Archive &A, + llvm::StringRef Path) { + llvm_unreachable("MockSerializationFormat does not support Archive"); +} + llvm::Expected<WPASuite> MockSerializationFormat::readWPASuite(llvm::StringRef Path) { llvm_unreachable("MockSerializationFormat does not support WPASuite"); diff --git a/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.h b/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.h index 2ecaab9fb0132..fbfc482582e44 100644 --- a/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.h +++ b/clang/unittests/ScalableStaticAnalysis/Registries/MockSerializationFormat.h @@ -44,6 +44,10 @@ class MockSerializationFormat final : public SerializationFormat { llvm::Error writeLUSummaryEncoding(const LUSummaryEncoding &SummaryEncoding, llvm::StringRef Path) override; + llvm::Expected<Archive> readArchive(llvm::StringRef Path) override; + + llvm::Error writeArchive(const Archive &A, llvm::StringRef Path) override; + llvm::Expected<Artifact> readArtifact(llvm::StringRef Path) override; llvm::Error writeArtifact(const Artifact &A, llvm::StringRef Path) override; diff --git a/clang/unittests/ScalableStaticAnalysis/TestFixture.h b/clang/unittests/ScalableStaticAnalysis/TestFixture.h index 22fbff754fb37..8c769277c193e 100644 --- a/clang/unittests/ScalableStaticAnalysis/TestFixture.h +++ b/clang/unittests/ScalableStaticAnalysis/TestFixture.h @@ -9,6 +9,7 @@ #ifndef LLVM_CLANG_UNITTESTS_SCALABLESTATICANALYSIS_TESTFIXTURE_H #define LLVM_CLANG_UNITTESTS_SCALABLESTATICANALYSIS_TESTFIXTURE_H +#include "clang/ScalableStaticAnalysis/Core/EntityLinker/Archive.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummary.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/LUSummaryEncoding.h" #include "clang/ScalableStaticAnalysis/Core/EntityLinker/TUSummaryEncoding.h" _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
