Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Handle new CPU enum types inside J9CPU.cpp #10390

Merged
merged 1 commit into from
Aug 19, 2020

Conversation

dchopra001
Copy link
Contributor

New CPU types were introduced in the OMRProcessArchitecture enum and OpenJ9 must be able to handle these new entries. Additionally, this PR also adds on to the J9::Z::CPU::applyUserOptions() routine by also updating _supportedArch when the CPU level is changed.

Signed-off-by: Dhruv Chopra <Dhruv.C.Chopra@ibm.com>
@fjeremic fjeremic self-assigned this Aug 14, 2020
@fjeremic
Copy link
Contributor

Jenkins test sanity zlinux jdk11

@fjeremic fjeremic added the depends:omr Pull request is dependent on a corresponding change in OMR label Aug 14, 2020
@fjeremic
Copy link
Contributor

fjeremic commented Aug 14, 2020

Depends on eclipse-omr/omr#5459. We'll need to wait for a promotion.

@dchopra001
Copy link
Contributor Author

@fjeremic I think this one depends on eclipse-omr/omr#5459

@fjeremic
Copy link
Contributor

Jenkins test sanity zlinux jdk11 depends eclipse-omr/omr#5459

Copy link
Contributor

@harryyu1994 harryyu1994 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I don't think you need the changes in applyUserOptions() at all.

@dchopra001
Copy link
Contributor Author

I only added the changes in applyUserOptions because I saw a failure in a test where we purposefully disable architectures to test support. I will try to reproduce it again. It looks like, as you are suggesting, the fix to that issue might be something else.

@dchopra001
Copy link
Contributor Author

dchopra001 commented Aug 17, 2020

Here are a few examples:

java"   -Xdump -Xjit:count=0,disableZ13 -version
Time spent starting: 1 milliseconds
Time spent executing: 390 milliseconds
Test result: FAILED
Output from test:
 [ERR] Assertion failed at /tmp/bld_453611/bld_linux_390-64_cmprssptrs/compiler/../omr/compiler/z/env/OMRCPU.cpp:117: self()->is_at_least_test(p)
 [ERR] 	processor z14(9) failed, _supportedArch z14(8), _processorDescription.processor zEC12(7)
java"   -Xdump -Xjit:count=0,disableZEC12 -version
Time spent starting: 1 milliseconds
Time spent executing: 338 milliseconds
Test result: FAILED
Output from test:
 [ERR] Assertion failed at /tmp/bld_453611/bld_linux_390-64_cmprssptrs/compiler/../omr/compiler/z/env/OMRCPU.cpp:117: self()->is_at_least_test(p)
 [ERR] 	processor z14(9) failed, _supportedArch z14(8), _processorDescription.processor z196(6)
java"   -Xdump -Xjit:count=0,disableZ196 -version
Time spent starting: 2 milliseconds
Time spent executing: 355 milliseconds
Test result: FAILED
Output from test:
 [ERR] Assertion failed at /tmp/bld_453611/bld_linux_390-64_cmprssptrs/compiler/../omr/compiler/z/env/OMRCPU.cpp:117: self()->is_at_least_test(p)
 [ERR] 	processor z14(9) failed, _supportedArch z14(8), _processorDescription.processor z10(5)

In all of these situations _supportedArch looks like it ignored the disableArch option.

@harryyu1994
Copy link
Contributor

If any update needs to be done for _supportedArch, they should be done in this function. Does this function do what is expected?

