Run OMR on OpenJ9

[samasri]

• [x] Use the instructions to build OpenJ9 in Docker.
  • PS: If make failed: execute git checkout f66506e7a528340d176260c3af47c63cf66979ec inside openj9-openjdk-jdk9/openj9 and try again
• [x] Use Nazim's instructions of running BruteClang on OpenJ9 to get the OpenJ9 source file list that is supposed to be processed by OMRStatistics
• [x] Automate the process of getting this source file list by editing the OMRStatistics build system to automatically get the source file list from the OpenJ9 build system
• [x] Get list of includes and rest of configuration used in OMRChecker to use when running OMRStatistics
  • [x] Find all the required variables to be defined for OMRChecker to run independently from the whole build system
  • [x] Define these variables in the build system of OMRStatistics
  • [x] Run it on all archs
• [ ] Fix errors

[samasri]

In order to run OMRChecker, I will need to reproduce the configurations used to run OMRChecker. In linter.mk, we can see that OMRChecker depends on the following variables to run:

• CXX_CMD: This is probably clang++-5.0 in OMRStatistics
• LINTER_FLAGS: Defined in the same file
• LINTER_EXTRA: Defined in the same file
• CXX_INCLUDES: Depends on the following variable:
  • PRODUCT_INCLUDES: Defined in build/toolcfg/gnu/common.mk. Here we are assuming that the tool used (defined in TOOLCHAIN variable) is GNU, which stands aligned with our assumption that the OS used is linux
• CXX_DEFINES: Depends on the following variables:
  • CX_DEFINES: It is defined inside nested common.mk files. The right common.mk depends on the tool we are using (TOOLCHAIN). When using GNU, it would depend on the following:
    • PRODUCT_DEFINES: Depends on the following variables:
      • ASSUMES: Based on this makefile, I am assuming this should be 1.
      • PUBLIC_BUILD: I could not find any place where this variable is defined, so I am assuming this should be 0.
    • HOST_DEFINES and TARGET_DEFINES: Defined in makefiles inside the build/toocfg/host and build/toocfg/target directories respectively. These are automatically included from the main build/tooclfg/common.mk based on the following variables:
      • HOST_ARCH and TARGET_ARCH: Can be x, p, z, or arm
      • HOST_BITS and TARGET_BITS: Can be 32 or 64
      • OS: It represents the operating system used, for our purpose I think linux makes sense (can also be win, aix, zos, ztpf)
    • HOST_BITS and HOST_ARCH: already explained
    • BUILD_CONFIG: Can be either debug or prod
  • CX_DEFINES_EXTRA: Never defined in the project
  • CXX_DEFINES_EXTRA: Never defined in the project

Hence, in order to get the right variables for the configuration we need to do the following:

• include the build/tooclfg/common.mk (to import the needed variables):
• Define the following:
  • CXX_CMD=clang++-3.8
  • LINTER_FLAGS=-std=c++0x -w -fsyntax-only -ferror-limit=0
  • LINTER_EXTRA=-Xclang -load -Xclang $(JIT_SRCBASE)/omr/tools/compiler/OMRStatistics/OMRStatistics.so -Xclang -add-plugin -Xclang omr-statistics
  • TOOLCHAIN=gnu
  • ASSUMES=1
  • PUBLIC_BUILD=0
  • OS=linux
  • BUILD_CONFIG=prod
• Variables that we need to change to build on different archs:
  • HOST_ARCH
  • TARGET_ARCH
  • HOST_BITS=64 (I am gonna assume this for now)
  • TARGET_BITS=64 (I am gonna assume this for now)

[samasri]

After running OMRStatistics (almost) successfully on all architectures, I got 22 errors in total, documented here

[samasri]

When setting TARGET_BITS=32 on i386, the number of errors decreased to 19. Also, now the CodeGenerator hierarchy is processed successfully by OMRStatistics on all architectures. So I can now virtualize the CodeGenerator chain and submit my PR. However, I still need to fix the rest of the errors to have OMRStatistics fully working on OpenJ9