[IntelJITListener] Generalize JIT listener test

[andrew.w.kaylor]

Summary

This change generalizes the checks to allow JIT notification of method load events to pass the test in any order. The order in which method load events are reported doesn't seem to be non-deterministic, but it isn't necessarily stable across versions. This change avoids fragility in the test.

Note that this test is only run if -DLLVM_USE_INTEL_JITEVENTS=ON is used in the CMake configuration.

This address Bugzilla 51859.

[lhames]

If the order is expected to be stable within a release then re-ordering to match the new expected order seems like a good option, since it alert you to any unexpected changes. I'm ok with this approach too though.

Thanks very much for looking into this Andy!

[h-vetinari]

I tested this patch in https://github.com/conda-forge/llvmdev-feedstock/pull/131 and it works as intended. Any blockers to landing it?

[andrew.w.kaylor]

Instead of generalizing the test, I re-ordered the checks to match what's currently happening. It appears to be stable and the test was broken by an explicit change to the object symbol ordering.

https://github.com/llvm/llvm-project/commit/e49c0c5100b992e1a18c7225bc147431089f560f

llvm/test/JitListener/multiple.ll

 ; Verify the behavior of the IntelJITEventListener.
-; RUN: llvm-jitlistener %s | FileCheck %s
+; As a workaround to avoid problems with list ordering in the notification
+; we run the test three times.
+; RUN: llvm-jitlistener %s | FileCheck --check-prefixes=CHECK-ALL,CHECK-FOO %s
+; RUN: llvm-jitlistener %s | FileCheck --check-prefixes=CHECK-ALL,CHECK-BAR %s
+; RUN: llvm-jitlistener %s | FileCheck --check-prefixes=CHECK-ALL,CHECK-FUBAR %s
 
 ; This test was created using the following file:
 ;
 ;  1: int foo(int a) {
 ;  2:   return a;
 ;  3: }
 ;  4:
 ;  5: int bar(int a) {

 ; 16:     case 1:
 ; 17:       return 20;
 ; 18:     default:
 ; 19:       return 30;
 ; 20:   }
 ; 21: }
 ;
 
-; CHECK: Method load [1]: bar, Size = {{[0-9]+}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
-
-; CHECK: Method load [2]: foo, Size = {{[0-9]+}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[1,2]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[1,2]}}
-
-; CHECK: Method load [3]: fubar, Size = {{[0-9]+}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
-; CHECK:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
-
-; CHECK: Method unload [1]
-; CHECK: Method unload [2]
-; CHECK: Method unload [3]
+; CHECK-BAR: Method load [{{[123]}}]: bar, Size = {{[0-9]+}}
+; CHECK-BAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
+; CHECK-BAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
+; CHECK-BAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
+; CHECK-BAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[5,6,7,9]}}
+
+; CHECK-FOO: Method load [{{[123]}}]: foo, Size = {{[0-9]+}}
+; CHECK-FOO-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[1,2]}}
+; CHECK-FOO-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[1,2]}}
+
+; CHECK-FUBAR: Method load [{{[123]}}]: fubar, Size = {{[0-9]+}}
+; CHECK-FUBAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
+; CHECK-FUBAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
+; CHECK-FUBAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
+; CHECK-FUBAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
+; CHECK-FUBAR-NEXT:   Line info @ {{[0-9]+}}: multiple.c, line {{[12,13,15,17,19]}}
+
+; CHECK-ALL: Method unload [1]
+; CHECK-ALL: Method unload [2]
+; CHECK-ALL: Method unload [3]
 
 ; ModuleID = 'multiple.c'
 
 ; Function Attrs: nounwind uwtable
 define i32 @foo(i32 %a) #0 !dbg !4 {
 entry:
   %a.addr = alloca i32, align 4
   store i32 %a, i32* %a.addr, align 4