[AIX][Test][ORC] Skip unsupported ORC C API tests on AIX

[hubert.reinterpretcast]

Summary

As mentioned before in D78813, currently the XCOFF backend does not support writing 64-bit object files, which the ORC JIT tests will try to exercise if we are on AIX. This patch disables the tests on AIX for now. This is consistent with what's been done, for example, regarding armv7.

[lhames]

Hi Hubert,

It would be better to just disable these tests on AIX for now. You can do that by extending the static bool isSupported(StringRef Triple) method to return false for AIX.

XCOFF backend does not support writing 64-bit object files...

Is there some other object format that the JIT should be selecting? Or is AIX not expected to produce JIT-linkable objects at all?

• Lang.

[hubert.reinterpretcast]

In D101971#2741103, @lhames wrote:

Hi Hubert,

It would be better to just disable these tests on AIX for now. You can do that by extending the static bool isSupported(StringRef Triple) method to return false for AIX.

Thanks. I'll update the patch to do this.

XCOFF backend does not support writing 64-bit object files...

Is there some other object format that the JIT should be selecting?

Not really. There's only XCOFF in its 32-bit and 64-bit variations. We're building LLVM as a 64-bit application, so I think XCOFF64 is the right object format to select.

Or is AIX not expected to produce JIT-linkable objects at all?

I'm not certain how capable it is at this time of producing JIT-linkable objects. We've been trying to enable functionality for building C/C++ applications using Clang on AIX (which we had set up to call out to the system assembler). The direct object code generation started out with XCOFF32 and we ended up building that out further and further without getting to the XCOFF64 side.

• Lang.

[hubert.reinterpretcast]

Address comments: Use isSupported

[lhames]

LGTM. Thanks Hubert!

llvm/unittests/ExecutionEngine/Orc/OrcCAPITest.cpp

 #include "llvm-c/Orc.h"
 #include "gtest/gtest.h"
 
 #include "llvm/ADT/Triple.h"
 #include <string>
 
 using namespace llvm;
 
+// Writing 64-bit XCOFF isn't supported yet, so we expect some tests to crash.
+#if defined(_AIX) && defined(__64BIT__)
+#define EXPECT_DEATH_ON_AIX_64BIT_THEN_SKIP(...)                               \
+  do {                                                                         \
+    EXPECT_DEATH(__VA_ARGS__);                                                 \
+    return;                                                                    \
+  } while (false)
+#else
+#define EXPECT_DEATH_ON_AIX_64BIT_THEN_SKIP(statement, regex) (statement)
+#endif
+
 // OrcCAPITestBase contains several helper methods and pointers for unit tests
 // written for the LLVM-C API. It provides the following helpers:
 //
 // 1. Jit: an LLVMOrcLLJIT instance which is freed upon test exit
 // 2. ExecutionSession: the LLVMOrcExecutionSession for the JIT
 // 3. MainDylib: the main JITDylib for the LLJIT instance
 // 4. materializationUnitFn: function pointer to an empty function, used for
 //                           materialization unit testing
