Make the compose and join functions in the EdgeFunction implementatio…

…ns optional, if the IDETabulkationProblem impl provides extend and combine
secure-software-engineering · Oct 21, 2024 · cad8c02 · cad8c02
1 parent c1a75ed
commit cad8c02
Show file tree

Hide file tree

Showing 4 changed files with 101 additions and 43 deletions.
diff --git a/include/phasar/DataFlow/IfdsIde/EdgeFunction.h b/include/phasar/DataFlow/IfdsIde/EdgeFunction.h
@@ -12,6 +12,7 @@
 
 #include "phasar/DataFlow/IfdsIde/EdgeFunctionSingletonCache.h"
 #include "phasar/Utils/ByRef.h"
+#include "phasar/Utils/ErrorFwd.h"
 #include "phasar/Utils/TypeTraits.h"
 
 #include "llvm/ADT/DenseMapInfo.h"
@@ -41,28 +42,48 @@ template <typename T, typename = void>
 struct IsEdgeFunction : std::false_type {};
 template <typename T>
 struct IsEdgeFunction<
-    T, std::void_t<
-           typename T::l_t,
-           decltype(std::declval<const T &>().computeTarget(
-               std::declval<typename T::l_t>())),
-           decltype(T::compose(std::declval<EdgeFunctionRef<T>>(),
-                               std::declval<EdgeFunction<typename T::l_t>>())),
-           decltype(T::join(std::declval<EdgeFunctionRef<T>>(),
-                            std::declval<EdgeFunction<typename T::l_t>>()))>>
+    T, std::void_t<typename T::l_t,
+                   decltype(std::declval<const T &>().computeTarget(
+                       std::declval<typename T::l_t>()))>> : std::true_type {};
+
+template <typename T, typename = void> struct HasEFCompose : std::false_type {};
+template <typename T>
+struct HasEFCompose<T, std::void_t<decltype(T::compose(
+                           std::declval<EdgeFunctionRef<T>>(),
+                           std::declval<EdgeFunction<typename T::l_t>>()))>>
     : std::true_type {};
 
+template <typename T, typename = void> struct HasEFJoin : std::false_type {};
+template <typename T>
+struct HasEFJoin<T, std::void_t<decltype(T::join(
+                        std::declval<EdgeFunctionRef<T>>(),
+                        std::declval<EdgeFunction<typename T::l_t>>()))>>
+    : std::true_type {};
 } // namespace detail
 template <typename T>
 static constexpr bool IsEdgeFunction = detail::IsEdgeFunction<T>::value;
+template <typename T>
+static constexpr bool HasEFCompose = detail::HasEFCompose<T>::value;
+template <typename T>
+static constexpr bool HasEFJoin = detail::HasEFJoin<T>::value;
 
 #else
 // clang-format off
 template <typename T>
