3539 build oneapi version 2024 incompatible for mkl #3573

christophe-murphy · 2024-07-16T21:24:02Z

Modifications and bug fixes to get the OneAPI backend working with Intel OneAPI version 2024.1 This has only been tested on Linux and not Windows.

Description

Several changes needed to be made to the CMake files to support OneAPI version 2024. Calls to the Sycl queue also needed to be modified to prevent nested submissions which are now unsupported.

A number of tests were failing and bugs were identified and fixed including the following:

In the wrap function the 4th dimension was not being wrapped
The reduce function was being called with an incorrect number of threads in certain circumstances
Half precision support check was erroneously indicating support for some devices

A number of functions are not supported on the OneAPI backend, a build option was added to skip tests for unsupported functions rather than failing.

Fixes: #3539

Changes to Users

Additional CMake build option: AF_SKIP_UNSUPPORTED_TESTS
This will cause tests unsupported by the backend to be skipped rather than fail

Checklist

[ x] Rebased on latest master
[ x] Code compiles
[ x] Tests pass
[ x] Functions added to unified API
[ x] Functions documented

…'t support compiling on Windows, this will be added later.

…o the SYCL queue which is not supported. This has been fixed by moving calls to get() out of the submit calls. If a get call is made to a node that has not yet been evaluated, it will need to submit work to the SYCL queue.

…current backend. If a function is not supported the test is skipped. This works with both the C API which returns an error flag and the C++ API which throws an exception.

… precision as well as the fp16 aspect for the oneAPI backend. Some devices advertise the fp16 aspect but their native vector width for half precision is zero which results in errors when calling OpenCL routines with half precision arguments.

…nested oneAPI queue submissions.

…re made to ireduceDimKernelSMEM for 1, 2 and 4 y threads

…missing from the global problem size.

…event segfaults in subsequent asserts.

…ailing when AF_SKIP_UNSUPPORTED_TESTS CMake option is enabled

…eDetermineCompilerSupport in version 3.30. Added support for this.

umar456 · 2024-12-17T18:08:52Z

test/testHelpers.hpp

+///
+/// \param[in]  CALL This is the arrayfire C++ function
+#ifdef SKIP_UNSUPPORTED_TESTS
+#define FUNCTION_UNSUPPORTED \


Not a fan of this approach to unsupported exceptions: Can you try using http://google.github.io/googletest/advanced.html#asserting-on-subroutines-with-an-exception

This should allow you to add a listener to catch these exceptions.

The documentation you linked to seems to be for turning a failed assert into an exception, not for listening for an exception but I will investigate more to see if we can do what you suggest.

umar456 · 2024-12-17T18:10:02Z

test/testHelpers.hpp

+static af_err CHECK_SUPPORTED_ERR_RETURN;
+#define CHECK_SUPPORTED(af_stat) \
+    if (af_stat == AF_ERR_NOT_SUPPORTED) \
+        GTEST_SKIP() << "Function not supported on this backend"


would be good to print the backend name.

I've looked into this and an error message with the back end name is generated in backend/common/err_common.cpp in the set_global_error_string function. However it is only printed if the AF_PRINT_ERRORS environment variable is set. Not sure the reason for this.

I also notice that in the ***_NOT_SUPPORTED macros a string is being passed called 'message' however this string is then assigned to the 'backend' member of the SupportError class. So when getBackendName() is called the 'message' is being returned instead of the back end name.

It is difficult to obtain the back end name at this point in the code, it seems that it is not exposed in the API. If a C++ exception is triggered it will print out the back end as part of the verbose error message when the AF_PRINT_ERRORS environment variable is set. For the C function you just get a AF_ERR_NOT_SUPPORTED returned from the function.

umar456 · 2024-12-17T18:26:07Z

test/medfilt.cpp

    //    4.0000        8.0000       12.0000       16.0000
-    array b = medfilt(a, 3, 3, AF_PAD_ZERO);
+    array b;
+    try { b = medfilt(a, 3, 3, AF_PAD_ZERO); } catch FUNCTION_UNSUPPORTED


These are examples in documentations. You should never put test related stuff in these types of code snippets.

umar456 · 2024-12-17T18:28:08Z

src/backend/oneapi/kernel/index.hpp

    blocks[0] *= threads[0];

    sycl::nd_range<3> marange(blocks, threads);
+    sycl::buffer<uint> *idxArrs_get[4];


Wouldn't this go out of scope when you call submit?

This is captured by the lambda function which is passed as an argument to submit.

umar456 · 2024-12-17T18:28:42Z

