Test for YMMRegisters.

[ravitheja]

Summary

This patch contains test for reading YMM Registers. The test basically
contains an inferior that loads the ymm registers with a bit pattern
and the python test executes register read to check if the bit pattern
is correctly written in the registers. This test is repeated twice for
each register with a different pattern for better sanity.

[aprantl]

This test fails for me on an older MacPro without AVX instructions (https://everymac.com/systems/apple/mac_pro/specs/mac-pro-twelve-core-2.66-mid-2010-westmere-specs.html) is there a way to restrict this test to run on AVX systems only? E.g., can we restrict it to x86_64h?

[clayborg]

Detecting x86_64h might be tricky on different platforms. Two things I can think of: explicitly compile using x86_64h and when you try to run it it might fail. I believe that will work for Darwin, but not sure about other OSs (linux, Android). Mach-o has the x86_64h CPU type/subtyype, but I am not sure how ELF does this since they only really have the machine type and it isn't enough to represent x86_64h. The other way would be to start up the process (if it launches on all platforms) and look for a register by name that is only available if haswell support is available on the system. I believe all of our targets do correctly detect their AVX regs, so just stopping and looking for the register by name, and end the test as an expected failure or success if the register isn't available.

lldb/trunk/packages/Python/lldbsuite/test/functionalities/register/intel_avx/Makefile

+LEVEL = ../../../make
+
+C_SOURCES := main.c
+
+CFLAGS_EXTRAS ?= -g -O1
+
+include $(LEVEL)/Makefile.rules

lldb/trunk/packages/Python/lldbsuite/test/functionalities/register/intel_avx/TestYMMRegister.py

+"""
+Test that we correctly read the YMM registers.
+"""
+
+from __future__ import print_function
+
+
+import os
+import time
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+
+
+class TestYMMRegister(TestBase):
+    mydir = TestBase.compute_mydir(__file__)
+
+    @skipIfFreeBSD
+    @skipIfiOSSimulator
+    @skipIfTargetAndroid()
+    @skipIf(archs=no_match(['i386', 'x86_64']))
+    def test(self):
+        self.build()
+        self.setTearDownCleanup()
+
+        exe = os.path.join(os.getcwd(), "a.out")
+        target = self.dbg.CreateTarget(exe)
+
+        self.assertTrue(target, VALID_TARGET)
+
+        byte_pattern1 = 0x80
+        byte_pattern2 = 0xFF
+
+        # Launch the process and stop.
+        self.expect("run", PROCESS_STOPPED, substrs=['stopped'])
+
+        # Check stop reason; Should be either signal SIGTRAP or EXC_BREAKPOINT
+        output = self.res.GetOutput()
+        matched = False
+        substrs = [
+            'stop reason = EXC_BREAKPOINT',
+            'stop reason = signal SIGTRAP']
+        for str1 in substrs:
+            matched = output.find(str1) != -1
+            with recording(self, False) as sbuf:
+                print("%s sub string: %s" % ('Expecting', str1), file=sbuf)
+                print("Matched" if matched else "Not Matched", file=sbuf)
+            if matched:
+                break
+        self.assertTrue(matched, STOPPED_DUE_TO_SIGNAL)
+
+        if self.getArchitecture() == 'x86_64':
+            register_range = 16
+        else:
+            register_range = 8
+        for i in range(register_range):
+            self.runCmd("thread step-inst")
+
+            register_byte = (byte_pattern1 | i)
+            pattern = "ymm" + str(i) + " = " + str('{') + (
+                str(hex(register_byte)) + ' ') * 31 + str(hex(register_byte)) + str('}')
+
+            self.expect(
+                "register read ymm" + str(i),
+                substrs=[pattern])
+
+            register_byte = (byte_pattern2 | i)
+            pattern = "ymm" + str(i) + " = " + str('{') + (
+                str(hex(register_byte)) + ' ') * 31 + str(hex(register_byte)) + str('}')
+
+            self.runCmd("thread step-inst")
+            self.expect(
+                "register read ymm" + str(i),
+                substrs=[pattern])

lldb/trunk/packages/Python/lldbsuite/test/functionalities/register/intel_avx/main.c

+//===-- main.c ------------------------------------------------*- C -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+
+void func() {
+  unsigned int ymmvalues[16];
+  unsigned char val;
+  unsigned char i;
+  for (i = 0 ; i < 16 ; i++)
+  {
+    val = (0x80 | i);
+    ymmvalues[i] = (val << 24) | (val << 16) | (val << 8) | val;
+  }
+
+  unsigned int ymmallones = 0xFFFFFFFF;
+  __asm__("int3;"
+          "vbroadcastss %1, %%ymm0;"
+          "vbroadcastss %0, %%ymm0;"
+          "vbroadcastss %2, %%ymm1;"
+          "vbroadcastss %0, %%ymm1;"
+          "vbroadcastss %3, %%ymm2;"
+          "vbroadcastss %0, %%ymm2;"
+          "vbroadcastss %4, %%ymm3;"
+          "vbroadcastss %0, %%ymm3;"
+          "vbroadcastss %5, %%ymm4;"
+          "vbroadcastss %0, %%ymm4;"
+          "vbroadcastss %6, %%ymm5;"
+          "vbroadcastss %0, %%ymm5;"
+          "vbroadcastss %7, %%ymm6;"
+          "vbroadcastss %0, %%ymm6;"
+          "vbroadcastss %8, %%ymm7;"
+          "vbroadcastss %0, %%ymm7;"
+#if defined(__x86_64__)
+          "vbroadcastss %9, %%ymm8;"
+          "vbroadcastss %0, %%ymm8;"
+          "vbroadcastss %10, %%ymm9;"
+          "vbroadcastss %0, %%ymm9;"
+          "vbroadcastss %11, %%ymm10;"
+          "vbroadcastss %0, %%ymm10;"
+          "vbroadcastss %12, %%ymm11;"
+          "vbroadcastss %0, %%ymm11;"
+          "vbroadcastss %13, %%ymm12;"
+          "vbroadcastss %0, %%ymm12;"
+          "vbroadcastss %14, %%ymm13;"
+          "vbroadcastss %0, %%ymm13;"
+          "vbroadcastss %15, %%ymm14;"
+          "vbroadcastss %0, %%ymm14;"
+          "vbroadcastss %16, %%ymm15;"
+          "vbroadcastss %0, %%ymm15;"
+#endif
+          ::"m"(ymmallones),
+          "m"(ymmvalues[0]), "m"(ymmvalues[1]), "m"(ymmvalues[2]), "m"(ymmvalues[3]),
+          "m"(ymmvalues[4]), "m"(ymmvalues[5]), "m"(ymmvalues[6]), "m"(ymmvalues[7])
+#if defined(__x86_64__)
+          ,
+          "m"(ymmvalues[8]), "m"(ymmvalues[9]), "m"(ymmvalues[10]), "m"(ymmvalues[11]),
+          "m"(ymmvalues[12]), "m"(ymmvalues[13]), "m"(ymmvalues[14]), "m"(ymmvalues[15])
+#endif
+              );
+}
+
+int main(int argc, char const *argv[]) { func(); }