TEST_F(OrcCAPITestBase, ResourceTrackerDefinitionLifetime) {
   // removed.
   LLVMOrcResourceTrackerRef RT =
       LLVMOrcJITDylibCreateResourceTracker(MainDylib);
   LLVMOrcThreadSafeModuleRef TSM = createTestModule();
   if (LLVMErrorRef E = LLVMOrcLLJITAddLLVMIRModuleWithRT(Jit, RT, TSM))
     FAIL() << "Failed to add LLVM IR module to LLJIT (triple = " << TargetTriple
            << "): " << toString(E);
   LLVMOrcJITTargetAddress TestFnAddr;
-  if (LLVMErrorRef E = LLVMOrcLLJITLookup(Jit, &TestFnAddr, "sum"))
-    FAIL() << "Symbol \"sum\" was not added into JIT (triple = " << TargetTriple
-           << "): " << toString(E);
+  {
+    LLVMErrorRef E = nullptr;
+    EXPECT_DEATH_ON_AIX_64BIT_THEN_SKIP(
+        E = LLVMOrcLLJITLookup(Jit, &TestFnAddr, "sum"),
+        "64-bit XCOFF object files are not supported yet");
+    if (E)
+      FAIL() << "Symbol \"sum\" was not added into JIT (triple = "
+             << TargetTriple << "): " << toString(E);
+  }
   ASSERT_TRUE(!!TestFnAddr);
   LLVMOrcResourceTrackerRemove(RT);
   LLVMOrcJITTargetAddress OutAddr;
   LLVMErrorRef Err = LLVMOrcLLJITLookup(Jit, &OutAddr, "sum");
   ASSERT_TRUE(Err);
   LLVMConsumeError(Err);
 
   ASSERT_FALSE(OutAddr);
LLVMOrcResourceTrackerRef DefaultRT =
       LLVMOrcJITDylibGetDefaultResourceTracker(MainDylib);
   LLVMOrcResourceTrackerRef RT2 =
       LLVMOrcJITDylibCreateResourceTracker(MainDylib);
   LLVMOrcThreadSafeModuleRef TSM = createTestModule();
   if (LLVMErrorRef E = LLVMOrcLLJITAddLLVMIRModuleWithRT(Jit, DefaultRT, TSM))
     FAIL() << "Failed to add LLVM IR module to LLJIT (triple = " << TargetTriple
            << "): " << toString(E);
   LLVMOrcJITTargetAddress Addr;
-  if (LLVMErrorRef E = LLVMOrcLLJITLookup(Jit, &Addr, "sum"))
-    FAIL() << "Symbol \"sum\" was not added into JIT (triple = " << TargetTriple
-           << "): " << toString(E);
+  {
+    LLVMErrorRef E = nullptr;
+    EXPECT_DEATH_ON_AIX_64BIT_THEN_SKIP(
+        E = LLVMOrcLLJITLookup(Jit, &Addr, "sum"),
+        "64-bit XCOFF object files are not supported yet");
+    if (E)
+      FAIL() << "Symbol \"sum\" was not added into JIT (triple = "
+             << TargetTriple << "): " << toString(E);
+  }
   LLVMOrcResourceTrackerTransferTo(DefaultRT, RT2);
   LLVMErrorRef Err = LLVMOrcLLJITLookup(Jit, &Addr, "sum");
   ASSERT_FALSE(Err);
   LLVMOrcReleaseResourceTracker(RT2);
 }
 
 TEST_F(OrcCAPITestBase, ExecutionTest) {
   if (!Jit) {
     // TODO: Use GTEST_SKIP() when GTest is updated to version 1.10.0
     return;
   }
 
   using SumFunctionType = int32_t (*)(int32_t, int32_t);
 
   // This test performs OrcJIT compilation of a simple sum module
   LLVMInitializeNativeAsmPrinter();
   LLVMOrcThreadSafeModuleRef TSM = createTestModule();
   if (LLVMErrorRef E = LLVMOrcLLJITAddLLVMIRModule(Jit, MainDylib, TSM))
     FAIL() << "Failed to add LLVM IR module to LLJIT (triple = " << TargetTriple
            << ")" << toString(E);
   LLVMOrcJITTargetAddress TestFnAddr;
-  if (LLVMErrorRef E = LLVMOrcLLJITLookup(Jit, &TestFnAddr, "sum"))
-    FAIL() << "Symbol \"sum\" was not added into JIT (triple = " << TargetTriple
-           << "): " << toString(E);
+  {
+    LLVMErrorRef E = nullptr;
+    EXPECT_DEATH_ON_AIX_64BIT_THEN_SKIP(
+        E = LLVMOrcLLJITLookup(Jit, &TestFnAddr, "sum"),
+        "64-bit XCOFF object files are not supported yet");
+    if (E)
+      FAIL() << "Symbol \"sum\" was not added into JIT (triple = "
+             << TargetTriple << "): " << toString(E);
+  }
   auto *SumFn = (SumFunctionType)(TestFnAddr);
   int32_t Result = SumFn(1, 1);
   ASSERT_EQ(2, Result);
 }