Support -XX:[+/-]ShowHiddenFrames option

[fengxue-IS]

• removed unused VM runtime flags
• added hiddenFrames count info to J9GetStackTraceUserData
• added new VM option -XX:[+/-]ShowHiddenFrames
• added new VM runtime flag J9_RUNTIME_SHOW_HIDDEN_FRAMES for new option
• Add check to skip hidden frames during walkFrame() call
• Add new flag to all fillInStackTrace implementations

Fixes: #3394, Fixes: #14132

Signed-off-by: Jack Lu Jack.S.Lu@ibm.com

[fengxue-IS]

@tajila can you take a look?

[fengxue-IS]

Senior review : @DanHeidinga please take a look

[fengxue-IS]

@DanHeidinga can I get a re-review please?

[M-Davies]

Any update on this @fengxue-IS?

[fengxue-IS]

@DanHeidinga Can you take a look at this please

[genie-openj9]

Can one of the admins verify this patch?

[tajila]

@fengxue-IS Can you please rebase this PR with the latest changes

[tajila]

@DanHeidinga did you have any objections to these changes?

We have noticed some JDK18 tests that require this behaviour

[fengxue-IS]

@tajila Can you please take a look.
I made a revert commit for the the original changes and build a new approach as I noticed the old logic will generate a StackTraceElement[] array with null entries at the end for hidden frames removed which breaks some expected behavior of getStackTrace.
The new approach will filter the hidden frames when the internal stacktrace array is created during fillInStackTrace by specifying the newly added flag J9_STACKWALK_SKIP_HIDDEN_FRAMES .

Few points to note:

1. which Java version should this behavior be enabled on?
2. which APIs other than Throwable.fillInStackTrace should we specify J9_STACKWALK_SKIP_HIDDEN_FRAMES (I noticed that we have a different impl for j.l.Thread.getStackTrace which doesn't use Throwable.fillInStackTrace to initialize)
3. should we update StackWalker natives to use the new flag or keeping filtering in the iterator?

We could also continue with the old approach by building a new iterator for the first pass of iterateStackTrace call when calculating the number of frames (https://github.com/eclipse-openj9/openj9/blob/master/runtime/jcl/common/jclexception.cpp#L324).

[tajila]

which Java version should this behavior be enabled on?

all versions

which APIs other than Throwable.fillInStackTrace should we specify J9_STACKWALK_SKIP_HIDDEN_FRAMES (I noticed that we have a different impl for j.l.Thread.getStackTrace which doesn't use Throwable.fillInStackTrace to initialize)

I think we should try to match the RI as much as possible

should we update StackWalker natives to use the new flag or keeping filtering in the iterator?

Yes, lets handle this in a uniform manner

[fengxue-IS]

@tajila can you please take another look?
I've updated the code to have the swalk caller check -XX:ShowHiddenFrames option and set walk flag. Also update the StackWalker API to use the same logic/flags. Personal build passed on sanity.functional/openjdk

Locally tested on my VM that tests below passed:

java/lang/StackTraceElement/WithClassLoaderName.java
java/lang/reflect/MethodHandleAccessorsTest.java#id0
java/lang/reflect/IllegalArgumentsTest.java

[tajila]

@gacholio please review these changes

[gacholio]

Was our behaviour incorrect before (assuming the option defaults to off)?

[fengxue-IS]

Was our behaviour incorrect before (assuming the option defaults to off)?

OpenJ9 by default doesn't skip hidden frames, though behavior in terms of handling hidden frames is unspecified, the reason for this change is due to many OJDK tests depends on this behavior so we are matching the RI's behavior

[gacholio]

For consistency, please add the print to the start of the stack walker for the new flag bit.

[gacholio]

And please squash the commits once that change is made.

[fengxue-IS]

fixed all review comments as suggested, re-compiled locally and passed JTreg test associated.

[gacholio]

jenkins test sanity zlinux jdk17

[pshipton]

@fengxue-IS please create a https://github.com/eclipse-openj9/openj9-docs issue and PR to update the user guide. The new option also needs to be mentioned in the OpenJ9 release notes. https://github.com/eclipse-openj9/openj9/blob/master/doc/release-notes/0.31/0.31.md