src/backend/oneapi/join.cpp

    if (second.isReady()) {
        if (1LL + jdim >= second.ndims() && second.isLinear()) {
            // second & out are linear
+            auto second_get = second.get();


You need better names here.

changed to "second_array", etc..

umar456 · 2024-12-17T18:30:58Z

CMakeModules/select_compute_arch.cmake

  set(CUDA_LIMIT_GPU_ARCHITECTURE "9.0")
 endif()

+if(CUDA_VERSION VERSION_GREATER_EQUAL "11.8")


Was any architecture removed during these releases?

Support for CC < 5.0 was removed in CUDA 12. I've updated the CUDA_ALL_GPU_ARCHITECTURES list.

…or CUDA 12

…s the back end name

…eptions. If the not supported exception is thrown, the test can be skipped if the AF_SKIP_UNSUPPORTED_TESTS variable is on.

… SKIP_BACKEND macro will be made instead that will need to be explicitly added to each test that calls a function unsupported for a given backend.

…e not supported by the oneAPI back end. If AF_SKIP_UNSUPPORTED_TESTS is set to ON then all tests with this macro will be skipped. These will need to be removed as oneAPI support is added for each feature.

…It is now used for the UNSUPPORTED_BACKEND macro.

christophe-murphy added 9 commits June 12, 2024 10:11

Updated cmake files to support oneAPI version 2024.1. Currently doesn…

920ad26

…'t support compiling on Windows, this will be added later.

Modify test cases to check if library functions are supported on the …

2e3de39

…current backend. If a function is not supported the test is skipped. This works with both the C API which returns an error flag and the C++ API which throws an exception.

Fix for bug in index function introduced when implementing a fix for …

4848dd3

…nested oneAPI queue submissions.

Fixed bug in irreduce_dim_launcher where incorrect templated calls we…

37277f8

…re made to ireduceDimKernelSMEM for 1, 2 and 4 y threads

Fix bug in wrap function where one dimension of the output array was …

3e41a4a

…missing from the global problem size.

Check for failure of asserts in apiWrapper and return from test to pr…

ecafd15

…event segfaults in subsequent asserts.

Modified ASSERT_SUCCESS macro to skip unsupported tests rather than f…

2db0b33

…ailing when AF_SKIP_UNSUPPORTED_TESTS CMake option is enabled

christophe-murphy linked an issue Jul 16, 2024 that may be closed by this pull request

[Build] OneAPI version 2024 incompatible for MKL #3539

Closed

edwinsolisf and others added 2 commits September 30, 2024 10:09

Fixed cmake policy issue for oneapi fix (#3569)

d374808

Cmake function CMakeDetermineCompileFeatures has been changed to CMak…

7b57fa8

…eDetermineCompilerSupport in version 3.30. Added support for this.

umar456 requested changes Dec 17, 2024

View reviewed changes

christophe-murphy added 6 commits December 17, 2024 16:04

Removed unsupported compute capabilites from all architectures list f…

96569d5

…or CUDA 12

Rename variables for input and output arrays of join method

6a42d24

Fix issue where NOT_SUPPORTED errors were storing the error message a…

3c14855

…s the back end name

Added macro for asserting success of C++ API functions that throw exc…

23ab660

…eptions. If the not supported exception is thrown, the test can be skipped if the AF_SKIP_UNSUPPORTED_TESTS variable is on.

Remove macros that check for unsupported exceptions and skip tests. A…

ce3aa62

… SKIP_BACKEND macro will be made instead that will need to be explicitly added to each test that calls a function unsupported for a given backend.

The UNSUPPORTED_BACKEND macro has now been added to all tests that ar…

cd2828e

…e not supported by the oneAPI back end. If AF_SKIP_UNSUPPORTED_TESTS is set to ON then all tests with this macro will be skipped. These will need to be removed as oneAPI support is added for each feature.

This was referenced Feb 5, 2025

CMake fixes for building ArrayFire oneAPI backend in windows #3610

Closed

Additional oneAPI fixes required for windows build #3634

Closed

melonakos added this to the 3.10 milestone Feb 5, 2025

Update getBackendName test helper function to support all back ends. …

15902c7

…It is now used for the UNSUPPORTED_BACKEND macro.

umar456 approved these changes Feb 12, 2025

View reviewed changes

christophe-murphy merged commit b1e85d3 into master Feb 13, 2025
2 of 4 checks passed

3539 build oneapi version 2024 incompatible for mkl #3573

3539 build oneapi version 2024 incompatible for mkl #3573

Uh oh!

Conversation

christophe-murphy commented Jul 16, 2024

Description

Changes to Users

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christophe-murphy Dec 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

christophe-murphy Dec 19, 2024 •

edited

Loading