-concept IsEdgeFunction = requires(const T &EF, const EdgeFunction<typename T::l_t>& TEEF, EdgeFunctionRef<T> CEF, typename T::l_t Src) {
+concept IsEdgeFunction = requires(const T &EF, typename T::l_t Src) {
   typename T::l_t;
   {EF.computeTarget(Src)}   -> std::convertible_to<typename T::l_t>;
-  {T::compose(CEF, TEEF)}  -> std::same_as<EdgeFunction<typename T::l_t>>;
-  {T::join(CEF, TEEF)}     -> std::same_as<EdgeFunction<typename T::l_t>>;
+};
+
+template <typename T>
+concept HasEFCompose = requires(EdgeFunctionRef<T> EFRef,
+                                const EdgeFunction<typename T::l_t> &EF) {
+  { T::compose(EFRef, EF) } -> std::convertible_to<EdgeFunction<T::l_t>>;
+};
+template <typename T>
+concept HasEFJoin = requires(EdgeFunctionRef<T> EFRef,
+                                const EdgeFunction<typename T::l_t> &EF) {
+  { T::join(EFRef, EF) } -> std::convertible_to<EdgeFunction<T::l_t>>;
 };
   // clang-format on
 
@@ -700,17 +721,28 @@ class [[clang::trivial_abi]] EdgeFunction final : EdgeFunctionBase {
         return getPtr<ConcreteEF>(EF)->computeTarget(Source);
       },
       [](const void *EF, const EdgeFunction &SecondEF,
-         AllocationPolicy Policy) {
-        return ConcreteEF::compose(
-            EdgeFunctionRef<ConcreteEF>(
-                EF, Policy == AllocationPolicy::CustomHeapAllocated),
-            SecondEF);
+         AllocationPolicy Policy) -> EdgeFunction {
+        if constexpr (HasEFCompose<ConcreteEF>) {
+          return ConcreteEF::compose(
+              EdgeFunctionRef<ConcreteEF>(
+                  EF, Policy == AllocationPolicy::CustomHeapAllocated),
+              SecondEF);
+        } else {
+          composeEFPureVirtualError(llvm::getTypeName<ConcreteEF>(),
+                                    llvm::getTypeName<l_t>());
+        }
       },
-      [](const void *EF, const EdgeFunction &OtherEF, AllocationPolicy Policy) {
-        return ConcreteEF::join(
-            EdgeFunctionRef<ConcreteEF>(
-                EF, Policy == AllocationPolicy::CustomHeapAllocated),
-            OtherEF);
+      [](const void *EF, const EdgeFunction &OtherEF,
+         AllocationPolicy Policy) -> EdgeFunction {
+        if constexpr (HasEFJoin<ConcreteEF>) {
+          return ConcreteEF::join(
+              EdgeFunctionRef<ConcreteEF>(
+                  EF, Policy == AllocationPolicy::CustomHeapAllocated),
+              OtherEF);
+        } else {
+          joinEFPureVirtualError(llvm::getTypeName<ConcreteEF>(),
+                                 llvm::getTypeName<l_t>());
+        }
       },
       [](const void *EF1, const void *EF2) noexcept {
         static_assert(IsEqualityComparable<ConcreteEF> ||

diff --git a/include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEInstInteractionAnalysis.h b/include/phasar/PhasarLLVM/DataFlow/IfdsIde/Problems/IDEInstInteractionAnalysis.h
@@ -950,17 +950,6 @@ class IDEInstInteractionAnalysisT
 
     l_t computeTarget(ByConstRef<l_t> /* Src */) const { return Replacement; }
 
-    static EdgeFunction<l_t>
-    compose(EdgeFunctionRef<IIAAKillOrReplaceEF> /*This*/,
-            const EdgeFunction<l_t> /*SecondFunction*/) {
-      llvm::report_fatal_error("Implemented in 'extend'");
-    }
-
-    static EdgeFunction<l_t> join(EdgeFunctionRef<IIAAKillOrReplaceEF> /*This*/,
-                                  const EdgeFunction<l_t> & /*OtherFunction*/) {
-      llvm::report_fatal_error("Implemented in 'combine'");
-    }
-
     bool operator==(const IIAAKillOrReplaceEF &Other) const noexcept {
       return Replacement == Other.Replacement;
     }
@@ -1001,17 +990,6 @@ class IDEInstInteractionAnalysisT
       return IDEInstInteractionAnalysisT::joinImpl(Src, Data);
     }
 
-    static EdgeFunction<l_t>
-    compose(EdgeFunctionRef<IIAAAddLabelsEF> /*This*/,
-            const EdgeFunction<l_t> & /*SecondFunction*/) {
-      llvm::report_fatal_error("Implemented in 'extend'");
-    }
-
-    static EdgeFunction<l_t> join(EdgeFunctionRef<IIAAAddLabelsEF> /*This*/,
-                                  const EdgeFunction<l_t> & /*OtherFunction*/) {
-      llvm::report_fatal_error("Implemented in 'combine'");
-    }
-
     bool operator==(const IIAAAddLabelsEF &Other) const noexcept {
       return Data == Other.Data;
     }

diff --git a/include/phasar/Utils/ErrorFwd.h b/include/phasar/Utils/ErrorFwd.h
@@ -0,0 +1,22 @@
+/******************************************************************************
+ * Copyright (c) 2024 Fabian Schiebel.
+ * All rights reserved. This program and the accompanying materials are made
+ * available under the terms of LICENSE.txt.
+ *
+ * Contributors:
+ *     Fabian Schiebel and others
+ *****************************************************************************/
+
+#ifndef PHASAR_UTILS_ERRORFWD_H
+#define PHASAR_UTILS_ERRORFWD_H
+
+#include "llvm/ADT/StringRef.h"
+
+namespace psr {
+[[noreturn, gnu::cold]] void
+composeEFPureVirtualError(llvm::StringRef ConcreteEF, llvm::StringRef L);
+[[noreturn, gnu::cold]] void joinEFPureVirtualError(llvm::StringRef ConcreteEF,
+                                                    llvm::StringRef L);
+} // namespace psr
+
+#endif // PHASAR_UTILS_ERRORFWD_H
diff --git a/lib/Utils/ErrorFwd.cpp b/lib/Utils/ErrorFwd.cpp
@@ -0,0 +1,26 @@
+#include "phasar/Utils/ErrorFwd.h"
+
+#include "llvm/ADT/Twine.h"
+#include "llvm/Support/ErrorHandling.h"
+
+void psr::composeEFPureVirtualError(llvm::StringRef ConcreteEF,
+                                    llvm::StringRef L) {
+  llvm::report_fatal_error(
+      "EdgeFunction composition is not implemented for " + ConcreteEF +
+      "; Either implement static EdgeFunction<" + L +
+      "> compose(const EdgeFunctionRef<" + ConcreteEF +
+      ">, const EdgeFunction<" + L + ">&) in " + ConcreteEF +
+      ", or override EdgeFunction<" + L + "> extend(const EdgeFunction<" + L +
+      ">&, const EdgeFunction<" + L + ">&) in your IDETabulationProblem");
+}
+
+void psr::joinEFPureVirtualError(llvm::StringRef ConcreteEF,
+                                 llvm::StringRef L) {
+  llvm::report_fatal_error(
+      "EdgeFunction join is not implemented for " + ConcreteEF +
+      "; Either implement static EdgeFunction<" + L +
+      "> join(const EdgeFunctionRef<" + ConcreteEF + ">, const EdgeFunction<" +
+      L + ">&) in " + ConcreteEF + ", or override EdgeFunction<" + L +
+      "> combine(const EdgeFunction<" + L + ">&, const EdgeFunction<" + L +
+      ">&) in your IDETabulationProblem");
+}