Fix S390 opcode properties

[Spencer-Comin]

I found some s390 opcodes that had incorrect and/or missing properties when comparing with documentation.

Missing properties

IsRegCopy

• LOAD (short) (LER)
• LOAD (long) (LDR)
• LOAD (extended) (LXR)

ImplicitlyUsesGPR0

• PERFORM RANDOM NUMBER OPERATION (PRNO)

SetsOperand2

• COMPARE DOUBLE AND SWAP (32) (CDS)
• COMPARE AND SWAP (32) (CS)
• STORE ACCESS MULTIPLE (STAM)
• STORE CHARACTERS UNDER MASK (low) (STCM)
• STORE CONTROL (32) (STCTL)
• STORE MULTIPLE (32) (STM)
• COMPARE DOUBLE AND SWAP (64) (CDSG)
• COMPARE DOUBLE AND SWAP (32) (CDSY)
• COMPARE AND SWAP (64) (CSG)
• COMPARE AND SWAP (32) (CSY)
• STORE ACCESS MULTIPLE (STAMY)
• STORE CHARACTERS UNDER MASK (high) (STCMH)
• STORE CHARACTERS UNDER MASK (low) (STCMY)
• STORE CONTROL (64) (STCTG)
• STORE MULTIPLE (64) (STMG)
• STORE MULTIPLE HIGH (32) (STMH)
• STORE MULTIPLE (32) (STMY)

UsesM3

• LOAD ROUNDED (long to short DFP) (LEDTR)
• LOAD ROUNDED (extended to long DFP) (LDXTR)
• VECTOR LOAD (VL)
• VECTOR STORE (VST)
• CONVERT FROM LOGICAL (64 to short BFP) (CELGBR)
• CONVERT FROM LOGICAL (32 to short BFP) (CELFBR)
• CONVERT FROM LOGICAL (64 to long BFP) (CDLGBR)
• CONVERT FROM LOGICAL (32 to long BFP) (CDLFBR)

SingleFP

• CONVERT FROM LOGICAL (64 to short BFP) (CELGBR)
• STORE (short) (STE)
• STORE (short) (STEY)

UsesM4

• CONVERT FROM LOGICAL (64 to short BFP) (CELGBR)
• CONVERT FROM LOGICAL (32 to short BFP) (CELFBR)
• CONVERT FROM LOGICAL (64 to long BFP) (CDLGBR)
• CONVERT FROM LOGICAL (32 to long BFP) (CDLFBR)

UsesRegPairForSource

• STORE PAIR TO QUADWORD (STPQ)

DoubleFP

• STORE (long) (STD)
• STORE (long) (STDY)

Incorrect properties

SetsOperand3

• COMPARE DOUBLE AND SWAP (32) CDS
• COMPARE AND SWAP (32) CS
• STORE ACCESS MULTIPLE STAM
• STORE CHARACTERS UNDER MASK (low) STCM
• STORE CONTROL (32) STCTL
• STORE MULTIPLE (32) STM
• COMPARE DOUBLE AND SWAP (64) CDSG
• COMPARE DOUBLE AND SWAP (32) CDSY
• COMPARE AND SWAP (64) CSG
• COMPARE AND SWAP (32) CSY
• STORE ACCESS MULTIPLE STAMY
• STORE CHARACTERS UNDER MASK (high) STCMH
• STORE CHARACTERS UNDER MASK (low) STCMY
• STORE CONTROL (64) STCTG
• STORE MULTIPLE (64) STMG
• STORE MULTIPLE HIGH (32) STMH
• STORE MULTIPLE (32) STMY

UsesRegPairForTarget

• STORE PAIR TO QUADWORD STPQ

SingleFP

• STORE (long) STD

DoubleFP

• STORE (short) STE

Closes: #6155
Signed-off-by: Spencer Comin spencer.comin@ibm.com

[github-actions]

Thank you for supporting the project, and congratulations on your first contribution! A project committer will shortly review your contribution. In the mean time, if you haven't had a chance please skim over the contribution guidelines which all pull requests must adhere to. If the ECA pull request check fails, have a look at the instructions for signing the ECA in the legal considerations section.

If you run into any problems our community will be happy to assist you in any way we can. There are a number of recommended ways to interact with the community. We encourage you to ask questions, or drop by to say hello.

[Spencer-Comin]

A bit of context on how these properties are used, from what I've found looking through the codebase:

• IsRegCopy - Not used anywhere
• ImplicitlyUsesGPR0 - In OMR::Z::Instruction::setUseDefRegisters(), which is used in a few different peephole optimizations, e.g. OMR::Z::Peephole::tryToReduceLRCHIToLTR()
• SetsOperand2, SetsOperand3 - In some S390RegInstruction subclass constructors to set source or target register, e.g. S390VRRInstruction
• UsesM3, UsesM4 - In some s390VInstruction subclass constructors to set the flags _printM3 and _printM4 (e.g. S390VRRInstruction), which are used when printing the instruction
• SingleFP, DoubleFP - Both checked in OMR::Z::Instruction::isFloat(), which as far as I can tell is not used anywhere
• UsesRegPairForSource - In TR_DEBUG::print() for S390RSInstruction
• UsesRegPairForTarget - In asserts in S390RegInstruction constructors to check that register pairs are used only when appropriate

[0xdaryl]

@r30shah : please review

[r30shah]

I am bit curious how this flag is used in the binary encoding. As bunch of places, you replaced setsOperand3 does not even use that when instruction was constructed.
Looking at one of the constructor for RSInstruction [1], previously it was setting lreg as source register, but with this change, it will set it as target Register.

[1].

omr/compiler/z/codegen/S390Instruction.hpp

Lines 2591 to 2594 in 4553376

	if (getOpCode().setsOperand2())
	useTargetRegister(lreg);
	else
	useSourceRegister(lreg);

[r30shah]

Jenkins build zos,zlinux

[r30shah]

We did have incorrectly tagged properties on some of the instructions. Thanks a lot @Spencer-Comin for taking time and correcting them. Changes looks good to me.
Given that jenkins build on the PR for zLinux and z/OS passed and knowing that Spencer has put his changes through sufficient internal testing through personal builds on z/OS and LoZ, @0xdaryl Can I request you to merge this changes?