[SYCL] Drop optimization level when merging properties (#19432)

Image properties are merged when images are linked. This merging
currently fails if some of the properties conflict with eachother. One
of the properties is the optimization level used when compiling the
binaries, which are used when compiling the images. However, since
linking uses compiled binaries, the optimization level has no effect on
the merged image. As such, this commit drops the property.

---------

Signed-off-by: Larsen, Steffen <[email protected]>

Author: steffenlarsen

sycl/source/detail/device_binary_image.cpp

@@ -280,16 +280,21 @@ naiveMergeBinaryProperties(const std::vector<const RTDeviceBinaryImage *> &Imgs,
 
 // Exclusive property merge logic. If IgnoreDuplicates is false it assumes there
 // are no cases where properties have different values and throws otherwise.
-template <typename RangeGetterT>
+template <typename RangeGetterT, typename DropPropertyT>
 static std::unordered_map<std::string_view, const sycl_device_binary_property>
 exclusiveMergeBinaryProperties(
     const std::vector<const RTDeviceBinaryImage *> &Imgs,
-    const RangeGetterT &RangeGetter, bool IgnoreDuplicates = false) {
+    const RangeGetterT &RangeGetter, bool IgnoreDuplicates,
+    const DropPropertyT &DropProperty) {
   std::unordered_map<std::string_view, const sycl_device_binary_property>
       MergeMap;
   for (const RTDeviceBinaryImage *Img : Imgs) {
     const RTDeviceBinaryImage::PropertyRange &Range = RangeGetter(*Img);
     for (const sycl_device_binary_property Prop : Range) {
+      // Skip adding the property if we can drop it.
+      if (DropProperty(std::string_view{Prop->Name}))
+        continue;
+
       const auto [It, Inserted] =
           MergeMap.try_emplace(std::string_view{Prop->Name}, Prop);
       if (IgnoreDuplicates || Inserted)
@@ -308,6 +313,17 @@ exclusiveMergeBinaryProperties(
   return MergeMap;
 }
 
+template <typename RangeGetterT,
+          typename DropPropertyT = std::function<bool(std::string_view)>>
+static std::unordered_map<std::string_view, const sycl_device_binary_property>
+exclusiveMergeBinaryProperties(
+    const std::vector<const RTDeviceBinaryImage *> &Imgs,
+    const RangeGetterT &RangeGetter, bool IgnoreDuplicates = false) {
+  return exclusiveMergeBinaryProperties(
+      Imgs, RangeGetter, IgnoreDuplicates,
+      /*DropProperty=*/[](std::string_view) { return false; });
+}
+
 // Device requirements needs the ability to produce new properties. The
 // information for these are kept in this struct.
 struct MergedDeviceRequirements {
@@ -549,10 +565,11 @@ DynRTDeviceBinaryImage::DynRTDeviceBinaryImage(
       Imgs,
       [](const RTDeviceBinaryImage &Img) { return Img.getImportedSymbols(); },
       /*IgnoreDuplicates=*/true);
-  auto MergedMisc =
-      exclusiveMergeBinaryProperties(Imgs, [](const RTDeviceBinaryImage &Img) {
-        return Img.getMiscProperties();
-      });
+  auto MergedMisc = exclusiveMergeBinaryProperties(
+      Imgs,
+      [](const RTDeviceBinaryImage &Img) { return Img.getMiscProperties(); },
+      /*IgnoreDuplicates=*/true, /*DropProperty=*/
+      [](std::string_view PropertyName) { return PropertyName == "optLevel"; });
 
   std::array<const std::unordered_map<std::string_view,
                                       const sycl_device_binary_property> *,

sycl/test-e2e/SYCLBIN/link_mixed_opt_input.cpp

@@ -0,0 +1,27 @@
+//==--------- link_mixed_opt_input.cpp --- SYCLBIN extension tests ---------==//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+// REQUIRES: aspect-usm_shared_allocations
+
+// -- Test for linking two SYCLBIN kernel_bundles with different optimization
+// -- levels.
+
+// ptxas currently fails to compile images with unresolved symbols. Disable for
+// other targets than SPIR-V until this has been resolved. (CMPLRLLVM-68810)
+// Note: %{sycl_target_opts} should be added to the SYCLBIN compilation lines
+// once fixed.
+// REQUIRES: target-spir
+
+// RUN: %clangxx --offload-new-driver -fsyclbin=input -fsycl-allow-device-image-dependencies -O0 %S/Inputs/exporting_function.cpp -o %t.export.syclbin
+// RUN: %clangxx --offload-new-driver -fsyclbin=input -fsycl-allow-device-image-dependencies -O1 %S/Inputs/importing_kernel.cpp -o %t.import.syclbin
+// RUN: %{build} -o %t.out
+// RUN: %{l0_leak_check} %{run}  %t.out %t.export.syclbin %t.import.syclbin
+
+#define SYCLBIN_INPUT_STATE
+
+#include "Inputs/link.hpp"

sycl/test-e2e/SYCLBIN/link_mixed_opt_object.cpp

@@ -0,0 +1,27 @@
+//==--------- link_mixed_opt_input.cpp --- SYCLBIN extension tests ---------==//
+//
+// 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
+//
+//===----------------------------------------------------------------------===//
+
+// REQUIRES: aspect-usm_shared_allocations
+
+// -- Test for linking two SYCLBIN kernel_bundle with different optimization
+// -- levels.
+
+// ptxas currently fails to compile images with unresolved symbols. Disable for
+// other targets than SPIR-V until this has been resolved. (CMPLRLLVM-68810)
+// Note: %{sycl_target_opts} should be added to the SYCLBIN compilation lines
+// once fixed.
+// REQUIRES: target-spir
+
+// RUN: %clangxx --offload-new-driver -fsyclbin=object -fsycl-allow-device-image-dependencies -O0 %S/Inputs/exporting_function.cpp -o %t.export.syclbin
+// RUN: %clangxx --offload-new-driver -fsyclbin=object -fsycl-allow-device-image-dependencies -O1 %S/Inputs/importing_kernel.cpp -o %t.import.syclbin
+// RUN: %{build} -o %t.out
+// RUN: %{l0_leak_check} %{run}  %t.out %t.export.syclbin %t.import.syclbin
+
+#define SYCLBIN_OBJECT_STATE
+
+#include "Inputs/link.hpp"