[llvm-exegesis] Add an AArch64 target

[john.brawn]

Summary

The target does just enough to be able to run llvm-exegesis in latency mode for at least some opcodes.

[courbet]

Nice ! Can you please create an LLVMExegesisAArch64Test library in unittests/tools/llvm-exegesis/AArch64 with a Target.cpp test similar to what's in unittests/tools/llvm_exegesis/X86/Target.cpp ?

[john.brawn]

Add a simple unit test.

[bjope]

Can't build unittests (I suspect this patch):

ninja: Entering directory `build-all'
[1/5] Preparing lit tests
[2/5] Linking CXX executable unittests/Target/AArch64/AArch64Tests
[3/5] Building CXX object unittests/tools/llvm-exegesis/AArch64/CMakeFiles/LLVMExegesisAArch64Tests.dir/TargetTest.cpp.o
FAILED: unittests/tools/llvm-exegesis/AArch64/CMakeFiles/LLVMExegesisAArch64Tests.dir/TargetTest.cpp.o 
/repo/app/clang/3.6/bin/clang++  -march=corei7  -DGTEST_HAS_RTTI=0 -DGTEST_HAS_TR1_TUPLE=0 -DGTEST_LANG_CXX11=1 -D_DEBUG -D_GNU_SOURCE -D__STDC_CONSTANT_MACROS -D__STDC_FORMAT_MACROS -D__STDC_LIMIT_MACROS -Iunittests/tools/llvm-exegesis/AAr h64 -I../unittests/tools/llvm-exegesis/AArch64 -I/usr/include/libxml2 -Iinclude -I../include -I../tools/llvm-exegesis/lib -I../utils/unittest/googletest/include -I../utils/unittest/googlemock/include -I../lib/Target/AArch64 -Ilib/Target/AAr h64 -fPIC -fvisibility-inlines-hidden -Werror -Werror=date-time -std=c++11 -Wall -Wextra -Wno-unused-parameter -Wwrite-strings -Wcast-qual -Wmissing-field-initializers -pedantic -Wno-long-long -Wcovered-switch-default -Wnon-virtual-dtor -Wd lete-non-virtual-dtor -Wstring-conversion -fdiagnostics-color -ffunction-sections -fdata-sections -O3    -UNDEBUG  -Wno-variadic-macros -Wno-gnu-zero-variadic-macro-arguments -fno-exceptions -fno-rtti -MMD -MT unittests/tools/llvm-exegesis/ Arch64/CMakeFiles/LLVMExegesisAArch64Tests.dir/TargetTest.cpp.o -MF unittests/tools/llvm-exegesis/AArch64/CMakeFiles/LLVMExegesisAArch64Tests.dir/TargetTest.cpp.o.d -o unittests/tools/llvm-exegesis/AArch64/CMakeFiles/LLVMExegesisAArch64Test .dir/TargetTest.cpp.o -c ../unittests/tools/llvm-exegesis/AArch64/TargetTest.cpp
../unittests/tools/llvm-exegesis/AArch64/TargetTest.cpp:33:65: error: too few arguments to function call, expected 2, have 1
  const auto Insts = Target_->setRegToConstant(llvm::AArch64::X0);
                     ~~~~~~~~~~~~~~~~~~~~~~~~~                  ^
../tools/llvm-exegesis/lib/Target.h:37:3: note: 'setRegToConstant' declared here
  virtual std::vector<llvm::MCInst>
  ^
1 error generated.

[john.brawn]

Fixed in r336188.

John

[bjope]

In D48780#1150658, @john.brawn wrote:

Fixed in r336188.

John

Great! Thanks alot for the quick fix!

tools/llvm-exegesis/lib/AArch64/CMakeLists.txt

+include_directories(
+  ${LLVM_MAIN_SRC_DIR}/lib/Target/AArch64
+  ${LLVM_BINARY_DIR}/lib/Target/AArch64
+  )
+
+add_library(LLVMExegesisAArch64
+  STATIC
+  Target.cpp
+  )
+
+llvm_update_compile_flags(LLVMExegesisAArch64)
+llvm_map_components_to_libnames(libs
+  AArch64
+  Exegesis
+  )
+
+target_link_libraries(LLVMExegesisAArch64 ${libs})
+set_target_properties(LLVMExegesisAArch64 PROPERTIES FOLDER "Libraries")

tools/llvm-exegesis/lib/AArch64/LLVMBuild.txt

+;===- ./tools/llvm-exegesis/lib/AArch64/LLVMBuild.txt ----------*- Conf -*--===;
+;
+;                     The LLVM Compiler Infrastructure
+;
+; This file is distributed under the University of Illinois Open Source
+; License. See LICENSE.TXT for details.
+;
+;===------------------------------------------------------------------------===;
+;
+; This is an LLVMBuild description file for the components in this subdirectory.
+;
+; For more information on the LLVMBuild system, please see:
+;
+;   http://llvm.org/docs/LLVMBuild.html
+;
+;===------------------------------------------------------------------------===;
+
+[component_0]
+type = Library
+name = ExegesisAArch64
+parent = Libraries
+required_libraries = AArch64

tools/llvm-exegesis/lib/AArch64/Target.cpp

+//===-- Target.cpp ----------------------------------------------*- C++ -*-===//
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file is distributed under the University of Illinois Open Source
+// License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+#include "../Target.h"
+#include "../Latency.h"
+#include "AArch64.h"
+
+namespace exegesis {
+
+namespace {
+
+class AArch64LatencyBenchmarkRunner : public LatencyBenchmarkRunner {
+public:
+  AArch64LatencyBenchmarkRunner(const LLVMState &State)
+      : LatencyBenchmarkRunner(State) {}
+
+private:
+  const char *getCounterName() const override {
+    // All AArch64 subtargets have CPU_CYCLES as the cycle counter name
+    return "CPU_CYCLES";
+  }
+};
+
+class ExegesisAArch64Target : public ExegesisTarget {
+  bool matchesArch(llvm::Triple::ArchType Arch) const override {
+    return Arch == llvm::Triple::aarch64 || Arch == llvm::Triple::aarch64_be;
+  }
+  void addTargetSpecificPasses(llvm::PassManagerBase &PM) const override {
+    // Function return is a pseudo-instruction that needs to be expanded
+    PM.add(llvm::createAArch64ExpandPseudoPass());
+  }
+  std::unique_ptr<BenchmarkRunner>
+  createLatencyBenchmarkRunner(const LLVMState &State) const override {
+    return llvm::make_unique<AArch64LatencyBenchmarkRunner>(State);
+  }
+};
+
+} // namespace
+
+static ExegesisTarget *getTheExegesisAArch64Target() {
+  static ExegesisAArch64Target Target;
+  return &Target;
+}
+
+void InitializeAArch64ExegesisTarget() {
+  ExegesisTarget::registerTarget(getTheExegesisAArch64Target());
+}
+
+} // namespace exegesis

tools/llvm-exegesis/lib/CMakeLists.txt

 if (LLVM_TARGETS_TO_BUILD MATCHES "X86")
   add_subdirectory(X86)
   set(LLVM_EXEGESIS_TARGETS "${LLVM_EXEGESIS_TARGETS} X86" PARENT_SCOPE)
 endif()
+if (LLVM_TARGETS_TO_BUILD MATCHES "AArch64")
+  add_subdirectory(AArch64)
+  set(LLVM_EXEGESIS_TARGETS "${LLVM_EXEGESIS_TARGETS} AArch64" PARENT_SCOPE)
+endif()
 
 add_library(LLVMExegesis
   STATIC
   Analysis.cpp
   Assembler.cpp
   BenchmarkResult.cpp
   BenchmarkRunner.cpp
   Clustering.cpp

unittests/tools/llvm-exegesis/AArch64/CMakeLists.txt

+include_directories(
+  ${LLVM_MAIN_SRC_DIR}/lib/Target/AArch64
+  ${LLVM_BINARY_DIR}/lib/Target/AArch64
+  ${LLVM_MAIN_SRC_DIR}/tools/llvm-exegesis/lib
+  )
+
+set(LLVM_LINK_COMPONENTS
+  MC
+  MCParser
+  Object
+  Support
+  Symbolize
+  AArch64
+  )
+
+add_llvm_unittest(LLVMExegesisAArch64Tests
+  TargetTest.cpp
+  )
+target_link_libraries(LLVMExegesisAArch64Tests PRIVATE
+  LLVMExegesis
+  LLVMExegesisAArch64)

unittests/tools/llvm-exegesis/AArch64/TargetTest.cpp

+#include "Target.h"
+
+#include <cassert>
+#include <memory>
+
+#include "MCTargetDesc/AArch64MCTargetDesc.h"
+#include "gmock/gmock.h"
+#include "gtest/gtest.h"
+
+namespace exegesis {
+
+void InitializeAArch64ExegesisTarget();
+
+namespace {
+
+using testing::Gt;
+using testing::NotNull;
+using testing::SizeIs;
+
+class AArch64TargetTest : public ::testing::Test {
+protected:
+  AArch64TargetTest()
+      : Target_(ExegesisTarget::lookup(llvm::Triple("aarch64-unknown-linux"))) {
+    EXPECT_THAT(Target_, NotNull());
+  }
+  static void SetUpTestCase() { InitializeAArch64ExegesisTarget(); }
+
+  const ExegesisTarget *const Target_;
+};
+
+TEST_F(AArch64TargetTest, SetRegToConstant) {
+  // The AArch64 target currently doesn't know how to set register values
+  const auto Insts = Target_->setRegToConstant(llvm::AArch64::X0);
+  EXPECT_THAT(Insts, SizeIs(0));
+}
+
+} // namespace
+} // namespace exegesis

unittests/tools/llvm-exegesis/CMakeLists.txt

 target_link_libraries(LLVMExegesisTests PRIVATE LLVMExegesis)
 
 if(LLVM_TARGETS_TO_BUILD MATCHES "X86")
   add_subdirectory(X86)
 endif()
 if(LLVM_TARGETS_TO_BUILD MATCHES "ARM")
   add_subdirectory(ARM)
 endif()
+if(LLVM_TARGETS_TO_BUILD MATCHES "AArch64")
+  add_subdirectory(AArch64)
+endif()