void
J9::Z::CPU::initializeS390ProcessorFeatures()
   {
   // The following nested if statements cascade so as to have the effect of only enabling the least common denominator
   // of disable CPU architectures. For example if the user specified to disable z13 when running on a z15 machine the
   // logic below will ensure we only reach the `setSupportsArch` call for zEC12.
   if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZ6() &&
         !TR::Options::getCmdLineOptions()->getOption(TR_DisableZ10))
      {
      TR::Compiler->target.cpu.setSupportsArch(TR::CPU::z10);

      if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZGryphon() &&
            !TR::Options::getCmdLineOptions()->getOption(TR_DisableZ196))
         {
         TR::Compiler->target.cpu.setSupportsArch(TR::CPU::z196);

         if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZHelix() &&
               !TR::Options::getCmdLineOptions()->getOption(TR_DisableZEC12))
            {
            TR::Compiler->target.cpu.setSupportsArch(TR::CPU::zEC12);

            if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZ13() &&
                  !TR::Options::getCmdLineOptions()->getOption(TR_DisableZ13))
               {
               TR::Compiler->target.cpu.setSupportsArch(TR::CPU::z13);

               if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZ14() &&
                     !TR::Options::getCmdLineOptions()->getOption(TR_DisableZ14))
                  {
                  TR::Compiler->target.cpu.setSupportsArch(TR::CPU::z14);

                  if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZ15() &&
                        !TR::Options::getCmdLineOptions()->getOption(TR_DisableZ15))
                     {
                     TR::Compiler->target.cpu.setSupportsArch(TR::CPU::z15);

                     if (TR::Compiler->target.cpu.TO_PORTLIB_get390_supportsZNext() &&
                           !TR::Options::getCmdLineOptions()->getOption(TR_DisableZNext))
                        {
                        TR::Compiler->target.cpu.setSupportsArch(TR::CPU::zNext);
                        }
                     }
                  }
               }
            }
         }
      }
....

@dchopra001
Copy link
Contributor Author

The backtrace for the above assert is as below:

(gdb) bt
#0  __GI_raise (sig=sig@entry=6) at ../sysdeps/unix/sysv/linux/raise.c:51
#1  0x000003fffdcbf37a in __GI_abort () at abort.c:79
#2  0x000003fff77ed6cc in TR::trap() () from /sandbox/dchopra/development/openj9-openjdk-jdk8/build/linux-s390x-normal-server-release/images/j2sdk-image/jre/lib/s390x/compressedrefs/libj9jit29.so
#3  0x000003fff77ed764 in TR::fatal_assertion(char const*, int, char const*, char const*, ...) () from /sandbox/dchopra/development/openj9-openjdk-jdk8/build/linux-s390x-normal-server-release/images/j2sdk-image/jre/lib/s390x/compressedrefs/libj9jit29.so
#4  0x000003fff7cb5d80 in OMR::Z::CPU::isAtLeast(OMRProcessorArchitecture) () from /sandbox/dchopra/development/openj9-openjdk-jdk8/build/linux-s390x-normal-server-release/images/j2sdk-image/jre/lib/s390x/compressedrefs/libj9jit29.so
#5  0x000003fff736c8b4 in TR_J9VM::initializeProcessorType() () from /sandbox/dchopra/development/openj9-openjdk-jdk8/build/linux-s390x-normal-server-release/images/j2sdk-image/jre/lib/s390x/compressedrefs/libj9jit29.so
#6  0x000003fff736c09e in TR_J9VMBase::initializeSystemProperties() () from /sandbox/dchopra/development/openj9-openjdk-jdk8/build/linux-s390x-normal-server-release/images/j2sdk-image/jre/lib/s390x/compressedrefs/libj9jit29.so

Looking at initializeProcessorType:

void
TR_J9VM::initializeProcessorType()
   {
   TR_ASSERT(_compInfo,"compInfo not defined");
   TR::Compiler->target.cpu.applyUserOptions();

   if (TR::Compiler->target.cpu.isZ())
      {
#if defined(TR_HOST_S390)
      initializeS390ProcessorFeatures();

#if defined(J9ZOS390)
      // Cache whether current process is running in Supervisor State (i.e. Control Region of WAS).
      if (!_isPSWInProblemState())
         _compInfo->setIsInZOSSupervisorState();
#endif
#endif

#ifdef TR_TARGET_S390
      // For AOT shared classes cache processor compatibility purposes, the following
      // processor settings should not be modified.
      if (TR::Compiler->target.cpu.isAtLeast(OMR_PROCESSOR_S390_ZNEXT))

So it looks like applyUserOptions, when invoked, should update support for the new implementation. And initializeS390ProcessorFeatures(), when invoked, should update support for the old implementation. And that is what I see when I added some tracing inside initializeS390ProcessorFeatures() as well. So it does look like it's doing the correct thing.

But then when we later call isAtLeast in this routine, the assert fires. So I'm not sure why this happens.

@harryyu1994
Copy link
Contributor

harryyu1994 commented Aug 17, 2020

So it looks like applyUserOptions, when invoked, should update support for the new implementation. And initializeS390ProcessorFeatures(), when invoked, should update support for the old implementation. And that is what I see when I added some tracing inside initializeS390ProcessorFeatures() as well. So it does look like it's doing the correct thing.

But then when we later call isAtLeast in this routine, the assert fires. So I'm not sure why this happens.

Just guessing here. You added initialization of _supportedArch in OMR::Z::CPU::CPU(const OMRProcessorDesc& processorDescription). And that constructor does not look at the DisableArch set of options when initializing _supportedArch

@harryyu1994
Copy link
Contributor

harryyu1994 commented Aug 17, 2020

Try this and see if the problem goes away:

#if defined(J9VM_OPT_JITSERVER)
   // In JITServer, we would like to use JITClient's processor info for the compilation
   // The following code effectively replaces the cpu with client's cpu through the getProcessorDescription() that has JITServer support
   if (self()->getPersistentInfo()->getRemoteCompilationMode() == JITServer::SERVER)
      {
      OMRProcessorDesc JITClientProcessorDesc = TR::Compiler->target.cpu.getProcessorDescription();
      _target.cpu = TR::CPU(JITClientProcessorDesc);
#if defined(TR_TARGET_S390)
     _target.cpu.initialzeS390ProcessorFeatures();
#endif
      }
   else
#endif /* defined(J9VM_OPT_JITSERVER) */

then remove the initialization of _supportedArch in OMR::Z::CPU::CPU() constructor, just give it a default z9

@harryyu1994
Copy link
Contributor

Sorry for the complications.. They wouldn't be here if we don't still have 2 implementations of processor detection. Hopefully I'll have time soon to get rid of the old implementation.

@dchopra001
Copy link
Contributor Author

It sounds like that might be the problem because OMR::Z::CPU::detect(OMRPortLibrary * const omrPortLib) also uses that OMR::Z::CPU::CPU(processorDesc) constructor. I'm trying your suggested fix now.

@harryyu1994
Copy link
Contributor

For what it's worth:

detect() + applyUserOptions() will get the new processor type (_processorDescription) to its final form
initializeS390ProcessorFeatures() will get the old processor type (_supportedArch) to its final form

@harryyu1994
Copy link
Contributor

harryyu1994 commented Aug 17, 2020

Oh just realized, I don't think the processor detection test applies to JITServer
We shouldn't need _target.cpu.initialzeS390ProcessorFeatures(); for JITServer

@dchopra001
Copy link
Contributor Author

It looks like your above suggested solution fixed the problem in my java -version test.

I see the following code:

bool
J9::Z::CPU::is_at_least_test(OMRProcessorArchitecture p)
   {
#if defined(J9VM_OPT_JITSERVER)
   if (TR::CompilationInfo::getStream())
      return true;
#endif /* defined(J9VM_OPT_JITSERVER) */

So I think that test will pass regardless of the above change you suggested. But I can still remove the change for JITServer if you prefer.

@harryyu1994
Copy link
Contributor

harryyu1994 commented Aug 17, 2020

yeah we should remove the change for JITServer because it doesn't make sense as JITClientProcessorDesc is already initialized by a remote client JVM.

@dchopra001
Copy link
Contributor Author

I have reverted the changes in applyUserOptions: 86e45fe

@fjeremic
Copy link
Contributor

@harryyu1994 is this one ready? Please add an approval review whenever you get a chance.

Jenkins test sanity zlinux jdk8

@fjeremic fjeremic removed the depends:omr Pull request is dependent on a corresponding change in OMR label Aug 19, 2020
@fjeremic fjeremic merged commit 92fcbf4 into eclipse-openj9:master Aug 19, 2020
@dchopra001 dchopra001 mentioned this pull request Sep 28, 2020
32 tasks
@dchopra001 dchopra001 deleted the updateJ9CPU branch July 13, 2021 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants